1
0

NPOI.XML 2.0 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322373233732437325373263732737328373293733037331373323733337334373353733637337373383733937340373413734237343373443734537346373473734837349373503735137352373533735437355373563735737358373593736037361373623736337364373653736637367373683736937370373713737237373373743737537376373773737837379373803738137382373833738437385373863738737388373893739037391373923739337394373953739637397373983739937400374013740237403374043740537406374073740837409374103741137412374133741437415374163741737418374193742037421374223742337424374253742637427374283742937430374313743237433374343743537436374373743837439374403744137442374433744437445374463744737448374493745037451374523745337454374553745637457374583745937460374613746237463374643746537466374673746837469374703747137472374733747437475374763747737478374793748037481374823748337484374853748637487374883748937490374913749237493374943749537496374973749837499375003750137502375033750437505375063750737508375093751037511375123751337514375153751637517375183751937520375213752237523375243752537526375273752837529375303753137532375333753437535375363753737538375393754037541375423754337544375453754637547375483754937550375513755237553375543755537556375573755837559375603756137562375633756437565375663756737568375693757037571375723757337574375753757637577375783757937580375813758237583375843758537586375873758837589375903759137592375933759437595375963759737598375993760037601376023760337604376053760637607376083760937610376113761237613376143761537616376173761837619376203762137622376233762437625376263762737628376293763037631376323763337634376353763637637376383763937640376413764237643376443764537646376473764837649376503765137652376533765437655376563765737658376593766037661376623766337664376653766637667376683766937670376713767237673376743767537676376773767837679376803768137682376833768437685376863768737688376893769037691376923769337694376953769637697376983769937700377013770237703377043770537706377073770837709377103771137712377133771437715377163771737718377193772037721377223772337724377253772637727377283772937730377313773237733377343773537736377373773837739377403774137742377433774437745377463774737748377493775037751377523775337754377553775637757377583775937760377613776237763377643776537766377673776837769377703777137772377733777437775377763777737778377793778037781377823778337784377853778637787377883778937790377913779237793377943779537796377973779837799378003780137802378033780437805378063780737808378093781037811378123781337814378153781637817378183781937820378213782237823378243782537826378273782837829378303783137832378333783437835378363783737838378393784037841378423784337844378453784637847378483784937850378513785237853378543785537856378573785837859378603786137862378633786437865378663786737868378693787037871378723787337874378753787637877378783787937880378813788237883378843788537886378873788837889378903789137892378933789437895378963789737898378993790037901379023790337904379053790637907379083790937910379113791237913379143791537916379173791837919379203792137922379233792437925379263792737928379293793037931379323793337934379353793637937379383793937940379413794237943379443794537946379473794837949379503795137952379533795437955379563795737958379593796037961379623796337964379653796637967379683796937970379713797237973379743797537976379773797837979379803798137982379833798437985379863798737988379893799037991379923799337994379953799637997379983799938000380013800238003380043800538006380073800838009380103801138012380133801438015380163801738018380193802038021380223802338024380253802638027380283802938030380313803238033380343803538036380373803838039380403804138042380433804438045380463804738048380493805038051380523805338054380553805638057380583805938060380613806238063380643806538066380673806838069380703807138072380733807438075380763807738078380793808038081380823808338084380853808638087380883808938090380913809238093380943809538096380973809838099381003810138102381033810438105381063810738108381093811038111381123811338114381153811638117381183811938120381213812238123381243812538126381273812838129381303813138132381333813438135381363813738138381393814038141381423814338144381453814638147381483814938150381513815238153381543815538156381573815838159381603816138162381633816438165381663816738168381693817038171381723817338174381753817638177381783817938180381813818238183381843818538186381873818838189381903819138192381933819438195381963819738198381993820038201382023820338204382053820638207382083820938210382113821238213382143821538216382173821838219382203822138222382233822438225382263822738228382293823038231382323823338234382353823638237382383823938240382413824238243382443824538246382473824838249382503825138252382533825438255382563825738258382593826038261382623826338264382653826638267382683826938270382713827238273382743827538276382773827838279382803828138282382833828438285382863828738288382893829038291382923829338294382953829638297382983829938300383013830238303383043830538306383073830838309383103831138312383133831438315383163831738318383193832038321383223832338324383253832638327383283832938330383313833238333383343833538336383373833838339383403834138342383433834438345383463834738348383493835038351383523835338354383553835638357383583835938360383613836238363383643836538366383673836838369383703837138372383733837438375383763837738378383793838038381383823838338384383853838638387383883838938390383913839238393383943839538396383973839838399384003840138402384033840438405384063840738408384093841038411384123841338414384153841638417384183841938420384213842238423384243842538426384273842838429384303843138432384333843438435384363843738438384393844038441384423844338444384453844638447384483844938450384513845238453384543845538456384573845838459384603846138462384633846438465384663846738468384693847038471384723847338474384753847638477384783847938480384813848238483384843848538486384873848838489384903849138492384933849438495384963849738498384993850038501385023850338504385053850638507385083850938510385113851238513385143851538516385173851838519385203852138522385233852438525385263852738528385293853038531385323853338534385353853638537385383853938540385413854238543385443854538546385473854838549385503855138552385533855438555385563855738558385593856038561385623856338564385653856638567385683856938570385713857238573385743857538576385773857838579385803858138582385833858438585385863858738588385893859038591385923859338594385953859638597385983859938600386013860238603386043860538606386073860838609386103861138612386133861438615386163861738618386193862038621386223862338624386253862638627386283862938630386313863238633386343863538636386373863838639386403864138642386433864438645386463864738648386493865038651386523865338654386553865638657386583865938660386613866238663386643866538666386673866838669386703867138672386733867438675386763867738678386793868038681386823868338684386853868638687386883868938690386913869238693386943869538696386973869838699387003870138702387033870438705387063870738708387093871038711387123871338714387153871638717387183871938720387213872238723387243872538726387273872838729387303873138732387333873438735387363873738738387393874038741387423874338744387453874638747387483874938750387513875238753387543875538756387573875838759387603876138762387633876438765387663876738768387693877038771387723877338774387753877638777387783877938780387813878238783387843878538786387873878838789387903879138792387933879438795387963879738798387993880038801388023880338804388053880638807388083880938810388113881238813388143881538816388173881838819388203882138822388233882438825388263882738828388293883038831388323883338834388353883638837388383883938840388413884238843388443884538846388473884838849388503885138852388533885438855388563885738858388593886038861388623886338864388653886638867388683886938870388713887238873388743887538876388773887838879388803888138882388833888438885388863888738888388893889038891388923889338894388953889638897388983889938900389013890238903389043890538906389073890838909389103891138912389133891438915389163891738918389193892038921389223892338924389253892638927389283892938930389313893238933389343893538936389373893838939389403894138942389433894438945389463894738948389493895038951389523895338954389553895638957389583895938960389613896238963389643896538966389673896838969389703897138972389733897438975389763897738978389793898038981389823898338984389853898638987389883898938990389913899238993389943899538996389973899838999390003900139002390033900439005390063900739008390093901039011390123901339014390153901639017390183901939020390213902239023390243902539026390273902839029390303903139032390333903439035390363903739038390393904039041390423904339044390453904639047390483904939050390513905239053390543905539056390573905839059390603906139062390633906439065390663906739068390693907039071390723907339074390753907639077390783907939080390813908239083390843908539086390873908839089390903909139092390933909439095390963909739098390993910039101391023910339104391053910639107391083910939110391113911239113391143911539116391173911839119391203912139122391233912439125391263912739128391293913039131391323913339134391353913639137391383913939140391413914239143391443914539146391473914839149391503915139152391533915439155391563915739158391593916039161391623916339164391653916639167391683916939170391713917239173391743917539176391773917839179391803918139182391833918439185391863918739188391893919039191391923919339194391953919639197391983919939200392013920239203392043920539206392073920839209392103921139212392133921439215392163921739218392193922039221392223922339224392253922639227392283922939230392313923239233392343923539236392373923839239392403924139242392433924439245392463924739248392493925039251392523925339254392553925639257392583925939260392613926239263392643926539266392673926839269392703927139272392733927439275392763927739278392793928039281392823928339284392853928639287392883928939290392913929239293392943929539296392973929839299393003930139302393033930439305393063930739308393093931039311393123931339314393153931639317393183931939320393213932239323393243932539326393273932839329393303933139332393333933439335393363933739338393393934039341393423934339344393453934639347393483934939350393513935239353393543935539356393573935839359393603936139362393633936439365393663936739368393693937039371393723937339374393753937639377393783937939380393813938239383393843938539386393873938839389393903939139392393933939439395393963939739398393993940039401394023940339404394053940639407394083940939410394113941239413394143941539416394173941839419394203942139422394233942439425394263942739428394293943039431394323943339434394353943639437394383943939440394413944239443394443944539446394473944839449394503945139452394533945439455394563945739458394593946039461394623946339464394653946639467394683946939470394713947239473394743947539476394773947839479394803948139482394833948439485394863948739488394893949039491394923949339494394953949639497394983949939500395013950239503395043950539506395073950839509395103951139512395133951439515395163951739518395193952039521395223952339524395253952639527395283952939530395313953239533395343953539536395373953839539395403954139542395433954439545395463954739548395493955039551395523955339554395553955639557395583955939560395613956239563395643956539566395673956839569395703957139572395733957439575395763957739578395793958039581395823958339584395853958639587395883958939590395913959239593395943959539596395973959839599396003960139602396033960439605396063960739608396093961039611396123961339614396153961639617396183961939620396213962239623396243962539626396273962839629396303963139632396333963439635396363963739638396393964039641396423964339644396453964639647396483964939650396513965239653396543965539656396573965839659396603966139662396633966439665396663966739668396693967039671396723967339674396753967639677396783967939680396813968239683396843968539686396873968839689396903969139692396933969439695396963969739698396993970039701397023970339704397053970639707397083970939710397113971239713397143971539716397173971839719397203972139722397233972439725397263972739728397293973039731397323973339734397353973639737397383973939740397413974239743397443974539746397473974839749397503975139752397533975439755397563975739758397593976039761397623976339764397653976639767397683976939770397713977239773397743977539776397773977839779397803978139782397833978439785397863978739788397893979039791397923979339794397953979639797397983979939800398013980239803398043980539806398073980839809398103981139812398133981439815398163981739818398193982039821398223982339824398253982639827398283982939830398313983239833398343983539836398373983839839398403984139842398433984439845398463984739848398493985039851398523985339854398553985639857398583985939860398613986239863398643986539866398673986839869398703987139872398733987439875398763987739878398793988039881398823988339884398853988639887398883988939890398913989239893398943989539896398973989839899399003990139902399033990439905399063990739908399093991039911399123991339914399153991639917399183991939920399213992239923399243992539926399273992839929399303993139932399333993439935399363993739938399393994039941399423994339944399453994639947399483994939950399513995239953399543995539956399573995839959399603996139962399633996439965399663996739968399693997039971399723997339974399753997639977399783997939980399813998239983399843998539986399873998839989399903999139992399933999439995399963999739998399994000040001400024000340004400054000640007400084000940010400114001240013400144001540016400174001840019400204002140022400234002440025400264002740028400294003040031400324003340034400354003640037400384003940040400414004240043400444004540046400474004840049400504005140052400534005440055400564005740058400594006040061400624006340064400654006640067400684006940070400714007240073400744007540076400774007840079400804008140082400834008440085400864008740088400894009040091400924009340094400954009640097400984009940100401014010240103401044010540106401074010840109401104011140112401134011440115401164011740118401194012040121401224012340124401254012640127401284012940130401314013240133401344013540136401374013840139401404014140142401434014440145401464014740148401494015040151401524015340154401554015640157401584015940160401614016240163401644016540166401674016840169401704017140172401734017440175401764017740178401794018040181401824018340184401854018640187401884018940190401914019240193401944019540196401974019840199402004020140202402034020440205402064020740208402094021040211402124021340214402154021640217402184021940220402214022240223402244022540226402274022840229402304023140232402334023440235402364023740238402394024040241402424024340244402454024640247402484024940250402514025240253402544025540256402574025840259402604026140262402634026440265402664026740268402694027040271402724027340274402754027640277402784027940280402814028240283402844028540286402874028840289402904029140292402934029440295402964029740298402994030040301403024030340304403054030640307403084030940310403114031240313403144031540316403174031840319403204032140322403234032440325403264032740328403294033040331403324033340334403354033640337403384033940340403414034240343403444034540346403474034840349403504035140352403534035440355403564035740358403594036040361403624036340364403654036640367403684036940370403714037240373403744037540376403774037840379403804038140382403834038440385403864038740388403894039040391403924039340394403954039640397403984039940400404014040240403404044040540406404074040840409404104041140412404134041440415404164041740418404194042040421404224042340424404254042640427404284042940430404314043240433404344043540436404374043840439404404044140442404434044440445404464044740448404494045040451404524045340454404554045640457404584045940460404614046240463404644046540466404674046840469404704047140472404734047440475404764047740478404794048040481404824048340484404854048640487404884048940490404914049240493404944049540496404974049840499405004050140502405034050440505405064050740508405094051040511405124051340514405154051640517405184051940520405214052240523405244052540526405274052840529405304053140532405334053440535405364053740538405394054040541405424054340544405454054640547405484054940550405514055240553405544055540556405574055840559405604056140562405634056440565405664056740568405694057040571405724057340574405754057640577405784057940580405814058240583405844058540586405874058840589405904059140592405934059440595405964059740598405994060040601406024060340604406054060640607406084060940610406114061240613406144061540616406174061840619406204062140622406234062440625406264062740628406294063040631406324063340634406354063640637406384063940640406414064240643406444064540646406474064840649406504065140652406534065440655406564065740658406594066040661406624066340664406654066640667406684066940670406714067240673406744067540676406774067840679406804068140682406834068440685406864068740688406894069040691406924069340694406954069640697406984069940700407014070240703407044070540706407074070840709407104071140712407134071440715407164071740718407194072040721407224072340724407254072640727407284072940730407314073240733407344073540736407374073840739407404074140742407434074440745407464074740748407494075040751407524075340754407554075640757407584075940760407614076240763407644076540766407674076840769407704077140772407734077440775407764077740778407794078040781407824078340784407854078640787407884078940790407914079240793407944079540796407974079840799408004080140802408034080440805408064080740808408094081040811408124081340814408154081640817408184081940820408214082240823408244082540826408274082840829408304083140832408334083440835408364083740838408394084040841408424084340844408454084640847408484084940850408514085240853408544085540856408574085840859408604086140862408634086440865408664086740868408694087040871408724087340874408754087640877408784087940880408814088240883408844088540886408874088840889408904089140892408934089440895408964089740898408994090040901409024090340904409054090640907409084090940910409114091240913409144091540916409174091840919409204092140922409234092440925409264092740928409294093040931409324093340934409354093640937409384093940940409414094240943409444094540946409474094840949409504095140952409534095440955409564095740958409594096040961409624096340964409654096640967409684096940970409714097240973409744097540976409774097840979409804098140982409834098440985409864098740988409894099040991409924099340994409954099640997409984099941000410014100241003410044100541006410074100841009410104101141012410134101441015410164101741018410194102041021410224102341024410254102641027410284102941030410314103241033410344103541036410374103841039410404104141042410434104441045410464104741048410494105041051410524105341054410554105641057410584105941060410614106241063410644106541066410674106841069410704107141072410734107441075410764107741078410794108041081410824108341084410854108641087410884108941090410914109241093410944109541096410974109841099411004110141102411034110441105411064110741108411094111041111411124111341114411154111641117411184111941120411214112241123411244112541126411274112841129411304113141132411334113441135411364113741138411394114041141411424114341144411454114641147411484114941150411514115241153411544115541156411574115841159411604116141162411634116441165411664116741168411694117041171411724117341174411754117641177411784117941180411814118241183411844118541186411874118841189411904119141192411934119441195411964119741198411994120041201412024120341204412054120641207412084120941210412114121241213412144121541216412174121841219412204122141222412234122441225412264122741228412294123041231412324123341234412354123641237412384123941240412414124241243412444124541246412474124841249412504125141252412534125441255412564125741258412594126041261412624126341264412654126641267412684126941270412714127241273412744127541276412774127841279412804128141282412834128441285412864128741288412894129041291412924129341294412954129641297412984129941300413014130241303413044130541306413074130841309413104131141312413134131441315413164131741318413194132041321413224132341324413254132641327413284132941330413314133241333413344133541336413374133841339413404134141342413434134441345413464134741348413494135041351413524135341354413554135641357413584135941360413614136241363413644136541366413674136841369413704137141372413734137441375413764137741378413794138041381413824138341384413854138641387413884138941390413914139241393413944139541396413974139841399414004140141402414034140441405414064140741408414094141041411414124141341414414154141641417414184141941420414214142241423414244142541426414274142841429414304143141432414334143441435414364143741438414394144041441414424144341444414454144641447414484144941450414514145241453414544145541456414574145841459414604146141462
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NPOI</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="T:NPOI.DDF.EscherRecord">
  14. <summary>
  15. The base abstract record from which all escher records are defined. Subclasses will need
  16. to define methods for serialization/deserialization and for determining the record size.
  17. @author Glen Stampoultzis
  18. </summary>
  19. </member>
  20. <member name="M:NPOI.DDF.EscherRecord.#ctor">
  21. <summary>
  22. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRecord"/> class.
  23. </summary>
  24. </member>
  25. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],NPOI.DDF.IEscherRecordFactory)">
  26. <summary>
  27. Delegates to FillFields(byte[], int, EscherRecordFactory)
  28. </summary>
  29. <param name="data">The data.</param>
  30. <param name="f">The f.</param>
  31. <returns></returns>
  32. </member>
  33. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  34. <summary>
  35. The contract of this method is to deSerialize an escher record including
  36. it's children.
  37. </summary>
  38. <param name="data">The byte array containing the Serialized escher
  39. records.</param>
  40. <param name="offset">The offset into the byte array.</param>
  41. <param name="recordFactory">A factory for creating new escher records.</param>
  42. <returns>The number of bytes written.</returns>
  43. </member>
  44. <member name="M:NPOI.DDF.EscherRecord.ReadHeader(System.Byte[],System.Int32)">
  45. <summary>
  46. Reads the 8 byte header information and populates the
  47. <c>options</c>
  48. and
  49. <c>recordId</c>
  50. records.
  51. </summary>
  52. <param name="data">the byte array to Read from</param>
  53. <param name="offset">the offset to start Reading from</param>
  54. <returns>the number of bytes remaining in this record. This</returns>
  55. </member>
  56. <member name="M:NPOI.DDF.EscherRecord.ReadInstance(System.Byte[],System.Int32)">
  57. <summary>
  58. Read the options field from header and return instance part of it.
  59. </summary>
  60. <param name="data">the byte array to read from</param>
  61. <param name="offset">the offset to start reading from</param>
  62. <returns>value of instance part of options field</returns>
  63. </member>
  64. <member name="M:NPOI.DDF.EscherRecord.Serialize">
  65. <summary>
  66. Serializes to a new byte array. This is done by delegating to
  67. Serialize(int, byte[]);
  68. </summary>
  69. <returns>the Serialized record.</returns>
  70. </member>
  71. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[])">
  72. <summary>
  73. Serializes to an existing byte array without serialization listener.
  74. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  75. </summary>
  76. <param name="offset">the offset within the data byte array.</param>
  77. <param name="data">the data array to Serialize to.</param>
  78. <returns>The number of bytes written.</returns>
  79. </member>
  80. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  81. <summary>
  82. Serializes the record to an existing byte array.
  83. </summary>
  84. <param name="offset">the offset within the byte array.</param>
  85. <param name="data">the offset within the byte array</param>
  86. <param name="listener">a listener for begin and end serialization events. This.
  87. is useful because the serialization is
  88. hierarchical/recursive and sometimes you need to be able
  89. break into that.
  90. </param>
  91. <returns></returns>
  92. </member>
  93. <member name="M:NPOI.DDF.EscherRecord.Clone">
  94. <summary>
  95. Creates a new object that is a copy of the current instance.
  96. </summary>
  97. <returns>
  98. A new object that is a copy of this instance.
  99. </returns>
  100. </member>
  101. <member name="M:NPOI.DDF.EscherRecord.GetChild(System.Int32)">
  102. <summary>
  103. Returns the indexed child record.
  104. </summary>
  105. <param name="index">The index.</param>
  106. <returns></returns>
  107. </member>
  108. <member name="M:NPOI.DDF.EscherRecord.Display(System.Int32)">
  109. <summary>
  110. The display methods allows escher variables to print the record names
  111. according to their hierarchy.
  112. </summary>
  113. <param name="indent">The current indent level.</param>
  114. </member>
  115. <member name="M:NPOI.DDF.EscherRecord.ToXml(System.String)">
  116. @param tab - each children must be a right of his parent
  117. @return xml representation of this record
  118. </member>
  119. <member name="P:NPOI.DDF.EscherRecord.IsContainerRecord">
  120. <summary>
  121. Determine whether this is a container record by inspecting the option
  122. field.
  123. </summary>
  124. <value>
  125. <c>true</c> if this instance is container record; otherwise, <c>false</c>.
  126. </value>
  127. </member>
  128. <member name="P:NPOI.DDF.EscherRecord.Options">
  129. <summary>
  130. Gets or sets the options field for this record. All records have one
  131. </summary>
  132. <value>The options.</value>
  133. </member>
  134. <member name="P:NPOI.DDF.EscherRecord.RecordSize">
  135. <summary>
  136. Subclasses should effeciently return the number of bytes required to
  137. Serialize the record.
  138. </summary>
  139. <value>number of bytes</value>
  140. </member>
  141. <member name="P:NPOI.DDF.EscherRecord.RecordId">
  142. <summary>
  143. Return the current record id.
  144. </summary>
  145. <value>The 16 bit record id.</value>
  146. </member>
  147. <member name="P:NPOI.DDF.EscherRecord.ChildRecords">
  148. <summary>
  149. Gets or sets the child records.
  150. </summary>
  151. <value>Returns the children of this record. By default this will
  152. be an empty list. EscherCotainerRecord is the only record that may contain children.</value>
  153. </member>
  154. <member name="P:NPOI.DDF.EscherRecord.RecordName">
  155. <summary>
  156. Gets the name of the record.
  157. </summary>
  158. <value>The name of the record.</value>
  159. </member>
  160. <member name="P:NPOI.DDF.EscherRecord.Instance">
  161. <summary>
  162. Get or set the instance part of the option record.
  163. </summary>
  164. </member>
  165. <member name="P:NPOI.DDF.EscherRecord.Version">
  166. <summary>
  167. Get or set the version part of the option record.
  168. </summary>
  169. </member>
  170. <member name="T:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader">
  171. <summary>
  172. This class Reads the standard escher header.
  173. </summary>
  174. </member>
  175. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ReadHeader(System.Byte[],System.Int32)">
  176. <summary>
  177. Reads the header.
  178. </summary>
  179. <param name="data">The data.</param>
  180. <param name="offset">The off set.</param>
  181. <returns></returns>
  182. </member>
  183. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ToString">
  184. <summary>
  185. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  186. </summary>
  187. <returns>
  188. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  189. </returns>
  190. </member>
  191. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.Options">
  192. <summary>
  193. Gets the options.
  194. </summary>
  195. <value>The options.</value>
  196. </member>
  197. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RecordId">
  198. <summary>
  199. Gets the record id.
  200. </summary>
  201. <value>The record id.</value>
  202. </member>
  203. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RemainingBytes">
  204. <summary>
  205. Gets the remaining bytes.
  206. </summary>
  207. <value>The remaining bytes.</value>
  208. </member>
  209. <member name="M:NPOI.DDF.AbstractEscherOptRecord.AddEscherProperty(NPOI.DDF.EscherProperty)">
  210. Add a property to this record.
  211. </member>
  212. <member name="M:NPOI.DDF.AbstractEscherOptRecord.GetEscherProperty(System.Int32)">
  213. The list of properties stored by this record.
  214. </member>
  215. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SortProperties">
  216. Records should be sorted by property number before being stored.
  217. </member>
  218. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SetEscherProperty(NPOI.DDF.EscherProperty)">
  219. * Set an escher property. If a property with given propId already
  220. exists it is replaced.
  221. *
  222. * @param value the property to set.
  223. </member>
  224. <member name="M:NPOI.DDF.AbstractEscherOptRecord.ToString">
  225. Retrieve the string representation of this record.
  226. </member>
  227. <member name="P:NPOI.DDF.AbstractEscherOptRecord.EscherProperties">
  228. The list of properties stored by this record.
  229. </member>
  230. <member name="T:NPOI.DDF.EscherTertiaryOptRecord">
  231. "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
  232. -- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
  233. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  234. </member>
  235. <member name="T:NPOI.HPSF.UnsupportedEncodingException">
  236. The Character Encoding is not supported.
  237. @author Asmus Freytag
  238. @since JDK1.1
  239. </member>
  240. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor">
  241. Constructs an UnsupportedEncodingException without a detail message.
  242. </member>
  243. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor(System.String)">
  244. Constructs an UnsupportedEncodingException with a detail message.
  245. @param s Describes the reason for the exception.
  246. </member>
  247. <member name="M:NPOI.HSSF.Converter.ExcelToHtmlConverter.ProcessRow(NPOI.SS.Util.CellRangeAddress[][],NPOI.HSSF.UserModel.HSSFRow,System.Xml.XmlElement)">
  248. @return maximum 1-base index of column that were rendered, zero if none
  249. </member>
  250. <member name="M:NPOI.HSSF.Converter.ExcelToHtmlConverter.ProcessColumnWidths(NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Xml.XmlElement)">
  251. Creates COLGROUP element with width specified for all columns. (Except
  252. first if <tt>{@link #isOutputRowNumbers()}==true</tt>)
  253. </member>
  254. <member name="P:NPOI.HSSF.Converter.ExcelToHtmlConverter.OutputColumnHeaders">
  255. <summary>
  256. 是否输出列头
  257. </summary>
  258. </member>
  259. <member name="P:NPOI.HSSF.Converter.ExcelToHtmlConverter.OutputHiddenColumns">
  260. <summary>
  261. 是否输出隐藏的列
  262. </summary>
  263. </member>
  264. <member name="P:NPOI.HSSF.Converter.ExcelToHtmlConverter.OutputHiddenRows">
  265. <summary>
  266. 是否输出隐藏的行
  267. </summary>
  268. </member>
  269. <member name="P:NPOI.HSSF.Converter.ExcelToHtmlConverter.OutputLeadingSpacesAsNonBreaking">
  270. <summary>
  271. 是否输出文本前的空格
  272. </summary>
  273. </member>
  274. <member name="P:NPOI.HSSF.Converter.ExcelToHtmlConverter.OutputRowNumbers">
  275. <summary>
  276. 是否输出行号
  277. </summary>
  278. </member>
  279. <member name="P:NPOI.HSSF.Converter.ExcelToHtmlConverter.UseDivsToSpan">
  280. <summary>
  281. 在跨列的单元格使用DIV标记
  282. </summary>
  283. </member>
  284. <member name="M:NPOI.HSSF.Converter.ExcelToHtmlUtils.BuildMergedRangesMap(NPOI.HSSF.UserModel.HSSFSheet)">
  285. Creates a map (i.e. two-dimensional array) filled with ranges. Allow fast
  286. retrieving {@link CellRangeAddress} of any cell, if cell is contained in
  287. range.
  288. @see #getMergedRange(CellRangeAddress[][], int, int)
  289. </member>
  290. <member name="M:NPOI.HSSF.Converter.ExcelToHtmlUtils.GetColumnWidthInPx(System.Int32)">
  291. See <a href=
  292. "http://apache-poi.1045710.n5.nabble.com/Excel-Column-Width-Unit-Converter-pixels-excel-column-width-units-td2301481.html"
  293. >here</a> for Xio explanation and details
  294. </member>
  295. <member name="M:NPOI.HSSF.Converter.ExcelToHtmlUtils.GetMergedRange(NPOI.SS.Util.CellRangeAddress[][],System.Int32,System.Int32)">
  296. @param mergedRanges
  297. map of sheet merged ranges built with
  298. {@link #buildMergedRangesMap(HSSFSheet)}
  299. @return {@link CellRangeAddress} from map if cell with specified row and
  300. column numbers contained in found range, <tt>null</tt> otherwise
  301. </member>
  302. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AttachedLabelAggregate">
  303. <summary>
  304. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  305. AI = BRAI [SeriesText]
  306. </summary>
  307. </member>
  308. <member name="T:NPOI.HSSF.Record.Aggregates.RecordAggregate">
  309. <c>RecordAggregate</c>s are groups of of BIFF <c>Record</c>s that are typically stored
  310. together and/or updated together. Workbook / Sheet records are typically stored in a sequential
  311. list, which does not provide much structure to coordinate updates.
  312. @author Josh Micich
  313. </member>
  314. <member name="T:NPOI.HSSF.Record.RecordBase">
  315. Common base class of {@link Record} and {@link RecordAggregate}
  316. @author Josh Micich
  317. </member>
  318. <member name="M:NPOI.HSSF.Record.RecordBase.Serialize(System.Int32,System.Byte[])">
  319. called by the class that is responsible for writing this sucker.
  320. Subclasses should implement this so that their data is passed back in a
  321. byte array.
  322. @param offset to begin writing at
  323. @param data byte array containing instance data
  324. @return number of bytes written
  325. </member>
  326. <member name="P:NPOI.HSSF.Record.RecordBase.RecordSize">
  327. gives the current serialized size of the record. Should include the sid
  328. and reclength (4 bytes).
  329. </member>
  330. <member name="M:NPOI.HSSF.Record.Aggregates.RecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  331. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  332. that they should be written to file. Implementors may or may not return the actual
  333. {@link Record}s being used to manage POI's internal implementation. Callers should not
  334. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  335. </member>
  336. <member name="M:NPOI.HSSF.Record.Aggregates.RecordVisitor.VisitRecord(NPOI.HSSF.Record.Record)">
  337. Implementors may call non-mutating methods on Record r.
  338. @param r must not be <c>null</c>
  339. </member>
  340. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxesAggregate">
  341. <summary>
  342. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  343. </summary>
  344. </member>
  345. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxisParentAggregate">
  346. <summary>
  347. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  348. </summary>
  349. </member>
  350. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXMAggregate">
  351. <summary>
  352. AXM = YMult StartObject ATTACHEDLABEL EndObject
  353. </summary>
  354. </member>
  355. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXSAggregate">
  356. <summary>
  357. AXS = [IFmtRecord] [Tick] [FontX] *4(AxisLine LineFormat) [AreaFormat]
  358. [GELFRAME] *4SHAPEPROPS [TextPropsStream *ContinueFrt12]
  359. </summary>
  360. </member>
  361. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartFormatsAggregate">
  362. <summary>
  363. CHARTFOMATS = Chart Begin *2FONTLIST Scl PlotGrowth [FRAME] *SERIESFORMAT *SS ShtProps
  364. *2DFTTEXT AxesUsed 1*2AXISPARENT [CrtLayout12A] [DAT] *ATTACHEDLABEL [CRTMLFRT]
  365. *([DataLabExt StartObject] ATTACHEDLABEL [EndObject]) [TEXTPROPS] *2CRTMLFRT End
  366. </summary>
  367. </member>
  368. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate">
  369. <summary>
  370. CHARTSHEET = BOF CHARTSHEETCONTENT
  371. CHARTSHEETCONTENT = [WriteProtect] [SheetExt] [WebPub] *HFPicture PAGESETUP PrintSize
  372. [HeaderFooter] [BACKGROUND] *Fbi *Fbi2 [ClrtClient] [PROTECTION] [Palette] [SXViewLink]
  373. [PivotChartBits] [SBaseRef] [MsoDrawingGroup] OBJECTS Units CHARTFOMATS SERIESDATA
  374. *WINDOW *CUSTOMVIEW [CodeName] [CRTMLFRT] EOF
  375. </summary>
  376. </member>
  377. <member name="F:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate._recs">
  378. All the records between BOF and EOF
  379. </member>
  380. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CRTAggregate">
  381. <summary>
  382. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar /
  383. RadarArea / Surf) CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat)
  384. *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  385. </summary>
  386. </member>
  387. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CrtMlFrtAggregate">
  388. <summary>
  389. CRTMLFRT = CrtMlFrt *CrtMlFrtContinue
  390. </summary>
  391. </member>
  392. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DatAggregate">
  393. <summary>
  394. DAT = Dat Begin LD End
  395. </summary>
  396. </member>
  397. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DFTTextAggregate">
  398. <summary>
  399. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  400. </summary>
  401. </member>
  402. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DropBarAggregate">
  403. <summary>
  404. DROPBAR = DropBar Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  405. </summary>
  406. </member>
  407. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DVAxisAggregate">
  408. <summary>
  409. DVAXIS = Axis Begin [ValueRange] [AXM] AXS [CRTMLFRT] End
  410. </summary>
  411. </member>
  412. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FontListAggregate">
  413. <summary>
  414. FONTLIST = FrtFontList StartObject *(Font [Fbi]) EndObject
  415. </summary>
  416. </member>
  417. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FrameAggregate">
  418. <summary>
  419. FRAME = Frame Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  420. </summary>
  421. </member>
  422. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.GelFrameAggregate">
  423. <summary>
  424. GELFRAME = 1*2GelFrame *Continue [PICF]
  425. PICF = Begin PicF End
  426. </summary>
  427. </member>
  428. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.IVAxisAggregate">
  429. <summary>
  430. IVAXIS = Axis Begin [CatSerRange] AxcExt [CatLab] AXS [CRTMLFRT] End
  431. </summary>
  432. </member>
  433. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.LDAggregate">
  434. <summary>
  435. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  436. </summary>
  437. </member>
  438. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesAxisAggregate">
  439. <summary>
  440. SERIESAXIS = Axis Begin [CatSerRange] AXS [CRTMLFRT] End
  441. </summary>
  442. </member>
  443. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesDataAggregate">
  444. <summary>
  445. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  446. </summary>
  447. </member>
  448. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate">
  449. <summary>
  450. SERIESFORMAT = Series Begin 4AI *SS (SerToCrt / (SerParent (SerAuxTrend / SerAuxErrBar)))
  451. *(LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]) End
  452. </summary>
  453. </member>
  454. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate.LegendExceptionAggregate">
  455. <summary>
  456. LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]
  457. </summary>
  458. </member>
  459. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ShapePropsAggregate">
  460. <summary>
  461. SHAPEPROPS = ShapePropsStream *ContinueFrt12
  462. </summary>
  463. </member>
  464. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SSAggregate">
  465. <summary>
  466. SS = DataFormat Begin [Chart3DBarShape] [LineFormat AreaFormat PieFormat] [SerFmt]
  467. [GELFRAME] [MarkerFormat] [AttachedLabel] *2SHAPEPROPS [CRTMLFRT] End
  468. </summary>
  469. </member>
  470. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.TextPropsAggregate">
  471. <summary>
  472. TEXTPROPS = (RichTextStream / TextPropsStream) *ContinueFrt12
  473. </summary>
  474. </member>
  475. <member name="T:NPOI.HSSF.Record.Chart.AlRunsRecord">
  476. <summary>
  477. The AlRuns record specifies Rich Text Formatting within chart
  478. titles (section 2.2.3.3), trendline (section 2.2.3.12), and
  479. data labels (section 2.2.3.11).
  480. </summary>
  481. </member>
  482. <member name="T:NPOI.HSSF.Record.StandardRecord">
  483. Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for
  484. some simplification of serialization logic
  485. @author Josh Micich
  486. </member>
  487. <member name="T:NPOI.HSSF.Record.Record">
  488. Title: Record
  489. Description: All HSSF Records inherit from this class. It
  490. populates the fields common to all records (id, size and data).
  491. Subclasses should be sure to validate the id,
  492. Company:
  493. @author Andrew C. Oliver
  494. @author Marc Johnson (mjohnson at apache dot org)
  495. @author Jason Height (jheight at chariot dot net dot au)
  496. @version 2.0-pre
  497. </member>
  498. <member name="M:NPOI.HSSF.Record.Record.#ctor">
  499. instantiates a blank record strictly for ID matching
  500. </member>
  501. <member name="M:NPOI.HSSF.Record.Record.Serialize">
  502. called by the class that is responsible for writing this sucker.
  503. Subclasses should implement this so that their data is passed back in a
  504. byte array.
  505. @return byte array containing instance data
  506. </member>
  507. <member name="P:NPOI.HSSF.Record.Record.Sid">
  508. return the non static version of the id for this record.
  509. </member>
  510. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(System.Int32,System.Byte[])">
  511. <summary>
  512. Write the data content of this BIFF record including the sid and record length.
  513. The subclass must write the exact number of bytes as reported by Record#getRecordSize()
  514. </summary>
  515. <param name="offset">offset</param>
  516. <param name="data">data</param>
  517. <returns></returns>
  518. </member>
  519. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  520. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
  521. have already been written by the superclass.<br/>
  522. The number of bytes written must equal the record size reported by
  523. {@link Record#getDataSize()} minus four
  524. ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
  525. by thye superclass).
  526. </member>
  527. <member name="T:NPOI.HSSF.Record.Chart.AttachedLabelRecord">
  528. * The series label record defines the type of label associated with the data format record.
  529. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  530. * Remove the record in src/records/definitions.
  531. * @author Glen Stampoultzis (glens at apache.org)
  532. </member>
  533. <member name="M:NPOI.HSSF.Record.Chart.AttachedLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  534. Constructs a SeriesLabels record and Sets its fields appropriately.
  535. @param in the RecordInputstream to Read the record from
  536. </member>
  537. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.DataSize">
  538. Size of record (exluding 4 byte header)
  539. </member>
  540. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.FormatFlags">
  541. Get the format flags field for the SeriesLabels record.
  542. </member>
  543. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowActual">
  544. show actual value of the data point
  545. @return the show actual field value.
  546. </member>
  547. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowPercent">
  548. show value as percentage of total (pie charts only)
  549. @return the show percent field value.
  550. </member>
  551. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsLabelAsPercentage">
  552. show category label/value as percentage (pie charts only)
  553. @return the label as percentage field value.
  554. </member>
  555. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsSmoothedLine">
  556. show smooth line
  557. @return the smoothed line field value.
  558. </member>
  559. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowLabel">
  560. Display category label
  561. @return the show label field value.
  562. </member>
  563. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowBubbleSizes">
  564. ??
  565. @return the show bubble sizes field value.
  566. </member>
  567. <member name="T:NPOI.HSSF.Record.Chart.AxcExtRecord">
  568. <summary>
  569. The AxcExt record specifies additional extension properties of a date axis (section 2.2.3.6),
  570. along with a CatSerRange record (section 2.4.39).
  571. </summary>
  572. </member>
  573. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorInterval">
  574. <summary>
  575. specifies the interval at which the major tick marks are displayed on the axis (section 2.2.3.6),
  576. in the unit defined by duMajor.
  577. </summary>
  578. </member>
  579. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorUnit">
  580. <summary>
  581. 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).
  582. If fDateAxis is set to 0, MUST be ignored.
  583. </summary>
  584. </member>
  585. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MinorInterval">
  586. <summary>
  587. specifies the interval at which the minor tick marks are displayed on the axis (section 2.2.3.6),
  588. in a unit defined by duMinor.
  589. </summary>
  590. </member>
  591. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.BaseUnit">
  592. <summary>
  593. specifies the smallest unit of time used by the axis (section 2.2.3.6).
  594. </summary>
  595. </member>
  596. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.CrossDate">
  597. <summary>
  598. specifies at which date, as a date in the date system specified by the Date1904 record (section 2.4.77),
  599. in the units defined by duBase, the value axis (section 2.2.3.6) crosses this axis (section 2.2.3.6).
  600. </summary>
  601. </member>
  602. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMin">
  603. <summary>
  604. specifies whether MinimumDate is calculated automatically.
  605. </summary>
  606. </member>
  607. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMax">
  608. <summary>
  609. specifies whether MaximumDate is calculated automatically.
  610. </summary>
  611. </member>
  612. <member name="T:NPOI.HSSF.Record.Chart.AxesUsedRecord">
  613. * The number of axes used on a chart.
  614. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  615. * Remove the record in src/records/definitions.
  616. * @author Glen Stampoultzis (glens at apache.org)
  617. </member>
  618. <member name="M:NPOI.HSSF.Record.Chart.AxesUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  619. Constructs a AxisUsed record and Sets its fields appropriately.
  620. @param in the RecordInputstream to Read the record from
  621. </member>
  622. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.DataSize">
  623. Size of record (exluding 4 byte header)
  624. </member>
  625. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.NumAxis">
  626. Get the num axis field for the AxisUsed record.
  627. </member>
  628. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.AxisLine">
  629. <summary>
  630. The axis (section 2.2.3.6) line itself.
  631. </summary>
  632. </member>
  633. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MajorGridLine">
  634. <summary>
  635. The major gridlines along the axis
  636. </summary>
  637. </member>
  638. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MinorGridLine">
  639. <summary>
  640. The minor gridlines along the axis
  641. </summary>
  642. </member>
  643. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.WallsOrFloorOf3D">
  644. <summary>
  645. The walls or floor of a 3-D chart
  646. </summary>
  647. </member>
  648. <member name="T:NPOI.HSSF.Record.Chart.AxisLineRecord">
  649. <summary>
  650. The AxisLine record specifies which part of the axis (section 2.2.3.6) is
  651. specified by the LineFormat record (section 2.4.156) that follows.
  652. Excel Binary File Format (.xls) Structure Specification
  653. </summary>
  654. </member>
  655. <member name="M:NPOI.HSSF.Record.Chart.AxisLineRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  656. Constructs a AxisLineFormat record and Sets its fields appropriately.
  657. @param in the RecordInputstream to Read the record from
  658. </member>
  659. <member name="P:NPOI.HSSF.Record.Chart.AxisLineRecord.DataSize">
  660. Size of record (exluding 4 byte header)
  661. </member>
  662. <member name="P:NPOI.HSSF.Record.Chart.AxisLineRecord.AxisType">
  663. <summary>
  664. </summary>
  665. </member>
  666. <member name="T:NPOI.HSSF.Record.Chart.BopPopCustomRecord">
  667. <summary>
  668. The BopPopCustom record specifies which data points in the series are contained
  669. in the secondary bar/pie instead of the primary pie. MUST follow a BopPop record
  670. that has its split field set to Custom (0x0003).
  671. </summary>
  672. <remarks>
  673. author: Antony liu (antony.apollo at gmail.com)
  674. </remarks>
  675. </member>
  676. <member name="T:NPOI.HSSF.Record.RowDataRecord">
  677. <summary>
  678. this record only used for record that has name and not implemented.
  679. </summary>
  680. </member>
  681. <member name="T:NPOI.HSSF.Record.Chart.BopPopRecord">
  682. <summary>
  683. The BopPop record specifies that the chart group is a bar of pie chart group or
  684. a pie of pie chart group and specifies the chart group attributes.
  685. </summary>
  686. <remarks>
  687. author: Antony liu (antony.apollo at gmail.com)
  688. </remarks>
  689. </member>
  690. <member name="T:NPOI.HSSF.Record.Chart.BRAIRecord">
  691. <summary>
  692. The BRAI record specifies a reference to data in a sheet (1) that is used by a part of a series,
  693. legend entry, trendline or error bars.
  694. </summary>
  695. </member>
  696. <member name="F:NPOI.HSSF.Record.Chart.BRAIRecord.field_5_formulaOfLink">
  697. <summary>
  698. A ChartParsedFormula structure that specifies the formula (section 2.2.2) that specifies the reference.
  699. </summary>
  700. </member>
  701. <member name="M:NPOI.HSSF.Record.Chart.BRAIRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  702. Constructs a LinkedData record and Sets its fields appropriately.
  703. @param in the RecordInputstream to Read the record from
  704. </member>
  705. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.DataSize">
  706. Size of record (exluding 4 byte header)
  707. </member>
  708. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.LinkType">
  709. <summary>
  710. specifies the part of the series, trendline, or error bars the referenced data specifies.
  711. </summary>
  712. </member>
  713. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.IndexNumberFmtRecord">
  714. <summary>
  715. specifies the number format to use for the data.
  716. </summary>
  717. </member>
  718. <member name="T:NPOI.HSSF.Record.Chart.CatSerRangeRecord">
  719. <summary>
  720. specifies the properties of a category (3) axis, a date axis, or a series axis.
  721. </summary>
  722. </member>
  723. <member name="M:NPOI.HSSF.Record.Chart.CatSerRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  724. Constructs a CategorySeriesAxis record and Sets its fields appropriately.
  725. @param in the RecordInputstream to Read the record from
  726. </member>
  727. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.DataSize">
  728. Size of record (exluding 4 byte header)
  729. </member>
  730. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.CrossPoint">
  731. <summary>
  732. specifies where the value axis crosses this axis, based on the following table.
  733. If fMaxCross is set to 1, the value this field MUST be ignored.
  734. Category (3) axis This field specifies the category (3) at which the value axis crosses.
  735. For example, if this field is 2, the value axis crosses this axis at the second category (3)
  736. on this axis. MUST be greater than or equal to 1 and less than or equal to 31999.
  737. Series axis MUST be 0.
  738. Date axis catCross MUST be equal to the value given by the following formula:
  739. catCross = catCrossDate – catMin + 1
  740. Where catCrossDate is the catCrossDate field of the AxcExt record
  741. and catMin is the catMin field of the AxcExt record.
  742. </summary>
  743. </member>
  744. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.LabelInterval">
  745. <summary>
  746. specifies the interval between axis labels on this axis. MUST be greater than or equal to 1 and
  747. less than or equal to 31999. MUST be ignored for a date axis.
  748. </summary>
  749. </member>
  750. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.MarkInterval">
  751. <summary>
  752. specifies the interval at which major tick marks and minor tick marks are displayed on the axis.
  753. Major tick marks and minor tick marks that would have been visible are hidden unless they are
  754. located at a multiple of this field.
  755. </summary>
  756. </member>
  757. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsBetween">
  758. <summary>
  759. specifies whether the value axis crosses this axis between major tick marks. MUST be a value from to following table:
  760. 0 The value axis crosses this axis on a major tick mark.
  761. 1 The value axis crosses this axis between major tick marks.
  762. </summary>
  763. </member>
  764. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsMaxCross">
  765. <summary>
  766. specifies whether the value axis crosses this axis at the last category (3), the last series,
  767. or the maximum date. MUST be a value from the following table:
  768. 0 The value axis crosses this axis at the value specified by catCross.
  769. 1 The value axis crosses this axis at the last category (3), the last series, or the maximum date.
  770. </summary>
  771. </member>
  772. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsReverse">
  773. <summary>
  774. specifies whether the axis is displayed in reverse order. MUST be a value from the following table:
  775. 0 The axis is displayed in order.
  776. 1 The axis is display in reverse order.
  777. </summary>
  778. </member>
  779. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Riser">
  780. <summary>
  781. the shape of the base of the data points in a bar or column chart group.
  782. MUST be a value from the following table
  783. 0x00 The base of the data point is a rectangle.
  784. 0x01 The base of the data point is an ellipse.
  785. </summary>
  786. </member>
  787. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Taper">
  788. <summary>
  789. how the data points in a bar or column chart group taper from base to tip.
  790. MUST be a value from the following
  791. 0x00 The data points of the bar or column chart group do not taper.
  792. The shape at the maximum value of the data point is the same as the shape at the base.:
  793. 0x01 The data points of the bar or column chart group taper to a point at the maximum value of each data point.
  794. 0x02 The data points of the bar or column chart group taper towards a projected point at the position of
  795. the maximum value of all of the data points in the chart group, but are clipped at the value of each data point.
  796. </summary>
  797. </member>
  798. <member name="T:NPOI.HSSF.Record.Chart.CrtLineRecord">
  799. <summary>
  800. The CrtLine record specifies the presence of drop lines, high-low lines, series lines
  801. or leader lines on the chart group. This record is followed by a LineFormat record
  802. which specifies the format of the lines.
  803. </summary>
  804. <remarks>
  805. author: Antony liu (antony.apollo at gmail.com)
  806. </remarks>
  807. </member>
  808. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtContinueRecord">
  809. <summary>
  810. The CrtMlFrtContinue record specifies additional data for a CrtMlFrt record, as specified in the CrtMlFrt record.
  811. </summary>
  812. <remarks>
  813. author: Antony liu (antony.apollo at gmail.com)
  814. </remarks>
  815. </member>
  816. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtContentsRecord">
  817. <summary>
  818. The DataLabExtContents record specifies the contents of an extended data label.
  819. </summary>
  820. </member>
  821. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtRecord">
  822. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  823. @author Patrick Cheng
  824. </member>
  825. <member name="T:NPOI.HSSF.Record.Chart.TextFormatInfo">
  826. <summary>
  827. specifies the text elements that are formatted using the position and appearance information
  828. specified by the Text record immediately following this record.
  829. </summary>
  830. </member>
  831. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueNotSet">
  832. <summary>
  833. Format all Text records in the chart group where fShowPercent is equal to 0 or fShowValue is equal to 0.
  834. </summary>
  835. </member>
  836. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueSet">
  837. <summary>
  838. Format all Text records in the chart group where fShowPercent is equal to 1 or fShowValue is equal to 1.
  839. </summary>
  840. </member>
  841. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleNotSet">
  842. <summary>
  843. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 0.
  844. </summary>
  845. </member>
  846. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleSet">
  847. <summary>
  848. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 1.
  849. </summary>
  850. </member>
  851. <member name="T:NPOI.HSSF.Record.Chart.DefaultTextRecord">
  852. <summary>
  853. specifies the text elements that are formatted using the information specified by
  854. the Text record immediately following this record.
  855. </summary>
  856. </member>
  857. <member name="M:NPOI.HSSF.Record.Chart.DefaultTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  858. Constructs a DefaultDataLabelTextProperties record and Sets its fields appropriately.
  859. @param in the RecordInputstream to Read the record from
  860. </member>
  861. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.DataSize">
  862. Size of record (exluding 4 byte header)
  863. </member>
  864. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.FormatType">
  865. <summary>
  866. specifies the text elements that are formatted using the position and appearance
  867. information specified by the Text record immediately following this record.
  868. </summary>
  869. </member>
  870. <member name="T:NPOI.HSSF.Record.Chart.DropBarRecord">
  871. <summary>
  872. The DropBar record specifies the attributes of the up bars or the down bars between multiple
  873. series of a line chart group and specifies the beginning of a collection of records as
  874. defined by the Chart Sheet Substream ABNF. The first of these collections in the line chart
  875. group specifies the attributes of the up bars. The second specifies the attributes of the
  876. down bars. If this record exists, then the chart group type MUST be line and the field cSer
  877. in the record SeriesList MUST be greater than 1.
  878. </summary>
  879. <remarks>
  880. author: Antony liu (antony.apollo at gmail.com)
  881. </remarks>
  882. </member>
  883. <member name="T:NPOI.HSSF.Record.Chart.EndBlockRecord">
  884. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  885. @author Patrick Cheng
  886. </member>
  887. <member name="T:NPOI.HSSF.Record.Chart.Fbi2Record">
  888. <summary>
  889. The Fbi2 record specifies the font information at the time the scalable font is added to the chart.
  890. </summary>
  891. <remarks>
  892. author: Antony liu (antony.apollo at gmail.com)
  893. </remarks>
  894. </member>
  895. <member name="T:NPOI.HSSF.Record.Chart.FbiRecord">
  896. <summary>
  897. The Fbi record specifies the font information at the time the scalable font is added to the chart.
  898. </summary>
  899. </member>
  900. <member name="M:NPOI.HSSF.Record.Chart.FbiRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  901. Constructs a FontBasis record and Sets its fields appropriately.
  902. @param in the RecordInputstream to Read the record from
  903. </member>
  904. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.DataSize">
  905. Size of record (exluding 4 byte header)
  906. </member>
  907. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.XBasis">
  908. Get the x Basis field for the FontBasis record.
  909. </member>
  910. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.YBasis">
  911. Get the y Basis field for the FontBasis record.
  912. </member>
  913. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.HeightBasis">
  914. Get the height basis field for the FontBasis record.
  915. </member>
  916. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.Scale">
  917. Get the scale field for the FontBasis record.
  918. </member>
  919. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.IndexToFontTable">
  920. Get the index to font table field for the FontBasis record.
  921. </member>
  922. <member name="T:NPOI.HSSF.Record.Chart.FontXRecord">
  923. <summary>
  924. The FontX record specifies the font for a given text element.
  925. The Font record referenced by iFont can exist in this chart sheet substream or the workbook.
  926. </summary>
  927. </member>
  928. <member name="M:NPOI.HSSF.Record.Chart.FontXRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  929. Constructs a FontIndex record and Sets its fields appropriately.
  930. @param in the RecordInputstream to Read the record from
  931. </member>
  932. <member name="P:NPOI.HSSF.Record.Chart.FontXRecord.DataSize">
  933. Size of record (exluding 4 byte header)
  934. </member>
  935. <member name="P:NPOI.HSSF.Record.Chart.FontXRecord.FontIndex">
  936. <summary>
  937. specifies the font to use for subsequent records.
  938. This font can either be the default font of the chart, part of the collection of Font records following
  939. the FrtFontList record, or part of the collection of Font records in the globals substream.
  940. If iFont is 0x0000, this record specifies the default font of the chart.
  941. If iFont is less than or equal to the number of Font records in the globals substream,
  942. iFont is a one-based index to a Font record in the globals substream.
  943. Otherwise iFont is a one-based index into the collection of Font records in this chart sheet substream
  944. where the index is equal to iFont – n, where n is the number of Font records in the globals substream.
  945. </summary>
  946. </member>
  947. <member name="T:NPOI.HSSF.Record.Chart.FrtFontListRecord">
  948. <summary>
  949. The FrtFontList record specifies font information used on the chart and specifies the
  950. beginning of a collection of Font records as defined by the Chart Sheet Substream ABNF.
  951. </summary>
  952. <remarks>
  953. author: Antony liu (antony.apollo at gmail.com)
  954. </remarks>
  955. </member>
  956. <member name="T:NPOI.HSSF.Record.Chart.GelFrameRecord">
  957. <summary>
  958. specifies the properties of a fill pattern for parts of a chart.
  959. </summary>
  960. <remarks>
  961. author: Antony liu (antony.apollo at gmail.com)
  962. </remarks>
  963. </member>
  964. <member name="T:NPOI.HSSF.Record.Chart.IFmtRecordRecord">
  965. <summary>
  966. The IFmtRecord record specifies the number format to use for the text on an axis.
  967. </summary>
  968. </member>
  969. <member name="M:NPOI.HSSF.Record.Chart.IFmtRecordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  970. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  971. @param in the RecordInputstream to Read the record from
  972. </member>
  973. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.DataSize">
  974. Size of record (exluding 4 byte header)
  975. </member>
  976. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.FormatIndex">
  977. Get the format index field for the NumberFormatIndex record.
  978. </member>
  979. <member name="T:NPOI.HSSF.Record.Chart.LegendExceptionRecord">
  980. <summary>
  981. The LegendException record specifies information about a legend entry which was
  982. changed from the default legend entry settings, and specifies the beginning of
  983. a collection of records as defined by the Chart Sheet Substream ABNF.
  984. The collection of records specifies legend entry formatting. On a chart where
  985. the legend contains legend entries for the series and trendlines, as defined
  986. in the legend overview, there MUST be zero instances or one instance of this
  987. record in the sequence of records that conform to the SERIESFORMAT rule.
  988. </summary>
  989. <remarks>
  990. author: Antony liu (antony.apollo at gmail.com)
  991. </remarks>
  992. </member>
  993. <member name="T:NPOI.HSSF.Record.Chart.PicFRecord">
  994. <summary>
  995. The PicF record specifies the layout of a picture that is attached to a picture-filled chart element.
  996. </summary>
  997. <remarks>
  998. author: Antony liu (antony.apollo at gmail.com)
  999. </remarks>
  1000. </member>
  1001. <member name="T:NPOI.HSSF.Record.Chart.RadarAreaRecord">
  1002. <summary>
  1003. The RadarArea record specifies that the chart group is a filled radar chart group and specifies the chart group attributes.
  1004. </summary>
  1005. <remarks>
  1006. author: Antony liu (antony.apollo at gmail.com)
  1007. </remarks>
  1008. </member>
  1009. <member name="T:NPOI.HSSF.Record.Chart.RadarRecord">
  1010. <summary>
  1011. The Radar record specifies that the chart group is a radar chart group and specifies the chart group attributes.
  1012. </summary>
  1013. <remarks>
  1014. author: Antony liu (antony.apollo at gmail.com)
  1015. </remarks>
  1016. </member>
  1017. <member name="T:NPOI.HSSF.Record.Chart.RichTextStreamRecord">
  1018. <summary>
  1019. The RichTextStream record specifies additional text properties for the text in
  1020. the entire chart, text in the current legend, text in the current legend entry,
  1021. or text in the attached label. These text properties are a superset of the
  1022. properties stored in the Text, Font, FontX, BRAI, and ObjectLink records based
  1023. on the following table, as specified by the Chart Sheet Substream ABNF. In each
  1024. case, the associated Font record is specified by the associated FontX record.
  1025. </summary>
  1026. <remarks>
  1027. author: Antony liu (antony.apollo at gmail.com)
  1028. </remarks>
  1029. </member>
  1030. <member name="T:NPOI.HSSF.Record.Chart.ScatterRecord">
  1031. <summary>
  1032. The Scatter record specifies that the chart group is a scatter chart group or
  1033. a bubble chart group, and specifies the chart group attributes.
  1034. </summary>
  1035. <remarks>
  1036. author: Antony liu (antony.apollo at gmail.com)
  1037. </remarks>
  1038. </member>
  1039. <member name="T:NPOI.HSSF.Record.Chart.SerAuxErrBarRecord">
  1040. <summary>
  1041. The SerAuxErrBar record specifies properties of an error bar.
  1042. </summary>
  1043. <remarks>
  1044. author: Antony liu (antony.apollo at gmail.com)
  1045. </remarks>
  1046. </member>
  1047. <member name="T:NPOI.HSSF.Record.Chart.SerAuxTrendRecord">
  1048. <summary>
  1049. The SerAuxTrend record specifies a trendline.
  1050. </summary>
  1051. <remarks>
  1052. author: Antony liu (antony.apollo at gmail.com)
  1053. </remarks>
  1054. </member>
  1055. <member name="T:NPOI.HSSF.Record.Chart.SerFmtRecord">
  1056. <summary>
  1057. The SerFmt record specifies properties of the associated data points, data markers,
  1058. or lines of the series. The associated data points, data markers, or lines of the
  1059. series are specified by the preceding DataFormat record. If this record is not
  1060. present in the sequence of records that conforms to the SS rule of the Chart Sheet
  1061. Substream ABNF, then the properties of the associated data points, data markers,
  1062. or lines of the series are specified by the default values of the fields of this record.
  1063. </summary>
  1064. <remarks>
  1065. author: Antony liu (antony.apollo at gmail.com)
  1066. </remarks>
  1067. </member>
  1068. <member name="T:NPOI.HSSF.Record.Chart.SerParentRecord">
  1069. <summary>
  1070. The SerParent record specifies the series to which the current trendline or error bar corresponds.
  1071. </summary>
  1072. <remarks>
  1073. author: Antony liu (antony.apollo at gmail.com)
  1074. </remarks>
  1075. </member>
  1076. <member name="T:NPOI.HSSF.Record.Chart.SerToCrtRecord">
  1077. <summary>
  1078. The SerToCrt record specifies the chart group for the current series.
  1079. </summary>
  1080. </member>
  1081. <member name="M:NPOI.HSSF.Record.Chart.SerToCrtRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1082. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  1083. @param in the RecordInputstream to Read the record from
  1084. </member>
  1085. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.DataSize">
  1086. Size of record (exluding 4 byte header)
  1087. </member>
  1088. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.ChartGroupIndex">
  1089. Get the chart Group index field for the SeriesChartGroupIndex record.
  1090. </member>
  1091. <member name="T:NPOI.HSSF.Record.Chart.ShapePropsStreamRecord">
  1092. <summary>
  1093. The ShapePropsStream record specifies the shape formatting properties for chart elements.
  1094. These shape formatting properties are a superset of the properties stored in the LineFormat,
  1095. AreaFormat, MarkerFormat, and GelFrame records. They are stored in the rgb field, which is an
  1096. XML stream (section 2.1.7.22), as defined in [ECMA-376] Part 4, section 5.7.2.198.
  1097. </summary>
  1098. <remarks>
  1099. author: Antony liu (antony.apollo at gmail.com)
  1100. </remarks>
  1101. </member>
  1102. <member name="T:NPOI.HSSF.Record.Chart.ShtPropsRecord">
  1103. * Describes a chart sheet properties record.
  1104. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  1105. * Remove the record in src/records/definitions.
  1106. * @author Glen Stampoultzis (glens at apache.org)
  1107. <summary>
  1108. specifies properties of a chart as defined by the Chart Sheet Substream ABNF
  1109. </summary>
  1110. </member>
  1111. <member name="M:NPOI.HSSF.Record.Chart.ShtPropsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1112. Constructs a SheetProperties record and Sets its fields appropriately.
  1113. @param in the RecordInputstream to Read the record from
  1114. </member>
  1115. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.DataSize">
  1116. Size of record (exluding 4 byte header)
  1117. </member>
  1118. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Flags">
  1119. Get the flags field for the SheetProperties record.
  1120. </member>
  1121. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Blank">
  1122. Get the empty field for the SheetProperties record.
  1123. @return One of
  1124. EMPTY_NOT_PLOTTED
  1125. EMPTY_ZERO
  1126. EMPTY_INTERPOLATED
  1127. <summary>
  1128. specifies how the empty cells are plotted be a value from the following table:
  1129. 0x00 Empty cells are not plotted.
  1130. 0x01 Empty cells are plotted as zero.
  1131. 0x02 Empty cells are plotted as interpolated.
  1132. </summary>
  1133. </member>
  1134. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManSerAlloc">
  1135. <summary>
  1136. whether series are automatically allocated for the chart.
  1137. </summary>
  1138. </member>
  1139. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsPlotVisibleOnly">
  1140. <summary>
  1141. whether to plot visible cells only.
  1142. </summary>
  1143. </member>
  1144. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsNotSizeWithWindow">
  1145. <summary>
  1146. whether to size the chart with the window.
  1147. </summary>
  1148. </member>
  1149. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManPlotArea">
  1150. <summary>
  1151. If fAlwaysAutoPlotArea is 1, then this field MUST be 1.
  1152. If fAlwaysAutoPlotArea is 0, then this field MUST be ignored.
  1153. </summary>
  1154. </member>
  1155. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsAlwaysAutoPlotArea">
  1156. <summary>
  1157. specifies whether the default plot area dimension (2) is used.
  1158. 0 Use the default plot area dimension (2) regardless of the Pos record information.
  1159. 1 Use the plot area dimension (2) of the Pos record; and fManPlotArea MUST be 1.
  1160. </summary>
  1161. </member>
  1162. <member name="T:NPOI.HSSF.Record.Chart.StartBlockRecord">
  1163. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  1164. @author Patrick Cheng
  1165. </member>
  1166. <member name="T:NPOI.HSSF.Record.Chart.SurfRecord">
  1167. <summary>
  1168. The Surf record specifies that the chart group is a surface chart group and specifies the chart group attributes.
  1169. </summary>
  1170. <remarks>
  1171. author: Antony liu (antony.apollo at gmail.com)
  1172. </remarks>
  1173. </member>
  1174. <member name="T:NPOI.HSSF.Record.Chart.TextPropsStreamRecord">
  1175. <summary>
  1176. The RichTextStream record specifies additional text properties for the text
  1177. in the entire chart, text in the current legend, text in the current legend
  1178. entry, or text in the attached label. These text properties are a superset
  1179. of the properties stored in the Text, Font, FontX, BRAI, and ObjectLink records
  1180. based on the following table, as specified by the Chart Sheet Substream ABNF.
  1181. In each case, the associated Font record is specified by the associated FontX record.
  1182. </summary>
  1183. <remarks>
  1184. author: Antony liu (antony.apollo at gmail.com)
  1185. </remarks>
  1186. </member>
  1187. <member name="T:NPOI.HSSF.Record.Chart.YMultRecord">
  1188. <summary>
  1189. The YMult record specifies properties of the value multiplier for a value axis and
  1190. that specifies the beginning of a collection of records as defined by the Chart Sheet
  1191. substream ABNF. The collection of records specifies a display units label.
  1192. </summary>
  1193. <remarks>
  1194. author: Antony liu (antony.apollo at gmail.com)
  1195. </remarks>
  1196. </member>
  1197. <member name="T:NPOI.HSSF.Record.ContinueFrt12Record">
  1198. <summary>
  1199. The ContinueFrt12 record specifies a continuation of the data in a preceding Future Record
  1200. Type record that has data longer than 8,224 bytes. Such records are split into several records.
  1201. The first section of the data appears in the base record and subsequent sections appear in
  1202. one or more ContinueFrt12 records that appear after the base record. The preceding base record
  1203. MUST contain a FrtRefHeader or a FrtHeader field.
  1204. </summary>
  1205. <remarks>
  1206. author: Antony liu (antony.apollo at gmail.com)
  1207. </remarks>
  1208. </member>
  1209. <member name="T:NPOI.HSSF.Record.DConRefRecord">
  1210. DConRef records specify a range in a workbook (internal or external) that serves as a data source
  1211. for pivot tables or data consolidation.
  1212. Represents a <code>DConRef</code> Structure
  1213. <a href="http://msdn.microsoft.com/en-us/library/dd923854(office.12).aspx">[MS-XLS s.
  1214. 2.4.86]</a>, and the contained <code>DConFile</code> structure
  1215. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  1216. [MS-XLS s. 2.5.69]</a>. This in turn contains a <code>XLUnicodeStringNoCch</code>
  1217. <a href="http://msdn.microsoft.com/en-us/library/dd910585(office.12).aspx">
  1218. [MS-XLS s. 2.5.296]</a>.
  1219. <pre>
  1220. _______________________________
  1221. | DConRef |
  1222. (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  1223. | ref |cch| stFile | un|
  1224. +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  1225. |
  1226. _________|_____________________
  1227. |DConFile / XLUnicodeStringNoCch|
  1228. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  1229. (bits) |h| reserved | rgb |
  1230. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  1231. </pre>
  1232. Where
  1233. <ul>
  1234. <li><code>DConFile.h = 0x00</code> if the characters in<code>rgb</code> are single byte, and
  1235. <code>DConFile.h = 0x01</code> if they are double byte. <br/>
  1236. If they are double byte, then<br/>
  1237. <ul>
  1238. <li> If it exists, the length of <code>DConRef.un = 2</code>. Otherwise it is 1.</li>
  1239. <li> The length of <code>DConFile.rgb = (2 * DConRef.cch)</code>. Otherwise it is equal to
  1240. <code>DConRef.cch</code></li>.
  1241. </ul>
  1242. </li>
  1243. <li><code>DConRef.rgb</code> starts with <code>0x01</code> if it is an external reference,
  1244. and with <code>0x02</code> if it is a self-reference.</li>
  1245. </ul>
  1246. At the moment this class is read-only.
  1247. @author Niklas Rehfeld
  1248. </member>
  1249. <member name="F:NPOI.HSSF.Record.DConRefRecord.sid">
  1250. The id of the record type,
  1251. <code>sid = {@value}</code>
  1252. </member>
  1253. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstRow">
  1254. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1255. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1256. [MS XLS s.2.5.211]</a>
  1257. </member>
  1258. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastRow">
  1259. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1260. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1261. [MS XLS s.2.5.211]</a>
  1262. </member>
  1263. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstCol">
  1264. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1265. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1266. [MS XLS s.2.5.211]</a>
  1267. </member>
  1268. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastCol">
  1269. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  1270. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  1271. [MS XLS s.2.5.211]</a>
  1272. </member>
  1273. <member name="F:NPOI.HSSF.Record.DConRefRecord.charCount">
  1274. the number of chars in the link
  1275. </member>
  1276. <member name="F:NPOI.HSSF.Record.DConRefRecord.charType">
  1277. the type of characters (single or double byte)
  1278. </member>
  1279. <member name="F:NPOI.HSSF.Record.DConRefRecord.path">
  1280. The link's path string. This is the <code>rgb</code> field of a
  1281. <code>XLUnicodeStringNoCch</code>. Therefore it will contain at least one leading special
  1282. character (0x01 or 0x02) and probably other ones.<p/>
  1283. @see <a href="http://msdn.microsoft.com/en-us/library/dd923491(office.12).aspx">
  1284. DConFile [MS-XLS s. 2.5.77]</a> and
  1285. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  1286. VirtualPath [MS-XLS s. 2.5.69]</a>
  1287. <p/>
  1288. </member>
  1289. <member name="F:NPOI.HSSF.Record.DConRefRecord._unused">
  1290. unused bits at the end, must be set to 0.
  1291. </member>
  1292. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(System.Byte[])">
  1293. Read constructor.
  1294. @param data byte array containing a DConRef Record, including the header.
  1295. </member>
  1296. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  1297. Read Constructor.
  1298. @param inStream RecordInputStream containing a DConRefRecord structure.
  1299. </member>
  1300. <member name="M:NPOI.HSSF.Record.DConRefRecord.GetPath">
  1301. @return raw path byte array.
  1302. </member>
  1303. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstColumn">
  1304. @return The first column of the range.
  1305. </member>
  1306. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstRow">
  1307. @return The first row of the range.
  1308. </member>
  1309. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastColumn">
  1310. @return The last column of the range.
  1311. </member>
  1312. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastRow">
  1313. @return The last row of the range.
  1314. </member>
  1315. <member name="P:NPOI.HSSF.Record.DConRefRecord.ReadablePath">
  1316. @return the link's path, with the special characters stripped/replaced. May be null.
  1317. See MS-XLS 2.5.277 (VirtualPath)
  1318. </member>
  1319. <member name="P:NPOI.HSSF.Record.DConRefRecord.IsExternalRef">
  1320. Checks if the data source in this reference record is external to this sheet or internal.
  1321. @return true iff this is an external reference.
  1322. </member>
  1323. <member name="T:NPOI.HSSF.UserModel.HSSFSimpleShape">
  1324. <summary>
  1325. Represents a simple shape such as a line, rectangle or oval.
  1326. @author Glen Stampoultzis (glens at apache.org)
  1327. </summary>
  1328. </member>
  1329. <member name="T:NPOI.HSSF.UserModel.HSSFShape">
  1330. <summary>
  1331. An abstract shape.
  1332. @author Glen Stampoultzis (glens at apache.org)
  1333. </summary>
  1334. </member>
  1335. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.ObjRecord)">
  1336. creates shapes from existing file
  1337. @param spContainer
  1338. @param objRecord
  1339. </member>
  1340. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  1341. <summary>
  1342. Create a new shape with the specified parent and anchor.
  1343. </summary>
  1344. <param name="parent">The parent.</param>
  1345. <param name="anchor">The anchor.</param>
  1346. </member>
  1347. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  1348. <summary>
  1349. Sets the color applied to the lines of this shape
  1350. </summary>
  1351. <param name="red">The red.</param>
  1352. <param name="green">The green.</param>
  1353. <param name="blue">The blue.</param>
  1354. </member>
  1355. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  1356. <summary>
  1357. Sets the color used to fill this shape.
  1358. </summary>
  1359. <param name="red">The red.</param>
  1360. <param name="green">The green.</param>
  1361. <param name="blue">The blue.</param>
  1362. </member>
  1363. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Parent">
  1364. <summary>
  1365. Gets the parent shape.
  1366. </summary>
  1367. <value>The parent.</value>
  1368. </member>
  1369. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Anchor">
  1370. <summary>
  1371. Gets or sets the anchor that is used by this shape.
  1372. </summary>
  1373. <value>The anchor.</value>
  1374. </member>
  1375. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyleColor">
  1376. <summary>
  1377. The color applied to the lines of this shape.
  1378. </summary>
  1379. <value>The color of the line style.</value>
  1380. </member>
  1381. <member name="P:NPOI.HSSF.UserModel.HSSFShape.FillColor">
  1382. <summary>
  1383. Gets or sets the color used to fill this shape.
  1384. </summary>
  1385. <value>The color of the fill.</value>
  1386. </member>
  1387. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineWidth">
  1388. <summary>
  1389. Gets or sets with width of the line in EMUs. 12700 = 1 pt.
  1390. </summary>
  1391. <value>The width of the line.</value>
  1392. </member>
  1393. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyle">
  1394. <summary>
  1395. Gets or sets One of the constants in LINESTYLE_*
  1396. </summary>
  1397. <value>The line style.</value>
  1398. </member>
  1399. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsNoFill">
  1400. <summary>
  1401. Gets or sets a value indicating whether this instance is no fill.
  1402. </summary>
  1403. <value>
  1404. <c>true</c> if this shape Is not filled with a color; otherwise, <c>false</c>.
  1405. </value>
  1406. </member>
  1407. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipVertical">
  1408. <summary>
  1409. whether this shape is vertically flipped.
  1410. </summary>
  1411. </member>
  1412. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipHorizontal">
  1413. <summary>
  1414. whether this shape is horizontally flipped.
  1415. </summary>
  1416. </member>
  1417. <member name="P:NPOI.HSSF.UserModel.HSSFShape.RotationDegree">
  1418. <summary>
  1419. get or set the rotation, in degrees, that is applied to a shape.
  1420. Negative values specify rotation in the counterclockwise direction.
  1421. Rotation occurs around the center of the shape.
  1422. The default value for this property is 0x00000000
  1423. </summary>
  1424. </member>
  1425. <member name="P:NPOI.HSSF.UserModel.HSSFShape.CountOfAllChildren">
  1426. <summary>
  1427. Count of all children and their childrens children.
  1428. </summary>
  1429. <value>The count of all children.</value>
  1430. </member>
  1431. <member name="M:NPOI.HSSF.UserModel.HSSFSimpleShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  1432. <summary>
  1433. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFSimpleShape"/> class.
  1434. </summary>
  1435. <param name="parent">The parent.</param>
  1436. <param name="anchor">The anchor.</param>
  1437. </member>
  1438. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.ShapeType">
  1439. <summary>
  1440. Gets the shape type.
  1441. </summary>
  1442. <value>One of the OBJECT_TYPE_* constants.</value>
  1443. @see #OBJECT_TYPE_LINE
  1444. @see #OBJECT_TYPE_OVAL
  1445. @see #OBJECT_TYPE_RECTANGLE
  1446. @see #OBJECT_TYPE_PICTURE
  1447. @see #OBJECT_TYPE_COMMENT
  1448. </member>
  1449. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.String">
  1450. <summary>
  1451. Get or set the rich text string used by this object.
  1452. </summary>
  1453. </member>
  1454. <member name="T:NPOI.HSSF.UserModel.HSSFShapeFactory">
  1455. @author Evgeniy Berlog
  1456. date: 05.06.12
  1457. </member>
  1458. <member name="M:NPOI.HSSF.UserModel.HSSFShapeFactory.CreateShapeTree(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.EscherAggregate,NPOI.HSSF.UserModel.HSSFShapeContainer,NPOI.POIFS.FileSystem.DirectoryNode)">
  1459. build shape tree from escher container
  1460. @param container root escher container from which escher records must be taken
  1461. @param agg - EscherAggregate
  1462. @param out - shape container to which shapes must be added
  1463. @param root - node to create HSSFObjectData shapes
  1464. </member>
  1465. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  1466. Copies an Entry into a target POIFS directory, recursively
  1467. </member>
  1468. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  1469. Copies all the nodes from one POIFS Directory to another
  1470. @param sourceRoot
  1471. is the source Directory to copy from
  1472. @param targetRoot
  1473. is the target Directory to copy to
  1474. </member>
  1475. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.FilteringDirectoryNode,NPOI.POIFS.FileSystem.FilteringDirectoryNode)">
  1476. Copies nodes from one Directory to the other minus the excepts
  1477. @param filteredSource The filtering source Directory to copy from
  1478. @param filteredTarget The filtering target Directory to copy to
  1479. </member>
  1480. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  1481. Copies nodes from one Directory to the other minus the excepts
  1482. @param sourceRoot
  1483. is the source Directory to copy from
  1484. @param targetRoot
  1485. is the target Directory to copy to
  1486. @param excepts
  1487. is a list of Strings specifying what nodes NOT to copy
  1488. @deprecated use {@link FilteringDirectoryNode} instead
  1489. </member>
  1490. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  1491. Copies all nodes from one POIFS to the other
  1492. @param source
  1493. is the source POIFS to copy from
  1494. @param target
  1495. is the target POIFS to copy to
  1496. </member>
  1497. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  1498. Copies nodes from one POIFS to the other, minus the excepts.
  1499. This delegates the filtering work to {@link FilteringDirectoryNode},
  1500. so excepts can be of the form "NodeToExclude" or
  1501. "FilteringDirectory/ExcludedChildNode"
  1502. @param source is the source POIFS to copy from
  1503. @param target is the target POIFS to copy to
  1504. @param excepts is a list of Entry Names to be excluded from the copy
  1505. </member>
  1506. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDirectoriesIdentical(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  1507. Checks to see if the two Directories hold the same contents.
  1508. For this to be true, they must have entries with the same names,
  1509. no entries in one but not the other, and the size+contents
  1510. of each entry must match, and they must share names.
  1511. To exclude certain parts of the Directory from being checked,
  1512. use a {@link FilteringDirectoryNode}
  1513. </member>
  1514. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDocumentsIdentical(NPOI.POIFS.FileSystem.DocumentEntry,NPOI.POIFS.FileSystem.DocumentEntry)">
  1515. Checks to see if two Documents have the same name
  1516. and the same contents. (Their parent directories are
  1517. not checked)
  1518. </member>
  1519. <member name="T:NPOI.POIFS.FileSystem.FilteringDirectoryNode">
  1520. <summary>
  1521. A DirectoryEntry filter, which exposes another DirectoryEntry less certain parts.
  1522. This is typically used when copying or comparing Filesystems.
  1523. </summary>
  1524. </member>
  1525. <member name="T:NPOI.POIFS.FileSystem.DirectoryEntry">
  1526. <summary>
  1527. This interface defines methods specific to Directory objects
  1528. managed by a Filesystem instance.
  1529. @author Marc Johnson (mjohnson at apache dot org)
  1530. </summary>
  1531. </member>
  1532. <member name="T:NPOI.POIFS.FileSystem.Entry">
  1533. <summary>
  1534. This interface provides access to an object managed by a Filesystem
  1535. instance. Entry objects are further divided into DocumentEntry and
  1536. DirectoryEntry instances.
  1537. @author Marc Johnson (mjohnson at apache dot org)
  1538. </summary>
  1539. </member>
  1540. <member name="M:NPOI.POIFS.FileSystem.Entry.Delete">
  1541. <summary>
  1542. Delete this Entry. ThIs operation should succeed, but there are
  1543. special circumstances when it will not:
  1544. If this Entry Is the root of the Entry tree, it cannot be
  1545. deleted, as there Is no way to Create another one.
  1546. If this Entry Is a directory, it cannot be deleted unless it Is
  1547. empty.
  1548. </summary>
  1549. <returns>true if the Entry was successfully deleted, else false</returns>
  1550. </member>
  1551. <member name="M:NPOI.POIFS.FileSystem.Entry.RenameTo(System.String)">
  1552. <summary>
  1553. Rename this Entry. ThIs operation will fail if:
  1554. There Is a sibling Entry (i.e., an Entry whose parent Is the
  1555. same as this Entry's parent) with the same name.
  1556. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  1557. by the Filesystem and many not be Changed.
  1558. </summary>
  1559. <param name="newName">the new name for this Entry</param>
  1560. <returns>true if the operation succeeded, else false</returns>
  1561. </member>
  1562. <member name="P:NPOI.POIFS.FileSystem.Entry.Name">
  1563. <summary>
  1564. Get the name of the Entry
  1565. </summary>
  1566. <value>The name.</value>
  1567. </member>
  1568. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDirectoryEntry">
  1569. <summary>
  1570. Is this a DirectoryEntry?
  1571. </summary>
  1572. <value>
  1573. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  1574. </value>
  1575. </member>
  1576. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDocumentEntry">
  1577. <summary>
  1578. Is this a DocumentEntry?
  1579. </summary>
  1580. <value>
  1581. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  1582. </value>
  1583. </member>
  1584. <member name="P:NPOI.POIFS.FileSystem.Entry.Parent">
  1585. <summary>
  1586. Get this Entry's parent (the DirectoryEntry that owns this
  1587. Entry). All Entry objects, except the root Entry, has a parent.
  1588. </summary>
  1589. <value>this Entry's parent; null iff this Is the root Entry</value>
  1590. This property is moved to EntryNode
  1591. </member>
  1592. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.GetEntry(System.String)">
  1593. <summary>
  1594. get a specified Entry by name
  1595. </summary>
  1596. <param name="name">the name of the Entry to obtain.</param>
  1597. <returns>the specified Entry, if it is directly contained in
  1598. this DirectoryEntry</returns>
  1599. </member>
  1600. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.IO.Stream)">
  1601. <summary>
  1602. Create a new DocumentEntry
  1603. </summary>
  1604. <param name="name">the name of the new DocumentEntry</param>
  1605. <param name="stream">the Stream from which to Create the new DocumentEntry</param>
  1606. <returns>the new DocumentEntry</returns>
  1607. </member>
  1608. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  1609. <summary>
  1610. Create a new DocumentEntry; the data will be provided later
  1611. </summary>
  1612. <param name="name">the name of the new DocumentEntry</param>
  1613. <param name="size">the size of the new DocumentEntry</param>
  1614. <param name="writer">BeforeWriting event handler</param>
  1615. <returns>the new DocumentEntry</returns>
  1616. </member>
  1617. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDirectory(System.String)">
  1618. <summary>
  1619. Create a new DirectoryEntry
  1620. </summary>
  1621. <param name="name">the name of the new DirectoryEntry</param>
  1622. <returns>the name of the new DirectoryEntry</returns>
  1623. </member>
  1624. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.HasEntry(System.String)">
  1625. <summary>
  1626. Checks if entry with specified name present
  1627. </summary>
  1628. <param name="name">entry name</param>
  1629. <returns>true if have</returns>
  1630. </member>
  1631. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.Entries">
  1632. <summary>
  1633. get an iterator of the Entry instances contained directly in
  1634. this instance (in other words, children only; no grandchildren
  1635. etc.)
  1636. </summary>
  1637. <value>The entries.never null, but hasNext() may return false
  1638. immediately (i.e., this DirectoryEntry is empty). All
  1639. objects retrieved by next() are guaranteed to be
  1640. implementations of Entry.</value>
  1641. </member>
  1642. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.IsEmpty">
  1643. <summary>
  1644. is this DirectoryEntry empty?
  1645. </summary>
  1646. <value><c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.</value>
  1647. </member>
  1648. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryCount">
  1649. <summary>
  1650. find out how many Entry instances are contained directly within
  1651. this DirectoryEntry
  1652. </summary>
  1653. <value>number of immediately (no grandchildren etc.) contained
  1654. Entry instances</value>
  1655. </member>
  1656. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.StorageClsid">
  1657. <summary>
  1658. Gets or sets the storage ClassID.
  1659. </summary>
  1660. <value>The storage ClassID.</value>
  1661. </member>
  1662. <member name="M:NPOI.POIFS.FileSystem.FilteringDirectoryNode.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.ICollection{System.String})">
  1663. <summary>
  1664. Creates a filter round the specified directory, which will exclude entries such as
  1665. "MyNode" and "MyDir/IgnoreNode". The excludes can stretch into children, if they contain a /.
  1666. </summary>
  1667. <param name="directory">The Directory to filter</param>
  1668. <param name="excludes">The Entries to exclude</param>
  1669. </member>
  1670. <member name="M:NPOI.Util.POIUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  1671. Copies an Entry into a target POIFS directory, recursively
  1672. </member>
  1673. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  1674. Copies nodes from one POIFS to the other minus the excepts
  1675. @param source
  1676. is the source POIFS to copy from
  1677. @param target
  1678. is the target POIFS to copy to
  1679. @param excepts
  1680. is a list of Strings specifying what nodes NOT to copy
  1681. </member>
  1682. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  1683. Copies nodes from one POIFS to the other minus the excepts
  1684. @param source
  1685. is the source POIFS to copy from
  1686. @param target
  1687. is the target POIFS to copy to
  1688. @param excepts
  1689. is a list of Strings specifying what nodes NOT to copy
  1690. </member>
  1691. <member name="T:NPOI.SS.Formula.Atp.ArgumentsEvaluator">
  1692. Evaluator for formula arguments.
  1693. @author jfaenomoto@gmail.com
  1694. </member>
  1695. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDateArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  1696. Evaluate a generic {@link ValueEval} argument to a double value that represents a date in POI.
  1697. @param arg {@link ValueEval} an argument.
  1698. @param srcCellRow number cell row.
  1699. @param srcCellCol number cell column.
  1700. @return a double representing a date in POI.
  1701. @throws EvaluationException exception upon argument evaluation.
  1702. </member>
  1703. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDatesArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  1704. Evaluate a generic {@link ValueEval} argument to an array of double values that represents dates in POI.
  1705. @param arg {@link ValueEval} an argument.
  1706. @param srcCellRow number cell row.
  1707. @param srcCellCol number cell column.
  1708. @return an array of doubles representing dates in POI.
  1709. @throws EvaluationException exception upon argument evaluation.
  1710. </member>
  1711. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateNumberArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  1712. Evaluate a generic {@link ValueEval} argument to a double value.
  1713. @param arg {@link ValueEval} an argument.
  1714. @param srcCellRow number cell row.
  1715. @param srcCellCol number cell column.
  1716. @return a double value.
  1717. @throws EvaluationException exception upon argument evaluation.
  1718. </member>
  1719. <member name="T:NPOI.SS.Formula.Atp.DateParser">
  1720. Parser for java dates.
  1721. @author jfaenomoto@gmail.com
  1722. </member>
  1723. <member name="M:NPOI.SS.Formula.Atp.DateParser.ParseDate(System.String)">
  1724. Parses a date from a string.
  1725. @param strVal a string with a date pattern.
  1726. @return a date parsed from argument.
  1727. @throws EvaluationException exception upon parsing.
  1728. </member>
  1729. <member name="M:NPOI.SS.Formula.Atp.DateParser.MakeDate(System.Int32,System.Int32,System.Int32)">
  1730. @param month 1-based
  1731. </member>
  1732. <member name="T:NPOI.SS.Formula.Atp.NetworkdaysFunction">
  1733. Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()<br/>
  1734. Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non
  1735. saturday/sunday date.
  1736. <p/>
  1737. <b>Syntax</b><br/>
  1738. <b>NETWORKDAYS</b>(<b>startDate</b>, <b>endDate</b>, holidays)
  1739. <p/>
  1740. @author jfaenomoto@gmail.com
  1741. </member>
  1742. <member name="T:NPOI.SS.Formula.Functions.FreeRefFunction">
  1743. For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are
  1744. passed in as arguments, and the exact location remains fixed. However, a select few Excel
  1745. functions have the ability to access cells that were not part of any reference passed as an
  1746. argument.<br/>
  1747. Two important functions with this feature are <b>INDIRECT</b> and <b>OFFSet</b><p/>
  1748. In POI, the <c>HSSFFormulaEvaluator</c> Evaluates every cell in each reference argument before
  1749. calling the function. This means that functions using fixed references do not need access to
  1750. the rest of the workbook to execute. Hence the <c>Evaluate()</c> method on the common
  1751. interface <c>Function</c> does not take a workbook parameter.
  1752. This interface recognises the requirement of some functions to freely Create and Evaluate
  1753. references beyond those passed in as arguments.
  1754. @author Josh Micich
  1755. </member>
  1756. <member name="M:NPOI.SS.Formula.Functions.FreeRefFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  1757. @param args the pre-Evaluated arguments for this function. args is never <code>null</code>,
  1758. nor are any of its elements.
  1759. @param ec primarily used to identify the source cell Containing the formula being Evaluated.
  1760. may also be used to dynamically create reference evals.
  1761. @return never <code>null</code>. Possibly an instance of <c>ErrorEval</c> in the case of
  1762. a specified Excel error (Exceptions are never thrown to represent Excel errors).
  1763. </member>
  1764. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.#ctor(NPOI.SS.Formula.Atp.ArgumentsEvaluator)">
  1765. Constructor.
  1766. @param anEvaluator an injected {@link ArgumentsEvaluator}.
  1767. </member>
  1768. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  1769. Evaluate for NETWORKDAYS. Given two dates and a optional date or interval of holidays, determines how many working days are there
  1770. between those dates.
  1771. @return {@link ValueEval} for the number of days between two dates.
  1772. </member>
  1773. <member name="T:NPOI.SS.Formula.Atp.WorkdayCalculator">
  1774. A calculator for workdays, considering dates as excel representations.
  1775. @author jfaenomoto@gmail.com
  1776. </member>
  1777. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.#ctor">
  1778. Constructor.
  1779. </member>
  1780. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Double,System.Double[])">
  1781. Calculate how many workdays are there between a start and an end date, as excel representations, considering a range of holidays.
  1782. @param start start date.
  1783. @param end end date.
  1784. @param holidays an array of holidays.
  1785. @return number of workdays between start and end dates, including both dates.
  1786. </member>
  1787. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Int32,System.Double[])">
  1788. Calculate the workday past x workdays from a starting date, considering a range of holidays.
  1789. @param start start date.
  1790. @param workdays number of workdays to be past from starting date.
  1791. @param holidays an array of holidays.
  1792. @return date past x workdays.
  1793. </member>
  1794. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.PastDaysOfWeek(System.Double,System.Double,System.DayOfWeek)">
  1795. Calculates how many days of week past between a start and an end date.
  1796. @param start start date.
  1797. @param end end date.
  1798. @param dayOfWeek a day of week as represented by {@link Calendar} constants.
  1799. @return how many days of week past in this interval.
  1800. </member>
  1801. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateNonWeekendHolidays(System.Double,System.Double,System.Double[])">
  1802. Calculates how many holidays in a list are workdays, considering an interval of dates.
  1803. @param start start date.
  1804. @param end end date.
  1805. @param holidays an array of holidays.
  1806. @return number of holidays that occur in workdays, between start and end dates.
  1807. </member>
  1808. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsWeekend(System.Double)">
  1809. @param aDate a given date.
  1810. @return <code>true</code> if date is weekend, <code>false</code> otherwise.
  1811. </member>
  1812. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsHoliday(System.Double,System.Double[])">
  1813. @param aDate a given date.
  1814. @param holidays an array of holidays.
  1815. @return <code>true</code> if date is a holiday, <code>false</code> otherwise.
  1816. </member>
  1817. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsNonWorkday(System.Double,System.Double[])">
  1818. @param aDate a given date.
  1819. @param holidays an array of holidays.
  1820. @return <code>1</code> is not a workday, <code>0</code> otherwise.
  1821. </member>
  1822. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsInARange(System.Double,System.Double,System.Double)">
  1823. @param start start date.
  1824. @param end end date.
  1825. @param aDate a date to be analyzed.
  1826. @return <code>true</code> if aDate is between start and end dates, <code>false</code> otherwise.
  1827. </member>
  1828. <member name="T:NPOI.SS.Formula.Atp.WorkdayFunction">
  1829. Implementation of Excel 'Analysis ToolPak' function WORKDAY()<br/>
  1830. Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non
  1831. saturday/sunday date.
  1832. <p/>
  1833. <b>Syntax</b><br/>
  1834. <b>WORKDAY</b>(<b>startDate</b>, <b>days</b>, holidays)
  1835. <p/>
  1836. @author jfaenomoto@gmail.com
  1837. </member>
  1838. <member name="M:NPOI.SS.Formula.Atp.WorkdayFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  1839. Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past
  1840. number of parametrized workdays.
  1841. @return {@link ValueEval} with date as its value.
  1842. </member>
  1843. <member name="T:NPOI.SS.Formula.Functions.Errortype">
  1844. Implementation for the ERROR.TYPE() Excel function.
  1845. <p>
  1846. <b>Syntax:</b><br/>
  1847. <b>ERROR.TYPE</b>(<b>errorValue</b>)</p>
  1848. <p>
  1849. Returns a number corresponding to the error type of the supplied argument.</p>
  1850. <p>
  1851. <table border="1" cellpadding="1" cellspacing="1" summary="Return values for ERROR.TYPE()">
  1852. <tr><td>errorValue</td><td>Return Value</td></tr>
  1853. <tr><td>#NULL!</td><td>1</td></tr>
  1854. <tr><td>#DIV/0!</td><td>2</td></tr>
  1855. <tr><td>#VALUE!</td><td>3</td></tr>
  1856. <tr><td>#REF!</td><td>4</td></tr>
  1857. <tr><td>#NAME?</td><td>5</td></tr>
  1858. <tr><td>#NUM!</td><td>6</td></tr>
  1859. <tr><td>#N/A!</td><td>7</td></tr>
  1860. <tr><td>everything else</td><td>#N/A!</td></tr>
  1861. </table>
  1862. Note - the results of ERROR.TYPE() are different to the constants defined in
  1863. <tt>ErrorConstants</tt>.
  1864. </p>
  1865. @author Josh Micich
  1866. </member>
  1867. <member name="T:NPOI.SS.Formula.Functions.Fixed1ArgFunction">
  1868. Convenience base class for functions that must take exactly one argument.
  1869. @author Josh Micich
  1870. </member>
  1871. <member name="T:NPOI.SS.Formula.Functions.Function1Arg">
  1872. Implemented by all functions that can be called with one argument
  1873. @author Josh Micich
  1874. </member>
  1875. <member name="T:NPOI.SS.Formula.Functions.Function">
  1876. <summary>
  1877. Function serves as a marker interface.
  1878. </summary>
  1879. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  1880. </member>
  1881. <member name="M:NPOI.SS.Formula.Functions.Function.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  1882. <summary>
  1883. Evaluates the specified args.
  1884. </summary>
  1885. <param name="args">the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval</param>
  1886. <param name="srcRowIndex">row index of the cell containing the formula under evaluation</param>
  1887. <param name="srcColumnIndex">column index of the cell containing the formula under evaluation</param>
  1888. <returns></returns>
  1889. </member>
  1890. <member name="M:NPOI.SS.Formula.Functions.Function1Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  1891. see {@link Function#Evaluate(ValueEval[], int, int)}
  1892. </member>
  1893. <member name="T:NPOI.SS.Formula.Functions.Hyperlink">
  1894. Implementation of Excel HYPERLINK function.<p/>
  1895. In Excel this function has special behaviour - it causes the displayed cell value to behave like
  1896. a hyperlink in the GUI. From an evaluation perspective however, it is very simple.<p/>
  1897. <b>Syntax</b>:<br/>
  1898. <b>HYPERLINK</b>(<b>link_location</b>, friendly_name)<p/>
  1899. <b>link_location</b> The URL of the hyperlink <br/>
  1900. <b>friendly_name</b> (optional) the value to display<p/>
  1901. Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}).
  1902. @author Wayne Clingingsmith
  1903. </member>
  1904. <member name="T:NPOI.SS.Formula.Functions.Var1or2ArgFunction">
  1905. Convenience base class for any function which must take two or three
  1906. arguments
  1907. @author Josh Micich
  1908. </member>
  1909. <member name="T:NPOI.SS.Formula.Functions.Function2Arg">
  1910. Implemented by all functions that can be called with two arguments
  1911. @author Josh Micich
  1912. </member>
  1913. <member name="M:NPOI.SS.Formula.Functions.Function2Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  1914. see {@link Function#Evaluate(ValueEval[], int, int)}
  1915. </member>
  1916. <member name="T:NPOI.SS.Formula.Functions.Rank">
  1917. * 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.
  1918. * Syntax:
  1919. * RANK(number,ref,order)
  1920. * Number is the number whose rank you want to find.
  1921. * Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored.
  1922. * Order is a number specifying how to rank number.
  1923. * If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order.
  1924. * If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.
  1925. *
  1926. * @author Rubin Wang
  1927. </member>
  1928. <member name="T:NPOI.SS.Formula.Functions.Var2or3ArgFunction">
  1929. Convenience base class for any function which must take two or three
  1930. arguments
  1931. @author Josh Micich
  1932. </member>
  1933. <member name="T:NPOI.SS.Formula.Functions.Function3Arg">
  1934. Implemented by all functions that can be called with three arguments
  1935. @author Josh Micich
  1936. </member>
  1937. <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)">
  1938. see {@link Function#Evaluate(ValueEval[], int, int)}
  1939. </member>
  1940. <member name="T:NPOI.SS.Formula.Functions.Rate">
  1941. Implements the Excel Rate function
  1942. </member>
  1943. <member name="M:NPOI.SS.Formula.Functions.Rate.CheckValue(System.Double)">
  1944. Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases
  1945. @throws EvaluationException (#NUM!) if result is NaN or Infinity
  1946. </member>
  1947. <member name="T:NPOI.SS.Formula.Functions.Sumifs">
  1948. Implementation for the Excel function SUMIFS<br/>
  1949. <p>
  1950. Syntax : <br/>
  1951. SUMIFS ( <b>sum_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  1952. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  1953. <ul>
  1954. <li><b>sum_range</b> Required. One or more cells to sum, including numbers or names, ranges,
  1955. or cell references that contain numbers. Blank and text values are ignored.</li>
  1956. <li><b>criteria1_range</b> Required. The first range in which
  1957. to evaluate the associated criteria.</li>
  1958. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  1959. cell reference, or text that define which cells in the criteria_range1
  1960. argument will be added</li>
  1961. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  1962. Up to 127 range/criteria pairs are allowed.</li>
  1963. </ul>
  1964. </p>
  1965. @author Yegor Kozlov
  1966. </member>
  1967. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  1968. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  1969. as the <code>sumRange</code> argument
  1970. @throws EvaluationException if
  1971. </member>
  1972. <member name="M:NPOI.SS.Formula.Functions.Sumifs.SumMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.I_MatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  1973. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeSum</code>
  1974. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  1975. @param aeSum the range to sum
  1976. @return the computed value
  1977. </member>
  1978. <member name="T:NPOI.SS.Formula.Functions.WeekdayFunc">
  1979. Implementation for the Excel function WEEKDAY
  1980. @author Thies Wellpott
  1981. </member>
  1982. <member name="M:NPOI.SS.Formula.Functions.WeekdayFunc.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  1983. * Perform WEEKDAY(date, returnOption) function.
  1984. * Note: Parameter texts are from German EXCEL-2010 help.
  1985. * Parameters in args[]:
  1986. * args[0] serialDate
  1987. * EXCEL-date value
  1988. * Standardmaessig ist der 1. Januar 1900 die fortlaufende Zahl 1 und
  1989. * der 1. Januar 2008 die fortlaufende Zahl 39.448, da dieser Tag nach 39.448 Tagen
  1990. * auf den 01.01.1900 folgt.
  1991. * @return Option (optional)
  1992. * Bestimmt den Rueckgabewert:
  1993. 1 oder nicht angegeben Zahl 1 (Sonntag) bis 7 (Samstag). Verhaelt sich wie fruehere Microsoft Excel-Versionen.
  1994. 2 Zahl 1 (Montag) bis 7 (Sonntag).
  1995. 3 Zahl 0 (Montag) bis 6 (Sonntag).
  1996. 11 Die Zahlen 1 (Montag) bis 7 (Sonntag)
  1997. 12 Die Zahlen 1 (Dienstag) bis 7 (Montag)
  1998. 13 Die Zahlen 1 (Mittwoch) bis 7 (Dienstag)
  1999. 14 Die Zahlen 1 (Donnerstag) bis 7 (Mittwoch)
  2000. 15 Die Zahlen 1 (Freitag) bis 7 (Donnerstag)
  2001. 16 Die Zahlen 1 (Samstag) bis 7 (Freitag)
  2002. 17 Die Zahlen 1 (Sonntag) bis 7 (Samstag)
  2003. </member>
  2004. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.DummyRecordBase">
  2005. </member>
  2006. <member name="T:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate">
  2007. Manages the all the records associated with a chart sub-stream.<br/>
  2008. Includes the Initial {@link BOFRecord} and {@link EOFRecord}.
  2009. @author Josh Micich
  2010. </member>
  2011. <member name="F:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate._recs">
  2012. All the records between BOF and EOF
  2013. </member>
  2014. <member name="T:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock">
  2015. Groups the sheet protection records for a worksheet.
  2016. <p/>
  2017. See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook
  2018. (BIFF5-BIFF8)'
  2019. @author Josh Micich
  2020. </member>
  2021. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.#ctor">
  2022. Creates an empty WorksheetProtectionBlock
  2023. </member>
  2024. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.IsComponentRecord(System.Int32)">
  2025. @return <c>true</c> if the specified Record sid is one belonging to
  2026. the 'Page Settings Block'.
  2027. </member>
  2028. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.AddRecords(NPOI.HSSF.Model.RecordStream)">
  2029. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream
  2030. until the first non-WorksheetProtectionBlock record is encountered. As each record is Read,
  2031. it is incorporated into this WorksheetProtectionBlock.
  2032. <p/>
  2033. As per the OOO documentation, the protection block records can be expected to be written
  2034. toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009)
  2035. didn't do this. Workbooks with sheet protection Created by those earlier POI versions
  2036. seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files
  2037. with non continuous worksheet protection blocks.
  2038. <p/>
  2039. <b>Note</b> - when POI Writes out this WorksheetProtectionBlock, the records will always be
  2040. written in one consolidated block (in the standard ordering) regardless of how scattered the
  2041. records were when they were originally Read.
  2042. </member>
  2043. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.ProtectSheet(System.String,System.Boolean,System.Boolean)">
  2044. <summary>
  2045. protect a spreadsheet with a password (not encrypted, just sets protect flags and the password.)
  2046. </summary>
  2047. <param name="password">password to set;Pass <code>null</code> to remove all protection</param>
  2048. <param name="shouldProtectObjects">shouldProtectObjects are protected</param>
  2049. <param name="shouldProtectScenarios">shouldProtectScenarios are protected</param>
  2050. </member>
  2051. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateObjectProtect">
  2052. <summary>
  2053. Creates an ObjectProtect record with protect set to false.
  2054. </summary>
  2055. <returns></returns>
  2056. </member>
  2057. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateScenarioProtect">
  2058. <summary>
  2059. Creates a ScenarioProtect record with protect set to false.
  2060. </summary>
  2061. <returns></returns>
  2062. </member>
  2063. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreatePassword">
  2064. <summary>
  2065. Creates a Password record with password set to 0x0000.
  2066. </summary>
  2067. <returns></returns>
  2068. </member>
  2069. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Protect">
  2070. <summary>
  2071. the ProtectRecord. If one is not contained in the sheet, then one is created.
  2072. </summary>
  2073. </member>
  2074. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Password">
  2075. <summary>
  2076. the PasswordRecord. If one is not Contained in the sheet, then one is Created.
  2077. </summary>
  2078. </member>
  2079. <member name="T:NPOI.HSSF.Record.Chart.Chart3dRecord">
  2080. <summary>
  2081. The Chart3d record specifies that the plot area of the chart group is rendered in a 3-D scene
  2082. and also specifies the attributes of the 3-D plot area. The preceding chart group type MUST be
  2083. of type bar, pie, line, area, or surface.
  2084. </summary>
  2085. <remarks>
  2086. author: Antony liu (antony.apollo at gmail.com)
  2087. </remarks>
  2088. </member>
  2089. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Rotation">
  2090. <summary>
  2091. A signed integer that specifies the clockwise rotation, in degrees, of the 3-D plot area
  2092. around a vertical line through the center of the 3-D plot area. MUST be greater than or
  2093. equal to 0 and MUST be less than or equal to 360.
  2094. </summary>
  2095. </member>
  2096. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Elev">
  2097. <summary>
  2098. A signed integer that specifies the rotation, in degrees, of the 3-D plot area around
  2099. a horizontal line through the center of the 3-D plot area.MUST be greater than or equal
  2100. to -90 and MUST be less than or equal to 90.
  2101. </summary>
  2102. </member>
  2103. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Dist">
  2104. <summary>
  2105. A signed integer that specifies the field of view angle for the 3-D plot area.
  2106. MUST be greater than or equal to zero and less than 200.
  2107. </summary>
  2108. </member>
  2109. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Height">
  2110. <summary>
  2111. If fNotPieChart is 0, then this is an unsigned integer that specifies the thickness of the pie for a pie chart group.
  2112. 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.
  2113. </summary>
  2114. </member>
  2115. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Depth">
  2116. <summary>
  2117. A signed integer that specifies the depth of the 3-D plot area as a percentage of its width.
  2118. MUST be greater than or equal to 1 and less than or equal to 2000.
  2119. </summary>
  2120. </member>
  2121. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Gap">
  2122. <summary>
  2123. An unsigned integer that specifies the width of the gap between the series and the front and
  2124. back edges of the 3-D plot area as a percentage of the data point depth divided by 2.
  2125. If fCluster is not 1 and chart group type is not a bar then pcGap also specifies distance
  2126. between adjacent series as a percentage of the data point depth. MUST be less than or equal to 500.
  2127. </summary>
  2128. </member>
  2129. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsPerspective">
  2130. <summary>
  2131. A bit that specifies whether the 3-D plot area is rendered with a vanishing point.
  2132. If fNotPieChart is 0 the value MUST be 0. If fNotPieChart is 1 then the value
  2133. MUST be a value from the following
  2134. true Perspective vanishing point applied based on value of pcDist.
  2135. false No vanishing point applied.
  2136. </summary>
  2137. </member>
  2138. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsCluster">
  2139. <summary>
  2140. specifies whether data points are clustered together in a bar chart group.
  2141. If chart group type is not bar or pie, value MUST be ignored. If chart group type is pie,
  2142. value MUST be 0. If chart group type is bar, then the value MUST be a value from the following
  2143. true Data points are clustered.
  2144. false Data points are not clustered.
  2145. </summary>
  2146. </member>
  2147. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Is3DScaling">
  2148. <summary>
  2149. A bit that specifies whether the height of the 3-D plot area is automatically determined.
  2150. If fNotPieChart is 0 then this MUST be 0. If fNotPieChart is 1 then the value MUST be a value from the following table:
  2151. false The value of pcHeight is used to determine the height of the 3-D plot area
  2152. true The height of the 3-D plot area is automatically determined
  2153. </summary>
  2154. </member>
  2155. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsNotPieChart">
  2156. <summary>
  2157. A bit that specifies whether the chart group type is pie. MUST be a value from the following :
  2158. false Chart group type MUST be pie.
  2159. true Chart group type MUST not be pie.
  2160. </summary>
  2161. </member>
  2162. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsWalls2D">
  2163. <summary>
  2164. Whether the walls are rendered in 2-D. If fPerspective is 1 then this MUST be ignored.
  2165. If the chart group type is not bar, area or pie this MUST be ignored.
  2166. If the chart group is of type bar and fCluster is 0, then this MUST be ignored.
  2167. If the chart group type is pie this MUST be 0 and MUST be ignored.
  2168. If the chart group type is bar or area, then the value MUST be a value from the following
  2169. false Chart walls and floor are rendered in 3D.
  2170. true Chart walls are rendered in 2D and the chart floor is not rendered.
  2171. </summary>
  2172. </member>
  2173. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12ARecord">
  2174. <summary>
  2175. The CrtLayout12A record specifies layout information for a plot area.
  2176. </summary>
  2177. <remarks>
  2178. author: Antony liu (antony.apollo at gmail.com)
  2179. </remarks>
  2180. </member>
  2181. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.IsLayoutTargetInner">
  2182. <summary>
  2183. specifies the type of plot area for the layout target.
  2184. false Outer plot area - The bounding rectangle that includes the axis labels, axis titles, data table (2) and plot area of the chart.
  2185. true Inner plot area – The rectangle bounded by the chart axes.
  2186. </summary>
  2187. </member>
  2188. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.CheckSum">
  2189. <summary>
  2190. specifies the checksum
  2191. </summary>
  2192. </member>
  2193. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XTL">
  2194. <summary>
  2195. specifies the horizontal offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  2196. </summary>
  2197. </member>
  2198. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YTL">
  2199. <summary>
  2200. specifies the vertical offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  2201. </summary>
  2202. </member>
  2203. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XBR">
  2204. <summary>
  2205. specifies the width of the plot area
  2206. </summary>
  2207. </member>
  2208. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YBR">
  2209. <summary>
  2210. specifies the height of the plot area
  2211. </summary>
  2212. </member>
  2213. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XMode">
  2214. <summary>
  2215. A CrtLayout12Mode structure that specifies the meaning of x.
  2216. </summary>
  2217. </member>
  2218. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YMode">
  2219. <summary>
  2220. A CrtLayout12Mode structure that specifies the meaning of y.
  2221. </summary>
  2222. </member>
  2223. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.WidthMode">
  2224. <summary>
  2225. A CrtLayout12Mode structure that specifies the meaning of dx.
  2226. </summary>
  2227. </member>
  2228. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.HeightMode">
  2229. <summary>
  2230. A CrtLayout12Mode structure that specifies the meaning of dy.
  2231. </summary>
  2232. </member>
  2233. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.X">
  2234. <summary>
  2235. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  2236. </summary>
  2237. </member>
  2238. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.Y">
  2239. <summary>
  2240. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  2241. </summary>
  2242. </member>
  2243. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DX">
  2244. <summary>
  2245. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  2246. </summary>
  2247. </member>
  2248. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DY">
  2249. <summary>
  2250. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  2251. </summary>
  2252. </member>
  2253. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Mode">
  2254. <summary>
  2255. The CrtLayout12Mode specifies a layout mode. Each layout mode specifies a different
  2256. meaning of the x, y, dx, and dy fields of CrtLayout12 and CrtLayout12A.
  2257. </summary>
  2258. </member>
  2259. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MAUTO">
  2260. <summary>
  2261. Position and dimension (2) are determined by the application. x, y, dx and dy MUST be ignored.
  2262. </summary>
  2263. </member>
  2264. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MFACTOR">
  2265. <summary>
  2266. x and y specify the offset of the top left corner, relative to its default position,
  2267. as a fraction of the chart area. MUST be greater than or equal to -1.0 and MUST be
  2268. less than or equal to 1.0. dx and dy specify the width and height, as a fraction of
  2269. the chart area, MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  2270. </summary>
  2271. </member>
  2272. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MEDGE">
  2273. <summary>
  2274. x and y specify the offset of the upper-left corner; dx and dy specify the offset of the bottom-right corner.
  2275. x, y, dx and dy are specified relative to the upper-left corner of the chart area as a fraction of the chart area.
  2276. x, y, dx and dy MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  2277. </summary>
  2278. </member>
  2279. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Record">
  2280. <summary>
  2281. The CrtLayout12 record specifies the layout information for attached label, when contained
  2282. in the sequence of records that conforms to the ATTACHEDLABEL rule,
  2283. or legend, when contained in the sequence of records that conforms to the LD rule.
  2284. </summary>
  2285. </member>
  2286. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.AutoLayoutType">
  2287. <summary>
  2288. automatic layout type of the legend.
  2289. MUST be ignored when this record is in the sequence of records that conforms to the ATTACHEDLABEL rule.
  2290. MUST be a value from the following table:
  2291. 0x0 Align to the bottom
  2292. 0x1 Align to top right corner
  2293. 0x2 Align to the top
  2294. 0x3 Align to the right
  2295. 0x4 Align to the left
  2296. </summary>
  2297. </member>
  2298. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.CheckSum">
  2299. <summary>
  2300. specifies the checksum of the values in the order as follows,
  2301. </summary>
  2302. </member>
  2303. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.XMode">
  2304. <summary>
  2305. A CrtLayout12Mode structure that specifies the meaning of x.
  2306. </summary>
  2307. </member>
  2308. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.YMode">
  2309. <summary>
  2310. A CrtLayout12Mode structure that specifies the meaning of y.
  2311. </summary>
  2312. </member>
  2313. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.WidthMode">
  2314. <summary>
  2315. A CrtLayout12Mode structure that specifies the meaning of dx.
  2316. </summary>
  2317. </member>
  2318. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.HeightMode">
  2319. <summary>
  2320. A CrtLayout12Mode structure that specifies the meaning of dy.
  2321. </summary>
  2322. </member>
  2323. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.X">
  2324. <summary>
  2325. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  2326. </summary>
  2327. </member>
  2328. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.Y">
  2329. <summary>
  2330. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  2331. </summary>
  2332. </member>
  2333. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DX">
  2334. <summary>
  2335. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  2336. </summary>
  2337. </member>
  2338. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DY">
  2339. <summary>
  2340. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  2341. </summary>
  2342. </member>
  2343. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtRecord">
  2344. <summary>
  2345. The CrtMlFrt record specifies additional properties for chart elements, as specified by
  2346. the Chart Sheet Substream ABNF. These properties complement the record to which they
  2347. correspond, and are stored as a structure chain defined in XmlTkChain. An application
  2348. can ignore this record without loss of functionality, except for the additional properties.
  2349. If this record is longer than 8224 bytes, it MUST be split into several records. The first
  2350. section of the data appears in this record and subsequent sections appear in one or more
  2351. CrtMlFrtContinue records that follow this record.
  2352. </summary>
  2353. <remarks>
  2354. author: Antony liu (antony.apollo at gmail.com)
  2355. </remarks>
  2356. </member>
  2357. <member name="T:NPOI.HSSF.Record.Chart.MarkerFormatRecord">
  2358. <summary>
  2359. specifies the color, size, and shape of the associated data markers that appear on line, radar,
  2360. and scatter chart groups. The associated data markers are specified by the preceding DataFormat record.
  2361. </summary>
  2362. <remarks>
  2363. author: Antony liu (antony.apollo at gmail.com)
  2364. </remarks>
  2365. </member>
  2366. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBFore">
  2367. <summary>
  2368. the border color of the data marker.
  2369. </summary>
  2370. </member>
  2371. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBBack">
  2372. <summary>
  2373. the interior color of the data marker.
  2374. </summary>
  2375. </member>
  2376. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.DataMarkerType">
  2377. <summary>
  2378. the type of data marker.
  2379. </summary>
  2380. </member>
  2381. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Auto">
  2382. <summary>
  2383. whether the data marker is automatically generated.
  2384. false The data marker is not automatically generated.
  2385. true The data marker type, size, and color are automatically generated and the values are set accordingly in this record.
  2386. </summary>
  2387. </member>
  2388. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowInt">
  2389. <summary>
  2390. whether to show the data marker interior.
  2391. false The data marker interior is shown.
  2392. true The data marker interior is not shown.
  2393. </summary>
  2394. </member>
  2395. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowBorder">
  2396. <summary>
  2397. whether to show the data marker border.
  2398. false The data marker border is shown.
  2399. true The data marker border is not shown.
  2400. </summary>
  2401. </member>
  2402. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvFore">
  2403. <summary>
  2404. the border color of the data marker.
  2405. </summary>
  2406. </member>
  2407. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvBack">
  2408. <summary>
  2409. the interior color of the data marker.
  2410. </summary>
  2411. </member>
  2412. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Size">
  2413. <summary>
  2414. specifies the size in twips of the data marker.
  2415. </summary>
  2416. </member>
  2417. <member name="T:NPOI.HSSF.Record.Chart.PieFormatRecord">
  2418. <summary>
  2419. The PieFormat record specifies the distance of a data point or data points in a series from the center of one of the following:
  2420. The plot area for a doughnut or pie chart group.
  2421. The primary pie in a pie of pie or bar of pie chart group.
  2422. The secondary bar/pie of a pie of pie chart group.
  2423. </summary>
  2424. <remarks>
  2425. author: Antony liu (antony.apollo at gmail.com)
  2426. </remarks>
  2427. </member>
  2428. <member name="P:NPOI.HSSF.Record.Chart.PieFormatRecord.Explode">
  2429. <summary>
  2430. 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:
  2431. The plot area for a doughnut or pie chart group.
  2432. The primary pie in a pie of pie or bar of pie chart group.
  2433. The secondary bar/pie of a pie of pie chart group.
  2434. </summary>
  2435. </member>
  2436. <member name="T:NPOI.HSSF.Record.Chart.PieRecord">
  2437. <summary>
  2438. The Pie record specifies that the chart group is a pie chart group or
  2439. a doughnut chart group, and specifies the chart group attributes.
  2440. </summary>
  2441. <remarks>
  2442. author: Antony liu (antony.apollo at gmail.com)
  2443. </remarks>
  2444. </member>
  2445. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Start">
  2446. <summary>
  2447. An unsigned integer that specifies the starting angle of the first data point,
  2448. clockwise from the top of the circle. MUST be less than or equal to 360.
  2449. </summary>
  2450. </member>
  2451. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Dount">
  2452. <summary>
  2453. An unsigned integer that specifies the size of the center hole in a doughnut chart group
  2454. as a percentage of the plot area size. MUST be a value from the following table:
  2455. 0 Pie chart group.
  2456. 10 to 90 Doughnut chart group.
  2457. </summary>
  2458. </member>
  2459. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.HasShadow">
  2460. <summary>
  2461. A bit that specifies whether one data point or more data points in the chart group have shadows.
  2462. </summary>
  2463. </member>
  2464. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.ShowLdrLines">
  2465. <summary>
  2466. A bit that specifies whether the leader lines to the data labels are shown.
  2467. </summary>
  2468. </member>
  2469. <member name="T:NPOI.HSSF.Record.Common.FeatFormulaErr2">
  2470. FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part
  2471. This record part specifies Formula Evaluation &amp; Error Ignoring data
  2472. for a sheet, stored as part of a Shared Feature. It can be found in
  2473. records such as {@link FeatRecord}.
  2474. For the full meanings of the flags, see pages 669 and 670
  2475. of the Excel binary file format documentation.
  2476. </member>
  2477. <member name="T:NPOI.HSSF.Record.Common.SharedFeature">
  2478. Common Interface for all Shared Features
  2479. </member>
  2480. <member name="F:NPOI.HSSF.Record.Common.FeatFormulaErr2.errorCheck">
  2481. What errors we should ignore
  2482. </member>
  2483. <member name="T:NPOI.HSSF.Record.Common.FeatProtection">
  2484. Title: FeatProtection (Protection Shared Feature) common record part
  2485. This record part specifies Protection data for a sheet, stored
  2486. as part of a Shared Feature. It can be found in records such
  2487. as {@link FeatRecord}
  2488. </member>
  2489. <member name="F:NPOI.HSSF.Record.Common.FeatProtection.passwordVerifier">
  2490. 0 means no password. Otherwise indicates the
  2491. password verifier algorithm (same kind as
  2492. {@link PasswordRecord} and
  2493. {@link PasswordRev4Record})
  2494. </member>
  2495. <member name="T:NPOI.HSSF.Record.Common.FeatSmartTag">
  2496. Title: FeatSmartTag (Smart Tag Shared Feature) common record part
  2497. This record part specifies Smart Tag data for a sheet, stored as part
  2498. of a Shared Feature. It can be found in records such as {@link FeatRecord}.
  2499. It is made up of a hash, and a Set of Factoid Data that Makes up
  2500. the smart tags.
  2501. For more details, see page 669 of the Excel binary file
  2502. format documentation.
  2503. </member>
  2504. <member name="T:NPOI.HSSF.Record.Common.FtrHeader">
  2505. Title: FtrHeader (Future Record Header) common record part
  2506. This record part specifies a header for a Ftr (Future)
  2507. style record, which includes extra attributes above and
  2508. beyond those of a traditional record.
  2509. </member>
  2510. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.recordType">
  2511. This MUST match the type on the Containing record
  2512. </member>
  2513. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.grbitFrt">
  2514. This is a FrtFlags
  2515. </member>
  2516. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.reserved">
  2517. MUST be 8 bytes and all zero
  2518. </member>
  2519. <member name="T:NPOI.HSSF.Record.UnicodeString">
  2520. Title: Unicode String<p/>
  2521. Description: Unicode String - just standard fields that are in several records.
  2522. It is considered more desirable then repeating it in all of them.<p/>
  2523. This is often called a XLUnicodeRichExtendedString in MS documentation.<p/>
  2524. REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  2525. REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214
  2526. </member>
  2527. <member name="M:NPOI.HSSF.Record.UnicodeString.Equals(System.Object)">
  2528. Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand
  2529. rich text fields yet it's difficult to make a sound comparison.
  2530. @param o The object to Compare.
  2531. @return true if the object is actually Equal.
  2532. </member>
  2533. <member name="M:NPOI.HSSF.Record.UnicodeString.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  2534. construct a unicode string record and fill its fields, ID is ignored
  2535. @param in the RecordInputstream to read the record from
  2536. </member>
  2537. <member name="M:NPOI.HSSF.Record.UnicodeString.AddFormatRun(NPOI.HSSF.Record.UnicodeString.FormatRun)">
  2538. Adds a font run to the formatted string.
  2539. If a font run exists at the current charcter location, then it is
  2540. Replaced with the font run to be Added.
  2541. </member>
  2542. <member name="M:NPOI.HSSF.Record.UnicodeString.SwapFontUse(System.Int16,System.Int16)">
  2543. Swaps all use in the string of one font index
  2544. for use of a different font index.
  2545. Normally only called when fonts have been
  2546. Removed / re-ordered
  2547. </member>
  2548. <member name="M:NPOI.HSSF.Record.UnicodeString.ToString">
  2549. unlike the real records we return the same as "getString()" rather than debug info
  2550. @see #getDebugInfo()
  2551. @return String value of the record
  2552. </member>
  2553. <member name="M:NPOI.HSSF.Record.UnicodeString.GetDebugInfo">
  2554. return a character representation of the fields of this record
  2555. @return String of output for biffviewer etc.
  2556. </member>
  2557. <member name="M:NPOI.HSSF.Record.UnicodeString.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  2558. Serialises out the String. There are special rules
  2559. about where we can and can't split onto
  2560. Continue records.
  2561. </member>
  2562. <member name="P:NPOI.HSSF.Record.UnicodeString.CharCount">
  2563. get the number of characters in the string,
  2564. as an un-wrapped int
  2565. @return number of characters
  2566. </member>
  2567. <member name="P:NPOI.HSSF.Record.UnicodeString.OptionFlags">
  2568. Get the option flags which among other things return if this is a 16-bit or
  2569. 8 bit string
  2570. @return optionflags bitmask
  2571. </member>
  2572. <member name="P:NPOI.HSSF.Record.UnicodeString.String">
  2573. @return the actual string this Contains as a java String object
  2574. </member>
  2575. <member name="P:NPOI.HSSF.Record.UnicodeString.ExtRst.DataSize">
  2576. Returns our size, excluding our
  2577. 4 byte header
  2578. </member>
  2579. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordInput">
  2580. A decorated {@link RecordInputStream} that can read primitive data types
  2581. (short, int, long, etc.) spanned across a {@link ContinueRecord } boundary.
  2582. <p>
  2583. Most records construct themselves from {@link RecordInputStream}.
  2584. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary,
  2585. however, it is not always so.
  2586. </p>
  2587. Two attachments to <a href="https://issues.apache.org/bugzilla/Show_bug.cgi?id=50779">Bugzilla 50779</a>
  2588. demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character
  2589. or between two bytes of a <code>short</code>. The problematic portion of the data is
  2590. in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
  2591. <p>
  2592. {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
  2593. "Not enough data (1) to read requested (2) bytes" exception. The <code>ContinuableRecordInput</code>
  2594. class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
  2595. </p>
  2596. <p>
  2597. YK: For now (March 2011) this class is only used to read
  2598. @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.
  2599. </p>
  2600. @author Yegor Kozlov
  2601. </member>
  2602. <member name="T:NPOI.Util.ILittleEndianInput">
  2603. @author Josh Micich
  2604. </member>
  2605. <member name="T:NPOI.HSSF.Record.FeatHdrRecord">
  2606. Title: FeatHdr (Feature Header) Record
  2607. This record specifies common information for Shared Features, and
  2608. specifies the beginning of a collection of records to define them.
  2609. The collection of data (Globals Substream ABNF, macro sheet substream
  2610. ABNF or worksheet substream ABNF) specifies Shared Feature data.
  2611. </member>
  2612. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFPROTECTION">
  2613. Specifies the enhanced protection type. Used to protect a
  2614. shared workbook by restricting access to some areas of it
  2615. </member>
  2616. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFEC2">
  2617. Specifies that formula errors should be ignored
  2618. </member>
  2619. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFACTOID">
  2620. Specifies the smart tag type. Recognises certain
  2621. types of entries (proper names, dates/times etc) and
  2622. flags them for action
  2623. </member>
  2624. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFLIST">
  2625. Specifies the shared list type. Used for a table
  2626. within a sheet
  2627. </member>
  2628. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.cbHdrData">
  2629. 0x00000000 = rgbHdrData not present
  2630. 0xffffffff = rgbHdrData present
  2631. </member>
  2632. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.rgbHdrData">
  2633. We need a BOFRecord to make sense of this...
  2634. </member>
  2635. <member name="T:NPOI.HSSF.Record.FeatRecord">
  2636. Title: Feat (Feature) Record
  2637. This record specifies Shared Features data. It is normally paired
  2638. up with a {@link FeatHdrRecord}.
  2639. </member>
  2640. <member name="F:NPOI.HSSF.Record.FeatRecord.isf_sharedFeatureType">
  2641. See SHAREDFEATURES_* on {@link FeatHdrRecord}
  2642. </member>
  2643. <member name="F:NPOI.HSSF.Record.FeatRecord.cbFeatData">
  2644. Only matters if type is ISFFEC2
  2645. </member>
  2646. <member name="F:NPOI.HSSF.Record.FeatRecord.sharedFeature">
  2647. Contents depends on isf_sharedFeatureType :
  2648. ISFPROTECTION -> FeatProtection
  2649. ISFFEC2 -> FeatFormulaErr2
  2650. ISFFACTOID -> FeatSmartTag
  2651. </member>
  2652. <member name="T:NPOI.HSSF.Record.SubRecord">
  2653. Subrecords are part of the OBJ class.
  2654. </member>
  2655. <member name="P:NPOI.HSSF.Record.SubRecord.IsTerminating">
  2656. Wether this record terminates the sub-record stream.
  2657. There are two cases when this method must be overridden and return <c>true</c>
  2658. - EndSubRecord (sid = 0x00)
  2659. - LbsDataSubRecord (sid = 0x12)
  2660. @return whether this record is the last in the sub-record stream
  2661. </member>
  2662. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.#ctor">
  2663. Construct a new <code>FtCblsSubRecord</code> and
  2664. fill its data with the default values
  2665. </member>
  2666. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.ToString">
  2667. Convert this record to string.
  2668. Used by BiffViewer and other utilities.
  2669. </member>
  2670. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  2671. Serialize the record data into the supplied array of bytes
  2672. @param out the stream to serialize into
  2673. </member>
  2674. <member name="P:NPOI.HSSF.Record.FtCblsSubRecord.Sid">
  2675. @return id of this record.
  2676. </member>
  2677. <member name="T:NPOI.HSSF.Record.SheetExtRecord">
  2678. <summary>
  2679. </summary>
  2680. </member>
  2681. <member name="F:NPOI.HSSF.XmlTkBlob.xtHeader">
  2682. <summary>
  2683. The xtHeader.drType field MUST be equal to 0x07.
  2684. </summary>
  2685. </member>
  2686. <member name="F:NPOI.HSSF.XmlTkBool.xtHeader">
  2687. <summary>
  2688. The xtHeader.drType field MUST be equal to 0x02.
  2689. </summary>
  2690. </member>
  2691. <member name="F:NPOI.HSSF.XmlTkDouble.xtHeader">
  2692. <summary>
  2693. The xtHeader.drType field MUST be equal to 0x03.
  2694. </summary>
  2695. </member>
  2696. <member name="F:NPOI.HSSF.XmlTkDWord.xtHeader">
  2697. <summary>
  2698. The xtHeader.drType field MUST be equal to 0x04.
  2699. </summary>
  2700. </member>
  2701. <member name="F:NPOI.HSSF.XmlTkEnd.xtHeader">
  2702. <summary>
  2703. The xtHeader.drType field MUST be equal to 0x01.
  2704. </summary>
  2705. </member>
  2706. <member name="F:NPOI.HSSF.XmlTkString.xtHeader">
  2707. <summary>
  2708. The xtHeader.drType field MUST be equal to 0x05.
  2709. </summary>
  2710. </member>
  2711. <member name="F:NPOI.HSSF.XmlTkString.rgbValue">
  2712. <summary>
  2713. An array of Unicode characters. The size of the array, in characters, is specified
  2714. by the cchValue field. The size of the field, in bytes, MUST equal the result of
  2715. the following formula:cchValue * 2.
  2716. </summary>
  2717. </member>
  2718. <member name="F:NPOI.HSSF.XmlTkStyle.chartStyle">
  2719. <summary>
  2720. The chartStyle.xtHeader.xmlTkTag MUST be equal to 0x0003.
  2721. </summary>
  2722. </member>
  2723. <member name="F:NPOI.HSSF.XmlTkTickMarkSkipFrt.nInterval">
  2724. <summary>
  2725. The nInterval.xtHeader.xmlTkTag field MUST be equal to 0x0052.
  2726. </summary>
  2727. </member>
  2728. <member name="T:NPOI.HSSF.UserModel.DVConstraint">
  2729. @author Josh Micich
  2730. </member>
  2731. <member name="M:NPOI.SS.UserModel.IDataValidationConstraint.GetValidationType">
  2732. @return data validation type of this constraint
  2733. @see ValidationType
  2734. </member>
  2735. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Operator">
  2736. @return the operator used for this constraint
  2737. @see OperatorType
  2738. <summary>
  2739. get or set then comparison operator for this constraint
  2740. </summary>
  2741. </member>
  2742. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula1">
  2743. <summary>
  2744. get or set the formula for expression 1. May be <code>null</code>
  2745. </summary>
  2746. </member>
  2747. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula2">
  2748. <summary>
  2749. get or set the formula for expression 2. May be <code>null</code>
  2750. </summary>
  2751. </member>
  2752. <member name="M:NPOI.HSSF.UserModel.DVConstraint.#ctor(System.String,System.String[])">
  2753. Creates a list constraint
  2754. </member>
  2755. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateNumericConstraint(System.Int32,System.Int32,System.String,System.String)">
  2756. Creates a number based data validation constraint. The text values entered for expr1 and expr2
  2757. can be either standard Excel formulas or formatted number values. If the expression starts
  2758. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted number.
  2759. @param validationType one of {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#ANY},
  2760. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#DECIMAL},
  2761. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#INTEGER},
  2762. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#TEXT_LENGTH}
  2763. @param comparisonOperator any constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  2764. @param expr1 date formula (when first char is '=') or formatted number value
  2765. @param expr2 date formula (when first char is '=') or formatted number value
  2766. </member>
  2767. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateTimeConstraint(System.Int32,System.String,System.String)">
  2768. Creates a time based data validation constraint. The text values entered for expr1 and expr2
  2769. can be either standard Excel formulas or formatted time values. If the expression starts
  2770. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted time. To parse
  2771. formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to
  2772. Excel which uses the default time format from the OS.
  2773. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  2774. @param expr1 date formula (when first char is '=') or formatted time value
  2775. @param expr2 date formula (when first char is '=') or formatted time value
  2776. </member>
  2777. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateDateConstraint(System.Int32,System.String,System.String,System.String)">
  2778. Creates a date based data validation constraint. The text values entered for expr1 and expr2
  2779. can be either standard Excel formulas or formatted date values. If the expression starts
  2780. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted date (Excel uses
  2781. the same convention). To parse formatted dates, a date format needs to be specified. This
  2782. is contrary to Excel which uses the default short date format from the OS.
  2783. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  2784. @param expr1 date formula (when first char is '=') or formatted date value
  2785. @param expr2 date formula (when first char is '=') or formatted date value
  2786. @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD"
  2787. otherwise any other valid argument for <c>SimpleDateFormat</c> can be used
  2788. @see <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/text/DateFormat.html'>SimpleDateFormat</a>
  2789. </member>
  2790. <member name="M:NPOI.HSSF.UserModel.DVConstraint.GetFormulaFromTextExpression(System.String)">
  2791. Distinguishes formula expressions from simple value expressions. This logic is only
  2792. required by a few factory methods in this class that create data validation constraints
  2793. from more or less the same parameters that would have been entered in the Excel UI. The
  2794. data validation dialog box uses the convention that formulas begin with '='. Other methods
  2795. in this class follow the POI convention (formulas and values are distinct), so the '='
  2796. convention is not used there.
  2797. @param textExpr a formula or value expression
  2798. @return all text After '=' if textExpr begins with '='. Otherwise <code>null</code> if textExpr does not begin with '='
  2799. </member>
  2800. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertNumber(System.String)">
  2801. @return <code>null</code> if numberStr is <code>null</code>
  2802. </member>
  2803. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertTime(System.String)">
  2804. @return <code>null</code> if timeStr is <code>null</code>
  2805. </member>
  2806. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDate(System.String,NPOI.SS.Util.SimpleDateFormat)">
  2807. @param dateFormat pass <code>null</code> for default YYYYMMDD
  2808. @return <code>null</code> if timeStr is <code>null</code>
  2809. </member>
  2810. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateFormulas(NPOI.HSSF.UserModel.HSSFSheet)">
  2811. @return both Parsed formulas (for expression 1 and 2).
  2812. </member>
  2813. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDoubleFormula(System.String,System.Double,NPOI.HSSF.UserModel.HSSFSheet)">
  2814. @return The Parsed token array representing the formula or value specified.
  2815. Empty array if both formula and value are <code>null</code>
  2816. </member>
  2817. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsListValidationType">
  2818. Convenience method
  2819. @return <c>true</c> if this constraint is a 'list' validation
  2820. </member>
  2821. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsExplicitList">
  2822. Convenience method
  2823. @return <c>true</c> if this constraint is a 'list' validation with explicit values
  2824. </member>
  2825. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value1">
  2826. @return the numeric value for expression 1. May be <c>null</c>
  2827. </member>
  2828. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value2">
  2829. @return the numeric value for expression 2. May be <c>null</c>
  2830. </member>
  2831. <member name="T:NPOI.HSSF.UserModel.HSSFDataFormatter">
  2832. HSSFDataFormatter contains methods for formatting the value stored in an
  2833. HSSFCell. This can be useful for reports and GUI presentations when you
  2834. need to display data exactly as it appears in Excel. Supported formats
  2835. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  2836. codes, etc.
  2837. Internally, formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  2838. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  2839. formats used by this class must obey the same pattern rules as these Format
  2840. subclasses. This means that only legal number pattern characters ("0", "#",
  2841. ".", "," etc.) may appear in number formats. Other characters can be
  2842. inserted <em>before</em> or <em>after</em> the number pattern to form a
  2843. prefix or suffix.
  2844. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  2845. </c> will be correctly formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  2846. However the pattern <c>"00-00-00"</c> is incorrectly formatted by
  2847. DecimalFormat as "000000--". For Excel formats that are not compatible with
  2848. DecimalFormat, you can provide your own custom {@link Format} implementation
  2849. via <c>HSSFDataFormatter.AddFormat(String,Format)</c>. The following
  2850. custom formats are already provided by this class:
  2851. <pre>
  2852. <ul><li>SSN "000-00-0000"</li>
  2853. <li>Phone Number "(###) ###-####"</li>
  2854. <li>Zip plus 4 "00000-0000"</li>
  2855. </ul>
  2856. </pre>
  2857. If the Excel format pattern cannot be parsed successfully, then a default
  2858. format will be used. The default number format will mimic the Excel General
  2859. format: "#" for whole numbers and "#.##########" for decimal numbers. You
  2860. can override the default format pattern with <c>
  2861. HSSFDataFormatter.DefaultNumberFormat=(Format)</c>. <b>Note:</b> the
  2862. default format will only be used when a Format cannot be created from the
  2863. cell's data format string.
  2864. @author James May (james dot may at fmr dot com)
  2865. </member>
  2866. <member name="T:NPOI.SS.UserModel.DataFormatter">
  2867. HSSFDataFormatter contains methods for Formatting the value stored in an
  2868. Cell. This can be useful for reports and GUI presentations when you
  2869. need to display data exactly as it appears in Excel. Supported Formats
  2870. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  2871. codes, etc.
  2872. Internally, Formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  2873. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  2874. Formats used by this class must obey the same pattern rules as these FormatBase
  2875. subclasses. This means that only legal number pattern characters ("0", "#",
  2876. ".", "," etc.) may appear in number formats. Other characters can be
  2877. inserted <em>before</em> or <em> after</em> the number pattern to form a
  2878. prefix or suffix.
  2879. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  2880. </c> will be correctly Formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  2881. However the pattern <c>"00-00-00"</c> is incorrectly Formatted by
  2882. DecimalFormat as "000000--". For Excel Formats that are not compatible with
  2883. DecimalFormat, you can provide your own custom {@link FormatBase} implementation
  2884. via <c>HSSFDataFormatter.AddFormat(String,FormatBase)</c>. The following
  2885. custom Formats are already provided by this class:
  2886. <pre>
  2887. <ul><li>SSN "000-00-0000"</li>
  2888. <li>Phone Number "(###) ###-####"</li>
  2889. <li>Zip plus 4 "00000-0000"</li>
  2890. </ul>
  2891. </pre>
  2892. If the Excel FormatBase pattern cannot be Parsed successfully, then a default
  2893. FormatBase will be used. The default number FormatBase will mimic the Excel General
  2894. FormatBase: "#" for whole numbers and "#.##########" for decimal numbers. You
  2895. can override the default FormatBase pattern with <c>
  2896. HSSFDataFormatter.setDefaultNumberFormat(FormatBase)</c>. <b>Note:</b> the
  2897. default FormatBase will only be used when a FormatBase cannot be Created from the
  2898. cell's data FormatBase string.
  2899. @author James May (james dot may at fmr dot com)
  2900. </member>
  2901. <member name="F:NPOI.SS.UserModel.DataFormatter.numPattern">
  2902. Pattern to find a number FormatBase: "0" or "#"
  2903. </member>
  2904. <member name="F:NPOI.SS.UserModel.DataFormatter.daysAsText">
  2905. Pattern to find days of week as text "ddd...."
  2906. </member>
  2907. <member name="F:NPOI.SS.UserModel.DataFormatter.amPmPattern">
  2908. Pattern to find "AM/PM" marker
  2909. </member>
  2910. <member name="F:NPOI.SS.UserModel.DataFormatter.localePatternGroup">
  2911. A regex to find patterns like [$$-1009] and [$�-452].
  2912. Note that we don't currently process these into locales
  2913. </member>
  2914. <member name="F:NPOI.SS.UserModel.DataFormatter.invalidDateTimeString">
  2915. * Cells formatted with a date or time format and which contain invalid date or time values
  2916. * show 255 pound signs ("#").
  2917. </member>
  2918. <member name="F:NPOI.SS.UserModel.DataFormatter.generalWholeNumFormat">
  2919. <em>General</em> FormatBase for whole numbers.
  2920. </member>
  2921. <member name="F:NPOI.SS.UserModel.DataFormatter.generalDecimalNumFormat">
  2922. <em>General</em> FormatBase for decimal numbers.
  2923. </member>
  2924. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultNumFormat">
  2925. A default FormatBase to use when a number pattern cannot be Parsed.
  2926. </member>
  2927. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor">
  2928. Creates a formatter using the {@link Locale#getDefault() default locale}.
  2929. </member>
  2930. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo)">
  2931. Constructor
  2932. </member>
  2933. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean)">
  2934. Creates a formatter using the given locale.
  2935. @param emulateCsv whether to emulate CSV output.
  2936. </member>
  2937. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormat(NPOI.SS.UserModel.ICell)">
  2938. Return a FormatBase for the given cell if one exists, otherwise try to
  2939. Create one. This method will return <c>null</c> if the any of the
  2940. following is true:
  2941. <ul>
  2942. <li>the cell's style is null</li>
  2943. <li>the style's data FormatBase string is null or empty</li>
  2944. <li>the FormatBase string cannot be recognized as either a number or date</li>
  2945. </ul>
  2946. @param cell The cell to retrieve a FormatBase for
  2947. @return A FormatBase for the FormatBase String
  2948. </member>
  2949. <member name="M:NPOI.SS.UserModel.DataFormatter.CreateFormat(NPOI.SS.UserModel.ICell)">
  2950. Create and return a FormatBase based on the FormatBase string from a cell's
  2951. style. If the pattern cannot be Parsed, return a default pattern.
  2952. @param cell The Excel cell
  2953. @return A FormatBase representing the excel FormatBase. May return null.
  2954. </member>
  2955. <member name="M:NPOI.SS.UserModel.DataFormatter.IsWholeNumber(System.Double)">
  2956. Return true if the double value represents a whole number
  2957. @param d the double value to check
  2958. @return <c>true</c> if d is a whole number
  2959. </member>
  2960. <member name="M:NPOI.SS.UserModel.DataFormatter.GetDefaultFormat(NPOI.SS.UserModel.ICell)">
  2961. Returns a default FormatBase for a cell.
  2962. @param cell The cell
  2963. @return a default FormatBase
  2964. </member>
  2965. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedDateString(NPOI.SS.UserModel.ICell)">
  2966. Returns the Formatted value of an Excel date as a <c>String</c> based
  2967. on the cell's <c>DataFormat</c>. i.e. "Thursday, January 02, 2003"
  2968. , "01/02/2003" , "02-Jan" , etc.
  2969. @param cell The cell
  2970. @return a Formatted date string
  2971. </member>
  2972. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedNumberString(NPOI.SS.UserModel.ICell)">
  2973. Returns the Formatted value of an Excel number as a <c>String</c>
  2974. based on the cell's <c>DataFormat</c>. Supported Formats include
  2975. currency, percents, decimals, phone number, SSN, etc.:
  2976. "61.54%", "$100.00", "(800) 555-1234".
  2977. @param cell The cell
  2978. @return a Formatted number string
  2979. </member>
  2980. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String)">
  2981. Formats the given raw cell value, based on the supplied
  2982. FormatBase index and string, according to excel style rules.
  2983. @see #FormatCellValue(Cell)
  2984. </member>
  2985. <member name="M:NPOI.SS.UserModel.DataFormatter.PerformDateFormatting(System.DateTime,NPOI.SS.Util.FormatBase)">
  2986. Performs Excel-style date formatting, using the
  2987. supplied Date and format
  2988. </member>
  2989. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String,System.Boolean)">
  2990. Formats the given raw cell value, based on the supplied
  2991. format index and string, according to excel style rules.
  2992. @see #formatCellValue(Cell)
  2993. </member>
  2994. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell)">
  2995. Returns the Formatted value of a cell as a <c>String</c> regardless
  2996. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  2997. cell value will be Formatted using a default FormatBase.
  2998. When passed a null or blank cell, this method will return an empty
  2999. String (""). Formulas in formula type cells will not be evaluated.
  3000. @param cell The cell
  3001. @return the Formatted cell value as a String
  3002. </member>
  3003. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFormulaEvaluator)">
  3004. Returns the Formatted value of a cell as a <c>String</c> regardless
  3005. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  3006. cell value will be Formatted using a default FormatBase.
  3007. When passed a null or blank cell, this method will return an empty
  3008. String (""). Formula cells will be evaluated using the given
  3009. {@link HSSFFormulaEvaluator} if the evaluator is non-null. If the
  3010. evaluator is null, then the formula String will be returned. The caller
  3011. is responsible for setting the currentRow on the evaluator
  3012. @param cell The cell (can be null)
  3013. @param evaluator The HSSFFormulaEvaluator (can be null)
  3014. @return a string value of the cell
  3015. </member>
  3016. <member name="M:NPOI.SS.UserModel.DataFormatter.SetDefaultNumberFormat(NPOI.SS.Util.FormatBase)">
  3017. Sets a default number FormatBase to be used when the Excel FormatBase cannot be
  3018. Parsed successfully. <b>Note:</b> This is a fall back for when an error
  3019. occurs while parsing an Excel number FormatBase pattern. This will not
  3020. affect cells with the <em>General</em> FormatBase.
  3021. The value that will be passed to the FormatBase's FormatBase method (specified
  3022. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  3023. numeric cell. Therefore the code in the FormatBase method should expect a
  3024. <c>Number</c> value.
  3025. @param FormatBase A FormatBase instance to be used as a default
  3026. @see java.text.FormatBase#FormatBase
  3027. </member>
  3028. <member name="M:NPOI.SS.UserModel.DataFormatter.AddFormat(System.String,NPOI.SS.Util.FormatBase)">
  3029. Adds a new FormatBase to the available formats.
  3030. The value that will be passed to the FormatBase's FormatBase method (specified
  3031. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  3032. numeric cell. Therefore the code in the FormatBase method should expect a
  3033. <c>Number</c> value.
  3034. @param excelformatStr The data FormatBase string
  3035. @param FormatBase A FormatBase instance
  3036. </member>
  3037. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor(System.Globalization.CultureInfo)">
  3038. Creates a formatter using the given locale.
  3039. </member>
  3040. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor">
  3041. Creates a formatter using the {@link Locale#getDefault() default locale}.
  3042. </member>
  3043. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidation">
  3044. Utility class for creating data validation cells
  3045. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  3046. </member>
  3047. <member name="M:NPOI.SS.UserModel.IDataValidation.CreatePromptBox(System.String,System.String)">
  3048. Sets the title and text for the prompt box . Prompt box is displayed when
  3049. the user selects a cell which belongs to this validation object . In
  3050. order for a prompt box to be displayed you should also use method
  3051. SetShowPromptBox( bool show )
  3052. @param title The prompt box's title
  3053. @param text The prompt box's text
  3054. </member>
  3055. <member name="M:NPOI.SS.UserModel.IDataValidation.CreateErrorBox(System.String,System.String)">
  3056. Sets the title and text for the error box . Error box is displayed when
  3057. the user enters an invalid value int o a cell which belongs to this
  3058. validation object . In order for an error box to be displayed you should
  3059. also use method SetShowErrorBox( bool show )
  3060. @param title The error box's title
  3061. @param text The error box's text
  3062. </member>
  3063. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorStyle">
  3064. <summary>
  3065. get or set the error style for error box
  3066. </summary>
  3067. </member>
  3068. <member name="P:NPOI.SS.UserModel.IDataValidation.EmptyCellAllowed">
  3069. <summary>
  3070. Setting this allows an empty object as a valid value. Retrieve the settings for empty cells allowed.
  3071. @return True if this object should treats empty as valid value , false otherwise
  3072. </summary>
  3073. <value><c>true</c> if this object should treats empty as valid value, <c>false</c> otherwise</value>
  3074. </member>
  3075. <member name="P:NPOI.SS.UserModel.IDataValidation.SuppressDropDownArrow">
  3076. <summary>
  3077. Useful for list validation objects .
  3078. Useful only list validation objects . This method always returns false if the object isn't a list validation object
  3079. </summary>
  3080. </member>
  3081. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowPromptBox">
  3082. Sets the behaviour when a cell which belongs to this object is selected
  3083. <value><c>true</c> if an prompt box should be displayed , <c>false</c> otherwise</value>
  3084. </member>
  3085. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowErrorBox">
  3086. Sets the behaviour when an invalid value is entered
  3087. <value><c>true</c> if an error box should be displayed , <c>false</c> otherwise</value>
  3088. </member>
  3089. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxTitle">
  3090. @return Prompt box's title or <code>null</code>
  3091. </member>
  3092. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxText">
  3093. @return Prompt box's text or <code>null</code>
  3094. </member>
  3095. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxTitle">
  3096. @return Error box's title or <code>null</code>
  3097. </member>
  3098. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxText">
  3099. @return Error box's text or <code>null</code>
  3100. </member>
  3101. <member name="M:NPOI.HSSF.UserModel.HSSFDataValidation.#ctor(NPOI.SS.Util.CellRangeAddressList,NPOI.SS.UserModel.IDataValidationConstraint)">
  3102. Constructor which Initializes the cell range on which this object will be
  3103. applied
  3104. @param constraint
  3105. </member>
  3106. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidationHelper">
  3107. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  3108. </member>
  3109. <member name="T:NPOI.SS.UserModel.IDataValidationHelper">
  3110. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  3111. </member>
  3112. <member name="T:NPOI.HSSF.UserModel.HSSFDateUtil">
  3113. Contains methods for dealing with Excel dates.
  3114. @author Michael Harhen
  3115. @author Glen Stampoultzis (glens at apache.org)
  3116. @author Dan Sherman (dsherman at isisph.com)
  3117. @author Hack Kampbjorn (hak at 2mba.dk)
  3118. @author Alex Jacoby (ajacoby at gmail.com)
  3119. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  3120. </member>
  3121. <member name="T:NPOI.SS.UserModel.DateUtil">
  3122. <summary>
  3123. Contains methods for dealing with Excel dates.
  3124. @author Michael Harhen
  3125. @author Glen Stampoultzis (glens at apache.org)
  3126. @author Dan Sherman (dsherman at Isisph.com)
  3127. @author Hack Kampbjorn (hak at 2mba.dk)
  3128. @author Alex Jacoby (ajacoby at gmail.com)
  3129. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  3130. @author Thies Wellpott
  3131. </summary>
  3132. </member>
  3133. <member name="M:NPOI.SS.UserModel.DateUtil.AbsoluteDay(System.DateTime,System.Boolean)">
  3134. <summary>
  3135. Given a Calendar, return the number of days since 1899/12/31.
  3136. </summary>
  3137. <param name="cal">the date</param>
  3138. <param name="use1904windowing">if set to <c>true</c> [use1904windowing].</param>
  3139. <returns>number of days since 1899/12/31</returns>
  3140. </member>
  3141. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime)">
  3142. <summary>
  3143. Given a Date, Converts it into a double representing its internal Excel representation,
  3144. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  3145. </summary>
  3146. <param name="date">Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</param>
  3147. <returns>the Date</returns>
  3148. </member>
  3149. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  3150. <summary>
  3151. Gets the excel date.
  3152. </summary>
  3153. <param name="year">The year.</param>
  3154. <param name="month">The month.</param>
  3155. <param name="day">The day.</param>
  3156. <param name="hour">The hour.</param>
  3157. <param name="minute">The minute.</param>
  3158. <param name="second">The second.</param>
  3159. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  3160. <returns></returns>
  3161. </member>
  3162. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime,System.Boolean)">
  3163. <summary>
  3164. Given a Date, Converts it into a double representing its internal Excel representation,
  3165. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  3166. </summary>
  3167. <param name="date">The date.</param>
  3168. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  3169. <returns>Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</returns>
  3170. </member>
  3171. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double)">
  3172. <summary>
  3173. Given an Excel date with using 1900 date windowing, and converts it to a java.util.Date.
  3174. Excel Dates and Times are stored without any timezone
  3175. information. If you know (through other means) that your file
  3176. uses a different TimeZone to the system default, you can use
  3177. this version of the getJavaDate() method to handle it.
  3178. </summary>
  3179. <param name="date">The Excel date.</param>
  3180. <returns>null if date is not a valid Excel date</returns>
  3181. </member>
  3182. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean)">
  3183. Given an Excel date with either 1900 or 1904 date windowing,
  3184. Converts it to a Date.
  3185. NOTE: If the default <c>TimeZone</c> in Java uses Daylight
  3186. Saving Time then the conversion back to an Excel date may not give
  3187. the same value, that Is the comparison
  3188. <CODE>excelDate == GetExcelDate(GetJavaDate(excelDate,false))</CODE>
  3189. Is not always true. For example if default timezone Is
  3190. <c>Europe/Copenhagen</c>, on 2004-03-28 the minute after
  3191. 01:59 CET Is 03:00 CEST, if the excel date represents a time between
  3192. 02:00 and 03:00 then it Is Converted to past 03:00 summer time
  3193. @param date The Excel date.
  3194. @param use1904windowing true if date uses 1904 windowing,
  3195. or false if using 1900 date windowing.
  3196. @return Java representation of the date, or null if date Is not a valid Excel date
  3197. @see TimeZone
  3198. </member>
  3199. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean)">
  3200. <summary>
  3201. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  3202. </summary>
  3203. <param name="date">The Excel date.</param>
  3204. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  3205. <returns>null if date is not a valid Excel date</returns>
  3206. </member>
  3207. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTime(System.String)">
  3208. <summary>
  3209. Converts a string of format "HH:MM" or "HH:MM:SS" to its (Excel) numeric equivalent
  3210. </summary>
  3211. <param name="timeStr">The time STR.</param>
  3212. <returns> a double between 0 and 1 representing the fraction of the day</returns>
  3213. </member>
  3214. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTimeInternal(System.String)">
  3215. <summary>
  3216. Converts the time internal.
  3217. </summary>
  3218. <param name="timeStr">The time STR.</param>
  3219. <returns></returns>
  3220. </member>
  3221. <member name="M:NPOI.SS.UserModel.DateUtil.IsADateFormat(System.Int32,System.String)">
  3222. <summary>
  3223. Given a format ID and its format String, will Check to see if the
  3224. format represents a date format or not.
  3225. Firstly, it will Check to see if the format ID corresponds to an
  3226. internal excel date format (eg most US date formats)
  3227. If not, it will Check to see if the format string only Contains
  3228. date formatting Chars (ymd-/), which covers most
  3229. non US date formats.
  3230. </summary>
  3231. <param name="formatIndex">The index of the format, eg from ExtendedFormatRecord.GetFormatIndex</param>
  3232. <param name="formatString">The format string, eg from FormatRecord.GetFormatString</param>
  3233. <returns>
  3234. <c>true</c> if [is A date format] [the specified format index]; otherwise, <c>false</c>.
  3235. </returns>
  3236. </member>
  3237. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDate(System.String)">
  3238. <summary>
  3239. Converts a string of format "YYYY/MM/DD" to its (Excel) numeric equivalent
  3240. </summary>
  3241. <param name="dateStr">The date STR.</param>
  3242. <returns>a double representing the (integer) number of days since the start of the Excel epoch</returns>
  3243. </member>
  3244. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDateInternal(System.String)">
  3245. <summary>
  3246. Parses the YYYYMMDD date internal.
  3247. </summary>
  3248. <param name="timeStr">The time string.</param>
  3249. <returns></returns>
  3250. </member>
  3251. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32)">
  3252. <summary>
  3253. Parses the int.
  3254. </summary>
  3255. <param name="strVal">The string value.</param>
  3256. <param name="fieldName">Name of the field.</param>
  3257. <param name="rangeMax">The range max.</param>
  3258. <returns></returns>
  3259. </member>
  3260. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32,System.Int32)">
  3261. <summary>
  3262. Parses the int.
  3263. </summary>
  3264. <param name="strVal">The STR val.</param>
  3265. <param name="fieldName">Name of the field.</param>
  3266. <param name="lowerLimit">The lower limit.</param>
  3267. <param name="upperLimit">The upper limit.</param>
  3268. <returns></returns>
  3269. </member>
  3270. <member name="M:NPOI.SS.UserModel.DateUtil.IsInternalDateFormat(System.Int32)">
  3271. <summary>
  3272. Given a format ID this will Check whether the format represents an internal excel date format or not.
  3273. </summary>
  3274. <param name="format">The format.</param>
  3275. </member>
  3276. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellDateFormatted(NPOI.SS.UserModel.ICell)">
  3277. <summary>
  3278. Check if a cell Contains a date
  3279. Since dates are stored internally in Excel as double values
  3280. we infer it Is a date if it Is formatted as such.
  3281. </summary>
  3282. <param name="cell">The cell.</param>
  3283. </member>
  3284. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellInternalDateFormatted(NPOI.SS.UserModel.ICell)">
  3285. <summary>
  3286. Check if a cell contains a date, Checking only for internal excel date formats.
  3287. As Excel stores a great many of its dates in "non-internal" date formats, you will not normally want to use this method.
  3288. </summary>
  3289. <param name="cell">The cell.</param>
  3290. </member>
  3291. <member name="M:NPOI.SS.UserModel.DateUtil.IsValidExcelDate(System.Double)">
  3292. <summary>
  3293. Given a double, Checks if it Is a valid Excel date.
  3294. </summary>
  3295. <param name="value">the double value.</param>
  3296. <returns>
  3297. <c>true</c> if [is valid excel date] [the specified value]; otherwise, <c>false</c>.
  3298. </returns>
  3299. </member>
  3300. <member name="T:NPOI.HSSF.Util.LazilyConcatenatedByteArray">
  3301. Utility for delaying the concatenation of multiple byte arrays. Doing this up-front
  3302. causes significantly more copying, which for a large number of byte arrays can cost
  3303. a large amount of time.
  3304. </member>
  3305. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Clear">
  3306. Clears the array (sets the concatenated length back to zero.
  3307. </member>
  3308. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Concatenate(System.Byte[])">
  3309. Concatenates an array onto the end of our array.
  3310. This is a relatively fast operation.
  3311. @param array the array to concatenate.
  3312. @throws ArgumentException if {@code array} is {@code null}.
  3313. </member>
  3314. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.ToArray">
  3315. Gets the concatenated contents as a single byte array.
  3316. This is a slower operation, but the concatenated array is stored off as a single
  3317. array again so that subsequent calls will not perform Additional copying.
  3318. @return the byte array. Returns {@code null} if no data has been placed into it.
  3319. </member>
  3320. <member name="T:NPOI.DDF.DefaultEscherRecordFactory">
  3321. <summary>
  3322. Generates escher records when provided the byte array containing those records.
  3323. @author Glen Stampoultzis
  3324. @author Nick Burch (nick at torchbox . com)
  3325. </summary>
  3326. </member>
  3327. <member name="T:NPOI.DDF.IEscherRecordFactory">
  3328. <summary>
  3329. The escher record factory interface allows for the creation of escher
  3330. records from a pointer into a data array.
  3331. @author Glen Stampoultzis (glens at apache.org)
  3332. </summary>
  3333. </member>
  3334. <member name="M:NPOI.DDF.IEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  3335. <summary>
  3336. Create a new escher record from the data provided. Does not attempt
  3337. to Fill the contents of the record however.
  3338. </summary>
  3339. <param name="data">The data.</param>
  3340. <param name="offset">The off set.</param>
  3341. <returns></returns>
  3342. </member>
  3343. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.#ctor">
  3344. <summary>
  3345. Initializes a new instance of the <see cref="T:NPOI.DDF.DefaultEscherRecordFactory"/> class.
  3346. </summary>
  3347. </member>
  3348. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  3349. <summary>
  3350. Generates an escher record including the any children contained under that record.
  3351. An exception is thrown if the record could not be generated.
  3352. </summary>
  3353. <param name="data">The byte array containing the records</param>
  3354. <param name="offset">The starting offset into the byte array</param>
  3355. <returns>The generated escher record</returns>
  3356. </member>
  3357. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.RecordsToMap(System.Type[])">
  3358. <summary>
  3359. Converts from a list of classes into a map that Contains the record id as the key and
  3360. the Constructor in the value part of the map. It does this by using reflection to look up
  3361. the RECORD_ID field then using reflection again to find a reference to the constructor.
  3362. </summary>
  3363. <param name="records">The records to convert</param>
  3364. <returns>The map containing the id/constructor pairs.</returns>
  3365. </member>
  3366. <member name="T:NPOI.DDF.EscherArrayProperty">
  3367. <summary>
  3368. Escher array properties are the most wierd construction ever invented
  3369. with all sorts of special cases. I'm hopeful I've got them all.
  3370. @author Glen Stampoultzis (glens at superlinksoftware.com)
  3371. </summary>
  3372. </member>
  3373. <member name="T:NPOI.DDF.EscherComplexProperty">
  3374. <summary>
  3375. A complex property differs from a simple property in that the data can not fit inside a 32 bit
  3376. integer. See the specification for more detailed information regarding exactly what is
  3377. stored here.
  3378. @author Glen Stampoultzis
  3379. </summary>
  3380. </member>
  3381. <member name="T:NPOI.DDF.EscherProperty">
  3382. <summary>
  3383. This is the abstract base class for all escher properties.
  3384. @see EscherOptRecord
  3385. @author Glen Stampoultzis (glens at apache.org)
  3386. </summary>
  3387. </member>
  3388. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16)">
  3389. <summary>
  3390. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.
  3391. </summary>
  3392. <param name="id">The id is distinct from the actual property number. The id includes the property number the blip id
  3393. flag and an indicator whether the property is complex or not.</param>
  3394. </member>
  3395. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16,System.Boolean,System.Boolean)">
  3396. <summary>
  3397. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.The three parameters are combined to form a property
  3398. id.
  3399. </summary>
  3400. <param name="propertyNumber">The property number.</param>
  3401. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  3402. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  3403. </member>
  3404. <member name="M:NPOI.DDF.EscherProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  3405. <summary>
  3406. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  3407. The fixed Length part is Serialized first.
  3408. </summary>
  3409. <param name="data">The data.</param>
  3410. <param name="pos">The pos.</param>
  3411. <returns></returns>
  3412. </member>
  3413. <member name="M:NPOI.DDF.EscherProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  3414. <summary>
  3415. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  3416. The fixed Length part is Serialized first.
  3417. </summary>
  3418. <param name="data">The data.</param>
  3419. <param name="pos">The pos.</param>
  3420. <returns></returns>
  3421. </member>
  3422. <member name="P:NPOI.DDF.EscherProperty.Id">
  3423. <summary>
  3424. Gets the id.
  3425. </summary>
  3426. <value>The id.</value>
  3427. </member>
  3428. <member name="P:NPOI.DDF.EscherProperty.PropertyNumber">
  3429. <summary>
  3430. Gets the property number.
  3431. </summary>
  3432. <value>The property number.</value>
  3433. </member>
  3434. <member name="P:NPOI.DDF.EscherProperty.IsComplex">
  3435. <summary>
  3436. Gets a value indicating whether this instance is complex.
  3437. </summary>
  3438. <value>
  3439. <c>true</c> if this instance is complex; otherwise, <c>false</c>.
  3440. </value>
  3441. </member>
  3442. <member name="P:NPOI.DDF.EscherProperty.IsBlipId">
  3443. <summary>
  3444. Gets a value indicating whether this instance is blip id.
  3445. </summary>
  3446. <value>
  3447. <c>true</c> if this instance is blip id; otherwise, <c>false</c>.
  3448. </value>
  3449. </member>
  3450. <member name="P:NPOI.DDF.EscherProperty.Name">
  3451. <summary>
  3452. Gets the name.
  3453. </summary>
  3454. <value>The name.</value>
  3455. </member>
  3456. <member name="P:NPOI.DDF.EscherProperty.PropertySize">
  3457. <summary>
  3458. Most properties are just 6 bytes in Length. Override this if we're
  3459. dealing with complex properties.
  3460. </summary>
  3461. <value>The size of the property.</value>
  3462. </member>
  3463. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Byte[])">
  3464. <summary>
  3465. Create a complex property using the property id and a byte array containing the complex
  3466. data value.
  3467. </summary>
  3468. <param name="id"> The id consists of the property number, a flag indicating whether this is a blip id and a flag
  3469. indicating that this is a complex property.</param>
  3470. <param name="complexData">The value of this property.</param>
  3471. </member>
  3472. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Boolean,System.Byte[])">
  3473. <summary>
  3474. Create a complex property using the property number, a flag to indicate whether this is a
  3475. blip reference and the complex property data.
  3476. </summary>
  3477. <param name="propertyNumber">The property number.</param>
  3478. <param name="isBlipId">Whether this is a blip id. Should be false.</param>
  3479. <param name="complexData">The value of this complex property.</param>
  3480. </member>
  3481. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  3482. <summary>
  3483. Serializes the simple part of this property. ie the first 6 bytes.
  3484. </summary>
  3485. <param name="data"></param>
  3486. <param name="pos"></param>
  3487. <returns></returns>
  3488. </member>
  3489. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  3490. <summary>
  3491. Serializes the complex part of this property
  3492. </summary>
  3493. <param name="data">The data array to Serialize to</param>
  3494. <param name="pos">The offset within data to start serializing to.</param>
  3495. <returns>The number of bytes Serialized.</returns>
  3496. </member>
  3497. <member name="M:NPOI.DDF.EscherComplexProperty.Equals(System.Object)">
  3498. <summary>
  3499. Determine whether this property is equal to another property.
  3500. </summary>
  3501. <param name="o">The object to compare to.</param>
  3502. <returns>True if the objects are equal.</returns>
  3503. </member>
  3504. <member name="M:NPOI.DDF.EscherComplexProperty.GetHashCode">
  3505. <summary>
  3506. Serves as a hash function for a particular type.
  3507. </summary>
  3508. <returns>
  3509. A hash code for the current <see cref="T:System.Object"/>.
  3510. </returns>
  3511. </member>
  3512. <member name="M:NPOI.DDF.EscherComplexProperty.ToString">
  3513. <summary>
  3514. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3515. </summary>
  3516. <returns>
  3517. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3518. </returns>
  3519. </member>
  3520. <member name="P:NPOI.DDF.EscherComplexProperty.ComplexData">
  3521. <summary>
  3522. Gets the complex data.
  3523. </summary>
  3524. <value>The complex data.</value>
  3525. </member>
  3526. <member name="P:NPOI.DDF.EscherComplexProperty.PropertySize">
  3527. <summary>
  3528. Caclulates the number of bytes required to Serialize this property.
  3529. </summary>
  3530. <value>Number of bytes</value>
  3531. </member>
  3532. <member name="F:NPOI.DDF.EscherArrayProperty.FIXED_SIZE">
  3533. The size of the header that goes at the
  3534. start of the array, before the data
  3535. </member>
  3536. <member name="F:NPOI.DDF.EscherArrayProperty.sizeIncludesHeaderSize">
  3537. Normally, the size recorded in the simple data (for the complex
  3538. data) includes the size of the header.
  3539. There are a few cases when it doesn't though...
  3540. </member>
  3541. <member name="F:NPOI.DDF.EscherArrayProperty.emptyComplexPart">
  3542. When Reading a property from data stream remeber if the complex part is empty and Set this flag.
  3543. </member>
  3544. <member name="M:NPOI.DDF.EscherArrayProperty.GetElement(System.Int32)">
  3545. <summary>
  3546. Gets the element.
  3547. </summary>
  3548. <param name="index">The index.</param>
  3549. <returns></returns>
  3550. </member>
  3551. <member name="M:NPOI.DDF.EscherArrayProperty.SetElement(System.Int32,System.Byte[])">
  3552. <summary>
  3553. Sets the element.
  3554. </summary>
  3555. <param name="index">The index.</param>
  3556. <param name="element">The element.</param>
  3557. </member>
  3558. <member name="M:NPOI.DDF.EscherArrayProperty.ToString">
  3559. <summary>
  3560. Retrieves the string representation for this property.
  3561. </summary>
  3562. <returns></returns>
  3563. </member>
  3564. <member name="M:NPOI.DDF.EscherArrayProperty.SetArrayData(System.Byte[],System.Int32)">
  3565. <summary>
  3566. We have this method because the way in which arrays in escher works
  3567. is screwed for seemly arbitary reasons. While most properties are
  3568. fairly consistent and have a predictable array size, escher arrays
  3569. have special cases.
  3570. </summary>
  3571. <param name="data">The data array containing the escher array information</param>
  3572. <param name="offset">The offset into the array to start Reading from.</param>
  3573. <returns>the number of bytes used by this complex property.</returns>
  3574. </member>
  3575. <member name="M:NPOI.DDF.EscherArrayProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  3576. <summary>
  3577. Serializes the simple part of this property. ie the first 6 bytes.
  3578. Needs special code to handle the case when the size doesn't
  3579. include the size of the header block
  3580. </summary>
  3581. <param name="data"></param>
  3582. <param name="pos"></param>
  3583. <returns></returns>
  3584. </member>
  3585. <member name="M:NPOI.DDF.EscherArrayProperty.GetActualSizeOfElements(System.Int16)">
  3586. <summary>
  3587. Sometimes the element size is stored as a negative number. We
  3588. negate it and shift it to Get the real value.
  3589. </summary>
  3590. <param name="sizeOfElements">The size of elements.</param>
  3591. <returns></returns>
  3592. </member>
  3593. <member name="T:NPOI.DDF.EscherBitmapBlip">
  3594. <summary>
  3595. @author Glen Stampoultzis
  3596. @version $Id: EscherBitmapBlip.java 569827 2007-08-26 15:26:29Z yegor $
  3597. </summary>
  3598. </member>
  3599. <member name="T:NPOI.DDF.EscherBlipRecord">
  3600. <summary>
  3601. @author Glen Stampoultzis
  3602. @version $Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $
  3603. </summary>
  3604. </member>
  3605. <member name="M:NPOI.DDF.EscherBlipRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  3606. <summary>
  3607. This method deSerializes the record from a byte array.
  3608. </summary>
  3609. <param name="data">The byte array containing the escher record information</param>
  3610. <param name="offset">The starting offset into </param>
  3611. <param name="recordFactory">May be null since this is not a container record.</param>
  3612. <returns>The number of bytes Read from the byte array.</returns>
  3613. </member>
  3614. <member name="M:NPOI.DDF.EscherBlipRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  3615. <summary>
  3616. Serializes the record to an existing byte array.
  3617. </summary>
  3618. <param name="offset"> the offset within the byte array</param>
  3619. <param name="data">the data array to Serialize to</param>
  3620. <param name="listener">a listener for begin and end serialization events.</param>
  3621. <returns>the number of bytes written.</returns>
  3622. </member>
  3623. <member name="M:NPOI.DDF.EscherBlipRecord.ToString">
  3624. <summary>
  3625. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3626. </summary>
  3627. <returns>
  3628. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3629. </returns>
  3630. </member>
  3631. <member name="P:NPOI.DDF.EscherBlipRecord.RecordSize">
  3632. <summary>
  3633. Returns the number of bytes that are required to Serialize this record.
  3634. </summary>
  3635. <value>Number of bytes</value>
  3636. </member>
  3637. <member name="P:NPOI.DDF.EscherBlipRecord.RecordName">
  3638. <summary>
  3639. The short name for this record
  3640. </summary>
  3641. <value></value>
  3642. </member>
  3643. <member name="P:NPOI.DDF.EscherBlipRecord.PictureData">
  3644. <summary>
  3645. Gets or sets the picture data.
  3646. </summary>
  3647. <value>The picture data.</value>
  3648. </member>
  3649. <member name="M:NPOI.DDF.EscherBitmapBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  3650. <summary>
  3651. This method deSerializes the record from a byte array.
  3652. </summary>
  3653. <param name="data"> The byte array containing the escher record information</param>
  3654. <param name="offset">The starting offset into </param>
  3655. <param name="recordFactory">May be null since this is not a container record.</param>
  3656. <returns>The number of bytes Read from the byte array.</returns>
  3657. </member>
  3658. <member name="M:NPOI.DDF.EscherBitmapBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  3659. <summary>
  3660. Serializes the record to an existing byte array.
  3661. </summary>
  3662. <param name="offset">the offset within the byte array</param>
  3663. <param name="data">the data array to Serialize to</param>
  3664. <param name="listener">a listener for begin and end serialization events.</param>
  3665. <returns>the number of bytes written.</returns>
  3666. </member>
  3667. <member name="M:NPOI.DDF.EscherBitmapBlip.ToString">
  3668. <summary>
  3669. Toes the string.
  3670. </summary>
  3671. <returns></returns>
  3672. </member>
  3673. <member name="P:NPOI.DDF.EscherBitmapBlip.RecordSize">
  3674. <summary>
  3675. Returns the number of bytes that are required to Serialize this record.
  3676. </summary>
  3677. <value> Number of bytes</value>
  3678. </member>
  3679. <member name="P:NPOI.DDF.EscherBitmapBlip.UID">
  3680. <summary>
  3681. Gets or sets the UID.
  3682. </summary>
  3683. <value>The UID.</value>
  3684. </member>
  3685. <member name="P:NPOI.DDF.EscherBitmapBlip.Marker">
  3686. <summary>
  3687. Gets or sets the marker.
  3688. </summary>
  3689. <value>The marker.</value>
  3690. </member>
  3691. <member name="T:NPOI.DDF.EscherBlipWMFRecord">
  3692. <summary>
  3693. The blip record is used to hold details about large binary objects that occur in escher such
  3694. as JPEG, GIF, PICT and WMF files. The contents of the stream is usually compressed. Inflate
  3695. can be used to decompress the data.
  3696. @author Glen Stampoultzis
  3697. </summary>
  3698. </member>
  3699. <member name="M:NPOI.DDF.EscherBlipWMFRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  3700. <summary>
  3701. This method deserializes the record from a byte array.
  3702. </summary>
  3703. <param name="data">The byte array containing the escher record information</param>
  3704. <param name="offset">The starting offset into</param>
  3705. <param name="recordFactory">May be null since this is not a container record.</param>
  3706. <returns>
  3707. The number of bytes Read from the byte array.
  3708. </returns>
  3709. </member>
  3710. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  3711. <summary>
  3712. This method Serializes this escher record into a byte array.
  3713. @param offset
  3714. </summary>
  3715. <param name="offset">The offset into data to start writing the record data to.</param>
  3716. <param name="data">the data array to Serialize to</param>
  3717. <param name="listener">a listener for begin and end serialization events.</param>
  3718. <returns>the number of bytes written.</returns>
  3719. </member>
  3720. <member name="M:NPOI.DDF.EscherBlipWMFRecord.ToString">
  3721. <summary>
  3722. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3723. </summary>
  3724. <returns>
  3725. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3726. </returns>
  3727. </member>
  3728. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Compress(System.Byte[])">
  3729. <summary>
  3730. Compress the contents of the provided array
  3731. </summary>
  3732. <param name="data">An uncompressed byte array</param>
  3733. <returns></returns>
  3734. </member>
  3735. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Decompress(System.Byte[],System.Int32,System.Int32)">
  3736. <summary>
  3737. Decompresses the specified data.
  3738. </summary>
  3739. <param name="data">The compressed byte array.</param>
  3740. <param name="pos">The starting position into the byte array.</param>
  3741. <param name="Length">The number of compressed bytes to decompress.</param>
  3742. <returns>An uncompressed byte array</returns>
  3743. </member>
  3744. <member name="P:NPOI.DDF.EscherBlipWMFRecord.RecordSize">
  3745. <summary>
  3746. Returns the number of bytes that are required to Serialize this record.
  3747. </summary>
  3748. <value>Number of bytes</value>
  3749. </member>
  3750. <member name="P:NPOI.DDF.EscherBlipWMFRecord.RecordName">
  3751. <summary>
  3752. The short name for this record
  3753. </summary>
  3754. <value></value>
  3755. </member>
  3756. <member name="P:NPOI.DDF.EscherBlipWMFRecord.SecondaryUID">
  3757. <summary>
  3758. Gets or sets the secondary UID.
  3759. </summary>
  3760. <value>The secondary UID.</value>
  3761. </member>
  3762. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CacheOfSize">
  3763. <summary>
  3764. Gets or sets the size of the cache of.
  3765. </summary>
  3766. <value>The size of the cache of.</value>
  3767. </member>
  3768. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryTop">
  3769. <summary>
  3770. Gets or sets the top boundary of the metafile drawing commands
  3771. </summary>
  3772. <value>The boundary top.</value>
  3773. </member>
  3774. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryLeft">
  3775. <summary>
  3776. Gets or sets the left boundary of the metafile drawing commands
  3777. </summary>
  3778. <value>The boundary left.</value>
  3779. </member>
  3780. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryWidth">
  3781. <summary>
  3782. Gets or sets the boundary width of the metafile drawing commands
  3783. </summary>
  3784. <value>The width of the boundary.</value>
  3785. </member>
  3786. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryHeight">
  3787. <summary>
  3788. Gets or sets the boundary height of the metafile drawing commands
  3789. </summary>
  3790. <value>The height of the boundary.</value>
  3791. </member>
  3792. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Width">
  3793. <summary>
  3794. Gets or sets the width of the metafile in EMU's (English Metric Units).
  3795. </summary>
  3796. <value>The width.</value>
  3797. </member>
  3798. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Height">
  3799. <summary>
  3800. Gets or sets the height of the metafile in EMU's (English Metric Units).
  3801. </summary>
  3802. <value>The height.</value>
  3803. </member>
  3804. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CacheOfSavedSize">
  3805. <summary>
  3806. Gets or sets the cache of the saved size
  3807. </summary>
  3808. <value>the cache of the saved size.</value>
  3809. </member>
  3810. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CompressionFlag">
  3811. <summary>
  3812. Is the contents of the blip compressed?
  3813. </summary>
  3814. <value>The compression flag.</value>
  3815. </member>
  3816. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Filter">
  3817. <summary>
  3818. Gets or sets the filter.
  3819. </summary>
  3820. <value>The filter.</value>
  3821. </member>
  3822. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Data">
  3823. <summary>
  3824. Gets or sets The BLIP data
  3825. </summary>
  3826. <value>The data.</value>
  3827. </member>
  3828. <member name="T:NPOI.DDF.EscherBoolProperty">
  3829. <summary>
  3830. Represents a bool property. The actual utility of this property is in doubt because many
  3831. of the properties marked as bool seem to actually contain special values. In other words
  3832. they're not true bools.
  3833. @author Glen Stampoultzis
  3834. </summary>
  3835. </member>
  3836. <member name="T:NPOI.DDF.EscherSimpleProperty">
  3837. <summary>
  3838. A simple property is of fixed Length and as a property number in Addition
  3839. to a 32-bit value. Properties that can't be stored in only 32-bits are
  3840. stored as EscherComplexProperty objects.
  3841. @author Glen Stampoultzis (glens at apache.org)
  3842. </summary>
  3843. </member>
  3844. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Int32)">
  3845. <summary>
  3846. The id is distinct from the actual property number. The id includes the property number the blip id
  3847. flag and an indicator whether the property is complex or not.
  3848. </summary>
  3849. <param name="id">The id.</param>
  3850. <param name="propertyValue">The property value.</param>
  3851. </member>
  3852. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Boolean,System.Boolean,System.Int32)">
  3853. <summary>
  3854. Constructs a new escher property. The three parameters are combined to form a property
  3855. id.
  3856. </summary>
  3857. <param name="propertyNumber">The property number.</param>
  3858. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  3859. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  3860. <param name="propertyValue">The property value.</param>
  3861. </member>
  3862. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  3863. <summary>
  3864. Serialize the simple part of the escher record.
  3865. </summary>
  3866. <param name="data">The data.</param>
  3867. <param name="offset">The off set.</param>
  3868. <returns>the number of bytes Serialized.</returns>
  3869. </member>
  3870. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  3871. <summary>
  3872. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  3873. The fixed Length part is Serialized first.
  3874. </summary>
  3875. <param name="data"></param>
  3876. <param name="pos"></param>
  3877. <returns></returns>
  3878. </member>
  3879. <member name="M:NPOI.DDF.EscherSimpleProperty.Equals(System.Object)">
  3880. <summary>
  3881. Returns true if one escher property is equal to another.
  3882. </summary>
  3883. <param name="o">The o.</param>
  3884. <returns></returns>
  3885. </member>
  3886. <member name="M:NPOI.DDF.EscherSimpleProperty.GetHashCode">
  3887. <summary>
  3888. Serves as a hash function for a particular type.
  3889. </summary>
  3890. <returns>
  3891. A hash code for the current <see cref="T:System.Object"/>.
  3892. </returns>
  3893. </member>
  3894. <member name="M:NPOI.DDF.EscherSimpleProperty.ToString">
  3895. <summary>
  3896. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3897. </summary>
  3898. <returns>
  3899. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3900. </returns>
  3901. </member>
  3902. <member name="P:NPOI.DDF.EscherSimpleProperty.PropertyValue">
  3903. <summary>
  3904. Return the 32 bit value of this property.
  3905. </summary>
  3906. <value>The property value.</value>
  3907. </member>
  3908. <member name="M:NPOI.DDF.EscherBoolProperty.#ctor(System.Int16,System.Int32)">
  3909. <summary>
  3910. Create an instance of an escher bool property.
  3911. </summary>
  3912. <param name="propertyNumber">The property number (or id)</param>
  3913. <param name="value">The 32 bit value of this bool property</param>
  3914. </member>
  3915. <member name="P:NPOI.DDF.EscherBoolProperty.IsTrue">
  3916. <summary>
  3917. Whether this bool property is true
  3918. </summary>
  3919. <value><c>true</c> if this instance is true; otherwise, <c>false</c>.</value>
  3920. </member>
  3921. <member name="P:NPOI.DDF.EscherBoolProperty.IsFalse">
  3922. <summary>
  3923. Whether this bool property is false
  3924. </summary>
  3925. <value><c>true</c> if this instance is false; otherwise, <c>false</c>.</value>
  3926. </member>
  3927. <member name="T:NPOI.DDF.EscherBSERecord">
  3928. <summary>
  3929. The BSE record is related closely to the EscherBlipRecord and stores
  3930. extra information about the blip. A blip record is actually stored inside
  3931. the BSE record even though the BSE record isn't actually a container record.
  3932. @author Glen Stampoultzis
  3933. @see EscherBlipRecord
  3934. </summary>
  3935. </member>
  3936. <member name="M:NPOI.DDF.EscherBSERecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  3937. <summary>
  3938. This method deSerializes the record from a byte array.
  3939. </summary>
  3940. <param name="data">The byte array containing the escher record information</param>
  3941. <param name="offset">The starting offset into data</param>
  3942. <param name="recordFactory">May be null since this is not a container record.</param>
  3943. <returns>The number of bytes Read from the byte array.</returns>
  3944. </member>
  3945. <member name="M:NPOI.DDF.EscherBSERecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  3946. <summary>
  3947. This method Serializes this escher record into a byte array.
  3948. </summary>
  3949. <param name="offset">The offset into
  3950. data to start writing the record data to</param>
  3951. <param name="data">The byte array to Serialize to.</param>
  3952. <param name="listener">a listener for begin and end serialization events.</param>
  3953. <returns>The number of bytes written.</returns>
  3954. </member>
  3955. <member name="M:NPOI.DDF.EscherBSERecord.ToString">
  3956. <summary>
  3957. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3958. </summary>
  3959. <returns>
  3960. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3961. </returns>
  3962. </member>
  3963. <member name="M:NPOI.DDF.EscherBSERecord.GetBlipType(System.Byte)">
  3964. <summary>
  3965. Retrieve the string representation given a blip id.
  3966. </summary>
  3967. <param name="b">The b.</param>
  3968. <returns></returns>
  3969. </member>
  3970. <member name="P:NPOI.DDF.EscherBSERecord.RecordSize">
  3971. <summary>
  3972. Returns the number of bytes that are required to Serialize this record.
  3973. </summary>
  3974. <value>Number of bytes</value>
  3975. </member>
  3976. <member name="P:NPOI.DDF.EscherBSERecord.RecordName">
  3977. <summary>
  3978. The short name for this record
  3979. </summary>
  3980. <value></value>
  3981. </member>
  3982. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeWin32">
  3983. <summary>
  3984. Gets or sets the expected blip type under windows (failure to match this blip type will result in
  3985. Excel converting to this format).
  3986. </summary>
  3987. <value>The blip type win32.</value>
  3988. </member>
  3989. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeMacOS">
  3990. <summary>
  3991. Gets or sets the expected blip type under MacOS (failure to match this blip type will result in
  3992. Excel converting to this format).
  3993. </summary>
  3994. <value>The blip type mac OS.</value>
  3995. </member>
  3996. <member name="P:NPOI.DDF.EscherBSERecord.UID">
  3997. <summary>
  3998. Gets or sets 16 byte MD4 checksum.
  3999. </summary>
  4000. <value>The UID.</value>
  4001. </member>
  4002. <member name="P:NPOI.DDF.EscherBSERecord.Tag">
  4003. <summary>
  4004. Gets or sets the tag. (Unused)
  4005. </summary>
  4006. <value>The tag.</value>
  4007. </member>
  4008. <member name="P:NPOI.DDF.EscherBSERecord.Size">
  4009. <summary>
  4010. Gets or sets Blip size in stream..
  4011. </summary>
  4012. <value>The size.</value>
  4013. </member>
  4014. <member name="P:NPOI.DDF.EscherBSERecord.Ref">
  4015. <summary>
  4016. Gets or sets the reference count of this blip.
  4017. </summary>
  4018. <value>The ref.</value>
  4019. </member>
  4020. <member name="P:NPOI.DDF.EscherBSERecord.Offset">
  4021. <summary>
  4022. Gets or sets the offset in the delay stream..
  4023. </summary>
  4024. <value>The offset.</value>
  4025. </member>
  4026. <member name="P:NPOI.DDF.EscherBSERecord.Usage">
  4027. <summary>
  4028. Defines the way this blip is used.
  4029. </summary>
  4030. <value>The usage.</value>
  4031. </member>
  4032. <member name="P:NPOI.DDF.EscherBSERecord.Name">
  4033. <summary>
  4034. Gets or sets the blip name.
  4035. </summary>
  4036. <value>The name.</value>
  4037. </member>
  4038. <member name="P:NPOI.DDF.EscherBSERecord.Unused2">
  4039. <summary>
  4040. Gets or sets the unused2.
  4041. </summary>
  4042. <value>The unused2.</value>
  4043. </member>
  4044. <member name="P:NPOI.DDF.EscherBSERecord.Unused3">
  4045. <summary>
  4046. Gets or sets the unused3.
  4047. </summary>
  4048. <value>The unused3.</value>
  4049. </member>
  4050. <member name="P:NPOI.DDF.EscherBSERecord.BlipRecord">
  4051. <summary>
  4052. Gets or sets the blip record.
  4053. </summary>
  4054. <value>The blip record.</value>
  4055. </member>
  4056. <member name="P:NPOI.DDF.EscherBSERecord.RemainingData">
  4057. <summary>
  4058. Gets or sets any remaining data in this record.
  4059. </summary>
  4060. <value>The remaining data.</value>
  4061. </member>
  4062. <member name="T:NPOI.DDF.EscherChildAnchorRecord">
  4063. <summary>
  4064. The escher child achor record is used to specify the position of a shape under an
  4065. existing group. The first level of shape records use a EscherClientAnchor record instead.
  4066. @author Glen Stampoultzis
  4067. </summary>
  4068. </member>
  4069. <member name="M:NPOI.DDF.EscherChildAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4070. <summary>
  4071. This method deSerializes the record from a byte array.
  4072. </summary>
  4073. <param name="data">The byte array containing the escher record information</param>
  4074. <param name="offset">The starting offset into data</param>
  4075. <param name="recordFactory">May be null since this is not a container record.</param>
  4076. <returns>The number of bytes Read from the byte array.</returns>
  4077. </member>
  4078. <member name="M:NPOI.DDF.EscherChildAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4079. <summary>
  4080. This method Serializes this escher record into a byte array.
  4081. </summary>
  4082. <param name="offset">The offset into data to start writing the record data to.</param>
  4083. <param name="data">The byte array to Serialize to.</param>
  4084. <param name="listener">a listener for begin and end serialization events.</param>
  4085. <returns>The number of bytes written.</returns>
  4086. </member>
  4087. <member name="M:NPOI.DDF.EscherChildAnchorRecord.ToString">
  4088. <summary>
  4089. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4090. </summary>
  4091. <returns>
  4092. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4093. </returns>
  4094. </member>
  4095. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordSize">
  4096. <summary>
  4097. Returns the number of bytes that are required to Serialize this record.
  4098. </summary>
  4099. <value>Number of bytes</value>
  4100. </member>
  4101. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordId">
  4102. <summary>
  4103. The record id for the EscherChildAnchorRecord.
  4104. </summary>
  4105. <value></value>
  4106. </member>
  4107. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordName">
  4108. <summary>
  4109. The short name for this record
  4110. </summary>
  4111. <value></value>
  4112. </member>
  4113. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx1">
  4114. <summary>
  4115. Gets or sets offset within the parent coordinate space for the top left point.
  4116. </summary>
  4117. <value>The DX1.</value>
  4118. </member>
  4119. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy1">
  4120. <summary>
  4121. Gets or sets the offset within the parent coordinate space for the top left point.
  4122. </summary>
  4123. <value>The dy1.</value>
  4124. </member>
  4125. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx2">
  4126. <summary>
  4127. Gets or sets the offset within the parent coordinate space for the bottom right point.
  4128. </summary>
  4129. <value>The DX2.</value>
  4130. </member>
  4131. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy2">
  4132. <summary>
  4133. Gets or sets the offset within the parent coordinate space for the bottom right point.
  4134. </summary>
  4135. <value>The dy2.</value>
  4136. </member>
  4137. <member name="T:NPOI.DDF.EscherClientAnchorRecord">
  4138. <summary>
  4139. The escher client anchor specifies which rows and cells the shape is bound to as well as
  4140. the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless
  4141. of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most
  4142. shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
  4143. @author Glen Stampoultzis
  4144. </summary>
  4145. </member>
  4146. <member name="F:NPOI.DDF.EscherClientAnchorRecord.field_1_flag">
  4147. bit[0] - fMove (1 bit): A bit that specifies whether the shape will be kept intact when the cells are moved.
  4148. 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.
  4149. bit[2-4] - reserved, MUST be 0 and MUST be ignored
  4150. bit[5-15]- Undefined and MUST be ignored.
  4151. it can take values: 0, 2, 3
  4152. </member>
  4153. <member name="M:NPOI.DDF.EscherClientAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4154. <summary>
  4155. This method deSerializes the record from a byte array.
  4156. </summary>
  4157. <param name="data">The byte array containing the escher record information</param>
  4158. <param name="offset">The starting offset into data</param>
  4159. <param name="recordFactory">May be null since this is not a container record.</param>
  4160. <returns>The number of bytes Read from the byte array.</returns>
  4161. </member>
  4162. <member name="M:NPOI.DDF.EscherClientAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4163. <summary>
  4164. This method Serializes this escher record into a byte array.
  4165. </summary>
  4166. <param name="offset">The offset into data to start writing the record data to.</param>
  4167. <param name="data">The byte array to Serialize to.</param>
  4168. <param name="listener">a listener for begin and end serialization events.</param>
  4169. <returns>The number of bytes written.</returns>
  4170. </member>
  4171. <member name="M:NPOI.DDF.EscherClientAnchorRecord.ToString">
  4172. <summary>
  4173. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4174. </summary>
  4175. <returns>
  4176. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4177. </returns>
  4178. </member>
  4179. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordSize">
  4180. <summary>
  4181. Returns the number of bytes that are required to Serialize this record.
  4182. </summary>
  4183. <value>Number of bytes</value>
  4184. </member>
  4185. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordId">
  4186. <summary>
  4187. The record id for this record.
  4188. </summary>
  4189. <value></value>
  4190. </member>
  4191. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordName">
  4192. <summary>
  4193. The short name for this record
  4194. </summary>
  4195. <value></value>
  4196. </member>
  4197. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Flag">
  4198. <summary>
  4199. Gets or sets the flag.
  4200. </summary>
  4201. <value>0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</value>
  4202. </member>
  4203. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col1">
  4204. <summary>
  4205. Gets or sets The column number for the top-left position. 0 based.
  4206. </summary>
  4207. <value>The col1.</value>
  4208. </member>
  4209. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx1">
  4210. <summary>
  4211. Gets or sets The x offset within the top-left cell. Range is from 0 to 1023.
  4212. </summary>
  4213. <value>The DX1.</value>
  4214. </member>
  4215. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row1">
  4216. <summary>
  4217. Gets or sets The row number for the top-left corner of the shape.
  4218. </summary>
  4219. <value>The row1.</value>
  4220. </member>
  4221. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy1">
  4222. <summary>
  4223. Gets or sets The y offset within the top-left corner of the current shape.
  4224. </summary>
  4225. <value>The dy1.</value>
  4226. </member>
  4227. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col2">
  4228. <summary>
  4229. Gets or sets The column of the bottom right corner of this shape.
  4230. </summary>
  4231. <value>The col2.</value>
  4232. </member>
  4233. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx2">
  4234. <summary>
  4235. Gets or sets The x offset withing the cell for the bottom-right corner of this shape.
  4236. </summary>
  4237. <value>The DX2.</value>
  4238. </member>
  4239. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row2">
  4240. <summary>
  4241. Gets or sets The row number for the bottom-right corner of the current shape.
  4242. </summary>
  4243. <value>The row2.</value>
  4244. </member>
  4245. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy2">
  4246. <summary>
  4247. Gets or sets The y offset withing the cell for the bottom-right corner of this shape.
  4248. </summary>
  4249. <value>The dy2.</value>
  4250. </member>
  4251. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RemainingData">
  4252. <summary>
  4253. Gets or sets the remaining data.
  4254. </summary>
  4255. <value>The remaining data.</value>
  4256. </member>
  4257. <member name="T:NPOI.DDF.EscherClientDataRecord">
  4258. <summary>
  4259. The EscherClientDataRecord is used to store client specific data about the position of a
  4260. shape within a container.
  4261. @author Glen Stampoultzis
  4262. </summary>
  4263. </member>
  4264. <member name="M:NPOI.DDF.EscherClientDataRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4265. <summary>
  4266. This method deSerializes the record from a byte array.
  4267. </summary>
  4268. <param name="data">The byte array containing the escher record information</param>
  4269. <param name="offset">The starting offset into data</param>
  4270. <param name="recordFactory">May be null since this is not a container record.</param>
  4271. <returns>The number of bytes Read from the byte array.</returns>
  4272. </member>
  4273. <member name="M:NPOI.DDF.EscherClientDataRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4274. This method Serializes this escher record into a byte array.
  4275. @param offset The offset into <c>data</c> to start writing the record data to.
  4276. @param data The byte array to Serialize to.
  4277. @param listener A listener to retrieve start and end callbacks. Use a <c>NullEscherSerailizationListener</c> to ignore these events.
  4278. @return The number of bytes written.
  4279. @see NullEscherSerializationListener
  4280. </member>
  4281. <member name="M:NPOI.DDF.EscherClientDataRecord.ToString">
  4282. Returns the string representation of this record.
  4283. </member>
  4284. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordSize">
  4285. Returns the number of bytes that are required to Serialize this record.
  4286. @return Number of bytes
  4287. </member>
  4288. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordId">
  4289. Returns the identifier of this record.
  4290. </member>
  4291. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordName">
  4292. The short name for this record
  4293. </member>
  4294. <member name="P:NPOI.DDF.EscherClientDataRecord.RemainingData">
  4295. Any data recording this record.
  4296. </member>
  4297. <member name="T:NPOI.DDF.EscherContainerRecord">
  4298. <summary>
  4299. Escher container records store other escher records as children.
  4300. The container records themselves never store any information beyond
  4301. the standard header used by all escher records. This one record is
  4302. used to represent many different types of records.
  4303. @author Glen Stampoultzis
  4304. </summary>
  4305. </member>
  4306. <member name="F:NPOI.DDF.EscherContainerRecord._remainingLength">
  4307. in case if document contains any charts we have such document structure:
  4308. BOF
  4309. ...
  4310. DrawingRecord
  4311. ...
  4312. ObjRecord|TxtObjRecord
  4313. ...
  4314. EOF
  4315. ...
  4316. BOF(Chart begin)
  4317. ...
  4318. DrawingRecord
  4319. ...
  4320. ObjRecord|TxtObjRecord
  4321. ...
  4322. EOF
  4323. So, when we call EscherAggregate.createAggregate() we have not all needed data.
  4324. When we got warning "WARNING: " + bytesRemaining + " bytes remaining but no space left"
  4325. we should save value of bytesRemaining
  4326. and add it to container size when we serialize it
  4327. </member>
  4328. <member name="M:NPOI.DDF.EscherContainerRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4329. <summary>
  4330. The contract of this method is to deSerialize an escher record including
  4331. it's children.
  4332. </summary>
  4333. <param name="data">The byte array containing the Serialized escher
  4334. records.</param>
  4335. <param name="offset">The offset into the byte array.</param>
  4336. <param name="recordFactory">A factory for creating new escher records</param>
  4337. <returns>The number of bytes written.</returns>
  4338. </member>
  4339. <member name="M:NPOI.DDF.EscherContainerRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4340. <summary>
  4341. Serializes to an existing byte array without serialization listener.
  4342. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  4343. </summary>
  4344. <param name="offset">the offset within the data byte array.</param>
  4345. <param name="data"> the data array to Serialize to.</param>
  4346. <param name="listener">a listener for begin and end serialization events.</param>
  4347. <returns>The number of bytes written.</returns>
  4348. </member>
  4349. <member name="M:NPOI.DDF.EscherContainerRecord.HasChildOfType(System.Int16)">
  4350. <summary>
  4351. Do any of our (top level) children have the
  4352. given recordId?
  4353. </summary>
  4354. <param name="recordId">The record id.</param>
  4355. <returns>
  4356. <c>true</c> if [has child of type] [the specified record id]; otherwise, <c>false</c>.
  4357. </returns>
  4358. </member>
  4359. <member name="M:NPOI.DDF.EscherContainerRecord.Display(System.Int32)">
  4360. <summary>
  4361. The display methods allows escher variables to print the record names
  4362. according to their hierarchy.
  4363. </summary>
  4364. <param name="indent">The current indent level.</param>
  4365. </member>
  4366. <member name="M:NPOI.DDF.EscherContainerRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  4367. <summary>
  4368. Adds the child record.
  4369. </summary>
  4370. <param name="record">The record.</param>
  4371. </member>
  4372. <member name="M:NPOI.DDF.EscherContainerRecord.ToString">
  4373. <summary>
  4374. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4375. </summary>
  4376. <returns>
  4377. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4378. </returns>
  4379. </member>
  4380. <member name="M:NPOI.DDF.EscherContainerRecord.GetChildById(System.Int16)">
  4381. <summary>
  4382. Gets the child by id.
  4383. </summary>
  4384. <param name="recordId">The record id.</param>
  4385. <returns></returns>
  4386. </member>
  4387. <member name="M:NPOI.DDF.EscherContainerRecord.GetRecordsById(System.Int16,System.Collections.ArrayList@)">
  4388. <summary>
  4389. Recursively find records with the specified record ID
  4390. </summary>
  4391. <param name="recordId"></param>
  4392. <param name="out1">list to store found records</param>
  4393. </member>
  4394. <member name="P:NPOI.DDF.EscherContainerRecord.RecordSize">
  4395. <summary>
  4396. Subclasses should effeciently return the number of bytes required to
  4397. Serialize the record.
  4398. </summary>
  4399. <value>number of bytes</value>
  4400. </member>
  4401. <member name="P:NPOI.DDF.EscherContainerRecord.ChildRecords">
  4402. <summary>
  4403. Returns a list of all the child (escher) records
  4404. of the container.
  4405. </summary>
  4406. <value></value>
  4407. </member>
  4408. <member name="P:NPOI.DDF.EscherContainerRecord.ChildContainers">
  4409. <summary>
  4410. Returns all of our children which are also
  4411. EscherContainers (may be 0, 1, or vary rarely
  4412. 2 or 3)
  4413. </summary>
  4414. <value>The child containers.</value>
  4415. </member>
  4416. <member name="P:NPOI.DDF.EscherContainerRecord.RecordName">
  4417. <summary>
  4418. Subclasses should return the short name for this escher record.
  4419. </summary>
  4420. <value></value>
  4421. </member>
  4422. <member name="T:NPOI.DDF.EscherDggRecord">
  4423. <summary>
  4424. This record defines the drawing groups used for a particular sheet.
  4425. </summary>
  4426. </member>
  4427. <member name="M:NPOI.DDF.EscherDggRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4428. <summary>
  4429. This method deSerializes the record from a byte array.
  4430. </summary>
  4431. <param name="data">The byte array containing the escher record information</param>
  4432. <param name="offset">The starting offset into data</param>
  4433. <param name="recordFactory">May be null since this is not a container record.</param>
  4434. <returns>The number of bytes Read from the byte array.</returns>
  4435. </member>
  4436. <member name="M:NPOI.DDF.EscherDggRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4437. <summary>
  4438. This method Serializes this escher record into a byte array.
  4439. </summary>
  4440. <param name="offset">The offset into data to start writing the record data to.</param>
  4441. <param name="data">The byte array to Serialize to.</param>
  4442. <param name="listener">a listener for begin and end serialization events.</param>
  4443. <returns>The number of bytes written.</returns>
  4444. </member>
  4445. <member name="M:NPOI.DDF.EscherDggRecord.ToString">
  4446. <summary>
  4447. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4448. </summary>
  4449. <returns>
  4450. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4451. </returns>
  4452. </member>
  4453. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32)">
  4454. <summary>
  4455. Adds the cluster.
  4456. </summary>
  4457. <param name="dgId">The dg id.</param>
  4458. <param name="numShapedUsed">The num shaped used.</param>
  4459. </member>
  4460. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32,System.Boolean)">
  4461. <summary>
  4462. Adds the cluster.
  4463. </summary>
  4464. <param name="dgId">id of the drawing group (stored in the record options)</param>
  4465. <param name="numShapedUsed">initial value of the numShapedUsed field</param>
  4466. <param name="sort">if set to <c>true</c> if true then sort clusters by drawing group id.(
  4467. In Excel the clusters are sorted but in PPT they are not).</param>
  4468. </member>
  4469. <member name="P:NPOI.DDF.EscherDggRecord.RecordSize">
  4470. <summary>
  4471. Returns the number of bytes that are required to Serialize this record.
  4472. </summary>
  4473. <value>Number of bytes</value>
  4474. </member>
  4475. <member name="P:NPOI.DDF.EscherDggRecord.RecordId">
  4476. <summary>
  4477. Return the current record id.
  4478. </summary>
  4479. <value>The 16 bit record id.</value>
  4480. </member>
  4481. <member name="P:NPOI.DDF.EscherDggRecord.RecordName">
  4482. <summary>
  4483. The short name for this record
  4484. </summary>
  4485. <value></value>
  4486. </member>
  4487. <member name="P:NPOI.DDF.EscherDggRecord.ShapeIdMax">
  4488. <summary>
  4489. Gets or sets the shape id max.
  4490. </summary>
  4491. <value>The shape id max.</value>
  4492. </member>
  4493. <member name="P:NPOI.DDF.EscherDggRecord.NumIdClusters">
  4494. <summary>
  4495. Gets the Number of id clusters + 1
  4496. </summary>
  4497. <value>The num id clusters.</value>
  4498. </member>
  4499. <member name="P:NPOI.DDF.EscherDggRecord.NumShapesSaved">
  4500. <summary>
  4501. Gets or sets the num shapes saved.
  4502. </summary>
  4503. <value>The num shapes saved.</value>
  4504. </member>
  4505. <member name="P:NPOI.DDF.EscherDggRecord.DrawingsSaved">
  4506. <summary>
  4507. Gets or sets the drawings saved.
  4508. </summary>
  4509. <value>The drawings saved.</value>
  4510. </member>
  4511. <member name="P:NPOI.DDF.EscherDggRecord.MaxDrawingGroupId">
  4512. <summary>
  4513. Gets or sets the max drawing group id.
  4514. </summary>
  4515. <value>The max drawing group id.</value>
  4516. </member>
  4517. <member name="P:NPOI.DDF.EscherDggRecord.FileIdClusters">
  4518. <summary>
  4519. Gets or sets the file id clusters.
  4520. </summary>
  4521. <value>The file id clusters.</value>
  4522. </member>
  4523. <member name="T:NPOI.DDF.EscherDgRecord">
  4524. <summary>
  4525. This record simply holds the number of shapes in the drawing group and the
  4526. last shape id used for this drawing group.
  4527. @author Glen Stampoultzis
  4528. </summary>
  4529. </member>
  4530. <member name="M:NPOI.DDF.EscherDgRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4531. <summary>
  4532. This method deSerializes the record from a byte array.
  4533. </summary>
  4534. <param name="data">The byte array containing the escher record information</param>
  4535. <param name="offset">The starting offset into data</param>
  4536. <param name="recordFactory">May be null since this is not a container record.</param>
  4537. <returns>The number of bytes Read from the byte array.</returns>
  4538. </member>
  4539. <member name="M:NPOI.DDF.EscherDgRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4540. <summary>
  4541. This method Serializes this escher record into a byte array.
  4542. </summary>
  4543. <param name="offset"> The offset into data to start writing the record data to.</param>
  4544. <param name="data"> The byte array to Serialize to.</param>
  4545. <returns>The number of bytes written.</returns>
  4546. <param name="listener">a listener for begin and end serialization events.</param>
  4547. </member>
  4548. <member name="M:NPOI.DDF.EscherDgRecord.ToString">
  4549. <summary>
  4550. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4551. </summary>
  4552. <returns>
  4553. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4554. </returns>
  4555. </member>
  4556. <member name="M:NPOI.DDF.EscherDgRecord.IncrementShapeCount">
  4557. <summary>
  4558. Increments the shape count.
  4559. </summary>
  4560. </member>
  4561. <member name="P:NPOI.DDF.EscherDgRecord.RecordSize">
  4562. <summary>
  4563. Returns the number of bytes that are required to Serialize this record.
  4564. </summary>
  4565. <value>Number of bytes</value>
  4566. </member>
  4567. <member name="P:NPOI.DDF.EscherDgRecord.RecordId">
  4568. <summary>
  4569. Return the current record id.
  4570. </summary>
  4571. <value>The 16 bit record id.</value>
  4572. </member>
  4573. <member name="P:NPOI.DDF.EscherDgRecord.RecordName">
  4574. <summary>
  4575. The short name for this record
  4576. </summary>
  4577. <value></value>
  4578. </member>
  4579. <member name="P:NPOI.DDF.EscherDgRecord.NumShapes">
  4580. <summary>
  4581. Gets or sets The number of shapes in this drawing group.
  4582. </summary>
  4583. <value>The num shapes.</value>
  4584. </member>
  4585. <member name="P:NPOI.DDF.EscherDgRecord.LastMSOSPID">
  4586. <summary>
  4587. Gets or sets The last shape id used in this drawing group.
  4588. </summary>
  4589. <value>The last MSOSPID.</value>
  4590. </member>
  4591. <member name="P:NPOI.DDF.EscherDgRecord.DrawingGroupId">
  4592. <summary>
  4593. Gets the drawing group id for this record. This is encoded in the
  4594. instance part of the option record.
  4595. </summary>
  4596. <value>The drawing group id.</value>
  4597. </member>
  4598. <member name="T:NPOI.DDF.EscherDump">
  4599. <summary>
  4600. Used to dump the contents of escher records to a PrintStream.
  4601. @author Glen Stampoultzis (glens at apache.org)
  4602. </summary>
  4603. </member>
  4604. <member name="M:NPOI.DDF.EscherDump.Dump(System.Byte[],System.Int32,System.Int32)">
  4605. <summary>
  4606. Decodes the escher stream from a byte array and dumps the results to
  4607. a print stream.
  4608. </summary>
  4609. <param name="data">The data array containing the escher records.</param>
  4610. <param name="offset">The starting offset within the data array.</param>
  4611. <param name="size">The number of bytes to Read.</param>
  4612. </member>
  4613. <member name="M:NPOI.DDF.EscherDump.DumpOld(System.Int64,System.IO.Stream)">
  4614. <summary>
  4615. This version of dump is a translation from the open office escher dump routine.
  4616. </summary>
  4617. <param name="maxLength">The number of bytes to Read</param>
  4618. <param name="in1">An input stream to Read from.</param>
  4619. </member>
  4620. <member name="M:NPOI.DDF.EscherDump.PropertyName(System.Int16)">
  4621. <summary>
  4622. Returns a property name given a property id. This is used only by the
  4623. old escher dump routine.
  4624. </summary>
  4625. <param name="propertyId">The property number for the name</param>
  4626. <returns>A descriptive name.</returns>
  4627. </member>
  4628. <member name="M:NPOI.DDF.EscherDump.GetBlipType(System.Byte)">
  4629. <summary>
  4630. Returns the blip description given a blip id.
  4631. </summary>
  4632. <param name="b">blip id</param>
  4633. <returns> A description.</returns>
  4634. </member>
  4635. <member name="M:NPOI.DDF.EscherDump.Dec1616(System.Int32)">
  4636. <summary>
  4637. Straight conversion from OO. Converts a type of float.
  4638. </summary>
  4639. <param name="n32">The N32.</param>
  4640. <returns></returns>
  4641. </member>
  4642. <member name="M:NPOI.DDF.EscherDump.OutHex(System.Int32,System.IO.Stream)">
  4643. <summary>
  4644. Dumps out a hex value by Reading from a input stream.
  4645. </summary>
  4646. <param name="bytes">How many bytes this hex value consists of.</param>
  4647. <param name="in1">The stream to Read the hex value from.</param>
  4648. </member>
  4649. <member name="M:NPOI.DDF.EscherDump.Dump(System.Int32,System.Byte[])">
  4650. <summary>
  4651. Dumps the specified record size.
  4652. </summary>
  4653. <param name="recordSize">Size of the record.</param>
  4654. <param name="data">The data.</param>
  4655. </member>
  4656. <member name="T:NPOI.DDF.EscherMetafileBlip">
  4657. <summary>
  4658. @author Daniel Noll
  4659. </summary>
  4660. </member>
  4661. <member name="F:NPOI.DDF.EscherMetafileBlip.SIGNATURE_EMF">
  4662. BLIP signatures as defined in the escher spec
  4663. </member>
  4664. <member name="F:NPOI.DDF.EscherMetafileBlip.field_2_UID">
  4665. The primary UID is only saved to disk if (blip_instance ^ blip_signature == 1)
  4666. </member>
  4667. <member name="M:NPOI.DDF.EscherMetafileBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4668. <summary>
  4669. This method deSerializes the record from a byte array.
  4670. </summary>
  4671. <param name="data">The byte array containing the escher record information</param>
  4672. <param name="offset">The starting offset into</param>
  4673. <param name="recordFactory">May be null since this is not a container record.</param>
  4674. <returns>
  4675. The number of bytes Read from the byte array.
  4676. </returns>
  4677. </member>
  4678. <member name="M:NPOI.DDF.EscherMetafileBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4679. <summary>
  4680. Serializes the record to an existing byte array.
  4681. </summary>
  4682. <param name="offset">the offset within the byte array</param>
  4683. <param name="data">the data array to Serialize to</param>
  4684. <param name="listener">a listener for begin and end serialization events.</param>
  4685. <returns>the number of bytes written.</returns>
  4686. </member>
  4687. <member name="M:NPOI.DDF.EscherMetafileBlip.InflatePictureData(System.Byte[])">
  4688. <summary>
  4689. Decompresses the provided data, returning the inflated result.
  4690. </summary>
  4691. <param name="data">the deflated picture data.</param>
  4692. <returns>the inflated picture data.</returns>
  4693. </member>
  4694. <member name="M:NPOI.DDF.EscherMetafileBlip.ToString">
  4695. <summary>
  4696. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4697. </summary>
  4698. <returns>
  4699. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4700. </returns>
  4701. </member>
  4702. <member name="P:NPOI.DDF.EscherMetafileBlip.RecordSize">
  4703. <summary>
  4704. Returns the number of bytes that are required to Serialize this record.
  4705. </summary>
  4706. <value>Number of bytes</value>
  4707. </member>
  4708. <member name="P:NPOI.DDF.EscherMetafileBlip.UID">
  4709. <summary>
  4710. Gets or sets the UID.
  4711. </summary>
  4712. <value>The UID.</value>
  4713. </member>
  4714. <member name="P:NPOI.DDF.EscherMetafileBlip.PrimaryUID">
  4715. <summary>
  4716. Gets or sets the primary UID.
  4717. </summary>
  4718. <value>The primary UID.</value>
  4719. </member>
  4720. <member name="P:NPOI.DDF.EscherMetafileBlip.UncompressedSize">
  4721. <summary>
  4722. Gets or sets the size of the uncompressed.
  4723. </summary>
  4724. <value>The size of the uncompressed.</value>
  4725. </member>
  4726. <member name="P:NPOI.DDF.EscherMetafileBlip.Bounds">
  4727. <summary>
  4728. Gets or sets the bounds.
  4729. </summary>
  4730. <value>The bounds.</value>
  4731. </member>
  4732. <member name="P:NPOI.DDF.EscherMetafileBlip.SizeEMU">
  4733. <summary>
  4734. Gets or sets the size EMU.
  4735. </summary>
  4736. <value>The size EMU.</value>
  4737. </member>
  4738. <member name="P:NPOI.DDF.EscherMetafileBlip.CompressedSize">
  4739. <summary>
  4740. Gets or sets the size of the compressed.
  4741. </summary>
  4742. <value>The size of the compressed.</value>
  4743. </member>
  4744. <member name="P:NPOI.DDF.EscherMetafileBlip.IsCompressed">
  4745. <summary>
  4746. Gets or sets a value indicating whether this instance is compressed.
  4747. </summary>
  4748. <value>
  4749. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  4750. </value>
  4751. </member>
  4752. <member name="P:NPOI.DDF.EscherMetafileBlip.Signature">
  4753. <summary>
  4754. Return the blip signature
  4755. </summary>
  4756. <value>the blip signature</value>
  4757. </member>
  4758. <member name="T:NPOI.DDF.EscherOptRecord">
  4759. <summary>
  4760. The opt record is used to store property values for a shape. It is the key to determining
  4761. the attributes of a shape. Properties can be of two types: simple or complex. Simple types
  4762. are fixed Length. Complex properties are variable Length.
  4763. @author Glen Stampoultzis
  4764. </summary>
  4765. </member>
  4766. <member name="P:NPOI.DDF.EscherOptRecord.Options">
  4767. <summary>
  4768. Automatically recalculate the correct option
  4769. </summary>
  4770. <value></value>
  4771. </member>
  4772. <member name="P:NPOI.DDF.EscherOptRecord.RecordName">
  4773. <summary>
  4774. The short name for this record
  4775. </summary>
  4776. <value></value>
  4777. </member>
  4778. <member name="T:NPOI.DDF.EscherPictBlip">
  4779. <summary>
  4780. @author Daniel Noll
  4781. </summary>
  4782. </member>
  4783. <member name="M:NPOI.DDF.EscherPictBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  4784. <summary>
  4785. This method deSerializes the record from a byte array.
  4786. </summary>
  4787. <param name="data">The byte array containing the escher record information</param>
  4788. <param name="offset">The starting offset into</param>
  4789. <param name="recordFactory">May be null since this is not a container record.</param>
  4790. <returns>
  4791. The number of bytes Read from the byte array.
  4792. </returns>
  4793. </member>
  4794. <member name="M:NPOI.DDF.EscherPictBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  4795. <summary>
  4796. Serializes the record to an existing byte array.
  4797. </summary>
  4798. <param name="offset">the offset within the byte array</param>
  4799. <param name="data">the data array to Serialize to</param>
  4800. <param name="listener">a listener for begin and end serialization events.</param>
  4801. <returns>the number of bytes written.</returns>
  4802. </member>
  4803. <member name="M:NPOI.DDF.EscherPictBlip.InflatePictureData(System.Byte[])">
  4804. <summary>
  4805. Decompresses the provided data, returning the inflated result.
  4806. </summary>
  4807. <param name="data">the deflated picture data.</param>
  4808. <returns>the inflated picture data.</returns>
  4809. </member>
  4810. <member name="M:NPOI.DDF.EscherPictBlip.ToString">
  4811. <summary>
  4812. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4813. </summary>
  4814. <returns>
  4815. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4816. </returns>
  4817. </member>
  4818. <member name="P:NPOI.DDF.EscherPictBlip.RecordSize">
  4819. <summary>
  4820. Returns the number of bytes that are required to Serialize this record.
  4821. </summary>
  4822. <value>Number of bytes</value>
  4823. </member>
  4824. <member name="P:NPOI.DDF.EscherPictBlip.UID">
  4825. <summary>
  4826. Gets or sets the UID.
  4827. </summary>
  4828. <value>The UID.</value>
  4829. </member>
  4830. <member name="P:NPOI.DDF.EscherPictBlip.UncompressedSize">
  4831. <summary>
  4832. Gets or sets the size of the uncompressed.
  4833. </summary>
  4834. <value>The size of the uncompressed.</value>
  4835. </member>
  4836. <member name="P:NPOI.DDF.EscherPictBlip.Bounds">
  4837. <summary>
  4838. Gets or sets the bounds.
  4839. </summary>
  4840. <value>The bounds.</value>
  4841. </member>
  4842. <member name="P:NPOI.DDF.EscherPictBlip.SizeEMU">
  4843. <summary>
  4844. Gets or sets the size EMU.
  4845. </summary>
  4846. <value>The size EMU.</value>
  4847. </member>
  4848. <member name="P:NPOI.DDF.EscherPictBlip.CompressedSize">
  4849. <summary>
  4850. Gets or sets the size of the compressed.
  4851. </summary>
  4852. <value>The size of the compressed.</value>
  4853. </member>
  4854. <member name="P:NPOI.DDF.EscherPictBlip.IsCompressed">
  4855. <summary>
  4856. Gets a value indicating whether this instance is compressed.
  4857. </summary>
  4858. <value>
  4859. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  4860. </value>
  4861. </member>
  4862. <member name="T:NPOI.DDF.EscherProperties">
  4863. <summary>
  4864. Provides a list of all known escher properties including the description and
  4865. type.
  4866. @author Glen Stampoultzis (glens at apache.org)
  4867. </summary>
  4868. </member>
  4869. <member name="M:NPOI.DDF.EscherProperties.InitProps">
  4870. <summary>
  4871. Inits the props.
  4872. </summary>
  4873. </member>
  4874. <member name="M:NPOI.DDF.EscherProperties.AddProp(System.Int32,NPOI.DDF.EscherPropertyMetaData)">
  4875. <summary>
  4876. Adds the prop.
  4877. </summary>
  4878. <param name="s">The s.</param>
  4879. <param name="data">The data.</param>
  4880. </member>
  4881. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String,System.Byte)">
  4882. <summary>
  4883. Gets the data.
  4884. </summary>
  4885. <param name="propName">Name of the prop.</param>
  4886. <param name="type">The type.</param>
  4887. <returns></returns>
  4888. </member>
  4889. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String)">
  4890. <summary>
  4891. Gets the data.
  4892. </summary>
  4893. <param name="propName">Name of the prop.</param>
  4894. <returns></returns>
  4895. </member>
  4896. <member name="M:NPOI.DDF.EscherProperties.GetPropertyName(System.Int16)">
  4897. <summary>
  4898. Gets the name of the property.
  4899. </summary>
  4900. <param name="propertyId">The property id.</param>
  4901. <returns></returns>
  4902. </member>
  4903. <member name="M:NPOI.DDF.EscherProperties.GetPropertyType(System.Int16)">
  4904. <summary>
  4905. Gets the type of the property.
  4906. </summary>
  4907. <param name="propertyId">The property id.</param>
  4908. <returns></returns>
  4909. </member>
  4910. <member name="T:NPOI.DDF.EscherPropertyFactory">
  4911. <summary>
  4912. Generates a property given a reference into the byte array storing that property.
  4913. @author Glen Stampoultzis
  4914. </summary>
  4915. </member>
  4916. <member name="M:NPOI.DDF.EscherPropertyFactory.CreateProperties(System.Byte[],System.Int32,System.Int16)">
  4917. <summary>
  4918. Create new properties from a byte array.
  4919. </summary>
  4920. <param name="data">The byte array containing the property</param>
  4921. <param name="offset">The starting offset into the byte array</param>
  4922. <param name="numProperties">The new properties</param>
  4923. <returns></returns>
  4924. </member>
  4925. <member name="T:NPOI.DDF.EscherPropertyMetaData">
  4926. <summary>
  4927. This class stores the type and description of an escher property.
  4928. @author Glen Stampoultzis (glens at apache.org)
  4929. </summary>
  4930. </member>
  4931. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String)">
  4932. <summary>
  4933. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  4934. </summary>
  4935. <param name="description">The description of the escher property.</param>
  4936. </member>
  4937. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String,System.Byte)">
  4938. <summary>
  4939. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  4940. </summary>
  4941. <param name="description">The description of the escher property.</param>
  4942. <param name="type">The type of the property.</param>
  4943. </member>
  4944. <member name="P:NPOI.DDF.EscherPropertyMetaData.Description">
  4945. <summary>
  4946. Gets the description.
  4947. </summary>
  4948. <value>The description.</value>
  4949. </member>
  4950. <member name="P:NPOI.DDF.EscherPropertyMetaData.Type">
  4951. <summary>
  4952. Gets the type.
  4953. </summary>
  4954. <value>The type.</value>
  4955. </member>
  4956. <member name="T:NPOI.DDF.EscherRGBProperty">
  4957. <summary>
  4958. A color property.
  4959. @author Glen Stampoultzis (glens at apache.org)
  4960. </summary>
  4961. </member>
  4962. <member name="M:NPOI.DDF.EscherRGBProperty.#ctor(System.Int16,System.Int32)">
  4963. <summary>
  4964. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRGBProperty"/> class.
  4965. </summary>
  4966. <param name="propertyNumber">The property number.</param>
  4967. <param name="rgbColor">Color of the RGB.</param>
  4968. </member>
  4969. <member name="P:NPOI.DDF.EscherRGBProperty.RgbColor">
  4970. <summary>
  4971. Gets the color of the RGB.
  4972. </summary>
  4973. <value>The color of the RGB.</value>
  4974. </member>
  4975. <member name="P:NPOI.DDF.EscherRGBProperty.Red">
  4976. <summary>
  4977. Gets the red.
  4978. </summary>
  4979. <value>The red.</value>
  4980. </member>
  4981. <member name="P:NPOI.DDF.EscherRGBProperty.Green">
  4982. <summary>
  4983. Gets the green.
  4984. </summary>
  4985. <value>The green.</value>
  4986. </member>
  4987. <member name="P:NPOI.DDF.EscherRGBProperty.Blue">
  4988. <summary>
  4989. Gets the blue.
  4990. </summary>
  4991. <value>The blue.</value>
  4992. </member>
  4993. <member name="T:NPOI.DDF.EscherSerializationListener">
  4994. Interface for listening to escher serialization events.
  4995. @author Glen Stampoultzis (glens at apache.org)
  4996. </member>
  4997. <member name="M:NPOI.DDF.EscherSerializationListener.BeforeRecordSerialize(System.Int32,System.Int16,NPOI.DDF.EscherRecord)">
  4998. Fired before a given escher record is Serialized.
  4999. @param offset The position in the data array at which the record will be Serialized.
  5000. @param recordId The id of the record about to be Serialized.
  5001. </member>
  5002. <member name="M:NPOI.DDF.EscherSerializationListener.AfterRecordSerialize(System.Int32,System.Int16,System.Int32,NPOI.DDF.EscherRecord)">
  5003. Fired after a record has been Serialized.
  5004. @param offset The position of the end of the Serialized record + 1
  5005. @param recordId The id of the record about to be Serialized
  5006. @param size The number of bytes written for this record. If it is a container
  5007. record then this will include the size of any included records.
  5008. </member>
  5009. <member name="T:NPOI.DDF.EscherShapePathProperty">
  5010. <summary>
  5011. Defines the constants for the various possible shape paths.
  5012. @author Glen Stampoultzis (glens at apache.org)
  5013. </summary>
  5014. </member>
  5015. <member name="M:NPOI.DDF.EscherShapePathProperty.#ctor(System.Int16,System.Int32)">
  5016. <summary>
  5017. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherShapePathProperty"/> class.
  5018. </summary>
  5019. <param name="propertyNumber">The property number.</param>
  5020. <param name="shapePath">The shape path.</param>
  5021. </member>
  5022. <member name="T:NPOI.DDF.EscherSpgrRecord">
  5023. <summary>
  5024. The spgr record defines information about a shape group. Groups in escher
  5025. are simply another form of shape that you can't physically see.
  5026. @author Glen Stampoultzis (glens at apache.org)
  5027. </summary>
  5028. </member>
  5029. <member name="M:NPOI.DDF.EscherSpgrRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5030. <summary>
  5031. This method deSerializes the record from a byte array.
  5032. </summary>
  5033. <param name="data">The byte array containing the escher record information</param>
  5034. <param name="offset">The starting offset into data</param>
  5035. <param name="recordFactory">May be null since this is not a container record.</param>
  5036. <returns>The number of bytes Read from the byte array.</returns>
  5037. </member>
  5038. <member name="M:NPOI.DDF.EscherSpgrRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5039. <summary>
  5040. This method Serializes this escher record into a byte array
  5041. </summary>
  5042. <param name="offset">The offset into data
  5043. to start writing the record data to.</param>
  5044. <param name="data">The byte array to Serialize to.</param>
  5045. <param name="listener">a listener for begin and end serialization events.</param>
  5046. <returns>The number of bytes written.</returns>
  5047. </member>
  5048. <member name="M:NPOI.DDF.EscherSpgrRecord.ToString">
  5049. <summary>
  5050. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5051. </summary>
  5052. <returns>
  5053. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5054. </returns>
  5055. </member>
  5056. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordSize">
  5057. <summary>
  5058. Returns the number of bytes that are required to Serialize this record.
  5059. </summary>
  5060. <value>Number of bytes</value>
  5061. </member>
  5062. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordId">
  5063. <summary>
  5064. Return the current record id.
  5065. </summary>
  5066. <value>The 16 bit identifier of this shape group record.</value>
  5067. </member>
  5068. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordName">
  5069. <summary>
  5070. The short name for this record
  5071. </summary>
  5072. <value></value>
  5073. </member>
  5074. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX1">
  5075. <summary>
  5076. Gets or sets the starting top-left coordinate of child records.
  5077. </summary>
  5078. <value>The rect x1.</value>
  5079. </member>
  5080. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX2">
  5081. <summary>
  5082. Gets or sets the starting bottom-right coordinate of child records.
  5083. </summary>
  5084. <value>The rect x2.</value>
  5085. </member>
  5086. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY1">
  5087. <summary>
  5088. Gets or sets the starting top-left coordinate of child records.
  5089. </summary>
  5090. <value>The rect y1.</value>
  5091. </member>
  5092. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY2">
  5093. <summary>
  5094. Gets or sets the starting bottom-right coordinate of child records.
  5095. </summary>
  5096. <value>The rect y2.</value>
  5097. </member>
  5098. <member name="T:NPOI.DDF.EscherSplitMenuColorsRecord">
  5099. <summary>
  5100. A list of the most recently used colours for the drawings contained in
  5101. this document.
  5102. @author Glen Stampoultzis (glens at apache.org)
  5103. </summary>
  5104. </member>
  5105. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5106. <summary>
  5107. This method deSerializes the record from a byte array.
  5108. </summary>
  5109. <param name="data">The byte array containing the escher record information</param>
  5110. <param name="offset">The starting offset into data</param>
  5111. <param name="recordFactory">May be null since this is not a container record.</param>
  5112. <returns>The number of bytes Read from the byte array.</returns>
  5113. </member>
  5114. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5115. <summary>
  5116. This method Serializes this escher record into a byte array
  5117. </summary>
  5118. <param name="offset">The offset into data
  5119. to start writing the record data to.</param>
  5120. <param name="data">The byte array to Serialize to.</param>
  5121. <param name="listener">a listener for begin and end serialization events.</param>
  5122. <returns>The number of bytes written.</returns>
  5123. </member>
  5124. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.ToString">
  5125. <summary>
  5126. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5127. </summary>
  5128. <returns>
  5129. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5130. </returns>
  5131. @return a string representation of this record.
  5132. </member>
  5133. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordSize">
  5134. <summary>
  5135. Returns the number of bytes that are required to Serialize this record.
  5136. </summary>
  5137. <value>number of bytes</value>
  5138. </member>
  5139. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordId">
  5140. <summary>
  5141. Return the current record id.
  5142. </summary>
  5143. <value>the 16 bit identifer for this record.</value>
  5144. </member>
  5145. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordName">
  5146. <summary>
  5147. Gets the short name for this record
  5148. </summary>
  5149. <value>The name of the record.</value>
  5150. </member>
  5151. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color1">
  5152. <summary>
  5153. Gets or sets the color1.
  5154. </summary>
  5155. <value>The color1.</value>
  5156. </member>
  5157. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color2">
  5158. <summary>
  5159. Gets or sets the color2.
  5160. </summary>
  5161. <value>The color2.</value>
  5162. </member>
  5163. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color3">
  5164. <summary>
  5165. Gets or sets the color3.
  5166. </summary>
  5167. <value>The color3.</value>
  5168. </member>
  5169. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color4">
  5170. <summary>
  5171. Gets or sets the color4.
  5172. </summary>
  5173. <value>The color4.</value>
  5174. </member>
  5175. <member name="T:NPOI.DDF.EscherSpRecord">
  5176. <summary>
  5177. ToGether the the EscherOptRecord this record defines some of the basic
  5178. properties of a shape.
  5179. @author Glen Stampoultzis (glens at apache.org)
  5180. </summary>
  5181. </member>
  5182. <member name="M:NPOI.DDF.EscherSpRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5183. <summary>
  5184. The contract of this method is to deSerialize an escher record including
  5185. it's children.
  5186. </summary>
  5187. <param name="data">The byte array containing the Serialized escher
  5188. records.</param>
  5189. <param name="offset">The offset into the byte array.</param>
  5190. <param name="recordFactory">A factory for creating new escher records</param>
  5191. <returns>The number of bytes written.</returns>
  5192. </member>
  5193. <member name="M:NPOI.DDF.EscherSpRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5194. <summary>
  5195. Serializes to an existing byte array without serialization listener.
  5196. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  5197. </summary>
  5198. <param name="offset">the offset within the data byte array.</param>
  5199. <param name="data"> the data array to Serialize to.</param>
  5200. <param name="listener">a listener for begin and end serialization events.</param>
  5201. <returns>The number of bytes written.</returns>
  5202. </member>
  5203. <member name="M:NPOI.DDF.EscherSpRecord.ToString">
  5204. <summary>
  5205. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5206. </summary>
  5207. <returns>
  5208. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5209. </returns>
  5210. </member>
  5211. <member name="M:NPOI.DDF.EscherSpRecord.DecodeFlags(System.Int32)">
  5212. <summary>
  5213. Converts the shape flags into a more descriptive name.
  5214. </summary>
  5215. <param name="flags">The flags.</param>
  5216. <returns></returns>
  5217. </member>
  5218. <member name="P:NPOI.DDF.EscherSpRecord.RecordSize">
  5219. <summary>
  5220. Returns the number of bytes that are required to Serialize this record.
  5221. </summary>
  5222. <value>Number of bytes</value>
  5223. </member>
  5224. <member name="P:NPOI.DDF.EscherSpRecord.RecordId">
  5225. <summary>
  5226. @return the 16 bit identifier for this record.
  5227. </summary>
  5228. <value></value>
  5229. </member>
  5230. <member name="P:NPOI.DDF.EscherSpRecord.RecordName">
  5231. <summary>
  5232. The short name for this record
  5233. </summary>
  5234. <value></value>
  5235. </member>
  5236. <member name="P:NPOI.DDF.EscherSpRecord.ShapeId">
  5237. <summary>
  5238. Gets or sets A number that identifies this shape
  5239. </summary>
  5240. <value>The shape id.</value>
  5241. </member>
  5242. <member name="P:NPOI.DDF.EscherSpRecord.Flags">
  5243. <summary>
  5244. The flags that apply to this shape.
  5245. </summary>
  5246. <value>The flags.</value>
  5247. </member>
  5248. <member name="P:NPOI.DDF.EscherSpRecord.ShapeType">
  5249. <summary>
  5250. Get or set shape type. Must be one of MSOSPT values (see [MS-ODRAW] for details).
  5251. </summary>
  5252. </member>
  5253. <member name="T:NPOI.DDF.EscherTextboxRecord">
  5254. <summary>
  5255. Holds data from the parent application. Most commonly used to store
  5256. text in the format of the parent application, rather than in
  5257. Escher format. We don't attempt to understand the contents, since
  5258. they will be in the parent's format, not Escher format.
  5259. @author Glen Stampoultzis (glens at apache.org)
  5260. @author Nick Burch (nick at torchbox dot com)
  5261. </summary>
  5262. </member>
  5263. <member name="F:NPOI.DDF.EscherTextboxRecord._thedata">
  5264. The data for this record not including the the 8 byte header
  5265. </member>
  5266. <member name="M:NPOI.DDF.EscherTextboxRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5267. This method deserializes the record from a byte array.
  5268. @param data The byte array containing the escher record information
  5269. @param offset The starting offset into <c>data</c>.
  5270. @param recordFactory May be null since this is not a container record.
  5271. @return The number of bytes Read from the byte array.
  5272. </member>
  5273. <member name="M:NPOI.DDF.EscherTextboxRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5274. <summary>
  5275. Writes this record and any contained records to the supplied byte
  5276. </summary>
  5277. <param name="offset"></param>
  5278. <param name="data"></param>
  5279. <param name="listener">a listener for begin and end serialization events.</param>
  5280. <returns>the number of bytes written.</returns>
  5281. </member>
  5282. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[],System.Int32,System.Int32)">
  5283. <summary>
  5284. Sets the extra data (in the parent application's format) to be
  5285. contained by the record. Used when the parent application changes
  5286. the contents.
  5287. </summary>
  5288. <param name="b">The b.</param>
  5289. <param name="start">The start.</param>
  5290. <param name="length">The length.</param>
  5291. </member>
  5292. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[])">
  5293. <summary>
  5294. Sets the data.
  5295. </summary>
  5296. <param name="b">The b.</param>
  5297. </member>
  5298. <member name="M:NPOI.DDF.EscherTextboxRecord.ToString">
  5299. <summary>
  5300. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5301. </summary>
  5302. <returns>
  5303. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5304. </returns>
  5305. </member>
  5306. <member name="P:NPOI.DDF.EscherTextboxRecord.Data">
  5307. <summary>
  5308. Returns any extra data associated with this record. In practice excel
  5309. does not seem to put anything here, but with PowerPoint this will
  5310. contain the bytes that make up a TextHeaderAtom followed by a
  5311. TextBytesAtom/TextCharsAtom
  5312. </summary>
  5313. <value>The data.</value>
  5314. </member>
  5315. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordSize">
  5316. <summary>
  5317. Returns the number of bytes that are required to serialize this record.
  5318. </summary>
  5319. <value>Number of bytes</value>
  5320. </member>
  5321. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordName">
  5322. <summary>
  5323. The short name for this record
  5324. </summary>
  5325. <value></value>
  5326. </member>
  5327. <member name="T:NPOI.DDF.UnknownEscherRecord">
  5328. <summary>
  5329. This record is used whenever a escher record is encountered that
  5330. we do not explicitly support.
  5331. @author Glen Stampoultzis (glens at apache.org)
  5332. </summary>
  5333. </member>
  5334. <member name="F:NPOI.DDF.UnknownEscherRecord._thedata">
  5335. The data for this record not including the the 8 byte header
  5336. </member>
  5337. <member name="M:NPOI.DDF.UnknownEscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  5338. <summary>
  5339. This method deSerializes the record from a byte array.
  5340. </summary>
  5341. <param name="data"> The byte array containing the escher record information</param>
  5342. <param name="offset">The starting offset into data </param>
  5343. <param name="recordFactory">May be null since this is not a container record.</param>
  5344. <returns>The number of bytes Read from the byte array.</returns>
  5345. </member>
  5346. <member name="M:NPOI.DDF.UnknownEscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  5347. <summary>
  5348. Writes this record and any contained records to the supplied byte
  5349. array.
  5350. </summary>
  5351. <param name="offset"></param>
  5352. <param name="data"></param>
  5353. <param name="listener">a listener for begin and end serialization events.</param>
  5354. <returns>the number of bytes written.</returns>
  5355. </member>
  5356. <member name="M:NPOI.DDF.UnknownEscherRecord.ToString">
  5357. <summary>
  5358. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5359. </summary>
  5360. <returns>
  5361. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5362. </returns>
  5363. </member>
  5364. <member name="M:NPOI.DDF.UnknownEscherRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  5365. <summary>
  5366. Adds the child record.
  5367. </summary>
  5368. <param name="childRecord">The child record.</param>
  5369. </member>
  5370. <member name="P:NPOI.DDF.UnknownEscherRecord.Data">
  5371. <summary>
  5372. Gets the data.
  5373. </summary>
  5374. <value>The data.</value>
  5375. </member>
  5376. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordSize">
  5377. <summary>
  5378. Returns the number of bytes that are required to Serialize this record.
  5379. </summary>
  5380. <value>Number of bytes</value>
  5381. </member>
  5382. <member name="P:NPOI.DDF.UnknownEscherRecord.ChildRecords">
  5383. <summary>
  5384. Returns the children of this record. By default this will
  5385. be an empty list. EscherCotainerRecord is the only record
  5386. that may contain children.
  5387. </summary>
  5388. <value></value>
  5389. </member>
  5390. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordName">
  5391. <summary>
  5392. The short name for this record
  5393. </summary>
  5394. <value></value>
  5395. </member>
  5396. <member name="T:NPOI.HPSF.Constants">
  5397. <summary>
  5398. Defines constants of general use.
  5399. @author Rainer Klute klute@rainer-klute.de
  5400. @since 2004-06-20
  5401. </summary>
  5402. </member>
  5403. <member name="F:NPOI.HPSF.Constants.None">
  5404. <summary>
  5405. Allow accessing the Initial value.
  5406. </summary>
  5407. </member>
  5408. <member name="F:NPOI.HPSF.Constants.CP_037">
  5409. Codepage 037, a special case
  5410. </member>
  5411. <member name="F:NPOI.HPSF.Constants.CP_SJIS">
  5412. Codepage for SJIS
  5413. </member>
  5414. <member name="F:NPOI.HPSF.Constants.CP_GBK">
  5415. Codepage for GBK, aka MS936
  5416. </member>
  5417. <member name="F:NPOI.HPSF.Constants.CP_MS949">
  5418. Codepage for MS949
  5419. </member>
  5420. <member name="F:NPOI.HPSF.Constants.CP_UTF16">
  5421. Codepage for UTF-16
  5422. </member>
  5423. <member name="F:NPOI.HPSF.Constants.CP_UTF16_BE">
  5424. Codepage for UTF-16 big-endian
  5425. </member>
  5426. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1250">
  5427. Codepage for Windows 1250
  5428. </member>
  5429. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1251">
  5430. Codepage for Windows 1251
  5431. </member>
  5432. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1252">
  5433. Codepage for Windows 1252
  5434. </member>
  5435. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1253">
  5436. Codepage for Windows 1253
  5437. </member>
  5438. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1254">
  5439. Codepage for Windows 1254
  5440. </member>
  5441. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1255">
  5442. Codepage for Windows 1255
  5443. </member>
  5444. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1256">
  5445. Codepage for Windows 1256
  5446. </member>
  5447. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1257">
  5448. Codepage for Windows 1257
  5449. </member>
  5450. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1258">
  5451. Codepage for Windows 1258
  5452. </member>
  5453. <member name="F:NPOI.HPSF.Constants.CP_JOHAB">
  5454. Codepage for Johab
  5455. </member>
  5456. <member name="F:NPOI.HPSF.Constants.CP_MAC_ROMAN">
  5457. Codepage for Macintosh Roman (Java: MacRoman)
  5458. </member>
  5459. <member name="F:NPOI.HPSF.Constants.CP_MAC_JAPAN">
  5460. Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  5461. cp943)
  5462. </member>
  5463. <member name="F:NPOI.HPSF.Constants.CP_MAC_CHINESE_TRADITIONAL">
  5464. Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  5465. MS950, or cp937)
  5466. </member>
  5467. <member name="F:NPOI.HPSF.Constants.CP_MAC_KOREAN">
  5468. Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  5469. cp949)
  5470. </member>
  5471. <member name="F:NPOI.HPSF.Constants.CP_MAC_ARABIC">
  5472. Codepage for Macintosh Arabic (Java: MacArabic)
  5473. </member>
  5474. <member name="F:NPOI.HPSF.Constants.CP_MAC_HEBREW">
  5475. Codepage for Macintosh Hebrew (Java: MacHebrew)
  5476. </member>
  5477. <member name="F:NPOI.HPSF.Constants.CP_MAC_GREEK">
  5478. Codepage for Macintosh Greek (Java: MacGreek)
  5479. </member>
  5480. <member name="F:NPOI.HPSF.Constants.CP_MAC_CYRILLIC">
  5481. Codepage for Macintosh Cyrillic (Java: MacCyrillic)
  5482. </member>
  5483. <member name="F:NPOI.HPSF.Constants.CP_MAC_CHINESE_SIMPLE">
  5484. Codepage for Macintosh Chinese Simplified (Java: unknown - use
  5485. EUC_CN, ISO2022_CN_GB, MS936 or cp935)
  5486. </member>
  5487. <member name="F:NPOI.HPSF.Constants.CP_MAC_ROMANIA">
  5488. Codepage for Macintosh Romanian (Java: MacRomania)
  5489. </member>
  5490. <member name="F:NPOI.HPSF.Constants.CP_MAC_UKRAINE">
  5491. Codepage for Macintosh Ukrainian (Java: MacUkraine)
  5492. </member>
  5493. <member name="F:NPOI.HPSF.Constants.CP_MAC_THAI">
  5494. Codepage for Macintosh Thai (Java: MacThai)
  5495. </member>
  5496. <member name="F:NPOI.HPSF.Constants.CP_MAC_CENTRAL_EUROPE">
  5497. Codepage for Macintosh Central Europe (Latin-2)
  5498. (Java: MacCentralEurope)
  5499. </member>
  5500. <member name="F:NPOI.HPSF.Constants.CP_MAC_ICELAND">
  5501. Codepage for Macintosh Iceland (Java: MacIceland)
  5502. </member>
  5503. <member name="F:NPOI.HPSF.Constants.CP_MAC_TURKISH">
  5504. Codepage for Macintosh Turkish (Java: MacTurkish)
  5505. </member>
  5506. <member name="F:NPOI.HPSF.Constants.CP_MAC_CROATIAN">
  5507. Codepage for Macintosh Croatian (Java: MacCroatian)
  5508. </member>
  5509. <member name="F:NPOI.HPSF.Constants.CP_US_ACSII">
  5510. Codepage for US-ASCII
  5511. </member>
  5512. <member name="F:NPOI.HPSF.Constants.CP_KOI8_R">
  5513. Codepage for KOI8-R
  5514. </member>
  5515. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_1">
  5516. Codepage for ISO-8859-1
  5517. </member>
  5518. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_2">
  5519. Codepage for ISO-8859-2
  5520. </member>
  5521. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_3">
  5522. Codepage for ISO-8859-3
  5523. </member>
  5524. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_4">
  5525. Codepage for ISO-8859-4
  5526. </member>
  5527. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_5">
  5528. Codepage for ISO-8859-5
  5529. </member>
  5530. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_6">
  5531. Codepage for ISO-8859-6
  5532. </member>
  5533. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_7">
  5534. Codepage for ISO-8859-7
  5535. </member>
  5536. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_8">
  5537. Codepage for ISO-8859-8
  5538. </member>
  5539. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_9">
  5540. Codepage for ISO-8859-9
  5541. </member>
  5542. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP1">
  5543. Codepage for ISO-2022-JP
  5544. </member>
  5545. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP2">
  5546. Another codepage for ISO-2022-JP
  5547. </member>
  5548. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP3">
  5549. Yet another codepage for ISO-2022-JP
  5550. </member>
  5551. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_KR">
  5552. Codepage for ISO-2022-KR
  5553. </member>
  5554. <member name="F:NPOI.HPSF.Constants.CP_EUC_JP">
  5555. Codepage for EUC-JP
  5556. </member>
  5557. <member name="F:NPOI.HPSF.Constants.CP_EUC_KR">
  5558. Codepage for EUC-KR
  5559. </member>
  5560. <member name="F:NPOI.HPSF.Constants.CP_GB2312">
  5561. Codepage for GB2312
  5562. </member>
  5563. <member name="F:NPOI.HPSF.Constants.CP_GB18030">
  5564. Codepage for GB18030
  5565. </member>
  5566. <member name="F:NPOI.HPSF.Constants.CP_US_ASCII2">
  5567. Another codepage for US-ASCII
  5568. </member>
  5569. <member name="F:NPOI.HPSF.Constants.CP_UTF8">
  5570. Codepage for UTF-8
  5571. </member>
  5572. <member name="F:NPOI.HPSF.Constants.CP_UNICODE">
  5573. Codepage for Unicode
  5574. </member>
  5575. <member name="T:NPOI.HPSF.CustomProperties">
  5576. <summary>
  5577. Maintains the instances of {@link CustomProperty} that belong To a
  5578. {@link DocumentSummaryInformation}. The class maintains the names of the
  5579. custom properties in a dictionary. It implements the {@link Map} interface
  5580. and by this provides a simplified view on custom properties: A property's
  5581. name is the key that maps To a typed value. This implementation hides
  5582. property IDs from the developer and regards the property names as keys To
  5583. typed values.
  5584. While this class provides a simple API To custom properties, it ignores
  5585. the fact that not names, but IDs are the real keys To properties. Under the
  5586. hood this class maintains a 1:1 relationship between IDs and names. Therefore
  5587. you should not use this class To process property Sets with several IDs
  5588. mapping To the same name or with properties without a name: the result will
  5589. contain only a subSet of the original properties. If you really need To deal
  5590. such property Sets, use HPSF's low-level access methods.
  5591. An application can call the {@link #isPure} method To check whether a
  5592. property Set parsed by {@link CustomProperties} is still pure (i.e.
  5593. unmodified) or whether one or more properties have been dropped.
  5594. This class is not thRead-safe; concurrent access To instances of this
  5595. class must be syncronized.
  5596. @author Rainer Klute
  5597. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5598. @since 2006-02-09
  5599. </summary>
  5600. </member>
  5601. <member name="F:NPOI.HPSF.CustomProperties.dictionaryIDToName">
  5602. Maps property IDs To property names.
  5603. </member>
  5604. <member name="F:NPOI.HPSF.CustomProperties.dictionaryNameToID">
  5605. Maps property names To property IDs.
  5606. </member>
  5607. <member name="F:NPOI.HPSF.CustomProperties.isPure">
  5608. Tells whether this object is pure or not.
  5609. </member>
  5610. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,NPOI.HPSF.CustomProperty)">
  5611. <summary>
  5612. Puts a {@link CustomProperty} into this map. It is assumed that the
  5613. {@link CustomProperty} alReady has a valid ID. Otherwise use
  5614. {@link #Put(CustomProperty)}.
  5615. </summary>
  5616. <param name="name">The name.</param>
  5617. <param name="cp">The custom property.</param>
  5618. <returns></returns>
  5619. </member>
  5620. <member name="M:NPOI.HPSF.CustomProperties.KeySet">
  5621. Returns a set of all the names of our
  5622. custom properties. Equivalent to
  5623. {@link #nameSet()}
  5624. </member>
  5625. <member name="M:NPOI.HPSF.CustomProperties.NameSet">
  5626. Returns a set of all the names of our
  5627. custom properties
  5628. </member>
  5629. <member name="M:NPOI.HPSF.CustomProperties.IdSet">
  5630. Returns a set of all the IDs of our
  5631. custom properties
  5632. </member>
  5633. <member name="M:NPOI.HPSF.CustomProperties.Put(NPOI.HPSF.CustomProperty)">
  5634. <summary>
  5635. Puts a {@link CustomProperty} that has not yet a valid ID into this
  5636. map. The method will allocate a suitable ID for the custom property:
  5637. <ul>
  5638. <li>If there is alReady a property with the same name, take the ID
  5639. of that property.</li>
  5640. <li>Otherwise Find the highest ID and use its value plus one.</li>
  5641. </ul>
  5642. </summary>
  5643. <param name="customProperty">The custom property.</param>
  5644. <returns>If the was alReady a property with the same name, the</returns>
  5645. </member>
  5646. <member name="M:NPOI.HPSF.CustomProperties.Remove(System.String)">
  5647. <summary>
  5648. Removes a custom property.
  5649. </summary>
  5650. <param name="name">The name of the custom property To Remove</param>
  5651. <returns>The Removed property or
  5652. <c>null</c>
  5653. if the specified property was not found.</returns>
  5654. </member>
  5655. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.String)">
  5656. <summary>
  5657. Adds a named string property.
  5658. </summary>
  5659. <param name="name">The property's name.</param>
  5660. <param name="value">The property's value.</param>
  5661. <returns>the property that was stored under the specified name before, or
  5662. <c>null</c>
  5663. if there was no such property before.</returns>
  5664. </member>
  5665. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int64)">
  5666. <summary>
  5667. Adds a named long property
  5668. </summary>
  5669. <param name="name">The property's name.</param>
  5670. <param name="value">The property's value.</param>
  5671. <returns>the property that was stored under the specified name before, or
  5672. <c>null</c>
  5673. if there was no such property before.</returns>
  5674. </member>
  5675. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Double)">
  5676. <summary>
  5677. Adds a named double property.
  5678. </summary>
  5679. <param name="name">The property's name.</param>
  5680. <param name="value">The property's value.</param>
  5681. <returns>the property that was stored under the specified name before, or
  5682. <c>null</c>
  5683. if there was no such property before.</returns>
  5684. </member>
  5685. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int32)">
  5686. <summary>
  5687. Adds a named integer property.
  5688. </summary>
  5689. <param name="name">The property's name.</param>
  5690. <param name="value">The property's value.</param>
  5691. <returns>the property that was stored under the specified name before, or
  5692. <c>null</c>
  5693. if there was no such property before.</returns>
  5694. </member>
  5695. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Boolean)">
  5696. <summary>
  5697. Adds a named bool property.
  5698. </summary>
  5699. <param name="name">The property's name.</param>
  5700. <param name="value">The property's value.</param>
  5701. <returns>the property that was stored under the specified name before, or
  5702. <c>null</c>
  5703. if there was no such property before.</returns>
  5704. </member>
  5705. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.DateTime)">
  5706. <summary>
  5707. Adds a named date property.
  5708. </summary>
  5709. <param name="name">The property's name.</param>
  5710. <param name="value">The property's value.</param>
  5711. <returns>the property that was stored under the specified name before, or
  5712. <c>null</c>
  5713. if there was no such property before.</returns>
  5714. </member>
  5715. <member name="M:NPOI.HPSF.CustomProperties.ContainsKey(System.Object)">
  5716. Checks against both String Name and Long ID
  5717. </member>
  5718. <member name="M:NPOI.HPSF.CustomProperties.ContainsValue(System.Object)">
  5719. Checks against both the property, and its values.
  5720. </member>
  5721. <member name="P:NPOI.HPSF.CustomProperties.Item(System.String)">
  5722. <summary>
  5723. Gets the <see cref="T:System.Object"/> with the specified name.
  5724. </summary>
  5725. <value>the value or
  5726. <c>null</c>
  5727. if a value with the specified
  5728. name is not found in the custom properties.</value>
  5729. </member>
  5730. <member name="P:NPOI.HPSF.CustomProperties.Dictionary">
  5731. <summary>
  5732. Gets the dictionary which Contains IDs and names of the named custom
  5733. properties.
  5734. </summary>
  5735. <value>The dictionary.</value>
  5736. </member>
  5737. <member name="P:NPOI.HPSF.CustomProperties.Codepage">
  5738. <summary>
  5739. Gets or sets the codepage.
  5740. </summary>
  5741. <value>The codepage.</value>
  5742. </member>
  5743. <member name="P:NPOI.HPSF.CustomProperties.IsPure">
  5744. <summary>
  5745. Tells whether this {@link CustomProperties} instance is pure or one or
  5746. more properties of the underlying low-level property Set has been
  5747. dropped.
  5748. </summary>
  5749. <value><c>true</c> if this instance is pure; otherwise, <c>false</c>.</value>
  5750. </member>
  5751. <member name="T:NPOI.HPSF.CustomProperty">
  5752. <summary>
  5753. This class represents custum properties in the document summary
  5754. information stream. The difference To normal properties is that custom
  5755. properties have an optional name. If the name is not <c>null</c> it
  5756. will be maintained in the section's dictionary.
  5757. @author Rainer Klute
  5758. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5759. @since 2006-02-09
  5760. </summary>
  5761. </member>
  5762. <member name="T:NPOI.HPSF.MutableProperty">
  5763. <summary>
  5764. Adds writing capability To the {@link Property} class.
  5765. Please be aware that this class' functionality will be merged into the
  5766. {@link Property} class at a later time, so the API will Change.
  5767. @author Rainer Klute
  5768. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5769. @since 2003-08-03
  5770. </summary>
  5771. </member>
  5772. <member name="T:NPOI.HPSF.Property">
  5773. <summary>
  5774. A property in a {@link Section} of a {@link PropertySet}.
  5775. The property's ID gives the property a meaning
  5776. in the context of its {@link Section}. Each {@link Section} spans
  5777. its own name space of property IDs.
  5778. The property's type determines how its
  5779. value is interpreted. For example, if the type Is
  5780. {@link Variant#VT_LPSTR} (byte string), the value consists of a
  5781. DWord telling how many bytes the string Contains. The bytes follow
  5782. immediately, including any null bytes that terminate the
  5783. string. The type {@link Variant#VT_I4} denotes a four-byte integer
  5784. value, {@link Variant#VT_FILETIME} some DateTime and time (of a
  5785. file).
  5786. Please note that not all {@link Variant} types yet. This might Change
  5787. over time but largely depends on your feedback so that the POI team knows
  5788. which variant types are really needed. So please feel free To submit error
  5789. reports or patches for the types you need.
  5790. Microsoft documentation:
  5791. <a href="http://msdn.microsoft.com/library/en-us/stg/stg/property_Set_display_name_dictionary.asp?frame=true">
  5792. Property Set Display Name Dictionary</a>
  5793. .
  5794. @author Rainer Klute
  5795. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5796. @author Drew Varner (Drew.Varner InAndAround sc.edu)
  5797. @see Section
  5798. @see Variant
  5799. @since 2002-02-09
  5800. </summary>
  5801. </member>
  5802. <member name="F:NPOI.HPSF.Property.id">
  5803. The property's ID.
  5804. </member>
  5805. <member name="F:NPOI.HPSF.Property.type">
  5806. The property's type.
  5807. </member>
  5808. <member name="F:NPOI.HPSF.Property.value">
  5809. The property's value.
  5810. </member>
  5811. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Int64,System.Object)">
  5812. <summary>
  5813. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  5814. </summary>
  5815. <param name="id">the property's ID.</param>
  5816. <param name="type">the property's type, see {@link Variant}.</param>
  5817. <param name="value">the property's value. Only certain types are allowed, see
  5818. {@link Variant}.</param>
  5819. </member>
  5820. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Byte[],System.Int64,System.Int32,System.Int32)">
  5821. <summary>
  5822. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  5823. </summary>
  5824. <param name="id">The property's ID.</param>
  5825. <param name="src">The bytes the property Set stream consists of.</param>
  5826. <param name="offset">The property's type/value pair's offset in the
  5827. section.</param>
  5828. <param name="Length">The property's type/value pair's Length in bytes.</param>
  5829. <param name="codepage">The section's and thus the property's
  5830. codepage. It is needed only when Reading string values</param>
  5831. </member>
  5832. <member name="M:NPOI.HPSF.Property.#ctor">
  5833. <summary>
  5834. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  5835. </summary>
  5836. </member>
  5837. <member name="M:NPOI.HPSF.Property.ReadDictionary(System.Byte[],System.Int64,System.Int32,System.Int32)">
  5838. <summary>
  5839. Reads the dictionary.
  5840. </summary>
  5841. <param name="src">The byte array containing the bytes making out the dictionary.</param>
  5842. <param name="offset">At this offset within src the dictionary starts.</param>
  5843. <param name="Length">The dictionary Contains at most this many bytes.</param>
  5844. <param name="codepage">The codepage of the string values.</param>
  5845. <returns>The dictonary</returns>
  5846. </member>
  5847. <member name="M:NPOI.HPSF.Property.Equals(System.Object)">
  5848. <summary>
  5849. Compares two properties.
  5850. Please beware that a property with
  5851. ID == 0 is a special case: It does not have a type, and its value is the
  5852. section's dictionary. Another special case are strings: Two properties
  5853. may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;
  5854. </summary>
  5855. <param name="o">The o.</param>
  5856. <returns></returns>
  5857. </member>
  5858. <member name="M:NPOI.HPSF.Property.TypesAreEqual(System.Int64,System.Int64)">
  5859. <summary>
  5860. Typeses the are equal.
  5861. </summary>
  5862. <param name="t1">The t1.</param>
  5863. <param name="t2">The t2.</param>
  5864. <returns></returns>
  5865. </member>
  5866. <member name="M:NPOI.HPSF.Property.GetHashCode">
  5867. <summary>
  5868. Serves as a hash function for a particular type.
  5869. </summary>
  5870. <returns>
  5871. A hash code for the current <see cref="T:System.Object"/>.
  5872. </returns>
  5873. </member>
  5874. <member name="M:NPOI.HPSF.Property.ToString">
  5875. <summary>
  5876. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5877. </summary>
  5878. <returns>
  5879. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  5880. </returns>
  5881. </member>
  5882. <member name="P:NPOI.HPSF.Property.ID">
  5883. Returns the property's ID.
  5884. @return The ID value
  5885. </member>
  5886. <member name="P:NPOI.HPSF.Property.Type">
  5887. Returns the property's type.
  5888. @return The type value
  5889. </member>
  5890. <member name="P:NPOI.HPSF.Property.Value">
  5891. <summary>
  5892. Gets the property's value.
  5893. </summary>
  5894. <value>The property's value</value>
  5895. </member>
  5896. <member name="P:NPOI.HPSF.Property.Count">
  5897. <summary>
  5898. Gets the property's size in bytes. This is always a multiple of
  5899. 4.
  5900. </summary>
  5901. <value>the property's size in bytes</value>
  5902. </member>
  5903. <member name="M:NPOI.HPSF.MutableProperty.#ctor">
  5904. <summary>
  5905. Creates an empty property. It must be Filled using the Set method To
  5906. be usable.
  5907. </summary>
  5908. </member>
  5909. <member name="M:NPOI.HPSF.MutableProperty.#ctor(NPOI.HPSF.Property)">
  5910. <summary>
  5911. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableProperty"/> class.
  5912. </summary>
  5913. <param name="p">The property To copy.</param>
  5914. </member>
  5915. <member name="M:NPOI.HPSF.MutableProperty.Write(System.IO.Stream,System.Int32)">
  5916. <summary>
  5917. Writes the property To an output stream.
  5918. </summary>
  5919. <param name="out1">The output stream To Write To.</param>
  5920. <param name="codepage">The codepage To use for writing non-wide strings</param>
  5921. <returns>the number of bytes written To the stream</returns>
  5922. </member>
  5923. <member name="M:NPOI.HPSF.CustomProperty.#ctor">
  5924. <summary>
  5925. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  5926. </summary>
  5927. </member>
  5928. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property)">
  5929. <summary>
  5930. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  5931. </summary>
  5932. <param name="property">the property To copy</param>
  5933. </member>
  5934. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property,System.String)">
  5935. <summary>
  5936. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  5937. </summary>
  5938. <param name="property">This property's attributes are copied To the new custom
  5939. property.</param>
  5940. <param name="name">The new custom property's name.</param>
  5941. </member>
  5942. <member name="M:NPOI.HPSF.CustomProperty.EqualsContents(System.Object)">
  5943. <summary>
  5944. Compares two custom properties for equality. The method returns
  5945. <c>true</c> if all attributes of the two custom properties are
  5946. equal.
  5947. </summary>
  5948. <param name="o">The custom property To Compare with.</param>
  5949. <returns><c>true</c>
  5950. if both custom properties are equal, else
  5951. <c>false</c></returns>
  5952. </member>
  5953. <member name="M:NPOI.HPSF.CustomProperty.GetHashCode">
  5954. <summary>
  5955. </summary>
  5956. <returns></returns>
  5957. @see Object#GetHashCode()
  5958. </member>
  5959. <member name="P:NPOI.HPSF.CustomProperty.Name">
  5960. <summary>
  5961. Gets or sets the property's name.
  5962. </summary>
  5963. <value>the property's name.</value>
  5964. </member>
  5965. <member name="T:NPOI.HPSF.DocumentSummaryInformation">
  5966. <summary>
  5967. Convenience class representing a DocumentSummary Information stream in a
  5968. Microsoft Office document.
  5969. @author Rainer Klute
  5970. klute@rainer-klute.de
  5971. @author Drew Varner (Drew.Varner cloSeto sc.edu)
  5972. @author robert_flaherty@hyperion.com
  5973. @since 2002-02-09
  5974. </summary>
  5975. </member>
  5976. <member name="T:NPOI.HPSF.SpecialPropertySet">
  5977. <summary>
  5978. Abstract superclass for the convenience classes {@link
  5979. SummaryInformation} and {@link DocumentSummaryInformation}.
  5980. The motivation behind this class is quite nasty if you look
  5981. behind the scenes, but it serves the application programmer well by
  5982. providing him with the easy-to-use {@link SummaryInformation} and
  5983. {@link DocumentSummaryInformation} classes. When parsing the data a
  5984. property Set stream consists of (possibly coming from an {@link
  5985. java.io.Stream}) we want To Read and process each byte only
  5986. once. Since we don't know in advance which kind of property Set we
  5987. have, we can expect only the most general {@link
  5988. PropertySet}. Creating a special subclass should be as easy as
  5989. calling the special subclass' constructor and pass the general
  5990. {@link PropertySet} in. To make things easy internally, the special
  5991. class just holds a reference To the general {@link PropertySet} and
  5992. delegates all method calls To it.
  5993. A cleaner implementation would have been like this: The {@link
  5994. PropertySetFactory} parses the stream data into some internal
  5995. object first. Then it Finds out whether the stream is a {@link
  5996. SummaryInformation}, a {@link DocumentSummaryInformation} or a
  5997. general {@link PropertySet}. However, the current implementation
  5998. went the other way round historically: the convenience classes came
  5999. only late To my mind.
  6000. @author Rainer Klute
  6001. klute@rainer-klute.de
  6002. @since 2002-02-09
  6003. </summary>
  6004. </member>
  6005. <member name="T:NPOI.HPSF.MutablePropertySet">
  6006. <summary>
  6007. Adds writing support To the {@link PropertySet} class.
  6008. Please be aware that this class' functionality will be merged into the
  6009. {@link PropertySet} class at a later time, so the API will Change.
  6010. @author Rainer Klute
  6011. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  6012. @since 2003-02-19
  6013. </summary>
  6014. </member>
  6015. <member name="T:NPOI.HPSF.PropertySet">
  6016. <summary>
  6017. Represents a property Set in the Horrible Property Set Format
  6018. (HPSF). These are usually metadata of a Microsoft Office
  6019. document.
  6020. An application that wants To access these metadata should Create
  6021. an instance of this class or one of its subclasses by calling the
  6022. factory method {@link PropertySetFactory#Create} and then retrieve
  6023. the information its needs by calling appropriate methods.
  6024. {@link PropertySetFactory#Create} does its work by calling one
  6025. of the constructors {@link PropertySet#PropertySet(InputStream)} or
  6026. {@link PropertySet#PropertySet(byte[])}. If the constructor's
  6027. argument is not in the Horrible Property Set Format, i.e. not a
  6028. property Set stream, or if any other error occurs, an appropriate
  6029. exception is thrown.
  6030. A {@link PropertySet} has a list of {@link Section}s, and each
  6031. {@link Section} has a {@link Property} array. Use {@link
  6032. #GetSections} To retrieve the {@link Section}s, then call {@link
  6033. Section#GetProperties} for each {@link Section} To Get hold of the
  6034. {@link Property} arrays. Since the vast majority of {@link
  6035. PropertySet}s Contains only a single {@link Section}, the
  6036. convenience method {@link #GetProperties} returns the properties of
  6037. a {@link PropertySet}'s {@link Section} (throwing a {@link
  6038. NoSingleSectionException} if the {@link PropertySet} Contains more
  6039. (or less) than exactly one {@link Section}).
  6040. @author Rainer Klute
  6041. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  6042. @author Drew Varner (Drew.Varner hanginIn sc.edu)
  6043. @since 2002-02-09
  6044. </summary>
  6045. </member>
  6046. <member name="F:NPOI.HPSF.PropertySet.OS_WIN16">
  6047. If the OS version field holds this value the property Set stream Was
  6048. Created on a 16-bit Windows system.
  6049. </member>
  6050. <member name="F:NPOI.HPSF.PropertySet.OS_MACINTOSH">
  6051. If the OS version field holds this value the property Set stream Was
  6052. Created on a Macintosh system.
  6053. </member>
  6054. <member name="F:NPOI.HPSF.PropertySet.OS_WIN32">
  6055. If the OS version field holds this value the property Set stream Was
  6056. Created on a 32-bit Windows system.
  6057. </member>
  6058. <member name="F:NPOI.HPSF.PropertySet.BYTE_ORDER_ASSERTION">
  6059. The "byteOrder" field must equal this value.
  6060. </member>
  6061. <member name="F:NPOI.HPSF.PropertySet.byteOrder">
  6062. Specifies this {@link PropertySet}'s byte order. See the
  6063. HPFS documentation for details!
  6064. </member>
  6065. <member name="F:NPOI.HPSF.PropertySet.FORMAT_ASSERTION">
  6066. The "format" field must equal this value.
  6067. </member>
  6068. <member name="F:NPOI.HPSF.PropertySet.format">
  6069. Specifies this {@link PropertySet}'s format. See the HPFS
  6070. documentation for details!
  6071. </member>
  6072. <member name="F:NPOI.HPSF.PropertySet.osVersion">
  6073. Specifies the version of the operating system that Created
  6074. this {@link PropertySet}. See the HPFS documentation for
  6075. details!
  6076. </member>
  6077. <member name="F:NPOI.HPSF.PropertySet.classID">
  6078. Specifies this {@link PropertySet}'s "classID" field. See
  6079. the HPFS documentation for details!
  6080. </member>
  6081. <member name="F:NPOI.HPSF.PropertySet.sections">
  6082. The sections in this {@link PropertySet}.
  6083. </member>
  6084. <member name="M:NPOI.HPSF.PropertySet.#ctor">
  6085. <summary>
  6086. Creates an empty (uninitialized) {@link PropertySet}
  6087. Please note: For the time being this
  6088. constructor is protected since it is used for internal purposes
  6089. only, but expect it To become public once the property Set's
  6090. writing functionality is implemented.
  6091. </summary>
  6092. </member>
  6093. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.IO.Stream)">
  6094. <summary>
  6095. Creates a {@link PropertySet} instance from an {@link
  6096. InputStream} in the Horrible Property Set Format.
  6097. The constructor Reads the first few bytes from the stream
  6098. and determines whether it is really a property Set stream. If
  6099. it Is, it parses the rest of the stream. If it is not, it
  6100. Resets the stream To its beginning in order To let other
  6101. components mess around with the data and throws an
  6102. exception.
  6103. </summary>
  6104. <param name="stream">Holds the data making out the property Set
  6105. stream.</param>
  6106. </member>
  6107. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[],System.Int32,System.Int32)">
  6108. <summary>
  6109. Creates a {@link PropertySet} instance from a byte array
  6110. that represents a stream in the Horrible Property Set
  6111. Format.
  6112. </summary>
  6113. <param name="stream">The byte array holding the stream data.</param>
  6114. <param name="offset">The offset in stream where the stream data begin.
  6115. If the stream data begin with the first byte in the
  6116. array, the offset is 0.</param>
  6117. <param name="Length"> The Length of the stream data.</param>
  6118. </member>
  6119. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[])">
  6120. <summary>
  6121. Creates a {@link PropertySet} instance from a byte array
  6122. that represents a stream in the Horrible Property Set
  6123. Format.
  6124. </summary>
  6125. <param name="stream">The byte array holding the stream data. The
  6126. complete byte array contents is the stream data.</param>
  6127. </member>
  6128. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.IO.Stream)">
  6129. <summary>
  6130. Checks whether an {@link InputStream} is in the Horrible
  6131. Property Set Format.
  6132. </summary>
  6133. <param name="stream">The {@link InputStream} To check. In order To
  6134. perform the check, the method Reads the first bytes from the
  6135. stream. After Reading, the stream is Reset To the position it
  6136. had before Reading. The {@link InputStream} must support the
  6137. {@link InputStream#mark} method.</param>
  6138. <returns>
  6139. <c>true</c> if the stream is a property Set
  6140. stream; otherwise, <c>false</c>.
  6141. </returns>
  6142. </member>
  6143. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.Byte[],System.Int32,System.Int32)">
  6144. <summary>
  6145. Checks whether a byte array is in the Horrible Property Set
  6146. Format.
  6147. </summary>
  6148. <param name="src">The byte array To check.</param>
  6149. <param name="offset">The offset in the byte array.</param>
  6150. <param name="Length">The significant number of bytes in the byte
  6151. array. Only this number of bytes will be checked.</param>
  6152. <returns>
  6153. <c>true</c> if the byte array is a property Set
  6154. stream; otherwise, <c>false</c>.
  6155. </returns>
  6156. </member>
  6157. <member name="M:NPOI.HPSF.PropertySet.init(System.Byte[],System.Int32,System.Int32)">
  6158. <summary>
  6159. Initializes this {@link PropertySet} instance from a byte
  6160. array. The method assumes that it has been checked alReady that
  6161. the byte array indeed represents a property Set stream. It does
  6162. no more checks on its own.
  6163. </summary>
  6164. <param name="src">Byte array containing the property Set stream</param>
  6165. <param name="offset">The property Set stream starts at this offset</param>
  6166. <param name="Length">Length of the property Set stream.</param>
  6167. </member>
  6168. <member name="M:NPOI.HPSF.PropertySet.GetProperty(System.Int32)">
  6169. <summary>
  6170. Convenience method returning the value of the property with
  6171. the specified ID. If the property is not available,
  6172. <c>null</c> is returned and a subsequent call To {@link
  6173. #WasNull} will return <c>true</c> .
  6174. </summary>
  6175. <param name="id">The property ID</param>
  6176. <returns>The property value</returns>
  6177. </member>
  6178. <member name="M:NPOI.HPSF.PropertySet.GetPropertyBooleanValue(System.Int32)">
  6179. <summary>
  6180. Convenience method returning the value of a bool property
  6181. with the specified ID. If the property is not available,
  6182. <c>false</c> is returned. A subsequent call To {@link
  6183. #WasNull} will return <c>true</c> To let the caller
  6184. distinguish that case from a real property value of
  6185. <c>false</c>.
  6186. </summary>
  6187. <param name="id">The property ID</param>
  6188. <returns>The property value</returns>
  6189. </member>
  6190. <member name="M:NPOI.HPSF.PropertySet.GetPropertyIntValue(System.Int32)">
  6191. <summary>
  6192. Convenience method returning the value of the numeric
  6193. property with the specified ID. If the property is not
  6194. available, 0 is returned. A subsequent call To {@link #WasNull}
  6195. will return <c>true</c> To let the caller distinguish
  6196. that case from a real property value of 0.
  6197. </summary>
  6198. <param name="id">The property ID</param>
  6199. <returns>The propertyIntValue value</returns>
  6200. </member>
  6201. <member name="M:NPOI.HPSF.PropertySet.Equals(System.Object)">
  6202. <summary>
  6203. Returns <c>true</c> if the <c>PropertySet</c> is equal
  6204. To the specified parameter, else <c>false</c>.
  6205. </summary>
  6206. <param name="o">the object To Compare this
  6207. <c>PropertySet</c>
  6208. with</param>
  6209. <returns><c>true</c>
  6210. if the objects are equal,
  6211. <c>false</c>
  6212. if not</returns>
  6213. </member>
  6214. <member name="M:NPOI.HPSF.PropertySet.GetHashCode">
  6215. <summary>
  6216. Serves as a hash function for a particular type.
  6217. </summary>
  6218. <returns>
  6219. A hash code for the current <see cref="T:System.Object"/>.
  6220. </returns>
  6221. </member>
  6222. <member name="M:NPOI.HPSF.PropertySet.ToString">
  6223. <summary>
  6224. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6225. </summary>
  6226. <returns>
  6227. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6228. </returns>
  6229. </member>
  6230. <member name="P:NPOI.HPSF.PropertySet.ByteOrder">
  6231. <summary>
  6232. Gets or sets the property Set stream's low-level "byte order"
  6233. field. It is always <c>0xFFFE</c>
  6234. </summary>
  6235. <value>The property Set stream's low-level "byte order" field..</value>
  6236. </member>
  6237. <member name="P:NPOI.HPSF.PropertySet.Format">
  6238. <summary>
  6239. Gets or sets the property Set stream's low-level "format"
  6240. field. It is always <c>0x0000</c>
  6241. </summary>
  6242. <value>The property Set stream's low-level "format" field.</value>
  6243. </member>
  6244. <member name="P:NPOI.HPSF.PropertySet.OSVersion">
  6245. <summary>
  6246. Returns the property Set stream's low-level "OS version"
  6247. field.
  6248. </summary>
  6249. <value>The property Set stream's low-level "OS version" field.</value>
  6250. </member>
  6251. <member name="P:NPOI.HPSF.PropertySet.ClassID">
  6252. <summary>
  6253. Gets or sets the property Set stream's low-level "class ID"
  6254. </summary>
  6255. <value>The property Set stream's low-level "class ID" field.</value>
  6256. </member>
  6257. <member name="P:NPOI.HPSF.PropertySet.SectionCount">
  6258. <summary>
  6259. Returns the number of {@link Section}s in the property
  6260. Set.
  6261. </summary>
  6262. <value>The number of {@link Section}s in the property Set.</value>
  6263. </member>
  6264. <member name="P:NPOI.HPSF.PropertySet.Sections">
  6265. <summary>
  6266. Returns the {@link Section}s in the property Set.
  6267. </summary>
  6268. <value>{@link Section}s in the property Set.</value>
  6269. </member>
  6270. <member name="P:NPOI.HPSF.PropertySet.IsSummaryInformation">
  6271. <summary>
  6272. Checks whether this {@link PropertySet} represents a Summary
  6273. Information.
  6274. </summary>
  6275. <value>
  6276. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  6277. Information; otherwise, <c>false</c>.
  6278. </value>
  6279. </member>
  6280. <member name="P:NPOI.HPSF.PropertySet.IsDocumentSummaryInformation">
  6281. <summary>
  6282. Gets a value indicating whether this instance is document summary information.
  6283. </summary>
  6284. <value>
  6285. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  6286. </value>
  6287. Checks whether this {@link PropertySet} is a Document
  6288. Summary Information.
  6289. @return
  6290. <c>true</c>
  6291. if this {@link PropertySet}
  6292. represents a Document Summary Information, else
  6293. <c>false</c>
  6294. </member>
  6295. <member name="P:NPOI.HPSF.PropertySet.Properties">
  6296. <summary>
  6297. Convenience method returning the {@link Property} array
  6298. contained in this property Set. It is a shortcut for Getting
  6299. the {@link PropertySet}'s {@link Section}s list and then
  6300. Getting the {@link Property} array from the first {@link
  6301. Section}.
  6302. </summary>
  6303. <value>The properties of the only {@link Section} of this
  6304. {@link PropertySet}.</value>
  6305. </member>
  6306. <member name="P:NPOI.HPSF.PropertySet.WasNull">
  6307. <summary>
  6308. Checks whether the property which the last call To {@link
  6309. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  6310. Was available or not. This information might be important for
  6311. callers of {@link #GetPropertyIntValue} since the latter
  6312. returns 0 if the property does not exist. Using {@link
  6313. #WasNull}, the caller can distiguish this case from a
  6314. property's real value of 0.
  6315. </summary>
  6316. <value><c>true</c> if the last call To {@link
  6317. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  6318. property that Was not available; otherwise, <c>false</c>.</value>
  6319. </member>
  6320. <member name="P:NPOI.HPSF.PropertySet.FirstSection">
  6321. <summary>
  6322. Gets the first section.
  6323. </summary>
  6324. <value>The first section.</value>
  6325. </member>
  6326. <member name="P:NPOI.HPSF.PropertySet.SingleSection">
  6327. <summary>
  6328. If the {@link PropertySet} has only a single section this
  6329. method returns it.
  6330. </summary>
  6331. <value>The singleSection value</value>
  6332. </member>
  6333. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor">
  6334. <summary>
  6335. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  6336. Its primary task is To initialize the immutable field with their proper
  6337. values. It also Sets fields that might Change To reasonable defaults.
  6338. </summary>
  6339. </member>
  6340. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor(NPOI.HPSF.PropertySet)">
  6341. <summary>
  6342. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  6343. All nested elements, i.e.<c>Section</c>s and <c>Property</c> instances, will be their
  6344. mutable counterparts in the new <c>MutablePropertySet</c>.
  6345. </summary>
  6346. <param name="ps">The property Set To copy</param>
  6347. </member>
  6348. <member name="F:NPOI.HPSF.MutablePropertySet.OFFSET_HEADER">
  6349. The Length of the property Set stream header.
  6350. </member>
  6351. <member name="M:NPOI.HPSF.MutablePropertySet.ClearSections">
  6352. <summary>
  6353. Removes all sections from this property Set.
  6354. </summary>
  6355. </member>
  6356. <member name="M:NPOI.HPSF.MutablePropertySet.AddSection(NPOI.HPSF.Section)">
  6357. <summary>
  6358. Adds a section To this property Set.
  6359. </summary>
  6360. <param name="section">section The {@link Section} To Add. It will be Appended
  6361. after any sections that are alReady present in the property Set
  6362. and thus become the last section.</param>
  6363. </member>
  6364. <member name="M:NPOI.HPSF.MutablePropertySet.Write(System.IO.Stream)">
  6365. <summary>
  6366. Writes the property Set To an output stream.
  6367. </summary>
  6368. <param name="out1">the output stream To Write the section To</param>
  6369. </member>
  6370. <member name="M:NPOI.HPSF.MutablePropertySet.GetStream">
  6371. <summary>
  6372. Returns the contents of this property Set stream as an input stream.
  6373. The latter can be used for example To Write the property Set into a POIFS
  6374. document. The input stream represents a snapshot of the property Set.
  6375. If the latter is modified while the input stream is still being
  6376. Read, the modifications will not be reflected in the input stream but in
  6377. the {@link MutablePropertySet} only.
  6378. </summary>
  6379. <returns>the contents of this property Set stream</returns>
  6380. </member>
  6381. <member name="M:NPOI.HPSF.MutablePropertySet.ToStream">
  6382. <summary>
  6383. Returns the contents of this property set stream as an input stream.
  6384. The latter can be used for example to write the property set into a POIFS
  6385. document. The input stream represents a snapshot of the property set.
  6386. If the latter is modified while the input stream is still being
  6387. read, the modifications will not be reflected in the input stream but in
  6388. the {@link MutablePropertySet} only.
  6389. </summary>
  6390. <returns>the contents of this property set stream</returns>
  6391. </member>
  6392. <member name="M:NPOI.HPSF.MutablePropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  6393. <summary>
  6394. Writes a property Set To a document in a POI filesystem directory
  6395. </summary>
  6396. <param name="dir">The directory in the POI filesystem To Write the document To.</param>
  6397. <param name="name">The document's name. If there is alReady a document with the
  6398. same name in the directory the latter will be overwritten.</param>
  6399. </member>
  6400. <member name="P:NPOI.HPSF.MutablePropertySet.ByteOrder">
  6401. <summary>
  6402. Gets or sets the "byteOrder" property.
  6403. </summary>
  6404. <value>the byteOrder value To Set</value>
  6405. </member>
  6406. <member name="P:NPOI.HPSF.MutablePropertySet.Format">
  6407. <summary>
  6408. Gets or sets the "format" property.
  6409. </summary>
  6410. <value>the format value To Set</value>
  6411. </member>
  6412. <member name="P:NPOI.HPSF.MutablePropertySet.OSVersion">
  6413. <summary>
  6414. Gets or sets the "osVersion" property
  6415. </summary>
  6416. <value>the osVersion value To Set.</value>
  6417. </member>
  6418. <member name="P:NPOI.HPSF.MutablePropertySet.ClassID">
  6419. <summary>
  6420. Gets or sets the property Set stream's low-level "class ID"
  6421. </summary>
  6422. <value>The property Set stream's low-level "class ID" field.</value>
  6423. </member>
  6424. <member name="F:NPOI.HPSF.SpecialPropertySet.delegate1">
  6425. The "real" property Set <c>SpecialPropertySet</c>
  6426. delegates To.
  6427. </member>
  6428. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.PropertySet)">
  6429. <summary>
  6430. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  6431. </summary>
  6432. <param name="ps">The property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  6433. </member>
  6434. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.MutablePropertySet)">
  6435. <summary>
  6436. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  6437. </summary>
  6438. <param name="ps">The mutable property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  6439. </member>
  6440. <member name="M:NPOI.HPSF.SpecialPropertySet.AddSection(NPOI.HPSF.Section)">
  6441. <summary>
  6442. Adds a section To this property set.
  6443. </summary>
  6444. <param name="section">The {@link Section} To Add. It will be Appended
  6445. after any sections that are alReady present in the property Set
  6446. and thus become the last section.</param>
  6447. </member>
  6448. <member name="M:NPOI.HPSF.SpecialPropertySet.ClearSections">
  6449. <summary>
  6450. Removes all sections from this property Set.
  6451. </summary>
  6452. </member>
  6453. <member name="M:NPOI.HPSF.SpecialPropertySet.GetStream">
  6454. <summary>
  6455. Returns the contents of this property Set stream as an input stream.
  6456. The latter can be used for example To Write the property Set into a POIFS
  6457. document. The input stream represents a snapshot of the property Set.
  6458. If the latter is modified while the input stream is still being
  6459. Read, the modifications will not be reflected in the input stream but in
  6460. the {@link MutablePropertySet} only.
  6461. </summary>
  6462. <returns>the contents of this PropertySet stream</returns>
  6463. </member>
  6464. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  6465. <summary>
  6466. Writes a property Set To a document in a POI filesystem directory.
  6467. </summary>
  6468. <param name="dir">The directory in the POI filesystem To Write the document To</param>
  6469. <param name="name">The document's name. If there is alReady a document with the
  6470. same name in the directory the latter will be overwritten.</param>
  6471. </member>
  6472. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(System.IO.Stream)">
  6473. <summary>
  6474. Writes the property Set To an output stream.
  6475. </summary>
  6476. <param name="out1">the output stream To Write the section To</param>
  6477. </member>
  6478. <member name="M:NPOI.HPSF.SpecialPropertySet.Equals(System.Object)">
  6479. <summary>
  6480. Returns <c>true</c> if the <c>PropertySet</c> is equal
  6481. To the specified parameter, else <c>false</c>.
  6482. </summary>
  6483. <param name="o">the object To Compare this
  6484. <c>PropertySet</c>
  6485. with</param>
  6486. <returns>
  6487. <c>true</c>
  6488. if the objects are equal,
  6489. <c>false</c>
  6490. if not
  6491. </returns>
  6492. </member>
  6493. <member name="M:NPOI.HPSF.SpecialPropertySet.GetProperty(System.Int32)">
  6494. <summary>
  6495. Convenience method returning the value of the property with
  6496. the specified ID. If the property is not available,
  6497. <c>null</c> is returned and a subsequent call To {@link
  6498. #WasNull} will return <c>true</c> .
  6499. </summary>
  6500. <param name="id">The property ID</param>
  6501. <returns>The property value</returns>
  6502. </member>
  6503. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyBooleanValue(System.Int32)">
  6504. <summary>
  6505. Convenience method returning the value of a bool property
  6506. with the specified ID. If the property is not available,
  6507. <c>false</c> is returned. A subsequent call To {@link
  6508. #WasNull} will return <c>true</c> To let the caller
  6509. distinguish that case from a real property value of
  6510. <c>false</c>.
  6511. </summary>
  6512. <param name="id">The property ID</param>
  6513. <returns>The property value</returns>
  6514. </member>
  6515. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyIntValue(System.Int32)">
  6516. <summary>
  6517. Convenience method returning the value of the numeric
  6518. property with the specified ID. If the property is not
  6519. available, 0 is returned. A subsequent call To {@link #WasNull}
  6520. will return <c>true</c> To let the caller distinguish
  6521. that case from a real property value of 0.
  6522. </summary>
  6523. <param name="id">The property ID</param>
  6524. <returns>The propertyIntValue value</returns>
  6525. </member>
  6526. <member name="M:NPOI.HPSF.SpecialPropertySet.GetHashCode">
  6527. <summary>
  6528. Serves as a hash function for a particular type.
  6529. </summary>
  6530. <returns>
  6531. A hash code for the current <see cref="T:System.Object"/>.
  6532. </returns>
  6533. </member>
  6534. <member name="M:NPOI.HPSF.SpecialPropertySet.ToString">
  6535. <summary>
  6536. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6537. </summary>
  6538. <returns>
  6539. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6540. </returns>
  6541. </member>
  6542. <member name="P:NPOI.HPSF.SpecialPropertySet.PropertySetIDMap">
  6543. The id to name mapping of the properties
  6544. in this set.
  6545. </member>
  6546. <member name="P:NPOI.HPSF.SpecialPropertySet.ByteOrder">
  6547. <summary>
  6548. gets or sets the "byteOrder" property.
  6549. </summary>
  6550. <value>the byteOrder value To Set</value>
  6551. </member>
  6552. <member name="P:NPOI.HPSF.SpecialPropertySet.Format">
  6553. <summary>
  6554. gets or sets the "format" property
  6555. </summary>
  6556. <value>the format value To Set</value>
  6557. </member>
  6558. <member name="P:NPOI.HPSF.SpecialPropertySet.ClassID">
  6559. <summary>
  6560. gets or sets the property Set stream's low-level "class ID"
  6561. field.
  6562. </summary>
  6563. <value>The property Set stream's low-level "class ID" field</value>
  6564. </member>
  6565. <member name="P:NPOI.HPSF.SpecialPropertySet.SectionCount">
  6566. <summary>
  6567. Returns the number of {@link Section}s in the property
  6568. Set.
  6569. </summary>
  6570. <value>The number of {@link Section}s in the property Set.</value>
  6571. </member>
  6572. <member name="P:NPOI.HPSF.SpecialPropertySet.IsSummaryInformation">
  6573. <summary>
  6574. Checks whether this {@link PropertySet} represents a Summary
  6575. Information.
  6576. </summary>
  6577. <value>
  6578. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  6579. Information; otherwise, <c>false</c>.
  6580. </value>
  6581. </member>
  6582. <member name="P:NPOI.HPSF.SpecialPropertySet.IsDocumentSummaryInformation">
  6583. <summary>
  6584. Gets a value indicating whether this instance is document summary information.
  6585. </summary>
  6586. <value>
  6587. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  6588. </value>
  6589. Checks whether this {@link PropertySet} is a Document
  6590. Summary Information.
  6591. @return
  6592. <c>true</c>
  6593. if this {@link PropertySet}
  6594. represents a Document Summary Information, else
  6595. <c>false</c>
  6596. </member>
  6597. <member name="P:NPOI.HPSF.SpecialPropertySet.FirstSection">
  6598. <summary>
  6599. Gets the PropertySet's first section.
  6600. </summary>
  6601. <value>The {@link PropertySet}'s first section.</value>
  6602. </member>
  6603. <member name="P:NPOI.HPSF.SpecialPropertySet.OSVersion">
  6604. <summary>
  6605. gets or sets the "osVersion" property
  6606. </summary>
  6607. <value> the osVersion value To Set</value>
  6608. </member>
  6609. <member name="P:NPOI.HPSF.SpecialPropertySet.Properties">
  6610. <summary>
  6611. Convenience method returning the {@link Property} array
  6612. contained in this property Set. It is a shortcut for Getting
  6613. the {@link PropertySet}'s {@link Section}s list and then
  6614. Getting the {@link Property} array from the first {@link
  6615. Section}.
  6616. </summary>
  6617. <value>
  6618. The properties of the only {@link Section} of this
  6619. {@link PropertySet}.
  6620. </value>
  6621. </member>
  6622. <member name="P:NPOI.HPSF.SpecialPropertySet.WasNull">
  6623. <summary>
  6624. Checks whether the property which the last call To {@link
  6625. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  6626. Was available or not. This information might be important for
  6627. callers of {@link #GetPropertyIntValue} since the latter
  6628. returns 0 if the property does not exist. Using {@link
  6629. #WasNull}, the caller can distiguish this case from a
  6630. property's real value of 0.
  6631. </summary>
  6632. <value>
  6633. <c>true</c> if the last call To {@link
  6634. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  6635. property that Was not available; otherwise, <c>false</c>.
  6636. </value>
  6637. </member>
  6638. <member name="F:NPOI.HPSF.DocumentSummaryInformation.DEFAULT_STREAM_NAME">
  6639. The document name a document summary information stream
  6640. usually has in a POIFS filesystem.
  6641. </member>
  6642. <member name="M:NPOI.HPSF.DocumentSummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  6643. <summary>
  6644. Initializes a new instance of the <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> class.
  6645. </summary>
  6646. <param name="ps">A property Set which should be Created from a
  6647. document summary information stream.</param>
  6648. </member>
  6649. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCategory">
  6650. <summary>
  6651. Removes the category.
  6652. </summary>
  6653. </member>
  6654. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemovePresentationFormat">
  6655. <summary>
  6656. Removes the presentation format.
  6657. </summary>
  6658. </member>
  6659. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveByteCount">
  6660. <summary>
  6661. Removes the byte count.
  6662. </summary>
  6663. </member>
  6664. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLineCount">
  6665. <summary>
  6666. Removes the line count.
  6667. </summary>
  6668. </member>
  6669. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveParCount">
  6670. <summary>
  6671. Removes the par count.
  6672. </summary>
  6673. </member>
  6674. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveSlideCount">
  6675. <summary>
  6676. Removes the slide count.
  6677. </summary>
  6678. </member>
  6679. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveNoteCount">
  6680. <summary>
  6681. Removes the note count.
  6682. </summary>
  6683. </member>
  6684. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHiddenCount">
  6685. <summary>
  6686. Removes the hidden count.
  6687. </summary>
  6688. </member>
  6689. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveMMClipCount">
  6690. <summary>
  6691. Removes the MMClip count.
  6692. </summary>
  6693. </member>
  6694. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveScale">
  6695. <summary>
  6696. Removes the scale.
  6697. </summary>
  6698. </member>
  6699. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHeadingPair">
  6700. <summary>
  6701. Removes the heading pair.
  6702. </summary>
  6703. </member>
  6704. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocparts">
  6705. <summary>
  6706. Removes the doc parts.
  6707. </summary>
  6708. </member>
  6709. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveManager">
  6710. <summary>
  6711. Removes the manager.
  6712. </summary>
  6713. </member>
  6714. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCompany">
  6715. <summary>
  6716. Removes the company.
  6717. </summary>
  6718. </member>
  6719. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLinksDirty">
  6720. <summary>
  6721. Removes the links dirty.
  6722. </summary>
  6723. </member>
  6724. <member name="M:NPOI.HPSF.DocumentSummaryInformation.EnsureSection2">
  6725. <summary>
  6726. Creates section 2 if it is not alReady present.
  6727. </summary>
  6728. </member>
  6729. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCustomProperties">
  6730. <summary>
  6731. Removes the custom properties.
  6732. </summary>
  6733. </member>
  6734. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Category">
  6735. <summary>
  6736. Gets or sets the category.
  6737. </summary>
  6738. <value>The category value</value>
  6739. </member>
  6740. <member name="P:NPOI.HPSF.DocumentSummaryInformation.PresentationFormat">
  6741. <summary>
  6742. Gets or sets the presentation format (or null).
  6743. </summary>
  6744. <value>The presentation format value</value>
  6745. </member>
  6746. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ByteCount">
  6747. <summary>
  6748. Gets or sets the byte count or 0 if the {@link
  6749. DocumentSummaryInformation} does not contain a byte count.
  6750. </summary>
  6751. <value>The byteCount value</value>
  6752. </member>
  6753. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LineCount">
  6754. <summary>
  6755. Gets or sets the line count or 0 if the {@link
  6756. DocumentSummaryInformation} does not contain a line count.
  6757. </summary>
  6758. <value>The line count value.</value>
  6759. </member>
  6760. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ParCount">
  6761. <summary>
  6762. Gets or sets the par count or 0 if the {@link
  6763. DocumentSummaryInformation} does not contain a par count.
  6764. </summary>
  6765. <value>The par count value</value>
  6766. </member>
  6767. <member name="P:NPOI.HPSF.DocumentSummaryInformation.SlideCount">
  6768. <summary>
  6769. Gets or sets the slide count or 0 if the {@link
  6770. DocumentSummaryInformation} does not contain a slide count.
  6771. </summary>
  6772. <value>The slide count value</value>
  6773. </member>
  6774. <member name="P:NPOI.HPSF.DocumentSummaryInformation.NoteCount">
  6775. <summary>
  6776. Gets or sets the note count or 0 if the {@link
  6777. DocumentSummaryInformation} does not contain a note count
  6778. </summary>
  6779. <value>The note count value</value>
  6780. </member>
  6781. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HiddenCount">
  6782. <summary>
  6783. Gets or sets the hidden count or 0 if the {@link
  6784. DocumentSummaryInformation} does not contain a hidden
  6785. count.
  6786. </summary>
  6787. <value>The hidden count value.</value>
  6788. </member>
  6789. <member name="P:NPOI.HPSF.DocumentSummaryInformation.MMClipCount">
  6790. <summary>
  6791. Returns the mmclip count or 0 if the {@link
  6792. DocumentSummaryInformation} does not contain a mmclip
  6793. count.
  6794. </summary>
  6795. <value>The mmclip count value.</value>
  6796. </member>
  6797. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Scale">
  6798. <summary>
  6799. Gets or sets a value indicating whether this <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> is scale.
  6800. </summary>
  6801. <value><c>true</c> if cropping is desired; otherwise, <c>false</c>.</value>
  6802. </member>
  6803. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HeadingPair">
  6804. <summary>
  6805. Gets or sets the heading pair (or null)
  6806. </summary>
  6807. <value>The heading pair value.</value>
  6808. </member>
  6809. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Docparts">
  6810. <summary>
  6811. Gets or sets the doc parts.
  6812. </summary>
  6813. <value>The doc parts value</value>
  6814. </member>
  6815. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Manager">
  6816. <summary>
  6817. Gets or sets the manager (or <c>null</c>).
  6818. </summary>
  6819. <value>The manager value</value>
  6820. </member>
  6821. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Company">
  6822. <summary>
  6823. Gets or sets the company (or <c>null</c>).
  6824. </summary>
  6825. <value>The company value</value>
  6826. </member>
  6827. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LinksDirty">
  6828. <summary>
  6829. Gets or sets a value indicating whether [links dirty].
  6830. </summary>
  6831. <value><c>true</c> if the custom links are dirty.; otherwise, <c>false</c>.</value>
  6832. </member>
  6833. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CustomProperties">
  6834. <summary>
  6835. Gets or sets the custom properties.
  6836. </summary>
  6837. <value>The custom properties.</value>
  6838. </member>
  6839. <member name="T:NPOI.HPSF.Extractor.HPSFPropertiesExtractor">
  6840. <summary>
  6841. Extracts all of the HPSF properties, both
  6842. build in and custom, returning them in
  6843. textual form.
  6844. </summary>
  6845. </member>
  6846. <member name="T:NPOI.POITextExtractor">
  6847. <summary>
  6848. Common Parent for Text Extractors
  6849. of POI Documents.
  6850. You will typically find the implementation of
  6851. a given format's text extractor under
  6852. org.apache.poi.[format].extractor .
  6853. </summary>
  6854. @see org.apache.poi.hssf.extractor.ExcelExtractor
  6855. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  6856. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  6857. @see org.apache.poi.hwpf.extractor.WordExtractor
  6858. </member>
  6859. <member name="F:NPOI.POITextExtractor.document">
  6860. The POIDocument that's open
  6861. </member>
  6862. <member name="M:NPOI.POITextExtractor.#ctor(NPOI.POIDocument)">
  6863. <summary>
  6864. Creates a new text extractor for the given document
  6865. </summary>
  6866. <param name="document">The document.</param>
  6867. </member>
  6868. <member name="M:NPOI.POITextExtractor.#ctor(NPOI.POITextExtractor)">
  6869. <summary>
  6870. Creates a new text extractor, using the same
  6871. document as another text extractor. Normally
  6872. only used by properties extractors.
  6873. </summary>
  6874. <param name="otherExtractor">The other extractor.</param>
  6875. </member>
  6876. <member name="P:NPOI.POITextExtractor.Text">
  6877. <summary>
  6878. Retrieves all the text from the document.
  6879. How cells, paragraphs etc are separated in the text
  6880. is implementation specific - see the javadocs for
  6881. a specific project for details.
  6882. </summary>
  6883. <value>All the text from the document.</value>
  6884. </member>
  6885. <member name="P:NPOI.POITextExtractor.MetadataTextExtractor">
  6886. <summary>
  6887. Returns another text extractor, which is able to
  6888. output the textual content of the document
  6889. metadata / properties, such as author and title.
  6890. </summary>
  6891. <value>The metadata text extractor.</value>
  6892. </member>
  6893. <member name="M:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.GetPropertiesText(NPOI.HPSF.SpecialPropertySet)">
  6894. <summary>
  6895. Gets the properties text.
  6896. </summary>
  6897. <param name="ps">The ps.</param>
  6898. <returns></returns>
  6899. </member>
  6900. <member name="M:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.GetPropertyValueText(System.Object)">
  6901. <summary>
  6902. Gets the property value text.
  6903. </summary>
  6904. <param name="val">The val.</param>
  6905. <returns></returns>
  6906. </member>
  6907. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.DocumentSummaryInformationText">
  6908. <summary>
  6909. Gets the document summary information text.
  6910. </summary>
  6911. <value>The document summary information text.</value>
  6912. </member>
  6913. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.SummaryInformationText">
  6914. <summary>
  6915. Gets the summary information text.
  6916. </summary>
  6917. <value>The summary information text.</value>
  6918. </member>
  6919. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.Text">
  6920. <summary>
  6921. Return the text of all the properties defined in
  6922. the document.
  6923. </summary>
  6924. <value>All the text from the document.</value>
  6925. </member>
  6926. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.MetadataTextExtractor">
  6927. <summary>
  6928. Returns another text extractor, which is able to
  6929. output the textual content of the document
  6930. metadata / properties, such as author and title.
  6931. </summary>
  6932. <value>The metadata text extractor.</value>
  6933. </member>
  6934. <member name="T:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.PropertiesOnlyDocument">
  6935. <summary>
  6936. So we can get at the properties of any
  6937. random OLE2 document.
  6938. </summary>
  6939. </member>
  6940. <member name="T:NPOI.POIDocument">
  6941. <summary>
  6942. This holds the common functionality for all POI
  6943. Document classes.
  6944. Currently, this relates to Document Information Properties
  6945. </summary>
  6946. <remarks>@author Nick Burch</remarks>
  6947. </member>
  6948. <member name="F:NPOI.POIDocument.sInf">
  6949. Holds metadata on our document
  6950. </member>
  6951. <member name="F:NPOI.POIDocument.dsInf">
  6952. Holds further metadata on our document
  6953. </member>
  6954. <member name="F:NPOI.POIDocument.directory">
  6955. The directory that our document lives in
  6956. </member>
  6957. <member name="F:NPOI.POIDocument.initialized">
  6958. For our own logging use
  6959. </member>
  6960. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6961. <summary>
  6962. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  6963. </summary>
  6964. <param name="dir">The dir.</param>
  6965. <param name="fs">The fs.</param>
  6966. </member>
  6967. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6968. <summary>
  6969. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  6970. </summary>
  6971. <param name="fs">The fs.</param>
  6972. </member>
  6973. <member name="M:NPOI.POIDocument.CreateInformationProperties">
  6974. Will create whichever of SummaryInformation
  6975. and DocumentSummaryInformation (HPSF) properties
  6976. are not already part of your document.
  6977. This is normally useful when creating a new
  6978. document from scratch.
  6979. If the information properties are already there,
  6980. then nothing will happen.
  6981. </member>
  6982. <member name="M:NPOI.POIDocument.ReadProperties">
  6983. <summary>
  6984. Find, and Create objects for, the standard
  6985. Documment Information Properties (HPSF).
  6986. If a given property Set is missing or corrupt,
  6987. it will remain null;
  6988. </summary>
  6989. </member>
  6990. <member name="M:NPOI.POIDocument.GetPropertySet(System.String)">
  6991. <summary>
  6992. For a given named property entry, either return it or null if
  6993. if it wasn't found
  6994. </summary>
  6995. <param name="setName">Name of the set.</param>
  6996. <returns></returns>
  6997. </member>
  6998. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6999. <summary>
  7000. Writes out the standard Documment Information Properties (HPSF)
  7001. </summary>
  7002. <param name="outFS">the POIFSFileSystem to Write the properties into</param>
  7003. </member>
  7004. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.IList)">
  7005. <summary>
  7006. Writes out the standard Documment Information Properties (HPSF)
  7007. </summary>
  7008. <param name="outFS">the POIFSFileSystem to Write the properties into.</param>
  7009. <param name="writtenEntries">a list of POIFS entries to Add the property names too.</param>
  7010. </member>
  7011. <member name="M:NPOI.POIDocument.WritePropertySet(System.String,NPOI.HPSF.PropertySet,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  7012. <summary>
  7013. Writes out a given ProperySet
  7014. </summary>
  7015. <param name="name">the (POIFS Level) name of the property to Write.</param>
  7016. <param name="Set">the PropertySet to Write out.</param>
  7017. <param name="outFS">the POIFSFileSystem to Write the property into.</param>
  7018. </member>
  7019. <member name="M:NPOI.POIDocument.Write(System.IO.Stream)">
  7020. <summary>
  7021. Writes the document out to the specified output stream
  7022. </summary>
  7023. <param name="out1">The out1.</param>
  7024. </member>
  7025. <member name="M:NPOI.POIDocument.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  7026. <summary>
  7027. Copies nodes from one POIFS to the other minus the excepts
  7028. </summary>
  7029. <param name="source">the source POIFS to copy from.</param>
  7030. <param name="target">the target POIFS to copy to</param>
  7031. <param name="excepts">a list of Strings specifying what nodes NOT to copy</param>
  7032. </member>
  7033. <member name="M:NPOI.POIDocument.CopyNodes(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.DirectoryNode,System.Collections.Generic.List{System.String})">
  7034. <summary>
  7035. Copies nodes from one POIFS to the other minus the excepts
  7036. </summary>
  7037. <param name="sourceRoot">the source POIFS to copy from.</param>
  7038. <param name="targetRoot">the target POIFS to copy to</param>
  7039. <param name="excepts">a list of Strings specifying what nodes NOT to copy</param>
  7040. </member>
  7041. <member name="M:NPOI.POIDocument.isInList(System.String,System.Collections.IList)">
  7042. <summary>
  7043. Checks to see if the String is in the list, used when copying
  7044. nodes between one POIFS and another
  7045. </summary>
  7046. <param name="entry">The entry.</param>
  7047. <param name="list">The list.</param>
  7048. <returns>
  7049. <c>true</c> if [is in list] [the specified entry]; otherwise, <c>false</c>.
  7050. </returns>
  7051. </member>
  7052. <member name="M:NPOI.POIDocument.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  7053. <summary>
  7054. Copies an Entry into a target POIFS directory, recursively
  7055. </summary>
  7056. <param name="entry">The entry.</param>
  7057. <param name="target">The target.</param>
  7058. </member>
  7059. <member name="P:NPOI.POIDocument.DocumentSummaryInformation">
  7060. <summary>
  7061. Fetch the Document Summary Information of the document
  7062. </summary>
  7063. <value>The document summary information.</value>
  7064. </member>
  7065. <member name="P:NPOI.POIDocument.SummaryInformation">
  7066. <summary>
  7067. Fetch the Summary Information of the document
  7068. </summary>
  7069. <value>The summary information.</value>
  7070. </member>
  7071. <member name="T:NPOI.HPSF.HPSFException">
  7072. <summary>
  7073. This exception is the superclass of all other checked exceptions thrown
  7074. in this package. It supports a nested "reason" throwable, i.e. an exception
  7075. that caused this one To be thrown.
  7076. @author Rainer Klute
  7077. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7078. @since 2002-02-09
  7079. </summary>
  7080. </member>
  7081. <member name="M:NPOI.HPSF.HPSFException.#ctor">
  7082. <summary>
  7083. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  7084. </summary>
  7085. </member>
  7086. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String)">
  7087. <summary>
  7088. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  7089. </summary>
  7090. <param name="msg">The message string.</param>
  7091. </member>
  7092. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.Exception)">
  7093. <summary>
  7094. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  7095. </summary>
  7096. <param name="reason">The reason, i.e. a throwable that indirectly
  7097. caused this exception.</param>
  7098. </member>
  7099. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String,System.Exception)">
  7100. <summary>
  7101. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  7102. </summary>
  7103. <param name="msg">The message string.</param>
  7104. <param name="reason">The reason, i.e. a throwable that indirectly
  7105. caused this exception.</param>
  7106. </member>
  7107. <member name="P:NPOI.HPSF.HPSFException.Reason">
  7108. <summary>
  7109. Returns the {@link Exception} that caused this exception To
  7110. be thrown or null if there was no such {@link
  7111. Exception}.
  7112. </summary>
  7113. <value>The reason.</value>
  7114. </member>
  7115. <member name="T:NPOI.HPSF.HPSFRuntimeException">
  7116. <summary>
  7117. This exception is the superclass of all other unchecked
  7118. exceptions thrown in this package. It supports a nested "reason"
  7119. throwable, i.e. an exception that caused this one To be thrown.
  7120. @author Rainer Klute
  7121. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7122. @since 2002-02-09
  7123. </summary>
  7124. </member>
  7125. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor">
  7126. <summary>
  7127. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  7128. </summary>
  7129. </member>
  7130. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String)">
  7131. <summary>
  7132. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  7133. </summary>
  7134. <param name="msg">The message string.</param>
  7135. </member>
  7136. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.Exception)">
  7137. <summary>
  7138. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  7139. </summary>
  7140. <param name="reason">The reason, i.e. a throwable that indirectly
  7141. caused this exception.</param>
  7142. </member>
  7143. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String,System.Exception)">
  7144. <summary>
  7145. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  7146. </summary>
  7147. <param name="msg">The message string.</param>
  7148. <param name="reason">The reason, i.e. a throwable that indirectly
  7149. caused this exception.</param>
  7150. </member>
  7151. <member name="T:NPOI.HPSF.IllegalPropertySetDataException">
  7152. <summary>
  7153. This exception is thrown when there is an illegal value Set in a
  7154. {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must
  7155. have a value of <c>-1 (true)</c> or <c>0 (false)</c>.
  7156. Any other value would trigger this exception. It supports a nested
  7157. "reason" throwable, i.e. an exception that caused this one To be
  7158. thrown.
  7159. @author Drew Varner(Drew.Varner atDomain sc.edu)
  7160. @since 2002-05-26
  7161. </summary>
  7162. </member>
  7163. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor">
  7164. <summary>
  7165. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  7166. </summary>
  7167. </member>
  7168. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String)">
  7169. <summary>
  7170. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  7171. </summary>
  7172. <param name="msg">The exception's message string</param>
  7173. </member>
  7174. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.Exception)">
  7175. <summary>
  7176. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  7177. </summary>
  7178. <param name="reason">This exception's underlying reason</param>
  7179. </member>
  7180. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String,System.Exception)">
  7181. <summary>
  7182. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  7183. </summary>
  7184. <param name="msg"> The exception's message string</param>
  7185. <param name="reason">This exception's underlying reason</param>
  7186. </member>
  7187. <member name="T:NPOI.HPSF.IllegalVariantTypeException">
  7188. <summary>
  7189. This exception is thrown if HPSF encounters a variant type that is illegal
  7190. in the current context.
  7191. @author Rainer Klute
  7192. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7193. @since 2004-06-21
  7194. </summary>
  7195. </member>
  7196. <member name="T:NPOI.HPSF.VariantTypeException">
  7197. <summary>
  7198. This exception is thrown if HPSF encounters a problem with a variant type.
  7199. Concrete subclasses specifiy the problem further.
  7200. @author Rainer Klute
  7201. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7202. @since 2004-06-21
  7203. </summary>
  7204. </member>
  7205. <member name="M:NPOI.HPSF.VariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  7206. <summary>
  7207. Initializes a new instance of the <see cref="T:NPOI.HPSF.VariantTypeException"/> class.
  7208. </summary>
  7209. <param name="variantType">The variant type causing the problem</param>
  7210. <param name="value">The value who's variant type causes the problem</param>
  7211. <param name="msg">A message text describing the problem</param>
  7212. </member>
  7213. <member name="P:NPOI.HPSF.VariantTypeException.VariantType">
  7214. <summary>
  7215. Gets the offending variant type
  7216. </summary>
  7217. <value>the offending variant type.</value>
  7218. </member>
  7219. <member name="P:NPOI.HPSF.VariantTypeException.Value">
  7220. <summary>
  7221. Returns the value who's variant type caused the problem.
  7222. </summary>
  7223. <value>the value who's variant type caused the problem.</value>
  7224. </member>
  7225. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  7226. <summary>
  7227. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  7228. </summary>
  7229. <param name="variantType">The unsupported variant type</param>
  7230. <param name="value">The value</param>
  7231. <param name="msg">A message string</param>
  7232. </member>
  7233. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object)">
  7234. <summary>
  7235. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  7236. </summary>
  7237. <param name="variantType">The unsupported variant type</param>
  7238. <param name="value">The value.</param>
  7239. </member>
  7240. <member name="T:NPOI.HPSF.MarkUnsupportedException">
  7241. <summary>
  7242. This exception is thrown if an {@link java.io.InputStream} does
  7243. not support the {@link java.io.InputStream#mark} operation.
  7244. @author Rainer Klute
  7245. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7246. @since 2002-02-09
  7247. </summary>
  7248. </member>
  7249. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor">
  7250. <summary>
  7251. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  7252. </summary>
  7253. </member>
  7254. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String)">
  7255. <summary>
  7256. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  7257. </summary>
  7258. <param name="msg">The exception's message string.</param>
  7259. </member>
  7260. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.Exception)">
  7261. <summary>
  7262. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  7263. </summary>
  7264. <param name="reason">This exception's underlying reason.</param>
  7265. </member>
  7266. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String,System.Exception)">
  7267. <summary>
  7268. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  7269. </summary>
  7270. <param name="msg">The exception's message string</param>
  7271. <param name="reason">This exception's underlying reason</param>
  7272. </member>
  7273. <member name="T:NPOI.HPSF.MissingSectionException">
  7274. <summary>
  7275. This exception is thrown if one of the {@link PropertySet}'s
  7276. convenience methods does not Find a required {@link Section}.
  7277. The constructors of this class are analogous To those of its
  7278. superclass and documented there.
  7279. @author Rainer Klute
  7280. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7281. @since 2006-02-08
  7282. </summary>
  7283. </member>
  7284. <member name="M:NPOI.HPSF.MissingSectionException.#ctor">
  7285. <summary>
  7286. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  7287. </summary>
  7288. </member>
  7289. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String)">
  7290. <summary>
  7291. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  7292. </summary>
  7293. <param name="msg">The exception's message string</param>
  7294. </member>
  7295. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.Exception)">
  7296. <summary>
  7297. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  7298. </summary>
  7299. <param name="reason">This exception's underlying reason.</param>
  7300. </member>
  7301. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String,System.Exception)">
  7302. <summary>
  7303. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  7304. </summary>
  7305. <param name="msg">The exception's message string</param>
  7306. <param name="reason">This exception's underlying reason</param>
  7307. </member>
  7308. <member name="T:NPOI.HPSF.MutableSection">
  7309. <summary>
  7310. Adds writing capability To the {@link Section} class.
  7311. Please be aware that this class' functionality will be merged into the
  7312. {@link Section} class at a later time, so the API will Change.
  7313. @since 2002-02-20
  7314. </summary>
  7315. </member>
  7316. <member name="T:NPOI.HPSF.Section">
  7317. <summary>
  7318. Represents a section in a {@link PropertySet}.
  7319. @author Rainer Klute
  7320. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7321. @author Drew Varner (Drew.Varner allUpIn sc.edu)
  7322. @since 2002-02-09
  7323. </summary>
  7324. </member>
  7325. <member name="F:NPOI.HPSF.Section.dictionary">
  7326. Maps property IDs To section-private PID strings. These
  7327. strings can be found in the property with ID 0.
  7328. </member>
  7329. <member name="F:NPOI.HPSF.Section.formatID">
  7330. The section's format ID, {@link #GetFormatID}.
  7331. </member>
  7332. <member name="M:NPOI.HPSF.Section.#ctor">
  7333. <summary>
  7334. Creates an empty and uninitialized {@link Section}.
  7335. </summary>
  7336. </member>
  7337. <member name="M:NPOI.HPSF.Section.#ctor(System.Byte[],System.Int32)">
  7338. <summary>
  7339. Creates a {@link Section} instance from a byte array.
  7340. </summary>
  7341. <param name="src">Contains the complete property Set stream.</param>
  7342. <param name="offset">The position in the stream that points To the
  7343. section's format ID.</param>
  7344. </member>
  7345. <member name="M:NPOI.HPSF.Section.GetProperty(System.Int64)">
  7346. Returns the value of the property with the specified ID. If
  7347. the property is not available, <c>null</c> is returned
  7348. and a subsequent call To {@link #wasNull} will return
  7349. <c>true</c>.
  7350. @param id The property's ID
  7351. @return The property's value
  7352. </member>
  7353. <member name="M:NPOI.HPSF.Section.GetPropertyIntValue(System.Int64)">
  7354. Returns the value of the numeric property with the specified
  7355. ID. If the property is not available, 0 is returned. A
  7356. subsequent call To {@link #wasNull} will return
  7357. <c>true</c> To let the caller distinguish that case from
  7358. a real property value of 0.
  7359. @param id The property's ID
  7360. @return The property's value
  7361. </member>
  7362. <member name="M:NPOI.HPSF.Section.GetPropertyBooleanValue(System.Int32)">
  7363. Returns the value of the bool property with the specified
  7364. ID. If the property is not available, <c>false</c> Is
  7365. returned. A subsequent call To {@link #wasNull} will return
  7366. <c>true</c> To let the caller distinguish that case from
  7367. a real property value of <c>false</c>.
  7368. @param id The property's ID
  7369. @return The property's value
  7370. </member>
  7371. <member name="F:NPOI.HPSF.Section.wasNull">
  7372. This member is <c>true</c> if the last call To {@link
  7373. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  7374. property that was not available, else <c>false</c>.
  7375. </member>
  7376. <member name="M:NPOI.HPSF.Section.GetPIDString(System.Int64)">
  7377. <summary>
  7378. Returns the PID string associated with a property ID. The ID
  7379. is first looked up in the {@link Section}'s private
  7380. dictionary. If it is not found there, the method calls {@link
  7381. SectionIDMap#GetPIDString}.
  7382. </summary>
  7383. <param name="pid">The property ID.</param>
  7384. <returns>The property ID's string value</returns>
  7385. </member>
  7386. <member name="M:NPOI.HPSF.Section.Equals(System.Object)">
  7387. Checks whether this section is equal To another object. The result Is
  7388. <c>false</c> if one of the the following conditions holds:
  7389. <ul>
  7390. <li>The other object is not a {@link Section}.</li>
  7391. <li>The format IDs of the two sections are not equal.</li>
  7392. <li>The sections have a different number of properties. However,
  7393. properties with ID 1 (codepage) are not counted.</li>
  7394. <li>The other object is not a {@link Section}.</li>
  7395. <li>The properties have different values. The order of the properties
  7396. is irrelevant.</li>
  7397. </ul>
  7398. @param o The object To Compare this section with
  7399. @return <c>true</c> if the objects are equal, <c>false</c> if
  7400. not
  7401. </member>
  7402. <member name="M:NPOI.HPSF.Section.Remove(NPOI.HPSF.Property[],System.Int32)">
  7403. <summary>
  7404. Removes a field from a property array. The resulting array Is
  7405. compactified and returned.
  7406. </summary>
  7407. <param name="pa">The property array.</param>
  7408. <param name="i">The index of the field To be Removed.</param>
  7409. <returns>the compactified array.</returns>
  7410. </member>
  7411. <member name="M:NPOI.HPSF.Section.GetHashCode">
  7412. <summary>
  7413. Serves as a hash function for a particular type.
  7414. </summary>
  7415. <returns>
  7416. A hash code for the current <see cref="T:System.Object"/>.
  7417. </returns>
  7418. </member>
  7419. <member name="M:NPOI.HPSF.Section.ToString">
  7420. <summary>
  7421. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7422. </summary>
  7423. <returns>
  7424. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  7425. </returns>
  7426. </member>
  7427. <member name="P:NPOI.HPSF.Section.FormatID">
  7428. <summary>
  7429. Returns the format ID. The format ID is the "type" of the
  7430. section. For example, if the format ID of the first {@link
  7431. Section} Contains the bytes specified by
  7432. <c>org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID</c>
  7433. the section (and thus the property Set) is a SummaryInformation.
  7434. </summary>
  7435. <value>The format ID.</value>
  7436. </member>
  7437. <member name="P:NPOI.HPSF.Section.OffSet">
  7438. <summary>
  7439. Gets the offset of the section in the stream.
  7440. </summary>
  7441. <value>The offset of the section in the stream</value>
  7442. </member>
  7443. <member name="P:NPOI.HPSF.Section.Size">
  7444. <summary>
  7445. Returns the section's size in bytes.
  7446. </summary>
  7447. <value>The section's size in bytes.</value>
  7448. </member>
  7449. <member name="P:NPOI.HPSF.Section.PropertyCount">
  7450. <summary>
  7451. Returns the number of properties in this section.
  7452. </summary>
  7453. <value>The number of properties in this section.</value>
  7454. </member>
  7455. <member name="P:NPOI.HPSF.Section.Properties">
  7456. <summary>
  7457. Returns this section's properties.
  7458. </summary>
  7459. <value>This section's properties.</value>
  7460. </member>
  7461. <member name="P:NPOI.HPSF.Section.WasNull">
  7462. <summary>
  7463. Checks whether the property which the last call To {@link
  7464. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  7465. was available or not. This information might be important for
  7466. callers of {@link #GetPropertyIntValue} since the latter
  7467. returns 0 if the property does not exist. Using {@link
  7468. #wasNull} the caller can distiguish this case from a property's
  7469. real value of 0.
  7470. </summary>
  7471. <value><c>true</c> if the last call To {@link
  7472. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  7473. property that was not available; otherwise, <c>false</c>.</value>
  7474. </member>
  7475. <member name="P:NPOI.HPSF.Section.Dictionary">
  7476. <summary>
  7477. Gets the section's dictionary. A dictionary allows an application To
  7478. use human-Readable property names instead of numeric property IDs. It
  7479. Contains mappings from property IDs To their associated string
  7480. values. The dictionary is stored as the property with ID 0. The codepage
  7481. for the strings in the dictionary is defined by property with ID 1.
  7482. </summary>
  7483. <value>the dictionary or null
  7484. if the section does not have
  7485. a dictionary.</value>
  7486. </member>
  7487. <member name="P:NPOI.HPSF.Section.Codepage">
  7488. <summary>
  7489. Gets the section's codepage, if any.
  7490. </summary>
  7491. <value>The section's codepage if one is defined, else -1.</value>
  7492. </member>
  7493. <member name="T:NPOI.HPSF.Section.PropertyListEntry">
  7494. Represents an entry in the property list and holds a property's ID and
  7495. its offset from the section's beginning.
  7496. </member>
  7497. <member name="M:NPOI.HPSF.Section.PropertyListEntry.CompareTo(System.Object)">
  7498. Compares this {@link PropertyListEntry} with another one by their
  7499. offsets. A {@link PropertyListEntry} is "smaller" than another one if
  7500. its offset from the section's begin is smaller.
  7501. @see Comparable#CompareTo(java.lang.Object)
  7502. </member>
  7503. <member name="F:NPOI.HPSF.MutableSection.dirty">
  7504. If the "dirty" flag is true, the section's size must be
  7505. (re-)calculated before the section is written.
  7506. </member>
  7507. <member name="F:NPOI.HPSF.MutableSection.preprops">
  7508. List To assemble the properties. Unfortunately a wrong
  7509. decision has been taken when specifying the "properties" field
  7510. as an Property[]. It should have been a {@link java.util.List}.
  7511. </member>
  7512. <member name="F:NPOI.HPSF.MutableSection.sectionBytes">
  7513. Contains the bytes making out the section. This byte array is
  7514. established when the section's size is calculated and can be reused
  7515. later. It is valid only if the "dirty" flag is false.
  7516. </member>
  7517. <member name="M:NPOI.HPSF.MutableSection.#ctor">
  7518. <summary>
  7519. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableSection"/> class.
  7520. </summary>
  7521. </member>
  7522. <member name="M:NPOI.HPSF.MutableSection.#ctor(NPOI.HPSF.Section)">
  7523. <summary>
  7524. Constructs a <c>MutableSection</c> by doing a deep copy of an
  7525. existing <c>Section</c>. All nested <c>Property</c>
  7526. instances, will be their mutable counterparts in the new
  7527. <c>MutableSection</c>.
  7528. </summary>
  7529. <param name="s">The section Set To copy</param>
  7530. </member>
  7531. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(NPOI.Util.ClassID)">
  7532. <summary>
  7533. Sets the section's format ID.
  7534. </summary>
  7535. <param name="formatID">The section's format ID</param>
  7536. </member>
  7537. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(System.Byte[])">
  7538. <summary>
  7539. Sets the section's format ID.
  7540. </summary>
  7541. <param name="formatID">The section's format ID as a byte array. It components
  7542. are in big-endian format.</param>
  7543. </member>
  7544. <member name="M:NPOI.HPSF.MutableSection.SetProperties(NPOI.HPSF.Property[])">
  7545. <summary>
  7546. Sets this section's properties. Any former values are overwritten.
  7547. </summary>
  7548. <param name="properties">This section's new properties.</param>
  7549. </member>
  7550. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.String)">
  7551. <summary>
  7552. Sets the string value of the property with the specified ID.
  7553. </summary>
  7554. <param name="id">The property's ID</param>
  7555. <param name="value">The property's value. It will be written as a Unicode
  7556. string.</param>
  7557. </member>
  7558. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int32)">
  7559. <summary>
  7560. Sets the int value of the property with the specified ID.
  7561. </summary>
  7562. <param name="id">The property's ID</param>
  7563. <param name="value">The property's value.</param>
  7564. </member>
  7565. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64)">
  7566. <summary>
  7567. Sets the long value of the property with the specified ID.
  7568. </summary>
  7569. <param name="id">The property's ID</param>
  7570. <param name="value">The property's value.</param>
  7571. </member>
  7572. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Boolean)">
  7573. <summary>
  7574. Sets the bool value of the property with the specified ID.
  7575. </summary>
  7576. <param name="id">The property's ID</param>
  7577. <param name="value">The property's value.</param>
  7578. </member>
  7579. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64,System.Object)">
  7580. <summary>
  7581. Sets the value and the variant type of the property with the
  7582. specified ID. If a property with this ID is not yet present in
  7583. the section, it will be Added. An alReady present property with
  7584. the specified ID will be overwritten. A default mapping will be
  7585. used To choose the property's type.
  7586. </summary>
  7587. <param name="id">The property's ID.</param>
  7588. <param name="variantType">The property's variant type.</param>
  7589. <param name="value">The property's value.</param>
  7590. </member>
  7591. <member name="M:NPOI.HPSF.MutableSection.SetProperty(NPOI.HPSF.Property)">
  7592. <summary>
  7593. Sets the property.
  7594. </summary>
  7595. <param name="p">The property To be Set.</param>
  7596. </member>
  7597. <member name="M:NPOI.HPSF.MutableSection.RemoveProperty(System.Int64)">
  7598. <summary>
  7599. Removes the property.
  7600. </summary>
  7601. <param name="id">The ID of the property To be Removed</param>
  7602. </member>
  7603. <member name="M:NPOI.HPSF.MutableSection.SetPropertyBooleanValue(System.Int32,System.Boolean)">
  7604. <summary>
  7605. Sets the value of the bool property with the specified
  7606. ID.
  7607. </summary>
  7608. <param name="id">The property's ID</param>
  7609. <param name="value">The property's value</param>
  7610. </member>
  7611. <member name="M:NPOI.HPSF.MutableSection.CalcSize">
  7612. <summary>
  7613. Calculates the section's size. It is the sum of the Lengths of the
  7614. section's header (8), the properties list (16 times the number of
  7615. properties) and the properties themselves.
  7616. </summary>
  7617. <returns>the section's Length in bytes.</returns>
  7618. </member>
  7619. <member name="M:NPOI.HPSF.MutableSection.Write(System.IO.Stream)">
  7620. <summary>
  7621. Writes this section into an output stream.
  7622. Internally this is done by writing into three byte array output
  7623. streams: one for the properties, one for the property list and one for
  7624. the section as such. The two former are Appended To the latter when they
  7625. have received all their data.
  7626. </summary>
  7627. <param name="out1">The stream To Write into.</param>
  7628. <returns>The number of bytes written, i.e. the section's size.</returns>
  7629. </member>
  7630. <member name="M:NPOI.HPSF.MutableSection.WriteDictionary(System.IO.Stream,System.Collections.IDictionary,System.Int32)">
  7631. <summary>
  7632. Writes the section's dictionary
  7633. </summary>
  7634. <param name="out1">The output stream To Write To.</param>
  7635. <param name="dictionary">The dictionary.</param>
  7636. <param name="codepage">The codepage to be used to Write the dictionary items.</param>
  7637. <returns>The number of bytes written</returns>
  7638. <remarks>
  7639. see MSDN KB: http://msdn.microsoft.com/en-us/library/aa380065(VS.85).aspx
  7640. </remarks>
  7641. </member>
  7642. <member name="M:NPOI.HPSF.MutableSection.EnsureProperties">
  7643. <summary>
  7644. Ensures the properties.
  7645. </summary>
  7646. </member>
  7647. <member name="M:NPOI.HPSF.MutableSection.GetProperty(System.Int64)">
  7648. <summary>
  7649. Gets a property.
  7650. </summary>
  7651. <param name="id">The ID of the property To Get</param>
  7652. <returns>The property or null if there is no such property</returns>
  7653. </member>
  7654. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Object)">
  7655. <summary>
  7656. Sets the property.
  7657. </summary>
  7658. <param name="id">The property ID.</param>
  7659. <param name="value">The property's value. The value's class must be one of those
  7660. supported by HPSF.</param>
  7661. </member>
  7662. <member name="M:NPOI.HPSF.MutableSection.Clear">
  7663. <summary>
  7664. Removes all properties from the section including 0 (dictionary) and
  7665. 1 (codepage).
  7666. </summary>
  7667. </member>
  7668. <member name="P:NPOI.HPSF.MutableSection.Size">
  7669. <summary>
  7670. Returns the section's size in bytes.
  7671. </summary>
  7672. <value>The section's size in bytes.</value>
  7673. </member>
  7674. <member name="P:NPOI.HPSF.MutableSection.PropertyCount">
  7675. <summary>
  7676. OverWrites the base class' method To cope with a redundancy:
  7677. the property count is maintained in a separate member variable, but
  7678. shouldn't.
  7679. </summary>
  7680. <value>The number of properties in this section.</value>
  7681. </member>
  7682. <member name="P:NPOI.HPSF.MutableSection.Properties">
  7683. <summary>
  7684. Returns this section's properties.
  7685. </summary>
  7686. <value>This section's properties.</value>
  7687. </member>
  7688. <member name="P:NPOI.HPSF.MutableSection.Dictionary">
  7689. <summary>
  7690. Sets the section's dictionary. All keys in the dictionary must be
  7691. {@link java.lang.long} instances, all values must be
  7692. {@link java.lang.String}s. This method overWrites the properties with IDs
  7693. 0 and 1 since they are reserved for the dictionary and the dictionary's
  7694. codepage. Setting these properties explicitly might have surprising
  7695. effects. An application should never do this but always use this
  7696. method.
  7697. </summary>
  7698. <value>
  7699. the dictionary
  7700. </value>
  7701. </member>
  7702. <member name="P:NPOI.HPSF.MutableSection.Codepage">
  7703. <summary>
  7704. Gets the section's codepage, if any.
  7705. </summary>
  7706. <value>The section's codepage if one is defined, else -1.</value>
  7707. </member>
  7708. <member name="T:NPOI.HPSF.NoFormatIDException">
  7709. <summary>
  7710. This exception is thrown if a {@link MutablePropertySet} is To be written
  7711. but does not have a formatID Set (see {@link
  7712. MutableSection#SetFormatID(ClassID)} or
  7713. {@link org.apache.poi.hpsf.MutableSection#SetFormatID(byte[])}.
  7714. @author Rainer Klute
  7715. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7716. @since 2002-09-03
  7717. </summary>
  7718. </member>
  7719. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor">
  7720. <summary>
  7721. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  7722. </summary>
  7723. </member>
  7724. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String)">
  7725. <summary>
  7726. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  7727. </summary>
  7728. <param name="msg">The exception's message string</param>
  7729. </member>
  7730. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.Exception)">
  7731. <summary>
  7732. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  7733. </summary>
  7734. <param name="reason">This exception's underlying reason</param>
  7735. </member>
  7736. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String,System.Exception)">
  7737. <summary>
  7738. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  7739. </summary>
  7740. <param name="msg">The exception's message string</param>
  7741. <param name="reason">This exception's underlying reason</param>
  7742. </member>
  7743. <member name="T:NPOI.HPSF.NoPropertySetStreamException">
  7744. <summary>
  7745. This exception is thrown if a format error in a property Set stream Is
  7746. detected or when the input data do not constitute a property Set stream.
  7747. The constructors of this class are analogous To those of its superclass
  7748. and are documented there.
  7749. @author Rainer Klute
  7750. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7751. @since 2002-02-09
  7752. </summary>
  7753. </member>
  7754. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor">
  7755. <summary>
  7756. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  7757. </summary>
  7758. </member>
  7759. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String)">
  7760. <summary>
  7761. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  7762. </summary>
  7763. <param name="msg">The exception's message string</param>
  7764. </member>
  7765. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.Exception)">
  7766. <summary>
  7767. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  7768. </summary>
  7769. <param name="reason">This exception's underlying reason</param>
  7770. </member>
  7771. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String,System.Exception)">
  7772. <summary>
  7773. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  7774. </summary>
  7775. <param name="msg">The exception's message string</param>
  7776. <param name="reason">This exception's underlying reason</param>
  7777. </member>
  7778. <member name="T:NPOI.HPSF.NoSingleSectionException">
  7779. <summary>
  7780. This exception is thrown if one of the {@link PropertySet}'s
  7781. convenience methods that require a single {@link Section} is called
  7782. and the {@link PropertySet} does not contain exactly one {@link
  7783. Section}.
  7784. The constructors of this class are analogous To those of its
  7785. superclass and documented there.
  7786. @author Rainer Klute
  7787. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7788. @since 2002-02-09
  7789. </summary>
  7790. </member>
  7791. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor">
  7792. <summary>
  7793. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  7794. </summary>
  7795. </member>
  7796. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String)">
  7797. <summary>
  7798. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  7799. </summary>
  7800. <param name="msg">The exception's message string</param>
  7801. </member>
  7802. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.Exception)">
  7803. <summary>
  7804. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  7805. </summary>
  7806. <param name="reason">This exception's underlying reason</param>
  7807. </member>
  7808. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String,System.Exception)">
  7809. <summary>
  7810. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  7811. </summary>
  7812. <param name="msg">The exception's message string</param>
  7813. <param name="reason">This exception's underlying reason</param>
  7814. </member>
  7815. <member name="T:NPOI.HPSF.PropertySetFactory">
  7816. <summary>
  7817. Factory class To Create instances of {@link SummaryInformation},
  7818. {@link DocumentSummaryInformation} and {@link PropertySet}.
  7819. @author Rainer Klute
  7820. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7821. @since 2002-02-09
  7822. </summary>
  7823. </member>
  7824. <member name="M:NPOI.HPSF.PropertySetFactory.Create(System.IO.Stream)">
  7825. <summary>
  7826. Creates the most specific {@link PropertySet} from an {@link
  7827. InputStream}. This is preferrably a {@link
  7828. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  7829. the specified {@link InputStream} does not contain a property
  7830. Set stream, an exception is thrown and the {@link InputStream}
  7831. is repositioned at its beginning.
  7832. </summary>
  7833. <param name="stream">Contains the property set stream's data.</param>
  7834. <returns>The Created {@link PropertySet}.</returns>
  7835. </member>
  7836. <member name="M:NPOI.HPSF.PropertySetFactory.CreateSummaryInformation">
  7837. <summary>
  7838. Creates a new summary information
  7839. </summary>
  7840. <returns>the new summary information.</returns>
  7841. </member>
  7842. <member name="M:NPOI.HPSF.PropertySetFactory.CreateDocumentSummaryInformation">
  7843. <summary>
  7844. Creates a new document summary information.
  7845. </summary>
  7846. <returns>the new document summary information.</returns>
  7847. </member>
  7848. <member name="T:NPOI.HPSF.ReadingNotSupportedException">
  7849. <summary>
  7850. This exception is thrown when HPSF tries To Read a (yet) unsupported
  7851. variant type.
  7852. @see WritingNotSupportedException
  7853. @see UnsupportedVariantTypeException
  7854. @author Rainer Klute
  7855. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7856. @since 2003-08-08
  7857. </summary>
  7858. </member>
  7859. <member name="T:NPOI.HPSF.UnsupportedVariantTypeException">
  7860. <summary>
  7861. This exception is thrown if HPSF encounters a variant type that isn't
  7862. supported yet. Although a variant type is unsupported the value can still be
  7863. retrieved using the {@link VariantTypeException#GetValue} method.
  7864. Obviously this class should disappear some day.
  7865. @author Rainer Klute
  7866. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7867. @since 2003-08-05
  7868. </summary>
  7869. </member>
  7870. <member name="M:NPOI.HPSF.UnsupportedVariantTypeException.#ctor(System.Int64,System.Object)">
  7871. <summary>
  7872. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnsupportedVariantTypeException"/> class.
  7873. </summary>
  7874. <param name="variantType">The unsupported variant type</param>
  7875. <param name="value">The value who's variant type is not yet supported</param>
  7876. </member>
  7877. <member name="M:NPOI.HPSF.ReadingNotSupportedException.#ctor(System.Int64,System.Object)">
  7878. <summary>
  7879. Initializes a new instance of the <see cref="T:NPOI.HPSF.ReadingNotSupportedException"/> class.
  7880. </summary>
  7881. <param name="variantType">The unsupported variant type</param>
  7882. <param name="value">The value who's variant type is not yet supported</param>
  7883. </member>
  7884. <member name="T:NPOI.HPSF.SummaryInformation">
  7885. <summary>
  7886. Convenience class representing a Summary Information stream in a
  7887. Microsoft Office document.
  7888. @author Rainer Klute
  7889. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  7890. @see DocumentSummaryInformation
  7891. @since 2002-02-09
  7892. </summary>
  7893. </member>
  7894. <member name="F:NPOI.HPSF.SummaryInformation.DEFAULT_STREAM_NAME">
  7895. The document name a summary information stream usually has in a POIFS
  7896. filesystem.
  7897. </member>
  7898. <member name="M:NPOI.HPSF.SummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  7899. <summary>
  7900. Initializes a new instance of the <see cref="T:NPOI.HPSF.SummaryInformation"/> class.
  7901. </summary>
  7902. <param name="ps">A property Set which should be Created from a summary
  7903. information stream.</param>
  7904. </member>
  7905. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTitle">
  7906. <summary>
  7907. Removes the title.
  7908. </summary>
  7909. </member>
  7910. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSubject">
  7911. <summary>
  7912. Removes the subject.
  7913. </summary>
  7914. </member>
  7915. <member name="M:NPOI.HPSF.SummaryInformation.RemoveAuthor">
  7916. <summary>
  7917. Removes the author.
  7918. </summary>
  7919. </member>
  7920. <member name="M:NPOI.HPSF.SummaryInformation.RemoveKeywords">
  7921. <summary>
  7922. Removes the keywords.
  7923. </summary>
  7924. </member>
  7925. <member name="M:NPOI.HPSF.SummaryInformation.RemoveComments">
  7926. <summary>
  7927. Removes the comments.
  7928. </summary>
  7929. </member>
  7930. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTemplate">
  7931. <summary>
  7932. Removes the template.
  7933. </summary>
  7934. </member>
  7935. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastAuthor">
  7936. <summary>
  7937. Removes the last author.
  7938. </summary>
  7939. </member>
  7940. <member name="M:NPOI.HPSF.SummaryInformation.RemoveRevNumber">
  7941. <summary>
  7942. Removes the rev number.
  7943. </summary>
  7944. </member>
  7945. <member name="M:NPOI.HPSF.SummaryInformation.RemoveEditTime">
  7946. <summary>
  7947. Removes the edit time.
  7948. </summary>
  7949. </member>
  7950. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastPrinted">
  7951. <summary>
  7952. Removes the last printed.
  7953. </summary>
  7954. </member>
  7955. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCreateDateTime">
  7956. <summary>
  7957. Removes the create date time.
  7958. </summary>
  7959. </member>
  7960. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastSaveDateTime">
  7961. <summary>
  7962. Removes the last save date time.
  7963. </summary>
  7964. </member>
  7965. <member name="M:NPOI.HPSF.SummaryInformation.RemovePageCount">
  7966. <summary>
  7967. Removes the page count.
  7968. </summary>
  7969. </member>
  7970. <member name="M:NPOI.HPSF.SummaryInformation.RemoveWordCount">
  7971. <summary>
  7972. Removes the word count.
  7973. </summary>
  7974. </member>
  7975. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCharCount">
  7976. <summary>
  7977. Removes the char count.
  7978. </summary>
  7979. </member>
  7980. <member name="M:NPOI.HPSF.SummaryInformation.RemoveThumbnail">
  7981. <summary>
  7982. Removes the thumbnail.
  7983. </summary>
  7984. </member>
  7985. <member name="M:NPOI.HPSF.SummaryInformation.RemoveApplicationName">
  7986. <summary>
  7987. Removes the name of the application.
  7988. </summary>
  7989. </member>
  7990. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSecurity">
  7991. <summary>
  7992. Removes the security code.
  7993. </summary>
  7994. </member>
  7995. <member name="P:NPOI.HPSF.SummaryInformation.Title">
  7996. <summary>
  7997. Gets or sets the title.
  7998. </summary>
  7999. <value>The title.</value>
  8000. </member>
  8001. <member name="P:NPOI.HPSF.SummaryInformation.Subject">
  8002. <summary>
  8003. Gets or sets the subject.
  8004. </summary>
  8005. <value>The subject.</value>
  8006. </member>
  8007. <member name="P:NPOI.HPSF.SummaryInformation.Author">
  8008. <summary>
  8009. Gets or sets the author.
  8010. </summary>
  8011. <value>The author.</value>
  8012. </member>
  8013. <member name="P:NPOI.HPSF.SummaryInformation.Keywords">
  8014. <summary>
  8015. Gets or sets the keywords.
  8016. </summary>
  8017. <value>The keywords.</value>
  8018. </member>
  8019. <member name="P:NPOI.HPSF.SummaryInformation.Comments">
  8020. <summary>
  8021. Gets or sets the comments.
  8022. </summary>
  8023. <value>The comments.</value>
  8024. </member>
  8025. <member name="P:NPOI.HPSF.SummaryInformation.Template">
  8026. <summary>
  8027. Gets or sets the template.
  8028. </summary>
  8029. <value>The template.</value>
  8030. </member>
  8031. <member name="P:NPOI.HPSF.SummaryInformation.LastAuthor">
  8032. <summary>
  8033. Gets or sets the last author.
  8034. </summary>
  8035. <value>The last author.</value>
  8036. </member>
  8037. <member name="P:NPOI.HPSF.SummaryInformation.RevNumber">
  8038. <summary>
  8039. Gets or sets the rev number.
  8040. </summary>
  8041. <value>The rev number.</value>
  8042. </member>
  8043. <member name="P:NPOI.HPSF.SummaryInformation.EditTime">
  8044. <summary>
  8045. Returns the Total time spent in editing the document (or 0).
  8046. </summary>
  8047. <value>The Total time spent in editing the document or 0 if the {@link
  8048. SummaryInformation} does not contain this information.</value>
  8049. </member>
  8050. <member name="P:NPOI.HPSF.SummaryInformation.LastPrinted">
  8051. <summary>
  8052. Gets or sets the last printed time
  8053. </summary>
  8054. <value>The last printed time</value>
  8055. Returns the last printed time (or <c>null</c>).
  8056. </member>
  8057. <member name="P:NPOI.HPSF.SummaryInformation.CreateDateTime">
  8058. <summary>
  8059. Gets or sets the create date time.
  8060. </summary>
  8061. <value>The create date time.</value>
  8062. </member>
  8063. <member name="P:NPOI.HPSF.SummaryInformation.LastSaveDateTime">
  8064. <summary>
  8065. Gets or sets the last save date time.
  8066. </summary>
  8067. <value>The last save date time.</value>
  8068. </member>
  8069. <member name="P:NPOI.HPSF.SummaryInformation.PageCount">
  8070. <summary>
  8071. Gets or sets the page count or 0 if the {@link SummaryInformation} does
  8072. not contain a page count.
  8073. </summary>
  8074. <value>The page count or 0 if the {@link SummaryInformation} does not
  8075. contain a page count.</value>
  8076. </member>
  8077. <member name="P:NPOI.HPSF.SummaryInformation.WordCount">
  8078. <summary>
  8079. Gets or sets the word count or 0 if the {@link SummaryInformation} does
  8080. not contain a word count.
  8081. </summary>
  8082. <value>The word count.</value>
  8083. </member>
  8084. <member name="P:NPOI.HPSF.SummaryInformation.CharCount">
  8085. <summary>
  8086. Gets or sets the character count or 0 if the {@link SummaryInformation}
  8087. does not contain a char count.
  8088. </summary>
  8089. <value>The character count.</value>
  8090. </member>
  8091. <member name="P:NPOI.HPSF.SummaryInformation.Thumbnail">
  8092. <summary>
  8093. Gets or sets the thumbnail (or <c>null</c>) <strong>when this
  8094. method is implemented. Please note that the return type is likely To
  8095. Change!</strong>
  8096. <strong>Hint To developers:</strong> Drew Varner &lt;Drew.Varner
  8097. -at- sc.edu&gt; said that this is an image in WMF or Clipboard (BMP?)
  8098. format. However, we won't do any conversion into any image type but
  8099. instead just return a byte array.
  8100. </summary>
  8101. <value>The thumbnail.</value>
  8102. </member>
  8103. <member name="P:NPOI.HPSF.SummaryInformation.ApplicationName">
  8104. <summary>
  8105. Gets or sets the name of the application.
  8106. </summary>
  8107. <value>The name of the application.</value>
  8108. </member>
  8109. <member name="P:NPOI.HPSF.SummaryInformation.Security">
  8110. <summary>
  8111. Gets or sets a security code which is one of the following values:
  8112. <ul>
  8113. <li>0 if the {@link SummaryInformation} does not contain a
  8114. security field or if there is no security on the document. Use
  8115. {@link PropertySet#wasNull()} To distinguish between the two
  8116. cases!</li>
  8117. <li>1 if the document is password protected</li>
  8118. <li>2 if the document is Read-only recommended</li>
  8119. <li>4 if the document is Read-only enforced</li>
  8120. <li>8 if the document is locked for annotations</li>
  8121. </ul>
  8122. </summary>
  8123. <value>The security code</value>
  8124. </member>
  8125. <member name="T:NPOI.HPSF.Thumbnail">
  8126. <summary>
  8127. Class To manipulate data in the Clipboard Variant (Variant#VT_CF VT_CF) format.
  8128. @author Drew Varner (Drew.Varner inOrAround sc.edu)
  8129. @since 2002-04-29
  8130. </summary>
  8131. </member>
  8132. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CFTAG">
  8133. <summary>
  8134. OffSet in bytes where the Clipboard Format Tag starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  8135. </summary>
  8136. </member>
  8137. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CF">
  8138. <summary>
  8139. OffSet in bytes where the Clipboard Format starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  8140. </summary>
  8141. <remarks>This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS</remarks>
  8142. </member>
  8143. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_WMFDATA">
  8144. <summary>
  8145. OffSet in bytes where the Windows Metafile (WMF) image data starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  8146. There is only WMF data at this point in the
  8147. <c>byte[]</c> if the Clipboard Format Tag is
  8148. CFTAG_WINDOWS and the Clipboard Format is
  8149. CF_METAFILEPICT.
  8150. </summary>
  8151. <remarks>Note: The <c>byte[]</c> that starts at
  8152. <c>OFFSet_WMFDATA</c> and ends at
  8153. <c>GetThumbnail().Length - 1</c> forms a complete WMF
  8154. image. It can be saved To disk with a <c>.wmf</c> file
  8155. type and Read using a WMF-capable image viewer.</remarks>
  8156. </member>
  8157. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_WINDOWS">
  8158. <summary>
  8159. Clipboard Format Tag - Windows clipboard format
  8160. </summary>
  8161. <remarks>A <c>DWORD</c> indicating a built-in Windows clipboard format value</remarks>
  8162. </member>
  8163. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_MACINTOSH">
  8164. <summary>
  8165. Clipboard Format Tag - Macintosh clipboard format
  8166. </summary>
  8167. <remarks>A <c>DWORD</c> indicating a Macintosh clipboard format value</remarks>
  8168. </member>
  8169. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_FMTID">
  8170. <summary>
  8171. Clipboard Format Tag - Format ID
  8172. </summary>
  8173. <remarks>A GUID containing a format identifier (FMTID). This is rarely used.</remarks>
  8174. </member>
  8175. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_NODATA">
  8176. <summary>
  8177. Clipboard Format Tag - No Data
  8178. </summary>
  8179. <remarks>A <c>DWORD</c> indicating No data. This is rarely used.</remarks>
  8180. </member>
  8181. <member name="F:NPOI.HPSF.Thumbnail.CF_METAFILEPICT">
  8182. <summary>
  8183. Clipboard Format - Windows metafile format. This is the recommended way To store thumbnails in Property Streams.
  8184. </summary>
  8185. <remarks>Note:This is not the same format used in
  8186. regular WMF images. The clipboard version of this format has an
  8187. extra clipboard-specific header.</remarks>
  8188. </member>
  8189. <member name="F:NPOI.HPSF.Thumbnail.CF_DIB">
  8190. <summary>
  8191. Clipboard Format - Device Independent Bitmap
  8192. </summary>
  8193. </member>
  8194. <member name="F:NPOI.HPSF.Thumbnail.CF_ENHMETAFILE">
  8195. <summary>
  8196. Clipboard Format - Enhanced Windows metafile format
  8197. </summary>
  8198. </member>
  8199. <member name="F:NPOI.HPSF.Thumbnail.CF_BITMAP">
  8200. <summary>
  8201. Clipboard Format - Bitmap
  8202. </summary>
  8203. <remarks>see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</remarks>
  8204. </member>
  8205. <member name="F:NPOI.HPSF.Thumbnail.thumbnailData">
  8206. A <c>byte[]</c> To hold a thumbnail image in (
  8207. Variant#VT_CF VT_CF) format.
  8208. </member>
  8209. <member name="M:NPOI.HPSF.Thumbnail.#ctor">
  8210. <summary>
  8211. Default Constructor. If you use it then one you'll have To Add
  8212. the thumbnail <c>byte[]</c> from {@link
  8213. SummaryInformation#GetThumbnail()} To do any useful
  8214. manipulations, otherwise you'll Get a
  8215. <c>NullPointerException</c>.
  8216. </summary>
  8217. </member>
  8218. <member name="M:NPOI.HPSF.Thumbnail.#ctor(System.Byte[])">
  8219. <summary>
  8220. Initializes a new instance of the <see cref="T:NPOI.HPSF.Thumbnail"/> class.
  8221. </summary>
  8222. <param name="thumbnailData">The thumbnail data.</param>
  8223. </member>
  8224. <member name="M:NPOI.HPSF.Thumbnail.GetClipboardFormat">
  8225. <summary>
  8226. Returns an <c>int</c> representing the Clipboard
  8227. Format
  8228. Will throw an exception if the Thumbnail's Clipboard Format
  8229. Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}.
  8230. Possible return values are:
  8231. <ul>
  8232. <li>{@link #CF_METAFILEPICT CF_METAFILEPICT}</li>
  8233. <li>{@link #CF_DIB CF_DIB}</li>
  8234. <li>{@link #CF_ENHMETAFILE CF_ENHMETAFILE}</li>
  8235. <li>{@link #CF_BITMAP CF_BITMAP}</li>
  8236. </ul>
  8237. </summary>
  8238. <returns>a flag indicating the Clipboard Format</returns>
  8239. </member>
  8240. <member name="M:NPOI.HPSF.Thumbnail.GetThumbnailAsWMF">
  8241. <summary>
  8242. Returns the Thumbnail as a <c>byte[]</c> of WMF data
  8243. if the Thumbnail's Clipboard Format Tag is {@link
  8244. #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is
  8245. {@link #CF_METAFILEPICT CF_METAFILEPICT}
  8246. This
  8247. <c>byte[]</c> is in the traditional WMF file, not the
  8248. clipboard-specific version with special headers.
  8249. See <a href="http://www.wvware.com/caolan/ora-wmf.html" tarGet="_blank">http://www.wvware.com/caolan/ora-wmf.html</a>
  8250. for more information on the WMF image format.
  8251. @return A WMF image of the Thumbnail
  8252. @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and
  8253. CF_METAFILEPICT
  8254. </summary>
  8255. <returns></returns>
  8256. </member>
  8257. <member name="P:NPOI.HPSF.Thumbnail.ThumbnailData">
  8258. <summary>
  8259. Gets or sets the thumbnail as a <c>byte[]</c> in {@link
  8260. Variant#VT_CF VT_CF} format.
  8261. </summary>
  8262. <value>The thumbnail value</value>
  8263. </member>
  8264. <member name="P:NPOI.HPSF.Thumbnail.ClipboardFormatTag">
  8265. <summary>
  8266. Returns an <c>int</c> representing the Clipboard
  8267. Format Tag
  8268. Possible return values are:
  8269. <ul>
  8270. <li>{@link #CFTAG_WINDOWS CFTAG_WINDOWS}</li>
  8271. <li>{@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}</li>
  8272. <li>{@link #CFTAG_FMTID CFTAG_FMTID}</li>
  8273. <li>{@link #CFTAG_NODATA CFTAG_NODATA}</li>
  8274. </ul>
  8275. </summary>
  8276. <returns>A flag indicating the Clipboard Format Tag</returns>
  8277. </member>
  8278. <member name="T:NPOI.HPSF.TypeWriter">
  8279. <summary>
  8280. Class for writing little-endian data and more.
  8281. @author Rainer Klute
  8282. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8283. @since 2003-02-20
  8284. </summary>
  8285. </member>
  8286. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int16)">
  8287. <summary>
  8288. Writes a two-byte value (short) To an output stream.
  8289. </summary>
  8290. <param name="out1">The stream To Write To..</param>
  8291. <param name="n">The number of bytes that have been written.</param>
  8292. <returns></returns>
  8293. </member>
  8294. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int32)">
  8295. Writes a four-byte value To an output stream.
  8296. @param out The stream To Write To.
  8297. @param n The value To Write.
  8298. @exception IOException if an I/O error occurs
  8299. @return The number of bytes written To the output stream.
  8300. </member>
  8301. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.UInt32)">
  8302. Writes a four-byte value To an output stream.
  8303. @param out The stream To Write To.
  8304. @param n The value To Write.
  8305. @exception IOException if an I/O error occurs
  8306. @return The number of bytes written To the output stream.
  8307. </member>
  8308. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int64)">
  8309. Writes a eight-byte value To an output stream.
  8310. @param out The stream To Write To.
  8311. @param n The value To Write.
  8312. @exception IOException if an I/O error occurs
  8313. @return The number of bytes written To the output stream.
  8314. </member>
  8315. <member name="M:NPOI.HPSF.TypeWriter.WriteUShortToStream(System.IO.Stream,System.Int32)">
  8316. Writes an unsigned two-byte value To an output stream.
  8317. @param out The stream To Write To
  8318. @param n The value To Write
  8319. @exception IOException if an I/O error occurs
  8320. </member>
  8321. <member name="M:NPOI.HPSF.TypeWriter.WriteUIntToStream(System.IO.Stream,System.UInt32)">
  8322. Writes an unsigned four-byte value To an output stream.
  8323. @param out The stream To Write To.
  8324. @param n The value To Write.
  8325. @return The number of bytes that have been written To the output stream.
  8326. @exception IOException if an I/O error occurs
  8327. </member>
  8328. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.Util.ClassID)">
  8329. Writes a 16-byte {@link ClassID} To an output stream.
  8330. @param out The stream To Write To
  8331. @param n The value To Write
  8332. @return The number of bytes written
  8333. @exception IOException if an I/O error occurs
  8334. </member>
  8335. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.HPSF.Property[],System.Int32)">
  8336. Writes an array of {@link Property} instances To an output stream
  8337. according To the Horrible Property Format.
  8338. @param out The stream To Write To
  8339. @param properties The array To Write To the stream
  8340. @param codepage The codepage number To use for writing strings
  8341. @exception IOException if an I/O error occurs
  8342. @throws UnsupportedVariantTypeException if HPSF does not support some
  8343. variant type.
  8344. </member>
  8345. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Double)">
  8346. Writes a double value value To an output stream.
  8347. @param out The stream To Write To.
  8348. @param n The value To Write.
  8349. @exception IOException if an I/O error occurs
  8350. @return The number of bytes written To the output stream.
  8351. </member>
  8352. <member name="T:NPOI.HPSF.UnexpectedPropertySetTypeException">
  8353. <summary>
  8354. This exception is thrown if a certain type of property Set Is
  8355. expected (e.g. a Document Summary Information) but the provided
  8356. property Set is not of that type.
  8357. The constructors of this class are analogous To those of its
  8358. superclass and documented there.
  8359. @author Rainer Klute
  8360. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8361. @since 2002-02-09
  8362. </summary>
  8363. </member>
  8364. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor">
  8365. <summary>
  8366. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  8367. </summary>
  8368. </member>
  8369. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String)">
  8370. <summary>
  8371. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  8372. </summary>
  8373. <param name="msg">The message string.</param>
  8374. </member>
  8375. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.Exception)">
  8376. <summary>
  8377. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  8378. </summary>
  8379. <param name="reason">The reason, i.e. a throwable that indirectly
  8380. caused this exception.</param>
  8381. </member>
  8382. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String,System.Exception)">
  8383. <summary>
  8384. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  8385. </summary>
  8386. <param name="msg">The message string.</param>
  8387. <param name="reason">The reason, i.e. a throwable that indirectly
  8388. caused this exception.</param>
  8389. </member>
  8390. <member name="T:NPOI.HPSF.Util">
  8391. <summary>
  8392. Provides various static utility methods.
  8393. @author Rainer Klute (klute@rainer-klute.de)
  8394. @since 2002-02-09
  8395. </summary>
  8396. </member>
  8397. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  8398. <summary>
  8399. Copies a part of a byte array into another byte array.
  8400. </summary>
  8401. <param name="src">The source byte array.</param>
  8402. <param name="srcOffSet">OffSet in the source byte array.</param>
  8403. <param name="Length">The number of bytes To Copy.</param>
  8404. <param name="dst">The destination byte array.</param>
  8405. <param name="dstOffSet">OffSet in the destination byte array.</param>
  8406. </member>
  8407. <member name="M:NPOI.HPSF.Util.Cat(System.Byte[][])">
  8408. <summary>
  8409. Concatenates the contents of several byte arrays into a
  8410. single one.
  8411. </summary>
  8412. <param name="byteArrays">The byte arrays To be conCatened.</param>
  8413. <returns>A new byte array containing the conCatenated byte arrays.</returns>
  8414. </member>
  8415. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32)">
  8416. <summary>
  8417. Copies bytes from a source byte array into a new byte
  8418. array.
  8419. </summary>
  8420. <param name="src">Copy from this byte array.</param>
  8421. <param name="offset">Start Copying here.</param>
  8422. <param name="Length">Copy this many bytes.</param>
  8423. <returns>The new byte array. Its Length is number of copied bytes.</returns>
  8424. </member>
  8425. <member name="F:NPOI.HPSF.Util.EPOCH_DIFF">
  8426. The difference between the Windows epoch (1601-01-01
  8427. 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in
  8428. milliseconds: 11644473600000L. (Use your favorite spReadsheet
  8429. program To verify the correctness of this value. By the way,
  8430. did you notice that you can tell from the epochs which
  8431. operating system is the modern one? :-))
  8432. </member>
  8433. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int32,System.Int32)">
  8434. <summary>
  8435. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  8436. FILETIME structure holds a DateTime and time associated with a
  8437. file. The structure identifies a 64-bit integer specifying the
  8438. number of 100-nanosecond intervals which have passed since
  8439. January 1, 1601. This 64-bit value is split into the two double
  8440. words stored in the structure.
  8441. </summary>
  8442. <param name="high">The higher double word of the FILETIME structure.</param>
  8443. <param name="low">The lower double word of the FILETIME structure.</param>
  8444. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  8445. </member>
  8446. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int64)">
  8447. <summary>
  8448. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  8449. FILETIME structure holds a DateTime and time associated with a
  8450. file. The structure identifies a 64-bit integer specifying the
  8451. number of 100-nanosecond intervals which have passed since
  8452. January 1, 1601.
  8453. </summary>
  8454. <param name="filetime">The filetime To Convert.</param>
  8455. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  8456. </member>
  8457. <member name="M:NPOI.HPSF.Util.DateToFileTime(System.DateTime)">
  8458. <summary>
  8459. Converts a {@link DateTime} into a filetime.
  8460. </summary>
  8461. <param name="dateTime">The DateTime To be Converted</param>
  8462. <returns>The filetime</returns>
  8463. </member>
  8464. <member name="M:NPOI.HPSF.Util.AreEqual(System.Collections.IList,System.Collections.IList)">
  8465. <summary>
  8466. Compares To object arrays with regarding the objects' order. For
  8467. example, [1, 2, 3] and [2, 1, 3] are equal.
  8468. </summary>
  8469. <param name="c1">The first object array.</param>
  8470. <param name="c2">The second object array.</param>
  8471. <returns><c>true</c>
  8472. if the object arrays are equal,
  8473. <c>false</c>
  8474. if they are not.</returns>
  8475. </member>
  8476. <member name="M:NPOI.HPSF.Util.internalEquals(System.Collections.IList,System.Collections.IList)">
  8477. <summary>
  8478. Internals the equals.
  8479. </summary>
  8480. <param name="c1">The c1.</param>
  8481. <param name="c2">The c2.</param>
  8482. <returns></returns>
  8483. </member>
  8484. <member name="M:NPOI.HPSF.Util.Pad4(System.Byte[])">
  8485. <summary>
  8486. Pads a byte array with 0x00 bytes so that its Length is a multiple of
  8487. 4.
  8488. </summary>
  8489. <param name="ba">The byte array To pad.</param>
  8490. <returns>The padded byte array.</returns>
  8491. </member>
  8492. <member name="M:NPOI.HPSF.Util.Pad4(System.Char[])">
  8493. <summary>
  8494. Pads a character array with 0x0000 characters so that its Length is a
  8495. multiple of 4.
  8496. </summary>
  8497. <param name="ca">The character array To pad.</param>
  8498. <returns>The padded character array.</returns>
  8499. </member>
  8500. <member name="M:NPOI.HPSF.Util.Pad4(System.String)">
  8501. <summary>
  8502. Pads a string with 0x0000 characters so that its Length is a
  8503. multiple of 4.
  8504. </summary>
  8505. <param name="s">The string To pad.</param>
  8506. <returns> The padded string as a character array.</returns>
  8507. </member>
  8508. <member name="T:NPOI.HPSF.Variant">
  8509. <summary>
  8510. The <em>Variant</em> types as defined by Microsoft's COM. I
  8511. found this information in <a href="http://www.marin.clara.net/COM/variant_type_definitions.htm">
  8512. http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.
  8513. In the variant types descriptions the following shortcuts are
  8514. used: <strong> [V]</strong> - may appear in a VARIANT,
  8515. <strong>[T]</strong> - may appear in a TYPEDESC,
  8516. <strong>[P]</strong> - may appear in an OLE property Set,
  8517. <strong>[S]</strong> - may appear in a Safe Array.
  8518. @author Rainer Klute (klute@rainer-klute.de)
  8519. @since 2002-02-09
  8520. </summary>
  8521. </member>
  8522. <member name="F:NPOI.HPSF.Variant.VT_EMPTY">
  8523. [V][P] Nothing, i.e. not a single byte of data.
  8524. </member>
  8525. <member name="F:NPOI.HPSF.Variant.VT_NULL">
  8526. [V][P] SQL style Null.
  8527. </member>
  8528. <member name="F:NPOI.HPSF.Variant.VT_I2">
  8529. [V][T][P][S] 2 byte signed int.
  8530. </member>
  8531. <member name="F:NPOI.HPSF.Variant.VT_I4">
  8532. [V][T][P][S] 4 byte signed int.
  8533. </member>
  8534. <member name="F:NPOI.HPSF.Variant.VT_R4">
  8535. [V][T][P][S] 4 byte real.
  8536. </member>
  8537. <member name="F:NPOI.HPSF.Variant.VT_R8">
  8538. [V][T][P][S] 8 byte real.
  8539. </member>
  8540. <member name="F:NPOI.HPSF.Variant.VT_CY">
  8541. [V][T][P][S] currency. <span style="background-color:
  8542. #ffff00">How long is this? How is it To be
  8543. interpreted?</span>
  8544. </member>
  8545. <member name="F:NPOI.HPSF.Variant.VT_DATE">
  8546. [V][T][P][S] DateTime. <span style="background-color:
  8547. #ffff00">How long is this? How is it To be
  8548. interpreted?</span>
  8549. </member>
  8550. <member name="F:NPOI.HPSF.Variant.VT_BSTR">
  8551. [V][T][P][S] OLE Automation string. <span
  8552. style="background-color: #ffff00">How long is this? How is it
  8553. To be interpreted?</span>
  8554. </member>
  8555. <member name="F:NPOI.HPSF.Variant.VT_DISPATCH">
  8556. [V][T][P][S] IDispatch *. <span style="background-color:
  8557. #ffff00">How long is this? How is it To be
  8558. interpreted?</span>
  8559. </member>
  8560. <member name="F:NPOI.HPSF.Variant.VT_ERROR">
  8561. [V][T][S] SCODE. <span style="background-color: #ffff00">How
  8562. long is this? How is it To be interpreted?</span>
  8563. </member>
  8564. <member name="F:NPOI.HPSF.Variant.VT_BOOL">
  8565. [V][T][P][S] True=-1, False=0.
  8566. </member>
  8567. <member name="F:NPOI.HPSF.Variant.VT_VARIANT">
  8568. [V][T][P][S] VARIANT *. <span style="background-color:
  8569. #ffff00">How long is this? How is it To be
  8570. interpreted?</span>
  8571. </member>
  8572. <member name="F:NPOI.HPSF.Variant.VT_UNKNOWN">
  8573. [V][T][S] IUnknown *. <span style="background-color:
  8574. #ffff00">How long is this? How is it To be
  8575. interpreted?</span>
  8576. </member>
  8577. <member name="F:NPOI.HPSF.Variant.VT_DECIMAL">
  8578. [V][T][S] 16 byte fixed point.
  8579. </member>
  8580. <member name="F:NPOI.HPSF.Variant.VT_I1">
  8581. [T] signed char.
  8582. </member>
  8583. <member name="F:NPOI.HPSF.Variant.VT_UI1">
  8584. [V][T][P][S] unsigned char.
  8585. </member>
  8586. <member name="F:NPOI.HPSF.Variant.VT_UI2">
  8587. [T][P] unsigned short.
  8588. </member>
  8589. <member name="F:NPOI.HPSF.Variant.VT_UI4">
  8590. [T][P] unsigned int.
  8591. </member>
  8592. <member name="F:NPOI.HPSF.Variant.VT_I8">
  8593. [T][P] signed 64-bit int.
  8594. </member>
  8595. <member name="F:NPOI.HPSF.Variant.VT_UI8">
  8596. [T][P] unsigned 64-bit int.
  8597. </member>
  8598. <member name="F:NPOI.HPSF.Variant.VT_INT">
  8599. [T] signed machine int.
  8600. </member>
  8601. <member name="F:NPOI.HPSF.Variant.VT_UINT">
  8602. [T] unsigned machine int.
  8603. </member>
  8604. <member name="F:NPOI.HPSF.Variant.VT_VOID">
  8605. [T] C style void.
  8606. </member>
  8607. <member name="F:NPOI.HPSF.Variant.VT_HRESULT">
  8608. [T] Standard return type. <span style="background-color:
  8609. #ffff00">How long is this? How is it To be
  8610. interpreted?</span>
  8611. </member>
  8612. <member name="F:NPOI.HPSF.Variant.VT_PTR">
  8613. [T] pointer type. <span style="background-color:
  8614. #ffff00">How long is this? How is it To be
  8615. interpreted?</span>
  8616. </member>
  8617. <member name="F:NPOI.HPSF.Variant.VT_SAFEARRAY">
  8618. [T] (use VT_ARRAY in VARIANT).
  8619. </member>
  8620. <member name="F:NPOI.HPSF.Variant.VT_CARRAY">
  8621. [T] C style array. <span style="background-color:
  8622. #ffff00">How long is this? How is it To be
  8623. interpreted?</span>
  8624. </member>
  8625. <member name="F:NPOI.HPSF.Variant.VT_USERDEFINED">
  8626. [T] user defined type. <span style="background-color:
  8627. #ffff00">How long is this? How is it To be
  8628. interpreted?</span>
  8629. </member>
  8630. <member name="F:NPOI.HPSF.Variant.VT_LPSTR">
  8631. [T][P] null terminated string.
  8632. </member>
  8633. <member name="F:NPOI.HPSF.Variant.VT_LPWSTR">
  8634. [T][P] wide (Unicode) null terminated string.
  8635. </member>
  8636. <member name="F:NPOI.HPSF.Variant.VT_FILETIME">
  8637. [P] FILETIME. The FILETIME structure holds a DateTime and time
  8638. associated with a file. The structure identifies a 64-bit
  8639. integer specifying the number of 100-nanosecond intervals which
  8640. have passed since January 1, 1601. This 64-bit value is split
  8641. into the two dwords stored in the structure.
  8642. </member>
  8643. <member name="F:NPOI.HPSF.Variant.VT_BLOB">
  8644. [P] Length prefixed bytes.
  8645. </member>
  8646. <member name="F:NPOI.HPSF.Variant.VT_STREAM">
  8647. [P] Name of the stream follows.
  8648. </member>
  8649. <member name="F:NPOI.HPSF.Variant.VT_STORAGE">
  8650. [P] Name of the storage follows.
  8651. </member>
  8652. <member name="F:NPOI.HPSF.Variant.VT_STREAMED_OBJECT">
  8653. [P] Stream Contains an object. <span
  8654. style="background-color: #ffff00"> How long is this? How is it
  8655. To be interpreted?</span>
  8656. </member>
  8657. <member name="F:NPOI.HPSF.Variant.VT_STORED_OBJECT">
  8658. [P] Storage Contains an object. <span
  8659. style="background-color: #ffff00"> How long is this? How is it
  8660. To be interpreted?</span>
  8661. </member>
  8662. <member name="F:NPOI.HPSF.Variant.VT_BLOB_OBJECT">
  8663. [P] Blob Contains an object. <span style="background-color:
  8664. #ffff00">How long is this? How is it To be
  8665. interpreted?</span>
  8666. </member>
  8667. <member name="F:NPOI.HPSF.Variant.VT_CF">
  8668. [P] Clipboard format. <span style="background-color:
  8669. #ffff00">How long is this? How is it To be
  8670. interpreted?</span>
  8671. </member>
  8672. <member name="F:NPOI.HPSF.Variant.VT_CLSID">
  8673. [P] A Class ID.
  8674. It consists of a 32 bit unsigned integer indicating the size
  8675. of the structure, a 32 bit signed integer indicating (Clipboard
  8676. Format Tag) indicating the type of data that it Contains, and
  8677. then a byte array containing the data.
  8678. The valid Clipboard Format Tags are:
  8679. <ul>
  8680. <li>{@link Thumbnail#CFTAG_WINDOWS}</li>
  8681. <li>{@link Thumbnail#CFTAG_MACINTOSH}</li>
  8682. <li>{@link Thumbnail#CFTAG_NODATA}</li>
  8683. <li>{@link Thumbnail#CFTAG_FMTID}</li>
  8684. </ul>
  8685. <pre>typedef struct tagCLIPDATA {
  8686. // cbSize is the size of the buffer pointed To
  8687. // by pClipData, plus sizeof(ulClipFmt)
  8688. ULONG cbSize;
  8689. long ulClipFmt;
  8690. BYTE* pClipData;
  8691. } CLIPDATA;</pre>
  8692. See <a
  8693. href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp"
  8694. tarGet="_blank">
  8695. msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.
  8696. </member>
  8697. <member name="F:NPOI.HPSF.Variant.VT_VERSIONED_STREAM">
  8698. "MUST be a VersionedStream. The storage representing the (non-simple)
  8699. property set MUST have a stream element with the name in the StreamName
  8700. field." -- [MS-OLEPS] -- v20110920; Object Linking and Embedding (OLE)
  8701. Property Set Data Structures; page 24 / 63
  8702. </member>
  8703. <member name="F:NPOI.HPSF.Variant.VT_VECTOR">
  8704. [P] simple counted array. <span style="background-color:
  8705. #ffff00">How long is this? How is it To be
  8706. interpreted?</span>
  8707. </member>
  8708. <member name="F:NPOI.HPSF.Variant.VT_ARRAY">
  8709. [V] SAFEARRAY*. <span style="background-color: #ffff00">How
  8710. long is this? How is it To be interpreted?</span>
  8711. </member>
  8712. <member name="F:NPOI.HPSF.Variant.VT_BYREF">
  8713. [V] void* for local use. <span style="background-color:
  8714. #ffff00">How long is this? How is it To be
  8715. interpreted?</span>
  8716. </member>
  8717. <member name="F:NPOI.HPSF.Variant.VT_RESERVED">
  8718. FIXME (3): Document this!
  8719. </member>
  8720. <member name="F:NPOI.HPSF.Variant.VT_ILLEGAL">
  8721. FIXME (3): Document this!
  8722. </member>
  8723. <member name="F:NPOI.HPSF.Variant.VT_ILLEGALMASKED">
  8724. FIXME (3): Document this!
  8725. </member>
  8726. <member name="F:NPOI.HPSF.Variant.VT_TYPEMASK">
  8727. FIXME (3): Document this!
  8728. </member>
  8729. <member name="F:NPOI.HPSF.Variant.Length_UNKNOWN">
  8730. Denotes a variant type with a Length that is unknown To HPSF yet.
  8731. </member>
  8732. <member name="F:NPOI.HPSF.Variant.Length_VARIABLE">
  8733. Denotes a variant type with a variable Length.
  8734. </member>
  8735. <member name="F:NPOI.HPSF.Variant.Length_0">
  8736. Denotes a variant type with a Length of 0 bytes.
  8737. </member>
  8738. <member name="F:NPOI.HPSF.Variant.Length_2">
  8739. Denotes a variant type with a Length of 2 bytes.
  8740. </member>
  8741. <member name="F:NPOI.HPSF.Variant.Length_4">
  8742. Denotes a variant type with a Length of 4 bytes.
  8743. </member>
  8744. <member name="F:NPOI.HPSF.Variant.Length_8">
  8745. Denotes a variant type with a Length of 8 bytes.
  8746. </member>
  8747. <member name="F:NPOI.HPSF.Variant.numberToName">
  8748. Maps the numbers denoting the variant types To their corresponding
  8749. variant type names.
  8750. </member>
  8751. <member name="M:NPOI.HPSF.Variant.GetVariantName(System.Int64)">
  8752. <summary>
  8753. Returns the variant type name associated with a variant type
  8754. number.
  8755. </summary>
  8756. <param name="variantType">The variant type number.</param>
  8757. <returns>The variant type name or the string "unknown variant type"</returns>
  8758. </member>
  8759. <member name="M:NPOI.HPSF.Variant.GetVariantLength(System.Int64)">
  8760. <summary>
  8761. Returns a variant type's Length.
  8762. </summary>
  8763. <param name="variantType">The variant type number.</param>
  8764. <returns>The Length of the variant type's data in bytes. If the Length Is
  8765. variable, i.e. the Length of a string, -1 is returned. If HPSF does not
  8766. know the Length, -2 is returned. The latter usually indicates an
  8767. unsupported variant type.</returns>
  8768. </member>
  8769. <member name="T:NPOI.HPSF.VariantSupport">
  8770. <summary>
  8771. Supports Reading and writing of variant data.
  8772. <strong>FIXME (3):</strong>
  8773. Reading and writing should be made more
  8774. uniform than it is now. The following items should be resolved:
  8775. Reading requires a Length parameter that is 4 byte greater than the
  8776. actual data, because the variant type field is included.
  8777. Reading Reads from a byte array while writing Writes To an byte array
  8778. output stream.
  8779. @author Rainer Klute
  8780. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8781. @since 2003-08-08
  8782. </summary>
  8783. </member>
  8784. <member name="F:NPOI.HPSF.VariantSupport.unsupportedMessage">
  8785. Keeps a list of the variant types an "unsupported" message has alReady
  8786. been issued for.
  8787. </member>
  8788. <member name="M:NPOI.HPSF.VariantSupport.WriteUnsupportedTypeMessage(NPOI.HPSF.UnsupportedVariantTypeException)">
  8789. <summary>
  8790. Writes a warning To System.err that a variant type Is
  8791. unsupported by HPSF. Such a warning is written only once for each variant
  8792. type. Log messages can be turned on or off by
  8793. </summary>
  8794. <param name="ex">The exception To log</param>
  8795. </member>
  8796. <member name="F:NPOI.HPSF.VariantSupport.SUPPORTED_TYPES">
  8797. HPSF is able To Read these {@link Variant} types.
  8798. </member>
  8799. <member name="M:NPOI.HPSF.VariantSupport.IsSupportedType(System.Int32)">
  8800. <summary>
  8801. Checks whether HPSF supports the specified variant type. Unsupported
  8802. types should be implemented included in the {@link #SUPPORTED_TYPES}
  8803. array.
  8804. </summary>
  8805. <param name="variantType">the variant type To check</param>
  8806. <returns>
  8807. <c>true</c> if HPFS supports this type,otherwise, <c>false</c>.
  8808. </returns>
  8809. </member>
  8810. <member name="M:NPOI.HPSF.VariantSupport.Read(System.Byte[],System.Int32,System.Int32,System.Int64,System.Int32)">
  8811. <summary>
  8812. Reads a variant type from a byte array
  8813. </summary>
  8814. <param name="src">The byte array</param>
  8815. <param name="offset">The offset in the byte array where the variant starts</param>
  8816. <param name="length">The Length of the variant including the variant type field</param>
  8817. <param name="type">The variant type To Read</param>
  8818. <param name="codepage">The codepage To use for non-wide strings</param>
  8819. <returns>A Java object that corresponds best To the variant field. For
  8820. example, a VT_I4 is returned as a {@link long}, a VT_LPSTR as a
  8821. {@link String}.</returns>
  8822. </member>
  8823. <member name="M:NPOI.HPSF.VariantSupport.CodepageToEncoding(System.Int32)">
  8824. <p>Turns a codepage number into the equivalent character encoding's
  8825. name.</p>
  8826. @param codepage The codepage number
  8827. @return The character encoding's name. If the codepage number is 65001,
  8828. the encoding name is "UTF-8". All other positive numbers are mapped to
  8829. "cp" followed by the number, e.g. if the codepage number is 1252 the
  8830. returned character encoding name will be "cp1252".
  8831. @exception UnsupportedEncodingException if the specified codepage is
  8832. less than zero.
  8833. </member>
  8834. <member name="M:NPOI.HPSF.VariantSupport.Write(System.IO.Stream,System.Int64,System.Object,System.Int32)">
  8835. <summary>
  8836. Writes a variant value To an output stream. This method ensures that
  8837. always a multiple of 4 bytes is written.
  8838. If the codepage is UTF-16, which is encouraged, strings
  8839. <strong>must</strong> always be written as {@link Variant#VT_LPWSTR}
  8840. strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this
  8841. by Converting strings appropriately, if needed.
  8842. </summary>
  8843. <param name="out1">The stream To Write the value To.</param>
  8844. <param name="type">The variant's type.</param>
  8845. <param name="value">The variant's value.</param>
  8846. <param name="codepage">The codepage To use To Write non-wide strings</param>
  8847. <returns>The number of entities that have been written. In many cases an
  8848. "entity" is a byte but this is not always the case.</returns>
  8849. </member>
  8850. <member name="P:NPOI.HPSF.VariantSupport.IsLogUnsupportedTypes">
  8851. <summary>
  8852. Checks whether logging of unsupported variant types warning is turned
  8853. on or off.
  8854. </summary>
  8855. <value>
  8856. <c>true</c> if logging is turned on; otherwise, <c>false</c>.
  8857. </value>
  8858. </member>
  8859. <member name="T:NPOI.HPSF.Wellknown.PropertyIDMap">
  8860. <summary>
  8861. This is a dictionary which maps property ID values To property
  8862. ID strings.
  8863. The methods {@link #GetSummaryInformationProperties} and {@link
  8864. #GetDocumentSummaryInformationProperties} return singleton {@link
  8865. PropertyIDMap}s. An application that wants To extend these maps
  8866. should treat them as unmodifiable, copy them and modifiy the
  8867. copies.
  8868. @author Rainer Klute
  8869. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  8870. @since 2002-02-09
  8871. </summary>
  8872. </member>
  8873. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TITLE">
  8874. ID of the property that denotes the document's title
  8875. </member>
  8876. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SUBJECT">
  8877. ID of the property that denotes the document's subject
  8878. </member>
  8879. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_AUTHOR">
  8880. ID of the property that denotes the document's author
  8881. </member>
  8882. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_KEYWORDS">
  8883. ID of the property that denotes the document's keywords
  8884. </member>
  8885. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMMENTS">
  8886. ID of the property that denotes the document's comments
  8887. </member>
  8888. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TEMPLATE">
  8889. ID of the property that denotes the document's template
  8890. </member>
  8891. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTAUTHOR">
  8892. ID of the property that denotes the document's last author
  8893. </member>
  8894. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_REVNUMBER">
  8895. ID of the property that denotes the document's revision number
  8896. </member>
  8897. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_EDITTIME">
  8898. ID of the property that denotes the document's edit time
  8899. </member>
  8900. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTPRINTED">
  8901. ID of the property that denotes the DateTime and time the document was
  8902. last printed
  8903. </member>
  8904. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_Create_DTM">
  8905. ID of the property that denotes the DateTime and time the document was
  8906. Created.
  8907. </member>
  8908. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTSAVE_DTM">
  8909. ID of the property that denotes the DateTime and time the document was
  8910. saved
  8911. </member>
  8912. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PAGECOUNT">
  8913. ID of the property that denotes the number of pages in the
  8914. document
  8915. </member>
  8916. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_WORDCOUNT">
  8917. ID of the property that denotes the number of words in the
  8918. document
  8919. </member>
  8920. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CHARCOUNT">
  8921. ID of the property that denotes the number of characters in the
  8922. document
  8923. </member>
  8924. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_THUMBNAIL">
  8925. ID of the property that denotes the document's thumbnail
  8926. </member>
  8927. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_APPNAME">
  8928. ID of the property that denotes the application that Created the
  8929. document
  8930. </member>
  8931. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SECURITY">
  8932. ID of the property that denotes whether Read/Write access To the
  8933. document is allowed or whether is should be opened as Read-only. It can
  8934. have the following values:
  8935. <table>
  8936. <tbody>
  8937. <tr>
  8938. <th>Value</th>
  8939. <th>Description</th>
  8940. </tr>
  8941. <tr>
  8942. <th>0</th>
  8943. <th>No restriction</th>
  8944. </tr>
  8945. <tr>
  8946. <th>2</th>
  8947. <th>Read-only recommended</th>
  8948. </tr>
  8949. <tr>
  8950. <th>4</th>
  8951. <th>Read-only enforced</th>
  8952. </tr>
  8953. </tbody>
  8954. </table>
  8955. </member>
  8956. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DICTIONARY">
  8957. The entry is a dictionary.
  8958. </member>
  8959. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CODEPAGE">
  8960. The entry denotes a code page.
  8961. </member>
  8962. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CATEGORY">
  8963. The entry is a string denoting the category the file belongs
  8964. To, e.g. review, memo, etc. This is useful To Find documents of
  8965. same type.
  8966. </member>
  8967. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PRESFORMAT">
  8968. TarGet format for power point presentation, e.g. 35mm,
  8969. printer, video etc.
  8970. </member>
  8971. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_BYTECOUNT">
  8972. Number of bytes.
  8973. </member>
  8974. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINECOUNT">
  8975. Number of lines.
  8976. </member>
  8977. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PARCOUNT">
  8978. Number of paragraphs.
  8979. </member>
  8980. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SLIDECOUNT">
  8981. Number of slides in a power point presentation.
  8982. </member>
  8983. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_NOTECOUNT">
  8984. Number of slides with notes.
  8985. </member>
  8986. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HIDDENCOUNT">
  8987. Number of hidden slides.
  8988. </member>
  8989. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MMCLIPCOUNT">
  8990. Number of multimedia clips, e.g. sound or video.
  8991. </member>
  8992. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SCALE">
  8993. This entry is Set To -1 when scaling of the thumbnail Is
  8994. desired. Otherwise the thumbnail should be cropped.
  8995. </member>
  8996. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HEADINGPAIR">
  8997. This entry denotes an internally used property. It is a
  8998. vector of variants consisting of pairs of a string (VT_LPSTR)
  8999. and a number (VT_I4). The string is a heading name, and the
  9000. number tells how many document parts are under that
  9001. heading.
  9002. </member>
  9003. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCPARTS">
  9004. This entry Contains the names of document parts (word: names
  9005. of the documents in the master document, excel: sheet names,
  9006. power point: slide titles, binder: document names).
  9007. </member>
  9008. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MANAGER">
  9009. This entry Contains the name of the project manager.
  9010. </member>
  9011. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMPANY">
  9012. This entry Contains the company name.
  9013. </member>
  9014. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINKSDIRTY">
  9015. If this entry is -1 the links are dirty and should be
  9016. re-evaluated.
  9017. </member>
  9018. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MAX">
  9019. The highest well-known property ID. Applications are free To use higher values for custom purposes.
  9020. </member>
  9021. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.summaryInformationProperties">
  9022. Contains the summary information property ID values and
  9023. associated strings. See the overall HPSF documentation for
  9024. details!
  9025. </member>
  9026. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.documentSummaryInformationProperties">
  9027. Contains the summary information property ID values and
  9028. associated strings. See the overall HPSF documentation for
  9029. details!
  9030. </member>
  9031. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Int32,System.Single)">
  9032. <summary>
  9033. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  9034. </summary>
  9035. <param name="initialCapacity">initialCapacity The initial capacity as defined for
  9036. {@link HashMap}</param>
  9037. <param name="loadFactor">The load factor as defined for {@link HashMap}</param>
  9038. </member>
  9039. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Collections.IDictionary)">
  9040. <summary>
  9041. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  9042. </summary>
  9043. <param name="map">The instance To be Created is backed by this map.</param>
  9044. </member>
  9045. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Put(System.Int64,System.String)">
  9046. <summary>
  9047. Puts a ID string for an ID into the {@link
  9048. PropertyIDMap}.
  9049. </summary>
  9050. <param name="id">The ID string.</param>
  9051. <param name="idString">The id string.</param>
  9052. <returns>As specified by the {@link java.util.Map} interface, this method
  9053. returns the previous value associated with the specified id</returns>
  9054. </member>
  9055. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Get(System.Int64)">
  9056. <summary>
  9057. Gets the ID string for an ID from the {@link
  9058. PropertyIDMap}.
  9059. </summary>
  9060. <param name="id">The ID.</param>
  9061. <returns>The ID string associated with id</returns>
  9062. </member>
  9063. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.SummaryInformationProperties">
  9064. <summary>
  9065. Gets the Summary Information properties singleton
  9066. </summary>
  9067. <returns></returns>
  9068. </member>
  9069. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.DocumentSummaryInformationProperties">
  9070. <summary>
  9071. Gets the Document Summary Information properties
  9072. singleton.
  9073. </summary>
  9074. <returns>The Document Summary Information properties singleton.</returns>
  9075. </member>
  9076. <member name="T:NPOI.HPSF.Wellknown.SectionIDMap">
  9077. <summary>
  9078. Maps section format IDs To {@link PropertyIDMap}s. It Is
  9079. initialized with two well-known section format IDs: those of the
  9080. <c>\005SummaryInformation</c> stream and the
  9081. <c>\005DocumentSummaryInformation</c> stream.
  9082. If you have a section format ID you can use it as a key To query
  9083. this map. If you Get a {@link PropertyIDMap} returned your section
  9084. is well-known and you can query the {@link PropertyIDMap} for PID
  9085. strings. If you Get back <c>null</c> you are on your own.
  9086. This {@link java.util.Map} expects the byte arrays of section format IDs
  9087. as keys. A key maps To a {@link PropertyIDMap} describing the
  9088. property IDs in sections with the specified section format ID.
  9089. @author Rainer Klute (klute@rainer-klute.de)
  9090. @since 2002-02-09
  9091. </summary>
  9092. </member>
  9093. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.UNDEFINED">
  9094. A property without a known name is described by this string.
  9095. </member>
  9096. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.SUMMARY_INFORMATION_ID">
  9097. The SummaryInformation's section's format ID.
  9098. </member>
  9099. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID1">
  9100. The DocumentSummaryInformation's first and second sections' format
  9101. ID.
  9102. </member>
  9103. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.defaultMap">
  9104. The default section ID map. It maps section format IDs To
  9105. {@link PropertyIDMap}s.
  9106. </member>
  9107. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetInstance">
  9108. <summary>
  9109. Returns the singleton instance of the default {@link
  9110. SectionIDMap}.
  9111. </summary>
  9112. <returns>The instance value</returns>
  9113. </member>
  9114. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetPIDString(System.Byte[],System.Int64)">
  9115. <summary>
  9116. Returns the property ID string that is associated with a
  9117. given property ID in a section format ID's namespace.
  9118. </summary>
  9119. <param name="sectionFormatID">Each section format ID has its own name
  9120. space of property ID strings and thus must be specified.</param>
  9121. <param name="pid">The property ID</param>
  9122. <returns>The well-known property ID string associated with the
  9123. property ID pid in the name space spanned by sectionFormatID If the pid
  9124. sectionFormatID combination is not well-known, the
  9125. string "[undefined]" is returned.
  9126. </returns>
  9127. </member>
  9128. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Byte[])">
  9129. <summary>
  9130. Returns the {@link PropertyIDMap} for a given section format
  9131. ID.
  9132. </summary>
  9133. <param name="sectionFormatID">The section format ID.</param>
  9134. <returns>the property ID map</returns>
  9135. </member>
  9136. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Object)">
  9137. <summary>
  9138. Returns the {@link PropertyIDMap} for a given section format
  9139. ID.
  9140. </summary>
  9141. <param name="sectionFormatID">A section format ID as a
  9142. <c>byte[]</c></param>
  9143. <returns>the property ID map</returns>
  9144. </member>
  9145. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Byte[],NPOI.HPSF.Wellknown.PropertyIDMap)">
  9146. <summary>
  9147. Associates a section format ID with a {@link
  9148. PropertyIDMap}.
  9149. </summary>
  9150. <param name="sectionFormatID">the section format ID</param>
  9151. <param name="propertyIDMap">The property ID map.</param>
  9152. <returns></returns>
  9153. </member>
  9154. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Object,System.Object)">
  9155. <summary>
  9156. Puts the specified key.
  9157. </summary>
  9158. <param name="key">This parameter remains undocumented since the method Is
  9159. deprecated.</param>
  9160. <param name="value">This parameter remains undocumented since the method Is
  9161. deprecated.</param>
  9162. <returns>The return value remains undocumented since the method Is
  9163. deprecated.</returns>
  9164. </member>
  9165. <member name="T:NPOI.HPSF.WritingNotSupportedException">
  9166. <summary>
  9167. This exception is thrown when trying To Write a (yet) unsupported variant
  9168. type.
  9169. @see ReadingNotSupportedException
  9170. @see UnsupportedVariantTypeException
  9171. @author Rainer Klute
  9172. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  9173. @since 2003-08-08
  9174. </summary>
  9175. </member>
  9176. <member name="M:NPOI.HPSF.WritingNotSupportedException.#ctor(System.Int64,System.Object)">
  9177. <summary>
  9178. Initializes a new instance of the <see cref="T:NPOI.HPSF.WritingNotSupportedException"/> class.
  9179. </summary>
  9180. <param name="variantType">The unsupported variant type.</param>
  9181. <param name="value">The value</param>
  9182. </member>
  9183. <member name="T:NPOI.HSSF.EventModel.IERFListener">
  9184. An ERFListener Is registered with the EventRecordFactory.
  9185. An ERFListener listens for Records coming from the stream
  9186. via the EventRecordFactory
  9187. @see EventRecordFactory
  9188. @author Andrew C. Oliver acoliver@apache.org
  9189. </member>
  9190. <member name="M:NPOI.HSSF.EventModel.IERFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  9191. Process a Record. This method Is called by the
  9192. EventRecordFactory when a record Is returned.
  9193. @return bool specifying whether the effort was a success.
  9194. </member>
  9195. <member name="T:NPOI.HSSF.EventModel.EventRecordFactory">
  9196. Event-based record factory. As opposed to RecordFactory
  9197. this refactored version throws record events as it comes
  9198. accross the records. I throws the "lazily" one record behind
  9199. to ensure that ContinueRecords are Processed first.
  9200. @author Andrew C. Oliver (acoliver@apache.org) - probably to blame for the bugs (so yank his chain on the list)
  9201. @author Marc Johnson (mjohnson at apache dot org) - methods taken from RecordFactory
  9202. @author Glen Stampoultzis (glens at apache.org) - methods taken from RecordFactory
  9203. @author Csaba Nagy (ncsaba at yahoo dot com)
  9204. </member>
  9205. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.#ctor(NPOI.HSSF.EventModel.IERFListener,System.Collections.ArrayList)">
  9206. Create an EventRecordFactory
  9207. @param abortable specifies whether the return from the listener
  9208. handler functions are obeyed. False means they are ignored. True
  9209. means the event loop exits on error.
  9210. </member>
  9211. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecord(NPOI.HSSF.Record.Record)">
  9212. sends the record event to all registered listeners.
  9213. @param record the record to be thrown.
  9214. @return <c>false</c> to abort. This aborts
  9215. out of the event loop should the listener return false
  9216. </member>
  9217. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecords(System.IO.Stream)">
  9218. Create an array of records from an input stream
  9219. @param in the InputStream from which the records will be
  9220. obtained
  9221. @exception RecordFormatException on error Processing the
  9222. InputStream
  9223. </member>
  9224. <member name="T:NPOI.HSSF.EventUserModel.AbortableHSSFListener">
  9225. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  9226. a listener supporting this interface and register it with the HSSFRequest (associating
  9227. it with Record SID's).
  9228. @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
  9229. @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  9230. @see org.apache.poi.hssf.eventusermodel.HSSFUserException
  9231. @author Carey Sublette (careysub@earthling.net)
  9232. </member>
  9233. <member name="T:NPOI.HSSF.EventUserModel.IHSSFListener">
  9234. <summary>
  9235. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  9236. a listener supporting this interface and register it with the HSSFRequest (associating
  9237. it with Record SID's).
  9238. @author acoliver@apache.org
  9239. </summary>
  9240. </member>
  9241. <member name="M:NPOI.HSSF.EventUserModel.IHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  9242. <summary>
  9243. Process an HSSF Record. Called when a record occurs in an HSSF file.
  9244. </summary>
  9245. <param name="record">The record.</param>
  9246. </member>
  9247. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  9248. This method, inherited from HSSFListener Is implemented as a stub.
  9249. It Is never called by HSSFEventFActory or HSSFRequest.
  9250. </member>
  9251. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.AbortableProcessRecord(NPOI.HSSF.Record.Record)">
  9252. Process an HSSF Record. Called when a record occurs in an HSSF file.
  9253. Provides two options for halting the Processing of the HSSF file.
  9254. The return value provides a means of non-error termination with a
  9255. user-defined result code. A value of zero must be returned to
  9256. continue Processing, any other value will halt Processing by
  9257. <c>HSSFEventFactory</c> with the code being passed back by
  9258. its abortable Process events methods.
  9259. Error termination can be done by throwing the HSSFUserException.
  9260. Note that HSSFEventFactory will not call the inherited Process
  9261. @return result code of zero for continued Processing.
  9262. @throws HSSFUserException User code can throw this to abort
  9263. file Processing by HSSFEventFactory and return diagnostic information.
  9264. </member>
  9265. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord">
  9266. A dummy record to indicate that we've now had the last
  9267. cell record for this row.
  9268. </member>
  9269. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.Row">
  9270. Returns the (0 based) number of the row we are
  9271. currently working on.
  9272. </member>
  9273. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.LastColumnNumber">
  9274. Returns the (0 based) number of the last column
  9275. seen for this row. You should have alReady been
  9276. called with that record.
  9277. This Is -1 in the case of there being no columns
  9278. for the row.
  9279. </member>
  9280. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingCellDummyRecord">
  9281. A dummy record for when we're missing a cell in a row,
  9282. but still want to trigger something
  9283. </member>
  9284. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingRowDummyRecord">
  9285. A dummy record for when we're missing a row, but still
  9286. want to trigger something
  9287. </member>
  9288. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder">
  9289. <summary>
  9290. When working with the EventUserModel, if you want to
  9291. Process formulas, you need an instance of
  9292. Workbook to pass to a HSSFWorkbook,
  9293. to finally give to HSSFFormulaParser,
  9294. and this will build you stub ones.
  9295. Since you're working with the EventUserModel, you
  9296. wouldn't want to Get a full Workbook and
  9297. HSSFWorkbook, as they would eat too much memory.
  9298. Instead, you should collect a few key records as they
  9299. go past, then call this once you have them to build a
  9300. stub Workbook, and from that a stub
  9301. HSSFWorkbook, to use with the HSSFFormulaParser.
  9302. The records you should collect are:
  9303. ExternSheetRecord
  9304. BoundSheetRecord
  9305. You should probably also collect SSTRecord,
  9306. but it's not required to pass this in.
  9307. To help, this class includes a HSSFListener wrapper
  9308. that will do the collecting for you.
  9309. </summary>
  9310. </member>
  9311. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubHSSFWorkbook(NPOI.HSSF.Model.InternalWorkbook)">
  9312. <summary>
  9313. Wraps up your stub Workbook as a stub HSSFWorkbook, ready for passing to HSSFFormulaParser
  9314. </summary>
  9315. <param name="workbook">The stub workbook.</param>
  9316. <returns></returns>
  9317. </member>
  9318. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[],NPOI.HSSF.Record.SSTRecord)">
  9319. <summary>
  9320. Creates a stub Workbook from the supplied records,
  9321. suitable for use with the {@link HSSFFormulaParser}
  9322. </summary>
  9323. <param name="externs">The ExternSheetRecords in your file</param>
  9324. <param name="bounds">The BoundSheetRecords in your file</param>
  9325. <param name="sst">TThe SSTRecord in your file.</param>
  9326. <returns>A stub Workbook suitable for use with HSSFFormulaParser</returns>
  9327. </member>
  9328. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[])">
  9329. <summary>
  9330. Creates a stub workbook from the supplied records,
  9331. suitable for use with the HSSFFormulaParser
  9332. </summary>
  9333. <param name="externs">The ExternSheetRecords in your file</param>
  9334. <param name="bounds">A stub Workbook suitable for use with HSSFFormulaParser</param>
  9335. <returns>A stub Workbook suitable for use with {@link HSSFFormulaParser}</returns>
  9336. </member>
  9337. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener">
  9338. <summary>
  9339. A wrapping HSSFListener which will collect
  9340. BoundSheetRecords and {@link ExternSheetRecord}s as
  9341. they go past, so you can Create a Stub {@link Workbook} from
  9342. them once required.
  9343. </summary>
  9344. </member>
  9345. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  9346. <summary>
  9347. Initializes a new instance of the <see cref="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener"/> class.
  9348. </summary>
  9349. <param name="childListener">The child listener.</param>
  9350. </member>
  9351. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetBoundSheetRecords">
  9352. <summary>
  9353. Gets the bound sheet records.
  9354. </summary>
  9355. <returns></returns>
  9356. </member>
  9357. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetExternSheetRecords">
  9358. <summary>
  9359. Gets the extern sheet records.
  9360. </summary>
  9361. <returns></returns>
  9362. </member>
  9363. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetSSTRecord">
  9364. <summary>
  9365. Gets the SST record.
  9366. </summary>
  9367. <returns></returns>
  9368. </member>
  9369. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubHSSFWorkbook">
  9370. <summary>
  9371. Gets the stub HSSF workbook.
  9372. </summary>
  9373. <returns></returns>
  9374. </member>
  9375. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubWorkbook">
  9376. <summary>
  9377. Gets the stub workbook.
  9378. </summary>
  9379. <returns></returns>
  9380. </member>
  9381. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  9382. <summary>
  9383. Process this record ourselves, and then
  9384. pass it on to our child listener
  9385. </summary>
  9386. <param name="record">The record.</param>
  9387. </member>
  9388. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  9389. <summary>
  9390. Process the record ourselves, but do not
  9391. pass it on to the child Listener.
  9392. </summary>
  9393. <param name="record">The record.</param>
  9394. </member>
  9395. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.StubHSSFWorkbook">
  9396. Let us at the {@link Workbook} constructor on
  9397. {@link HSSFWorkbook}
  9398. </member>
  9399. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook">
  9400. <summary>
  9401. High level representation of a workbook. This is the first object most users
  9402. will construct whether they are reading or writing a workbook. It is also the
  9403. top level object for creating new sheets/etc.
  9404. </summary>
  9405. @author Andrew C. Oliver (acoliver at apache dot org)
  9406. @author Glen Stampoultzis (glens at apache.org)
  9407. @author Shawn Laubach (slaubach at apache dot org)
  9408. </member>
  9409. <member name="T:NPOI.SS.UserModel.IWorkbook">
  9410. <summary>
  9411. High level interface of a Excel workbook. This is the first object most users
  9412. will construct whether they are reading or writing a workbook. It is also the
  9413. top level object for creating new sheets/etc.
  9414. This interface is shared between the implementation specific to xls and xlsx.
  9415. This way it is possible to access Excel workbooks stored in both formats.
  9416. </summary>
  9417. </member>
  9418. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetOrder(System.String,System.Int32)">
  9419. <summary>
  9420. Sets the order of appearance for a given sheet.
  9421. </summary>
  9422. <param name="sheetname">the name of the sheet to reorder</param>
  9423. <param name="pos">the position that we want to insert the sheet into (0 based)</param>
  9424. </member>
  9425. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSelectedTab(System.Int32)">
  9426. <summary>
  9427. Sets the tab whose data is actually seen when the sheet is opened.
  9428. This may be different from the "selected sheet" since excel seems to
  9429. allow you to show the data of one sheet when another is seen "selected"
  9430. in the tabs (at the bottom).
  9431. </summary>
  9432. <param name="index">the index of the sheet to select (0 based)</param>
  9433. </member>
  9434. <member name="M:NPOI.SS.UserModel.IWorkbook.SetActiveSheet(System.Int32)">
  9435. <summary>
  9436. set the active sheet. The active sheet is is the sheet
  9437. which is currently displayed when the workbook is viewed in Excel.
  9438. </summary>
  9439. <param name="sheetIndex">index of the active sheet (0-based)</param>
  9440. </member>
  9441. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetName(System.Int32)">
  9442. <summary>
  9443. Set the sheet name
  9444. </summary>
  9445. <param name="sheet">sheet number (0 based)</param>
  9446. <returns>Sheet name</returns>
  9447. </member>
  9448. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetName(System.Int32,System.String)">
  9449. <summary>
  9450. Set the sheet name.
  9451. </summary>
  9452. <param name="sheet">sheet number (0 based)</param>
  9453. <param name="name">sheet name</param>
  9454. </member>
  9455. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(System.String)">
  9456. <summary>
  9457. Returns the index of the sheet by its name
  9458. </summary>
  9459. <param name="name">the sheet name</param>
  9460. <returns>index of the sheet (0 based)</returns>
  9461. </member>
  9462. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  9463. <summary>
  9464. Returns the index of the given sheet
  9465. </summary>
  9466. <param name="sheet">the sheet to look up</param>
  9467. <returns>index of the sheet (0 based)</returns>
  9468. </member>
  9469. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet">
  9470. <summary>
  9471. Sreate an Sheet for this Workbook, Adds it to the sheets and returns
  9472. the high level representation. Use this to create new sheets.
  9473. </summary>
  9474. <returns></returns>
  9475. </member>
  9476. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet(System.String)">
  9477. <summary>
  9478. Create an Sheet for this Workbook, Adds it to the sheets and returns
  9479. the high level representation. Use this to create new sheets.
  9480. </summary>
  9481. <param name="sheetname">sheetname to set for the sheet.</param>
  9482. <returns>Sheet representing the new sheet.</returns>
  9483. </member>
  9484. <member name="M:NPOI.SS.UserModel.IWorkbook.CloneSheet(System.Int32)">
  9485. <summary>
  9486. Create an Sheet from an existing sheet in the Workbook.
  9487. </summary>
  9488. <param name="sheetNum"></param>
  9489. <returns></returns>
  9490. </member>
  9491. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetAt(System.Int32)">
  9492. <summary>
  9493. Get the Sheet object at the given index.
  9494. </summary>
  9495. <param name="index">index of the sheet number (0-based physical &amp; logical)</param>
  9496. <returns>Sheet at the provided index</returns>
  9497. </member>
  9498. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheet(System.String)">
  9499. <summary>
  9500. Get sheet with the given name
  9501. </summary>
  9502. <param name="name">name of the sheet</param>
  9503. <returns>Sheet with the name provided or null if it does not exist</returns>
  9504. </member>
  9505. <member name="M:NPOI.SS.UserModel.IWorkbook.GetEnumerator">
  9506. <summary>
  9507. Support foreach ISheet, e.g.
  9508. HSSFWorkbook workbook = new HSSFWorkbook();
  9509. foreach(ISheet sheet in workbook) ...
  9510. </summary>
  9511. <returns>Enumeration of all the sheets of this workbook</returns>
  9512. </member>
  9513. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveSheetAt(System.Int32)">
  9514. <summary>
  9515. Removes sheet at the given index
  9516. </summary>
  9517. <param name="index"></param>
  9518. </member>
  9519. <member name="M:NPOI.SS.UserModel.IWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  9520. To set just repeating columns:
  9521. workbook.SetRepeatingRowsAndColumns(0,0,1,-1-1);
  9522. To set just repeating rows:
  9523. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  9524. To remove all repeating rows and columns for a sheet.
  9525. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  9526. <summary>
  9527. Sets the repeating rows and columns for a sheet (as found in
  9528. File->PageSetup->Sheet). This is function is included in the workbook
  9529. because it Creates/modifies name records which are stored at the
  9530. workbook level.
  9531. </summary>
  9532. <param name="sheetIndex">0 based index to sheet.</param>
  9533. <param name="startColumn">0 based start of repeating columns.</param>
  9534. <param name="endColumn">0 based end of repeating columns.</param>
  9535. <param name="startRow">0 based start of repeating rows.</param>
  9536. <param name="endRow">0 based end of repeating rows.</param>
  9537. </member>
  9538. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateFont">
  9539. <summary>
  9540. Create a new Font and add it to the workbook's font table
  9541. </summary>
  9542. <returns></returns>
  9543. </member>
  9544. <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)">
  9545. <summary>
  9546. Finds a font that matches the one with the supplied attributes
  9547. </summary>
  9548. <param name="boldWeight"></param>
  9549. <param name="color"></param>
  9550. <param name="fontHeight"></param>
  9551. <param name="name"></param>
  9552. <param name="italic"></param>
  9553. <param name="strikeout"></param>
  9554. <param name="typeOffset"></param>
  9555. <param name="underline"></param>
  9556. <returns>the font with the matched attributes or null</returns>
  9557. </member>
  9558. <member name="M:NPOI.SS.UserModel.IWorkbook.GetFontAt(System.Int16)">
  9559. <summary>
  9560. Get the font at the given index number
  9561. </summary>
  9562. <param name="idx">index number (0-based)</param>
  9563. <returns>font at the index</returns>
  9564. </member>
  9565. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateCellStyle">
  9566. <summary>
  9567. Create a new Cell style and add it to the workbook's style table
  9568. </summary>
  9569. <returns>the new Cell Style object</returns>
  9570. </member>
  9571. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCellStyleAt(System.Int16)">
  9572. <summary>
  9573. Get the cell style object at the given index
  9574. </summary>
  9575. <param name="idx">index within the set of styles (0-based)</param>
  9576. <returns>CellStyle object at the index</returns>
  9577. </member>
  9578. <member name="M:NPOI.SS.UserModel.IWorkbook.Write(System.IO.Stream)">
  9579. <summary>
  9580. Write out this workbook to an OutPutstream.
  9581. </summary>
  9582. <param name="stream">the stream you wish to write to</param>
  9583. </member>
  9584. <member name="M:NPOI.SS.UserModel.IWorkbook.GetName(System.String)">
  9585. <summary>
  9586. the defined name with the specified name.
  9587. </summary>
  9588. <param name="name">the name of the defined name</param>
  9589. <returns>the defined name with the specified name. null if not found</returns>
  9590. </member>
  9591. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameAt(System.Int32)">
  9592. <summary>
  9593. the defined name at the specified index
  9594. </summary>
  9595. <param name="nameIndex">position of the named range (0-based)</param>
  9596. <returns></returns>
  9597. </member>
  9598. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateName">
  9599. <summary>
  9600. Creates a new (unInitialised) defined name in this workbook
  9601. </summary>
  9602. <returns>new defined name object</returns>
  9603. </member>
  9604. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameIndex(System.String)">
  9605. <summary>
  9606. Gets the defined name index by name
  9607. </summary>
  9608. <param name="name">the name of the defined name</param>
  9609. <returns>zero based index of the defined name.</returns>
  9610. </member>
  9611. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.Int32)">
  9612. <summary>
  9613. Remove the defined name at the specified index
  9614. </summary>
  9615. <param name="index">named range index (0 based)</param>
  9616. </member>
  9617. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.String)">
  9618. <summary>
  9619. Remove a defined name by name
  9620. </summary>
  9621. <param name="name">the name of the defined name</param>
  9622. </member>
  9623. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.String)">
  9624. <summary>
  9625. Sets the printarea for the sheet provided
  9626. </summary>
  9627. <param name="sheetIndex">Zero-based sheet index</param>
  9628. <param name="reference">Valid name Reference for the Print Area</param>
  9629. </member>
  9630. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  9631. <summary>
  9632. Sets the printarea for the sheet provided
  9633. </summary>
  9634. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  9635. <param name="startColumn">Column to begin printarea</param>
  9636. <param name="endColumn">Column to end the printarea</param>
  9637. <param name="startRow">Row to begin the printarea</param>
  9638. <param name="endRow">Row to end the printarea</param>
  9639. </member>
  9640. <member name="M:NPOI.SS.UserModel.IWorkbook.GetPrintArea(System.Int32)">
  9641. <summary>
  9642. Retrieves the reference for the printarea of the specified sheet,
  9643. the sheet name is Appended to the reference even if it was not specified.
  9644. </summary>
  9645. <param name="sheetIndex">Zero-based sheet index</param>
  9646. <returns>Null if no print area has been defined</returns>
  9647. </member>
  9648. <member name="M:NPOI.SS.UserModel.IWorkbook.RemovePrintArea(System.Int32)">
  9649. <summary>
  9650. Delete the printarea for the sheet specified
  9651. </summary>
  9652. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  9653. </member>
  9654. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateDataFormat">
  9655. <summary>
  9656. Returns the instance of DataFormat for this workbook.
  9657. </summary>
  9658. <returns>the DataFormat object</returns>
  9659. </member>
  9660. <member name="M:NPOI.SS.UserModel.IWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  9661. <summary>
  9662. Adds a picture to the workbook.
  9663. </summary>
  9664. <param name="pictureData">The bytes of the picture</param>
  9665. <param name="format">The format of the picture.</param>
  9666. <returns>the index to this picture (1 based).</returns>
  9667. </member>
  9668. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllPictures">
  9669. <summary>
  9670. Gets all pictures from the Workbook.
  9671. </summary>
  9672. <returns>the list of pictures (a list of link PictureData objects.)</returns>
  9673. </member>
  9674. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCreationHelper">
  9675. <summary>
  9676. Return an object that handles instantiating concrete classes of
  9677. the various instances one needs for HSSF and XSSF.
  9678. </summary>
  9679. <returns></returns>
  9680. </member>
  9681. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetHidden(System.Int32)">
  9682. <summary>
  9683. Check whether a sheet is hidden.
  9684. </summary>
  9685. <param name="sheetIx">number of sheet</param>
  9686. <returns>true if sheet is hidden</returns>
  9687. </member>
  9688. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetVeryHidden(System.Int32)">
  9689. Check whether a sheet is very hidden.
  9690. <p>
  9691. This is different from the normal hidden status
  9692. ({@link #isSheetHidden(int)})
  9693. </p>
  9694. @param sheetIx sheet index to check
  9695. @return <code>true</code> if sheet is very hidden
  9696. </member>
  9697. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  9698. Hide or unhide a sheet
  9699. @param sheetIx the sheet index (0-based)
  9700. @param hidden True to mark the sheet as hidden, false otherwise
  9701. </member>
  9702. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  9703. Hide or unhide a sheet.
  9704. <pre>
  9705. 0 = not hidden
  9706. 1 = hidden
  9707. 2 = very hidden.
  9708. </pre>
  9709. @param sheetIx The sheet number
  9710. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  9711. </member>
  9712. <member name="M:NPOI.SS.UserModel.IWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  9713. <summary>
  9714. Register a new toolpack in this workbook.
  9715. </summary>
  9716. <param name="toopack">the toolpack to register</param>
  9717. </member>
  9718. <member name="P:NPOI.SS.UserModel.IWorkbook.ActiveSheetIndex">
  9719. <summary>
  9720. get the active sheet. The active sheet is is the sheet
  9721. which is currently displayed when the workbook is viewed in Excel.
  9722. </summary>
  9723. </member>
  9724. <member name="P:NPOI.SS.UserModel.IWorkbook.FirstVisibleTab">
  9725. <summary>
  9726. Gets the first tab that is displayed in the list of tabs in excel.
  9727. </summary>
  9728. </member>
  9729. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfSheets">
  9730. <summary>
  9731. Get the number of spreadsheets in the workbook
  9732. </summary>
  9733. </member>
  9734. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfFonts">
  9735. <summary>
  9736. Get the number of fonts in the font table
  9737. </summary>
  9738. </member>
  9739. <member name="P:NPOI.SS.UserModel.IWorkbook.NumCellStyles">
  9740. <summary>
  9741. Get the number of styles the workbook Contains
  9742. </summary>
  9743. </member>
  9744. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfNames">
  9745. <summary>
  9746. the total number of defined names in this workbook
  9747. </summary>
  9748. </member>
  9749. <member name="P:NPOI.SS.UserModel.IWorkbook.MissingCellPolicy">
  9750. <summary>
  9751. Retrieves the current policy on what to do when getting missing or blank cells from a row.
  9752. </summary>
  9753. </member>
  9754. <member name="P:NPOI.SS.UserModel.IWorkbook.IsHidden">
  9755. <summary>
  9756. if this workbook is not visible in the GUI
  9757. </summary>
  9758. </member>
  9759. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.MAX_STYLES">
  9760. The maximum number of cell styles in a .xls workbook.
  9761. The 'official' limit is 4,000, but POI allows a slightly larger number.
  9762. This extra delta takes into account built-in styles that are automatically
  9763. created for new workbooks
  9764. See http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx
  9765. </member>
  9766. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.INITIAL_CAPACITY">
  9767. used for compile-time performance/memory optimization. This determines the
  9768. initial capacity for the sheet collection. Its currently Set to 3.
  9769. Changing it in this release will decrease performance
  9770. since you're never allowed to have more or less than three sheets!
  9771. </member>
  9772. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_COMPRESSED_UNICODE">
  9773. @deprecated POI will now properly handle Unicode strings without
  9774. forceing an encoding
  9775. </member>
  9776. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_UTF_16">
  9777. @deprecated POI will now properly handle Unicode strings without
  9778. forceing an encoding
  9779. </member>
  9780. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.workbook">
  9781. this Is the reference to the low level Workbook object
  9782. </member>
  9783. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._sheets">
  9784. this holds the HSSFSheet objects attached to this workbook
  9785. </member>
  9786. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.names">
  9787. this holds the HSSFName objects attached to this workbook
  9788. </member>
  9789. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.preserveNodes">
  9790. holds whether or not to preserve other nodes in the POIFS. Used
  9791. for macros and embedded objects.
  9792. </member>
  9793. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.formatter">
  9794. Used to keep track of the data formatter so that all
  9795. CreateDataFormatter calls return the same one for a given
  9796. book. This Ensures that updates from one places Is visible
  9797. someplace else.
  9798. </member>
  9799. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.fonts">
  9800. this holds the HSSFFont objects attached to this workbook.
  9801. We only create these from the low level records as required.
  9802. </member>
  9803. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor">
  9804. <summary>
  9805. Creates new HSSFWorkbook from scratch (start here!)
  9806. </summary>
  9807. </member>
  9808. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  9809. <summary>
  9810. given a POI POIFSFileSystem object, Read in its Workbook and populate the high and
  9811. low level models. If you're Reading in a workbook...start here.
  9812. </summary>
  9813. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  9814. <param name="preserveNodes">whether to preseve other nodes, such as
  9815. macros. This takes more memory, so only say yes if you
  9816. need to. If Set, will store all of the POIFSFileSystem
  9817. in memory</param>
  9818. </member>
  9819. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.WORKBOOK_DIR_ENTRY_NAMES">
  9820. Normally, the Workbook will be in a POIFS Stream
  9821. called "Workbook". However, some weird XLS generators use "WORKBOOK"
  9822. </member>
  9823. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  9824. <summary>
  9825. given a POI POIFSFileSystem object, and a specific directory
  9826. within it, Read in its Workbook and populate the high and
  9827. low level models. If you're Reading in a workbook...start here.
  9828. </summary>
  9829. <param name="directory">the POI filesystem directory to Process from</param>
  9830. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  9831. <param name="preserveNodes">whether to preseve other nodes, such as
  9832. macros. This takes more memory, so only say yes if you
  9833. need to. If Set, will store all of the POIFSFileSystem
  9834. in memory</param>
  9835. </member>
  9836. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)">
  9837. given a POI POIFSFileSystem object, and a specific directory
  9838. within it, read in its Workbook and populate the high and
  9839. low level models. If you're reading in a workbook...start here.
  9840. @param directory the POI filesystem directory to process from
  9841. @param preserveNodes whether to preseve other nodes, such as
  9842. macros. This takes more memory, so only say yes if you
  9843. need to. If set, will store all of the POIFSFileSystem
  9844. in memory
  9845. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  9846. @exception IOException if the stream cannot be read
  9847. </member>
  9848. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(System.IO.Stream,System.Boolean)">
  9849. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your
  9850. inputstream.
  9851. @param s the POI filesystem that Contains the Workbook stream.
  9852. @param preserveNodes whether to preseve other nodes, such as
  9853. macros. This takes more memory, so only say yes if you
  9854. need to.
  9855. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  9856. @see #HSSFWorkbook(POIFSFileSystem)
  9857. @exception IOException if the stream cannot be Read
  9858. </member>
  9859. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPropertiesFromWorkbook(NPOI.HSSF.Model.InternalWorkbook)">
  9860. used internally to Set the workbook properties.
  9861. </member>
  9862. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ConvertLabelRecords(System.Collections.IList,System.Int32)">
  9863. <summary>
  9864. This is basically a kludge to deal with the now obsolete Label records. If
  9865. you have to read in a sheet that contains Label records, be aware that the rest
  9866. of the API doesn't deal with them, the low level structure only provides Read-only
  9867. semi-immutable structures (the Sets are there for interface conformance with NO
  9868. impelmentation). In short, you need to call this function passing it a reference
  9869. to the Workbook object. All labels will be converted to LabelSST records and their
  9870. contained strings will be written to the Shared String tabel (SSTRecord) within
  9871. the Workbook.
  9872. </summary>
  9873. <param name="records">The records.</param>
  9874. <param name="offset">The offset.</param>
  9875. </member>
  9876. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  9877. <summary>
  9878. Sets the order of appearance for a given sheet.
  9879. </summary>
  9880. <param name="sheetname">the name of the sheet to reorder</param>
  9881. <param name="pos">the position that we want to Insert the sheet into (0 based)</param>
  9882. </member>
  9883. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ValidateSheetIndex(System.Int32)">
  9884. <summary>
  9885. Validates the index of the sheet.
  9886. </summary>
  9887. <param name="index">The index.</param>
  9888. </member>
  9889. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.InsertChartRecord">
  9890. Test only. Do not use
  9891. </member>
  9892. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTab(System.Int32)">
  9893. <summary>
  9894. Selects a single sheet. This may be different to
  9895. the 'active' sheet (which Is the sheet with focus).
  9896. </summary>
  9897. <param name="index">The index.</param>
  9898. </member>
  9899. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Int32[])">
  9900. <summary>
  9901. Sets the selected tabs.
  9902. </summary>
  9903. <param name="indexes">The indexes.</param>
  9904. </member>
  9905. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetName(System.Int32,System.String)">
  9906. <summary>
  9907. Set the sheet name.
  9908. </summary>
  9909. <param name="sheetIx">The sheet number(0 based).</param>
  9910. <param name="name">The name.</param>
  9911. </member>
  9912. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetName(System.Int32)">
  9913. <summary>
  9914. Get the sheet name
  9915. </summary>
  9916. <param name="sheetIx">The sheet index.</param>
  9917. <returns>Sheet name</returns>
  9918. </member>
  9919. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetHidden(System.Int32)">
  9920. <summary>
  9921. Check whether a sheet is hidden
  9922. </summary>
  9923. <param name="sheetIx">The sheet index.</param>
  9924. <returns>
  9925. <c>true</c> if sheet is hidden; otherwise, <c>false</c>.
  9926. </returns>
  9927. </member>
  9928. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  9929. <summary>
  9930. Check whether a sheet is very hidden.
  9931. This is different from the normal
  9932. hidden status
  9933. </summary>
  9934. <param name="sheetIx">The sheet index.</param>
  9935. <returns>
  9936. <c>true</c> if sheet is very hidden; otherwise, <c>false</c>.
  9937. </returns>
  9938. </member>
  9939. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  9940. <summary>
  9941. Hide or Unhide a sheet
  9942. </summary>
  9943. <param name="sheetIx">The sheet index</param>
  9944. <param name="hidden">True to mark the sheet as hidden, false otherwise</param>
  9945. </member>
  9946. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  9947. <summary>
  9948. Hide or unhide a sheet.
  9949. </summary>
  9950. <param name="sheetIx">The sheet number</param>
  9951. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  9952. </member>
  9953. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(System.String)">
  9954. <summary>
  9955. Returns the index of the sheet by his name
  9956. </summary>
  9957. <param name="name">the sheet name</param>
  9958. <returns>index of the sheet (0 based)</returns>
  9959. </member>
  9960. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  9961. <summary>
  9962. Returns the index of the given sheet
  9963. </summary>
  9964. <param name="sheet">the sheet to look up</param>
  9965. <returns>index of the sheet (0 based).-1
  9966. if not found </returns>
  9967. </member>
  9968. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetExternalSheetIndex(System.Int32)">
  9969. <summary>
  9970. Returns the external sheet index of the sheet
  9971. with the given internal index, creating one
  9972. if needed.
  9973. Used by some of the more obscure formula and
  9974. named range things.
  9975. </summary>
  9976. <param name="internalSheetIndex">Index of the internal sheet.</param>
  9977. <returns></returns>
  9978. </member>
  9979. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet">
  9980. <summary>
  9981. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and returns
  9982. the high level representation. Use this to Create new sheets.
  9983. </summary>
  9984. <returns>HSSFSheet representing the new sheet.</returns>
  9985. </member>
  9986. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CloneSheet(System.Int32)">
  9987. <summary>
  9988. Create an HSSFSheet from an existing sheet in the HSSFWorkbook.
  9989. </summary>
  9990. <param name="sheetIndex">the sheet index</param>
  9991. <returns>HSSFSheet representing the Cloned sheet.</returns>
  9992. </member>
  9993. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetUniqueSheetName(System.String)">
  9994. <summary>
  9995. Gets the name of the unique sheet.
  9996. </summary>
  9997. <param name="srcName">Name of the SRC.</param>
  9998. <returns></returns>
  9999. </member>
  10000. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet(System.String)">
  10001. <summary>
  10002. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and
  10003. returns the high level representation. Use this to Create new sheets.
  10004. </summary>
  10005. <param name="sheetname">sheetname to set for the sheet.</param>
  10006. <returns>HSSFSheet representing the new sheet.</returns>
  10007. </member>
  10008. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheets">
  10009. <summary>
  10010. Gets the sheets.
  10011. </summary>
  10012. <returns></returns>
  10013. </member>
  10014. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetAt(System.Int32)">
  10015. <summary>
  10016. Get the HSSFSheet object at the given index.
  10017. </summary>
  10018. <param name="index">index of the sheet number (0-based)</param>
  10019. <returns>HSSFSheet at the provided index</returns>
  10020. </member>
  10021. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheet(System.String)">
  10022. <summary>
  10023. Get sheet with the given name (case insensitive match)
  10024. </summary>
  10025. <param name="name">name of the sheet</param>
  10026. <returns>HSSFSheet with the name provided or null if it does not exist</returns>
  10027. </member>
  10028. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveSheetAt(System.Int32)">
  10029. <summary>
  10030. Removes sheet at the given index.
  10031. </summary>
  10032. <param name="index">index of the sheet (0-based)</param>
  10033. <remarks>
  10034. Care must be taken if the Removed sheet Is the currently active or only selected sheet in
  10035. the workbook. There are a few situations when Excel must have a selection and/or active
  10036. sheet. (For example when printing - see Bug 40414).
  10037. This method makes sure that if the Removed sheet was active, another sheet will become
  10038. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  10039. sheet will become selected. The newly active/selected sheet will have the same index, or
  10040. one less if the Removed sheet was the last in the workbook.
  10041. </remarks>
  10042. </member>
  10043. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  10044. <summary>
  10045. Sets the repeating rows and columns for a sheet (as found in
  10046. File-&gt;PageSetup-&gt;Sheet). This Is function Is included in the workbook
  10047. because it Creates/modifies name records which are stored at the
  10048. workbook level.
  10049. </summary>
  10050. <param name="sheetIndex">0 based index to sheet.</param>
  10051. <param name="startColumn">0 based start of repeating columns.</param>
  10052. <param name="endColumn">0 based end of repeating columns.</param>
  10053. <param name="startRow">0 based start of repeating rows.</param>
  10054. <param name="endRow">0 based end of repeating rows.</param>
  10055. <example>
  10056. To set just repeating columns:
  10057. workbook.SetRepeatingRowsAndColumns(0,0,1,-1-1);
  10058. To set just repeating rows:
  10059. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  10060. To remove all repeating rows and columns for a sheet.
  10061. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  10062. </example>
  10063. </member>
  10064. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateFont">
  10065. <summary>
  10066. Create a new Font and Add it to the workbook's font table
  10067. </summary>
  10068. <returns>new font object</returns>
  10069. </member>
  10070. <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)">
  10071. <summary>
  10072. Finds a font that matches the one with the supplied attributes
  10073. </summary>
  10074. <param name="boldWeight">The bold weight.</param>
  10075. <param name="color">The color.</param>
  10076. <param name="fontHeight">Height of the font.</param>
  10077. <param name="name">The name.</param>
  10078. <param name="italic">if set to <c>true</c> [italic].</param>
  10079. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  10080. <param name="typeOffset">The type offset.</param>
  10081. <param name="Underline">The underline.</param>
  10082. <returns></returns>
  10083. </member>
  10084. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetFontAt(System.Int16)">
  10085. <summary>
  10086. Get the font at the given index number
  10087. </summary>
  10088. <param name="idx">The index number</param>
  10089. <returns>HSSFFont at the index</returns>
  10090. </member>
  10091. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResetFontCache">
  10092. <summary>
  10093. Reset the fonts cache, causing all new calls
  10094. to getFontAt() to create new objects.
  10095. Should only be called after deleting fonts,
  10096. and that's not something you should normally do
  10097. </summary>
  10098. </member>
  10099. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateCellStyle">
  10100. <summary>
  10101. Create a new Cell style and Add it to the workbook's style table
  10102. </summary>
  10103. <returns>the new Cell Style object</returns>
  10104. </member>
  10105. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetCellStyleAt(System.Int16)">
  10106. <summary>
  10107. Get the cell style object at the given index
  10108. </summary>
  10109. <param name="idx">index within the Set of styles</param>
  10110. <returns>HSSFCellStyle object at the index</returns>
  10111. </member>
  10112. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.Stream)">
  10113. <summary>
  10114. Write out this workbook to an Outputstream. Constructs
  10115. a new POI POIFSFileSystem, passes in the workbook binary representation and
  10116. Writes it out.
  10117. </summary>
  10118. <param name="stream">the java OutputStream you wish to Write the XLS to</param>
  10119. </member>
  10120. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetBytes">
  10121. <summary>
  10122. Get the bytes of just the HSSF portions of the XLS file.
  10123. Use this to construct a POI POIFSFileSystem yourself.
  10124. </summary>
  10125. <returns>byte[] array containing the binary representation of this workbook and all contained
  10126. sheets, rows, cells, etc.</returns>
  10127. </member>
  10128. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._udfFinder">
  10129. The locator of user-defined functions.
  10130. By default includes functions from the Excel Analysis Toolpack
  10131. </member>
  10132. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  10133. Register a new toolpack in this workbook.
  10134. @param toopack the toolpack to register
  10135. </member>
  10136. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameAt(System.Int32)">
  10137. <summary>
  10138. Gets the Named range
  10139. </summary>
  10140. <param name="index">position of the named range</param>
  10141. <returns>named range high level</returns>
  10142. </member>
  10143. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameName(System.Int32)">
  10144. <summary>
  10145. Gets the named range name
  10146. </summary>
  10147. <param name="index">the named range index (0 based)</param>
  10148. <returns>named range name</returns>
  10149. </member>
  10150. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  10151. <summary>
  10152. TODO - make this less cryptic / move elsewhere
  10153. </summary>
  10154. <param name="reFindex">Index to REF entry in EXTERNSHEET record in the Link Table</param>
  10155. <param name="definedNameIndex">zero-based to DEFINEDNAME or EXTERNALNAME record</param>
  10156. <returns>the string representation of the defined or external name</returns>
  10157. </member>
  10158. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.String)">
  10159. <summary>
  10160. Sets the printarea for the sheet provided
  10161. i.e. Reference = $A$1:$B$2
  10162. </summary>
  10163. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  10164. <param name="reference">Valid name Reference for the Print Area</param>
  10165. </member>
  10166. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  10167. <summary>
  10168. Sets the print area.
  10169. </summary>
  10170. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  10171. <param name="startColumn">Column to begin printarea</param>
  10172. <param name="endColumn">Column to end the printarea</param>
  10173. <param name="startRow">Row to begin the printarea</param>
  10174. <param name="endRow">Row to end the printarea</param>
  10175. </member>
  10176. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetPrintArea(System.Int32)">
  10177. <summary>
  10178. Retrieves the reference for the printarea of the specified sheet, the sheet name Is Appended to the reference even if it was not specified.
  10179. </summary>
  10180. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  10181. <returns>String Null if no print area has been defined</returns>
  10182. </member>
  10183. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemovePrintArea(System.Int32)">
  10184. <summary>
  10185. Delete the printarea for the sheet specified
  10186. </summary>
  10187. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  10188. </member>
  10189. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateName">
  10190. <summary>
  10191. Creates a new named range and Add it to the model
  10192. </summary>
  10193. <returns>named range high level</returns>
  10194. </member>
  10195. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(System.String)">
  10196. <summary>
  10197. Gets the named range index by his name
  10198. Note:
  10199. Excel named ranges are case-insensitive and
  10200. this method performs a case-insensitive search.
  10201. </summary>
  10202. <param name="name">named range name</param>
  10203. <returns>named range index</returns>
  10204. </member>
  10205. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(NPOI.HSSF.UserModel.HSSFName)">
  10206. <summary>
  10207. As GetNameIndex(String) is not necessarily unique
  10208. (name + sheet index is unique), this method is more accurate.
  10209. </summary>
  10210. <param name="name">the name whose index in the list of names of this workbook should be looked up.</param>
  10211. <returns>an index value >= 0 if the name was found; -1, if the name was not found</returns>
  10212. </member>
  10213. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.Int32)">
  10214. <summary>
  10215. Remove the named range by his index
  10216. </summary>
  10217. <param name="index">The named range index (0 based)</param>
  10218. </member>
  10219. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateDataFormat">
  10220. <summary>
  10221. Creates the instance of HSSFDataFormat for this workbook.
  10222. </summary>
  10223. <returns>the HSSFDataFormat object</returns>
  10224. </member>
  10225. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.String)">
  10226. <summary>
  10227. Remove the named range by his name
  10228. </summary>
  10229. <param name="name">named range name</param>
  10230. </member>
  10231. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(NPOI.HSSF.UserModel.HSSFName)">
  10232. <summary>
  10233. As #removeName(String) is not necessarily unique (name + sheet index is unique),
  10234. this method is more accurate.
  10235. </summary>
  10236. <param name="name">the name to remove.</param>
  10237. </member>
  10238. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.DumpDrawingGroupRecords(System.Boolean)">
  10239. <summary>
  10240. Spits out a list of all the drawing records in the workbook.
  10241. </summary>
  10242. <param name="fat">if set to <c>true</c> [fat].</param>
  10243. </member>
  10244. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  10245. <summary>
  10246. Adds a picture to the workbook.
  10247. </summary>
  10248. <param name="pictureData">The bytes of the picture</param>
  10249. <param name="format">The format of the picture. One of
  10250. PictureType.</param>
  10251. <returns>the index to this picture (1 based).</returns>
  10252. </member>
  10253. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllPictures">
  10254. <summary>
  10255. Gets all pictures from the Workbook.
  10256. </summary>
  10257. <returns>the list of pictures (a list of HSSFPictureData objects.)</returns>
  10258. </member>
  10259. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SearchForPictures(System.Collections.IList,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFPictureData})">
  10260. <summary>
  10261. Performs a recursive search for pictures in the given list of escher records.
  10262. </summary>
  10263. <param name="escherRecords">the escher records.</param>
  10264. <param name="pictures">the list to populate with the pictures.</param>
  10265. </member>
  10266. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.WriteProtectWorkbook(System.String,System.String)">
  10267. <summary>
  10268. protect a workbook with a password (not encypted, just Sets Writeprotect
  10269. flags and the password.
  10270. </summary>
  10271. <param name="password">password to set</param>
  10272. <param name="username">The username.</param>
  10273. </member>
  10274. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.UnwriteProtectWorkbook">
  10275. <summary>
  10276. Removes the Write protect flag
  10277. </summary>
  10278. </member>
  10279. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects">
  10280. <summary>
  10281. Gets all embedded OLE2 objects from the Workbook.
  10282. </summary>
  10283. <returns>the list of embedded objects (a list of HSSFObjectData objects.)</returns>
  10284. </member>
  10285. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFSheet,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  10286. <summary>
  10287. Gets all embedded OLE2 objects from the Workbook.
  10288. </summary>
  10289. <param name="records">the list of records to search.</param>
  10290. <param name="objects">the list of embedded objects to populate.</param>
  10291. </member>
  10292. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetEnumerator">
  10293. <summary>
  10294. Support foreach ISheet, e.g.
  10295. HSSFWorkbook workbook = new HSSFWorkbook();
  10296. foreach(ISheet sheet in workbook) ...
  10297. </summary>
  10298. <returns>Enumeration of all the sheets of this workbook</returns>
  10299. </member>
  10300. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ChangeExternalReference(System.String,System.String)">
  10301. Changes an external referenced file to another file.
  10302. A formular in Excel which refers a cell in another file is saved in two parts:
  10303. The referenced file is stored in an reference table. the row/cell information is saved separate.
  10304. This method invokation will only change the reference in the lookup-table itself.
  10305. @param oldUrl The old URL to search for and which is to be replaced
  10306. @param newUrl The URL replacement
  10307. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  10308. </member>
  10309. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.MissingCellPolicy">
  10310. <summary>
  10311. Retrieves the current policy on what to do when
  10312. getting missing or blank cells from a row.
  10313. The default is to return blank and null cells.
  10314. </summary>
  10315. <value>The missing cell policy.</value>
  10316. </member>
  10317. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ActiveSheetIndex">
  10318. <summary>
  10319. Gets or sets the tab whose data is actually seen when the sheet is opened.
  10320. This may be different from the "selected sheet" since excel seems to
  10321. allow you to show the data of one sheet when another Is seen "selected"
  10322. in the tabs (at the bottom).
  10323. </summary>
  10324. </member>
  10325. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.FirstVisibleTab">
  10326. <summary>
  10327. Gets or sets the first tab that is displayed in the list of tabs
  10328. in excel.
  10329. </summary>
  10330. </member>
  10331. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfSheets">
  10332. <summary>
  10333. Get the number of spreadsheets in the workbook (this will be three after serialization)
  10334. </summary>
  10335. <value>The number of sheets.</value>
  10336. </member>
  10337. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.BackupFlag">
  10338. <summary>
  10339. determine whether the Excel GUI will backup the workbook when saving.
  10340. </summary>
  10341. <value>the current Setting for backups.</value>
  10342. </member>
  10343. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfFonts">
  10344. <summary>
  10345. Get the number of fonts in the font table
  10346. </summary>
  10347. <value>The number of fonts.</value>
  10348. </member>
  10349. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumCellStyles">
  10350. <summary>
  10351. Get the number of styles the workbook Contains
  10352. </summary>
  10353. <value>count of cell styles</value>
  10354. </member>
  10355. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.Workbook">
  10356. <summary>
  10357. Gets the workbook.
  10358. </summary>
  10359. <value>The workbook.</value>
  10360. </member>
  10361. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfNames">
  10362. <summary>
  10363. Gets the total number of named ranges in the workboko
  10364. </summary>
  10365. <value>The number of named ranges</value>
  10366. </member>
  10367. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.IsWriteProtected">
  10368. <summary>
  10369. Is the workbook protected with a password (not encrypted)?
  10370. </summary>
  10371. <value>
  10372. <c>true</c> if this instance is write protected; otherwise, <c>false</c>.
  10373. </value>
  10374. </member>
  10375. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NewUID">
  10376. <summary>
  10377. Gets the new UID.
  10378. </summary>
  10379. <value>The new UID.</value>
  10380. </member>
  10381. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ForceFormulaRecalculation">
  10382. <summary>
  10383. Whether the application shall perform a full recalculation when the workbook is opened.
  10384. Typically you want to force formula recalculation when you modify cell formulas or values
  10385. of a workbook previously created by Excel. When set to true, this flag will tell Excel
  10386. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  10387. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  10388. Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
  10389. on close.
  10390. Value is true if the application will perform a full recalculation of
  10391. workbook values when the workbook is opened.
  10392. since 3.8
  10393. </summary>
  10394. </member>
  10395. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook.SheetRecordCollector">
  10396. <summary>
  10397. Totals the sizes of all sheet records and eventually serializes them
  10398. </summary>
  10399. </member>
  10400. <member name="T:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener">
  10401. A proxy HSSFListener that keeps track of the document
  10402. formatting records, and provides an easy way to look
  10403. up the format strings used by cells from their ids.
  10404. </member>
  10405. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10406. Process this record ourselves, and then
  10407. pass it on to our child listener
  10408. </member>
  10409. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  10410. Process the record ourselves, but do not
  10411. pass it on to the child Listener.
  10412. @param record
  10413. </member>
  10414. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface)">
  10415. Formats the given numeric of date Cell's contents
  10416. as a String, in as close as we can to the way
  10417. that Excel would do so.
  10418. Uses the various format records to manage this.
  10419. TODO - move this to a central class in such a
  10420. way that hssf.usermodel can make use of it too
  10421. </member>
  10422. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(System.Int32)">
  10423. Returns the format string, eg $##.##, for the
  10424. given number format index.
  10425. </member>
  10426. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(NPOI.HSSF.Record.CellValueRecordInterface)">
  10427. Returns the format string, eg $##.##, used
  10428. by your cell
  10429. </member>
  10430. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatIndex(NPOI.HSSF.Record.CellValueRecordInterface)">
  10431. Returns the index of the format string, used by your cell,
  10432. or -1 if none found
  10433. </member>
  10434. <member name="T:NPOI.HSSF.EventUserModel.HSSFEventFactory">
  10435. <summary>
  10436. Low level event based HSSF Reader. Pass either a DocumentInputStream to
  10437. Process events along with a request object or pass a POIFS POIFSFileSystem to
  10438. ProcessWorkbookEvents along with a request.
  10439. This will cause your file to be Processed a record at a time. Each record with
  10440. a static id matching one that you have registed in your HSSFRequest will be passed
  10441. to your associated HSSFListener.
  10442. @author Andrew C. Oliver (acoliver at apache dot org)
  10443. @author Carey Sublette (careysub@earthling.net)
  10444. </summary>
  10445. </member>
  10446. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.#ctor">
  10447. <summary>
  10448. Creates a new instance of HSSFEventFactory
  10449. </summary>
  10450. </member>
  10451. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  10452. <summary>
  10453. Processes a file into essentially record events.
  10454. </summary>
  10455. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10456. <param name="fs">a POIFS filesystem containing your workbook</param>
  10457. </member>
  10458. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  10459. <summary>
  10460. Processes a file into essentially record events.
  10461. </summary>
  10462. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10463. <param name="fs">a POIFS filesystem containing your workbook</param>
  10464. <returns>numeric user-specified result code.</returns>
  10465. </member>
  10466. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  10467. <summary>
  10468. Processes a DocumentInputStream into essentially Record events.
  10469. If an
  10470. <c>AbortableHSSFListener</c>
  10471. causes a halt to Processing during this call
  10472. the method will return just as with
  10473. <c>abortableProcessEvents</c>
  10474. , but no
  10475. user code or
  10476. <c>HSSFUserException</c>
  10477. will be passed back.
  10478. </summary>
  10479. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10480. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  10481. </member>
  10482. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  10483. <summary>
  10484. Processes a DocumentInputStream into essentially Record events.
  10485. </summary>
  10486. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10487. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  10488. <returns>numeric user-specified result code.</returns>
  10489. </member>
  10490. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.GenericProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.HSSF.Record.RecordInputStream)">
  10491. <summary>
  10492. Processes a DocumentInputStream into essentially Record events.
  10493. </summary>
  10494. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  10495. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  10496. <returns>numeric user-specified result code.</returns>
  10497. </member>
  10498. <member name="T:NPOI.HSSF.EventUserModel.HSSFRecordStream">
  10499. <summary>
  10500. A stream based way to Get at complete records, with
  10501. as low a memory footprint as possible.
  10502. This handles Reading from a RecordInputStream, turning
  10503. the data into full records, Processing continue records
  10504. etc.
  10505. Most users should use HSSFEventFactory
  10506. HSSFListener and have new records pushed to
  10507. them, but this does allow for a "pull" style of coding.
  10508. </summary>
  10509. </member>
  10510. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.hitEOS">
  10511. Have we run out of records on the stream?
  10512. </member>
  10513. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.complete">
  10514. Have we returned all the records there are?
  10515. </member>
  10516. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.bonusRecords">
  10517. Sometimes we end up with a bunch of
  10518. records. When we do, these should
  10519. be returned before the next normal
  10520. record Processing occurs (i.e. before
  10521. we Check for continue records and
  10522. return rec)
  10523. </member>
  10524. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.rec">
  10525. The next record to return, which may need to have its
  10526. continue records passed to it before we do
  10527. </member>
  10528. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastRec">
  10529. The most recent record that we gave to the user
  10530. </member>
  10531. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastDrawingRecord">
  10532. The most recent DrawingRecord seen
  10533. </member>
  10534. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.NextRecord">
  10535. <summary>
  10536. Returns the next (complete) record from the
  10537. stream, or null if there are no more.
  10538. </summary>
  10539. <returns></returns>
  10540. </member>
  10541. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetBonusRecord">
  10542. <summary>
  10543. If there are any "bonus" records, that should
  10544. be returned before Processing new ones,
  10545. grabs the next and returns it.
  10546. If not, returns null;
  10547. </summary>
  10548. <returns></returns>
  10549. </member>
  10550. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetNextRecord">
  10551. <summary>
  10552. Returns the next available record, or null if
  10553. this pass didn't return a record that's
  10554. suitable for returning (eg was a continue record).
  10555. </summary>
  10556. <returns></returns>
  10557. </member>
  10558. <member name="T:NPOI.HSSF.EventUserModel.HSSFRequest">
  10559. <summary>
  10560. An HSSFRequest object should be constructed registering an instance or multiple
  10561. instances of HSSFListener with each Record.sid you wish to listen for.
  10562. @author Andrew C. Oliver (acoliver at apache dot org)
  10563. @author Carey Sublette (careysub@earthling.net)
  10564. </summary>
  10565. </member>
  10566. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.#ctor">
  10567. <summary>
  10568. Creates a new instance of HSSFRequest
  10569. </summary>
  10570. </member>
  10571. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListener(NPOI.HSSF.EventUserModel.IHSSFListener,System.Int16)">
  10572. <summary>
  10573. Add an event listener for a particular record type. The trick Is you have to know
  10574. what the records are for or just start with our examples and build on them. Alternatively,
  10575. you CAN call AddListenerForAllRecords and you'll recieve ALL record events in one listener,
  10576. but if you like to squeeze every last byte of efficiency out of life you my not like this.
  10577. (its sure as heck what I plan to do)
  10578. </summary>
  10579. <param name="lsnr">for the event</param>
  10580. <param name="sid">identifier for the record type this Is the .sid static member on the individual records</param>
  10581. </member>
  10582. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListenerForAllRecords(NPOI.HSSF.EventUserModel.IHSSFListener)">
  10583. <summary>
  10584. This Is the equivilent of calling AddListener(myListener, sid) for EVERY
  10585. record in the org.apache.poi.hssf.record package. This Is for lazy
  10586. people like me. You can call this more than once with more than one listener, but
  10587. that seems like a bad thing to do from a practice-perspective Unless you have a
  10588. compelling reason to do so (like maybe you send the event two places or log it or
  10589. something?).
  10590. </summary>
  10591. <param name="lsnr">a single listener to associate with ALL records</param>
  10592. </member>
  10593. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.ProcessRecord(NPOI.HSSF.Record.Record)">
  10594. <summary>
  10595. Called by HSSFEventFactory, passes the Record to each listener associated with
  10596. a record.sid.
  10597. Exception and return value Added 2002-04-19 by Carey Sublette
  10598. </summary>
  10599. <param name="rec">The record.</param>
  10600. <returns>numeric user-specified result code. If zero continue Processing.</returns>
  10601. </member>
  10602. <member name="T:NPOI.HSSF.EventUserModel.HSSFUserException">
  10603. <summary>
  10604. This exception Is provided as a way for API users to throw
  10605. exceptions from their event handling code. By doing so they
  10606. abort file Processing by the HSSFEventFactory and by
  10607. catching it from outside the HSSFEventFactory.ProcessEvents
  10608. method they can diagnose the cause for the abort.
  10609. The HSSFUserException supports a nested "reason"
  10610. throwable, i.e. an exception that caused this one to be thrown.
  10611. The HSSF package does not itself throw any of these
  10612. exceptions.
  10613. </summary>
  10614. <remarks>
  10615. @author Rainer Klute (klute@rainer-klute.de)
  10616. @author Carey Sublette (careysub@earthling.net)
  10617. </remarks>
  10618. </member>
  10619. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor">
  10620. <summary>
  10621. Creates a new HSSFUserException
  10622. </summary>
  10623. </member>
  10624. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String)">
  10625. <summary>
  10626. Creates a new HSSFUserException with a message
  10627. string.
  10628. </summary>
  10629. <param name="msg">The MSG.</param>
  10630. </member>
  10631. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.Exception)">
  10632. <summary>
  10633. Creates a new HSSFUserException with a reason.
  10634. </summary>
  10635. <param name="reason">The reason.</param>
  10636. </member>
  10637. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String,System.Exception)">
  10638. <summary>
  10639. Creates a new HSSFUserException with a message string
  10640. and a reason.
  10641. </summary>
  10642. <param name="msg">The MSG.</param>
  10643. <param name="reason">The reason.</param>
  10644. </member>
  10645. <member name="T:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener">
  10646. <summary>
  10647. A HSSFListener which tracks rows and columns, and will
  10648. trigger your HSSFListener for all rows and cells,
  10649. even the ones that aren't actually stored in the file.
  10650. This allows your code to have a more "Excel" like
  10651. view of the data in the file, and not have to worry
  10652. (as much) about if a particular row/cell Is in the
  10653. file, or was skipped from being written as it was
  10654. blank.
  10655. </summary>
  10656. </member>
  10657. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  10658. <summary>
  10659. Constructs a new MissingRecordAwareHSSFListener, which
  10660. will fire ProcessRecord on the supplied child
  10661. HSSFListener for all Records, and missing records.
  10662. </summary>
  10663. <param name="listener">The HSSFListener to pass records on to</param>
  10664. </member>
  10665. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10666. <summary>
  10667. Process an HSSF Record. Called when a record occurs in an HSSF file.
  10668. </summary>
  10669. <param name="record"></param>
  10670. </member>
  10671. <member name="T:NPOI.HSSF.Extractor.EventBasedExcelExtractor">
  10672. <summary>
  10673. A text extractor for Excel files, that is based
  10674. on the hssf eventusermodel api.
  10675. It will typically use less memory than
  10676. ExcelExtractor, but may not provide
  10677. the same richness of formatting.
  10678. Returns the textual content of the file, suitable for
  10679. indexing by something like Lucene, but not really
  10680. intended for display to the user.
  10681. </summary>
  10682. </member>
  10683. <member name="T:NPOI.POIOLE2TextExtractor">
  10684. <summary>
  10685. Common Parent for OLE2 based Text Extractors
  10686. of POI Documents, such as .doc, .xls
  10687. You will typically find the implementation of
  10688. a given format's text extractor under NPOI.Format.Extractor
  10689. </summary>
  10690. <remarks>
  10691. @see org.apache.poi.hssf.extractor.ExcelExtractor
  10692. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  10693. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  10694. @see org.apache.poi.hwpf.extractor.WordExtractor
  10695. </remarks>
  10696. </member>
  10697. <member name="M:NPOI.POIOLE2TextExtractor.#ctor(NPOI.POIDocument)">
  10698. <summary>
  10699. Creates a new text extractor for the given document
  10700. </summary>
  10701. <param name="document"></param>
  10702. </member>
  10703. <member name="P:NPOI.POIOLE2TextExtractor.DocSummaryInformation">
  10704. <summary>
  10705. Returns the document information metadata for the document
  10706. </summary>
  10707. <value>The doc summary information.</value>
  10708. </member>
  10709. <member name="P:NPOI.POIOLE2TextExtractor.SummaryInformation">
  10710. <summary>
  10711. Returns the summary information metadata for the document
  10712. </summary>
  10713. <value>The summary information.</value>
  10714. </member>
  10715. <member name="P:NPOI.POIOLE2TextExtractor.MetadataTextExtractor">
  10716. <summary>
  10717. Returns an HPSF powered text extractor for the
  10718. document properties metadata, such as title and author.
  10719. </summary>
  10720. <value></value>
  10721. </member>
  10722. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TriggerExtraction">
  10723. <summary>
  10724. Triggers the extraction.
  10725. </summary>
  10726. <returns></returns>
  10727. </member>
  10728. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.DocSummaryInformation">
  10729. <summary>
  10730. Would return the document information metadata for the document,
  10731. if we supported it
  10732. </summary>
  10733. <value>The doc summary information.</value>
  10734. </member>
  10735. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.SummaryInformation">
  10736. <summary>
  10737. Would return the summary information metadata for the document,
  10738. if we supported it
  10739. </summary>
  10740. <value>The summary information.</value>
  10741. </member>
  10742. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.IncludeSheetNames">
  10743. <summary>
  10744. Should sheet names be included? Default is true
  10745. </summary>
  10746. <value>if set to <c>true</c> [include sheet names].</value>
  10747. </member>
  10748. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.FormulasNotResults">
  10749. <summary>
  10750. Should we return the formula itself, and not
  10751. the result it produces? Default is false
  10752. </summary>
  10753. <value>if set to <c>true</c> [formulas not results].</value>
  10754. </member>
  10755. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.Text">
  10756. <summary>
  10757. Retreives the text contents of the file
  10758. </summary>
  10759. <value>All the text from the document.</value>
  10760. </member>
  10761. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  10762. <summary>
  10763. Process an HSSF Record. Called when a record occurs in an HSSF file.
  10764. </summary>
  10765. <param name="record"></param>
  10766. </member>
  10767. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface,System.Double)">
  10768. <summary>
  10769. Formats a number or date cell, be that a real number, or the
  10770. answer to a formula
  10771. </summary>
  10772. <param name="cell">The cell.</param>
  10773. <param name="value">The value.</param>
  10774. <returns></returns>
  10775. </member>
  10776. <member name="T:NPOI.HSSF.Extractor.ExcelExtractor">
  10777. <summary>
  10778. A text extractor for Excel files.
  10779. Returns the textual content of the file, suitable for
  10780. indexing by something like Lucene, but not really
  10781. intended for display to the user.
  10782. </summary>
  10783. </member>
  10784. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  10785. <summary>
  10786. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  10787. </summary>
  10788. <param name="wb">The wb.</param>
  10789. </member>
  10790. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  10791. <summary>
  10792. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  10793. </summary>
  10794. <param name="fs">The fs.</param>
  10795. </member>
  10796. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.ExtractHeaderFooter(NPOI.SS.UserModel.IHeaderFooter)">
  10797. <summary>
  10798. Extracts the header footer.
  10799. </summary>
  10800. <param name="hf">The header or footer</param>
  10801. <returns></returns>
  10802. </member>
  10803. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeHeaderFooter">
  10804. <summary>
  10805. Should header and footer be included? Default is true
  10806. </summary>
  10807. </member>
  10808. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeSheetNames">
  10809. <summary>
  10810. Should sheet names be included? Default is true
  10811. </summary>
  10812. <value>if set to <c>true</c> [include sheet names].</value>
  10813. </member>
  10814. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.FormulasNotResults">
  10815. <summary>
  10816. Should we return the formula itself, and not
  10817. the result it produces? Default is false
  10818. </summary>
  10819. <value>if set to <c>true</c> [formulas not results].</value>
  10820. </member>
  10821. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeCellComments">
  10822. <summary>
  10823. Should cell comments be included? Default is false
  10824. </summary>
  10825. <value>if set to <c>true</c> [include cell comments].</value>
  10826. </member>
  10827. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeBlankCells">
  10828. <summary>
  10829. Should blank cells be output? Default is to only
  10830. output cells that are present in the file and are
  10831. non-blank.
  10832. </summary>
  10833. <value>if set to <c>true</c> [include blank cells].</value>
  10834. </member>
  10835. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.Text">
  10836. <summary>
  10837. Retreives the text contents of the file
  10838. </summary>
  10839. <value>All the text from the document.</value>
  10840. </member>
  10841. <member name="T:NPOI.HSSF.Model.AbstractShape">
  10842. <summary>
  10843. An abstract shape Is the lowlevel model for a shape.
  10844. @author Glen Stampoultzis (glens at apache.org)
  10845. </summary>
  10846. </member>
  10847. <member name="M:NPOI.HSSF.Model.AbstractShape.CreateShape(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  10848. <summary>
  10849. Create a new shape object used to Create the escher records.
  10850. </summary>
  10851. <param name="hssfShape">The simple shape this Is based on.</param>
  10852. <param name="shapeId">The shape id.</param>
  10853. <returns></returns>
  10854. </member>
  10855. <member name="M:NPOI.HSSF.Model.AbstractShape.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  10856. <summary>
  10857. Creates an escher anchor record from a HSSFAnchor.
  10858. </summary>
  10859. <param name="userAnchor">The high level anchor to Convert.</param>
  10860. <returns>An escher anchor record.</returns>
  10861. </member>
  10862. <member name="M:NPOI.HSSF.Model.AbstractShape.AddStandardOptions(NPOI.HSSF.UserModel.HSSFShape,NPOI.DDF.EscherOptRecord)">
  10863. <summary>
  10864. Add standard properties to the opt record. These properties effect
  10865. all records.
  10866. </summary>
  10867. <param name="shape">The user model shape.</param>
  10868. <param name="opt">The opt record to Add the properties to.</param>
  10869. <returns>The number of options Added.</returns>
  10870. </member>
  10871. <member name="M:NPOI.HSSF.Model.AbstractShape.GetCmoObjectId(System.Int32)">
  10872. <summary>
  10873. Generate id for the CommonObjectDataSubRecord that stands behind this shape
  10874. </summary>
  10875. <param name="shapeId">shape id as generated by drawing manager</param>
  10876. <returns>object id that will be assigned to the Obj record</returns>
  10877. </member>
  10878. <member name="P:NPOI.HSSF.Model.AbstractShape.SpContainer">
  10879. <summary>
  10880. The shape container and it's children that can represent this
  10881. shape.
  10882. </summary>
  10883. <value>The sp container.</value>
  10884. </member>
  10885. <member name="P:NPOI.HSSF.Model.AbstractShape.ObjRecord">
  10886. <summary>
  10887. The object record that Is associated with this shape.
  10888. </summary>
  10889. <value>The obj record.</value>
  10890. </member>
  10891. <member name="M:NPOI.HSSF.Model.ComboboxShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  10892. Creates the low evel records for a combobox.
  10893. @param hssfShape The highlevel shape.
  10894. @param shapeId The shape id to use for this shape.
  10895. </member>
  10896. <member name="M:NPOI.HSSF.Model.ComboboxShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  10897. Generates the escher shape records for this shape.
  10898. </member>
  10899. <member name="T:NPOI.HSSF.Model.CommentShape">
  10900. <summary>
  10901. Represents a cell comment.
  10902. This class Converts highlevel model data from HSSFComment
  10903. to low-level records.
  10904. @author Yegor Kozlov
  10905. </summary>
  10906. </member>
  10907. <member name="T:NPOI.HSSF.Model.TextboxShape">
  10908. <summary>
  10909. Represents an textbox shape and Converts between the highlevel records
  10910. and lowlevel records for an oval.
  10911. @author Glen Stampoultzis (glens at apache.org)
  10912. </summary>
  10913. </member>
  10914. <member name="M:NPOI.HSSF.Model.TextboxShape.#ctor(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10915. <summary>
  10916. Creates the low evel records for a textbox.
  10917. </summary>
  10918. <param name="hssfShape">The highlevel shape.</param>
  10919. <param name="shapeId">The shape id to use for this shape.</param>
  10920. </member>
  10921. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10922. <summary>
  10923. Creates the lowerlevel OBJ records for this shape.
  10924. </summary>
  10925. <param name="hssfShape">The HSSF shape.</param>
  10926. <param name="shapeId">The shape id.</param>
  10927. <returns></returns>
  10928. </member>
  10929. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10930. <summary>
  10931. Creates the lowerlevel escher records for this shape.
  10932. </summary>
  10933. <param name="hssfShape">The HSSF shape.</param>
  10934. <param name="shapeId">The shape id.</param>
  10935. <returns></returns>
  10936. </member>
  10937. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateTextObjectRecord(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  10938. <summary>
  10939. Textboxes also have an extra TXO record associated with them that most
  10940. other shapes dont have.
  10941. </summary>
  10942. <param name="hssfShape">The HSSF shape.</param>
  10943. <param name="shapeId">The shape id.</param>
  10944. <returns></returns>
  10945. </member>
  10946. <member name="P:NPOI.HSSF.Model.TextboxShape.SpContainer">
  10947. <summary>
  10948. The shape container and it's children that can represent this
  10949. shape.
  10950. </summary>
  10951. <value></value>
  10952. </member>
  10953. <member name="P:NPOI.HSSF.Model.TextboxShape.ObjRecord">
  10954. <summary>
  10955. The object record that is associated with this shape.
  10956. </summary>
  10957. <value></value>
  10958. </member>
  10959. <member name="P:NPOI.HSSF.Model.TextboxShape.TextObjectRecord">
  10960. <summary>
  10961. The TextObject record that is associated with this shape.
  10962. </summary>
  10963. <value></value>
  10964. </member>
  10965. <member name="P:NPOI.HSSF.Model.TextboxShape.EscherTextbox">
  10966. <summary>
  10967. Gets the EscherTextbox record.
  10968. </summary>
  10969. <value>The EscherTextbox record.</value>
  10970. </member>
  10971. <member name="M:NPOI.HSSF.Model.CommentShape.#ctor(NPOI.HSSF.UserModel.HSSFComment,System.Int32)">
  10972. <summary>
  10973. Creates the low-level records for a comment.
  10974. </summary>
  10975. <param name="hssfShape">The highlevel shape.</param>
  10976. <param name="shapeId">The shape id to use for this shape.</param>
  10977. </member>
  10978. <member name="M:NPOI.HSSF.Model.CommentShape.CreateNoteRecord(NPOI.HSSF.UserModel.HSSFComment,System.Int32)">
  10979. <summary>
  10980. Creates the low level NoteRecord
  10981. which holds the comment attributes.
  10982. </summary>
  10983. <param name="shape">The shape.</param>
  10984. <param name="shapeId">The shape id.</param>
  10985. <returns></returns>
  10986. </member>
  10987. <member name="M:NPOI.HSSF.Model.CommentShape.AddStandardOptions(NPOI.HSSF.UserModel.HSSFShape,NPOI.DDF.EscherOptRecord)">
  10988. <summary>
  10989. Sets standard escher options for a comment.
  10990. This method is responsible for Setting default background,
  10991. shading and other comment properties.
  10992. </summary>
  10993. <param name="shape">The highlevel shape.</param>
  10994. <param name="opt">The escher records holding the proerties</param>
  10995. <returns>The number of escher options added</returns>
  10996. </member>
  10997. <member name="P:NPOI.HSSF.Model.CommentShape.NoteRecord">
  10998. <summary>
  10999. Gets the NoteRecord holding the comment attributes
  11000. </summary>
  11001. <value>The NoteRecord</value>
  11002. </member>
  11003. <member name="M:NPOI.HSSF.Model.ConvertAnchor.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  11004. <summary>
  11005. Creates the anchor.
  11006. </summary>
  11007. <param name="userAnchor">The user anchor.</param>
  11008. <returns></returns>
  11009. </member>
  11010. <member name="T:NPOI.HSSF.Model.DrawingManager">
  11011. Provides utilities to manage drawing Groups.
  11012. @author Glen Stampoultzis (glens at apache.org)
  11013. </member>
  11014. <member name="M:NPOI.HSSF.Model.DrawingManager.AllocateShapeId(System.Int16)">
  11015. Allocates new shape id for the new drawing Group id.
  11016. @return a new shape id.
  11017. </member>
  11018. <member name="T:NPOI.HSSF.Model.DrawingManager2">
  11019. <summary>
  11020. Provides utilities to manage drawing Groups.
  11021. </summary>
  11022. <remarks>
  11023. Glen Stampoultzis (glens at apache.org)
  11024. </remarks>
  11025. </member>
  11026. <member name="M:NPOI.HSSF.Model.DrawingManager2.ClearDrawingGroups">
  11027. <summary>
  11028. Clears the cached list of drawing Groups
  11029. </summary>
  11030. </member>
  11031. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16)">
  11032. <summary>
  11033. Allocates new shape id for the new drawing Group id.
  11034. </summary>
  11035. <param name="drawingGroupId"></param>
  11036. <returns>a new shape id.</returns>
  11037. </member>
  11038. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16,NPOI.DDF.EscherDgRecord)">
  11039. <summary>
  11040. Allocates new shape id for the new drawing group id.
  11041. </summary>
  11042. <param name="drawingGroupId"></param>
  11043. <param name="dg"></param>
  11044. <returns>a new shape id.</returns>
  11045. </member>
  11046. <member name="M:NPOI.HSSF.Model.DrawingManager2.FindNewDrawingGroupId">
  11047. <summary>
  11048. Finds the next available (1 based) drawing Group id
  11049. </summary>
  11050. <returns></returns>
  11051. </member>
  11052. <member name="T:NPOI.HSSF.Model.HSSFFormulaParser">
  11053. HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer}
  11054. @author Josh Micich
  11055. </member>
  11056. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  11057. Convenience method for parsing cell formulas. see {@link #parse(String, HSSFWorkbook, int)}
  11058. </member>
  11059. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType)">
  11060. @param formulaType a constant from {@link FormulaType}
  11061. @return the parsed formula tokens
  11062. </member>
  11063. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  11064. @param formula the formula to parse
  11065. @param workbook the parent workbook
  11066. @param formulaType a constant from {@link FormulaType}
  11067. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  11068. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  11069. the scope of the name will be ignored and the parser will match named ranges only by name
  11070. @return the parsed formula tokens
  11071. </member>
  11072. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.ToFormulaString(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  11073. Static method to convert an array of {@link Ptg}s in RPN order
  11074. to a human readable string format in infix mode.
  11075. @param book used for defined names and 3D references
  11076. @param ptgs must not be <c>null</c>
  11077. @return a human readable String
  11078. </member>
  11079. <member name="T:NPOI.HSSF.Model.LineShape">
  11080. <summary>
  11081. Represents a line shape and Creates all the line specific low level records.
  11082. @author Glen Stampoultzis (glens at apache.org)
  11083. </summary>
  11084. </member>
  11085. <member name="M:NPOI.HSSF.Model.LineShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11086. <summary>
  11087. Creates the line shape from the highlevel user shape. All low level
  11088. records are Created at this point.
  11089. </summary>
  11090. <param name="hssfShape">The user model shape</param>
  11091. <param name="shapeId">The identifier to use for this shape.</param>
  11092. </member>
  11093. <member name="M:NPOI.HSSF.Model.LineShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11094. <summary>
  11095. Creates the lowerlevel escher records for this shape.
  11096. </summary>
  11097. <param name="hssfShape">The HSSF shape.</param>
  11098. <param name="shapeId">The shape id.</param>
  11099. <returns></returns>
  11100. </member>
  11101. <member name="M:NPOI.HSSF.Model.LineShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  11102. <summary>
  11103. Creates the low level OBJ record for this shape.
  11104. </summary>
  11105. <param name="hssfShape">The HSSF shape.</param>
  11106. <param name="shapeId">The shape id.</param>
  11107. <returns></returns>
  11108. </member>
  11109. <member name="P:NPOI.HSSF.Model.LineShape.SpContainer">
  11110. <summary>
  11111. The shape container and it's children that can represent this
  11112. shape.
  11113. </summary>
  11114. <value></value>
  11115. </member>
  11116. <member name="P:NPOI.HSSF.Model.LineShape.ObjRecord">
  11117. <summary>
  11118. The object record that is associated with this shape.
  11119. </summary>
  11120. <value></value>
  11121. </member>
  11122. <member name="T:NPOI.HSSF.Model.LinkTable">
  11123. Link Table (OOO pdf reference: 4.10.3 ) <p/>
  11124. The main data of all types of references is stored in the Link Table inside the Workbook Globals
  11125. Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any
  11126. references in the document.
  11127. <p/>
  11128. In BIFF8 the Link Table consists of
  11129. <ul>
  11130. <li>zero or more EXTERNALBOOK Blocks<p/>
  11131. each consisting of
  11132. <ul>
  11133. <li>exactly one EXTERNALBOOK (0x01AE) record</li>
  11134. <li>zero or more EXTERNALNAME (0x0023) records</li>
  11135. <li>zero or more CRN Blocks<p/>
  11136. each consisting of
  11137. <ul>
  11138. <li>exactly one XCT (0x0059)record</li>
  11139. <li>zero or more CRN (0x005A) records (documentation says one or more)</li>
  11140. </ul>
  11141. </li>
  11142. </ul>
  11143. </li>
  11144. <li>zero or one EXTERNSHEET (0x0017) record</li>
  11145. <li>zero or more DEFINEDNAME (0x0018) records</li>
  11146. </ul>
  11147. @author Josh Micich
  11148. </member>
  11149. <member name="M:NPOI.HSSF.Model.LinkTable.GetIndexToInternalSheet(System.Int32)">
  11150. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  11151. @return -1 if the reference is to an external book
  11152. </member>
  11153. <member name="M:NPOI.HSSF.Model.LinkTable.AddNameXPtg(System.String)">
  11154. Register an external name in this workbook
  11155. @param name the name to register
  11156. @return a NameXPtg describing this name
  11157. </member>
  11158. <member name="M:NPOI.HSSF.Model.LinkTable.FindFirstRecordLocBySid(System.Int16)">
  11159. copied from Workbook
  11160. </member>
  11161. <member name="M:NPOI.HSSF.Model.LinkTable.ChangeExternalReference(System.String,System.String)">
  11162. Changes an external referenced file to another file.
  11163. A formular in Excel which refers a cell in another file is saved in two parts:
  11164. The referenced file is stored in an reference table. the row/cell information is saved separate.
  11165. This method invokation will only change the reference in the lookup-table itself.
  11166. @param oldUrl The old URL to search for and which is to be replaced
  11167. @param newUrl The URL replacement
  11168. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  11169. </member>
  11170. <member name="P:NPOI.HSSF.Model.LinkTable.RecordCount">
  11171. TODO - would not be required if calling code used RecordStream or similar
  11172. </member>
  11173. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor">
  11174. Create a new block for registering add-in functions
  11175. @see org.apache.poi.hssf.model.LinkTable#addNameXPtg(String)
  11176. </member>
  11177. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.Int32)">
  11178. Create a new block for internal references. It is called when constructing a new LinkTable.
  11179. @see org.apache.poi.hssf.model.LinkTable#LinkTable(int, WorkbookRecordList)
  11180. </member>
  11181. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.GetIndexOfName(System.String)">
  11182. Performs case-insensitive search
  11183. @return -1 if not found
  11184. </member>
  11185. <member name="T:NPOI.HSSF.Model.ParseNode">
  11186. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  11187. token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  11188. <c>Ptg</c> is non-atomic.
  11189. @author Josh Micich
  11190. </member>
  11191. <member name="M:NPOI.HSSF.Model.ParseNode.ToTokenArray(NPOI.HSSF.Model.ParseNode)">
  11192. <summary>
  11193. Collects the array of Ptg
  11194. tokens for the specified tree.
  11195. </summary>
  11196. <param name="rootNode">The root node.</param>
  11197. <returns></returns>
  11198. </member>
  11199. <member name="M:NPOI.HSSF.Model.ParseNode.CollectIfPtgs(NPOI.HSSF.Model.ParseNode.TokenCollector)">
  11200. <summary>
  11201. The IF() function Gets marked up with two or three tAttr tokens.
  11202. Similar logic will be required for CHOOSE() when it is supported
  11203. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  11204. </summary>
  11205. <param name="temp">The temp.</param>
  11206. </member>
  11207. <member name="T:NPOI.HSSF.Model.PictureShape">
  11208. <summary>
  11209. Represents a picture shape and Creates all specific low level records.
  11210. @author Glen Stampoultzis (glens at apache.org)
  11211. </summary>
  11212. </member>
  11213. <member name="M:NPOI.HSSF.Model.PictureShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11214. <summary>
  11215. Creates the line shape from the highlevel user shape. All low level
  11216. records are Created at this point.
  11217. </summary>
  11218. <param name="hssfShape">The user model shape.</param>
  11219. <param name="shapeId">The identifier to use for this shape.</param>
  11220. </member>
  11221. <member name="M:NPOI.HSSF.Model.PictureShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  11222. <summary>
  11223. Creates the lowerlevel escher records for this shape.
  11224. </summary>
  11225. <param name="hssfShape">The HSSF shape.</param>
  11226. <param name="shapeId">The shape id.</param>
  11227. <returns></returns>
  11228. </member>
  11229. <member name="M:NPOI.HSSF.Model.PictureShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  11230. <summary>
  11231. Creates the low level OBJ record for this shape.
  11232. </summary>
  11233. <param name="hssfShape">The HSSFShape.</param>
  11234. <param name="shapeId">The shape id.</param>
  11235. <returns></returns>
  11236. </member>
  11237. <member name="P:NPOI.HSSF.Model.PictureShape.SpContainer">
  11238. <summary>
  11239. The shape container and it's children that can represent this
  11240. shape.
  11241. </summary>
  11242. <value></value>
  11243. </member>
  11244. <member name="P:NPOI.HSSF.Model.PictureShape.ObjRecord">
  11245. <summary>
  11246. The object record that is associated with this shape.
  11247. </summary>
  11248. <value></value>
  11249. </member>
  11250. <member name="M:NPOI.HSSF.Model.PolygonShape.#ctor(NPOI.HSSF.UserModel.HSSFPolygon,System.Int32)">
  11251. <summary>
  11252. Creates the low evel records for an polygon.
  11253. </summary>
  11254. <param name="hssfShape">The highlevel shape.</param>
  11255. <param name="shapeId">The shape id to use for this shape.</param>
  11256. </member>
  11257. <member name="M:NPOI.HSSF.Model.PolygonShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFPolygon,System.Int32)">
  11258. <summary>
  11259. Creates the lowerlevel escher records for this shape.
  11260. </summary>
  11261. <param name="hssfShape">The HSSF shape.</param>
  11262. <param name="shapeId">The shape id.</param>
  11263. <returns></returns>
  11264. </member>
  11265. <member name="M:NPOI.HSSF.Model.PolygonShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  11266. <summary>
  11267. Creates the lowerlevel OBJ records for this shape.
  11268. </summary>
  11269. <param name="hssfShape">The HSSF shape.</param>
  11270. <param name="shapeId">The shape id.</param>
  11271. <returns></returns>
  11272. </member>
  11273. <member name="P:NPOI.HSSF.Model.PolygonShape.SpContainer">
  11274. <summary>
  11275. The shape container and it's children that can represent this
  11276. shape.
  11277. </summary>
  11278. <value></value>
  11279. </member>
  11280. <member name="P:NPOI.HSSF.Model.PolygonShape.ObjRecord">
  11281. <summary>
  11282. The object record that is associated with this shape.
  11283. </summary>
  11284. <value></value>
  11285. </member>
  11286. <member name="T:NPOI.HSSF.Model.RecordOrderer">
  11287. Finds correct insert positions for records in workbook streams<p/>
  11288. See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream'
  11289. @author Josh Micich
  11290. </member>
  11291. <member name="M:NPOI.HSSF.Model.RecordOrderer.AddNewSheetRecord(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},NPOI.HSSF.Record.RecordBase)">
  11292. Adds the specified new record in the correct place in sheet records list
  11293. </member>
  11294. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetWorksheetProtectionBlockInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11295. <summary>
  11296. Finds the index where the protection block should be inserted
  11297. </summary>
  11298. <param name="records">the records for this sheet</param>
  11299. <returns></returns>
  11300. <remark>
  11301. + BOF
  11302. o INDEX
  11303. o Calculation Settings Block
  11304. o PRINTHEADERS
  11305. o PRINTGRIDLINES
  11306. o GRIDSET
  11307. o GUTS
  11308. o DEFAULTROWHEIGHT
  11309. o SHEETPR
  11310. o Page Settings Block
  11311. o Worksheet Protection Block
  11312. o DEFCOLWIDTH
  11313. oo COLINFO
  11314. o SORT
  11315. + DIMENSION
  11316. </remark>
  11317. </member>
  11318. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsProtectionSubsequentRecord(System.Object)">
  11319. <summary>
  11320. These records may occur between the 'Worksheet Protection Block' and DIMENSION:
  11321. </summary>
  11322. <param name="rb"></param>
  11323. <returns></returns>
  11324. <remarks>
  11325. o DEFCOLWIDTH
  11326. oo COLINFO
  11327. o SORT
  11328. </remarks>
  11329. </member>
  11330. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindInsertPosForNewCondFormatTable(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11331. <summary>
  11332. Find correct position to add new CFHeader record
  11333. </summary>
  11334. <param name="records"></param>
  11335. <returns></returns>
  11336. </member>
  11337. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindDataValidationTableInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11338. Finds the index where the sheet validations header record should be inserted
  11339. @param records the records for this sheet
  11340. + WINDOW2
  11341. o SCL
  11342. o PANE
  11343. oo SELECTION
  11344. o STANDARDWIDTH
  11345. oo MERGEDCELLS
  11346. o LABELRANGES
  11347. o PHONETICPR
  11348. o Conditional Formatting Table
  11349. o Hyperlink Table
  11350. o Data Validity Table
  11351. o SHEETLAYOUT
  11352. o SHEETPROTECTION
  11353. o RANGEPROTECTION
  11354. + EOF
  11355. </member>
  11356. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetDimensionsIndex(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  11357. DIMENSIONS record is always present
  11358. </member>
  11359. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsEndOfRowBlock(System.Int32)">
  11360. <summary>
  11361. if the specified record ID terminates a sequence of Row block records
  11362. It is assumed that at least one row or cell value record has been found prior to the current
  11363. record
  11364. </summary>
  11365. <param name="sid"></param>
  11366. <returns></returns>
  11367. </member>
  11368. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsRowBlockRecord(System.Int32)">
  11369. <summary>
  11370. Whether the specified record id normally appears in the row blocks section of the sheet records
  11371. </summary>
  11372. <param name="sid"></param>
  11373. <returns></returns>
  11374. </member>
  11375. <member name="T:NPOI.HSSF.Model.RecordStream">
  11376. <summary>
  11377. Simplifies iteration over a sequence of Record objects.
  11378. @author Josh Micich
  11379. </summary>
  11380. </member>
  11381. <member name="M:NPOI.HSSF.Model.RecordStream.HasNext">
  11382. <summary>
  11383. Determines whether this instance has next.
  11384. </summary>
  11385. <returns>
  11386. <c>true</c> if this instance has next; otherwise, <c>false</c>.
  11387. </returns>
  11388. </member>
  11389. <member name="M:NPOI.HSSF.Model.RecordStream.GetNext">
  11390. <summary>
  11391. Gets the next record
  11392. </summary>
  11393. <returns></returns>
  11394. </member>
  11395. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextSid">
  11396. <summary>
  11397. Peeks the next sid.
  11398. </summary>
  11399. <returns>-1 if at end of records</returns>
  11400. </member>
  11401. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextClass">
  11402. <summary>
  11403. Peeks the next class.
  11404. </summary>
  11405. <returns>the class of the next Record.return null if this stream Is exhausted.</returns>
  11406. </member>
  11407. <member name="T:NPOI.HSSF.Model.RowBlocksReader">
  11408. Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and
  11409. shared formula records.
  11410. @author Josh Micich
  11411. </member>
  11412. <member name="M:NPOI.HSSF.Model.RowBlocksReader.#ctor(NPOI.HSSF.Model.RecordStream)">
  11413. Also collects any loose MergeCellRecords and puts them in the supplied
  11414. mergedCellsTable
  11415. </member>
  11416. <member name="P:NPOI.HSSF.Model.RowBlocksReader.LooseMergedCells">
  11417. Some unconventional apps place {@link MergeCellsRecord}s within the row block. They
  11418. actually should be in the {@link MergedCellsTable} which is much later (see bug 45699).
  11419. @return any loose <c>MergeCellsRecord</c>s found
  11420. </member>
  11421. <member name="P:NPOI.HSSF.Model.RowBlocksReader.PlainRecordStream">
  11422. @return a {@link RecordStream} containing all the non-{@link SharedFormulaRecord}
  11423. non-{@link ArrayRecord} and non-{@link TableRecord} Records.
  11424. </member>
  11425. <member name="T:NPOI.HSSF.Model.InternalSheet">
  11426. <summary>
  11427. Low level model implementation of a Sheet (one workbook Contains many sheets)
  11428. This file Contains the low level binary records starting at the sheets BOF and
  11429. ending with the sheets EOF. Use HSSFSheet for a high level representation.
  11430. The structures of the highlevel API use references to this to perform most of their
  11431. operations. Its probably Unwise to use these low level structures directly Unless you
  11432. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  11433. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  11434. before even attempting to use this.
  11435. </summary>
  11436. <remarks>
  11437. @author Andrew C. Oliver (acoliver at apache dot org)
  11438. @author Glen Stampoultzis (glens at apache.org)
  11439. @author Shawn Laubach (slaubach at apache dot org) Gridlines, Headers, Footers, PrintSetup, and Setting Default Column Styles
  11440. @author Jason Height (jheight at chariot dot net dot au) Clone support. DBCell and Index Record writing support
  11441. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  11442. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little)
  11443. </remarks>
  11444. </member>
  11445. <member name="F:NPOI.HSSF.Model.InternalSheet._mergedCellsTable">
  11446. java object always present, but if empty no BIFF records are written
  11447. </member>
  11448. <member name="F:NPOI.HSSF.Model.InternalSheet._dimensions">
  11449. the DimensionsRecord is always present
  11450. </member>
  11451. <member name="F:NPOI.HSSF.Model.InternalSheet._isUncalced">
  11452. Add an UncalcedRecord if not true indicating formulas have not been calculated
  11453. </member>
  11454. <member name="M:NPOI.HSSF.Model.InternalSheet.CloneSheet">
  11455. <summary>
  11456. Clones the low level records of this sheet and returns the new sheet instance.
  11457. This method is implemented by Adding methods for deep cloning to all records that
  11458. can be Added to a sheet. The Record object does not implement Cloneable.
  11459. When Adding a new record, implement a public Clone method if and only if the record
  11460. belongs to a sheet.
  11461. </summary>
  11462. <returns></returns>
  11463. </member>
  11464. <member name="M:NPOI.HSSF.Model.InternalSheet.GetValueRecords">
  11465. <summary>
  11466. get the NEXT value record (from LOC). The first record that is a value record
  11467. (starting at LOC) will be returned.
  11468. This method is "loc" sensitive. Meaning you need to set LOC to where you
  11469. want it to start searching. If you don't know do this: setLoc(getDimsLoc).
  11470. When adding several rows you can just start at the last one by leaving loc
  11471. at what this sets it to. For this method, set loc to dimsloc to start with,
  11472. subsequent calls will return values in (physical) sequence or NULL when you get to the end.
  11473. </summary>
  11474. <returns>the next value record or NULL if there are no more</returns>
  11475. </member>
  11476. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet(NPOI.HSSF.Model.RecordStream)">
  11477. <summary>
  11478. Creates the sheet.
  11479. </summary>
  11480. <param name="rs">The stream.</param>
  11481. <returns></returns>
  11482. </member>
  11483. <member name="M:NPOI.HSSF.Model.InternalSheet.#ctor(NPOI.HSSF.Model.RecordStream)">
  11484. <summary>
  11485. Initializes a new instance of the <see cref="T:NPOI.HSSF.Model.InternalSheet"/> class.
  11486. </summary>
  11487. <param name="rs">The stream.</param>
  11488. </member>
  11489. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet">
  11490. <summary>
  11491. Creates a sheet with all the usual records minus values and the "index"
  11492. record (not required). Sets the location pointer to where the first value
  11493. records should go. Use this to Create a sheet from "scratch".
  11494. </summary>
  11495. <returns>Sheet object with all values Set to defaults</returns>
  11496. </member>
  11497. <member name="M:NPOI.HSSF.Model.InternalSheet.AddMergedRegion(System.Int32,System.Int32,System.Int32,System.Int32)">
  11498. <summary>
  11499. Adds the merged region.
  11500. </summary>
  11501. <param name="rowFrom">the row index From </param>
  11502. <param name="colFrom">The column index From.</param>
  11503. <param name="rowTo">The row index To</param>
  11504. <param name="colTo">The column To.</param>
  11505. <returns></returns>
  11506. </member>
  11507. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveMergedRegion(System.Int32)">
  11508. <summary>
  11509. Removes the merged region.
  11510. </summary>
  11511. <param name="index">The index.</param>
  11512. </member>
  11513. <member name="M:NPOI.HSSF.Model.InternalSheet.GetMergedRegionAt(System.Int32)">
  11514. <summary>
  11515. Gets the merged region at.
  11516. </summary>
  11517. <param name="index">The index.</param>
  11518. <returns></returns>
  11519. </member>
  11520. <member name="M:NPOI.HSSF.Model.InternalSheet.SetDimensions(System.Int32,System.Int16,System.Int32,System.Int16)">
  11521. <summary>
  11522. Per an earlier reported bug in working with Andy Khan's excel Read library. This
  11523. Sets the values in the sheet's DimensionsRecord object to be correct. Excel doesn't
  11524. really care, but we want to play nice with other libraries.
  11525. </summary>
  11526. <param name="firstrow">The first row.</param>
  11527. <param name="firstcol">The first column.</param>
  11528. <param name="lastrow">The last row.</param>
  11529. <param name="lastcol">The last column.</param>
  11530. </member>
  11531. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRow(System.Int32)">
  11532. <summary>
  11533. Create a row record. (does not Add it to the records contained in this sheet)
  11534. </summary>
  11535. <param name="row">row number</param>
  11536. <returns>RowRecord Created for the passed in row number</returns>
  11537. </member>
  11538. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateLabelSST(System.Int32,System.Int16,System.Int32)">
  11539. <summary>
  11540. Create a LABELSST Record (does not Add it to the records contained in this sheet)
  11541. </summary>
  11542. <param name="row">the row the LabelSST Is a member of</param>
  11543. <param name="col">the column the LabelSST defines</param>
  11544. <param name="index">the index of the string within the SST (use workbook AddSSTString method)</param>
  11545. <returns>LabelSSTRecord newly Created containing your SST Index, row,col.</returns>
  11546. </member>
  11547. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateNumber(System.Int32,System.Int16,System.Double)">
  11548. <summary>
  11549. Create a NUMBER Record (does not Add it to the records contained in this sheet)
  11550. </summary>
  11551. <param name="row">the row the NumberRecord is a member of</param>
  11552. <param name="col">the column the NumberRecord defines</param>
  11553. <param name="value">value for the number record</param>
  11554. <returns>NumberRecord for that row, col containing that value as Added to the sheet</returns>
  11555. </member>
  11556. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBlank(System.Int32,System.Int16)">
  11557. <summary>
  11558. Create a BLANK record (does not Add it to the records contained in this sheet)
  11559. </summary>
  11560. <param name="row">the row the BlankRecord is a member of</param>
  11561. <param name="col">the column the BlankRecord is a member of</param>
  11562. <returns></returns>
  11563. </member>
  11564. <member name="M:NPOI.HSSF.Model.InternalSheet.AddValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  11565. <summary>
  11566. Adds a value record to the sheet's contained binary records
  11567. (i.e. LabelSSTRecord or NumberRecord).
  11568. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11569. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11570. When Adding several rows you can just start at the last one by leaving loc
  11571. at what this Sets it to.
  11572. </summary>
  11573. <param name="row">the row to Add the cell value to</param>
  11574. <param name="col">the cell value record itself.</param>
  11575. </member>
  11576. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  11577. <summary>
  11578. Remove a value record from the records array.
  11579. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  11580. </summary>
  11581. <param name="row">the row of the value record you wish to Remove</param>
  11582. <param name="col">a record supporting the CellValueRecordInterface.</param>
  11583. </member>
  11584. <member name="M:NPOI.HSSF.Model.InternalSheet.ReplaceValueRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  11585. <summary>
  11586. Replace a value record from the records array.
  11587. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  11588. </summary>
  11589. <param name="newval">a record supporting the CellValueRecordInterface. this will Replace
  11590. the cell value with the same row and column. If there Isn't one, one will
  11591. be Added.</param>
  11592. </member>
  11593. <member name="M:NPOI.HSSF.Model.InternalSheet.AddRow(NPOI.HSSF.Record.RowRecord)">
  11594. <summary>
  11595. Adds a row record to the sheet
  11596. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11597. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11598. When Adding several rows you can just start at the last one by leaving loc
  11599. at what this Sets it to.
  11600. </summary>
  11601. <param name="row">the row record to be Added</param>
  11602. </member>
  11603. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveRow(NPOI.HSSF.Record.RowRecord)">
  11604. <summary>
  11605. Removes a row record
  11606. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  11607. </summary>
  11608. <param name="row">the row record to Remove</param>
  11609. </member>
  11610. <member name="M:NPOI.HSSF.Model.InternalSheet.GetRow(System.Int32)">
  11611. <summary>
  11612. Get the NEXT (from LOC) RowRecord where rownumber matches the given rownum.
  11613. The first record that is a Row record (starting at LOC) that has the
  11614. same rownum as the given rownum will be returned.
  11615. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11616. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11617. When Adding several rows you can just start at the last one by leaving loc
  11618. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  11619. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  11620. </summary>
  11621. <param name="rownum">which row to return (careful with LOC)</param>
  11622. <returns>RowRecord representing the next row record or NULL if there are no more</returns>
  11623. </member>
  11624. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBOF">
  11625. <summary>
  11626. Creates the BOF record
  11627. </summary>
  11628. <returns>record containing a BOFRecord</returns>
  11629. </member>
  11630. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIndex">
  11631. <summary>
  11632. Creates the Index record - not currently used
  11633. </summary>
  11634. <returns>record containing a IndexRecord</returns>
  11635. </member>
  11636. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcMode">
  11637. <summary>
  11638. Creates the CalcMode record and Sets it to 1 (automatic formula caculation)
  11639. </summary>
  11640. <returns>record containing a CalcModeRecord</returns>
  11641. </member>
  11642. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcCount">
  11643. <summary>
  11644. Creates the CalcCount record and Sets it to 0x64 (default number of iterations)
  11645. </summary>
  11646. <returns>record containing a CalcCountRecord</returns>
  11647. </member>
  11648. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRefMode">
  11649. <summary>
  11650. Creates the RefMode record and Sets it to A1 Mode (default reference mode)
  11651. </summary>
  11652. <returns>record containing a RefModeRecord</returns>
  11653. </member>
  11654. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIteration">
  11655. <summary>
  11656. Creates the Iteration record and Sets it to false (don't iteratively calculate formulas)
  11657. </summary>
  11658. <returns>record containing a IterationRecord</returns>
  11659. </member>
  11660. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDelta">
  11661. <summary>
  11662. Creates the Delta record and Sets it to 0.0010 (default accuracy)
  11663. </summary>
  11664. <returns>record containing a DeltaRecord</returns>
  11665. </member>
  11666. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSaveRecalc">
  11667. <summary>
  11668. Creates the SaveRecalc record and Sets it to true (recalculate before saving)
  11669. </summary>
  11670. <returns>record containing a SaveRecalcRecord</returns>
  11671. </member>
  11672. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintHeaders">
  11673. <summary>
  11674. Creates the PrintHeaders record and Sets it to false (we don't Create headers yet so why print them)
  11675. </summary>
  11676. <returns>record containing a PrintHeadersRecord</returns>
  11677. </member>
  11678. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintGridlines">
  11679. <summary>
  11680. Creates the PrintGridlines record and Sets it to false (that makes for ugly sheets). As far as I can
  11681. tell this does the same thing as the GridsetRecord
  11682. </summary>
  11683. <returns>record containing a PrintGridlinesRecord</returns>
  11684. </member>
  11685. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGridset">
  11686. <summary>
  11687. Creates the GridSet record and Sets it to true (user has mucked with the gridlines)
  11688. </summary>
  11689. <returns>record containing a GridsetRecord</returns>
  11690. </member>
  11691. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGuts">
  11692. <summary>
  11693. Creates the Guts record and Sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0
  11694. </summary>
  11695. <returns>record containing a GutsRecordRecord</returns>
  11696. </member>
  11697. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultRowHeight">
  11698. <summary>
  11699. Creates the DefaultRowHeight Record and Sets its options to 0 and rowheight to 0xff
  11700. </summary>
  11701. <see cref="T:NPOI.HSSF.Record.DefaultRowHeightRecord"/>
  11702. <see cref="T:NPOI.HSSF.Record.Record"/>
  11703. <returns>record containing a DefaultRowHeightRecord</returns>
  11704. </member>
  11705. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWSBool">
  11706. Creates the WSBoolRecord and Sets its values to defaults
  11707. @see org.apache.poi.hssf.record.WSBoolRecord
  11708. @see org.apache.poi.hssf.record.Record
  11709. @return record containing a WSBoolRecord
  11710. </member>
  11711. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateHCenter">
  11712. Creates the HCenter Record and Sets it to false (don't horizontally center)
  11713. @see org.apache.poi.hssf.record.HCenterRecord
  11714. @see org.apache.poi.hssf.record.Record
  11715. @return record containing a HCenterRecord
  11716. </member>
  11717. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateVCenter">
  11718. Creates the VCenter Record and Sets it to false (don't horizontally center)
  11719. @see org.apache.poi.hssf.record.VCenterRecord
  11720. @see org.apache.poi.hssf.record.Record
  11721. @return record containing a VCenterRecord
  11722. </member>
  11723. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintSetup">
  11724. Creates the PrintSetup Record and Sets it to defaults and marks it invalid
  11725. @see org.apache.poi.hssf.record.PrintSetupRecord
  11726. @see org.apache.poi.hssf.record.Record
  11727. @return record containing a PrintSetupRecord
  11728. </member>
  11729. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultColWidth">
  11730. Creates the DefaultColWidth Record and Sets it to 8
  11731. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  11732. @see org.apache.poi.hssf.record.Record
  11733. @return record containing a DefaultColWidthRecord
  11734. </member>
  11735. <member name="M:NPOI.HSSF.Model.InternalSheet.GetColumnWidth(System.Int32)">
  11736. Get the width of a given column in Units of 1/256th of a Char width
  11737. @param column index
  11738. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  11739. @see org.apache.poi.hssf.record.ColumnInfoRecord
  11740. @see #SetColumnWidth(short,short)
  11741. @return column width in Units of 1/256th of a Char width
  11742. </member>
  11743. <member name="M:NPOI.HSSF.Model.InternalSheet.GetXFIndexForColAt(System.Int16)">
  11744. Get the index to the ExtendedFormatRecord "associated" with
  11745. the column at specified 0-based index. (In this case, an
  11746. ExtendedFormatRecord index is actually associated with a
  11747. ColumnInfoRecord which spans 1 or more columns)
  11748. <br/>
  11749. Returns the index to the default ExtendedFormatRecord (0xF)
  11750. if no ColumnInfoRecord exists that includes the column
  11751. index specified.
  11752. @param column
  11753. @return index of ExtendedFormatRecord associated with
  11754. ColumnInfoRecord that includes the column index or the
  11755. index of the default ExtendedFormatRecord (0xF)
  11756. </member>
  11757. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnWidth(System.Int32,System.Int32)">
  11758. Set the width for a given column in 1/256th of a Char width Units
  11759. @param column - the column number
  11760. @param width (in Units of 1/256th of a Char width)
  11761. </member>
  11762. <member name="M:NPOI.HSSF.Model.InternalSheet.IsColumnHidden(System.Int32)">
  11763. Get the hidden property for a given column.
  11764. @param column index
  11765. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  11766. @see org.apache.poi.hssf.record.ColumnInfoRecord
  11767. @see #SetColumnHidden(short,bool)
  11768. @return whether the column is hidden or not.
  11769. </member>
  11770. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnHidden(System.Int32,System.Boolean)">
  11771. Get the hidden property for a given column.
  11772. @param column - the column number
  11773. @param hidden - whether the column is hidden or not
  11774. </member>
  11775. <member name="M:NPOI.HSSF.Model.InternalSheet.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  11776. Creates an outline Group for the specified columns.
  11777. @param fromColumn Group from this column (inclusive)
  11778. @param toColumn Group to this column (inclusive)
  11779. @param indent if true the Group will be indented by one level,
  11780. if false indenting will be Removed by one level.
  11781. </member>
  11782. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDimensions">
  11783. Creates the Dimensions Record and Sets it to bogus values (you should Set this yourself
  11784. or let the high level API do it for you)
  11785. @see org.apache.poi.hssf.record.DimensionsRecord
  11786. @see org.apache.poi.hssf.record.Record
  11787. @return record containing a DimensionsRecord
  11788. </member>
  11789. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWindowTwo">
  11790. Creates the WindowTwo Record and Sets it to:
  11791. options = 0x6b6
  11792. toprow = 0
  11793. leftcol = 0
  11794. headercolor = 0x40
  11795. pagebreakzoom = 0x0
  11796. normalzoom = 0x0
  11797. @see org.apache.poi.hssf.record.WindowTwoRecord
  11798. @see org.apache.poi.hssf.record.Record
  11799. @return record containing a WindowTwoRecord
  11800. </member>
  11801. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSelection">
  11802. <summary>
  11803. Creates the Selection record and Sets it to nothing selected
  11804. </summary>
  11805. <returns>record containing a SelectionRecord</returns>
  11806. </member>
  11807. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCell(System.Int32,System.Int32)">
  11808. <summary>
  11809. Sets the active cell.
  11810. </summary>
  11811. <param name="row">The row.</param>
  11812. <param name="column">The column.</param>
  11813. </member>
  11814. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  11815. <summary>
  11816. Sets the active cell range.
  11817. </summary>
  11818. <param name="firstRow">The firstrow.</param>
  11819. <param name="lastRow">The lastrow.</param>
  11820. <param name="firstColumn">The firstcolumn.</param>
  11821. <param name="lastColumn">The lastcolumn.</param>
  11822. </member>
  11823. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  11824. <summary>
  11825. Sets the active cell range.
  11826. </summary>
  11827. <param name="cellranges">The cellranges.</param>
  11828. <param name="activeRange">The index of the active range.</param>
  11829. <param name="activeRow">The active row in the active range</param>
  11830. <param name="activeColumn">The active column in the active range</param>
  11831. </member>
  11832. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateEOF">
  11833. <summary>
  11834. Creates the EOF record
  11835. </summary>
  11836. <returns>record containing a EOFRecord</returns>
  11837. </member>
  11838. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordBySid(System.Int16)">
  11839. <summary>
  11840. Returns the first occurance of a record matching a particular sid.
  11841. </summary>
  11842. <param name="sid">The sid.</param>
  11843. <returns></returns>
  11844. </member>
  11845. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSCLRecord(NPOI.HSSF.Record.SCLRecord)">
  11846. <summary>
  11847. Sets the SCL record or Creates it in the correct place if it does not
  11848. already exist.
  11849. </summary>
  11850. <param name="sclRecord">The record to set.</param>
  11851. </member>
  11852. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordLocBySid(System.Int16)">
  11853. Finds the first occurance of a record matching a particular sid and
  11854. returns it's position.
  11855. @param sid the sid to search for
  11856. @return the record position of the matching record or -1 if no match
  11857. is made.
  11858. </member>
  11859. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSelected(System.Boolean)">
  11860. Sets whether the sheet is selected
  11861. @param sel True to select the sheet, false otherwise.
  11862. </member>
  11863. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  11864. Creates a split (freezepane). Any existing freezepane or split pane Is overwritten.
  11865. @param colSplit Horizonatal position of split.
  11866. @param rowSplit Vertical position of split.
  11867. @param topRow Top row visible in bottom pane
  11868. @param leftmostColumn Left column visible in right pane.
  11869. </member>
  11870. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  11871. Creates a split pane. Any existing freezepane or split pane is overwritten.
  11872. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  11873. @param ySplitPos Vertical position of split (in 1/20th of a point).
  11874. @param topRow Top row visible in bottom pane
  11875. @param leftmostColumn Left column visible in right pane.
  11876. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  11877. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  11878. @see #PANE_LOWER_LEFT
  11879. @see #PANE_LOWER_RIGHT
  11880. @see #PANE_UPPER_LEFT
  11881. @see #PANE_UPPER_RIGHT
  11882. </member>
  11883. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePassword">
  11884. creates a Password record with password set to 00.
  11885. </member>
  11886. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateProtect">
  11887. creates a Protect record with protect set to false.
  11888. </member>
  11889. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateObjectProtect">
  11890. Creates an ObjectProtect record with protect Set to false.
  11891. @see org.apache.poi.hssf.record.ObjectProtectRecord
  11892. @see org.apache.poi.hssf.record.Record
  11893. @return an ObjectProtectRecord
  11894. </member>
  11895. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateScenarioProtect">
  11896. Creates a ScenarioProtect record with protect Set to false.
  11897. @see org.apache.poi.hssf.record.ScenarioProtectRecord
  11898. @see org.apache.poi.hssf.record.Record
  11899. @return a ScenarioProtectRecord
  11900. </member>
  11901. <member name="M:NPOI.HSSF.Model.InternalSheet.AggregateDrawingRecords(NPOI.HSSF.Model.DrawingManager2,System.Boolean)">
  11902. <summary>
  11903. Finds the DrawingRecord for our sheet, and attaches it to the DrawingManager (which knows about
  11904. the overall DrawingGroup for our workbook).
  11905. If requested, will Create a new DrawRecord if none currently exist
  11906. </summary>
  11907. <param name="drawingManager">The DrawingManager2 for our workbook</param>
  11908. <param name="CreateIfMissing">Should one be Created if missing?</param>
  11909. <returns>location of EscherAggregate record. if no EscherAggregate record is found return -1</returns>
  11910. </member>
  11911. <member name="M:NPOI.HSSF.Model.InternalSheet.Preserialize">
  11912. Perform any work necessary before the sheet is about to be Serialized.
  11913. For instance the escher aggregates size needs to be calculated before
  11914. serialization so that the dgg record (which occurs first) can be written.
  11915. </member>
  11916. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int16,System.Int16,System.Int32)">
  11917. Shifts all the page breaks in the range "count" number of rows/columns
  11918. @param breaks The page record to be Shifted
  11919. @param start Starting "main" value to Shift breaks
  11920. @param stop Ending "main" value to Shift breaks
  11921. @param count number of Units (rows/columns) to Shift by
  11922. </member>
  11923. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  11924. Shifts the horizontal page breaks for the indicated count
  11925. @param startingRow
  11926. @param endingRow
  11927. @param count
  11928. </member>
  11929. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  11930. Shifts the vertical page breaks for the indicated count
  11931. @param startingCol
  11932. @param endingCol
  11933. @param count
  11934. </member>
  11935. <member name="M:NPOI.HSSF.Model.InternalSheet.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  11936. Updates formulas in cells and conditional formats due to moving of cells
  11937. @param externSheetIndex the externSheet index of this sheet
  11938. </member>
  11939. <member name="M:NPOI.HSSF.Model.InternalSheet.GetSizeOfInitialSheetRecords(System.Int32)">
  11940. 'initial sheet records' are between INDEX and the 'Row Blocks'
  11941. @param bofRecordIndex index of record after which INDEX record is to be placed
  11942. @return count of bytes from end of INDEX record to first ROW record.
  11943. </member>
  11944. <member name="M:NPOI.HSSF.Model.InternalSheet.GetNoteRecords">
  11945. Get the {@link NoteRecord}s (related to cell comments) for this sheet
  11946. @return never <code>null</code>, typically empty array
  11947. </member>
  11948. <member name="P:NPOI.HSSF.Model.InternalSheet.ColumnInfos">
  11949. <summary>
  11950. Gets the column infos.
  11951. </summary>
  11952. <value>The column infos.</value>
  11953. </member>
  11954. <member name="P:NPOI.HSSF.Model.InternalSheet.NumMergedRegions">
  11955. <summary>
  11956. Gets the number of merged regions.
  11957. </summary>
  11958. <value>The number merged regions.</value>
  11959. </member>
  11960. <member name="P:NPOI.HSSF.Model.InternalSheet.NumConditionalFormattings">
  11961. <summary>
  11962. Gets the number of conditional formattings.
  11963. </summary>
  11964. <value>The number of conditional formattings.</value>
  11965. </member>
  11966. <member name="P:NPOI.HSSF.Model.InternalSheet.PreOffset">
  11967. <summary>
  11968. Gets or Sets the preoffset when using DBCELL records (currently Unused) - this Is
  11969. the position of this sheet within the whole file.
  11970. </summary>
  11971. <value>the offset of the sheet's BOF within the file.</value>
  11972. </member>
  11973. <member name="P:NPOI.HSSF.Model.InternalSheet.NextRow">
  11974. <summary>
  11975. Get the NEXT RowRecord (from LOC). The first record that is a Row record
  11976. (starting at LOC) will be returned.
  11977. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  11978. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  11979. When Adding several rows you can just start at the last one by leaving loc
  11980. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  11981. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  11982. </summary>
  11983. <value>RowRecord representing the next row record or NULL if there are no more</value>
  11984. </member>
  11985. <member name="P:NPOI.HSSF.Model.InternalSheet.PageSettings">
  11986. <summary>
  11987. Gets the page settings.
  11988. </summary>
  11989. <returns></returns>
  11990. </member>
  11991. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultColumnWidth">
  11992. Get the default column width for the sheet (if the columns do not define their own width)
  11993. @return default column width
  11994. </member>
  11995. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultRowHeight">
  11996. Get the default row height for the sheet (if the rows do not define their own height)
  11997. @return default row height
  11998. </member>
  11999. <member name="P:NPOI.HSSF.Model.InternalSheet.TopRow">
  12000. <summary>
  12001. Gets or sets the top row.
  12002. </summary>
  12003. <value>The top row.</value>
  12004. </member>
  12005. <member name="P:NPOI.HSSF.Model.InternalSheet.LeftCol">
  12006. <summary>
  12007. Gets or sets the left col.
  12008. </summary>
  12009. <value>The left col.</value>
  12010. </member>
  12011. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellRow">
  12012. <summary>
  12013. Returns the active row
  12014. </summary>
  12015. <value>the active row index</value>
  12016. @see org.apache.poi.hssf.record.SelectionRecord
  12017. </member>
  12018. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellCol">
  12019. <summary>
  12020. Gets or sets the active cell col.
  12021. </summary>
  12022. <value>the active column index</value>
  12023. @see org.apache.poi.hssf.record.SelectionRecord
  12024. </member>
  12025. <member name="P:NPOI.HSSF.Model.InternalSheet.GridsetRecord">
  12026. <summary>
  12027. Gets the gridset record for this sheet.
  12028. </summary>
  12029. <value>The gridset record.</value>
  12030. </member>
  12031. <member name="P:NPOI.HSSF.Model.InternalSheet.Header">
  12032. <summary>
  12033. Gets or sets the header.
  12034. </summary>
  12035. <value>the HeaderRecord.</value>
  12036. </member>
  12037. <member name="P:NPOI.HSSF.Model.InternalSheet.IsAutoTabColor">
  12038. <summary>
  12039. Gets or sets a value indicating whether this instance is auto tab color.
  12040. </summary>
  12041. <value>
  12042. <c>true</c> if this instance is auto tab color; otherwise, <c>false</c>.
  12043. </value>
  12044. </member>
  12045. <member name="P:NPOI.HSSF.Model.InternalSheet.Footer">
  12046. <summary>
  12047. Gets or sets the footer.
  12048. </summary>
  12049. <value>FooterRecord for the sheet.</value>
  12050. </member>
  12051. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintSetup">
  12052. Returns the PrintSetupRecord.
  12053. @return PrintSetupRecord for the sheet.
  12054. </member>
  12055. <member name="P:NPOI.HSSF.Model.InternalSheet.IsGridsPrinted">
  12056. @return <c>true</c> if gridlines are printed
  12057. </member>
  12058. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintGridlines">
  12059. Returns the PrintGridlinesRecord.
  12060. @return PrintGridlinesRecord for the sheet.
  12061. </member>
  12062. <member name="P:NPOI.HSSF.Model.InternalSheet.PaneInformation">
  12063. Returns the information regarding the currently configured pane (split or freeze).
  12064. @return null if no pane configured, or the pane information.
  12065. </member>
  12066. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayGridlines">
  12067. Returns if gridlines are Displayed.
  12068. @return whether gridlines are Displayed
  12069. </member>
  12070. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayFormulas">
  12071. Returns if formulas are Displayed.
  12072. @return whether formulas are Displayed
  12073. </member>
  12074. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayRowColHeadings">
  12075. Returns if RowColHeadings are Displayed.
  12076. @return whether RowColHeadings are Displayed
  12077. </member>
  12078. <member name="P:NPOI.HSSF.Model.InternalSheet.IsUncalced">
  12079. @return whether an Uncalced record must be Inserted or not at generation
  12080. </member>
  12081. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  12082. <summary>
  12083. Creates the low evel records for an oval.
  12084. </summary>
  12085. <param name="hssfShape">The highlevel shape.</param>
  12086. <param name="shapeId">The shape id to use for this shape.</param>
  12087. </member>
  12088. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  12089. <summary>
  12090. Creates the lowerlevel escher records for this shape.
  12091. </summary>
  12092. <param name="hssfShape">The HSSF shape.</param>
  12093. <param name="shapeId">The shape id.</param>
  12094. <returns></returns>
  12095. </member>
  12096. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  12097. <summary>
  12098. Creates the lowerlevel OBJ records for this shape.
  12099. </summary>
  12100. <param name="hssfShape">The HSSF shape.</param>
  12101. <param name="shapeId">The shape id.</param>
  12102. <returns></returns>
  12103. </member>
  12104. <member name="P:NPOI.HSSF.Model.SimpleFilledShape.SpContainer">
  12105. <summary>
  12106. The shape container and it's children that can represent this
  12107. shape.
  12108. </summary>
  12109. <value></value>
  12110. </member>
  12111. <member name="P:NPOI.HSSF.Model.SimpleFilledShape.ObjRecord">
  12112. <summary>
  12113. The object record that is associated with this shape.
  12114. </summary>
  12115. <value></value>
  12116. </member>
  12117. <member name="T:NPOI.HSSF.Model.InternalWorkbook">
  12118. Low level model implementation of a Workbook. Provides creational methods
  12119. for Settings and objects contained in the workbook object.
  12120. This file Contains the low level binary records starting at the workbook's BOF and
  12121. ending with the workbook's EOF. Use HSSFWorkbook for a high level representation.
  12122. The structures of the highlevel API use references to this to perform most of their
  12123. operations. Its probably Unwise to use these low level structures directly Unless you
  12124. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  12125. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  12126. before even attempting to use this.
  12127. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  12128. @author Sergei Kozello (sergeikozello at mail.ru)
  12129. @author Shawn Laubach (slaubach at apache dot org) (Data Formats)
  12130. @author Andrew C. Oliver (acoliver at apache dot org)
  12131. @author Brian Sanders (bsanders at risklabs dot com) - custom palette
  12132. @author Dan Sherman (dsherman at Isisph.com)
  12133. @author Glen Stampoultzis (glens at apache.org)
  12134. @see org.apache.poi.hssf.usermodel.HSSFWorkbook
  12135. @version 1.0-pre
  12136. </member>
  12137. <member name="F:NPOI.HSSF.Model.InternalWorkbook.MAX_SENSITIVE_SHEET_NAME_LEN">
  12138. Excel silently truncates long sheet names to 31 chars.
  12139. This constant is used to ensure uniqueness in the first 31 chars
  12140. </member>
  12141. <member name="F:NPOI.HSSF.Model.InternalWorkbook.CODEPAGE">
  12142. constant used to Set the "codepage" wherever "codepage" is Set in records
  12143. (which is duplciated in more than one record)
  12144. </member>
  12145. <member name="F:NPOI.HSSF.Model.InternalWorkbook.records">
  12146. this Contains the Worksheet record objects
  12147. </member>
  12148. <member name="F:NPOI.HSSF.Model.InternalWorkbook.sst">
  12149. this Contains a reference to the SSTRecord so that new stings can be Added
  12150. to it.
  12151. </member>
  12152. <member name="F:NPOI.HSSF.Model.InternalWorkbook.boundsheets">
  12153. holds the "boundsheet" records (aka bundlesheet) so that they can have their
  12154. reference to their "BOF" marker
  12155. </member>
  12156. <member name="M:NPOI.HSSF.Model.InternalWorkbook.#ctor">
  12157. Creates new Workbook with no intitialization --useless right now
  12158. @see #CreateWorkbook(List)
  12159. </member>
  12160. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  12161. Read support for low level
  12162. API. Pass in an array of Record objects, A Workbook
  12163. object is constructed and passed back with all of its initialization Set
  12164. to the passed in records and references to those records held. Unlike Sheet
  12165. workbook does not use an offset (its assumed to be 0) since its first in a file.
  12166. If you need an offset then construct a new array with a 0 offset or Write your
  12167. own ;-p.
  12168. @param recs an array of Record objects
  12169. @return Workbook object
  12170. </member>
  12171. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameCommentRecord(NPOI.HSSF.Record.NameRecord)">
  12172. gets the name comment record
  12173. @param nameRecord name record who's comment is required.
  12174. @return name comment record or <code>null</code> if there isn't one for the given name.
  12175. </member>
  12176. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook">
  12177. Creates an empty workbook object with three blank sheets and all the empty
  12178. fields. Use this to Create a workbook from scratch.
  12179. </member>
  12180. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSpecificBuiltinRecord(System.Byte,System.Int32)">
  12181. Retrieves the Builtin NameRecord that matches the name and index
  12182. There shouldn't be too many names to make the sequential search too slow
  12183. @param name byte representation of the builtin name to match
  12184. @param sheetIndex Index to match
  12185. @return null if no builtin NameRecord matches
  12186. </member>
  12187. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveBuiltinRecord(System.Byte,System.Int32)">
  12188. Removes the specified Builtin NameRecord that matches the name and index
  12189. @param name byte representation of the builtin to match
  12190. @param sheetIndex zero-based sheet reference
  12191. </member>
  12192. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontRecordAt(System.Int32)">
  12193. Gets the font record at the given index in the font table. Remember
  12194. "There is No Four" (someone at M$ must have gone to Rocky Horror one too
  12195. many times)
  12196. @param idx the index to look at (0 or greater but NOT 4)
  12197. @return FontRecord located at the given index
  12198. </member>
  12199. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateNewFont">
  12200. Creates a new font record and Adds it to the "font table". This causes the
  12201. boundsheets to move down one, extended formats to move down (so this function moves
  12202. those pointers as well)
  12203. @return FontRecord that was just Created
  12204. </member>
  12205. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CloneDrawings(NPOI.HSSF.Model.InternalSheet)">
  12206. Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and
  12207. re-generate shape IDs
  12208. @param sheet the cloned sheet
  12209. </member>
  12210. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetBof(System.Int32,System.Int32)">
  12211. Sets the BOF for a given sheet
  12212. @param sheetnum the number of the sheet to Set the positing of the bof for
  12213. @param pos the actual bof position
  12214. </member>
  12215. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String)">
  12216. Sets the name for a given sheet. If the boundsheet record doesn't exist and
  12217. its only one more than we have, go ahead and Create it. If its > 1 more than
  12218. we have, except
  12219. @param sheetnum the sheet number (0 based)
  12220. @param sheetname the name for the sheet
  12221. </member>
  12222. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ContainsSheetName(System.String,System.Int32)">
  12223. Determines whether a workbook Contains the provided sheet name.
  12224. @param name the name to test (case insensitive match)
  12225. @param excludeSheetIdx the sheet to exclude from the Check or -1 to include all sheets in the Check.
  12226. @return true if the sheet Contains the name, false otherwise.
  12227. </member>
  12228. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String,System.Int16)">
  12229. Sets the name for a given sheet forcing the encoding. This is STILL A BAD IDEA.
  12230. Poi now automatically detects Unicode
  12231. @deprecated 3-Jan-06 Simply use SetSheetNam e(int sheetnum, String sheetname)
  12232. @param sheetnum the sheet number (0 based)
  12233. @param sheetname the name for the sheet
  12234. </member>
  12235. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetOrder(System.String,System.Int32)">
  12236. Sets the order of appearance for a given sheet.
  12237. @param sheetname the name of the sheet to reorder
  12238. @param pos the position that we want to Insert the sheet into (0 based)
  12239. </member>
  12240. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetName(System.Int32)">
  12241. Gets the name for a given sheet.
  12242. @param sheetnum the sheet number (0 based)
  12243. @return sheetname the name for the sheet
  12244. </member>
  12245. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetHidden(System.Int32)">
  12246. Gets the hidden flag for a given sheet.
  12247. @param sheetnum the sheet number (0 based)
  12248. @return True if sheet is hidden
  12249. </member>
  12250. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetVeryHidden(System.Int32)">
  12251. Gets the hidden flag for a given sheet.
  12252. Note that a sheet could instead be
  12253. set to be very hidden, which is different
  12254. ({@link #isSheetVeryHidden(int)})
  12255. @param sheetnum the sheet number (0 based)
  12256. @return True if sheet is hidden
  12257. </member>
  12258. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  12259. Hide or Unhide a sheet
  12260. @param sheetnum The sheet number
  12261. @param hidden True to mark the sheet as hidden, false otherwise
  12262. </member>
  12263. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  12264. Hide or unhide a sheet.
  12265. 0 = not hidden
  12266. 1 = hidden
  12267. 2 = very hidden.
  12268. @param sheetnum The sheet number
  12269. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  12270. </member>
  12271. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetIndex(System.String)">
  12272. Get the sheet's index
  12273. @param name sheet name
  12274. @return sheet index or -1 if it was not found.
  12275. </member>
  12276. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckSheets(System.Int32)">
  12277. if we're trying to Address one more sheet than we have, go ahead and Add it! if we're
  12278. trying to Address >1 more than we have throw an exception!
  12279. </member>
  12280. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FixTabIdRecord">
  12281. <summary>
  12282. make the tabid record look like the current situation.
  12283. </summary>
  12284. <returns>number of bytes written in the TabIdRecord</returns>
  12285. </member>
  12286. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontIndex(NPOI.HSSF.Record.FontRecord)">
  12287. Retrieves the index of the given font
  12288. </member>
  12289. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetStyleRecord(System.Int32)">
  12290. Returns the StyleRecord for the given
  12291. xfIndex, or null if that ExtendedFormat doesn't
  12292. have a Style set.
  12293. </member>
  12294. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetExFormatAt(System.Int32)">
  12295. Gets the ExtendedFormatRecord at the given 0-based index
  12296. @param index of the Extended format record (0-based)
  12297. @return ExtendedFormatRecord at the given index
  12298. </member>
  12299. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCellXF">
  12300. Creates a new Cell-type Extneded Format Record and Adds it to the end of
  12301. ExtendedFormatRecords collection
  12302. @return ExtendedFormatRecord that was Created
  12303. </member>
  12304. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddSSTString(NPOI.HSSF.Record.UnicodeString)">
  12305. Adds a string to the SST table and returns its index (if its a duplicate
  12306. just returns its index and update the counts) ASSUMES compressed Unicode
  12307. (meaning 8bit)
  12308. @param string the string to be Added to the SSTRecord
  12309. @return index of the string within the SSTRecord
  12310. </member>
  12311. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSSTString(System.Int32)">
  12312. given an index into the SST table, this function returns the corresponding String value
  12313. @return String containing the SST String
  12314. </member>
  12315. <member name="M:NPOI.HSSF.Model.InternalWorkbook.InsertSST">
  12316. use this function to Add a Shared String Table to an existing sheet (say
  12317. generated by a different java api) without an sst....
  12318. @see #CreateSST()
  12319. @see org.apache.poi.hssf.record.SSTRecord
  12320. </member>
  12321. <member name="M:NPOI.HSSF.Model.InternalWorkbook.Serialize(System.Int32,System.Byte[])">
  12322. Serializes all records int the worksheet section into a big byte array. Use
  12323. this to Write the Workbook out.
  12324. @param offset of the data to be written
  12325. @param data array of bytes to Write this to
  12326. </member>
  12327. <member name="M:NPOI.HSSF.Model.InternalWorkbook.PreSerialize">
  12328. Perform any work necessary before the workbook is about to be serialized.
  12329. Include in it ant code that modifies the workbook record stream and affects its size.
  12330. </member>
  12331. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBOF">
  12332. Creates the BOF record
  12333. @see org.apache.poi.hssf.record.BOFRecord
  12334. @see org.apache.poi.hssf.record.Record
  12335. @return record containing a BOFRecord
  12336. </member>
  12337. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceHdr">
  12338. Creates the InterfaceHdr record
  12339. @see org.apache.poi.hssf.record.InterfaceHdrRecord
  12340. @see org.apache.poi.hssf.record.Record
  12341. @return record containing a InterfaceHdrRecord
  12342. </member>
  12343. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateMMS">
  12344. Creates an MMS record
  12345. @see org.apache.poi.hssf.record.MMSRecord
  12346. @see org.apache.poi.hssf.record.Record
  12347. @return record containing a MMSRecord
  12348. </member>
  12349. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceEnd">
  12350. Creates the InterfaceEnd record
  12351. @see org.apache.poi.hssf.record.InterfaceEndRecord
  12352. @see org.apache.poi.hssf.record.Record
  12353. @return record containing a InterfaceEndRecord
  12354. </member>
  12355. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWriteAccess">
  12356. Creates the WriteAccess record containing the logged in user's name
  12357. @see org.apache.poi.hssf.record.WriteAccessRecord
  12358. @see org.apache.poi.hssf.record.Record
  12359. @return record containing a WriteAccessRecord
  12360. </member>
  12361. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCodepage">
  12362. Creates the Codepage record containing the constant stored in CODEPAGE
  12363. @see org.apache.poi.hssf.record.CodepageRecord
  12364. @see org.apache.poi.hssf.record.Record
  12365. @return record containing a CodepageRecord
  12366. </member>
  12367. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDSF">
  12368. Creates the DSF record containing a 0 since HSSF can't even Create Dual Stream Files
  12369. @see org.apache.poi.hssf.record.DSFRecord
  12370. @see org.apache.poi.hssf.record.Record
  12371. @return record containing a DSFRecord
  12372. </member>
  12373. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateTabId">
  12374. Creates the TabId record containing an array of 0,1,2. This release of HSSF
  12375. always has the default three sheets, no less, no more.
  12376. @see org.apache.poi.hssf.record.TabIdRecord
  12377. @see org.apache.poi.hssf.record.Record
  12378. @return record containing a TabIdRecord
  12379. </member>
  12380. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFnGroupCount">
  12381. Creates the FnGroupCount record containing the Magic number constant of 14.
  12382. @see org.apache.poi.hssf.record.FnGroupCountRecord
  12383. @see org.apache.poi.hssf.record.Record
  12384. @return record containing a FnGroupCountRecord
  12385. </member>
  12386. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowProtect">
  12387. Creates the WindowProtect record with protect Set to false.
  12388. @see org.apache.poi.hssf.record.WindowProtectRecord
  12389. @see org.apache.poi.hssf.record.Record
  12390. @return record containing a WindowProtectRecord
  12391. </member>
  12392. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtect">
  12393. Creates the Protect record with protect Set to false.
  12394. @see org.apache.poi.hssf.record.ProtectRecord
  12395. @see org.apache.poi.hssf.record.Record
  12396. @return record containing a ProtectRecord
  12397. </member>
  12398. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePassword">
  12399. Creates the Password record with password Set to 0.
  12400. @see org.apache.poi.hssf.record.PasswordRecord
  12401. @see org.apache.poi.hssf.record.Record
  12402. @return record containing a PasswordRecord
  12403. </member>
  12404. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtectionRev4">
  12405. Creates the ProtectionRev4 record with protect Set to false.
  12406. @see org.apache.poi.hssf.record.ProtectionRev4Record
  12407. @see org.apache.poi.hssf.record.Record
  12408. @return record containing a ProtectionRev4Record
  12409. </member>
  12410. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePasswordRev4">
  12411. Creates the PasswordRev4 record with password Set to 0.
  12412. @see org.apache.poi.hssf.record.PasswordRev4Record
  12413. @see org.apache.poi.hssf.record.Record
  12414. @return record containing a PasswordRev4Record
  12415. </member>
  12416. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowOne">
  12417. Creates the WindowOne record with the following magic values:
  12418. horizontal hold - 0x168
  12419. vertical hold - 0x10e
  12420. width - 0x3a5c
  12421. height - 0x23be
  12422. options - 0x38
  12423. selected tab - 0
  12424. Displayed tab - 0
  12425. num selected tab- 0
  12426. tab width ratio - 0x258
  12427. @see org.apache.poi.hssf.record.WindowOneRecord
  12428. @see org.apache.poi.hssf.record.Record
  12429. @return record containing a WindowOneRecord
  12430. </member>
  12431. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBackup">
  12432. Creates the Backup record with backup Set to 0. (loose the data, who cares)
  12433. @see org.apache.poi.hssf.record.BackupRecord
  12434. @see org.apache.poi.hssf.record.Record
  12435. @return record containing a BackupRecord
  12436. </member>
  12437. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateHideObj">
  12438. Creates the HideObj record with hide object Set to 0. (don't hide)
  12439. @see org.apache.poi.hssf.record.HideObjRecord
  12440. @see org.apache.poi.hssf.record.Record
  12441. @return record containing a HideObjRecord
  12442. </member>
  12443. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDateWindow1904">
  12444. Creates the DateWindow1904 record with windowing Set to 0. (don't window)
  12445. @see org.apache.poi.hssf.record.DateWindow1904Record
  12446. @see org.apache.poi.hssf.record.Record
  12447. @return record containing a DateWindow1904Record
  12448. </member>
  12449. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePrecision">
  12450. Creates the Precision record with precision Set to true. (full precision)
  12451. @see org.apache.poi.hssf.record.PrecisionRecord
  12452. @see org.apache.poi.hssf.record.Record
  12453. @return record containing a PrecisionRecord
  12454. </member>
  12455. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateRefreshAll">
  12456. Creates the RefreshAll record with refreshAll Set to true. (refresh all calcs)
  12457. @see org.apache.poi.hssf.record.RefreshAllRecord
  12458. @see org.apache.poi.hssf.record.Record
  12459. @return record containing a RefreshAllRecord
  12460. </member>
  12461. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBookBool">
  12462. Creates the BookBool record with saveLinkValues Set to 0. (don't save link values)
  12463. @see org.apache.poi.hssf.record.BookBoolRecord
  12464. @see org.apache.poi.hssf.record.Record
  12465. @return record containing a BookBoolRecord
  12466. </member>
  12467. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFont">
  12468. Creates a Font record with the following magic values:
  12469. fontheight = 0xc8
  12470. attributes = 0x0
  12471. color palette index = 0x7fff
  12472. bold weight = 0x190
  12473. Font Name Length = 5
  12474. Font Name = Arial
  12475. @see org.apache.poi.hssf.record.FontRecord
  12476. @see org.apache.poi.hssf.record.Record
  12477. @return record containing a FontRecord
  12478. </member>
  12479. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat(System.Int32)">
  12480. Creates an ExtendedFormatRecord object
  12481. @param id the number of the extended format record to Create (meaning its position in
  12482. a file as MS Excel would Create it.)
  12483. @return record containing an ExtendedFormatRecord
  12484. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  12485. @see org.apache.poi.hssf.record.Record
  12486. </member>
  12487. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat">
  12488. Creates an default cell type ExtendedFormatRecord object.
  12489. @return ExtendedFormatRecord with intial defaults (cell-type)
  12490. </member>
  12491. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyleRecord(System.Int32)">
  12492. Creates a new StyleRecord, for the given Extended
  12493. Format index, and adds it onto the end of the
  12494. records collection
  12495. </member>
  12496. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyle(System.Int32)">
  12497. Creates a StyleRecord object
  12498. @param id the number of the style record to Create (meaning its position in
  12499. a file as MS Excel would Create it.
  12500. @return record containing a StyleRecord
  12501. @see org.apache.poi.hssf.record.StyleRecord
  12502. @see org.apache.poi.hssf.record.Record
  12503. </member>
  12504. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePalette">
  12505. Creates a palette record initialized to the default palette
  12506. @return a PaletteRecord instance populated with the default colors
  12507. @see org.apache.poi.hssf.record.PaletteRecord
  12508. </member>
  12509. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateUseSelFS">
  12510. Creates the UseSelFS object with the use natural language flag Set to 0 (false)
  12511. @return record containing a UseSelFSRecord
  12512. @see org.apache.poi.hssf.record.UseSelFSRecord
  12513. @see org.apache.poi.hssf.record.Record
  12514. </member>
  12515. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBoundSheet(System.Int32)">
  12516. Create a "bound sheet" or "bundlesheet" (depending who you ask) record
  12517. Always Sets the sheet's bof to 0. You'll need to Set that yourself.
  12518. @param id either sheet 0,1 or 2.
  12519. @return record containing a BoundSheetRecord
  12520. @see org.apache.poi.hssf.record.BoundSheetRecord
  12521. @see org.apache.poi.hssf.record.Record
  12522. </member>
  12523. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCountry">
  12524. Creates the Country record with the default country Set to 1
  12525. and current country Set to 7 in case of russian locale ("ru_RU") and 1 otherwise
  12526. @return record containing a CountryRecord
  12527. @see org.apache.poi.hssf.record.CountryRecord
  12528. @see org.apache.poi.hssf.record.Record
  12529. </member>
  12530. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedSST">
  12531. Creates the ExtendedSST record with numstrings per bucket Set to 0x8. HSSF
  12532. doesn't yet know what to do with this thing, but we Create it with nothing in
  12533. it hardly just to make Excel happy and our sheets look like Excel's
  12534. @return record containing an ExtSSTRecord
  12535. @see org.apache.poi.hssf.record.ExtSSTRecord
  12536. @see org.apache.poi.hssf.record.Record
  12537. </member>
  12538. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindSheetNameFromExternSheet(System.Int32)">
  12539. Finds the sheet name by his extern sheet index
  12540. @param num extern sheet index
  12541. @return sheet name
  12542. </member>
  12543. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetIndexFromExternSheetIndex(System.Int32)">
  12544. Finds the sheet index for a particular external sheet number.
  12545. @param externSheetNumber The external sheet number to Convert
  12546. @return The index to the sheet found.
  12547. </member>
  12548. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckExternSheet(System.Int32)">
  12549. returns the extern sheet number for specific sheet number ,
  12550. if this sheet doesn't exist in extern sheet , Add it
  12551. @param sheetNumber sheet number
  12552. @return index to extern sheet
  12553. </member>
  12554. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.Udf.UDFFinder)">
  12555. @param name the name of an external function, typically a name of a UDF
  12556. @param udf locator of user-defiend functions to resolve names of VBA and Add-In functions
  12557. @return the external name or null
  12558. </member>
  12559. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameRecord(System.Int32)">
  12560. Gets the name record
  12561. @param index name index
  12562. @return name record
  12563. </member>
  12564. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateName">
  12565. Creates new name
  12566. @return new name record
  12567. </member>
  12568. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddName(NPOI.HSSF.Record.NameRecord)">
  12569. Creates new name
  12570. @return new name record
  12571. </member>
  12572. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBuiltInName(System.Byte,System.Int32)">
  12573. Generates a NameRecord to represent a built-in region
  12574. @return a new NameRecord Unless the index is invalid
  12575. </member>
  12576. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveName(System.Int32)">
  12577. Removes the name
  12578. @param namenum name index
  12579. </member>
  12580. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNameCommentRecordCache(NPOI.HSSF.Record.NameCommentRecord)">
  12581. If a {@link NameCommentRecord} is added or the name it references
  12582. is renamed, then this will update the lookup cache for it.
  12583. </member>
  12584. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFormat(System.String,System.Boolean)">
  12585. Returns a format index that matches the passed in format. It does not tie into HSSFDataFormat.
  12586. @param format the format string
  12587. @param CreateIfNotFound Creates a new format if format not found
  12588. @return the format id of a format that matches or -1 if none found and CreateIfNotFound
  12589. </member>
  12590. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.String)">
  12591. Creates a FormatRecord, Inserts it, and returns the index code.
  12592. @param format the format string
  12593. @return the index code of the format record.
  12594. @see org.apache.poi.hssf.record.FormatRecord
  12595. @see org.apache.poi.hssf.record.Record
  12596. </member>
  12597. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.Int32)">
  12598. Creates a FormatRecord object
  12599. @param id the number of the format record to create (meaning its position in
  12600. a file as M$ Excel would create it.)
  12601. </member>
  12602. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordBySid(System.Int16)">
  12603. Returns the first occurance of a record matching a particular sid.
  12604. </member>
  12605. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordLocBySid(System.Int16)">
  12606. Returns the index of a record matching a particular sid.
  12607. @param sid The sid of the record to match
  12608. @return The index of -1 if no match made.
  12609. </member>
  12610. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindNextRecordBySid(System.Int16,System.Int32)">
  12611. Returns the next occurance of a record matching a particular sid.
  12612. </member>
  12613. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindDrawingGroup">
  12614. Finds the primary drawing Group, if one already exists
  12615. </member>
  12616. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDrawingGroup">
  12617. Creates a primary drawing Group record. If it already
  12618. exists then it's modified.
  12619. </member>
  12620. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveFontRecord(NPOI.HSSF.Record.FontRecord)">
  12621. Removes the given font record from the
  12622. file's list. This will make all
  12623. subsequent font indicies drop by one,
  12624. so you'll need to update those yourself!
  12625. </member>
  12626. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(NPOI.HSSF.Record.ExtendedFormatRecord)">
  12627. Removes the given ExtendedFormatRecord record from the
  12628. file's list. This will make all
  12629. subsequent font indicies drop by one,
  12630. so you'll need to update those yourself!
  12631. </member>
  12632. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(System.Int32)">
  12633. <summary>
  12634. Removes ExtendedFormatRecord record with given index from the file's list. This will make all
  12635. subsequent font indicies drop by one,so you'll need to update those yourself!
  12636. </summary>
  12637. <param name="index">index of the Extended format record (0-based)</param>
  12638. </member>
  12639. <member name="M:NPOI.HSSF.Model.InternalWorkbook.WriteProtectWorkbook(System.String,System.String)">
  12640. protect a workbook with a password (not encypted, just Sets Writeprotect
  12641. flags and the password.
  12642. @param password to Set
  12643. </member>
  12644. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UnwriteProtectWorkbook">
  12645. Removes the Write protect flag
  12646. </member>
  12647. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  12648. @param reFindex Index to REF entry in EXTERNSHEET record in the Link Table
  12649. @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record
  12650. @return the string representation of the defined or external name
  12651. </member>
  12652. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNamesAfterCellShift(NPOI.SS.Formula.FormulaShifter)">
  12653. Updates named ranges due to moving of cells
  12654. </member>
  12655. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ChangeExternalReference(System.String,System.String)">
  12656. Changes an external referenced file to another file.
  12657. A formular in Excel which refers a cell in another file is saved in two parts:
  12658. The referenced file is stored in an reference table. the row/cell information is saved separate.
  12659. This method invokation will only change the reference in the lookup-table itself.
  12660. @param oldUrl The old URL to search for and which is to be replaced
  12661. @param newUrl The URL replacement
  12662. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  12663. </member>
  12664. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumberOfFontRecords">
  12665. Gets the number of font records
  12666. @return number of font records in the "font table"
  12667. </member>
  12668. <member name="P:NPOI.HSSF.Model.InternalWorkbook.BackupRecord">
  12669. Returns the position of the backup record.
  12670. </member>
  12671. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumSheets">
  12672. returns the number of boundsheet objects contained in this workbook.
  12673. @return number of BoundSheet records
  12674. </member>
  12675. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumExFormats">
  12676. Get the number of ExtendedFormat records contained in this workbook.
  12677. @return int count of ExtendedFormat records
  12678. </member>
  12679. <member name="P:NPOI.HSSF.Model.InternalWorkbook.OrCreateLinkTable">
  12680. lazy initialization
  12681. Note - creating the link table causes creation of 1 EXTERNALBOOK and 1 EXTERNALSHEET record
  12682. </member>
  12683. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumNames">
  12684. Gets the total number of names
  12685. @return number of names
  12686. </member>
  12687. <member name="P:NPOI.HSSF.Model.InternalWorkbook.Formats">
  12688. Returns the list of FormatRecords in the workbook.
  12689. @return ArrayList of FormatRecords in the notebook
  12690. </member>
  12691. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsUsing1904DateWindowing">
  12692. Whether date windowing is based on 1/2/1904 or 1/1/1900.
  12693. Some versions of Excel (Mac) can save workbooks using 1904 date windowing.
  12694. @return true if using 1904 date windowing
  12695. </member>
  12696. <member name="P:NPOI.HSSF.Model.InternalWorkbook.CustomPalette">
  12697. Returns the custom palette in use for this workbook; if a custom palette record
  12698. does not exist, then it is Created.
  12699. </member>
  12700. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsWriteProtected">
  12701. is the workbook protected with a password (not encrypted)?
  12702. </member>
  12703. <member name="P:NPOI.HSSF.Model.InternalWorkbook.RecalcId">
  12704. Get or create RecalcIdRecord
  12705. @see org.apache.poi.hssf.usermodel.HSSFWorkbook#setForceFormulaRecalculation(boolean)
  12706. </member>
  12707. <member name="T:NPOI.HSSF.Model.WorkbookRecordList">
  12708. <summary>
  12709. List for records in Workbook
  12710. </summary>
  12711. </member>
  12712. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Add(System.Int32,NPOI.HSSF.Record.Record)">
  12713. <summary>
  12714. Adds the specified pos.
  12715. </summary>
  12716. <param name="pos">The pos.</param>
  12717. <param name="r">The r.</param>
  12718. </member>
  12719. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(NPOI.HSSF.Record.Record)">
  12720. <summary>
  12721. Removes the specified record.
  12722. </summary>
  12723. <param name="record">The record.</param>
  12724. </member>
  12725. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(System.Int32)">
  12726. <summary>
  12727. Removes the specified position.
  12728. </summary>
  12729. <param name="pos">The position.</param>
  12730. </member>
  12731. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Records">
  12732. <summary>
  12733. Gets or sets the records.
  12734. </summary>
  12735. <value>The records.</value>
  12736. </member>
  12737. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Count">
  12738. <summary>
  12739. Gets the count.
  12740. </summary>
  12741. <value>The count.</value>
  12742. </member>
  12743. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Item(System.Int32)">
  12744. <summary>
  12745. Gets the <see cref="T:NPOI.HSSF.Record.Record"/> at the specified index.
  12746. </summary>
  12747. <value></value>
  12748. </member>
  12749. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Protpos">
  12750. <summary>
  12751. Gets or sets the protpos.
  12752. </summary>
  12753. <value>The protpos.</value>
  12754. </member>
  12755. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Bspos">
  12756. <summary>
  12757. Gets or sets the bspos.
  12758. </summary>
  12759. <value>The bspos.</value>
  12760. </member>
  12761. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Tabpos">
  12762. <summary>
  12763. Gets or sets the tabpos.
  12764. </summary>
  12765. <value>The tabpos.</value>
  12766. </member>
  12767. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Fontpos">
  12768. <summary>
  12769. Gets or sets the fontpos.
  12770. </summary>
  12771. <value>The fontpos.</value>
  12772. </member>
  12773. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Xfpos">
  12774. <summary>
  12775. Gets or sets the xfpos.
  12776. </summary>
  12777. <value>The xfpos.</value>
  12778. </member>
  12779. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Backuppos">
  12780. <summary>
  12781. Gets or sets the backuppos.
  12782. </summary>
  12783. <value>The backuppos.</value>
  12784. </member>
  12785. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Palettepos">
  12786. <summary>
  12787. Gets or sets the palettepos.
  12788. </summary>
  12789. <value>The palettepos.</value>
  12790. </member>
  12791. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Namepos">
  12792. <summary>
  12793. Gets or sets the namepos.
  12794. </summary>
  12795. <value>The namepos.</value>
  12796. </member>
  12797. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Supbookpos">
  12798. <summary>
  12799. Gets or sets the supbookpos.
  12800. </summary>
  12801. <value>The supbookpos.</value>
  12802. </member>
  12803. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.ExternsheetPos">
  12804. <summary>
  12805. Gets or sets the externsheet pos.
  12806. </summary>
  12807. <value>The externsheet pos.</value>
  12808. </member>
  12809. <member name="T:NPOI.HSSF.Record.AbstractEscherHolderRecord">
  12810. The escher container record is used to hold escher records. It is abstract and
  12811. must be subclassed for maximum benefit.
  12812. @author Glen Stampoultzis (glens at apache.org)
  12813. @author Michael Zalewski (zalewski at optonline.net)
  12814. </member>
  12815. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12816. Constructs a Bar record and Sets its fields appropriately.
  12817. @param in the RecordInputstream to Read the record from
  12818. </member>
  12819. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.AddEscherRecord(System.Int32,NPOI.DDF.EscherRecord)">
  12820. Clone the current record, via a call to serialise
  12821. it, and another to Create a new record from the
  12822. bytes.
  12823. May only be used for classes which don't have
  12824. internal counts / ids in them. For those which
  12825. do, a full record-aware serialise is needed, which
  12826. allocates new ids / counts as needed.
  12827. </member>
  12828. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.GetEscherContainer">
  12829. If we have a EscherContainerRecord as one of our
  12830. children (and most top level escher holders do),
  12831. then return that.
  12832. </member>
  12833. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.FindFirstWithId(System.Int16)">
  12834. Descends into all our children, returning the
  12835. first EscherRecord with the given id, or null
  12836. if none found
  12837. </member>
  12838. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Join(NPOI.HSSF.Record.AbstractEscherHolderRecord)">
  12839. Big drawing Group records are split but it's easier to deal with them
  12840. as a whole Group so we need to join them toGether.
  12841. </member>
  12842. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Decode">
  12843. Convert raw data to escher records.
  12844. </member>
  12845. <member name="P:NPOI.HSSF.Record.AbstractEscherHolderRecord.RecordSize">
  12846. Size of record (including 4 byte header)
  12847. </member>
  12848. <member name="T:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate">
  12849. <summary>
  12850. </summary>
  12851. CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord
  12852. and number of up to three CFRuleRecord records toGether to simplify
  12853. access to them.
  12854. @author Dmitriy Kumshayev
  12855. </member>
  12856. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.MAX_CONDTIONAL_FORMAT_RULES">
  12857. Excel allows up to 3 conditional formating rules
  12858. </member>
  12859. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.rules">
  12860. List of CFRuleRecord objects
  12861. </member>
  12862. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(NPOI.HSSF.Model.RecordStream)">
  12863. <summary>
  12864. Create CFRecordsAggregate from a list of CF Records
  12865. </summary>
  12866. <param name="rs">list of Record objects</param>
  12867. </member>
  12868. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(System.Collections.IList,System.Int32)">
  12869. <summary>
  12870. Create CFRecordsAggregate from a list of CF Records
  12871. </summary>
  12872. <param name="recs">list of Record objects</param>
  12873. <param name="pOffset">position of CFHeaderRecord object in the list of Record objects</param>
  12874. </member>
  12875. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CloneCFAggregate">
  12876. <summary>
  12877. Create a deep Clone of the record
  12878. </summary>
  12879. </member>
  12880. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  12881. <summary>
  12882. called by the class that is responsible for writing this sucker.
  12883. Subclasses should implement this so that their data is passed back in a
  12884. byte array.
  12885. </summary>
  12886. <param name="offset">The offset to begin writing at</param>
  12887. <param name="data">The data byte array containing instance data</param>
  12888. <returns> number of bytes written</returns>
  12889. </member>
  12890. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  12891. @return <c>false</c> if this whole {@link CFHeaderRecord} / {@link CFRuleRecord}s should be deleted
  12892. </member>
  12893. <member name="P:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.RecordSize">
  12894. @return sum of sizes of all aggregated records
  12895. </member>
  12896. <member name="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate">
  12897. <summary>
  12898. @author Glen Stampoultzis
  12899. </summary>
  12900. </member>
  12901. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor">
  12902. <summary>
  12903. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  12904. </summary>
  12905. </member>
  12906. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream)">
  12907. <summary>
  12908. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  12909. </summary>
  12910. <param name="rs">The rs.</param>
  12911. </member>
  12912. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Clone">
  12913. Performs a deep Clone of the record
  12914. </member>
  12915. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(NPOI.HSSF.Record.ColumnInfoRecord)">
  12916. <summary>
  12917. Inserts a column into the aggregate (at the end of the list).
  12918. </summary>
  12919. <param name="col">The column.</param>
  12920. </member>
  12921. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(System.Int32,NPOI.HSSF.Record.ColumnInfoRecord)">
  12922. <summary>
  12923. Inserts a column into the aggregate (at the position specified
  12924. by index
  12925. </summary>
  12926. <param name="idx">The index.</param>
  12927. <param name="col">The columninfo.</param>
  12928. </member>
  12929. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  12930. <summary>
  12931. called by the class that is responsible for writing this sucker.
  12932. Subclasses should implement this so that their data is passed back in a
  12933. byte array.
  12934. </summary>
  12935. <param name="offset">offset to begin writing at</param>
  12936. <param name="data">byte array containing instance data</param>
  12937. <returns>number of bytes written</returns>
  12938. </member>
  12939. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  12940. <summary>
  12941. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  12942. that they should be written to file. Implementors may or may not return the actual
  12943. Records being used to manage POI's internal implementation. Callers should not
  12944. assume either way, and therefore only attempt to modify those Records after cloning
  12945. </summary>
  12946. <param name="rv"></param>
  12947. </member>
  12948. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindStartOfColumnOutlineGroup(System.Int32)">
  12949. <summary>
  12950. Finds the start of column outline group.
  12951. </summary>
  12952. <param name="idx">The idx.</param>
  12953. <returns></returns>
  12954. </member>
  12955. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindEndOfColumnOutlineGroup(System.Int32)">
  12956. <summary>
  12957. Finds the end of column outline group.
  12958. </summary>
  12959. <param name="idx">The idx.</param>
  12960. <returns></returns>
  12961. </member>
  12962. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GetColInfo(System.Int32)">
  12963. <summary>
  12964. Gets the col info.
  12965. </summary>
  12966. <param name="idx">The idx.</param>
  12967. <returns></returns>
  12968. </member>
  12969. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupCollapsed(System.Int32)">
  12970. <summary>
  12971. Determines whether [is column group collapsed] [the specified idx].
  12972. </summary>
  12973. <param name="idx">The idx.</param>
  12974. <returns>
  12975. <c>true</c> if [is column group collapsed] [the specified idx]; otherwise, <c>false</c>.
  12976. </returns>
  12977. </member>
  12978. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupHiddenByParent(System.Int32)">
  12979. <summary>
  12980. Determines whether [is column group hidden by parent] [the specified idx].
  12981. </summary>
  12982. <param name="idx">The idx.</param>
  12983. <returns>
  12984. <c>true</c> if [is column group hidden by parent] [the specified idx]; otherwise, <c>false</c>.
  12985. </returns>
  12986. </member>
  12987. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColumn(System.Int32)">
  12988. <summary>
  12989. Collapses the column.
  12990. </summary>
  12991. <param name="columnNumber">The column number.</param>
  12992. </member>
  12993. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.ExpandColumn(System.Int32)">
  12994. <summary>
  12995. Expands the column.
  12996. </summary>
  12997. <param name="columnNumber">The column number.</param>
  12998. </member>
  12999. <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})">
  13000. Sets all non null fields into the <c>ci</c> parameter.
  13001. </member>
  13002. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.AttemptMergeColInfoRecords(System.Int32)">
  13003. <summary>
  13004. Attempts to merge the col info record at the specified index
  13005. with either or both of its neighbours
  13006. </summary>
  13007. <param name="colInfoIx">The col info ix.</param>
  13008. </member>
  13009. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MergeColInfoRecords(NPOI.HSSF.Record.ColumnInfoRecord,NPOI.HSSF.Record.ColumnInfoRecord)">
  13010. merges two column info records (if they are adjacent and have the same formatting, etc)
  13011. @return <c>false</c> if the two column records could not be merged
  13012. </member>
  13013. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  13014. <summary>
  13015. Sets all adjacent columns of the same outline level to the specified hidden status.
  13016. </summary>
  13017. <param name="pIdx">the col info index of the start of the outline group.</param>
  13018. <param name="level">The level.</param>
  13019. <param name="hidden">The hidden.</param>
  13020. <returns>the column index of the last column in the outline group</returns>
  13021. </member>
  13022. <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})">
  13023. <summary>
  13024. Sets the column.
  13025. </summary>
  13026. <param name="targetColumnIx">The target column ix.</param>
  13027. <param name="xfIndex">Index of the xf.</param>
  13028. <param name="width">The width.</param>
  13029. <param name="level">The level.</param>
  13030. <param name="hidden">The hidden.</param>
  13031. <param name="collapsed">The collapsed.</param>
  13032. </member>
  13033. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Int16,System.Int16,System.Int32,System.Boolean,System.Boolean)">
  13034. Sets all non null fields into the <c>ci</c> parameter.
  13035. </member>
  13036. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColInfoRecords(System.Int32)">
  13037. <summary>
  13038. Collapses the col info records.
  13039. </summary>
  13040. <param name="columnIdx">The column index.</param>
  13041. </member>
  13042. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  13043. <summary>
  13044. Creates an outline Group for the specified columns.
  13045. </summary>
  13046. <param name="fromColumnIx">Group from this column (inclusive)</param>
  13047. <param name="toColumnIx">Group to this column (inclusive)</param>
  13048. <param name="indent">if true the Group will be indented by one level;if false indenting will be Removed by one level.</param>
  13049. </member>
  13050. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindColumnInfo(System.Int32)">
  13051. <summary>
  13052. Finds the ColumnInfoRecord
  13053. which contains the specified columnIndex
  13054. </summary>
  13055. <param name="columnIndex">index of the column (not the index of the ColumnInfoRecord)</param>
  13056. <returns> /// <c>null</c>
  13057. if no column info found for the specified column
  13058. </returns>
  13059. </member>
  13060. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Sid">
  13061. It's an aggregate... just made something up
  13062. </member>
  13063. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.NumColumns">
  13064. <summary>
  13065. Gets the num columns.
  13066. </summary>
  13067. <value>The num columns.</value>
  13068. </member>
  13069. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.RecordSize">
  13070. <summary>
  13071. Gets the size of the record.
  13072. </summary>
  13073. <value>The size of the record.</value>
  13074. </member>
  13075. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MaxOutlineLevel">
  13076. <summary>
  13077. Gets the max outline level.
  13078. </summary>
  13079. <value>The max outline level.</value>
  13080. </member>
  13081. <member name="T:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable">
  13082. Holds all the conditional formatting for a workbook sheet.<p/>
  13083. See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'
  13084. @author Josh Micich
  13085. </member>
  13086. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.#ctor">
  13087. Creates an empty ConditionalFormattingTable
  13088. </member>
  13089. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.Add(NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  13090. @return index of the newly added CF header aggregate
  13091. </member>
  13092. <member name="T:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate">
  13093. Manages the all the records associated with a 'Custom View Settings' sub-stream.<br/>
  13094. Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB).
  13095. @author Josh Micich
  13096. </member>
  13097. <member name="F:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate._recs">
  13098. All the records between BOF and EOF
  13099. </member>
  13100. <member name="T:NPOI.HSSF.Record.Aggregates.DataValidityTable">
  13101. <summary>
  13102. Manages the DVALRecord and DVRecords for a single sheet
  13103. See OOO excelfileformat.pdf section 4.14
  13104. @author Josh Micich
  13105. </summary>
  13106. </member>
  13107. <member name="F:NPOI.HSSF.Record.Aggregates.DataValidityTable._validationList">
  13108. The list of data validations for the current sheet.
  13109. Note - this may be empty (contrary to OOO documentation)
  13110. </member>
  13111. <member name="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate">
  13112. <summary>
  13113. The formula record aggregate is used to join toGether the formula record and it's
  13114. (optional) string record and (optional) Shared Formula Record (template Reads, excel optimization).
  13115. @author Glen Stampoultzis (glens at apache.org)
  13116. </summary>
  13117. </member>
  13118. <member name="T:NPOI.HSSF.Record.CellValueRecordInterface">
  13119. The cell value record interface Is implemented by all classes of type Record that
  13120. contain cell values. It allows the containing sheet to move through them and Compare
  13121. them.
  13122. @author Andrew C. Oliver (acoliver at apache dot org)
  13123. @author Jason Height (jheight at chariot dot net dot au)
  13124. @see org.apache.poi.hssf.model.Sheet
  13125. @see org.apache.poi.hssf.record.Record
  13126. @see org.apache.poi.hssf.record.RecordFactory
  13127. </member>
  13128. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Row">
  13129. Get the row this cell occurs on
  13130. @return the row
  13131. </member>
  13132. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Column">
  13133. Get the column this cell defines within the row
  13134. @return the column
  13135. </member>
  13136. <member name="F:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate._stringRecord">
  13137. caches the calculated result of the formula
  13138. </member>
  13139. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.#ctor(NPOI.HSSF.Record.FormulaRecord,NPOI.HSSF.Record.StringRecord,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  13140. <summary>
  13141. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate"/> class.
  13142. </summary>
  13143. <param name="formulaRec">The formula rec.</param>
  13144. <param name="stringRec">The string rec.</param>
  13145. <param name="svm">The SVM.</param>
  13146. </member>
  13147. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.NotifyFormulaChanging">
  13148. Should be called by any code which is either deleting this formula cell, or changing
  13149. its type. This method gives the aggregate a chance to unlink any shared formula
  13150. that may be involved with this cell formula.
  13151. </member>
  13152. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Serialize(System.Int32,System.Byte[])">
  13153. <summary>
  13154. called by the class that is responsible for writing this sucker.
  13155. Subclasses should implement this so that their data is passed back in a
  13156. byte array.
  13157. </summary>
  13158. <param name="offset">offset to begin writing at</param>
  13159. <param name="data">byte array containing instance data.</param>
  13160. <returns>number of bytes written</returns>
  13161. </member>
  13162. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  13163. <summary>
  13164. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  13165. that they should be written to file. Implementors may or may not return the actual
  13166. {@link Record}s being used to manage POI's internal implementation. Callers should not
  13167. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  13168. </summary>
  13169. <param name="rv"></param>
  13170. </member>
  13171. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  13172. <summary>
  13173. Sometimes the shared formula flag "seems" to be erroneously set (because the corresponding
  13174. SharedFormulaRecord does not exist). Normally this would leave no way of determining
  13175. the Ptg tokens for the formula. However as it turns out in these
  13176. cases, Excel encodes the unshared Ptg tokens in the right place (inside the FormulaRecord).
  13177. So the the only thing that needs to be done is to ignore the erroneous
  13178. shared formula flag.
  13179. This method may also be used for setting breakpoints to help diagnose issues regarding the
  13180. abnormally-set 'shared formula' flags.
  13181. </summary>
  13182. <param name="formula">The formula.</param>
  13183. </member>
  13184. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Equals(System.Object)">
  13185. <summary>
  13186. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  13187. </summary>
  13188. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  13189. <returns>
  13190. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  13191. </returns>
  13192. <exception cref="T:System.NullReferenceException">
  13193. The <paramref name="obj"/> parameter is null.
  13194. </exception>
  13195. </member>
  13196. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.ToString">
  13197. <summary>
  13198. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  13199. </summary>
  13200. <returns>
  13201. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  13202. </returns>
  13203. </member>
  13204. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedStringResult(System.String)">
  13205. <summary>
  13206. Sets the cached string result.
  13207. </summary>
  13208. <param name="value">The value.</param>
  13209. </member>
  13210. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedBooleanResult(System.Boolean)">
  13211. <summary>
  13212. Sets the cached boolean result.
  13213. </summary>
  13214. <param name="value">if set to <c>true</c> [value].</param>
  13215. </member>
  13216. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedErrorResult(System.Int32)">
  13217. <summary>
  13218. Sets the cached error result.
  13219. </summary>
  13220. <param name="errorCode">The error code.</param>
  13221. </member>
  13222. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetParsedExpression(NPOI.SS.Formula.PTG.Ptg[])">
  13223. Also checks for a related shared formula and unlinks it if found
  13224. </member>
  13225. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RemoveArrayFormula(System.Int32,System.Int32)">
  13226. Removes an array formula
  13227. @return the range of the array formula containing the specified cell. Never <code>null</code>
  13228. </member>
  13229. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RecordSize">
  13230. <summary>
  13231. Get the current Serialized size of the record. Should include the sid and recLength (4 bytes).
  13232. </summary>
  13233. <value>The size of the record.</value>
  13234. </member>
  13235. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Sid">
  13236. <summary>
  13237. return the non static version of the id for this record.
  13238. </summary>
  13239. <value>The sid.</value>
  13240. </member>
  13241. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.FormulaRecord">
  13242. <summary>
  13243. Gets or sets the formula record.
  13244. </summary>
  13245. <value>The formula record.</value>
  13246. </member>
  13247. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringRecord">
  13248. <summary>
  13249. Gets or sets the string record.
  13250. </summary>
  13251. <value>The string record.</value>
  13252. </member>
  13253. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringValue">
  13254. <summary>
  13255. Gets the string value.
  13256. </summary>
  13257. <value>The string value.</value>
  13258. </member>
  13259. <member name="T:NPOI.HSSF.Record.Aggregates.MergedCellsTable">
  13260. @author Josh Micich
  13261. </member>
  13262. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.#ctor">
  13263. <summary>
  13264. Creates an empty aggregate
  13265. </summary>
  13266. </member>
  13267. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.Read(NPOI.HSSF.Model.RecordStream)">
  13268. Reads zero or more consecutive {@link MergeCellsRecord}s
  13269. @param rs
  13270. </member>
  13271. <member name="T:NPOI.HSSF.Record.Aggregates.PageSettingsBlock">
  13272. Groups the page settings records for a worksheet.<p/>
  13273. See OOO excelfileformat.pdf sec 4.4 'Page Settings Block'
  13274. @author Josh Micich
  13275. </member>
  13276. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.#ctor">
  13277. Creates a PageSettingsBlock with default settings
  13278. </member>
  13279. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsComponentRecord(System.Int32)">
  13280. @return <c>true</c> if the specified Record sid is one belonging to the
  13281. 'Page Settings Block'.
  13282. </member>
  13283. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetColumnBreak(System.Int32,System.Int32,System.Int32)">
  13284. Sets a page break at the indicated column
  13285. </member>
  13286. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveColumnBreak(System.Int32)">
  13287. Removes a page break at the indicated column
  13288. </member>
  13289. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateHCenter">
  13290. Creates the HCenter Record and sets it to false (don't horizontally center)
  13291. </member>
  13292. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateVCenter">
  13293. Creates the VCenter Record and sets it to false (don't horizontally center)
  13294. </member>
  13295. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreatePrintSetup">
  13296. Creates the PrintSetup Record and sets it to defaults and marks it invalid
  13297. @see org.apache.poi.hssf.record.PrintSetupRecord
  13298. @see org.apache.poi.hssf.record.Record
  13299. @return record containing a PrintSetupRecord
  13300. </member>
  13301. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.GetMargin(NPOI.SS.UserModel.MarginType)">
  13302. Gets the size of the margin in inches.
  13303. @param margin which margin to Get
  13304. @return the size of the margin
  13305. </member>
  13306. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  13307. Sets the size of the margin in inches.
  13308. @param margin which margin to Get
  13309. @param size the size of the margin
  13310. </member>
  13311. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int32,System.Int32,System.Int32)">
  13312. Shifts all the page breaks in the range "count" number of rows/columns
  13313. @param breaks The page record to be shifted
  13314. @param start Starting "main" value to shift breaks
  13315. @param stop Ending "main" value to shift breaks
  13316. @param count number of units (rows/columns) to shift by
  13317. </member>
  13318. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetRowBreak(System.Int32,System.Int16,System.Int16)">
  13319. Sets a page break at the indicated row
  13320. @param row
  13321. </member>
  13322. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveRowBreak(System.Int32)">
  13323. Removes a page break at the indicated row
  13324. @param row
  13325. </member>
  13326. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsRowBroken(System.Int32)">
  13327. Queries if the specified row has a page break
  13328. @param row
  13329. @return true if the specified row has a page break
  13330. </member>
  13331. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsColumnBroken(System.Int32)">
  13332. Queries if the specified column has a page break
  13333. @return <c>true</c> if the specified column has a page break
  13334. </member>
  13335. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  13336. Shifts the horizontal page breaks for the indicated count
  13337. @param startingRow
  13338. @param endingRow
  13339. @param count
  13340. </member>
  13341. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  13342. Shifts the vertical page breaks for the indicated count
  13343. @param startingCol
  13344. @param endingCol
  13345. @param count
  13346. </member>
  13347. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateHeaderFooter(NPOI.HSSF.Record.HeaderFooterRecord)">
  13348. <summary>
  13349. HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after
  13350. the PageSettingsBlock where it belongs.
  13351. </summary>
  13352. <param name="rec"></param>
  13353. </member>
  13354. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateRecords(NPOI.HSSF.Model.RecordStream)">
  13355. <summary>
  13356. This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered.
  13357. As each record is read, it is incorporated into this PageSettingsBlock.
  13358. </summary>
  13359. <param name="rs"></param>
  13360. </member>
  13361. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Header">
  13362. Returns the HeaderRecord.
  13363. @return HeaderRecord for the sheet.
  13364. </member>
  13365. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Footer">
  13366. Returns the FooterRecord.
  13367. @return FooterRecord for the sheet.
  13368. </member>
  13369. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.PrintSetup">
  13370. Returns the PrintSetupRecord.
  13371. @return PrintSetupRecord for the sheet.
  13372. </member>
  13373. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RowBreaks">
  13374. @return all the horizontal page breaks, never <c>null</c>
  13375. </member>
  13376. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumRowBreaks">
  13377. @return the number of row page breaks
  13378. </member>
  13379. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ColumnBreaks">
  13380. @return all the column page breaks, never <c>null</c>
  13381. </member>
  13382. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumColumnBreaks">
  13383. @return the number of column page breaks
  13384. </member>
  13385. <member name="F:NPOI.HSSF.Record.Aggregates.PLSAggregate._plsContinues">
  13386. holds any continue records found after the PLS record.<br/>
  13387. This would not be required if PLS was properly interpreted.
  13388. Currently, PLS is an {@link UnknownRecord} and does not automatically
  13389. include any trailing {@link ContinueRecord}s.
  13390. </member>
  13391. <member name="T:NPOI.HSSF.Record.Aggregates.PositionTrackingVisitor">
  13392. A wrapper for {@link RecordVisitor} which accumulates the sizes of all
  13393. records visited.
  13394. </member>
  13395. <member name="T:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate">
  13396. @author andy
  13397. @author Jason Height (jheight at chariot dot net dot au)
  13398. </member>
  13399. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor">
  13400. Creates a new instance of ValueRecordsAggregate
  13401. </member>
  13402. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  13403. @param rs record stream with all {@link SharedFormulaRecord}
  13404. {@link ArrayRecord}, {@link TableRecord} {@link MergeCellsRecord} Records removed
  13405. </member>
  13406. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.AddUnknownRecord(NPOI.HSSF.Record.Record)">
  13407. Handles UnknownRecords which appear within the row/cell records
  13408. </member>
  13409. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetRowCountForBlock(System.Int32)">
  13410. Returns the number of physical rows within a block
  13411. </member>
  13412. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetStartRowNumberForBlock(System.Int32)">
  13413. Returns the physical row number of the first row in a block
  13414. </member>
  13415. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetEndRowNumberForBlock(System.Int32)">
  13416. Returns the physical row number of the end row in a block
  13417. </member>
  13418. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.CreateRow(System.Int32)">
  13419. Create a row record.
  13420. @param row number
  13421. @return RowRecord Created for the passed in row number
  13422. @see org.apache.poi.hssf.record.RowRecord
  13423. </member>
  13424. <member name="P:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.RowBlockCount">
  13425. Returns the number of row blocks.
  13426. <p/>The row blocks are goupings of rows that contain the DBCell record
  13427. after them
  13428. </member>
  13429. <member name="T:NPOI.HSSF.Record.Aggregates.SharedValueManager">
  13430. <summary>
  13431. Manages various auxiliary records while constructing a RowRecordsAggregate
  13432. @author Josh Micich
  13433. </summary>
  13434. </member>
  13435. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager._groupsCache">
  13436. cached for optimization purposes
  13437. </member>
  13438. <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})">
  13439. @param firstCells
  13440. @param recs list of sheet records (possibly Contains records for other parts of the Excel file)
  13441. @param startIx index of first row/cell record for current sheet
  13442. @param endIx one past index of last row/cell record for current sheet. It is important
  13443. that this code does not inadvertently collect <c>SharedFormulaRecord</c>s from any other
  13444. sheet (which could happen if endIx is chosen poorly). (see bug 44449)
  13445. </member>
  13446. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.LinkSharedFormulaRecord(NPOI.SS.Util.CellReference,NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  13447. @param firstCell as extracted from the {@link ExpPtg} from the cell's formula.
  13448. @return never <code>null</code>
  13449. </member>
  13450. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetRecordForFirstCell(NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  13451. Gets the {@link SharedValueRecordBase} record if it should be encoded immediately after the
  13452. formula record Contained in the specified {@link FormulaRecordAggregate} agg. Note - the
  13453. shared value record always appears after the first formula record in the group. For arrays
  13454. and tables the first formula is always the in the top left cell. However, since shared
  13455. formula groups can be sparse and/or overlap, the first formula may not actually be in the
  13456. top left cell.
  13457. @return the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of
  13458. a table or array region. <code>null</code> if the formula cell is not shared/array/table,
  13459. or if the specified formula is not the the first in the group.
  13460. </member>
  13461. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Unlink(NPOI.HSSF.Record.SharedFormulaRecord)">
  13462. Converts all {@link FormulaRecord}s handled by <c>sharedFormulaRecord</c>
  13463. to plain unshared formulas
  13464. </member>
  13465. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.AddArrayRecord(NPOI.HSSF.Record.ArrayRecord)">
  13466. Add specified Array Record.
  13467. </member>
  13468. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.RemoveArrayFormula(System.Int32,System.Int32)">
  13469. Removes the {@link ArrayRecord} for the cell group containing the specified cell.
  13470. The caller should clear (set blank) all cells in the returned range.
  13471. @return the range of the array formula which was just removed. Never <code>null</code>.
  13472. </member>
  13473. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetArrayRecord(System.Int32,System.Int32)">
  13474. @return the shared ArrayRecord identified by (firstRow, firstColumn). never <code>null</code>.
  13475. </member>
  13476. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup._firstCell">
  13477. Coordinates of the first cell having a formula that uses this shared formula.
  13478. This is often <i>but not always</i> the top left cell in the range covered by
  13479. {@link #_sfr}
  13480. </member>
  13481. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup.IsFirstCell(System.Int32,System.Int32)">
  13482. Note - the 'first cell' of a shared formula group is not always the top-left cell
  13483. of the enclosing range.
  13484. @return <c>true</c> if the specified coordinates correspond to the 'first cell'
  13485. of this shared formula group.
  13486. </member>
  13487. <member name="T:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate">
  13488. Aggregate value records toGether. Things are easier to handle that way.
  13489. @author andy
  13490. @author Glen Stampoultzis (glens at apache.org)
  13491. @author Jason Height (jheight at chariot dot net dot au)
  13492. </member>
  13493. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.#ctor">
  13494. Creates a new instance of ValueRecordsAggregate
  13495. </member>
  13496. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  13497. Sometimes the shared formula flag "seems" to be erroneously Set, in which case there is no
  13498. call to <c>SharedFormulaRecord.ConvertSharedFormulaRecord</c> and hence the
  13499. <c>ParsedExpression</c> field of this <c>FormulaRecord</c> will not Get updated.<br/>
  13500. As it turns out, this is not a problem, because in these circumstances, the existing value
  13501. for <c>ParsedExpression</c> is perfectly OK.<p/>
  13502. This method may also be used for Setting breakpoints to help diagnose Issues regarding the
  13503. abnormally-Set 'shared formula' flags.
  13504. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).<p/>
  13505. The method currently does nothing but do not delete it without Finding a nice home for this
  13506. comment.
  13507. </member>
  13508. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.GetRowCellBlockSize(System.Int32,System.Int32)">
  13509. Tallies a count of the size of the cell records
  13510. that are attached to the rows in the range specified.
  13511. </member>
  13512. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.RowHasCells(System.Int32)">
  13513. Returns true if the row has cells attached to it
  13514. </member>
  13515. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.SerializeCellRow(System.Int32,System.Int32,System.Byte[])">
  13516. Serializes the cells that are allocated to a certain row range
  13517. </member>
  13518. <member name="T:NPOI.HSSF.Record.ArrayRecord">
  13519. ARRAY (0x0221)<p/>
  13520. Treated in a similar way to SharedFormulaRecord
  13521. @author Josh Micich
  13522. </member>
  13523. <member name="T:NPOI.HSSF.Record.SharedValueRecordBase">
  13524. Common base class for {@link SharedFormulaRecord}, {@link ArrayRecord} and
  13525. {@link TableRecord} which are have similarities.
  13526. @author Josh Micich
  13527. </member>
  13528. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13529. reads only the range (1 {@link CellRangeAddress8Bit}) from the stream
  13530. </member>
  13531. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsInRange(System.Int32,System.Int32)">
  13532. @return <c>true</c> if (rowIx, colIx) is within the range ({@link #Range})
  13533. of this shared value object.
  13534. </member>
  13535. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsFirstCell(System.Int32,System.Int32)">
  13536. @return <c>true</c> if (rowIx, colIx) describes the first cell in this shared value
  13537. object's range ({@link #Range})
  13538. </member>
  13539. <member name="T:NPOI.HSSF.Record.AutoFilter.DOPERRecord">
  13540. <summary>
  13541. DOPER Structure for AutoFilter record
  13542. </summary>
  13543. <remarks>author: Tony Qu</remarks>
  13544. </member>
  13545. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.RK">
  13546. <summary>
  13547. get or set the RK record
  13548. </summary>
  13549. </member>
  13550. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.LengthOfString">
  13551. <summary>
  13552. Gets or sets Length of the string (the string is stored in the rgch field that follows the DOPER structures)
  13553. </summary>
  13554. </member>
  13555. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsBooleanValue">
  13556. <summary>
  13557. Whether the bBoolErr field contains a Boolean value
  13558. </summary>
  13559. </member>
  13560. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsErrorValue">
  13561. <summary>
  13562. Whether the bBoolErr field contains a Error value
  13563. </summary>
  13564. </member>
  13565. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.BooleanValue">
  13566. <summary>
  13567. Get or sets the boolean value
  13568. </summary>
  13569. </member>
  13570. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.ErrorValue">
  13571. <summary>
  13572. Get or sets the boolean value
  13573. </summary>
  13574. </member>
  13575. <member name="T:NPOI.HSSF.Record.BackupRecord">
  13576. Title: Backup Record
  13577. Description: bool specifying whether
  13578. the GUI should store a backup of the file.
  13579. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13580. @author Andrew C. Oliver (acoliver at apache dot org)
  13581. @version 2.0-pre
  13582. </member>
  13583. <member name="M:NPOI.HSSF.Record.BackupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13584. Constructs a BackupRecord and Sets its fields appropriately
  13585. @param in the RecordInputstream to Read the record from
  13586. </member>
  13587. <member name="P:NPOI.HSSF.Record.BackupRecord.Backup">
  13588. Get the backup flag
  13589. @return short 0/1 (off/on)
  13590. </member>
  13591. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadRecordSID">
  13592. Read an unsigned short from the stream without decrypting
  13593. </member>
  13594. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadDataSize">
  13595. Read an unsigned short from the stream without decrypting
  13596. </member>
  13597. <member name="T:NPOI.HSSF.Record.BlankRecord">
  13598. Title: Blank cell record
  13599. Description: Represents a column in a row with no value but with styling.
  13600. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13601. @author Andrew C. Oliver (acoliver at apache dot org)
  13602. @author Jason Height (jheight at chariot dot net dot au)
  13603. @version 2.0-pre
  13604. </member>
  13605. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor">
  13606. Creates a new instance of BlankRecord
  13607. </member>
  13608. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13609. Constructs a BlankRecord and Sets its fields appropriately
  13610. @param in the RecordInputstream to Read the record from
  13611. </member>
  13612. <member name="M:NPOI.HSSF.Record.BlankRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13613. called by the class that is responsible for writing this sucker.
  13614. Subclasses should implement this so that their data is passed back in a
  13615. byte array.
  13616. @return byte array containing instance data
  13617. </member>
  13618. <member name="P:NPOI.HSSF.Record.BlankRecord.Row">
  13619. Get the row this cell occurs on
  13620. @return the row
  13621. </member>
  13622. <member name="P:NPOI.HSSF.Record.BlankRecord.Column">
  13623. Get the column this cell defines within the row
  13624. @return the column
  13625. </member>
  13626. <member name="P:NPOI.HSSF.Record.BlankRecord.XFIndex">
  13627. Set the index of the extended format record to style this cell with
  13628. @param xf - the 0-based index of the extended format
  13629. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  13630. </member>
  13631. <member name="P:NPOI.HSSF.Record.BlankRecord.Sid">
  13632. return the non static version of the id for this record.
  13633. </member>
  13634. <member name="T:NPOI.HSSF.Record.BOFRecord">
  13635. Title: Beginning Of File
  13636. Description: Somewhat of a misnomer, its used for the beginning of a Set of
  13637. records that have a particular pupose or subject.
  13638. Used in sheets and workbooks.
  13639. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13640. @author Andrew C. Oliver
  13641. @author Jason Height (jheight at chariot dot net dot au)
  13642. @version 2.0-pre
  13643. </member>
  13644. <member name="F:NPOI.HSSF.Record.BOFRecord.sid">
  13645. for BIFF8 files the BOF is 0x809. For earlier versions it was 0x09 or 0x(biffversion)09
  13646. </member>
  13647. <member name="F:NPOI.HSSF.Record.BOFRecord.VERSION">
  13648. suggested default (0x06 - BIFF8)
  13649. </member>
  13650. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD">
  13651. suggested default 0x10d3
  13652. </member>
  13653. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD_YEAR">
  13654. suggested default 0x07CC (1996)
  13655. </member>
  13656. <member name="F:NPOI.HSSF.Record.BOFRecord.HISTORY_MASK">
  13657. suggested default for a normal sheet (0x41)
  13658. </member>
  13659. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor">
  13660. Constructs an empty BOFRecord with no fields Set.
  13661. </member>
  13662. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13663. Constructs a BOFRecord and Sets its fields appropriately
  13664. @param in the RecordInputstream to Read the record from
  13665. </member>
  13666. <member name="P:NPOI.HSSF.Record.BOFRecord.Version">
  13667. Version number - for BIFF8 should be 0x06
  13668. @see #VERSION
  13669. @param version version to be Set
  13670. </member>
  13671. <member name="P:NPOI.HSSF.Record.BOFRecord.HistoryBitMask">
  13672. Set the history bit mask (not very useful)
  13673. @see #HISTORY_MASK
  13674. @param bitmask bitmask to Set for the history
  13675. </member>
  13676. <member name="P:NPOI.HSSF.Record.BOFRecord.RequiredVersion">
  13677. Set the minimum version required to Read this file
  13678. @see #VERSION
  13679. @param version version to Set
  13680. </member>
  13681. <member name="P:NPOI.HSSF.Record.BOFRecord.Type">
  13682. type of object this marks
  13683. @see #TYPE_WORKBOOK
  13684. @see #TYPE_VB_MODULE
  13685. @see #TYPE_WORKSHEET
  13686. @see #TYPE_CHART
  13687. @see #TYPE_EXCEL_4_MACRO
  13688. @see #TYPE_WORKSPACE_FILE
  13689. @return short type of object
  13690. </member>
  13691. <member name="P:NPOI.HSSF.Record.BOFRecord.Build">
  13692. Get the build that wrote this file
  13693. @see #BUILD
  13694. @return short build number of the generator of this file
  13695. </member>
  13696. <member name="P:NPOI.HSSF.Record.BOFRecord.BuildYear">
  13697. Year of the build that wrote this file
  13698. @see #BUILD_YEAR
  13699. @return short build year of the generator of this file
  13700. </member>
  13701. <member name="T:NPOI.HSSF.Record.BookBoolRecord">
  13702. Title: Save External Links record (BookBool)
  13703. Description: Contains a flag specifying whether the Gui should save externally
  13704. linked values from other workbooks.
  13705. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13706. @author Andrew C. Oliver (acoliver at apache dot org)
  13707. @version 2.0-pre
  13708. </member>
  13709. <member name="M:NPOI.HSSF.Record.BookBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13710. Constructs a BookBoolRecord and Sets its fields appropriately
  13711. @param in the RecordInputstream to Read the record from
  13712. </member>
  13713. <member name="P:NPOI.HSSF.Record.BookBoolRecord.SaveLinkValues">
  13714. Get the save ext links flag
  13715. @return short 0/1 (off/on)
  13716. </member>
  13717. <member name="T:NPOI.HSSF.Record.BoolErrRecord">
  13718. Creates new BoolErrRecord.
  13719. REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13720. @author Michael P. Harhen
  13721. @author Jason Height (jheight at chariot dot net dot au)
  13722. @version 2.0-pre
  13723. </member>
  13724. <member name="M:NPOI.HSSF.Record.CellRecord.AppendValueText(System.Text.StringBuilder)">
  13725. Append specific debug info (used by {@link #toString()} for the value
  13726. contained in this record. Trailing new-line should not be Appended
  13727. (superclass does that).
  13728. </member>
  13729. <member name="M:NPOI.HSSF.Record.CellRecord.SerializeValue(NPOI.Util.ILittleEndianOutput)">
  13730. writes out the value data for this cell record
  13731. </member>
  13732. <member name="P:NPOI.HSSF.Record.CellRecord.XFIndex">
  13733. get the index to the ExtendedFormat
  13734. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  13735. @return index to the XF record
  13736. </member>
  13737. <member name="P:NPOI.HSSF.Record.CellRecord.RecordName">
  13738. Gets the debug info BIFF record type name (used by {@link #toString()}.
  13739. </member>
  13740. <member name="P:NPOI.HSSF.Record.CellRecord.ValueDataSize">
  13741. @return the size (in bytes) of the value data for this cell record
  13742. </member>
  13743. <member name="F:NPOI.HSSF.Record.BoolErrRecord._isError">
  13744. If <code>true</code>, this record represents an error cell value, otherwise this record represents a boolean cell value
  13745. </member>
  13746. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor">
  13747. Creates new BoolErrRecord
  13748. </member>
  13749. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13750. Constructs a BoolErr record and Sets its fields appropriately.
  13751. @param in the RecordInputstream to Read the record from
  13752. </member>
  13753. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Boolean)">
  13754. Set the bool value for the cell
  13755. @param value representing the bool value
  13756. </member>
  13757. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Byte)">
  13758. Set the error value for the cell
  13759. @param value error representing the error value
  13760. this value can only be 0,7,15,23,29,36 or 42
  13761. see bugzilla bug 16560 for an explanation
  13762. </member>
  13763. <member name="P:NPOI.HSSF.Record.BoolErrRecord.BooleanValue">
  13764. Get the value for the cell
  13765. @return bool representing the bool value
  13766. </member>
  13767. <member name="P:NPOI.HSSF.Record.BoolErrRecord.ErrorValue">
  13768. Get the error value for the cell
  13769. @return byte representing the error value
  13770. </member>
  13771. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsBoolean">
  13772. Indicates whether the call holds a boolean value
  13773. @return boolean true if the cell holds a boolean value
  13774. </member>
  13775. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsError">
  13776. Indicates whether the call holds an error value
  13777. @return bool true if the cell holds an error value
  13778. </member>
  13779. <member name="T:NPOI.HSSF.Record.BottomMarginRecord">
  13780. Record for the bottom margin.
  13781. NOTE: This source was automatically generated.
  13782. @author Shawn Laubach (slaubach at apache dot org)
  13783. </member>
  13784. <member name="T:NPOI.HSSF.Record.IMargin">
  13785. The margin interface Is a parent used to define left, right, top and bottom margins.
  13786. This allows much of the code to be generic when it comes to handling margins.
  13787. NOTE: This source wass automatically generated.
  13788. @author Shawn Laubach (slaubach at apache dot org)
  13789. </member>
  13790. <member name="P:NPOI.HSSF.Record.IMargin.Margin">
  13791. Get the margin field for the Margin.
  13792. </member>
  13793. <member name="M:NPOI.HSSF.Record.BottomMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13794. Constructs a BottomMargin record and Sets its fields appropriately.
  13795. @param in the RecordInputstream to Read the record from
  13796. </member>
  13797. <member name="P:NPOI.HSSF.Record.BottomMarginRecord.Margin">
  13798. Get the margin field for the BottomMargin record.
  13799. </member>
  13800. <member name="T:NPOI.HSSF.Record.BoundSheetRecord">
  13801. Title: Bound Sheet Record (aka BundleSheet)
  13802. Description: Defines a sheet within a workbook. Basically stores the sheetname
  13803. and tells where the Beginning of file record Is within the HSSF
  13804. file.
  13805. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13806. @author Andrew C. Oliver (acoliver at apache dot org)
  13807. @author Sergei Kozello (sergeikozello at mail.ru)
  13808. </member>
  13809. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13810. Constructs a BoundSheetRecord and Sets its fields appropriately
  13811. @param in the RecordInputstream to Read the record from
  13812. </member>
  13813. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.OrderByBofPosition(System.Collections.Generic.List{NPOI.HSSF.Record.BoundSheetRecord})">
  13814. Converts a List of {@link BoundSheetRecord}s to an array and sorts by the position of their
  13815. BOFs.
  13816. </member>
  13817. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.PositionOfBof">
  13818. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  13819. @return offset in bytes
  13820. </member>
  13821. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.IsVeryHidden">
  13822. Is the sheet very hidden? Different from (normal) hidden
  13823. </member>
  13824. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.Sheetname">
  13825. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  13826. @return sheetname the name of the sheet
  13827. </member>
  13828. <member name="T:NPOI.HSSF.Record.CalcCountRecord">
  13829. Title: Calc Count Record
  13830. Description: Specifies the maximum times the gui should perform a formula
  13831. recalculation. For instance: in the case a formula includes
  13832. cells that are themselves a result of a formula and a value
  13833. Changes. This Is essentially a failsafe against an infinate
  13834. loop in the event the formulas are not independant.
  13835. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13836. @author Andrew C. Oliver (acoliver at apache dot org)
  13837. @author Jason Height (jheight at chariot dot net dot au)
  13838. @version 2.0-pre
  13839. @see org.apache.poi.hssf.record.CalcModeRecord
  13840. </member>
  13841. <member name="M:NPOI.HSSF.Record.CalcCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13842. Constructs a CalcCountRecord and Sets its fields appropriately
  13843. @param in the RecordInputstream to Read the record from
  13844. </member>
  13845. <member name="P:NPOI.HSSF.Record.CalcCountRecord.Iterations">
  13846. Get the number of iterations to perform
  13847. @return iterations
  13848. </member>
  13849. <member name="T:NPOI.HSSF.Record.CalcModeRecord">
  13850. Title: Calc Mode Record
  13851. Description: Tells the gui whether to calculate formulas
  13852. automatically, manually or automatically
  13853. except for tables.
  13854. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13855. @author Andrew C. Oliver (acoliver at apache dot org)
  13856. @author Jason Height (jheight at chariot dot net dot au)
  13857. @version 2.0-pre
  13858. @see org.apache.poi.hssf.record.CalcCountRecord
  13859. </member>
  13860. <member name="F:NPOI.HSSF.Record.CalcModeRecord.MANUAL">
  13861. manually calculate formulas (0)
  13862. </member>
  13863. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC">
  13864. automatically calculate formulas (1)
  13865. </member>
  13866. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC_EXCEPT_TABLES">
  13867. automatically calculate formulas except for tables (-1)
  13868. </member>
  13869. <member name="M:NPOI.HSSF.Record.CalcModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13870. Constructs a CalcModeRecord and Sets its fields appropriately
  13871. @param in the RecordInputstream to Read the record from
  13872. </member>
  13873. <member name="M:NPOI.HSSF.Record.CalcModeRecord.SetCalcMode(System.Int16)">
  13874. Set the calc mode flag for formulas
  13875. @see #MANUAL
  13876. @see #AUTOMATIC
  13877. @see #AUTOMATIC_EXCEPT_TABLES
  13878. @param calcmode one of the three flags above
  13879. </member>
  13880. <member name="M:NPOI.HSSF.Record.CalcModeRecord.GetCalcMode">
  13881. Get the calc mode flag for formulas
  13882. @see #MANUAL
  13883. @see #AUTOMATIC
  13884. @see #AUTOMATIC_EXCEPT_TABLES
  13885. @return calcmode one of the three flags above
  13886. </member>
  13887. <member name="T:NPOI.HSSF.Record.CFHeaderRecord">
  13888. Conditional Formatting Header record (CFHEADER)
  13889. @author Dmitriy Kumshayev
  13890. </member>
  13891. <member name="M:NPOI.HSSF.Record.CFHeaderRecord.#ctor">
  13892. Creates new CFHeaderRecord
  13893. </member>
  13894. <member name="T:NPOI.HSSF.Record.CFRuleRecord">
  13895. Conditional Formatting Rule Record.
  13896. @author Dmitriy Kumshayev
  13897. </member>
  13898. <member name="M:NPOI.HSSF.Record.CFRuleRecord.#ctor(System.Byte,NPOI.SS.UserModel.ComparisonOperator)">
  13899. Creates new CFRuleRecord
  13900. </member>
  13901. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFWorkbook,System.String)">
  13902. Creates a new comparison operation rule
  13903. </member>
  13904. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  13905. Creates a new comparison operation rule
  13906. </member>
  13907. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  13908. Creates a new comparison operation rule
  13909. </member>
  13910. <member name="M:NPOI.HSSF.Record.CFRuleRecord.GetFormulaSize(NPOI.SS.Formula.Formula)">
  13911. @param ptgs may be <c>null</c>
  13912. @return encoded size of the formula
  13913. </member>
  13914. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13915. called by the class that Is responsible for writing this sucker.
  13916. Subclasses should implement this so that their data Is passed back in a
  13917. byte array.
  13918. @param offset to begin writing at
  13919. @param data byte array containing instance data
  13920. @return number of bytes written
  13921. </member>
  13922. <member name="M:NPOI.HSSF.Record.CFRuleRecord.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  13923. TODO - Parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea
  13924. this call will produce the wrong results if the formula Contains any cell references
  13925. One approach might be to apply the inverse of SharedFormulaRecord.ConvertSharedFormulas(Stack, int, int)
  13926. Note - two extra parameters (rowIx &amp;colIx) will be required. They probably come from one of the Region objects.
  13927. @return <c>null</c> if <c>formula</c> was null.
  13928. </member>
  13929. <member name="M:NPOI.HSSF.Record.CFRuleRecord.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFSheet)">
  13930. TODO - parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea
  13931. this call will produce the wrong results if the formula contains any cell references
  13932. One approach might be to apply the inverse of SharedFormulaRecord.convertSharedFormulas(Stack, int, int)
  13933. Note - two extra parameters (rowIx &amp; colIx) will be required. They probably come from one of the Region objects.
  13934. @return <code>null</code> if <c>formula</c> was null.
  13935. </member>
  13936. <member name="P:NPOI.HSSF.Record.CFRuleRecord.ParsedExpression1">
  13937. get the stack of the 1st expression as a list
  13938. @return list of tokens (casts stack to a list and returns it!)
  13939. this method can return null is we are unable to create Ptgs from
  13940. existing excel file
  13941. callers should check for null!
  13942. </member>
  13943. <member name="P:NPOI.HSSF.Record.CFRuleRecord.ParsedExpression2">
  13944. get the stack of the 2nd expression as a list
  13945. @return list of tokens (casts stack to a list and returns it!)
  13946. this method can return null is we are unable to create Ptgs from
  13947. existing excel file
  13948. callers should check for null!
  13949. </member>
  13950. <member name="P:NPOI.HSSF.Record.CFRuleRecord.Options">
  13951. Get the option flags
  13952. @return bit mask
  13953. </member>
  13954. <member name="T:NPOI.HSSF.Record.CF.BorderFormatting">
  13955. Border Formatting Block of the Conditional Formatting Rule Record.
  13956. @author Dmitriy Kumshayev
  13957. </member>
  13958. <member name="M:NPOI.HSSF.Record.CF.BorderFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13959. Creates new FontFormatting
  13960. </member>
  13961. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderLeft">
  13962. <summary>
  13963. Get the type of border to use for the left border of the cell
  13964. </summary>
  13965. </member>
  13966. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderRight">
  13967. <summary>
  13968. Get the type of border to use for the right border of the cell
  13969. </summary>
  13970. </member>
  13971. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderTop">
  13972. <summary>
  13973. Get the type of border to use for the top border of the cell
  13974. </summary>
  13975. </member>
  13976. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderBottom">
  13977. <summary>
  13978. Get the type of border to use for the bottom border of the cell
  13979. </summary>
  13980. </member>
  13981. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderDiagonal">
  13982. <summary>
  13983. Get the type of border to use for the diagonal border of the cell
  13984. </summary>
  13985. </member>
  13986. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.LeftBorderColor">
  13987. <summary>
  13988. Get the color to use for the left border
  13989. </summary>
  13990. </member>
  13991. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.RightBorderColor">
  13992. <summary>
  13993. Get the color to use for the right border
  13994. </summary>
  13995. </member>
  13996. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.TopBorderColor">
  13997. <summary>
  13998. Get the color to use for the top border
  13999. </summary>
  14000. </member>
  14001. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BottomBorderColor">
  14002. <summary>
  14003. Get the color to use for the bottom border
  14004. </summary>
  14005. </member>
  14006. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.DiagonalBorderColor">
  14007. <summary>
  14008. Get the color to use for the diagonal border
  14009. </summary>
  14010. </member>
  14011. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsForwardDiagonalOn">
  14012. <summary>
  14013. true if forward diagonal is on
  14014. </summary>
  14015. </member>
  14016. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsBackwardDiagonalOn">
  14017. <summary>
  14018. true if backward diagonal Is on
  14019. </summary>
  14020. </member>
  14021. <member name="T:NPOI.HSSF.Record.CF.CellRangeUtil">
  14022. @author Dmitriy Kumshayev
  14023. </member>
  14024. <member name="F:NPOI.HSSF.Record.CF.CellRangeUtil.INSIDE">
  14025. first range is within the second range
  14026. </member>
  14027. <member name="F:NPOI.HSSF.Record.CF.CellRangeUtil.ENCLOSES">
  14028. first range encloses or is equal to the second
  14029. </member>
  14030. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.Intersect(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14031. Intersect this range with the specified range.
  14032. @param crB - the specified range
  14033. @return code which reflects how the specified range is related to this range.<br/>
  14034. Possible return codes are:
  14035. NO_INTERSECTION - the specified range is outside of this range;<br/>
  14036. OVERLAP - both ranges partially overlap;<br/>
  14037. INSIDE - the specified range is inside of this one<br/>
  14038. ENCLOSES - the specified range encloses (possibly exactly the same as) this range<br/>
  14039. </member>
  14040. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.MergeCellRanges(NPOI.SS.Util.CellRangeAddress[])">
  14041. Do all possible cell merges between cells of the list so that:
  14042. if a cell range is completely inside of another cell range, it s removed from the list
  14043. if two cells have a shared border, merge them into one bigger cell range
  14044. @param cellRangeList
  14045. @return updated List of cell ranges
  14046. </member>
  14047. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.MergeRanges(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14048. @return the new range(s) to replace the supplied ones. <c>null</c> if no merge is possible
  14049. </member>
  14050. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.SliceUp(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14051. @param crB never a full row or full column range
  14052. @return an array including <b>this</b> <c>CellRange</c> and all parts of <c>range</c>
  14053. outside of this range
  14054. </member>
  14055. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.Contains(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14056. Check if the specified range is located inside of this cell range.
  14057. @param crB
  14058. @return true if this cell range Contains the argument range inside if it's area
  14059. </member>
  14060. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.HasExactSharedBorder(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14061. Check if the specified cell range has a shared border with the current range.
  14062. @return <c>true</c> if the ranges have a complete shared border (i.e.
  14063. the two ranges toher make a simple rectangular region.
  14064. </member>
  14065. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.CreateEnclosingCellRange(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  14066. Create an enclosing CellRange for the two cell ranges.
  14067. @return enclosing CellRange
  14068. </member>
  14069. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.lt(System.Int32,System.Int32)">
  14070. @return true if a &lt; b
  14071. </member>
  14072. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.le(System.Int32,System.Int32)">
  14073. @return true if a &lt;= b
  14074. </member>
  14075. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.gt(System.Int32,System.Int32)">
  14076. @return true if a > b
  14077. </member>
  14078. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.ge(System.Int32,System.Int32)">
  14079. @return true if a >= b
  14080. </member>
  14081. <member name="T:NPOI.HSSF.Record.CF.FontFormatting">
  14082. Font Formatting Block of the Conditional Formatting Rule Record.
  14083. @author Dmitriy Kumshayev
  14084. </member>
  14085. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_NORMAL">
  14086. Normal boldness (not bold)
  14087. </member>
  14088. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_BOLD">
  14089. Bold boldness (bold)
  14090. </member>
  14091. <member name="M:NPOI.HSSF.Record.CF.FontFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14092. Creates new FontFormatting
  14093. </member>
  14094. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontHeight">
  14095. Gets the height of the font in 1/20th point Units
  14096. @return fontheight (in points/20); or -1 if not modified
  14097. </member>
  14098. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsItalic">
  14099. Get whether the font Is to be italics or not
  14100. @return italics - whether the font Is italics or not
  14101. @see #GetAttributes()
  14102. </member>
  14103. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsStruckout">
  14104. Get whether the font Is to be stricken out or not
  14105. @return strike - whether the font Is stricken out or not
  14106. @see #GetAttributes()
  14107. </member>
  14108. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontWeight">
  14109. <summary>
  14110. Get or set the font weight for this font (100-1000dec or 0x64-0x3e8).
  14111. Default Is 0x190 for normal and 0x2bc for bold
  14112. </summary>
  14113. </member>
  14114. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsBold">
  14115. <summary>
  14116. Get or set whether the font weight is set to bold or not
  14117. </summary>
  14118. </member>
  14119. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.EscapementType">
  14120. Get the type of base or subscript for the font
  14121. @return base or subscript option
  14122. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_NONE
  14123. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUPER
  14124. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUB
  14125. </member>
  14126. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.UnderlineType">
  14127. Get the type of Underlining for the font
  14128. @return font Underlining type
  14129. </member>
  14130. <member name="T:NPOI.HSSF.Record.CF.PatternFormatting">
  14131. Pattern Formatting Block of the Conditional Formatting Rule Record.
  14132. @author Dmitriy Kumshayev
  14133. </member>
  14134. <member name="M:NPOI.HSSF.Record.CF.PatternFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14135. Creates new FontFormatting
  14136. </member>
  14137. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillPattern">
  14138. Get the Fill pattern
  14139. @return Fill pattern
  14140. </member>
  14141. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillBackgroundColor">
  14142. Get the background Fill color
  14143. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  14144. @return Fill color
  14145. </member>
  14146. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillForegroundColor">
  14147. Get the foreground Fill color
  14148. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  14149. @return Fill color
  14150. </member>
  14151. <member name="T:NPOI.HSSF.Record.Chart.AreaFormatRecord">
  14152. * The area format record is used to define the colours and patterns for an area.
  14153. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14154. * Remove the record in src/records/definitions.
  14155. * @author Glen Stampoultzis (glens at apache.org)
  14156. </member>
  14157. <member name="M:NPOI.HSSF.Record.Chart.AreaFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14158. Constructs a AreaFormat record and s its fields appropriately.
  14159. @param in the RecordInputstream to Read the record from
  14160. </member>
  14161. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.DataSize">
  14162. Size of record (exluding 4 byte header)
  14163. </member>
  14164. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForegroundColor">
  14165. the foreground color field for the AreaFormat record.
  14166. </member>
  14167. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackgroundColor">
  14168. the background color field for the AreaFormat record.
  14169. </member>
  14170. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.Pattern">
  14171. the pattern field for the AreaFormat record.
  14172. </member>
  14173. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.FormatFlags">
  14174. the format flags field for the AreaFormat record.
  14175. </member>
  14176. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForecolorIndex">
  14177. the forecolor index field for the AreaFormat record.
  14178. </member>
  14179. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackcolorIndex">
  14180. the backcolor index field for the AreaFormat record.
  14181. </member>
  14182. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsAutomatic">
  14183. automatic formatting
  14184. @return the automatic field value.
  14185. </member>
  14186. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsInvert">
  14187. swap foreground and background colours when data is negative
  14188. @return the invert field value.
  14189. </member>
  14190. <member name="T:NPOI.HSSF.Record.Chart.AreaRecord">
  14191. * The area record is used to define a area chart.
  14192. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14193. * Remove the record in src/records/definitions.
  14194. * @author Glen Stampoultzis (glens at apache.org)
  14195. </member>
  14196. <member name="M:NPOI.HSSF.Record.Chart.AreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14197. Constructs a Area record and s its fields appropriately.
  14198. @param in the RecordInputstream to Read the record from
  14199. </member>
  14200. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.DataSize">
  14201. Size of record (exluding 4 byte header)
  14202. </member>
  14203. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.FormatFlags">
  14204. the format flags field for the Area record.
  14205. </member>
  14206. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsStacked">
  14207. series is stacked
  14208. @return the stacked field value.
  14209. </member>
  14210. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsDisplayAsPercentage">
  14211. results Displayed as percentages
  14212. @return the Display as percentage field value.
  14213. </member>
  14214. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsShadow">
  14215. Display a shadow for the chart
  14216. @return the shadow field value.
  14217. </member>
  14218. <member name="T:NPOI.HSSF.Record.Chart.AxisParentRecord">
  14219. * The axis size and location
  14220. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14221. * Remove the record in src/records/definitions.
  14222. * @author Glen Stampoultzis (glens at apache.org)
  14223. </member>
  14224. <member name="M:NPOI.HSSF.Record.Chart.AxisParentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14225. Constructs a AxisParent record and s its fields appropriately.
  14226. @param in the RecordInputstream to Read the record from
  14227. </member>
  14228. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.DataSize">
  14229. Size of record (exluding 4 byte header)
  14230. </member>
  14231. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.AxisType">
  14232. the axis type field for the AxisParent record.
  14233. @return One of
  14234. AXIS_TYPE_MAIN
  14235. AXIS_TYPE_SECONDARY
  14236. </member>
  14237. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.X">
  14238. the x field for the AxisParent record.
  14239. </member>
  14240. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Y">
  14241. the y field for the AxisParent record.
  14242. </member>
  14243. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Width">
  14244. the width field for the AxisParent record.
  14245. </member>
  14246. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Height">
  14247. the height field for the AxisParent record.
  14248. </member>
  14249. <member name="T:NPOI.HSSF.Record.Chart.AxisRecord">
  14250. * The axis record defines the type of an axis.
  14251. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14252. * Remove the record in src/records/definitions.
  14253. * @author Glen Stampoultzis (glens at apache.org)
  14254. </member>
  14255. <member name="M:NPOI.HSSF.Record.Chart.AxisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14256. Constructs a Axis record and Sets its fields appropriately.
  14257. @param in the RecordInputstream to Read the record from
  14258. </member>
  14259. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.DataSize">
  14260. Size of record (exluding 4 byte header)
  14261. </member>
  14262. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.AxisType">
  14263. Get the axis type field for the Axis record.
  14264. @return One of
  14265. AXIS_TYPE_CATEGORY_OR_X_AXIS
  14266. AXIS_TYPE_VALUE_AXIS
  14267. AXIS_TYPE_SERIES_AXIS
  14268. </member>
  14269. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved1">
  14270. Get the reserved1 field for the Axis record.
  14271. </member>
  14272. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved2">
  14273. Get the reserved2 field for the Axis record.
  14274. </member>
  14275. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved3">
  14276. Get the reserved3 field for the Axis record.
  14277. </member>
  14278. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved4">
  14279. Get the reserved4 field for the Axis record.
  14280. </member>
  14281. <member name="T:NPOI.HSSF.Record.Chart.BarRecord">
  14282. * The bar record is used to define a bar chart.
  14283. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14284. * Remove the record in src/records/definitions.
  14285. * @author Glen Stampoultzis (glens at apache.org)
  14286. </member>
  14287. <member name="M:NPOI.HSSF.Record.Chart.BarRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14288. Constructs a Bar record and s its fields appropriately.
  14289. @param in the RecordInputstream to Read the record from
  14290. </member>
  14291. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.DataSize">
  14292. Size of record (exluding 4 byte header)
  14293. </member>
  14294. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.BarSpace">
  14295. the bar space field for the Bar record.
  14296. </member>
  14297. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.CategorySpace">
  14298. the category space field for the Bar record.
  14299. </member>
  14300. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.FormatFlags">
  14301. the format flags field for the Bar record.
  14302. </member>
  14303. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsHorizontal">
  14304. true to Display horizontal bar charts, false for vertical
  14305. @return the horizontal field value.
  14306. </member>
  14307. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsStacked">
  14308. stack Displayed values
  14309. @return the stacked field value.
  14310. </member>
  14311. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsDisplayAsPercentage">
  14312. Display chart values as a percentage
  14313. @return the Display as percentage field value.
  14314. </member>
  14315. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsShadow">
  14316. Display a shadow for the chart
  14317. @return the shadow field value.
  14318. </member>
  14319. <member name="T:NPOI.HSSF.Record.Chart.BeginRecord">
  14320. The begin record defines the start of a block of records for a (grpahing
  14321. data object. This record is matched with a corresponding EndRecord.
  14322. @see EndRecord
  14323. @author Glen Stampoultzis (glens at apache.org)
  14324. </member>
  14325. <member name="M:NPOI.HSSF.Record.Chart.BeginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14326. Constructs a BeginRecord record and Sets its fields appropriately.
  14327. @param in the RecordInputstream to Read the record from
  14328. </member>
  14329. <member name="T:NPOI.HSSF.Record.Chart.CatLabRecord">
  14330. CATLAB - Category Labels (0x0856)<br/>
  14331. @author Patrick Cheng
  14332. </member>
  14333. <member name="T:NPOI.HSSF.Record.Chart.ChartEndBlockRecord">
  14334. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  14335. @author Patrick Cheng
  14336. </member>
  14337. <member name="T:NPOI.HSSF.Record.Chart.ChartEndObjectRecord">
  14338. ENDOBJECT - Chart Future Record Type End Object (0x0855)<br/>
  14339. @author Patrick Cheng
  14340. </member>
  14341. <member name="T:NPOI.HSSF.Record.ChartFormatRecord">
  14342. Class ChartFormatRecord
  14343. @author Glen Stampoultzis (glens at apache.org)
  14344. @version %I%, %G%
  14345. </member>
  14346. <member name="M:NPOI.HSSF.Record.ChartFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14347. Constructs a ChartFormatRecord record and Sets its fields appropriately.
  14348. @param in the RecordInputstream to Read the record from
  14349. </member>
  14350. <member name="T:NPOI.HSSF.Record.Chart.ChartFRTInfoRecord">
  14351. <summary>
  14352. The ChartFrtInfo record specifies the versions of the application that originally created and last saved the file.
  14353. </summary>
  14354. </member>
  14355. <member name="T:NPOI.HSSF.Record.Chart.ChartRecord">
  14356. * The chart record is used to define the location and size of a chart.
  14357. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14358. * Remove the record in src/records/definitions.
  14359. * @author Glen Stampoultzis (glens at apache.org)
  14360. </member>
  14361. <member name="M:NPOI.HSSF.Record.Chart.ChartRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14362. Constructs a Chart record and Sets its fields appropriately.
  14363. @param in the RecordInputstream to Read the record from
  14364. </member>
  14365. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.DataSize">
  14366. Size of record (exluding 4 byte header)
  14367. </member>
  14368. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.X">
  14369. Get the x field for the Chart record.
  14370. </member>
  14371. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Y">
  14372. Get the y field for the Chart record.
  14373. </member>
  14374. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Width">
  14375. Get the width field for the Chart record.
  14376. </member>
  14377. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Height">
  14378. Get the height field for the Chart record.
  14379. </member>
  14380. <member name="T:NPOI.HSSF.Record.Chart.ChartStartBlockRecord">
  14381. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  14382. @author Patrick Cheng
  14383. </member>
  14384. <member name="T:NPOI.HSSF.Record.Chart.ChartStartObjectRecord">
  14385. STARTOBJECT - Chart Future Record Type Start Object (0x0854)<br/>
  14386. @author Patrick Cheng
  14387. </member>
  14388. <member name="T:NPOI.HSSF.Record.Chart.CrtLinkRecord">
  14389. <summary>
  14390. The CrtLink record is written but unused.
  14391. </summary>
  14392. </member>
  14393. <member name="T:NPOI.HSSF.Record.Chart.DataFormatRecord">
  14394. * The data format record is used to index into a series.
  14395. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14396. * Remove the record in src/records/definitions.
  14397. * @author Glen Stampoultzis (glens at apache.org)
  14398. </member>
  14399. <member name="M:NPOI.HSSF.Record.Chart.DataFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14400. Constructs a DataFormat record and Sets its fields appropriately.
  14401. @param in the RecordInputstream to Read the record from
  14402. </member>
  14403. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.DataSize">
  14404. Size of record (exluding 4 byte header)
  14405. </member>
  14406. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.PointNumber">
  14407. Get the point number field for the DataFormat record.
  14408. </member>
  14409. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesIndex">
  14410. Get the series index field for the DataFormat record.
  14411. </member>
  14412. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesNumber">
  14413. Get the series number field for the DataFormat record.
  14414. </member>
  14415. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.FormatFlags">
  14416. Get the format flags field for the DataFormat record.
  14417. </member>
  14418. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.UseExcel4Colors">
  14419. Set true to use excel 4 colors.
  14420. @return the use excel 4 colors field value.
  14421. </member>
  14422. <member name="T:NPOI.HSSF.Record.Chart.DataLabelExtensionRecord">
  14423. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  14424. @author Patrick Cheng
  14425. </member>
  14426. <member name="T:NPOI.HSSF.Record.Chart.DatRecord">
  14427. * The dat record is used to store options for the chart.
  14428. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14429. * Remove the record in src/records/definitions.
  14430. * @author Glen Stampoultzis (glens at apache.org)
  14431. </member>
  14432. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14433. Constructs a Dat record and Sets its fields appropriately.
  14434. @param in the RecordInputstream to Read the record from
  14435. </member>
  14436. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetHorizontalBorder(System.Boolean)">
  14437. Sets the horizontal border field value.
  14438. has a horizontal border
  14439. </member>
  14440. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsHorizontalBorder">
  14441. has a horizontal border
  14442. @return the horizontal border field value.
  14443. </member>
  14444. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetVerticalBorder(System.Boolean)">
  14445. Sets the vertical border field value.
  14446. has vertical border
  14447. </member>
  14448. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsVerticalBorder">
  14449. has vertical border
  14450. @return the vertical border field value.
  14451. </member>
  14452. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetBorder(System.Boolean)">
  14453. Sets the border field value.
  14454. data table has a border
  14455. </member>
  14456. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsBorder">
  14457. data table has a border
  14458. @return the border field value.
  14459. </member>
  14460. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetShowSeriesKey(System.Boolean)">
  14461. Sets the show series key field value.
  14462. shows the series key
  14463. </member>
  14464. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsShowSeriesKey">
  14465. shows the series key
  14466. @return the show series key field value.
  14467. </member>
  14468. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.DataSize">
  14469. Size of record (exluding 4 byte header)
  14470. </member>
  14471. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.Options">
  14472. Get the options field for the Dat record.
  14473. </member>
  14474. <member name="T:NPOI.HSSF.Record.Chart.EndRecord">
  14475. The end record defines the end of a block of records for a (Graphing)
  14476. data object. This record is matched with a corresponding BeginRecord.
  14477. @see BeginRecord
  14478. @author Glen Stampoultzis (glens at apache.org)
  14479. </member>
  14480. <member name="M:NPOI.HSSF.Record.Chart.EndRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14481. Constructs a EndRecord record and Sets its fields appropriately.
  14482. @param in the RecordInputstream to Read the record from
  14483. </member>
  14484. <member name="T:NPOI.HSSF.Record.Chart.FontBasisRecord">
  14485. * The font basis record stores various font metrics.
  14486. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14487. * Remove the record in src/records/definitions.
  14488. * @author Glen Stampoultzis (glens at apache.org)
  14489. </member>
  14490. <member name="M:NPOI.HSSF.Record.Chart.FontBasisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14491. Constructs a FontBasis record and Sets its fields appropriately.
  14492. @param in the RecordInputstream to Read the record from
  14493. </member>
  14494. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.DataSize">
  14495. Size of record (exluding 4 byte header)
  14496. </member>
  14497. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.XBasis">
  14498. Get the x Basis field for the FontBasis record.
  14499. </member>
  14500. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.YBasis">
  14501. Get the y Basis field for the FontBasis record.
  14502. </member>
  14503. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.HeightBasis">
  14504. Get the height basis field for the FontBasis record.
  14505. </member>
  14506. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.Scale">
  14507. Get the scale field for the FontBasis record.
  14508. </member>
  14509. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.IndexToFontTable">
  14510. Get the index to font table field for the FontBasis record.
  14511. </member>
  14512. <member name="T:NPOI.HSSF.Record.Chart.FrameRecord">
  14513. * The frame record indicates whether there is a border around the Displayed text of a chart.
  14514. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14515. * Remove the record in src/records/definitions.
  14516. * @author Glen Stampoultzis (glens at apache.org)
  14517. </member>
  14518. <member name="M:NPOI.HSSF.Record.Chart.FrameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14519. Constructs a Frame record and Sets its fields appropriately.
  14520. @param in the RecordInputstream to Read the record from
  14521. </member>
  14522. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.DataSize">
  14523. Size of record (exluding 4 byte header)
  14524. </member>
  14525. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.BorderType">
  14526. Get the border type field for the Frame record.
  14527. @return One of
  14528. BORDER_TYPE_REGULAR
  14529. BORDER_TYPE_SHADOW
  14530. </member>
  14531. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.Options">
  14532. Get the options field for the Frame record.
  14533. </member>
  14534. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoSize">
  14535. excel calculates the size automatically if true
  14536. @return the auto size field value.
  14537. </member>
  14538. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoPosition">
  14539. excel calculates the position automatically
  14540. @return the auto position field value.
  14541. </member>
  14542. <member name="T:NPOI.HSSF.Record.Chart.LegendRecord">
  14543. * Defines a legend for a chart.
  14544. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14545. * Remove the record in src/records/definitions.
  14546. * @author Andrew C. Oliver (acoliver at apache.org)
  14547. </member>
  14548. <member name="M:NPOI.HSSF.Record.Chart.LegendRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14549. Constructs a Legend record and Sets its fields appropriately.
  14550. @param in the RecordInputstream to Read the record from
  14551. </member>
  14552. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.DataSize">
  14553. Size of record (exluding 4 byte header)
  14554. </member>
  14555. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XAxisUpperLeft">
  14556. Get the x axis upper left field for the Legend record.
  14557. </member>
  14558. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YAxisUpperLeft">
  14559. Get the y axis upper left field for the Legend record.
  14560. </member>
  14561. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XSize">
  14562. Get the x size field for the Legend record.
  14563. </member>
  14564. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YSize">
  14565. Get the y size field for the Legend record.
  14566. </member>
  14567. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Type">
  14568. Get the type field for the Legend record.
  14569. @return One of
  14570. TYPE_BOTTOM
  14571. TYPE_CORNER
  14572. TYPE_TOP
  14573. TYPE_RIGHT
  14574. TYPE_LEFT
  14575. TYPE_UNDOCKED
  14576. </member>
  14577. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Spacing">
  14578. Get the spacing field for the Legend record.
  14579. @return One of
  14580. SPACING_CLOSE
  14581. SPACING_MEDIUM
  14582. SPACING_OPEN
  14583. </member>
  14584. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Options">
  14585. Get the options field for the Legend record.
  14586. </member>
  14587. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoPosition">
  14588. automatic positioning (1=docked)
  14589. @return the auto position field value.
  14590. </member>
  14591. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoSeries">
  14592. excel 5 only (true)
  14593. @return the auto series field value.
  14594. </member>
  14595. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoXPositioning">
  14596. position of legend on the x axis is automatic
  14597. @return the auto x positioning field value.
  14598. </member>
  14599. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoYPositioning">
  14600. position of legend on the y axis is automatic
  14601. @return the auto y positioning field value.
  14602. </member>
  14603. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsVertical">
  14604. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.
  14605. @return the vertical field value.
  14606. </member>
  14607. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsDataTable">
  14608. 1 if chart Contains data table
  14609. @return the data table field value.
  14610. </member>
  14611. <member name="T:NPOI.HSSF.Record.Chart.LineFormatRecord">
  14612. * Describes a line format record. The line format record controls how a line on a chart appears.
  14613. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14614. * Remove the record in src/records/definitions.
  14615. * @author Glen Stampoultzis (glens at apache.org)
  14616. </member>
  14617. <member name="M:NPOI.HSSF.Record.Chart.LineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14618. Constructs a LineFormat record and Sets its fields appropriately.
  14619. @param in the RecordInputstream to Read the record from
  14620. </member>
  14621. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.DataSize">
  14622. Size of record (exluding 4 byte header)
  14623. </member>
  14624. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LineColor">
  14625. Get the line color field for the LineFormat record.
  14626. </member>
  14627. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LinePattern">
  14628. Get the line pattern field for the LineFormat record.
  14629. @return One of
  14630. LINE_PATTERN_SOLID
  14631. LINE_PATTERN_DASH
  14632. LINE_PATTERN_DOT
  14633. LINE_PATTERN_DASH_DOT
  14634. LINE_PATTERN_DASH_DOT_DOT
  14635. LINE_PATTERN_NONE
  14636. LINE_PATTERN_DARK_GRAY_PATTERN
  14637. LINE_PATTERN_MEDIUM_GRAY_PATTERN
  14638. LINE_PATTERN_LIGHT_GRAY_PATTERN
  14639. </member>
  14640. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Weight">
  14641. Get the weight field for the LineFormat record.
  14642. specifies the thickness of the line.
  14643. @return One of
  14644. WEIGHT_HAIRLINE
  14645. WEIGHT_NARROW
  14646. WEIGHT_MEDIUM
  14647. WEIGHT_WIDE
  14648. </member>
  14649. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Format">
  14650. Get the format field for the LineFormat record.
  14651. </member>
  14652. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.ColourPaletteIndex">
  14653. Get the colour palette index field for the LineFormat record.
  14654. </member>
  14655. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsAuto">
  14656. automatic format
  14657. @return the auto field value.
  14658. </member>
  14659. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsDrawTicks">
  14660. draw tick marks
  14661. @return the draw ticks field value.
  14662. </member>
  14663. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsUnknown">
  14664. book marks this as reserved = 0 but it seems to do something
  14665. @return the Unknown field value.
  14666. </member>
  14667. <member name="T:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord">
  14668. * The number format index record indexes format table. This applies to an axis.
  14669. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14670. * Remove the record in src/records/definitions.
  14671. * @author Glen Stampoultzis (glens at apache.org)
  14672. </member>
  14673. <member name="M:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14674. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  14675. @param in the RecordInputstream to Read the record from
  14676. </member>
  14677. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.DataSize">
  14678. Size of record (exluding 4 byte header)
  14679. </member>
  14680. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.FormatIndex">
  14681. Get the format index field for the NumberFormatIndex record.
  14682. </member>
  14683. <member name="T:NPOI.HSSF.Record.Chart.ObjectLinkRecord">
  14684. * Links text to an object on the chart or identifies it as the title.
  14685. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14686. * Remove the record in src/records/definitions.
  14687. * @author Andrew C. Oliver (acoliver at apache.org)
  14688. </member>
  14689. <member name="M:NPOI.HSSF.Record.Chart.ObjectLinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14690. Constructs a ObjectLink record and Sets its fields appropriately.
  14691. @param in the RecordInputstream to Read the record from
  14692. </member>
  14693. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.DataSize">
  14694. Size of record (exluding 4 byte header)
  14695. </member>
  14696. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.AnchorId">
  14697. Get the anchor id field for the ObjectLink record.
  14698. @return One of
  14699. ANCHOR_ID_CHART_TITLE
  14700. ANCHOR_ID_Y_AXIS
  14701. ANCHOR_ID_X_AXIS
  14702. ANCHOR_ID_SERIES_OR_POINT
  14703. ANCHOR_ID_Z_AXIS
  14704. </member>
  14705. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link1">
  14706. Get the link 1 field for the ObjectLink record.
  14707. </member>
  14708. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link2">
  14709. Get the link 2 field for the ObjectLink record.
  14710. </member>
  14711. <member name="T:NPOI.HSSF.Record.Chart.PlotAreaRecord">
  14712. * preceeds and identifies a frame as belonging to the plot area.
  14713. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14714. * Remove the record in src/records/definitions.
  14715. * @author Andrew C. Oliver (acoliver at apache.org)
  14716. </member>
  14717. <member name="M:NPOI.HSSF.Record.Chart.PlotAreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14718. Constructs a PlotArea record and Sets its fields appropriately.
  14719. @param in the RecordInputstream to Read the record from
  14720. </member>
  14721. <member name="P:NPOI.HSSF.Record.Chart.PlotAreaRecord.DataSize">
  14722. Size of record (exluding 4 byte header)
  14723. </member>
  14724. <member name="T:NPOI.HSSF.Record.Chart.PlotGrowthRecord">
  14725. * The plot growth record specifies the scaling factors used when a font is scaled.
  14726. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14727. * Remove the record in src/records/definitions.
  14728. * @author Glen Stampoultzis (glens at apache.org)
  14729. </member>
  14730. <member name="M:NPOI.HSSF.Record.Chart.PlotGrowthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14731. Constructs a PlotGrowth record and Sets its fields appropriately.
  14732. @param in the RecordInputstream to Read the record from
  14733. </member>
  14734. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.DataSize">
  14735. Size of record (exluding 4 byte header)
  14736. </member>
  14737. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.HorizontalScale">
  14738. Get the horizontalScale field for the PlotGrowth record.
  14739. </member>
  14740. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.VerticalScale">
  14741. Get the verticalScale field for the PlotGrowth record.
  14742. </member>
  14743. <member name="T:NPOI.HSSF.Record.Chart.PositionMode">
  14744. <summary>
  14745. pecifies positioning mode for position information saved in a Pos record.
  14746. </summary>
  14747. </member>
  14748. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDFX">
  14749. <summary>
  14750. Relative position to the chart, in points.
  14751. </summary>
  14752. </member>
  14753. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDABS">
  14754. <summary>
  14755. Absolute width and height in points. It can only be applied to the mdBotRt field of Pos.
  14756. </summary>
  14757. </member>
  14758. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDPARENT">
  14759. <summary>
  14760. Owner of Pos determines how to interpret the position data.
  14761. </summary>
  14762. </member>
  14763. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDKTH">
  14764. <summary>
  14765. Offset to default position, in 1/1000th of the plot area size.
  14766. </summary>
  14767. </member>
  14768. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDCHART">
  14769. <summary>
  14770. Relative position to the chart, in SPRC.
  14771. </summary>
  14772. </member>
  14773. <member name="T:NPOI.HSSF.Record.Chart.PosRecord">
  14774. <summary>
  14775. specifies the size and position for a legend, an attached label, or the plot area, as specified by the primary axis group.
  14776. </summary>
  14777. </member>
  14778. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MDTopLt">
  14779. <summary>
  14780. specifies the positioning mode for the upper-left corner of a legend, an attached label, or the plot area.
  14781. </summary>
  14782. </member>
  14783. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MdBotRt">
  14784. <summary>
  14785. specifies the positioning mode for the lower-right corner of a legend, an attached label, or the plot area
  14786. </summary>
  14787. </member>
  14788. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X1">
  14789. <summary>
  14790. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14791. </summary>
  14792. </member>
  14793. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X2">
  14794. <summary>
  14795. specifies a width. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14796. </summary>
  14797. </member>
  14798. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y1">
  14799. <summary>
  14800. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14801. </summary>
  14802. </member>
  14803. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y2">
  14804. <summary>
  14805. specifies a height. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  14806. </summary>
  14807. </member>
  14808. <member name="T:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord">
  14809. * The series chart Group index record stores the index to the CHARTFORMAT record (0 based).
  14810. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14811. * Remove the record in src/records/definitions.
  14812. * @author Glen Stampoultzis (glens at apache.org)
  14813. </member>
  14814. <member name="M:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14815. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  14816. @param in the RecordInputstream to Read the record from
  14817. </member>
  14818. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.DataSize">
  14819. Size of record (exluding 4 byte header)
  14820. </member>
  14821. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.ChartGroupIndex">
  14822. Get the chart Group index field for the SeriesChartGroupIndex record.
  14823. </member>
  14824. <member name="T:NPOI.HSSF.Record.Chart.SeriesIndexRecord">
  14825. * links a series to its position in the series list.
  14826. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14827. * Remove the record in src/records/definitions.
  14828. * @author Andrew C. Oliver (acoliver at apache.org)
  14829. </member>
  14830. <member name="M:NPOI.HSSF.Record.Chart.SeriesIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14831. Constructs a SeriesIndex record and Sets its fields appropriately.
  14832. @param in the RecordInputstream to Read the record from
  14833. </member>
  14834. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.DataSize">
  14835. Size of record (exluding 4 byte header)
  14836. </member>
  14837. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.Index">
  14838. Get the index field for the SeriesIndex record.
  14839. </member>
  14840. <member name="T:NPOI.HSSF.Record.Chart.SeriesLabelsRecord">
  14841. * The series label record defines the type of label associated with the data format record.
  14842. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14843. * Remove the record in src/records/definitions.
  14844. * @author Glen Stampoultzis (glens at apache.org)
  14845. </member>
  14846. <member name="M:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14847. Constructs a SeriesLabels record and Sets its fields appropriately.
  14848. @param in the RecordInputstream to Read the record from
  14849. </member>
  14850. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.DataSize">
  14851. Size of record (exluding 4 byte header)
  14852. </member>
  14853. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.FormatFlags">
  14854. Get the format flags field for the SeriesLabels record.
  14855. </member>
  14856. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowActual">
  14857. show actual value of the data point
  14858. @return the show actual field value.
  14859. </member>
  14860. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowPercent">
  14861. show value as percentage of total (pie charts only)
  14862. @return the show percent field value.
  14863. </member>
  14864. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsLabelAsPercentage">
  14865. show category label/value as percentage (pie charts only)
  14866. @return the label as percentage field value.
  14867. </member>
  14868. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsSmoothedLine">
  14869. show smooth line
  14870. @return the smoothed line field value.
  14871. </member>
  14872. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowLabel">
  14873. Display category label
  14874. @return the show label field value.
  14875. </member>
  14876. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowBubbleSizes">
  14877. ??
  14878. @return the show bubble sizes field value.
  14879. </member>
  14880. <member name="T:NPOI.HSSF.Record.Chart.SeriesListRecord">
  14881. * The series list record defines the series Displayed as an overlay to the main chart record.
  14882. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14883. * Remove the record in src/records/definitions.
  14884. * @author Glen Stampoultzis (glens at apache.org)
  14885. </member>
  14886. <member name="M:NPOI.HSSF.Record.Chart.SeriesListRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14887. Constructs a SeriesList record and Sets its fields appropriately.
  14888. @param in the RecordInputstream to Read the record from
  14889. </member>
  14890. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.DataSize">
  14891. Size of record (exluding 4 byte header)
  14892. </member>
  14893. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.SeriesNumbers">
  14894. Get the series numbers field for the SeriesList record.
  14895. </member>
  14896. <member name="T:NPOI.HSSF.Record.Chart.SeriesRecord">
  14897. * The series record describes the overall data for a series.
  14898. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14899. * Remove the record in src/records/definitions.
  14900. * @author Glen Stampoultzis (glens at apache.org)
  14901. </member>
  14902. <member name="M:NPOI.HSSF.Record.Chart.SeriesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14903. Constructs a Series record and Sets its fields appropriately.
  14904. @param in the RecordInputstream to Read the record from
  14905. </member>
  14906. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.DataSize">
  14907. Size of record (exluding 4 byte header)
  14908. </member>
  14909. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.CategoryDataType">
  14910. Get the category data type field for the Series record.
  14911. @return One of
  14912. CATEGORY_DATA_TYPE_DATES
  14913. CATEGORY_DATA_TYPE_NUMERIC
  14914. CATEGORY_DATA_TYPE_SEQUENCE
  14915. CATEGORY_DATA_TYPE_TEXT
  14916. </member>
  14917. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.ValuesDataType">
  14918. Get the values data type field for the Series record.
  14919. @return One of
  14920. VALUES_DATA_TYPE_DATES
  14921. VALUES_DATA_TYPE_NUMERIC
  14922. VALUES_DATA_TYPE_SEQUENCE
  14923. VALUES_DATA_TYPE_TEXT
  14924. </member>
  14925. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumCategories">
  14926. Get the num categories field for the Series record.
  14927. </member>
  14928. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumValues">
  14929. Get the num values field for the Series record.
  14930. </member>
  14931. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.BubbleSeriesType">
  14932. Get the bubble series type field for the Series record.
  14933. @return One of
  14934. BUBBLE_SERIES_TYPE_DATES
  14935. BUBBLE_SERIES_TYPE_NUMERIC
  14936. BUBBLE_SERIES_TYPE_SEQUENCE
  14937. BUBBLE_SERIES_TYPE_TEXT
  14938. </member>
  14939. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumBubbleValues">
  14940. Get the num bubble values field for the Series record.
  14941. </member>
  14942. <member name="T:NPOI.HSSF.Record.Chart.SeriesTextRecord">
  14943. * Defines a series name
  14944. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14945. * Remove the record in src/records/definitions.
  14946. * @author Andrew C. Oliver (acoliver at apache.org)
  14947. </member>
  14948. <member name="F:NPOI.HSSF.Record.Chart.SeriesTextRecord.MAX_LEN">
  14949. the actual text cannot be longer than 255 characters
  14950. </member>
  14951. <member name="M:NPOI.HSSF.Record.Chart.SeriesTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14952. Constructs a SeriesText record and Sets its fields appropriately.
  14953. @param in the RecordInputstream to Read the record from
  14954. </member>
  14955. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.DataSize">
  14956. Size of record (exluding 4 byte header)
  14957. </member>
  14958. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Id">
  14959. Get the id field for the SeriesText record.
  14960. </member>
  14961. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Text">
  14962. Get the text field for the SeriesText record.
  14963. </member>
  14964. <member name="T:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord">
  14965. * 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)
  14966. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  14967. * Remove the record in src/records/definitions.
  14968. * @author Andrew C. Oliver (acoliver at apache.org)
  14969. </member>
  14970. <member name="M:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14971. Constructs a SeriesToChartGroup record and Sets its fields appropriately.
  14972. @param in the RecordInputstream to Read the record from
  14973. </member>
  14974. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.DataSize">
  14975. Size of record (exluding 4 byte header)
  14976. </member>
  14977. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.ChartGroupIndex">
  14978. Get the chart Group index field for the SeriesToChartGroup record.
  14979. </member>
  14980. <member name="T:NPOI.HSSF.Record.TextRecord">
  14981. <summary>
  14982. Section [2.4.324]. The Text record specifies the properties of an attached label and specifies the beginning of
  14983. a collection of records as defined by the chart sheet substream ABNF. This collection of records specifies an attached label.
  14984. </summary>
  14985. </member>
  14986. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_LEFT">
  14987. <summary>
  14988. Left-alignment if iReadingOrder specifies left-to-right reading order; otherwise, right-alignment
  14989. </summary>
  14990. </member>
  14991. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_CENTER">
  14992. <summary>
  14993. Center-alignment
  14994. </summary>
  14995. </member>
  14996. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_BOTTOM">
  14997. <summary>
  14998. Right-alignment if iReadingOrder specifies left-to-right reading order; otherwise, left-alignment
  14999. </summary>
  15000. </member>
  15001. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_JUSTIFY">
  15002. <summary>
  15003. Justify-alignment
  15004. </summary>
  15005. </member>
  15006. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_DISTRIBUTED">
  15007. <summary>
  15008. distributed alignment
  15009. </summary>
  15010. </member>
  15011. <member name="F:NPOI.HSSF.Record.TextRecord.VERTICAL_ALIGNMENT_DISTRIBUTED">
  15012. <summary>
  15013. distributed alignment
  15014. </summary>
  15015. </member>
  15016. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_TRANSPARENT">
  15017. <summary>
  15018. Transparent background
  15019. </summary>
  15020. </member>
  15021. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_OPAQUE">
  15022. <summary>
  15023. Opaque background
  15024. </summary>
  15025. </member>
  15026. <member name="M:NPOI.HSSF.Record.TextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15027. Constructs a Text record and Sets its fields appropriately.
  15028. @param in the RecordInputstream to Read the record from
  15029. </member>
  15030. <member name="P:NPOI.HSSF.Record.TextRecord.DataSize">
  15031. Size of record (exluding 4 byte header)
  15032. </member>
  15033. <member name="P:NPOI.HSSF.Record.TextRecord.HorizontalAlignment">
  15034. Get the horizontal alignment field for the Text record.
  15035. @return One of
  15036. HORIZONTAL_ALIGNMENT_LEFT
  15037. HORIZONTAL_ALIGNMENT_CENTER
  15038. HORIZONTAL_ALIGNMENT_BOTTOM
  15039. HORIZONTAL_ALIGNMENT_JUSTIFY
  15040. </member>
  15041. <member name="P:NPOI.HSSF.Record.TextRecord.VerticalAlignment">
  15042. Get the vertical alignment field for the Text record.
  15043. @return One of
  15044. VERTICAL_ALIGNMENT_TOP
  15045. VERTICAL_ALIGNMENT_CENTER
  15046. VERTICAL_ALIGNMENT_BOTTOM
  15047. VERTICAL_ALIGNMENT_JUSTIFY
  15048. </member>
  15049. <member name="P:NPOI.HSSF.Record.TextRecord.DisplayMode">
  15050. Get the Display mode field for the Text record.
  15051. @return One of
  15052. DISPLAY_MODE_TRANSPARENT
  15053. DISPLAY_MODE_OPAQUE
  15054. </member>
  15055. <member name="P:NPOI.HSSF.Record.TextRecord.RgbColor">
  15056. Get the rgbColor field for the Text record.
  15057. </member>
  15058. <member name="P:NPOI.HSSF.Record.TextRecord.X">
  15059. Get the x field for the Text record.
  15060. </member>
  15061. <member name="P:NPOI.HSSF.Record.TextRecord.Y">
  15062. Get the y field for the Text record.
  15063. </member>
  15064. <member name="P:NPOI.HSSF.Record.TextRecord.Width">
  15065. Set the width field for the Text record.
  15066. </member>
  15067. <member name="P:NPOI.HSSF.Record.TextRecord.Height">
  15068. Get the height field for the Text record.
  15069. </member>
  15070. <member name="P:NPOI.HSSF.Record.TextRecord.Options1">
  15071. Get the options1 field for the Text record.
  15072. </member>
  15073. <member name="P:NPOI.HSSF.Record.TextRecord.IndexOfColorValue">
  15074. Get the index of color value field for the Text record.
  15075. </member>
  15076. <member name="P:NPOI.HSSF.Record.TextRecord.Options2">
  15077. Get the options2 field for the Text record.
  15078. </member>
  15079. <member name="P:NPOI.HSSF.Record.TextRecord.TextRotation">
  15080. Get the text rotation field for the Text record.
  15081. </member>
  15082. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoColor">
  15083. true = automaticly selected colour, false = user-selected
  15084. @return the auto color field value.
  15085. </member>
  15086. <member name="P:NPOI.HSSF.Record.TextRecord.ShowKey">
  15087. true = draw legend
  15088. @return the show key field value.
  15089. </member>
  15090. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValue">
  15091. false = text is category label
  15092. @return the show value field value.
  15093. </member>
  15094. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoGeneratedText">
  15095. @return the auto generated text field value.
  15096. </member>
  15097. <member name="P:NPOI.HSSF.Record.TextRecord.IsGenerated">
  15098. @return the generated field value.
  15099. </member>
  15100. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoLabelDeleted">
  15101. @return the auto label deleted field value.
  15102. </member>
  15103. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoBackground">
  15104. @return the auto background field value.
  15105. </member>
  15106. <member name="P:NPOI.HSSF.Record.TextRecord.ShowCategoryLabelAsPercentage">
  15107. @return the show category label as percentage field value.
  15108. </member>
  15109. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValueAsPercentage">
  15110. @return the show value as percentage field value.
  15111. </member>
  15112. <member name="P:NPOI.HSSF.Record.TextRecord.ShowBubbleSizes">
  15113. @return the show bubble sizes field value.
  15114. </member>
  15115. <member name="P:NPOI.HSSF.Record.TextRecord.ShowLabel">
  15116. @return the show label field value.
  15117. </member>
  15118. <member name="P:NPOI.HSSF.Record.TextRecord.DataLabelPlacement">
  15119. @return the data label placement field value.
  15120. </member>
  15121. <member name="T:NPOI.HSSF.Record.TickRecord">
  15122. * The Tick record defines how tick marks and label positioning/formatting
  15123. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15124. * Remove the record in src/records/definitions.
  15125. * @author Andrew C. Oliver(acoliver at apache.org)
  15126. </member>
  15127. <member name="M:NPOI.HSSF.Record.TickRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15128. Constructs a Tick record and Sets its fields appropriately.
  15129. @param in the RecordInputstream to Read the record from
  15130. </member>
  15131. <member name="P:NPOI.HSSF.Record.TickRecord.DataSize">
  15132. Size of record (exluding 4 byte header)
  15133. </member>
  15134. <member name="P:NPOI.HSSF.Record.TickRecord.MajorTickType">
  15135. Get the major tick type field for the Tick record.
  15136. </member>
  15137. <member name="P:NPOI.HSSF.Record.TickRecord.MinorTickType">
  15138. Get the minor tick type field for the Tick record.
  15139. </member>
  15140. <member name="P:NPOI.HSSF.Record.TickRecord.LabelPosition">
  15141. Get the label position field for the Tick record.
  15142. </member>
  15143. <member name="P:NPOI.HSSF.Record.TickRecord.Background">
  15144. Get the background field for the Tick record.
  15145. </member>
  15146. <member name="P:NPOI.HSSF.Record.TickRecord.LabelColorRgb">
  15147. Get the label color rgb field for the Tick record.
  15148. </member>
  15149. <member name="P:NPOI.HSSF.Record.TickRecord.Zero1">
  15150. Get the zero 1 field for the Tick record.
  15151. </member>
  15152. <member name="P:NPOI.HSSF.Record.TickRecord.Zero2">
  15153. Get the zero 2 field for the Tick record.
  15154. </member>
  15155. <member name="P:NPOI.HSSF.Record.TickRecord.Options">
  15156. Get the options field for the Tick record.
  15157. </member>
  15158. <member name="P:NPOI.HSSF.Record.TickRecord.TickColor">
  15159. Get the tick color field for the Tick record.
  15160. </member>
  15161. <member name="P:NPOI.HSSF.Record.TickRecord.Zero3">
  15162. Get the zero 3 field for the Tick record.
  15163. </member>
  15164. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextColor">
  15165. use the quote Unquote automatic color for text
  15166. @return the auto text color field value.
  15167. </member>
  15168. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextBackground">
  15169. use the quote Unquote automatic color for text background
  15170. @return the auto text background field value.
  15171. </member>
  15172. <member name="P:NPOI.HSSF.Record.TickRecord.Rotation">
  15173. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)
  15174. @return the rotation field value.
  15175. </member>
  15176. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutorotate">
  15177. automatically rotate the text
  15178. @return the autorotate field value.
  15179. </member>
  15180. <member name="T:NPOI.HSSF.Record.UnitsRecord">
  15181. * The Units record describes Units.
  15182. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15183. * Remove the record in src/records/definitions.
  15184. * @author Glen Stampoultzis (glens at apache.org)
  15185. </member>
  15186. <member name="M:NPOI.HSSF.Record.UnitsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15187. Constructs a Units record and Sets its fields appropriately.
  15188. @param in the RecordInputstream to Read the record from
  15189. </member>
  15190. <member name="P:NPOI.HSSF.Record.UnitsRecord.DataSize">
  15191. Size of record (exluding 4 byte header)
  15192. </member>
  15193. <member name="P:NPOI.HSSF.Record.UnitsRecord.Units">
  15194. Get the Units field for the Units record.
  15195. </member>
  15196. <member name="T:NPOI.HSSF.Record.Chart.ValueRangeRecord">
  15197. * The value range record defines the range of the value axis.
  15198. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15199. * Remove the record in src/records/definitions.
  15200. * @author Glen Stampoultzis (glens at apache.org)
  15201. </member>
  15202. <member name="M:NPOI.HSSF.Record.Chart.ValueRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15203. Constructs a ValueRange record and Sets its fields appropriately.
  15204. @param in the RecordInputstream to Read the record from
  15205. </member>
  15206. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.DataSize">
  15207. Size of record (exluding 4 byte header)
  15208. </member>
  15209. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinimumAxisValue">
  15210. Get the minimum axis value field for the ValueRange record.
  15211. </member>
  15212. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MaximumAxisValue">
  15213. Get the maximum axis value field for the ValueRange record.
  15214. </member>
  15215. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MajorIncrement">
  15216. Get the major increment field for the ValueRange record.
  15217. </member>
  15218. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinorIncrement">
  15219. Get the minor increment field for the ValueRange record.
  15220. </member>
  15221. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.CategoryAxisCross">
  15222. Get the category axis cross field for the ValueRange record.
  15223. </member>
  15224. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.Options">
  15225. Get the options field for the ValueRange record.
  15226. </member>
  15227. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinimum">
  15228. automatic minimum value selected
  15229. @return the automatic minimum field value.
  15230. </member>
  15231. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMaximum">
  15232. automatic maximum value selected
  15233. @return the automatic maximum field value.
  15234. </member>
  15235. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMajor">
  15236. automatic major Unit selected
  15237. @return the automatic major field value.
  15238. </member>
  15239. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinor">
  15240. automatic minor Unit selected
  15241. @return the automatic minor field value.
  15242. </member>
  15243. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticCategoryCrossing">
  15244. category crossing point is automatically selected
  15245. @return the automatic category crossing field value.
  15246. </member>
  15247. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsLogarithmicScale">
  15248. use logarithmic scale
  15249. @return the logarithmic scale field value.
  15250. </member>
  15251. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsValuesInReverse">
  15252. values are reverses in graph
  15253. @return the values in reverse field value.
  15254. </member>
  15255. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsCrossCategoryAxisAtMaximum">
  15256. category axis to cross at maximum value
  15257. @return the cross category axis at maximum field value.
  15258. </member>
  15259. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsReserved">
  15260. reserved, must equal 1 (excel dev. guide says otherwise)
  15261. @return the reserved field value.
  15262. </member>
  15263. <member name="T:NPOI.HSSF.Record.CodepageRecord">
  15264. Title: Codepage Record
  15265. Description: the default CharSet. for the workbook
  15266. REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15267. @author Andrew C. Oliver (acoliver at apache dot org)
  15268. @version 2.0-pre
  15269. </member>
  15270. <member name="F:NPOI.HSSF.Record.CodepageRecord.CODEPAGE">
  15271. the likely correct value for CODEPAGE (at least for US versions). We could use
  15272. some help with international versions (which we do not have access to documentation
  15273. for)
  15274. </member>
  15275. <member name="M:NPOI.HSSF.Record.CodepageRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15276. Constructs a CodepageRecord and Sets its fields appropriately
  15277. @param in the RecordInputstream to Read the record from
  15278. </member>
  15279. <member name="P:NPOI.HSSF.Record.CodepageRecord.Codepage">
  15280. Get the codepage for this workbook
  15281. @see #CODEPAGE
  15282. @return codepage - the codepage to Set
  15283. </member>
  15284. <member name="T:NPOI.HSSF.Record.ColumnInfoRecord">
  15285. Title: COLINFO Record<p/>
  15286. Description: Defines with width and formatting for a range of columns<p/>
  15287. REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  15288. @author Andrew C. Oliver (acoliver at apache dot org)
  15289. @version 2.0-pre
  15290. </member>
  15291. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15292. Constructs a ColumnInfo record and Sets its fields appropriately
  15293. @param in the RecordInputstream to Read the record from
  15294. </member>
  15295. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.FormatMatches(NPOI.HSSF.Record.ColumnInfoRecord)">
  15296. @return true if the format, options and column width match
  15297. </member>
  15298. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.FirstColumn">
  15299. Get the first column this record defines formatting info for
  15300. @return the first column index (0-based)
  15301. </member>
  15302. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.LastColumn">
  15303. Get the last column this record defines formatting info for
  15304. @return the last column index (0-based)
  15305. </member>
  15306. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.ColumnWidth">
  15307. Get the columns' width in 1/256 of a Char width
  15308. @return column width
  15309. </member>
  15310. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.XFIndex">
  15311. Get the columns' default format info
  15312. @return the extended format index
  15313. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  15314. </member>
  15315. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.Options">
  15316. Get the options bitfield - use the bitSetters instead
  15317. @return the bitfield raw value
  15318. </member>
  15319. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsHidden">
  15320. Get whether or not these cells are hidden
  15321. @return whether the cells are hidden.
  15322. @see #SetOptions(short)
  15323. </member>
  15324. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.OutlineLevel">
  15325. Get the outline level for the cells
  15326. @see #SetOptions(short)
  15327. @return outline level for the cells
  15328. </member>
  15329. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsCollapsed">
  15330. Get whether the cells are collapsed
  15331. @return wether the cells are collapsed
  15332. @see #SetOptions(short)
  15333. </member>
  15334. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent">
  15335. Class POIFSWriterEvent
  15336. @author Marc Johnson (mjohnson at apache dot org)
  15337. @version %I%, %G%
  15338. </member>
  15339. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  15340. namespace scoped constructor
  15341. @param stream the DocumentOutputStream, freshly opened
  15342. @param path the path of the document
  15343. @param documentName the name of the document
  15344. @param limit the limit, in bytes, that can be written to the
  15345. stream
  15346. </member>
  15347. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Stream">
  15348. @return the DocumentOutputStream, freshly opened
  15349. </member>
  15350. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Path">
  15351. @return the document's path
  15352. </member>
  15353. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Name">
  15354. @return the document's name
  15355. </member>
  15356. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Limit">
  15357. @return the limit on writing, in bytes
  15358. </member>
  15359. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs">
  15360. <summary>
  15361. EventArgs for POIFSWriter
  15362. author: Tony Qu
  15363. </summary>
  15364. </member>
  15365. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  15366. <summary>
  15367. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent"/> class.
  15368. </summary>
  15369. <param name="stream">the POIFSDocumentWriter, freshly opened</param>
  15370. <param name="path">the path of the document</param>
  15371. <param name="documentName">the name of the document</param>
  15372. <param name="limit">the limit, in bytes, that can be written to the stream</param>
  15373. </member>
  15374. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Limit">
  15375. <summary>
  15376. Gets the limit on writing, in bytes
  15377. </summary>
  15378. <value>The limit.</value>
  15379. </member>
  15380. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Name">
  15381. <summary>
  15382. Gets the document's name
  15383. </summary>
  15384. <value>The name.</value>
  15385. </member>
  15386. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Path">
  15387. <summary>
  15388. Gets the document's path
  15389. </summary>
  15390. <value>The path.</value>
  15391. </member>
  15392. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Stream">
  15393. <summary>
  15394. the POIFSDocumentWriter, freshly opened
  15395. </summary>
  15396. <value>The stream.</value>
  15397. </member>
  15398. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterListener">
  15399. Interface POIFSWriterListener
  15400. @author Marc Johnson (mjohnson at apache dot org)
  15401. @version %I%, %G%
  15402. </member>
  15403. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterListener.ProcessPOIFSWriterEvent(NPOI.POIFS.EventFileSystem.POIFSWriterEvent)">
  15404. Process a POIFSWriterEvent that this listener had registered
  15405. for
  15406. @param event the POIFSWriterEvent
  15407. </member>
  15408. <member name="T:NPOI.POIFS.FileSystem.BlockStore">
  15409. <summary>
  15410. This abstract class describes a way to read, store, chain
  15411. and free a series of blocks (be they Big or Small ones)
  15412. </summary>
  15413. </member>
  15414. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockStoreBlockSize">
  15415. <summary>
  15416. Returns the size of the blocks managed through the block store.
  15417. </summary>
  15418. <returns></returns>
  15419. </member>
  15420. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockAt(System.Int32)">
  15421. <summary>
  15422. Load the block at the given offset.
  15423. </summary>
  15424. <param name="offset"></param>
  15425. <returns></returns>
  15426. </member>
  15427. <member name="M:NPOI.POIFS.FileSystem.BlockStore.CreateBlockIfNeeded(System.Int32)">
  15428. <summary>
  15429. Extends the file if required to hold blocks up to
  15430. the specified offset, and return the block from there.
  15431. </summary>
  15432. <param name="offset"></param>
  15433. <returns></returns>
  15434. </member>
  15435. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBATBlockAndIndex(System.Int32)">
  15436. <summary>
  15437. Returns the BATBlock that handles the specified offset,
  15438. and the relative index within it
  15439. </summary>
  15440. <param name="offset"></param>
  15441. <returns></returns>
  15442. </member>
  15443. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetNextBlock(System.Int32)">
  15444. <summary>
  15445. Works out what block follows the specified one.
  15446. </summary>
  15447. <param name="offset"></param>
  15448. <returns></returns>
  15449. </member>
  15450. <member name="M:NPOI.POIFS.FileSystem.BlockStore.SetNextBlock(System.Int32,System.Int32)">
  15451. <summary>
  15452. Changes the record of what block follows the specified one.
  15453. </summary>
  15454. <param name="offset"></param>
  15455. <param name="nextBlock"></param>
  15456. </member>
  15457. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetFreeBlock">
  15458. <summary>
  15459. Finds a free block, and returns its offset.
  15460. This method will extend the file/stream if needed, and if doing
  15461. so, allocate new FAT blocks to address the extra space.
  15462. </summary>
  15463. <returns></returns>
  15464. </member>
  15465. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetChainLoopDetector">
  15466. <summary>
  15467. Creates a Detector for loops in the chain
  15468. </summary>
  15469. <returns></returns>
  15470. </member>
  15471. <member name="T:NPOI.POIFS.FileSystem.ChainLoopDetector">
  15472. <summary>
  15473. Used to detect if a chain has a loop in it, so
  15474. we can bail out with an error rather than
  15475. spinning away for ever...
  15476. </summary>
  15477. </member>
  15478. <member name="T:NPOI.POIFS.FileSystem.DocumentInputStream">
  15479. This class provides methods to read a DocumentEntry managed by a
  15480. {@link POIFSFileSystem} or {@link NPOIFSFileSystem} instance.
  15481. It Creates the appropriate one, and delegates, allowing us to
  15482. work transparently with the two.
  15483. </member>
  15484. <member name="F:NPOI.POIFS.FileSystem.DocumentInputStream.EOF">
  15485. returned by read operations if we're at end of document
  15486. </member>
  15487. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor">
  15488. For use by downstream implementations
  15489. </member>
  15490. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  15491. Create an InputStream from the specified DocumentEntry
  15492. @param document the DocumentEntry to be read
  15493. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  15494. been deleted?)
  15495. </member>
  15496. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  15497. Create an InputStream from the specified Document
  15498. @param document the Document to be read
  15499. </member>
  15500. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  15501. Create an InputStream from the specified Document
  15502. @param document the Document to be read
  15503. </member>
  15504. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.MarkSupported">
  15505. Tests if this input stream supports the mark and reset methods.
  15506. @return <code>true</code> always
  15507. </member>
  15508. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.Reset">
  15509. Repositions this stream to the position at the time the mark() method was
  15510. last called on this input stream. If mark() has not been called this
  15511. method repositions the stream to its beginning.
  15512. </member>
  15513. <member name="T:NPOI.POIFS.FileSystem.DocumentOutputStream">
  15514. This class provides a wrapper over an OutputStream so that Document
  15515. Writers can't accidently go over their size limits
  15516. @author Marc Johnson (mjohnson at apache dot org)
  15517. </member>
  15518. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.#ctor(System.IO.Stream,System.Int32)">
  15519. Create a DocumentOutputStream
  15520. @param stream the OutputStream to which the data is actually
  15521. read
  15522. @param limit the maximum number of bytes that can be written
  15523. </member>
  15524. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Int32)">
  15525. Writes the specified byte to this output stream. The general
  15526. contract for write is that one byte is written to the output
  15527. stream. The byte to be written is the eight low-order bits of
  15528. the argument b. The 24 high-order bits of b are ignored.
  15529. @param b the byte.
  15530. @exception IOException if an I/O error occurs. In particular,
  15531. an IOException may be thrown if the
  15532. output stream has been closed, or if the
  15533. Writer tries to write too much data.
  15534. </member>
  15535. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[])">
  15536. Writes b.Length bytes from the specified byte array
  15537. to this output stream.
  15538. @param b the data.
  15539. @exception IOException if an I/O error occurs.
  15540. </member>
  15541. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  15542. <summary>
  15543. Writes len bytes from the specified byte array starting at
  15544. offset off to this output stream. The general contract for
  15545. Write(b, off, len) is that some of the bytes in the array b are
  15546. written to the output stream in order; element b[off] is the
  15547. first byte written and b[off+len-1] is the last byte written by
  15548. this operation.
  15549. </summary>
  15550. <param name="b">the data.</param>
  15551. <param name="off">the start offset in the data.</param>
  15552. <param name="len">the number of bytes to Write.</param>
  15553. </member>
  15554. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Flush">
  15555. <summary>
  15556. Flushes this output stream and forces any buffered output bytes to be written out
  15557. </summary>
  15558. </member>
  15559. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Close">
  15560. Closes this output stream and releases any system resources
  15561. associated with this stream. The general contract of close is
  15562. that it closes the output stream. A closed stream cannot
  15563. perform output operations and cannot be reopened.
  15564. @exception IOException if an I/O error occurs.
  15565. </member>
  15566. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.WriteFiller(System.Int32,System.Byte)">
  15567. write the rest of the document's data (fill in at the end)
  15568. @param totalLimit the actual number of bytes the corresponding
  15569. document must fill
  15570. @param fill the byte to fill remaining space with
  15571. @exception IOException on I/O error
  15572. </member>
  15573. <member name="T:NPOI.POIFS.FileSystem.NDocumentInputStream">
  15574. This class provides methods to read a DocumentEntry managed by a
  15575. {@link NPOIFSFileSystem} instance.
  15576. </member>
  15577. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_offset">
  15578. current offset into the Document
  15579. </member>
  15580. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_block_count">
  15581. current block count
  15582. </member>
  15583. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset">
  15584. current marked offset into the Document (used by mark and Reset)
  15585. </member>
  15586. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset_count">
  15587. and the block count for it
  15588. </member>
  15589. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document_size">
  15590. the Document's size
  15591. </member>
  15592. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._closed">
  15593. have we been closed?
  15594. </member>
  15595. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document">
  15596. the actual Document
  15597. </member>
  15598. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  15599. Create an InputStream from the specified DocumentEntry
  15600. @param document the DocumentEntry to be read
  15601. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  15602. been deleted?)
  15603. </member>
  15604. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  15605. Create an InputStream from the specified Document
  15606. @param document the Document to be read
  15607. </member>
  15608. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.Reset">
  15609. Repositions this stream to the position at the time the mark() method was
  15610. last called on this input stream. If mark() has not been called this
  15611. method repositions the stream to its beginning.
  15612. </member>
  15613. <member name="T:NPOI.POIFS.FileSystem.NPOIFSDocument">
  15614. This class manages a document in the NIO POIFS filesystem.
  15615. This is the {@link NPOIFSFileSystem} version.
  15616. </member>
  15617. <member name="T:NPOI.POIFS.Dev.POIFSViewable">
  15618. <summary>
  15619. Interface for a drill-down viewable object. Such an object has
  15620. content that may or may not be displayed, at the discretion of the
  15621. viewer. The content is returned to the viewer as an array or as an
  15622. Iterator, and the object provides a clue as to which technique the
  15623. viewer should use to get its content.
  15624. A POIFSViewable object is also expected to provide a short
  15625. description of itself, that can be used by a viewer when the
  15626. viewable object is collapsed.
  15627. @author Marc Johnson (mjohnson at apache dot org)
  15628. </summary>
  15629. </member>
  15630. <member name="P:NPOI.POIFS.Dev.POIFSViewable.PreferArray">
  15631. <summary>
  15632. Provides a short description of the object to be used when a
  15633. POIFSViewable object has not provided its contents.
  15634. </summary>
  15635. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  15636. </member>
  15637. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ShortDescription">
  15638. <summary>
  15639. Gets the short description.
  15640. </summary>
  15641. <value>The short description.</value>
  15642. </member>
  15643. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableArray">
  15644. <summary>
  15645. Get an array of objects, some of which may implement POIFSViewable
  15646. </summary>
  15647. <value>The viewable array.</value>
  15648. </member>
  15649. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableIterator">
  15650. <summary>
  15651. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  15652. </summary>
  15653. <value>The viewable iterator.</value>
  15654. </member>
  15655. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  15656. Constructor for an existing Document
  15657. </member>
  15658. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(System.String,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.IO.Stream)">
  15659. Constructor for a new Document
  15660. @param name the name of the POIFSDocument
  15661. @param stream the InputStream we read data from
  15662. </member>
  15663. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableArray">
  15664. Get an array of objects, some of which may implement POIFSViewable
  15665. @return an array of Object; may not be null, but may be empty
  15666. </member>
  15667. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableIterator">
  15668. Get an Iterator of objects, some of which may implement POIFSViewable
  15669. @return an Iterator; may not be null, but may have an empty back end
  15670. store
  15671. </member>
  15672. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetShortDescription">
  15673. Provides a short description of the object, to be used when a
  15674. POIFSViewable object has not provided its contents.
  15675. @return short description
  15676. </member>
  15677. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.Size">
  15678. @return size of the document
  15679. </member>
  15680. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.DocumentProperty">
  15681. @return the instance's DocumentProperty
  15682. </member>
  15683. <member name="T:NPOI.POIFS.FileSystem.NPOIFSFileSystem">
  15684. This is the main class of the POIFS system; it manages the entire
  15685. life cycle of the filesystem.
  15686. This is the new NIO version
  15687. </member>
  15688. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  15689. Convenience method for clients that want to avoid the auto-close behaviour of the constructor.
  15690. </member>
  15691. <member name="F:NPOI.POIFS.FileSystem.NPOIFSFileSystem.bigBlockSize">
  15692. What big block size the file uses. Most files
  15693. use 512 bytes, but a few use 4096
  15694. </member>
  15695. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor">
  15696. Constructor, intended for writing
  15697. </member>
  15698. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.Stream)">
  15699. Create a POIFSFileSystem from an <tt>InputStream</tt>. Normally the stream is read until
  15700. EOF. The stream is always closed.<p/>
  15701. Some streams are usable After reaching EOF (typically those that return <code>true</code>
  15702. for <tt>markSupported()</tt>). In the unlikely case that the caller has such a stream
  15703. <i>and</i> needs to use it After this constructor completes, a work around is to wrap the
  15704. stream in order to trap the <tt>close()</tt> call. A convenience method (
  15705. <tt>CreateNonClosingInputStream()</tt>) has been provided for this purpose:
  15706. <pre>
  15707. InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  15708. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  15709. is.Reset();
  15710. doSomethingElse(is);
  15711. </pre>
  15712. Note also the special case of <tt>MemoryStream</tt> for which the <tt>close()</tt>
  15713. method does nothing.
  15714. <pre>
  15715. MemoryStream bais = ...
  15716. HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() !
  15717. bais.Reset(); // no problem
  15718. doSomethingElse(bais);
  15719. </pre>
  15720. @param stream the InputStream from which to read the data
  15721. @exception IOException on errors Reading, or on invalid data
  15722. </member>
  15723. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  15724. @param stream the stream to be closed
  15725. @param success <code>false</code> if an exception is currently being thrown in the calling method
  15726. </member>
  15727. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.ReadCoreContents">
  15728. Read and process the PropertiesTable and the
  15729. FAT / XFAT blocks, so that we're Ready to
  15730. work with the file
  15731. </member>
  15732. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBlockAt(System.Int32)">
  15733. Load the block at the given offset.
  15734. </member>
  15735. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateBlockIfNeeded(System.Int32)">
  15736. Load the block at the given offset,
  15737. extending the file if needed
  15738. </member>
  15739. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBATBlockAndIndex(System.Int32)">
  15740. Returns the BATBlock that handles the specified offset,
  15741. and the relative index within it
  15742. </member>
  15743. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetNextBlock(System.Int32)">
  15744. Works out what block follows the specified one.
  15745. </member>
  15746. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.SetNextBlock(System.Int32,System.Int32)">
  15747. Changes the record of what block follows the specified one.
  15748. </member>
  15749. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetFreeBlock">
  15750. Finds a free block, and returns its offset.
  15751. This method will extend the file if needed, and if doing
  15752. so, allocate new FAT blocks to Address the extra space.
  15753. </member>
  15754. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetMiniStore">
  15755. Returns the MiniStore, which performs a similar low
  15756. level function to this, except for the small blocks.
  15757. </member>
  15758. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  15759. add a new POIFSDocument to the FileSytem
  15760. @param document the POIFSDocument being Added
  15761. </member>
  15762. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  15763. add a new DirectoryProperty to the FileSystem
  15764. @param directory the DirectoryProperty being Added
  15765. </member>
  15766. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  15767. Create a new document to be Added to the root directory
  15768. @param stream the InputStream from which the document's data
  15769. will be obtained
  15770. @param name the name of the new POIFSDocument
  15771. @return the new DocumentEntry
  15772. @exception IOException on error creating the new POIFSDocument
  15773. </member>
  15774. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  15775. create a new DocumentEntry in the root entry; the data will be
  15776. provided later
  15777. @param name the name of the new DocumentEntry
  15778. @param size the size of the new DocumentEntry
  15779. @param Writer the Writer of the new DocumentEntry
  15780. @return the new DocumentEntry
  15781. @exception IOException
  15782. </member>
  15783. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDirectory(System.String)">
  15784. create a new DirectoryEntry in the root directory
  15785. @param name the name of the new DirectoryEntry
  15786. @return the new DirectoryEntry
  15787. @exception IOException on name duplication
  15788. </member>
  15789. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFilesystem">
  15790. Write the filesystem out to the open file. Will thrown an
  15791. {@link ArgumentException} if opened from an
  15792. {@link InputStream}.
  15793. @exception IOException thrown on errors writing to the stream
  15794. </member>
  15795. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFilesystem(System.IO.Stream)">
  15796. Write the filesystem out
  15797. @param stream the OutputStream to which the filesystem will be
  15798. written
  15799. @exception IOException thrown on errors writing to the stream
  15800. </member>
  15801. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.syncWithDataSource">
  15802. Has our in-memory objects write their state
  15803. to their backing blocks
  15804. </member>
  15805. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.close">
  15806. Closes the FileSystem, freeing any underlying files, streams
  15807. and buffers. After this, you will be unable to read or
  15808. write from the FileSystem.
  15809. </member>
  15810. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  15811. open a document in the root entry's list of entries
  15812. @param documentName the name of the document to be opened
  15813. @return a newly opened DocumentInputStream
  15814. @exception IOException if the document does not exist or the
  15815. name is that of a DirectoryEntry
  15816. </member>
  15817. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  15818. remove an entry
  15819. @param entry to be Removed
  15820. </member>
  15821. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableArray">
  15822. Get an array of objects, some of which may implement
  15823. POIFSViewable
  15824. @return an array of Object; may not be null, but may be empty
  15825. </member>
  15826. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableIterator">
  15827. Get an Iterator of objects, some of which may implement
  15828. POIFSViewable
  15829. @return an Iterator; may not be null, but may have an empty
  15830. back end store
  15831. </member>
  15832. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetShortDescription">
  15833. Provides a short description of the object, to be used when a
  15834. POIFSViewable object has not provided its contents.
  15835. @return short description
  15836. </member>
  15837. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSize">
  15838. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  15839. </member>
  15840. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSizeDetails">
  15841. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  15842. </member>
  15843. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.PropertyTable">
  15844. For unit Testing only! Returns the underlying
  15845. properties table
  15846. </member>
  15847. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Root">
  15848. Get the root entry
  15849. @return the root entry
  15850. </member>
  15851. <member name="T:NPOI.POIFS.FileSystem.NPOIFSMiniStore">
  15852. This class handles the MiniStream (small block store)
  15853. in the NIO case for {@link NPOIFSFileSystem}
  15854. </member>
  15855. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBlockAt(System.Int32)">
  15856. Load the block at the given offset.
  15857. </member>
  15858. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.CreateBlockIfNeeded(System.Int32)">
  15859. Load the block, extending the underlying stream if needed
  15860. </member>
  15861. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBATBlockAndIndex(System.Int32)">
  15862. Returns the BATBlock that handles the specified offset,
  15863. and the relative index within it
  15864. </member>
  15865. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetNextBlock(System.Int32)">
  15866. Works out what block follows the specified one.
  15867. </member>
  15868. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SetNextBlock(System.Int32,System.Int32)">
  15869. Changes the record of what block follows the specified one.
  15870. </member>
  15871. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetFreeBlock">
  15872. Finds a free block, and returns its offset.
  15873. This method will extend the file if needed, and if doing
  15874. so, allocate new FAT blocks to Address the extra space.
  15875. </member>
  15876. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SyncWithDataSource">
  15877. Writes the SBATs to their backing blocks
  15878. </member>
  15879. <member name="T:NPOI.POIFS.FileSystem.NPOIFSStream">
  15880. This handles Reading and writing a stream within a
  15881. {@link NPOIFSFileSystem}. It can supply an iterator
  15882. to read blocks, and way to write out to existing and
  15883. new blocks.
  15884. Most users will want a higher level version of this,
  15885. which deals with properties to track which stream
  15886. this is.
  15887. This only works on big block streams, it doesn't
  15888. handle small block ones.
  15889. This uses the new NIO code
  15890. TODO Implement a streaming write method, and append
  15891. </member>
  15892. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore,System.Int32)">
  15893. Constructor for an existing stream. It's up to you
  15894. to know how to Get the start block (eg from a
  15895. {@link HeaderBlock} or a {@link Property})
  15896. </member>
  15897. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore)">
  15898. Constructor for a new stream. A start block won't
  15899. be allocated until you begin writing to it.
  15900. </member>
  15901. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetStartBlock">
  15902. What block does this stream start at?
  15903. Will be {@link POIFSConstants#END_OF_CHAIN} for a
  15904. new stream that hasn't been written to yet.
  15905. </member>
  15906. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetBlockIterator">
  15907. Returns an iterator that'll supply one {@link ByteBuffer}
  15908. per block in the stream.
  15909. </member>
  15910. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.UpdateContents(System.Byte[])">
  15911. Updates the contents of the stream to the new
  15912. Set of bytes.
  15913. Note - if this is property based, you'll still
  15914. need to update the size in the property yourself
  15915. </member>
  15916. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.free">
  15917. Frees all blocks in the stream
  15918. </member>
  15919. <member name="T:NPOI.POIFS.FileSystem.ODocumentInputStream">
  15920. This class provides methods to read a DocumentEntry managed by a
  15921. {@link POIFSFileSystem} instance.
  15922. @author Marc Johnson (mjohnson at apache dot org)
  15923. </member>
  15924. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._current_offset">
  15925. current offset into the Document
  15926. </member>
  15927. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._marked_offset">
  15928. current marked offset into the Document (used by mark and Reset)
  15929. </member>
  15930. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document_size">
  15931. the Document's size
  15932. </member>
  15933. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._closed">
  15934. have we been closed?
  15935. </member>
  15936. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document">
  15937. the actual Document
  15938. </member>
  15939. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._currentBlock">
  15940. the data block Containing the current stream pointer
  15941. </member>
  15942. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  15943. Create an InputStream from the specified DocumentEntry
  15944. @param document the DocumentEntry to be read
  15945. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  15946. been deleted?)
  15947. </member>
  15948. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  15949. Create an InputStream from the specified Document
  15950. @param document the Document to be read
  15951. </member>
  15952. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.Reset">
  15953. Repositions this stream to the position at the time the mark() method was
  15954. last called on this input stream. If mark() has not been called this
  15955. method repositions the stream to its beginning.
  15956. </member>
  15957. <member name="T:NPOI.POIFS.FileSystem.POIFSDocument">
  15958. <summary>
  15959. This class manages a document in the POIFS filesystem.
  15960. @author Marc Johnson (mjohnson at apache dot org)
  15961. </summary>
  15962. </member>
  15963. <member name="T:NPOI.POIFS.FileSystem.BATManaged">
  15964. <summary>
  15965. This interface defines behaviors for objects managed by the Block
  15966. Allocation Table (BAT).
  15967. @author Marc Johnson (mjohnson at apache dot org)
  15968. </summary>
  15969. </member>
  15970. <member name="P:NPOI.POIFS.FileSystem.BATManaged.CountBlocks">
  15971. <summary>
  15972. Gets the number of BigBlock's this instance uses
  15973. </summary>
  15974. <value>count of BigBlock instances</value>
  15975. </member>
  15976. <member name="P:NPOI.POIFS.FileSystem.BATManaged.StartBlock">
  15977. <summary>
  15978. Sets the start block for this instance
  15979. </summary>
  15980. <value>index into the array of BigBlock instances making up the the filesystem</value>
  15981. </member>
  15982. <member name="T:NPOI.POIFS.Storage.BlockWritable">
  15983. <summary>
  15984. An interface for persisting block storage of POIFS components.
  15985. @author Marc Johnson (mjohnson at apache dot org)
  15986. </summary>
  15987. </member>
  15988. <member name="M:NPOI.POIFS.Storage.BlockWritable.WriteBlocks(System.IO.Stream)">
  15989. <summary>
  15990. Writes the blocks.
  15991. </summary>
  15992. <param name="stream">The stream.</param>
  15993. </member>
  15994. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.#ctor(System.String,System.IO.Stream)">
  15995. <summary>
  15996. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSDocument"/> class.
  15997. </summary>
  15998. <param name="name">the name of the POIFSDocument</param>
  15999. <param name="stream">the InputStream we read data from</param>
  16000. </member>
  16001. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.#ctor(System.String,NPOI.POIFS.Storage.ListManagedBlock[],System.Int32)">
  16002. <summary>
  16003. Constructor from small blocks
  16004. </summary>
  16005. <param name="name">the name of the POIFSDocument</param>
  16006. <param name="blocks">the small blocks making up the POIFSDocument</param>
  16007. <param name="length">the actual length of the POIFSDocument</param>
  16008. </member>
  16009. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.Read(System.Byte[],System.Int32)">
  16010. <summary>
  16011. read data from the internal stores
  16012. </summary>
  16013. <param name="buffer">the buffer to write to</param>
  16014. <param name="offset">the offset into our storage to read from</param>
  16015. </member>
  16016. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.WriteBlocks(System.IO.Stream)">
  16017. <summary>
  16018. Writes the blocks.
  16019. </summary>
  16020. <param name="stream">The stream.</param>
  16021. </member>
  16022. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.CountBlocks">
  16023. <summary>
  16024. Gets the number of BigBlock's this instance uses
  16025. </summary>
  16026. <value>count of BigBlock instances</value>
  16027. </member>
  16028. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.DocumentProperty">
  16029. <summary>
  16030. Gets the document property.
  16031. </summary>
  16032. <value>The document property.</value>
  16033. </member>
  16034. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.PreferArray">
  16035. <summary>
  16036. Provides a short description of the object to be used when a
  16037. POIFSViewable object has not provided its contents.
  16038. </summary>
  16039. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  16040. </member>
  16041. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ShortDescription">
  16042. <summary>
  16043. Gets the short description.
  16044. </summary>
  16045. <value>The short description.</value>
  16046. </member>
  16047. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.Size">
  16048. <summary>
  16049. Gets the size.
  16050. </summary>
  16051. <value>The size.</value>
  16052. </member>
  16053. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.SmallBlocks">
  16054. <summary>
  16055. Gets the small blocks.
  16056. </summary>
  16057. <value>The small blocks.</value>
  16058. </member>
  16059. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.StartBlock">
  16060. <summary>
  16061. Sets the start block for this instance
  16062. </summary>
  16063. <value>
  16064. index into the array of BigBlock instances making up the the filesystem
  16065. </value>
  16066. </member>
  16067. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ViewableArray">
  16068. <summary>
  16069. Get an array of objects, some of which may implement POIFSViewable
  16070. </summary>
  16071. <value>The viewable array.</value>
  16072. </member>
  16073. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ViewableIterator">
  16074. <summary>
  16075. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  16076. </summary>
  16077. <value>The viewable iterator.</value>
  16078. </member>
  16079. <member name="T:NPOI.POIFS.NIO.ByteArrayBackedDataSource">
  16080. <summary>
  16081. A POIFS <see cref="T:NPOI.POIFS.NIO.DataSource"/> backed by a byte array.
  16082. </summary>
  16083. </member>
  16084. <member name="T:NPOI.POIFS.NIO.DataSource">
  16085. <summary>
  16086. Common definition of how we read and write bytes
  16087. </summary>
  16088. </member>
  16089. <member name="M:NPOI.POIFS.NIO.DataSource.Close">
  16090. <summary>
  16091. Close the underlying stream
  16092. </summary>
  16093. </member>
  16094. <member name="M:NPOI.POIFS.NIO.DataSource.CopyTo(System.IO.Stream)">
  16095. <summary>
  16096. Copies the contents to the specified Stream
  16097. </summary>
  16098. <param name="stream"></param>
  16099. </member>
  16100. <member name="T:NPOI.POIFS.NIO.FileBackedDataSource">
  16101. <summary>
  16102. A POIFS DataSource backed by a File
  16103. </summary>
  16104. </member>
  16105. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Read(System.Int32,System.Int64)">
  16106. <summary>
  16107. Reads a sequence of bytes from this FileStream starting at the given file position.
  16108. </summary>
  16109. <param name="length"></param>
  16110. <param name="position">The file position at which the transfer is to begin;</param>
  16111. <returns></returns>
  16112. </member>
  16113. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Write(NPOI.Util.ByteBuffer,System.Int64)">
  16114. <summary>
  16115. Writes a sequence of bytes to this FileStream from the given Stream,
  16116. starting at the given file position.
  16117. </summary>
  16118. <param name="src">The Stream from which bytes are to be transferred</param>
  16119. <param name="position">The file position at which the transfer is to begin;
  16120. must be non-negative</param>
  16121. </member>
  16122. <member name="T:NPOI.POIFS.Storage.HeaderBlock">
  16123. <summary>
  16124. The block containing the archive header
  16125. @author Marc Johnson (mjohnson at apache dot org)
  16126. </summary>
  16127. </member>
  16128. <member name="T:NPOI.POIFS.Storage.HeaderBlockConstants">
  16129. <summary>
  16130. Constants used in reading/writing the Header block
  16131. @author Marc Johnson (mjohnson at apache dot org)
  16132. </summary>
  16133. </member>
  16134. <member name="F:NPOI.POIFS.Storage.HeaderBlock.bigBlockSize">
  16135. What big block Size the file uses. Most files
  16136. use 512 bytes, but a few use 4096
  16137. </member>
  16138. <member name="F:NPOI.POIFS.Storage.HeaderBlock._sbat_count">
  16139. Number of small block allocation table blocks (int)
  16140. (Number of MiniFAT Sectors in Microsoft parlance)
  16141. </member>
  16142. <member name="M:NPOI.POIFS.Storage.HeaderBlock.#ctor(System.IO.Stream)">
  16143. <summary>
  16144. create a new HeaderBlockReader from an Stream
  16145. </summary>
  16146. <param name="stream">the source Stream</param>
  16147. </member>
  16148. <member name="M:NPOI.POIFS.Storage.HeaderBlock.AlertShortRead(System.Int32,System.Int32)">
  16149. <summary>
  16150. Alerts the short read.
  16151. </summary>
  16152. <param name="read">The read.</param>
  16153. <param name="expectedReadSize">The expected size.</param>
  16154. </member>
  16155. <member name="P:NPOI.POIFS.Storage.HeaderBlock.PropertyStart">
  16156. <summary>
  16157. Get start of Property Table
  16158. </summary>
  16159. <value>the index of the first block of the Property Table</value>
  16160. </member>
  16161. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATStart">
  16162. <summary>
  16163. Gets start of small block allocation table
  16164. </summary>
  16165. <value>The SBAT start.</value>
  16166. </member>
  16167. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATCount">
  16168. <summary>
  16169. Gets number of BAT blocks
  16170. </summary>
  16171. <value>The BAT count.</value>
  16172. </member>
  16173. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BATArray">
  16174. <summary>
  16175. Gets the BAT array.
  16176. </summary>
  16177. <value>The BAT array.</value>
  16178. </member>
  16179. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATCount">
  16180. <summary>
  16181. Gets the XBAT count.
  16182. </summary>
  16183. <value>The XBAT count.</value>
  16184. @return XBAT count
  16185. </member>
  16186. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATIndex">
  16187. <summary>
  16188. Gets the index of the XBAT.
  16189. </summary>
  16190. <value>The index of the XBAT.</value>
  16191. </member>
  16192. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BigBlockSize">
  16193. <summary>
  16194. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  16195. </summary>
  16196. <value>The size of the big block.</value>
  16197. @return
  16198. </member>
  16199. <member name="T:NPOI.SS.Extractor.ExcelExtractor">
  16200. Common interface for Excel text extractors, covering
  16201. HSSF and XSSF
  16202. </member>
  16203. <member name="M:NPOI.SS.Extractor.ExcelExtractor.SetIncludeSheetNames(System.Boolean)">
  16204. Should sheet names be included? Default is true
  16205. </member>
  16206. <member name="M:NPOI.SS.Extractor.ExcelExtractor.SetFormulasNotResults(System.Boolean)">
  16207. Should we return the formula itself, and not
  16208. the result it produces? Default is false
  16209. </member>
  16210. <member name="M:NPOI.SS.Extractor.ExcelExtractor.SetIncludeCellComments(System.Boolean)">
  16211. Should cell comments be included? Default is false
  16212. </member>
  16213. <member name="P:NPOI.SS.Extractor.ExcelExtractor.Text">
  16214. Retreives the text contents of the file
  16215. </member>
  16216. <member name="T:NPOI.SS.Format.CellDateFormatter">
  16217. Formats a date value.
  16218. @author Ken Arnold, Industrious Media LLC
  16219. </member>
  16220. <member name="T:NPOI.SS.Format.CellFormatter">
  16221. This is the abstract supertype for the various cell formatters.
  16222. @author Ken Arnold, Industrious Media LLC
  16223. </member>
  16224. <member name="F:NPOI.SS.Format.CellFormatter.format">
  16225. The original specified format.
  16226. </member>
  16227. <member name="F:NPOI.SS.Format.CellFormatter.LOCALE">
  16228. This is the locale used to Get a consistent format result from which to
  16229. work.
  16230. </member>
  16231. <member name="M:NPOI.SS.Format.CellFormatter.#ctor(System.String)">
  16232. Creates a new formatter object, storing the format in {@link #format}.
  16233. @param format The format.
  16234. </member>
  16235. <member name="M:NPOI.SS.Format.CellFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16236. Format a value according the format string.
  16237. @param toAppendTo The buffer to append to.
  16238. @param value The value to format.
  16239. </member>
  16240. <member name="M:NPOI.SS.Format.CellFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16241. Format a value according to the type, in the most basic way.
  16242. @param toAppendTo The buffer to append to.
  16243. @param value The value to format.
  16244. </member>
  16245. <member name="M:NPOI.SS.Format.CellFormatter.Format(System.Object)">
  16246. Formats the value, returning the resulting string.
  16247. @param value The value to format.
  16248. @return The value, formatted.
  16249. </member>
  16250. <member name="M:NPOI.SS.Format.CellFormatter.SimpleFormat(System.Object)">
  16251. Formats the value in the most basic way, returning the resulting string.
  16252. @param value The value to format.
  16253. @return The value, formatted.
  16254. </member>
  16255. <member name="M:NPOI.SS.Format.CellFormatter.Quote(System.String)">
  16256. Returns the input string, surrounded by quotes.
  16257. @param str The string to quote.
  16258. @return The input string, surrounded by quotes.
  16259. </member>
  16260. <member name="M:NPOI.SS.Format.CellDateFormatter.#ctor(System.String)">
  16261. Creates a new date formatter with the given specification.
  16262. @param format The format.
  16263. </member>
  16264. <member name="M:NPOI.SS.Format.CellDateFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16265. {@inheritDoc}
  16266. </member>
  16267. <member name="M:NPOI.SS.Format.CellDateFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16268. {@inheritDoc}
  16269. <p/>
  16270. For a date, this is <tt>"mm/d/y"</tt>.
  16271. </member>
  16272. <member name="T:NPOI.SS.Format.CellFormatPart">
  16273. Objects of this class represent a single part of a cell format expression.
  16274. Each cell can have up to four of these for positive, zero, negative, and text
  16275. values.
  16276. <p/>
  16277. Each format part can contain a color, a condition, and will always contain a
  16278. format specification. For example <tt>"[Red][>=10]#"</tt> has a color
  16279. (<tt>[Red]</tt>), a condition (<tt>>=10</tt>) and a format specification
  16280. (<tt>#</tt>).
  16281. <p/>
  16282. This class also Contains patterns for matching the subparts of format
  16283. specification. These are used internally, but are made public in case other
  16284. code has use for them.
  16285. @author Ken Arnold, Industrious Media LLC
  16286. </member>
  16287. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_PAT">
  16288. Pattern for the color part of a cell format part.
  16289. </member>
  16290. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_PAT">
  16291. Pattern for the condition part of a cell format part.
  16292. </member>
  16293. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_PAT">
  16294. Pattern for the format specification part of a cell format part.
  16295. </member>
  16296. <member name="F:NPOI.SS.Format.CellFormatPart.FORMAT_PAT">
  16297. Pattern for an entire cell single part.
  16298. </member>
  16299. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_GROUP">
  16300. Within {@link #FORMAT_PAT}, the group number for the matched color.
  16301. </member>
  16302. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_OPERATOR_GROUP">
  16303. Within {@link #FORMAT_PAT}, the group number for the operator in the
  16304. condition.
  16305. </member>
  16306. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_VALUE_GROUP">
  16307. Within {@link #FORMAT_PAT}, the group number for the value in the
  16308. condition.
  16309. </member>
  16310. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_GROUP">
  16311. Within {@link #FORMAT_PAT}, the group number for the format
  16312. specification.
  16313. </member>
  16314. <member name="M:NPOI.SS.Format.CellFormatPart.#ctor(System.String)">
  16315. Create an object to represent a format part.
  16316. @param desc The string to Parse.
  16317. </member>
  16318. <member name="M:NPOI.SS.Format.CellFormatPart.Applies(System.Object)">
  16319. Returns <tt>true</tt> if this format part applies to the given value. If
  16320. the value is a number and this is part has a condition, returns
  16321. <tt>true</tt> only if the number passes the condition. Otherwise, this
  16322. allways return <tt>true</tt>.
  16323. @param valueObject The value to Evaluate.
  16324. @return <tt>true</tt> if this format part applies to the given value.
  16325. </member>
  16326. <member name="M:NPOI.SS.Format.CellFormatPart.FindGroup(System.Text.RegularExpressions.Regex,System.String,System.String)">
  16327. Returns the number of the first group that is the same as the marker
  16328. string. The search starts with group 1.
  16329. @param pat The pattern to use.
  16330. @param str The string to match against the pattern.
  16331. @param marker The marker value to find the group of.
  16332. @return The matching group number.
  16333. @throws ArgumentException No group matches the marker.
  16334. </member>
  16335. <member name="M:NPOI.SS.Format.CellFormatPart.GetColor(System.Text.RegularExpressions.Match)">
  16336. Returns the color specification from the matcher, or <tt>null</tt> if
  16337. there is none.
  16338. @param m The matcher for the format part.
  16339. @return The color specification or <tt>null</tt>.
  16340. </member>
  16341. <member name="M:NPOI.SS.Format.CellFormatPart.GetCondition(System.Text.RegularExpressions.Match)">
  16342. Returns the condition specification from the matcher, or <tt>null</tt> if
  16343. there is none.
  16344. @param m The matcher for the format part.
  16345. @return The condition specification or <tt>null</tt>.
  16346. </member>
  16347. <member name="M:NPOI.SS.Format.CellFormatPart.GetCellFormatType(System.Text.RegularExpressions.Match)">
  16348. Returns the CellFormatType object implied by the format specification for
  16349. the format part.
  16350. @param matcher The matcher for the format part.
  16351. @return The CellFormatType.
  16352. </member>
  16353. <member name="M:NPOI.SS.Format.CellFormatPart.GetFormatter(System.Text.RegularExpressions.Match)">
  16354. Returns the formatter object implied by the format specification for the
  16355. format part.
  16356. @param matcher The matcher for the format part.
  16357. @return The formatter.
  16358. </member>
  16359. <member name="M:NPOI.SS.Format.CellFormatPart.formatType(System.String)">
  16360. Returns the type of format.
  16361. @param fdesc The format specification
  16362. @return The type of format.
  16363. </member>
  16364. <member name="M:NPOI.SS.Format.CellFormatPart.QuoteSpecial(System.String,NPOI.SS.Format.CellFormatType)">
  16365. Returns a version of the original string that has any special characters
  16366. quoted (or escaped) as appropriate for the cell format type. The format
  16367. type object is queried to see what is special.
  16368. @param repl The original string.
  16369. @param type The format type representation object.
  16370. @return A version of the string with any special characters Replaced.
  16371. @see CellFormatType#isSpecial(char)
  16372. </member>
  16373. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Object)">
  16374. Apply this format part to the given value. This returns a {@link
  16375. CellFormatResult} object with the results.
  16376. @param value The value to apply this format part to.
  16377. @return A {@link CellFormatResult} object Containing the results of
  16378. Applying the format to the value.
  16379. </member>
  16380. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Windows.Forms.Label,System.Object)">
  16381. Apply this format part to the given value, Applying the result to the
  16382. given label.
  16383. @param label The label
  16384. @param value The value to apply this format part to.
  16385. @return <tt>true</tt> if the
  16386. </member>
  16387. <member name="M:NPOI.SS.Format.CellFormatPart.ExpandChar(System.String)">
  16388. Expands a character. This is only partly done, because we don't have the
  16389. correct info. In Excel, this would be expanded to fill the rest of the
  16390. cell, but we don't know, in general, what the "rest of the cell" is1.
  16391. @param part The character to be repeated is the second character in this
  16392. string.
  16393. @return The character repeated three times.
  16394. </member>
  16395. <member name="M:NPOI.SS.Format.CellFormatPart.Group(System.Text.RegularExpressions.Match,System.Int32)">
  16396. Returns the string from the group, or <tt>""</tt> if the group is
  16397. <tt>null</tt>.
  16398. @param m The matcher.
  16399. @param g The group number.
  16400. @return The group or <tt>""</tt>.
  16401. </member>
  16402. <member name="P:NPOI.SS.Format.CellFormatPart.CellFormatType">
  16403. Returns the CellFormatType object implied by the format specification for
  16404. the format part.
  16405. @return The CellFormatType.
  16406. </member>
  16407. <member name="P:NPOI.SS.Format.CellFormatPart.HasCondition">
  16408. Returns <tt>true</tt> if this format part has a condition.
  16409. @return <tt>true</tt> if this format part has a condition.
  16410. </member>
  16411. <member name="T:NPOI.SS.Format.CellElapsedFormatter">
  16412. This class : printing out an elapsed time format.
  16413. @author Ken Arnold, Industrious Media LLC
  16414. </member>
  16415. <member name="M:NPOI.SS.Format.CellElapsedFormatter.#ctor(System.String)">
  16416. Creates a elapsed time formatter.
  16417. @param pattern The pattern to Parse.
  16418. </member>
  16419. <member name="M:NPOI.SS.Format.CellElapsedFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16420. {@inheritDoc}
  16421. </member>
  16422. <member name="M:NPOI.SS.Format.CellElapsedFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16423. {@inheritDoc}
  16424. <p/>
  16425. For a date, this is <tt>"mm/d/y"</tt>.
  16426. </member>
  16427. <member name="T:NPOI.SS.Format.CellFormat">
  16428. Format a value according to the standard Excel behavior. This "standard" is
  16429. not explicitly documented by Microsoft, so the behavior is determined by
  16430. experimentation; see the tests.
  16431. An Excel format has up to four parts, Separated by semicolons. Each part
  16432. specifies what to do with particular kinds of values, depending on the number
  16433. of parts given:
  16434. - One part (example: <c>[Green]#.##</c>)
  16435. If the value is a number, display according to this one part (example: green text,
  16436. with up to two decimal points). If the value is text, display it as is.
  16437. - Two parts (example: <c>[Green]#.##;[Red]#.##</c>)
  16438. If the value is a positive number or zero, display according to the first part (example: green
  16439. text, with up to two decimal points); if it is a negative number, display
  16440. according to the second part (example: red text, with up to two decimal
  16441. points). If the value is text, display it as is.
  16442. - Three parts (example: <c>[Green]#.##;[Black]#.##;[Red]#.##</c>)
  16443. If the value is a positive number, display according to the first part (example: green text, with up to
  16444. two decimal points); if it is zero, display according to the second part
  16445. (example: black text, with up to two decimal points); if it is a negative
  16446. number, display according to the third part (example: red text, with up to
  16447. two decimal points). If the value is text, display it as is.
  16448. - Four parts (example: <c>[Green]#.##;[Black]#.##;[Red]#.##;[@]</c>)
  16449. If the value is a positive number, display according to the first part (example: green text,
  16450. with up to two decimal points); if it is zero, display according to the
  16451. second part (example: black text, with up to two decimal points); if it is a
  16452. negative number, display according to the third part (example: red text, with
  16453. up to two decimal points). If the value is text, display according to the
  16454. fourth part (example: text in the cell's usual color, with the text value
  16455. surround by brackets).
  16456. In Addition to these, there is a general format that is used when no format
  16457. is specified. This formatting is presented by the {@link #GENERAL_FORMAT}
  16458. object.
  16459. @author Ken Arnold, Industrious Media LLC
  16460. </member>
  16461. <member name="F:NPOI.SS.Format.CellFormat.formatCache">
  16462. Maps a format string to its Parsed version for efficiencies sake.
  16463. </member>
  16464. <member name="M:NPOI.SS.Format.CellFormat.GetInstance(System.String)">
  16465. Returns a {@link CellFormat} that applies the given format. Two calls
  16466. with the same format may or may not return the same object.
  16467. @param format The format.
  16468. @return A {@link CellFormat} that applies the given format.
  16469. </member>
  16470. <member name="M:NPOI.SS.Format.CellFormat.#ctor(System.String)">
  16471. Creates a new object.
  16472. @param format The format.
  16473. </member>
  16474. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Object)">
  16475. Returns the result of Applying the format to the given value. If the
  16476. value is a number (a type of {@link Number} object), the correct number
  16477. format type is chosen; otherwise it is considered a text object.
  16478. @param value The value
  16479. @return The result, in a {@link CellFormatResult}.
  16480. </member>
  16481. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.DateTime,System.Double)">
  16482. Returns the result of applying the format to the given date.
  16483. @param date The date.
  16484. @param numericValue The numeric value for the date.
  16485. @return The result, in a {@link CellFormatResult}.
  16486. </member>
  16487. <member name="M:NPOI.SS.Format.CellFormat.Apply(NPOI.SS.UserModel.ICell)">
  16488. Fetches the appropriate value from the cell, and returns the result of
  16489. Applying it to the appropriate format. For formula cells, the computed
  16490. value is what is used.
  16491. @param c The cell.
  16492. @return The result, in a {@link CellFormatResult}.
  16493. </member>
  16494. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Windows.Forms.Label,System.Object)">
  16495. Uses the result of Applying this format to the value, Setting the text
  16496. and color of a label before returning the result.
  16497. @param label The label to apply to.
  16498. @param value The value to Process.
  16499. @return The result, in a {@link CellFormatResult}.
  16500. </member>
  16501. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Windows.Forms.Label,System.DateTime,System.Double)">
  16502. Uses the result of applying this format to the given date, setting the text
  16503. and color of a label before returning the result.
  16504. @param label The label to apply to.
  16505. @param date The date.
  16506. @param numericValue The numeric value for the date.
  16507. @return The result, in a {@link CellFormatResult}.
  16508. </member>
  16509. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Windows.Forms.Label,NPOI.SS.UserModel.ICell)">
  16510. Fetches the appropriate value from the cell, and uses the result, Setting
  16511. the text and color of a label before returning the result.
  16512. @param label The label to apply to.
  16513. @param c The cell.
  16514. @return The result, in a {@link CellFormatResult}.
  16515. </member>
  16516. <member name="M:NPOI.SS.Format.CellFormat.GetApplicableFormatPart(System.Object)">
  16517. Returns the {@link CellFormatPart} that applies to the value. Result
  16518. depends on how many parts the cell format has, the cell value and any
  16519. conditions. The value must be a {@link Number}.
  16520. @param value The value.
  16521. @return The {@link CellFormatPart} that applies to the value.
  16522. </member>
  16523. <member name="M:NPOI.SS.Format.CellFormat.UltimateType(NPOI.SS.UserModel.ICell)">
  16524. Returns the ultimate cell type, following the results of formulas. If
  16525. the cell is a {@link Cell#CELL_TYPE_FORMULA}, this returns the result of
  16526. {@link Cell#getCachedFormulaResultType()}. Otherwise this returns the
  16527. result of {@link Cell#getCellType()}.
  16528. @param cell The cell.
  16529. @return The ultimate type of this cell.
  16530. </member>
  16531. <member name="M:NPOI.SS.Format.CellFormat.Equals(System.Object)">
  16532. Returns <tt>true</tt> if the other object is a {@link CellFormat} object
  16533. with the same format.
  16534. @param obj The other object.
  16535. @return <tt>true</tt> if the two objects are Equal.
  16536. </member>
  16537. <member name="M:NPOI.SS.Format.CellFormat.GetHashCode">
  16538. Returns a hash code for the format.
  16539. @return A hash code for the format.
  16540. </member>
  16541. <member name="T:NPOI.SS.Format.CellFormat.GeneralCellFormat">
  16542. Format a value as it would be were no format specified. This is also
  16543. used when the format specified is <tt>General</tt>.
  16544. </member>
  16545. <member name="T:NPOI.SS.Format.CellFormatCondition">
  16546. This object represents a condition in a cell format.
  16547. @author Ken Arnold, Industrious Media LLC
  16548. </member>
  16549. <member name="M:NPOI.SS.Format.CellFormatCondition.GetInstance(System.String,System.String)">
  16550. Returns an instance of a condition object.
  16551. @param opString The operator as a string. One of <tt>"&lt;"</tt>,
  16552. <tt>"&lt;="</tt>, <tt>">"</tt>, <tt>">="</tt>,
  16553. <tt>"="</tt>, <tt>"=="</tt>, <tt>"!="</tt>, or
  16554. <tt>"&lt;>"</tt>.
  16555. @param constStr The constant (such as <tt>"12"</tt>).
  16556. @return A condition object for the given condition.
  16557. </member>
  16558. <member name="M:NPOI.SS.Format.CellFormatCondition.Pass(System.Double)">
  16559. Returns <tt>true</tt> if the given value passes the constraint's test.
  16560. @param value The value to compare against.
  16561. @return <tt>true</tt> if the given value passes the constraint's test.
  16562. </member>
  16563. <member name="T:NPOI.SS.Format.CellFormatResult">
  16564. This object Contains the result of Applying a cell format or cell format part
  16565. to a value.
  16566. @author Ken Arnold, Industrious Media LLC
  16567. @see CellFormatPart#Apply(Object)
  16568. @see CellFormat#Apply(Object)
  16569. </member>
  16570. <member name="M:NPOI.SS.Format.CellFormatResult.#ctor(System.Boolean,System.String,System.Drawing.Color)">
  16571. Creates a new format result object.
  16572. @param applies The value for {@link #applies}.
  16573. @param text The value for {@link #text}.
  16574. @param textColor The value for {@link #textColor}.
  16575. </member>
  16576. <member name="P:NPOI.SS.Format.CellFormatResult.Applies">
  16577. This is <tt>true</tt> if no condition was given that applied to the
  16578. value, or if the condition is satisfied. If a condition is relevant, and
  16579. when applied the value fails the test, this is <tt>false</tt>.
  16580. </member>
  16581. <member name="P:NPOI.SS.Format.CellFormatResult.Text">
  16582. The resulting text. This will never be <tt>null</tt>.
  16583. </member>
  16584. <member name="P:NPOI.SS.Format.CellFormatResult.TextColor">
  16585. The color the format Sets, or <tt>null</tt> if the format Sets no color.
  16586. This will always be <tt>null</tt> if {@link #applies} is <tt>false</tt>.
  16587. </member>
  16588. <member name="T:NPOI.SS.Format.CellFormatType">
  16589. The different kinds of formats that the formatter understands.
  16590. @author Ken Arnold, Industrious Media LLC
  16591. </member>
  16592. <member name="F:NPOI.SS.Format.CellFormatType.GENERAL">
  16593. The general (default) format; also used for <tt>"General"</tt>.
  16594. </member>
  16595. <member name="F:NPOI.SS.Format.CellFormatType.NUMBER">
  16596. A numeric format.
  16597. </member>
  16598. <member name="F:NPOI.SS.Format.CellFormatType.DATE">
  16599. A date format.
  16600. </member>
  16601. <member name="F:NPOI.SS.Format.CellFormatType.ELAPSED">
  16602. An elapsed time format.
  16603. </member>
  16604. <member name="F:NPOI.SS.Format.CellFormatType.TEXT">
  16605. A text format.
  16606. </member>
  16607. <member name="M:NPOI.SS.Format.CellFormatType.IsSpecial(System.Char)">
  16608. Returns <tt>true</tt> if the format is special and needs to be quoted.
  16609. @param ch The character to test.
  16610. @return <tt>true</tt> if the format is special and needs to be quoted.
  16611. </member>
  16612. <member name="M:NPOI.SS.Format.CellFormatType.Formatter(System.String)">
  16613. Returns a new formatter of the appropriate type, for the given pattern.
  16614. The pattern must be appropriate for the type.
  16615. @param pattern The pattern to use.
  16616. @return A new formatter of the appropriate type, for the given pattern.
  16617. </member>
  16618. <member name="T:NPOI.SS.Format.CellGeneralFormatter">
  16619. A formatter for the default "General" cell format.
  16620. @author Ken Arnold, Industrious Media LLC
  16621. </member>
  16622. <member name="M:NPOI.SS.Format.CellGeneralFormatter.#ctor">
  16623. Creates a new general formatter.
  16624. </member>
  16625. <member name="M:NPOI.SS.Format.CellGeneralFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16626. The general style is not quite the same as any other, or any combination
  16627. of others.
  16628. @param toAppendTo The buffer to append to.
  16629. @param value The value to format.
  16630. </member>
  16631. <member name="M:NPOI.SS.Format.CellGeneralFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16632. Equivalent to {@link #formatValue(StringBuilder,Object)}. {@inheritDoc}.
  16633. </member>
  16634. <member name="T:NPOI.SS.Format.CellNumberFormatter">
  16635. This class : printing out a value using a number format.
  16636. @author Ken Arnold, Industrious Media LLC
  16637. </member>
  16638. <member name="M:NPOI.SS.Format.CellNumberFormatter.#ctor(System.String)">
  16639. Creates a new cell number formatter.
  16640. @param format The format to Parse.
  16641. </member>
  16642. <member name="M:NPOI.SS.Format.CellNumberFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16643. {@inheritDoc}
  16644. </member>
  16645. <member name="M:NPOI.SS.Format.CellNumberFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16646. {@inheritDoc}
  16647. <p/>
  16648. For a number, this is <tt>"#"</tt> for integer values, and <tt>"#.#"</tt>
  16649. for floating-point values.
  16650. </member>
  16651. <member name="T:NPOI.SS.Format.CellNumberFormatter.SimpleNumberCellFormatter">
  16652. <summary>
  16653. The CellNumberFormatter.simpleValue() method uses the SIMPLE_NUMBER
  16654. CellFormatter defined here. The CellFormat.GENERAL_FORMAT CellFormat
  16655. no longer uses the SIMPLE_NUMBER CellFormatter.
  16656. Note that the simpleValue()/SIMPLE_NUMBER CellFormatter format
  16657. ("#" for integer values, and "#.#" for floating-point values) is
  16658. different from the 'General' format for numbers ("#" for integer
  16659. values and "#.#########" for floating-point values).
  16660. </summary>
  16661. </member>
  16662. <member name="T:NPOI.SS.Format.CellNumberFormatter.Special">
  16663. This class is used to mark where the special characters in the format
  16664. are, as opposed to the other characters that are simply printed.
  16665. </member>
  16666. <member name="T:NPOI.SS.Format.CellNumberFormatter.StringMod">
  16667. This class represents a single modification to a result string. The way
  16668. this works is complicated, but so is numeric formatting. In general, for
  16669. most formats, we use a DecimalFormat object that will Put the string out
  16670. in a known format, usually with all possible leading and trailing zeros.
  16671. We then walk through the result and the orginal format, and note any
  16672. modifications that need to be made. Finally, we go through and apply
  16673. them all, dealing with overlapping modifications.
  16674. </member>
  16675. <member name="T:NPOI.SS.Format.CellNumberFormatter.Fraction">
  16676. Based on org.apache.Commons.math.fraction.Fraction from Apache Commons-Math.
  16677. YK: The only reason of having this inner class is to avoid dependency on the Commons-Math jar.
  16678. </member>
  16679. <member name="F:NPOI.SS.Format.CellNumberFormatter.Fraction.denominator">
  16680. The denominator.
  16681. </member>
  16682. <member name="F:NPOI.SS.Format.CellNumberFormatter.Fraction.numerator">
  16683. The numerator.
  16684. </member>
  16685. <member name="M:NPOI.SS.Format.CellNumberFormatter.Fraction.#ctor(System.Double,System.Double,System.Int32,System.Int32)">
  16686. Create a fraction given the double value and either the maximum error
  16687. allowed or the maximum number of denominator digits.
  16688. @param value the double value to convert to a fraction.
  16689. @param epsilon maximum error allowed. The resulting fraction is within
  16690. <code>epsilon</code> of <code>value</code>, in absolute terms.
  16691. @param maxDenominator maximum denominator value allowed.
  16692. @param maxIterations maximum number of convergents
  16693. @throws Exception if the continued fraction failed to
  16694. converge.
  16695. </member>
  16696. <member name="M:NPOI.SS.Format.CellNumberFormatter.Fraction.#ctor(System.Double,System.Int32)">
  16697. Create a fraction given the double value and maximum denominator.
  16698. <p>
  16699. References:
  16700. <ul>
  16701. <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
  16702. Continued Fraction</a> equations (11) and (22)-(26)</li>
  16703. </ul>
  16704. </p>
  16705. @param value the double value to convert to a fraction.
  16706. @param maxDenominator The maximum allowed value for denominator
  16707. @throws Exception if the continued fraction failed to
  16708. converge
  16709. </member>
  16710. <member name="P:NPOI.SS.Format.CellNumberFormatter.Fraction.Denominator">
  16711. Access the denominator.
  16712. @return the denominator.
  16713. </member>
  16714. <member name="P:NPOI.SS.Format.CellNumberFormatter.Fraction.Numerator">
  16715. Access the numerator.
  16716. @return the numerator.
  16717. </member>
  16718. <member name="T:NPOI.SS.Format.CellTextFormatter">
  16719. This class : printing out text.
  16720. @author Ken Arnold, Industrious Media LLC
  16721. </member>
  16722. <member name="M:NPOI.SS.Format.CellTextFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  16723. {@inheritDoc}
  16724. </member>
  16725. <member name="M:NPOI.SS.Format.CellTextFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  16726. {@inheritDoc}
  16727. <p/>
  16728. For text, this is just printing the text.
  16729. </member>
  16730. <member name="T:NPOI.SS.Formula.Atp.EDate">
  16731. Implementation of Excel 'Analysis ToolPak' function EDATE()<br/>
  16732. Adds a specified number of months to the specified date.<p/>
  16733. <b>Syntax</b><br/>
  16734. <b>EDATE</b>(<b>date</b>, <b>number</b>)
  16735. <p/>
  16736. @author Tomas Herceg
  16737. </member>
  16738. <member name="T:NPOI.SS.Formula.Constant.ConstantValueParser">
  16739. To support Constant Values (2.5.7) as required by the CRN record.
  16740. This class is also used for two dimensional arrays which are encoded by
  16741. EXTERNALNAME (5.39) records and Array tokens.<p/>
  16742. @author Josh Micich
  16743. </member>
  16744. <member name="M:NPOI.SS.Formula.Constant.ConstantValueParser.GetEncodedSize(System.Object)">
  16745. @return encoded size without the 'type' code byte
  16746. </member>
  16747. <member name="T:NPOI.SS.Formula.Constant.ErrorConstant">
  16748. <summary>
  16749. Represents a constant error code value as encoded in a constant values array.
  16750. This class is a type-safe wrapper for a 16-bit int value performing a similar job to
  16751. <c>ErrorEval</c>
  16752. </summary>
  16753. <remarks> @author Josh Micich</remarks>
  16754. </member>
  16755. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.#ctor(System.Int32)">
  16756. <summary>
  16757. Initializes a new instance of the <see cref="T:NPOI.SS.Formula.Constant.ErrorConstant"/> class.
  16758. </summary>
  16759. <param name="errorCode">The error code.</param>
  16760. </member>
  16761. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ValueOf(System.Int32)">
  16762. <summary>
  16763. Values the of.
  16764. </summary>
  16765. <param name="errorCode">The error code.</param>
  16766. <returns></returns>
  16767. </member>
  16768. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ToString">
  16769. <summary>
  16770. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16771. </summary>
  16772. <returns>
  16773. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16774. </returns>
  16775. </member>
  16776. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.ErrorCode">
  16777. <summary>
  16778. Gets the error code.
  16779. </summary>
  16780. <value>The error code.</value>
  16781. </member>
  16782. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.Text">
  16783. <summary>
  16784. Gets the text.
  16785. </summary>
  16786. <value>The text.</value>
  16787. </member>
  16788. <member name="T:NPOI.HSSF.Record.ContinueRecord">
  16789. Title: Continue Record - Helper class used primarily for SST Records
  16790. Description: handles overflow for prior record in the input
  16791. stream; content Is tailored to that prior record
  16792. @author Marc Johnson (mjohnson at apache dot org)
  16793. @author Andrew C. Oliver (acoliver at apache dot org)
  16794. @author Csaba Nagy (ncsaba at yahoo dot com)
  16795. @version 2.0-pre
  16796. </member>
  16797. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor">
  16798. default constructor
  16799. </member>
  16800. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16801. Main constructor -- kinda dummy because we don't validate or fill fields
  16802. @param in the RecordInputstream to Read the record from
  16803. </member>
  16804. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[])">
  16805. Writes the full encoding of a Continue record without making an instance
  16806. </member>
  16807. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[],System.Int32,System.Int32)">
  16808. @param initialDataByte (optional - often used for unicode flag).
  16809. If supplied, this will be written before srcData
  16810. @return the total number of bytes written
  16811. </member>
  16812. <member name="M:NPOI.HSSF.Record.ContinueRecord.ToString">
  16813. Debugging toString
  16814. @return string representation
  16815. </member>
  16816. <member name="M:NPOI.HSSF.Record.ContinueRecord.Clone">
  16817. Clone this record.
  16818. </member>
  16819. <member name="P:NPOI.HSSF.Record.ContinueRecord.Data">
  16820. Get the data for continuation
  16821. @return byte array containing all of the continued data
  16822. </member>
  16823. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecord">
  16824. Common superclass of all records that can produce {@link ContinueRecord}s while being Serialized.
  16825. @author Josh Micich
  16826. </member>
  16827. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  16828. Serializes this record's content to the supplied data output.<br/>
  16829. The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so
  16830. only BIFF data should be written by this method. Simple data types can be written with the
  16831. standard {@link LittleEndianOutput} methods. Methods from {@link ContinuableRecordOutput}
  16832. can be used to Serialize strings (with {@link ContinueRecord}s being written as required).
  16833. If necessary, implementors can explicitly start {@link ContinueRecord}s (regardless of the
  16834. amount of remaining space).
  16835. @param out a data output stream
  16836. </member>
  16837. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecord.RecordSize">
  16838. @return the total Length of the encoded record(s)
  16839. (Note - if any {@link ContinueRecord} is required, this result includes the
  16840. size of those too)
  16841. </member>
  16842. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordOutput">
  16843. An augmented {@link LittleEndianOutput} used for serialization of {@link ContinuableRecord}s.
  16844. This class keeps track of how much remaining space is available in the current BIFF record and
  16845. can start new {@link ContinueRecord}s as required.
  16846. @author Josh Micich
  16847. </member>
  16848. <member name="T:NPOI.Util.ILittleEndianOutput">
  16849. @author Josh Micich
  16850. </member>
  16851. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.Terminate">
  16852. Terminates the last record (also updates its 'ushort size' field)
  16853. </member>
  16854. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteContinue">
  16855. Terminates the current record and starts a new {@link ContinueRecord} (regardless
  16856. of how much space is still available in the current record).
  16857. </member>
  16858. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteStringData(System.String)">
  16859. Writes the 'optionFlags' byte and encoded character data of a unicode string. This includes:
  16860. <ul>
  16861. <li>byte optionFlags</li>
  16862. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  16863. </ul>
  16864. Notes:
  16865. <ul>
  16866. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  16867. of <c>text</c></li>
  16868. <li>The string options flag is never separated (by a {@link ContinueRecord}) from the
  16869. first chunk of character data it refers to.</li>
  16870. <li>The 'ushort Length' field is assumed to have been explicitly written earlier. Hence,
  16871. there may be an intervening {@link ContinueRecord}</li>
  16872. </ul>
  16873. </member>
  16874. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteString(System.String,System.Int32,System.Int32)">
  16875. Writes a unicode string complete with header and character data. This includes:
  16876. <ul>
  16877. <li>ushort Length</li>
  16878. <li>byte optionFlags</li>
  16879. <li>ushort numberOfRichTextRuns (optional)</li>
  16880. <li>ushort extendedDataSize (optional)</li>
  16881. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  16882. </ul>
  16883. The following bits of the 'optionFlags' byte will be set as appropriate:
  16884. <table border='1'>
  16885. <tr><th>Mask</th><th>Description</th></tr>
  16886. <tr><td>0x01</td><td>is16bitEncoded</td></tr>
  16887. <tr><td>0x04</td><td>hasExtendedData</td></tr>
  16888. <tr><td>0x08</td><td>isRichText</td></tr>
  16889. </table>
  16890. Notes:
  16891. <ul>
  16892. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  16893. of <c>text</c></li>
  16894. <li>The string header fields are never separated (by a {@link ContinueRecord}) from the
  16895. first chunk of character data (i.e. the first character is always encoded in the same
  16896. record as the string header).</li>
  16897. </ul>
  16898. </member>
  16899. <member name="F:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.NOPOutput">
  16900. **
  16901. </member>
  16902. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.TotalSize">
  16903. @return total number of bytes written so far (including all BIFF headers)
  16904. </member>
  16905. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.AvailableSpace">
  16906. @return number of remaining bytes of space in current record
  16907. </member>
  16908. <member name="T:NPOI.Util.IDelayableLittleEndianOutput">
  16909. <summary>
  16910. Implementors of this interface allow client code to 'delay' writing to a certain section of a
  16911. data output stream.<br/>
  16912. A typical application is for writing BIFF records when the size is not known until well after
  16913. the header has been written. The client code can call <see cref="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput"/>
  16914. to reserve two bytes of the output for the 'ushort size' header field. The delayed output can
  16915. be written at any stage.
  16916. </summary>
  16917. <remarks>@author Josh Micich</remarks>
  16918. </member>
  16919. <member name="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput(System.Int32)">
  16920. <summary>
  16921. Creates an output stream intended for outputting a sequence of <c>size</c> bytes.
  16922. </summary>
  16923. <param name="size"></param>
  16924. <returns></returns>
  16925. </member>
  16926. <member name="T:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput">
  16927. Allows the writing of BIFF records when the 'ushort size' header field is not known in advance.
  16928. When the client is finished writing data, it calls {@link #terminate()}, at which point this
  16929. class updates the 'ushort size' with its value.
  16930. @author Josh Micich
  16931. </member>
  16932. <member name="F:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput._dataSizeOutput">
  16933. for writing the 'ushort size' field once its value is known
  16934. </member>
  16935. <member name="M:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.Terminate">
  16936. Finishes writing the current record and updates 'ushort size' field.<br/>
  16937. After this method is called, only {@link #getTotalSize()} may be called.
  16938. </member>
  16939. <member name="P:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.TotalSize">
  16940. includes 4 byte header
  16941. </member>
  16942. <member name="T:NPOI.HSSF.Record.CountryRecord">
  16943. Title: Country Record (aka WIN.INI country)
  16944. Description: used for localization. Currently HSSF always Sets this to 1
  16945. and it seems to work fine even in Germany. (es geht's auch fuer Deutschland)
  16946. REFERENCE: PG 298 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16947. @author Andrew C. Oliver (acoliver at apache dot org)
  16948. @version 2.0-pre
  16949. </member>
  16950. <member name="M:NPOI.HSSF.Record.CountryRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16951. Constructs a CountryRecord and Sets its fields appropriately
  16952. @param in the RecordInputstream to Read the record from
  16953. </member>
  16954. <member name="P:NPOI.HSSF.Record.CountryRecord.DefaultCountry">
  16955. Gets the default country
  16956. @return country ID (1 = US)
  16957. </member>
  16958. <member name="P:NPOI.HSSF.Record.CountryRecord.CurrentCountry">
  16959. Gets the current country
  16960. @return country ID (1 = US)
  16961. </member>
  16962. <member name="T:NPOI.HSSF.Record.CRNCountRecord">
  16963. XCT ?CRN Count
  16964. REFERENCE: 5.114
  16965. @author Josh Micich
  16966. </member>
  16967. <member name="P:NPOI.HSSF.Record.CRNCountRecord.Sid">
  16968. return the non static version of the id for this record.
  16969. </member>
  16970. <member name="T:NPOI.HSSF.Record.CRNRecord">
  16971. Title: CRN
  16972. Description: This record stores the contents of an external cell or cell range
  16973. REFERENCE: 5.23
  16974. @author josh micich
  16975. </member>
  16976. <member name="P:NPOI.HSSF.Record.CRNRecord.Sid">
  16977. return the non static version of the id for this record.
  16978. </member>
  16979. <member name="T:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream">
  16980. @author Josh Micich
  16981. </member>
  16982. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadRecordSID">
  16983. Reads an unsigned short value without decrypting
  16984. </member>
  16985. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadDataSize">
  16986. Reads an unsigned short value without decrypting
  16987. </member>
  16988. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Create(System.Byte[])">
  16989. Create using the default password and a specified docId
  16990. @param docId 16 bytes
  16991. </member>
  16992. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Validate(System.Byte[],System.Byte[])">
  16993. @return <c>true</c> if the keyDigest is compatible with the specified saltData and saltHash
  16994. </member>
  16995. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CreateRC4(System.Int32)">
  16996. The {@link RC4} instance needs to be Changed every 1024 bytes.
  16997. @param keyBlockNo used to seed the newly Created {@link RC4}
  16998. </member>
  16999. <member name="F:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey._userPasswordTLS">
  17000. Stores the BIFF8 encryption/decryption password for the current thread. This has been done
  17001. using a {@link ThreadLocal} in order to avoid further overloading the various public APIs
  17002. (e.g. {@link HSSFWorkbook}) that need this functionality.
  17003. </member>
  17004. <member name="P:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CurrentUserPassword">
  17005. @return the BIFF8 encryption/decryption password for the current thread.
  17006. <code>null</code> if it is currently unSet.
  17007. </member>
  17008. <member name="T:NPOI.HSSF.Record.Crypto.Biff8RC4">
  17009. Used for both encrypting and decrypting BIFF8 streams. The internal
  17010. {@link RC4} instance is renewed (re-keyed) every 1024 bytes.
  17011. @author Josh Micich
  17012. </member>
  17013. <member name="F:NPOI.HSSF.Record.Crypto.Biff8RC4._streamPos">
  17014. This field is used to keep track of when to change the {@link RC4}
  17015. instance. The change occurs every 1024 bytes. Every byte passed over is
  17016. counted.
  17017. </member>
  17018. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.IsNeverEncryptedRecord(System.Int32)">
  17019. TODO: Additionally, the lbPlyPos (position_of_BOF) field of the BoundSheet8 record MUST NOT be encrypted.
  17020. @return <c>true</c> if record type specified by <c>sid</c> is never encrypted
  17021. </member>
  17022. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.SkipTwoBytes">
  17023. Used when BIFF header fields (sid, size) are being Read. The internal
  17024. {@link RC4} instance must step even when unencrypted bytes are read
  17025. </member>
  17026. <member name="T:NPOI.HSSF.Record.Crypto.RC4">
  17027. Simple implementation of the alleged RC4 algorithm.
  17028. Inspired by <A HREF="http://en.wikipedia.org/wiki/RC4">wikipedia's RC4 article</A>
  17029. @author Josh Micich
  17030. </member>
  17031. <member name="M:NPOI.HSSF.Record.CustomField.FillField(NPOI.HSSF.Record.RecordInputStream)">
  17032. Populates this fields data from the byte array passed in1.
  17033. @param in the RecordInputstream to Read the record from
  17034. </member>
  17035. <member name="M:NPOI.HSSF.Record.CustomField.ToString(System.Text.StringBuilder)">
  17036. Appends the string representation of this field to the supplied
  17037. StringBuilder.
  17038. @param str The string buffer to Append to.
  17039. </member>
  17040. <member name="M:NPOI.HSSF.Record.CustomField.SerializeField(System.Int32,System.Byte[])">
  17041. Converts this field to it's byte array form.
  17042. @param offset The offset into the byte array to start writing to.
  17043. @param data The data array to Write to.
  17044. @return The number of bytes written.
  17045. </member>
  17046. <member name="P:NPOI.HSSF.Record.CustomField.Size">
  17047. @return The size of this field in bytes. This operation Is not valid
  17048. Until after the call to <c>FillField()</c>
  17049. </member>
  17050. <member name="T:NPOI.HSSF.Record.DateWindow1904Record">
  17051. Title: Date Window 1904 Flag record
  17052. Description: Flag specifying whether 1904 date windowing Is used.
  17053. (tick toc tick toc...BOOM!)
  17054. REFERENCE: PG 280 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17055. @author Andrew C. Oliver (acoliver at apache dot org)
  17056. @version 2.0-pre
  17057. </member>
  17058. <member name="M:NPOI.HSSF.Record.DateWindow1904Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17059. Constructs a DateWindow1904 record and Sets its fields appropriately.
  17060. @param in the RecordInputstream to Read the record from
  17061. </member>
  17062. <member name="P:NPOI.HSSF.Record.DateWindow1904Record.Windowing">
  17063. Gets whether or not to use 1904 date windowing (which means you'll be screwed in 2004)
  17064. @return window flag - 0/1 (false,true)
  17065. </member>
  17066. <member name="T:NPOI.HSSF.Record.DBCellRecord">
  17067. Title: DBCell Record
  17068. Description: Used by Excel and other MS apps to quickly Find rows in the sheets.
  17069. REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17070. @author Andrew C. Oliver (acoliver at apache dot org)
  17071. @author Jason Height
  17072. @version 2.0-pre
  17073. </member>
  17074. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17075. Constructs a DBCellRecord and Sets its fields appropriately
  17076. @param in the RecordInputstream to Read the record from
  17077. </member>
  17078. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(System.Int32,System.Int16[])">
  17079. offset from the start of this DBCellRecord to the start of the first cell in
  17080. the next DBCell block.
  17081. </member>
  17082. <member name="M:NPOI.HSSF.Record.DBCellRecord.GetCellOffsetAt(System.Int32)">
  17083. return the cell offset in the array
  17084. @param index of the cell offset to retrieve
  17085. @return celloffset from the celloffset array
  17086. </member>
  17087. <member name="M:NPOI.HSSF.Record.DBCellRecord.CalculateSizeOfRecords(System.Int32,System.Int32)">
  17088. @returns the size of the Group of <c>DBCellRecord</c>s needed to encode
  17089. the specified number of blocks and rows
  17090. </member>
  17091. <member name="P:NPOI.HSSF.Record.DBCellRecord.RowOffset">
  17092. Gets offset from the start of this DBCellRecord to the start of the first cell in
  17093. the next DBCell block.
  17094. @return rowoffset to the start of the first cell in the next DBCell block
  17095. </member>
  17096. <member name="P:NPOI.HSSF.Record.DBCellRecord.NumCellOffsets">
  17097. Get the number of cell offsets in the celloffset array
  17098. @return number of cell offsets
  17099. </member>
  17100. <member name="T:NPOI.HSSF.Record.DefaultColWidthRecord">
  17101. Title: Default Column Width Record
  17102. Description: Specifies the default width for columns that have no specific
  17103. width Set.
  17104. REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17105. @author Andrew C. Oliver (acoliver at apache dot org)
  17106. @author Jason Height (jheight at chariot dot net dot au)
  17107. @version 2.0-pre
  17108. </member>
  17109. <member name="F:NPOI.HSSF.Record.DefaultColWidthRecord.DEFAULT_COLUMN_WIDTH">
  17110. The default column width is 8 characters
  17111. </member>
  17112. <member name="M:NPOI.HSSF.Record.DefaultColWidthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17113. Constructs a DefaultColumnWidth record and Sets its fields appropriately.
  17114. @param in the RecordInputstream to Read the record from
  17115. </member>
  17116. <member name="P:NPOI.HSSF.Record.DefaultColWidthRecord.ColWidth">
  17117. Get the default column width
  17118. @return defaultwidth for columns
  17119. </member>
  17120. <member name="T:NPOI.HSSF.Record.DefaultRowHeightRecord">
  17121. Title: Default Row Height Record
  17122. Description: Row height for rows with Undefined or not explicitly defined
  17123. heights.
  17124. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17125. @author Andrew C. Oliver (acoliver at apache dot org)
  17126. @author Jason Height (jheight at chariot dot net dot au)
  17127. @version 2.0-pre
  17128. </member>
  17129. <member name="F:NPOI.HSSF.Record.DefaultRowHeightRecord.DEFAULT_ROW_HEIGHT">
  17130. The default row height for empty rows is 255 twips (255 / 20 == 12.75 points)
  17131. </member>
  17132. <member name="M:NPOI.HSSF.Record.DefaultRowHeightRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17133. <summary>
  17134. Constructs a DefaultRowHeight record and Sets its fields appropriately.
  17135. </summary>
  17136. <param name="in1">the RecordInputstream to Read the record from</param>
  17137. </member>
  17138. <member name="P:NPOI.HSSF.Record.DefaultRowHeightRecord.RowHeight">
  17139. <summary>
  17140. Get the default row height
  17141. </summary>
  17142. </member>
  17143. <member name="T:NPOI.HSSF.Record.DeltaRecord">
  17144. Title: Delta Record
  17145. Description: controls the accuracy of the calculations
  17146. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17147. @author Andrew C. Oliver (acoliver at apache dot org)
  17148. @author Jason Height (jheight at chariot dot net dot au)
  17149. @version 2.0-pre
  17150. </member>
  17151. <member name="M:NPOI.HSSF.Record.DeltaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17152. Constructs a Delta record and Sets its fields appropriately.
  17153. @param in the RecordInputstream to Read the record from
  17154. </member>
  17155. <member name="P:NPOI.HSSF.Record.DeltaRecord.MaxChange">
  17156. Get the maximum Change
  17157. @return maxChange - maximum rounding error
  17158. </member>
  17159. <member name="T:NPOI.HSSF.Record.DimensionsRecord">
  17160. Title: Dimensions Record
  17161. Description: provides the minumum and maximum bounds
  17162. of a sheet.
  17163. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17164. @author Andrew C. Oliver (acoliver at apache dot org)
  17165. @author Jason Height (jheight at chariot dot net dot au)
  17166. @version 2.0-pre
  17167. </member>
  17168. <member name="M:NPOI.HSSF.Record.DimensionsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17169. Constructs a Dimensions record and Sets its fields appropriately.
  17170. @param in the RecordInputstream to Read the record from
  17171. </member>
  17172. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstRow">
  17173. Get the first row number for the sheet
  17174. @return row - first row on the sheet
  17175. </member>
  17176. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastRow">
  17177. Get the last row number for the sheet
  17178. @return row - last row on the sheet
  17179. </member>
  17180. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstCol">
  17181. Get the first column number for the sheet
  17182. @return column - first column on the sheet
  17183. </member>
  17184. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastCol">
  17185. Get the last col number for the sheet
  17186. @return column - last column on the sheet
  17187. </member>
  17188. <member name="M:NPOI.HSSF.Record.DrawingGroupRecord.ProcessChildRecords">
  17189. Process the bytes into escher records.
  17190. (Not done by default in case we break things,
  17191. Unless you Set the "poi.deSerialize.escher"
  17192. system property)
  17193. </member>
  17194. <member name="P:NPOI.HSSF.Record.DrawingGroupRecord.RecordSize">
  17195. Size of record (including 4 byte headers for all sections)
  17196. </member>
  17197. <member name="T:NPOI.HSSF.Record.DrawingRecord">
  17198. DrawingRecord (0x00EC)<p/>
  17199. </member>
  17200. <member name="M:NPOI.HSSF.Record.DrawingRecord.Clone">
  17201. Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed
  17202. @return cloned drawing records
  17203. </member>
  17204. <member name="T:NPOI.HSSF.Record.DrawingRecordForBiffViewer">
  17205. This Is purely for the biff viewer. During normal operations we don't want
  17206. to be seeing this.
  17207. </member>
  17208. <member name="T:NPOI.HSSF.Record.DSFRecord">
  17209. Title: double Stream Flag Record
  17210. Description: tells if this Is a double stream file. (always no for HSSF generated files)
  17211. double Stream files contain both BIFF8 and BIFF7 workbooks.
  17212. REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17213. @author Andrew C. Oliver (acoliver at apache dot org)
  17214. @version 2.0-pre
  17215. </member>
  17216. <member name="M:NPOI.HSSF.Record.DSFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17217. Constructs a DBCellRecord and Sets its fields appropriately.
  17218. @param in the RecordInputstream to Read the record from
  17219. </member>
  17220. <member name="T:NPOI.HSSF.Record.DVALRecord">
  17221. Title: DATAVALIDATIONS Record
  17222. Description: used in data validation ;
  17223. This record Is the list header of all data validation records (0x01BE) in the current sheet.
  17224. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  17225. </member>
  17226. <member name="F:NPOI.HSSF.Record.DVALRecord.field_1_options">
  17227. Options of the DVAL
  17228. </member>
  17229. <member name="F:NPOI.HSSF.Record.DVALRecord.field_2_horiz_pos">
  17230. Horizontal position of the dialog
  17231. </member>
  17232. <member name="F:NPOI.HSSF.Record.DVALRecord.field_3_vert_pos">
  17233. Vertical position of the dialog
  17234. </member>
  17235. <member name="F:NPOI.HSSF.Record.DVALRecord.field_cbo_id">
  17236. Object ID of the drop down arrow object for list boxes ;
  17237. in our case this will be always FFFF , Until
  17238. MSODrawingGroup and MSODrawing records are implemented
  17239. </member>
  17240. <member name="F:NPOI.HSSF.Record.DVALRecord.field_5_dv_no">
  17241. Number of following DV Records
  17242. </member>
  17243. <member name="M:NPOI.HSSF.Record.DVALRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17244. Constructs a DVAL record and Sets its fields appropriately.
  17245. @param in the RecordInputstream to Read the record from
  17246. </member>
  17247. <member name="P:NPOI.HSSF.Record.DVALRecord.Options">
  17248. @return the field_1_options
  17249. </member>
  17250. <member name="P:NPOI.HSSF.Record.DVALRecord.HorizontalPos">
  17251. @return the Horizontal position of the dialog
  17252. </member>
  17253. <member name="P:NPOI.HSSF.Record.DVALRecord.VerticalPos">
  17254. @return the the Vertical position of the dialog
  17255. </member>
  17256. <member name="P:NPOI.HSSF.Record.DVALRecord.ObjectID">
  17257. Get Object ID of the drop down arrow object for list boxes
  17258. </member>
  17259. <member name="P:NPOI.HSSF.Record.DVALRecord.DVRecNo">
  17260. Get number of following DV records
  17261. </member>
  17262. <member name="T:NPOI.HSSF.Record.DVRecord">
  17263. Title: DATAVALIDATION Record (0x01BE)<p/>
  17264. Description: This record stores data validation Settings and a list of cell ranges
  17265. which contain these Settings. The data validation Settings of a sheet
  17266. are stored in a sequential list of DV records. This list Is followed by
  17267. DVAL record(s)
  17268. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  17269. @version 2.0-pre
  17270. </member>
  17271. <member name="F:NPOI.HSSF.Record.DVRecord._option_flags">
  17272. Option flags
  17273. </member>
  17274. <member name="F:NPOI.HSSF.Record.DVRecord._promptTitle">
  17275. Title of the prompt box
  17276. </member>
  17277. <member name="F:NPOI.HSSF.Record.DVRecord._errorTitle">
  17278. Title of the error box
  17279. </member>
  17280. <member name="F:NPOI.HSSF.Record.DVRecord._promptText">
  17281. Text of the prompt box
  17282. </member>
  17283. <member name="F:NPOI.HSSF.Record.DVRecord._errorText">
  17284. Text of the error box
  17285. </member>
  17286. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_1">
  17287. Not used - Excel seems to always write 0x3FE0
  17288. </member>
  17289. <member name="F:NPOI.HSSF.Record.DVRecord._formula1">
  17290. Formula data for first condition (RPN token array without size field)
  17291. </member>
  17292. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_2">
  17293. Not used - Excel seems to always write 0x0000
  17294. </member>
  17295. <member name="F:NPOI.HSSF.Record.DVRecord._formula2">
  17296. Formula data for second condition (RPN token array without size field)
  17297. </member>
  17298. <member name="F:NPOI.HSSF.Record.DVRecord._regions">
  17299. Cell range address list with all affected ranges
  17300. </member>
  17301. <member name="F:NPOI.HSSF.Record.DVRecord.opt_data_type">
  17302. Option flags field
  17303. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17304. </member>
  17305. <member name="M:NPOI.HSSF.Record.DVRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17306. Constructs a DV record and Sets its fields appropriately.
  17307. @param in the RecordInputstream to Read the record from
  17308. </member>
  17309. <member name="M:NPOI.HSSF.Record.DVRecord.ResolveTitleText(System.String)">
  17310. When entered via the UI, Excel translates empty string into "\0"
  17311. While it is possible to encode the title/text as empty string (Excel doesn't exactly crash),
  17312. the resulting tool-tip text / message box looks wrong. It is best to do the same as the
  17313. Excel UI and encode 'not present' as "\0".
  17314. </member>
  17315. <member name="M:NPOI.HSSF.Record.DVRecord.Clone">
  17316. Clones the object. Uses serialisation, as the
  17317. contents are somewhat complex
  17318. </member>
  17319. <member name="P:NPOI.HSSF.Record.DVRecord.DataType">
  17320. Get the condition data type
  17321. @return the condition data type
  17322. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17323. </member>
  17324. <member name="P:NPOI.HSSF.Record.DVRecord.ErrorStyle">
  17325. Get the condition error style
  17326. @return the condition error style
  17327. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17328. </member>
  17329. <member name="P:NPOI.HSSF.Record.DVRecord.ListExplicitFormula">
  17330. return true if in list validations the string list Is explicitly given in the formula, false otherwise
  17331. @return true if in list validations the string list Is explicitly given in the formula, false otherwise
  17332. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17333. </member>
  17334. <member name="P:NPOI.HSSF.Record.DVRecord.EmptyCellAllowed">
  17335. return true if empty values are allowed in cells, false otherwise
  17336. @return if empty values are allowed in cells, false otherwise
  17337. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17338. </member>
  17339. <member name="P:NPOI.HSSF.Record.DVRecord.ShowPromptOnCellSelected">
  17340. return true if a prompt window should appear when cell Is selected, false otherwise
  17341. @return if a prompt window should appear when cell Is selected, false otherwise
  17342. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17343. </member>
  17344. <member name="P:NPOI.HSSF.Record.DVRecord.ShowErrorOnInvalidValue">
  17345. return true if an error window should appear when an invalid value Is entered in the cell, false otherwise
  17346. @return if an error window should appear when an invalid value Is entered in the cell, false otherwise
  17347. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17348. </member>
  17349. <member name="P:NPOI.HSSF.Record.DVRecord.ConditionOperator">
  17350. Get the condition operator
  17351. @return the condition operator
  17352. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  17353. </member>
  17354. <member name="P:NPOI.HSSF.Record.DVRecord.OptionFlags">
  17355. Gets the option flags field.
  17356. @return options - the option flags field
  17357. </member>
  17358. <member name="T:NPOI.HSSF.Record.EOFRecord">
  17359. End Of File record.
  17360. Description: Marks the end of records belonging to a particular object in the
  17361. HSSF File
  17362. REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17363. @author Andrew C. Oliver (acoliver at apache dot org)
  17364. @author Jason Height (jheight at chariot dot net dot au)
  17365. @version 2.0-pre
  17366. </member>
  17367. <member name="M:NPOI.HSSF.Record.EOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17368. Constructs a EOFRecord record and Sets its fields appropriately.
  17369. @param in the RecordInputstream to Read the record from
  17370. </member>
  17371. <member name="T:NPOI.HSSF.Record.EscherAggregate">
  17372. This class Is used to aggregate the MSODRAWING and OBJ record
  17373. combinations. This Is necessary due to the bizare way in which
  17374. these records are Serialized. What happens Is that you Get a
  17375. combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records
  17376. but the escher records are Serialized _across_ the MSODRAWING
  17377. records.
  17378. It Gets even worse when you start looking at TXO records.
  17379. So what we do with this class Is aggregate lazily. That Is
  17380. we don't aggregate the MSODRAWING -> OBJ records Unless we
  17381. need to modify them.
  17382. At first document contains 4 types of records which belong to drawing layer.
  17383. There are can be such sequence of record:
  17384. <p/>
  17385. DrawingRecord
  17386. ContinueRecord
  17387. ...
  17388. ContinueRecord
  17389. ObjRecord | TextObjectRecord
  17390. .....
  17391. ContinueRecord
  17392. ...
  17393. ContinueRecord
  17394. ObjRecord | TextObjectRecord
  17395. NoteRecord
  17396. ...
  17397. NoteRecord
  17398. <p/>
  17399. To work with shapes we have to read data from Drawing and Continue records into single array of bytes and
  17400. build escher(office art) records tree from this array.
  17401. Each shape in drawing layer matches corresponding ObjRecord
  17402. Each textbox matches corresponding TextObjectRecord
  17403. <p/>
  17404. ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)
  17405. <p/>
  17406. EscherAggrefate contains also NoteRecords
  17407. NoteRecords must be serial
  17408. @author Glen Stampoultzis (glens at apache.org)
  17409. </member>
  17410. <member name="F:NPOI.HSSF.Record.EscherAggregate.shapeToObj">
  17411. Maps shape container objects to their OBJ records
  17412. </member>
  17413. <member name="F:NPOI.HSSF.Record.EscherAggregate.tailRec">
  17414. list of "tail" records that need to be Serialized after all drawing Group records
  17415. </member>
  17416. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToString">
  17417. Calculates the string representation of this record. This Is
  17418. simply a dump of all the records.
  17419. </member>
  17420. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToXml(System.String)">
  17421. Calculates the xml representation of this record. This is
  17422. simply a dump of all the records.
  17423. @param tab - string which must be added before each line (used by default '\t')
  17424. @return xml representation of the all aggregated records
  17425. </member>
  17426. <member name="M:NPOI.HSSF.Record.EscherAggregate.IsDrawingLayerRecord(System.Int16)">
  17427. @param sid - record sid we want to check if it belongs to drawing layer
  17428. @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord
  17429. </member>
  17430. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.Record.EscherAggregate.CreateAggregate(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)" -->
  17431. <member name="M:NPOI.HSSF.Record.EscherAggregate.Serialize(System.Int32,System.Byte[])">
  17432. Serializes this aggregate to a byte array. Since this Is an aggregate
  17433. record it will effectively Serialize the aggregated records.
  17434. @param offset The offset into the start of the array.
  17435. @param data The byte array to Serialize to.
  17436. @return The number of bytes Serialized.
  17437. </member>
  17438. <member name="M:NPOI.HSSF.Record.EscherAggregate.WriteDataIntoDrawingRecord(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  17439. @param drawingData - escher records saved into single byte array
  17440. @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create
  17441. drawing or continue record)
  17442. @param pos current position of data array
  17443. @param data - array of bytes where drawing records must be serialized
  17444. @param i - number of shape, saved into data array
  17445. @return offset of data array after serialization
  17446. </member>
  17447. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherRecordSize(System.Collections.Generic.List{NPOI.DDF.EscherRecord})">
  17448. How many bytes do the raw escher records contain.
  17449. @param records List of escher records
  17450. @return the number of bytes
  17451. </member>
  17452. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetSid(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  17453. @param records list of records to look into
  17454. @param loc - location of the record which sid must be returned
  17455. @return sid of the record with selected location
  17456. </member>
  17457. <member name="M:NPOI.HSSF.Record.EscherAggregate.BuildBaseTree">
  17458. create base tree with such structure:
  17459. EscherDgContainer
  17460. -EscherSpgrContainer
  17461. --EscherSpContainer
  17462. ---EscherSpRecord
  17463. ---EscherSpgrRecord
  17464. ---EscherSpRecord
  17465. -EscherDgRecord
  17466. id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch
  17467. </member>
  17468. <member name="M:NPOI.HSSF.Record.EscherAggregate.Children(System.Byte[],System.Int16,System.Int32)">
  17469. Unused since this Is an aggregate record. Use CreateAggregate().
  17470. @see #CreateAggregate
  17471. </member>
  17472. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherChild(NPOI.DDF.EscherContainerRecord,System.Int32)">
  17473. Converts the Records into UserModel
  17474. objects on the bound HSSFPatriarch
  17475. </member>
  17476. <member name="M:NPOI.HSSF.Record.EscherAggregate.AssociateShapeToObjRecord(NPOI.DDF.EscherRecord,NPOI.HSSF.Record.Record)">
  17477. <summary>
  17478. Associates an escher record to an OBJ record or a TXO record.
  17479. </summary>
  17480. <param name="r">ClientData or Textbox record</param>
  17481. <param name="objRecord">Obj or TextObj record</param>
  17482. </member>
  17483. <member name="M:NPOI.HSSF.Record.EscherAggregate.RemoveShapeToObjRecord(NPOI.DDF.EscherRecord)">
  17484. <summary>
  17485. Remove echerRecord and associated to it Obj or TextObj record
  17486. </summary>
  17487. <param name="rec">clientData or textbox record to be removed</param>
  17488. </member>
  17489. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetNoteRecordByObj(NPOI.HSSF.Record.ObjRecord)">
  17490. @param obj - ObjRecord with id == NoteRecord.id
  17491. @return null if note record is not found else returns note record with id == obj.id
  17492. </member>
  17493. <member name="P:NPOI.HSSF.Record.EscherAggregate.Sid">
  17494. @return Returns the current sid.
  17495. </member>
  17496. <member name="P:NPOI.HSSF.Record.EscherAggregate.RecordSize">
  17497. @return record size, including header size of obj, text, note, drawing, continue records
  17498. </member>
  17499. <member name="P:NPOI.HSSF.Record.EscherAggregate.TailRecords">
  17500. @return unmodifiable copy of tail records. We need to access them when building shapes.
  17501. Every HSSFComment shape has a link to a NoteRecord from the tailRec collection.
  17502. </member>
  17503. <member name="T:NPOI.HSSF.Record.ExtendedFormatRecord">
  17504. Title: Extended Format Record
  17505. Description: Probably one of the more complex records. There are two breeds:
  17506. Style and Cell.
  17507. It should be noted that fields in the extended format record are
  17508. somewhat arbitrary. Almost all of the fields are bit-level, but
  17509. we name them as best as possible by functional Group. In some
  17510. places this Is better than others.
  17511. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17512. @author Andrew C. Oliver (acoliver at apache dot org)
  17513. @version 2.0-pre
  17514. </member>
  17515. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor">
  17516. Constructor ExtendedFormatRecord
  17517. </member>
  17518. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17519. Constructs an ExtendedFormat record and Sets its fields appropriately.
  17520. @param in the RecordInputstream to Read the record from
  17521. </member>
  17522. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.CloneStyleFrom(NPOI.HSSF.Record.ExtendedFormatRecord)">
  17523. Clones all the style information from another
  17524. ExtendedFormatRecord, onto this one. This
  17525. will then hold all the same style options.
  17526. If The source ExtendedFormatRecord comes from
  17527. a different Workbook, you will need to sort
  17528. out the font and format indicies yourself!
  17529. </member>
  17530. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.Equals(System.Object)">
  17531. Will consider two different records with the same
  17532. contents as Equals, as the various indexes
  17533. that matter are embedded in the records
  17534. </member>
  17535. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FontIndex">
  17536. <summary>
  17537. Get the index to the FONT record (which font to use 0 based)
  17538. </summary>
  17539. </member>
  17540. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FormatIndex">
  17541. <summary>
  17542. Get the index to the Format record (which FORMAT to use 0-based)
  17543. </summary>
  17544. </member>
  17545. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.CellOptions">
  17546. <summary>
  17547. Gets the options bitmask - you can also use corresponding option bit Getters
  17548. (see other methods that reference this one)
  17549. </summary>
  17550. </member>
  17551. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsLocked">
  17552. <summary>
  17553. Get whether the cell Is locked or not
  17554. </summary>
  17555. </member>
  17556. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsHidden">
  17557. <summary>
  17558. Get whether the cell Is hidden or not
  17559. </summary>
  17560. </member>
  17561. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.XFType">
  17562. <summary>
  17563. Get whether the cell Is a cell or style XFRecord
  17564. </summary>
  17565. </member>
  17566. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord._123Prefix">
  17567. <summary>
  17568. Get some old holdover from lotus 123. Who cares, its all over for Lotus.
  17569. RIP Lotus.
  17570. </summary>
  17571. </member>
  17572. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ParentIndex">
  17573. <summary>
  17574. for cell XF types this Is the parent style (usually 0/normal). For
  17575. style this should be NULL.
  17576. </summary>
  17577. </member>
  17578. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AlignmentOptions">
  17579. <summary>
  17580. Get the alignment options bitmask. See corresponding bitGetter methods
  17581. that reference this one.
  17582. </summary>
  17583. </member>
  17584. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Alignment">
  17585. <summary>
  17586. Get the horizontal alignment of the cell.
  17587. </summary>
  17588. </member>
  17589. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.WrapText">
  17590. <summary>
  17591. Get whether to wrap the text in the cell
  17592. </summary>
  17593. </member>
  17594. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.VerticalAlignment">
  17595. <summary>
  17596. Get the vertical alignment of text in the cell
  17597. </summary>
  17598. </member>
  17599. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.JustifyLast">
  17600. <summary>
  17601. Docs just say this Is for far east versions.. (I'm guessing it
  17602. justifies for right-to-left Read languages)
  17603. </summary>
  17604. </member>
  17605. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Rotation">
  17606. <summary>
  17607. Get the degree of rotation. (I've not actually seen this used anywhere)
  17608. </summary>
  17609. </member>
  17610. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IndentionOptions">
  17611. <summary>
  17612. Get the indent options bitmask (see corresponding bit Getters that reference
  17613. this field)
  17614. </summary>
  17615. </member>
  17616. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Indent">
  17617. <summary>
  17618. Get indention (not sure of the Units, think its spaces)
  17619. </summary>
  17620. </member>
  17621. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ShrinkToFit">
  17622. <summary>
  17623. Get whether to shrink the text to fit
  17624. </summary>
  17625. </member>
  17626. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.MergeCells">
  17627. <summary>
  17628. Get whether to merge cells
  17629. </summary>
  17630. </member>
  17631. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ReadingOrder">
  17632. <summary>
  17633. Get the Reading order for far east versions (0 - Context, 1 - Left to right,
  17634. 2 - right to left) - We could use some help with support for the far east.
  17635. </summary>
  17636. </member>
  17637. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFormat">
  17638. <summary>
  17639. Get whether or not to use the format in this XF instead of the parent XF.
  17640. </summary>
  17641. </member>
  17642. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFont">
  17643. <summary>
  17644. Get whether or not to use the font in this XF instead of the parent XF.
  17645. </summary>
  17646. </member>
  17647. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentAlignment">
  17648. <summary>
  17649. Get whether or not to use the alignment in this XF instead of the parent XF.
  17650. </summary>
  17651. </member>
  17652. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentBorder">
  17653. <summary>
  17654. Get whether or not to use the border in this XF instead of the parent XF.
  17655. </summary>
  17656. </member>
  17657. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentPattern">
  17658. <summary>
  17659. Get whether or not to use the pattern in this XF instead of the parent XF.
  17660. (foregrount/background)
  17661. </summary>
  17662. </member>
  17663. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentCellOptions">
  17664. <summary>
  17665. Get whether or not to use the locking/hidden in this XF instead of the parent XF.
  17666. </summary>
  17667. </member>
  17668. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderOptions">
  17669. <summary>
  17670. Get the border options bitmask (see the corresponding bit Getter methods
  17671. that reference back to this one)
  17672. </summary>
  17673. </member>
  17674. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderLeft">
  17675. <summary>
  17676. Get the borderline style for the left border
  17677. </summary>
  17678. </member>
  17679. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderRight">
  17680. <summary>
  17681. Get the borderline style for the right border
  17682. </summary>
  17683. </member>
  17684. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderTop">
  17685. <summary>
  17686. Get the borderline style for the top border
  17687. </summary>
  17688. </member>
  17689. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderBottom">
  17690. <summary>
  17691. Get the borderline style for the bottom border
  17692. </summary>
  17693. </member>
  17694. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.PaletteOptions">
  17695. <summary>
  17696. Get the palette options bitmask (see the individual bit Getter methods that
  17697. reference this one)
  17698. </summary>
  17699. </member>
  17700. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.LeftBorderPaletteIdx">
  17701. <summary>
  17702. Get the palette index for the left border color
  17703. </summary>
  17704. </member>
  17705. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.RightBorderPaletteIdx">
  17706. <summary>
  17707. Get the palette index for the right border color
  17708. </summary>
  17709. </member>
  17710. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlPaletteOptions">
  17711. <summary>
  17712. Get the Additional palette options bitmask (see individual bit Getter methods
  17713. that reference this method)
  17714. </summary>
  17715. </member>
  17716. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.TopBorderPaletteIdx">
  17717. <summary>
  17718. Get the palette index for the top border
  17719. </summary>
  17720. </member>
  17721. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BottomBorderPaletteIdx">
  17722. <summary>
  17723. Get the palette index for the bottom border
  17724. </summary>
  17725. </member>
  17726. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagBorderPaletteIdx">
  17727. <summary>
  17728. Get for diagonal borders
  17729. </summary>
  17730. </member>
  17731. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagLineStyle">
  17732. <summary>
  17733. Get the diagonal border line style
  17734. </summary>
  17735. </member>
  17736. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Diagonal">
  17737. <summary>
  17738. Not sure what this Is for (maybe Fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
  17739. </summary>
  17740. </member>
  17741. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlFillPattern">
  17742. <summary>
  17743. Get the Additional Fill pattern
  17744. </summary>
  17745. </member>
  17746. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillPaletteOptions">
  17747. <summary>
  17748. Get the Fill palette options bitmask (see indivdual bit Getters that
  17749. reference this method)
  17750. </summary>
  17751. </member>
  17752. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillForeground">
  17753. <summary>
  17754. Get the foreground palette color index
  17755. </summary>
  17756. </member>
  17757. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillBackground">
  17758. <summary>
  17759. Get the background palette color index
  17760. </summary>
  17761. </member>
  17762. <member name="T:NPOI.HSSF.Record.ExternalNameRecord">
  17763. EXTERNALNAME<p/>
  17764. @author Josh Micich
  17765. </member>
  17766. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._ddeValues">
  17767. 'rgoper' / 'Last received results of the DDE link'
  17768. (seems to be only applicable to DDE links)<br/>
  17769. Logically this is a 2-D array, which has been flattened into 1-D array here.
  17770. </member>
  17771. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nColumns">
  17772. (logical) number of columns in the {@link #_ddeValues} array
  17773. </member>
  17774. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nRows">
  17775. (logical) number of rows in the {@link #_ddeValues} array
  17776. </member>
  17777. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsBuiltInName">
  17778. Convenience Function to determine if the name Is a built-in name
  17779. </member>
  17780. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsAutomaticLink">
  17781. For OLE and DDE, links can be either 'automatic' or 'manual'
  17782. </member>
  17783. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsPicureLink">
  17784. only for OLE and DDE
  17785. </member>
  17786. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsStdDocumentNameIdentifier">
  17787. DDE links only. If <c>true</c>, this denotes the 'StdDocumentName'
  17788. </member>
  17789. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.Text">
  17790. @return the standard String representation of this name
  17791. </member>
  17792. <member name="F:NPOI.HSSF.Record.RefSubRecord._extBookIndex">
  17793. index to External Book Block (which starts with a EXTERNALBOOK record)
  17794. </member>
  17795. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(System.Int32,System.Int32,System.Int32)">
  17796. a Constructor for making new sub record
  17797. </member>
  17798. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17799. @param in the RecordInputstream to Read the record from
  17800. </member>
  17801. <member name="M:NPOI.HSSF.Record.RefSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  17802. called by the class that is responsible for writing this sucker.
  17803. Subclasses should implement this so that their data is passed back in a
  17804. byte array.
  17805. @param offset to begin writing at
  17806. @param data byte array containing instance data
  17807. @return number of bytes written
  17808. </member>
  17809. <member name="T:NPOI.HSSF.Record.ExternSheetRecord">
  17810. Title: Extern Sheet
  17811. Description: A List of Inndexes to SupBook
  17812. REFERENCE:
  17813. @author Libin Roman (Vista Portal LDT. Developer)
  17814. @version 1.0-pre
  17815. </member>
  17816. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17817. Constructs a Extern Sheet record and Sets its fields appropriately.
  17818. @param in the RecordInputstream to Read the record from
  17819. </member>
  17820. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddRef(System.Int32,System.Int32,System.Int32)">
  17821. @return index of newly added ref
  17822. </member>
  17823. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddREFRecord(NPOI.HSSF.Record.RefSubRecord)">
  17824. Adds REF struct (ExternSheetSubRecord)
  17825. @param rec REF struct
  17826. </member>
  17827. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.FindRefIndexFromExtBookIndex(System.Int32)">
  17828. @return -1 if not found
  17829. </member>
  17830. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  17831. called by the class that Is responsible for writing this sucker.
  17832. Subclasses should implement this so that their data Is passed back in a
  17833. byte array.
  17834. @param offset to begin writing at
  17835. @param data byte array containing instance data
  17836. @return number of bytes written
  17837. </member>
  17838. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfREFRecords">
  17839. returns the number of REF Records, which is in model
  17840. @return number of REF records
  17841. </member>
  17842. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfRefs">
  17843. @return number of REF structures
  17844. </member>
  17845. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.Sid">
  17846. return the non static version of the id for this record.
  17847. </member>
  17848. <member name="T:NPOI.HSSF.Record.ExternSheetSubRecord">
  17849. Title: A sub Record for Extern Sheet
  17850. Description: Defines a named range within a workbook.
  17851. REFERENCE:
  17852. @author Libin Roman (Vista Portal LDT. Developer)
  17853. @version 1.0-pre
  17854. </member>
  17855. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor">
  17856. a Constractor for making new sub record
  17857. </member>
  17858. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17859. Constructs a Extern Sheet Sub Record record and Sets its fields appropriately.
  17860. @param in the RecordInputstream to Read the record from
  17861. </member>
  17862. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToSupBook(System.Int16)">
  17863. Sets the Index to the sup book
  17864. @param index sup book index
  17865. </member>
  17866. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToSupBook">
  17867. Gets the index to sup book
  17868. @return sup book index
  17869. </member>
  17870. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToFirstSupBook(System.Int16)">
  17871. Sets the index to first sheet in supbook
  17872. @param index index to first sheet
  17873. </member>
  17874. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToFirstSupBook">
  17875. Gets the index to first sheet from supbook
  17876. @return index to first supbook
  17877. </member>
  17878. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToLastSupBook(System.Int16)">
  17879. Sets the index to last sheet in supbook
  17880. @param index index to last sheet
  17881. </member>
  17882. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToLastSupBook">
  17883. Gets the index to last sheet in supbook
  17884. @return index to last supbook
  17885. </member>
  17886. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.Serialize(System.Int32,System.Byte[])">
  17887. called by the class that Is responsible for writing this sucker.
  17888. Subclasses should implement this so that their data Is passed back in a
  17889. byte array.
  17890. @param offset to begin writing at
  17891. @param data byte array containing instance data
  17892. @return number of bytes written
  17893. </member>
  17894. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.RecordSize">
  17895. returns the record size
  17896. </member>
  17897. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.Sid">
  17898. return the non static version of the id for this record.
  17899. </member>
  17900. <member name="T:NPOI.HSSF.Record.InfoSubRecord">
  17901. Extended SST table info subrecord
  17902. Contains the elements of "info" in the SST's array field
  17903. @author Andrew C. Oliver (acoliver at apache dot org)
  17904. @version 2.0-pre
  17905. @see org.apache.poi.hssf.record.ExtSSTRecord
  17906. </member>
  17907. <member name="M:NPOI.HSSF.Record.InfoSubRecord.#ctor(System.Int32,System.Int32)">
  17908. Creates new ExtSSTInfoSubRecord
  17909. </member>
  17910. <member name="T:NPOI.HSSF.Record.ExtSSTRecord">
  17911. Title: Extended Static String Table
  17912. Description: This record Is used for a quick Lookup into the SST record. This
  17913. record breaks the SST table into a Set of buckets. The offsets
  17914. to these buckets within the SST record are kept as well as the
  17915. position relative to the start of the SST record.
  17916. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17917. @author Andrew C. Oliver (acoliver at apache dot org)
  17918. @author Jason Height (jheight at apache dot org)
  17919. @version 2.0-pre
  17920. @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord
  17921. </member>
  17922. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17923. Constructs a EOFRecord record and Sets its fields appropriately.
  17924. @param in the RecordInputstream to Read the record from
  17925. </member>
  17926. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.GetRecordSizeForStrings(System.Int32)">
  17927. Given a number of strings (in the sst), returns the size of the extsst record
  17928. </member>
  17929. <member name="P:NPOI.HSSF.Record.ExtSSTRecord.DataSize">
  17930. Returns the size of this record
  17931. </member>
  17932. <member name="T:NPOI.HSSF.Record.FilePassRecord">
  17933. Title: File Pass Record
  17934. Description: Indicates that the record after this record are encrypted. HSSF does not support encrypted excel workbooks
  17935. and the presence of this record will cause Processing to be aborted.
  17936. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17937. @author Jason Height (jheight at chariot dot net dot au)
  17938. @version 3.0-pre
  17939. </member>
  17940. <member name="T:NPOI.HSSF.Record.FileSharingRecord">
  17941. Title: FILESHARING
  17942. Description: stores the encrypted Readonly for a workbook (Write protect)
  17943. This functionality Is accessed from the options dialog box available when performing 'Save As'.<p/>
  17944. REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  17945. @author Andrew C. Oliver (acoliver at apache dot org)
  17946. </member>
  17947. <member name="M:NPOI.HSSF.Record.FileSharingRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17948. Constructs a FileSharing record and Sets its fields appropriately.
  17949. @param in the RecordInputstream to Read the record from
  17950. </member>
  17951. <member name="M:NPOI.HSSF.Record.FileSharingRecord.Clone">
  17952. Clone this record.
  17953. </member>
  17954. <member name="P:NPOI.HSSF.Record.FileSharingRecord.ReadOnly">
  17955. Get the Readonly
  17956. @return short representing if this Is Read only (1 = true)
  17957. </member>
  17958. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Password">
  17959. @returns password hashed with hashPassword() (very lame)
  17960. </member>
  17961. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Username">
  17962. @returns username of the user that Created the file
  17963. </member>
  17964. <member name="T:NPOI.HSSF.Record.FnGroupCountRecord">
  17965. Title: Function Group Count Record
  17966. Description: Number of built in function Groups in the current version of the
  17967. SpReadsheet (probably only used on Windoze)
  17968. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17969. @author Andrew C. Oliver (acoliver at apache dot org)
  17970. @version 2.0-pre
  17971. </member>
  17972. <member name="F:NPOI.HSSF.Record.FnGroupCountRecord.COUNT">
  17973. suggested default (14 dec)
  17974. </member>
  17975. <member name="M:NPOI.HSSF.Record.FnGroupCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17976. Constructs a FnGroupCount record and Sets its fields appropriately.
  17977. @param in the RecordInputstream to Read the record from
  17978. </member>
  17979. <member name="P:NPOI.HSSF.Record.FnGroupCountRecord.Count">
  17980. Get the number of built-in functions
  17981. @return number of built-in functions
  17982. </member>
  17983. <member name="T:NPOI.HSSF.Record.FontRecord">
  17984. Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
  17985. Description: An element in the Font Table
  17986. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  17987. @author Andrew C. Oliver (acoliver at apache dot org)
  17988. @version 2.0-pre
  17989. </member>
  17990. <member name="M:NPOI.HSSF.Record.FontRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  17991. Constructs a Font record and Sets its fields appropriately.
  17992. @param in the RecordInputstream to Read the record from
  17993. </member>
  17994. <member name="M:NPOI.HSSF.Record.FontRecord.CloneStyleFrom(NPOI.HSSF.Record.FontRecord)">
  17995. Clones all the font style information from another
  17996. FontRecord, onto this one. This
  17997. will then hold all the same font style options.
  17998. </member>
  17999. <member name="M:NPOI.HSSF.Record.FontRecord.SameProperties(NPOI.HSSF.Record.FontRecord)">
  18000. Does this FontRecord have all the same font
  18001. properties as the supplied FontRecord?
  18002. Note that {@link #equals(Object)} will check
  18003. for exact objects, while this will check
  18004. for exact contents, because normally the
  18005. font record's position makes a big
  18006. difference too.
  18007. </member>
  18008. <member name="M:NPOI.HSSF.Record.FontRecord.Equals(System.Object)">
  18009. Only returns two for the same exact object -
  18010. creating a second FontRecord with the same
  18011. properties won't be considered equal, as
  18012. the record's position in the record stream
  18013. matters.
  18014. </member>
  18015. <member name="P:NPOI.HSSF.Record.FontRecord.IsItalic">
  18016. Set the font to be italics or not
  18017. @param italics - whether the font Is italics or not
  18018. @see #SetAttributes(short)
  18019. </member>
  18020. <member name="P:NPOI.HSSF.Record.FontRecord.IsStrikeout">
  18021. Set the font to be stricken out or not
  18022. @param strike - whether the font Is stricken out or not
  18023. @see #SetAttributes(short)
  18024. </member>
  18025. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacoutlined">
  18026. whether to use the mac outline font style thing (mac only) - Some mac person
  18027. should comment this instead of me doing it (since I have no idea)
  18028. @param mac - whether to do that mac font outline thing or not
  18029. @see #SetAttributes(short)
  18030. </member>
  18031. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacshadowed">
  18032. whether to use the mac shado font style thing (mac only) - Some mac person
  18033. should comment this instead of me doing it (since I have no idea)
  18034. @param mac - whether to do that mac font shadow thing or not
  18035. @see #SetAttributes(short)
  18036. </member>
  18037. <member name="P:NPOI.HSSF.Record.FontRecord.Underline">
  18038. Set the type of Underlining for the font
  18039. </member>
  18040. <member name="P:NPOI.HSSF.Record.FontRecord.Family">
  18041. Set the font family (TODO)
  18042. @param f family
  18043. </member>
  18044. <member name="P:NPOI.HSSF.Record.FontRecord.Charset">
  18045. Set the Char Set
  18046. @param charSet - CharSet
  18047. </member>
  18048. <member name="P:NPOI.HSSF.Record.FontRecord.FontName">
  18049. Set the name of the font
  18050. @param fn - name of the font (i.e. "Arial")
  18051. </member>
  18052. <member name="P:NPOI.HSSF.Record.FontRecord.FontHeight">
  18053. Gets the height of the font in 1/20th point Units
  18054. @return fontheight (in points/20)
  18055. </member>
  18056. <member name="P:NPOI.HSSF.Record.FontRecord.Attributes">
  18057. Get the font attributes (see individual bit Getters that reference this method)
  18058. @return attribute - the bitmask
  18059. </member>
  18060. <member name="P:NPOI.HSSF.Record.FontRecord.ColorPaletteIndex">
  18061. Get the font's color palette index
  18062. @return cpi - font color index
  18063. </member>
  18064. <member name="P:NPOI.HSSF.Record.FontRecord.BoldWeight">
  18065. Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  18066. 0x190 for normal and 0x2bc for bold
  18067. @return bw - a number between 100-1000 for the fonts "boldness"
  18068. </member>
  18069. <member name="P:NPOI.HSSF.Record.FontRecord.SuperSubScript">
  18070. Get the type of base or subscript for the font
  18071. @return base or subscript option
  18072. </member>
  18073. <member name="T:NPOI.HSSF.Record.FooterRecord">
  18074. Title: Footer Record
  18075. Description: Specifies the footer for a sheet
  18076. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18077. @author Andrew C. Oliver (acoliver at apache dot org)
  18078. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  18079. @author Jason Height (jheight at chariot dot net dot au)
  18080. @version 2.0-pre
  18081. </member>
  18082. <member name="T:NPOI.HSSF.Record.HeaderFooterBase">
  18083. Common header/footer base class
  18084. @author Josh Micich
  18085. </member>
  18086. <member name="P:NPOI.HSSF.Record.HeaderFooterBase.TextLength">
  18087. get the length of the footer string
  18088. @return length of the footer string
  18089. </member>
  18090. <member name="M:NPOI.HSSF.Record.FooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18091. <summary>
  18092. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.FooterRecord"/> class.
  18093. </summary>
  18094. <param name="in1">the RecordInputstream to Read the record from</param>
  18095. </member>
  18096. <member name="M:NPOI.HSSF.Record.FooterRecord.ToString">
  18097. <summary>
  18098. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18099. </summary>
  18100. <returns>
  18101. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18102. </returns>
  18103. </member>
  18104. <member name="P:NPOI.HSSF.Record.FooterRecord.Sid">
  18105. <summary>
  18106. </summary>
  18107. <value></value>
  18108. return the non static version of the id for this record.
  18109. </member>
  18110. <member name="T:NPOI.HSSF.Record.FormatRecord">
  18111. Title: Format Record
  18112. Description: describes a number format -- those goofy strings like $(#,###)
  18113. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18114. @author Andrew C. Oliver (acoliver at apache dot org)
  18115. @author Shawn M. Laubach (slaubach at apache dot org)
  18116. @version 2.0-pre
  18117. </member>
  18118. <member name="M:NPOI.HSSF.Record.FormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18119. Constructs a Format record and Sets its fields appropriately.
  18120. @param in the RecordInputstream to Read the record from
  18121. </member>
  18122. <member name="P:NPOI.HSSF.Record.FormatRecord.IndexCode">
  18123. Get the format index code (for built in formats)
  18124. @return the format index code
  18125. @see org.apache.poi.hssf.model.Workbook
  18126. </member>
  18127. <member name="P:NPOI.HSSF.Record.FormatRecord.FormatString">
  18128. Get the format string
  18129. @return the format string
  18130. </member>
  18131. <member name="T:NPOI.HSSF.Record.SpecialCachedValue">
  18132. Manages the cached formula result values of other types besides numeric.
  18133. Excel encodes the same 8 bytes that would be field_4_value with various NaN
  18134. values that are decoded/encoded by this class.
  18135. </member>
  18136. <member name="F:NPOI.HSSF.Record.SpecialCachedValue.BIT_MARKER">
  18137. deliberately chosen by Excel in order to encode other values within Double NaNs
  18138. </member>
  18139. <member name="M:NPOI.HSSF.Record.SpecialCachedValue.Create(System.Int64)">
  18140. @return <c>null</c> if the double value encoded by <c>valueLongBits</c>
  18141. is a normal (non NaN) double value.
  18142. </member>
  18143. <member name="T:NPOI.HSSF.Record.FormulaRecord">
  18144. Formula Record.
  18145. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18146. @author Andrew C. Oliver (acoliver at apache dot org)
  18147. @author Jason Height (jheight at chariot dot net dot au)
  18148. @version 2.0-pre
  18149. </member>
  18150. <member name="F:NPOI.HSSF.Record.FormulaRecord.specialCachedValue">
  18151. Since the NaN support seems sketchy (different constants) we'll store and spit it out directly
  18152. </member>
  18153. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor">
  18154. Creates new FormulaRecord
  18155. </member>
  18156. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18157. Constructs a Formula record and Sets its fields appropriately.
  18158. Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an
  18159. "explanation of this bug in the documentation) or an exception
  18160. will be throw upon validation
  18161. @param in the RecordInputstream to Read the record from
  18162. </member>
  18163. <member name="P:NPOI.HSSF.Record.FormulaRecord.HasCachedResultString">
  18164. @return <c>true</c> if this {@link FormulaRecord} is followed by a
  18165. {@link StringRecord} representing the cached text result of the formula
  18166. evaluation.
  18167. </member>
  18168. <member name="P:NPOI.HSSF.Record.FormulaRecord.Value">
  18169. Get the calculated value of the formula
  18170. @return calculated value
  18171. </member>
  18172. <member name="P:NPOI.HSSF.Record.FormulaRecord.Options">
  18173. Get the option flags
  18174. @return bitmask
  18175. </member>
  18176. <member name="P:NPOI.HSSF.Record.FormulaRecord.ParsedExpression">
  18177. Get the stack as a list
  18178. @return list of tokens (casts stack to a list and returns it!)
  18179. this method can return null Is we are Unable to Create Ptgs from
  18180. existing excel file
  18181. callers should Check for null!
  18182. </member>
  18183. <member name="T:NPOI.HSSF.Record.GridsetRecord">
  18184. Title: GridSet Record.
  18185. Description: flag denoting whether the user specified that gridlines are used when
  18186. printing.
  18187. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18188. @author Andrew C. Oliver (acoliver at apache dot org)
  18189. @author Glen Stampoultzis (glens at apache.org)
  18190. @author Jason Height (jheight at chariot dot net dot au)
  18191. @version 2.0-pre
  18192. </member>
  18193. <member name="M:NPOI.HSSF.Record.GridsetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18194. Constructs a GridSet record and Sets its fields appropriately.
  18195. @param in the RecordInputstream to Read the record from
  18196. </member>
  18197. <member name="P:NPOI.HSSF.Record.GridsetRecord.Gridset">
  18198. Get whether the gridlines are shown during printing.
  18199. @return gridSet - true if gridlines are NOT printed, false if they are.
  18200. </member>
  18201. <member name="T:NPOI.HSSF.Record.GutsRecord">
  18202. Title: Guts Record
  18203. Description: Row/column gutter sizes
  18204. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18205. @author Andrew C. Oliver (acoliver at apache dot org)
  18206. @author Jason Height (jheight at chariot dot net dot au)
  18207. @version 2.0-pre
  18208. </member>
  18209. <member name="M:NPOI.HSSF.Record.GutsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18210. Constructs a Guts record and Sets its fields appropriately.
  18211. @param in the RecordInputstream to Read the record from
  18212. </member>
  18213. <member name="P:NPOI.HSSF.Record.GutsRecord.LeftRowGutter">
  18214. Get the size of the gutter that appears at the left of the rows
  18215. @return gutter size in screen Units
  18216. </member>
  18217. <member name="P:NPOI.HSSF.Record.GutsRecord.TopColGutter">
  18218. Get the size of the gutter that appears at the above the columns
  18219. @return gutter size in screen Units
  18220. </member>
  18221. <member name="P:NPOI.HSSF.Record.GutsRecord.RowLevelMax">
  18222. Get the maximum outline level for the row gutter.
  18223. @return maximum outline level
  18224. </member>
  18225. <member name="P:NPOI.HSSF.Record.GutsRecord.ColLevelMax">
  18226. Get the maximum outline level for the col gutter.
  18227. @return maximum outline level
  18228. </member>
  18229. <member name="T:NPOI.HSSF.Record.HCenterRecord">
  18230. Title: HCenter record
  18231. Description: whether to center between horizontal margins
  18232. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18233. @author Andrew C. Oliver (acoliver at apache dot org)
  18234. @author Jason Height (jheight at chariot dot net dot au)
  18235. @version 2.0-pre
  18236. </member>
  18237. <member name="M:NPOI.HSSF.Record.HCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18238. Constructs an HCenter record and Sets its fields appropriately.
  18239. @param in the RecordInputstream to Read the record from
  18240. </member>
  18241. <member name="P:NPOI.HSSF.Record.HCenterRecord.HCenter">
  18242. Get whether or not to horizonatally center this sheet.
  18243. @return center - t/f
  18244. </member>
  18245. <member name="T:NPOI.HSSF.Record.HeaderFooterRecord">
  18246. The HEADERFOOTER record stores information Added in Office Excel 2007 for headers/footers.
  18247. @author Yegor Kozlov
  18248. </member>
  18249. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18250. construct a HeaderFooterRecord record. No fields are interpreted and the record will
  18251. be Serialized in its original form more or less
  18252. @param in the RecordInputstream to read the record from
  18253. </member>
  18254. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  18255. spit the record out AS IS. no interpretation or identification
  18256. </member>
  18257. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.Guid">
  18258. If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
  18259. If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field
  18260. of the preceding {@link UserSViewBegin} record.
  18261. @return the sheet view's GUID
  18262. </member>
  18263. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.IsCurrentSheet">
  18264. @return whether this record belongs to the current sheet
  18265. </member>
  18266. <member name="T:NPOI.HSSF.Record.HeaderRecord">
  18267. Title: Header Record
  18268. Description: Specifies a header for a sheet
  18269. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18270. @author Andrew C. Oliver (acoliver at apache dot org)
  18271. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  18272. @author Jason Height (jheight at chariot dot net dot au)
  18273. @version 2.0-pre
  18274. </member>
  18275. <member name="M:NPOI.HSSF.Record.HeaderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18276. Constructs an Header record and Sets its fields appropriately.
  18277. @param in the RecordInputstream to Read the record from
  18278. </member>
  18279. <member name="T:NPOI.HSSF.Record.HideObjRecord">
  18280. Title: Hide Object Record
  18281. Description: flag defines whether to hide placeholders and object
  18282. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18283. @author Andrew C. Oliver (acoliver at apache dot org)
  18284. @version 2.0-pre
  18285. </member>
  18286. <member name="M:NPOI.HSSF.Record.HideObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18287. Constructs an HideObj record and Sets its fields appropriately.
  18288. @param in the RecordInputstream to Read the record from
  18289. </member>
  18290. <member name="M:NPOI.HSSF.Record.HideObjRecord.SetHideObj(System.Int16)">
  18291. Set hide object options
  18292. @param hide options
  18293. @see #HIDE_ALL
  18294. @see #SHOW_PLACEHOLDERS
  18295. @see #SHOW_ALL
  18296. </member>
  18297. <member name="M:NPOI.HSSF.Record.HideObjRecord.GetHideObj">
  18298. Get hide object options
  18299. @return hide options
  18300. @see #HIDE_ALL
  18301. @see #SHOW_PLACEHOLDERS
  18302. @see #SHOW_ALL
  18303. </member>
  18304. <member name="T:NPOI.HSSF.Record.HorizontalPageBreakRecord">
  18305. HorizontalPageBreak record that stores page breaks at rows
  18306. This class Is just used so that SID Compares work properly in the RecordFactory
  18307. @see PageBreakRecord
  18308. @author Danny Mui (dmui at apache dot org)
  18309. </member>
  18310. <member name="T:NPOI.HSSF.Record.PageBreakRecord">
  18311. Record that Contains the functionality page _breaks (horizontal and vertical)
  18312. The other two classes just specifically Set the SIDS for record creation.
  18313. REFERENCE: Microsoft Excel SDK page 322 and 420
  18314. @see HorizontalPageBreakRecord
  18315. @see VerticalPageBreakRecord
  18316. @author Danny Mui (dmui at apache dot org)
  18317. </member>
  18318. <member name="M:NPOI.HSSF.Record.PageBreakRecord.AddBreak(System.Int32,System.Int32,System.Int32)">
  18319. Adds the page break at the specified parameters
  18320. @param main Depending on sid, will determine row or column to put page break (zero-based)
  18321. @param subFrom No user-interface to Set (defaults to minumum, 0)
  18322. @param subTo No user-interface to Set
  18323. </member>
  18324. <member name="M:NPOI.HSSF.Record.PageBreakRecord.RemoveBreak(System.Int32)">
  18325. Removes the break indicated by the parameter
  18326. @param main (zero-based)
  18327. </member>
  18328. <member name="M:NPOI.HSSF.Record.PageBreakRecord.GetBreak(System.Int32)">
  18329. Retrieves the region at the row/column indicated
  18330. @param main FIXME: Document this!
  18331. @return The Break or null if no break exists at the row/col specified.
  18332. </member>
  18333. <member name="T:NPOI.HSSF.Record.PageBreakRecord.Break">
  18334. Since both records store 2byte integers (short), no point in
  18335. differentiating it in the records.
  18336. The subs (rows or columns, don't seem to be able to Set but excel Sets
  18337. them automatically)
  18338. </member>
  18339. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor">
  18340. </member>
  18341. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18342. @param in the RecordInputstream to Read the record from
  18343. </member>
  18344. <member name="T:NPOI.HSSF.Record.HyperlinkRecord">
  18345. The <c>HyperlinkRecord</c> wraps an HLINK-record
  18346. from the Excel-97 format.
  18347. Supports only external links for now (eg http://)
  18348. @author Mark Hissink Muller <a href="mailto:mark@hissinkmuller.nl">mark@hissinkmuller.nl</a>
  18349. @author Yegor Kozlov (yegor at apache dot org)
  18350. </member>
  18351. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.HLINK_URL">
  18352. Link flags
  18353. </member>
  18354. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.URL_uninterpretedTail">
  18355. Tail of a URL link
  18356. </member>
  18357. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.FILE_uninterpretedTail">
  18358. Tail of a file link
  18359. </member>
  18360. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._range">
  18361. cell range of this hyperlink
  18362. </member>
  18363. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._guid">
  18364. 16-byte GUID
  18365. </member>
  18366. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._fileOpts">
  18367. Some sort of options for file links.
  18368. </member>
  18369. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._linkOpts">
  18370. Link options. Can include any of HLINK_* flags.
  18371. </member>
  18372. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._label">
  18373. Test label
  18374. </member>
  18375. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._moniker">
  18376. Moniker. Makes sense only for URL and file links
  18377. </member>
  18378. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._shortFilename">
  18379. in 8:3 DOS format No Unicode string header,
  18380. always 8-bit characters, zero-terminated
  18381. </member>
  18382. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._address">
  18383. Link
  18384. </member>
  18385. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._textMark">
  18386. Text describing a place in document. In Excel UI, this is appended to the
  18387. address, (after a '#' delimiter).<br/>
  18388. This field is optional. If present, the {@link #HLINK_PLACE} must be set.
  18389. </member>
  18390. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._uninterpretedTail">
  18391. Remaining bytes
  18392. </member>
  18393. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor">
  18394. Create a new hyperlink
  18395. </member>
  18396. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18397. Read hyperlink from input stream
  18398. @param in the stream to Read from
  18399. </member>
  18400. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateUrlLink">
  18401. <summary>
  18402. Initialize a new url link
  18403. </summary>
  18404. </member>
  18405. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateFileLink">
  18406. <summary>
  18407. Initialize a new file link
  18408. </summary>
  18409. </member>
  18410. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateDocumentLink">
  18411. <summary>
  18412. Initialize a new document link
  18413. </summary>
  18414. </member>
  18415. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstColumn">
  18416. Return the column of the first cell that Contains the hyperlink
  18417. @return the 0-based column of the first cell that Contains the hyperlink
  18418. </member>
  18419. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastColumn">
  18420. Set the column of the last cell that Contains the hyperlink
  18421. @return the 0-based column of the last cell that Contains the hyperlink
  18422. </member>
  18423. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstRow">
  18424. Return the row of the first cell that Contains the hyperlink
  18425. @return the 0-based row of the first cell that Contains the hyperlink
  18426. </member>
  18427. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastRow">
  18428. Return the row of the last cell that Contains the hyperlink
  18429. @return the 0-based row of the last cell that Contains the hyperlink
  18430. </member>
  18431. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Guid">
  18432. Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER}
  18433. @return 16-byte guid identifier
  18434. </member>
  18435. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Moniker">
  18436. Returns a 16-byte moniker.
  18437. @return 16-byte moniker
  18438. </member>
  18439. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Label">
  18440. Return text label for this hyperlink
  18441. @return text to Display
  18442. </member>
  18443. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Address">
  18444. Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  18445. @return the Address of this hyperlink
  18446. </member>
  18447. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LinkOptions">
  18448. Link options. Must be a combination of HLINK_* constants.
  18449. </member>
  18450. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LabelOptions">
  18451. Label options
  18452. </member>
  18453. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FileOptions">
  18454. Options for a file link
  18455. </member>
  18456. <member name="T:NPOI.HSSF.Record.IndexRecord">
  18457. Title: Index Record
  18458. Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet
  18459. Important for locating cells
  18460. NOT USED IN THIS RELEASE
  18461. REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18462. @author Andrew C. Oliver (acoliver at apache dot org)
  18463. @author Jason Height (jheight at chariot dot net dot au)
  18464. @version 2.0-pre
  18465. </member>
  18466. <member name="M:NPOI.HSSF.Record.IndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18467. Constructs an Index record and Sets its fields appropriately.
  18468. @param in the RecordInputstream to Read the record from
  18469. </member>
  18470. <member name="M:NPOI.HSSF.Record.IndexRecord.GetRecordSizeForBlockCount(System.Int32)">
  18471. Returns the size of an INdexRecord when it needs to index the specified number of blocks
  18472. </member>
  18473. <member name="T:NPOI.HSSF.Record.InterfaceEndRecord">
  18474. Title: Interface End Record
  18475. Description: Shows where the Interface Records end (MMS)
  18476. (has no fields)
  18477. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18478. @author Andrew C. Oliver (acoliver at apache dot org)
  18479. @version 2.0-pre
  18480. </member>
  18481. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.Create(NPOI.HSSF.Record.RecordInputStream)">
  18482. Constructs an InterfaceEnd record and Sets its fields appropriately.
  18483. @param in the RecordInputstream to Read the record from
  18484. </member>
  18485. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.GetDataSize">
  18486. <summary>
  18487. for test TestInterfaceEndRecord.TestCreate()
  18488. </summary>
  18489. <returns></returns>
  18490. </member>
  18491. <member name="T:NPOI.HSSF.Record.InterfaceHdrRecord">
  18492. Title: Interface Header Record
  18493. Description: Defines the beginning of Interface records (MMS)
  18494. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18495. @author Andrew C. Oliver (acoliver at apache dot org)
  18496. @version 2.0-pre
  18497. </member>
  18498. <member name="F:NPOI.HSSF.Record.InterfaceHdrRecord.CODEPAGE">
  18499. suggested (and probably correct) default
  18500. </member>
  18501. <member name="M:NPOI.HSSF.Record.InterfaceHdrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18502. Constructs an Codepage record and Sets its fields appropriately.
  18503. @param in the RecordInputstream to Read the record from
  18504. </member>
  18505. <member name="T:NPOI.HSSF.Record.IterationRecord">
  18506. Title: Iteration Record
  18507. Description: Tells whether to iterate over forumla calculations or not
  18508. (if a formula Is dependant upon another formula's result)
  18509. (odd feature for something that can only have 32 elements in
  18510. a formula!)
  18511. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18512. @author Andrew C. Oliver (acoliver at apache dot org)
  18513. @author Jason Height (jheight at chariot dot net dot au)
  18514. @version 2.0-pre
  18515. </member>
  18516. <member name="M:NPOI.HSSF.Record.IterationRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18517. Constructs an Iteration record and Sets its fields appropriately.
  18518. @param in the RecordInputstream to Read the record from
  18519. </member>
  18520. <member name="P:NPOI.HSSF.Record.IterationRecord.Iteration">
  18521. Get whether or not to iterate for calculations
  18522. @return whether iterative calculations are turned off or on
  18523. </member>
  18524. <member name="T:NPOI.HSSF.Record.LabelRecord">
  18525. Label Record - Read only support for strings stored directly in the cell.. Don't
  18526. use this (except to Read), use LabelSST instead
  18527. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18528. @author Andrew C. Oliver (acoliver at apache dot org)
  18529. @author Jason Height (jheight at chariot dot net dot au)
  18530. @version 2.0-pre
  18531. @see org.apache.poi.hssf.record.LabelSSTRecord
  18532. </member>
  18533. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor">
  18534. Creates new LabelRecord
  18535. </member>
  18536. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18537. Constructs an Label record and Sets its fields appropriately.
  18538. @param in the RecordInputstream to Read the record from
  18539. </member>
  18540. <member name="M:NPOI.HSSF.Record.LabelRecord.Serialize(System.Int32,System.Byte[])">
  18541. THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
  18542. </member>
  18543. <member name="P:NPOI.HSSF.Record.LabelRecord.StringLength">
  18544. Get the number of Chars this string Contains
  18545. @return number of Chars
  18546. </member>
  18547. <member name="P:NPOI.HSSF.Record.LabelRecord.IsUncompressedUnicode">
  18548. Is this Uncompressed Unicode (16bit)? Or just 8-bit compressed?
  18549. @return IsUnicode - True for 16bit- false for 8bit
  18550. </member>
  18551. <member name="P:NPOI.HSSF.Record.LabelRecord.Value">
  18552. Get the value
  18553. @return the text string
  18554. @see #GetStringLength
  18555. </member>
  18556. <member name="T:NPOI.HSSF.Record.LabelSSTRecord">
  18557. Title: Label SST Record
  18558. Description: Refers to a string in the shared string table and Is a column
  18559. value.
  18560. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18561. @author Andrew C. Oliver (acoliver at apache dot org)
  18562. @author Jason Height (jheight at chariot dot net dot au)
  18563. @version 2.0-pre
  18564. </member>
  18565. <member name="M:NPOI.HSSF.Record.LabelSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18566. Constructs an LabelSST record and Sets its fields appropriately.
  18567. @param in the RecordInputstream to Read the record from
  18568. </member>
  18569. <member name="P:NPOI.HSSF.Record.LabelSSTRecord.SSTIndex">
  18570. Get the index to the string in the SSTRecord
  18571. @return index of string in the SST Table
  18572. @see org.apache.poi.hssf.record.SSTRecord
  18573. </member>
  18574. <member name="T:NPOI.HSSF.Record.LeftMarginRecord">
  18575. Record for the left margin.
  18576. NOTE: This source was automatically generated.
  18577. @author Shawn Laubach (slaubach at apache dot org)
  18578. </member>
  18579. <member name="M:NPOI.HSSF.Record.LeftMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18580. Constructs a LeftMargin record and Sets its fields appropriately.
  18581. @param in the RecordInputstream to Read the record from
  18582. </member>
  18583. <member name="P:NPOI.HSSF.Record.LeftMarginRecord.Margin">
  18584. Get the margin field for the LeftMargin record.
  18585. </member>
  18586. <member name="T:NPOI.HSSF.Record.LinkedDataFormulaField">
  18587. Not implemented yet. May commit it anyway just so people can see
  18588. where I'm heading.
  18589. @author Glen Stampoultzis (glens at apache.org)
  18590. </member>
  18591. <member name="T:NPOI.HSSF.Record.MergeCellsRecord">
  18592. Title: Merged Cells Record
  18593. Description: Optional record defining a square area of cells to "merged" into
  18594. one cell.
  18595. REFERENCE: NONE (UNDOCUMENTED PRESENTLY)
  18596. @author Andrew C. Oliver (acoliver at apache dot org)
  18597. @version 2.0-pre
  18598. </member>
  18599. <member name="F:NPOI.HSSF.Record.MergeCellsRecord._regions">
  18600. sometimes the regions array is shared with other MergedCellsRecords
  18601. </member>
  18602. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18603. Constructs a MergedCellsRecord and Sets its fields appropriately
  18604. @param in the RecordInputstream to Read the record from
  18605. </member>
  18606. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.GetAreaAt(System.Int32)">
  18607. @return MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
  18608. </member>
  18609. <member name="P:NPOI.HSSF.Record.MergeCellsRecord.NumAreas">
  18610. Get the number of merged areas. If this drops down to 0 you should just go
  18611. ahead and delete the record.
  18612. @return number of areas
  18613. </member>
  18614. <member name="T:NPOI.HSSF.Record.MMSRecord">
  18615. Title: MMS Record
  18616. Description: defines how many Add menu and del menu options are stored
  18617. in the file. Should always be Set to 0 for HSSF workbooks
  18618. REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18619. @author Andrew C. Oliver (acoliver at apache dot org)
  18620. @version 2.0-pre
  18621. </member>
  18622. <member name="M:NPOI.HSSF.Record.MMSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18623. Constructs a MMS record and Sets its fields appropriately.
  18624. @param in the RecordInputstream to Read the record from
  18625. </member>
  18626. <member name="P:NPOI.HSSF.Record.MMSRecord.AddMenuCount">
  18627. Set number of Add menu options (Set to 0)
  18628. @param am number of Add menu options
  18629. </member>
  18630. <member name="P:NPOI.HSSF.Record.MMSRecord.DelMenuCount">
  18631. Set number of del menu options (Set to 0)
  18632. @param dm number of del menu options
  18633. </member>
  18634. <member name="T:NPOI.HSSF.Record.MulBlankRecord">
  18635. Title: Mulitple Blank cell record
  18636. Description: Represents a Set of columns in a row with no value but with styling.
  18637. In this release we have Read-only support for this record type.
  18638. The RecordFactory Converts this to a Set of BlankRecord objects.
  18639. REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18640. @author Andrew C. Oliver (acoliver at apache dot org)
  18641. @author Glen Stampoultzis (glens at apache.org)
  18642. @version 2.0-pre
  18643. @see org.apache.poi.hssf.record.BlankRecord
  18644. </member>
  18645. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor">
  18646. Creates new MulBlankRecord
  18647. </member>
  18648. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18649. Constructs a MulBlank record and Sets its fields appropriately.
  18650. @param in the RecordInputstream to Read the record from
  18651. </member>
  18652. <member name="M:NPOI.HSSF.Record.MulBlankRecord.GetXFAt(System.Int32)">
  18653. returns the xf index for column (coffset = column - field_2_first_col)
  18654. @param coffset the column (coffset = column - field_2_first_col)
  18655. @return the XF index for the column
  18656. </member>
  18657. <member name="P:NPOI.HSSF.Record.MulBlankRecord.Row">
  18658. Get the row number of the cells this represents
  18659. @return row number
  18660. </member>
  18661. <member name="P:NPOI.HSSF.Record.MulBlankRecord.FirstColumn">
  18662. starting column (first cell this holds in the row)
  18663. @return first column number
  18664. </member>
  18665. <member name="P:NPOI.HSSF.Record.MulBlankRecord.LastColumn">
  18666. ending column (last cell this holds in the row)
  18667. @return first column number
  18668. </member>
  18669. <member name="P:NPOI.HSSF.Record.MulBlankRecord.NumColumns">
  18670. Get the number of columns this Contains (last-first +1)
  18671. @return number of columns (last - first +1)
  18672. </member>
  18673. <member name="T:NPOI.HSSF.Record.MulRKRecord">
  18674. Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
  18675. HSSF just Converts this into multiple NUMBER records. Read-ONLY SUPPORT!
  18676. REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18677. @author Andrew C. Oliver (acoliver at apache dot org)
  18678. @version 2.0-pre
  18679. </member>
  18680. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor">
  18681. Creates new MulRKRecord
  18682. </member>
  18683. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18684. Constructs a MulRK record and Sets its fields appropriately.
  18685. @param in the RecordInputstream to Read the record from
  18686. </member>
  18687. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetXFAt(System.Int32)">
  18688. returns the xf index for column (coffset = column - field_2_first_col)
  18689. @return the XF index for the column
  18690. </member>
  18691. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetRKNumberAt(System.Int32)">
  18692. returns the rk number for column (coffset = column - field_2_first_col)
  18693. @return the value (decoded into a double)
  18694. </member>
  18695. <member name="P:NPOI.HSSF.Record.MulRKRecord.FirstColumn">
  18696. starting column (first cell this holds in the row)
  18697. @return first column number
  18698. </member>
  18699. <member name="P:NPOI.HSSF.Record.MulRKRecord.LastColumn">
  18700. ending column (last cell this holds in the row)
  18701. @return first column number
  18702. </member>
  18703. <member name="P:NPOI.HSSF.Record.MulRKRecord.NumColumns">
  18704. Get the number of columns this Contains (last-first +1)
  18705. @return number of columns (last - first +1)
  18706. </member>
  18707. <member name="T:NPOI.HSSF.Record.NameCommentRecord">
  18708. Title: NAMECMT Record (0x0894)
  18709. Description: Defines a comment associated with a specified name.
  18710. REFERENCE:
  18711. @author Andrew Shirley (aks at corefiling.co.uk)
  18712. </member>
  18713. <member name="M:NPOI.HSSF.Record.NameCommentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18714. @param ris the RecordInputstream to read the record from
  18715. </member>
  18716. <member name="P:NPOI.HSSF.Record.NameCommentRecord.Sid">
  18717. return the non static version of the id for this record.
  18718. </member>
  18719. <member name="P:NPOI.HSSF.Record.NameCommentRecord.NameText">
  18720. @return the name of the NameRecord to which this comment applies.
  18721. </member>
  18722. <member name="P:NPOI.HSSF.Record.NameCommentRecord.CommentText">
  18723. @return the text of the comment.
  18724. </member>
  18725. <member name="T:NPOI.HSSF.Record.NameRecord">
  18726. Title: Name Record (aka Named Range)
  18727. Description: Defines a named range within a workbook.
  18728. REFERENCE:
  18729. @author Libin Roman (Vista Portal LDT. Developer)
  18730. @author Sergei Kozello (sergeikozello at mail.ru)
  18731. @author Glen Stampoultzis (glens at apache.org)
  18732. @version 1.0-pre
  18733. </member>
  18734. <member name="F:NPOI.HSSF.Record.NameRecord.sid">
  18735. </member>
  18736. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CONSOLIDATE_AREA">
  18737. Included for completeness sake, not implemented
  18738. </member>
  18739. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_OPEN">
  18740. Included for completeness sake, not implemented
  18741. </member>
  18742. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_CLOSE">
  18743. Included for completeness sake, not implemented
  18744. </member>
  18745. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATABASE">
  18746. Included for completeness sake, not implemented
  18747. </member>
  18748. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CRITERIA">
  18749. Included for completeness sake, not implemented
  18750. </member>
  18751. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_RECORDER">
  18752. Included for completeness sake, not implemented
  18753. </member>
  18754. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATA_FORM">
  18755. Included for completeness sake, not implemented
  18756. </member>
  18757. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_ACTIVATE">
  18758. Included for completeness sake, not implemented
  18759. </member>
  18760. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_DEACTIVATE">
  18761. Included for completeness sake, not implemented
  18762. </member>
  18763. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_SHEET_TITLE">
  18764. Included for completeness sake, not implemented
  18765. </member>
  18766. <member name="F:NPOI.HSSF.Record.NameRecord.field_5_externSheetIndex_plus1">
  18767. One-based extern index of sheet (resolved via LinkTable). Zero if this is a global name
  18768. </member>
  18769. <member name="F:NPOI.HSSF.Record.NameRecord.field_6_sheetNumber">
  18770. the one based sheet number.
  18771. </member>
  18772. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor">
  18773. Creates new NameRecord
  18774. </member>
  18775. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18776. Constructs a Name record and Sets its fields appropriately.
  18777. @param in the RecordInputstream to Read the record from
  18778. </member>
  18779. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(System.Byte,System.Int32)">
  18780. Constructor to Create a built-in named region
  18781. @param builtin Built-in byte representation for the name record, use the public constants
  18782. @param index
  18783. </member>
  18784. <member name="M:NPOI.HSSF.Record.NameRecord.SetFunction(System.Boolean)">
  18785. Indicates that the defined name refers to a user-defined function.
  18786. This attribute is used when there is an add-in or other code project associated with the file.
  18787. @param function <c>true</c> indicates the name refers to a function.
  18788. </member>
  18789. <member name="M:NPOI.HSSF.Record.NameRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  18790. called by the class that Is responsible for writing this sucker.
  18791. Subclasses should implement this so that their data Is passed back in a
  18792. @param offset to begin writing at
  18793. @param data byte array containing instance data
  18794. @return number of bytes written
  18795. </member>
  18796. <member name="M:NPOI.HSSF.Record.NameRecord.ToString">
  18797. @see Object#ToString()
  18798. </member>
  18799. <member name="M:NPOI.HSSF.Record.NameRecord.TranslateBuiltInName(System.Byte)">
  18800. Creates a human Readable name for built in types
  18801. @return Unknown if the built-in name cannot be translated
  18802. </member>
  18803. <member name="P:NPOI.HSSF.Record.NameRecord.FnGroup">
  18804. @return function Group
  18805. @see FnGroupCountRecord
  18806. </member>
  18807. <member name="P:NPOI.HSSF.Record.NameRecord.OptionFlag">
  18808. Gets the option flag
  18809. @return option flag
  18810. </member>
  18811. <member name="P:NPOI.HSSF.Record.NameRecord.KeyboardShortcut">
  18812. returns the keyboard shortcut
  18813. @return keyboard shortcut
  18814. </member>
  18815. <member name="P:NPOI.HSSF.Record.NameRecord.NameTextLength">
  18816. **
  18817. </member>
  18818. <member name="P:NPOI.HSSF.Record.NameRecord.HasFormula">
  18819. @return <c>true</c> if name has a formula (named range or defined value)
  18820. </member>
  18821. <member name="P:NPOI.HSSF.Record.NameRecord.IsHiddenName">
  18822. @return true if name Is hidden
  18823. </member>
  18824. <member name="P:NPOI.HSSF.Record.NameRecord.IsFunctionName">
  18825. @return true if name Is a function
  18826. </member>
  18827. <member name="P:NPOI.HSSF.Record.NameRecord.IsCommandName">
  18828. @return true if name Is a command
  18829. </member>
  18830. <member name="P:NPOI.HSSF.Record.NameRecord.IsMacro">
  18831. @return true if function macro or command macro
  18832. </member>
  18833. <member name="P:NPOI.HSSF.Record.NameRecord.IsComplexFunction">
  18834. @return true if array formula or user defined
  18835. </member>
  18836. <member name="P:NPOI.HSSF.Record.NameRecord.IsBuiltInName">
  18837. Convenience Function to determine if the name Is a built-in name
  18838. </member>
  18839. <member name="P:NPOI.HSSF.Record.NameRecord.NameText">
  18840. Gets the name
  18841. @return name
  18842. </member>
  18843. <member name="P:NPOI.HSSF.Record.NameRecord.BuiltInName">
  18844. Gets the Built In Name
  18845. @return the built in Name
  18846. </member>
  18847. <member name="P:NPOI.HSSF.Record.NameRecord.NameDefinition">
  18848. Gets the definition, reference (Formula)
  18849. @return definition -- can be null if we cant Parse ptgs
  18850. </member>
  18851. <member name="P:NPOI.HSSF.Record.NameRecord.CustomMenuText">
  18852. Get the custom menu text
  18853. @return custom menu text
  18854. </member>
  18855. <member name="P:NPOI.HSSF.Record.NameRecord.DescriptionText">
  18856. Gets the description text
  18857. @return description text
  18858. </member>
  18859. <member name="P:NPOI.HSSF.Record.NameRecord.HelpTopicText">
  18860. Get the help topic text
  18861. @return gelp topic text
  18862. </member>
  18863. <member name="P:NPOI.HSSF.Record.NameRecord.StatusBarText">
  18864. Gets the status bar text
  18865. @return status bar text
  18866. </member>
  18867. <member name="P:NPOI.HSSF.Record.NameRecord.SheetNumber">
  18868. For named ranges, and built-in names
  18869. @return the 1-based sheet number.
  18870. </member>
  18871. <member name="P:NPOI.HSSF.Record.NameRecord.ExternSheetNumber">
  18872. Gets the extern sheet number
  18873. @return extern sheet index
  18874. </member>
  18875. <member name="P:NPOI.HSSF.Record.NameRecord.Sid">
  18876. return the non static version of the id for this record.
  18877. </member>
  18878. <member name="T:NPOI.HSSF.Record.NoteRecord">
  18879. NOTE: Comment Associated with a Cell (1Ch)
  18880. @author Yegor Kozlov
  18881. </member>
  18882. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_HIDDEN">
  18883. Flag indicating that the comment Is hidden (default)
  18884. </member>
  18885. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_VISIBLE">
  18886. Flag indicating that the comment Is visible
  18887. </member>
  18888. <member name="F:NPOI.HSSF.Record.NoteRecord.field_7_padding">
  18889. Saves padding byte value to reduce delta during round-trip serialization.<br/>
  18890. The documentation is not clear about how padding should work. In any case
  18891. Excel(2007) does something different.
  18892. </member>
  18893. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor">
  18894. Construct a new <c>NoteRecord</c> and
  18895. Fill its data with the default values
  18896. </member>
  18897. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18898. Constructs a <c>NoteRecord</c> and Fills its fields
  18899. from the supplied <c>RecordInputStream</c>.
  18900. @param in the stream to Read from
  18901. </member>
  18902. <member name="M:NPOI.HSSF.Record.NoteRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  18903. Serialize the record data into the supplied array of bytes
  18904. @param offset offset in the <c>data</c>
  18905. @param data the data to Serialize into
  18906. @return size of the record
  18907. </member>
  18908. <member name="M:NPOI.HSSF.Record.NoteRecord.ToString">
  18909. Convert this record to string.
  18910. Used by BiffViewer and other utulities.
  18911. </member>
  18912. <member name="P:NPOI.HSSF.Record.NoteRecord.Sid">
  18913. @return id of this record.
  18914. </member>
  18915. <member name="P:NPOI.HSSF.Record.NoteRecord.DataSize">
  18916. Size of record
  18917. </member>
  18918. <member name="P:NPOI.HSSF.Record.NoteRecord.Row">
  18919. Return the row that Contains the comment
  18920. @return the row that Contains the comment
  18921. </member>
  18922. <member name="P:NPOI.HSSF.Record.NoteRecord.Column">
  18923. Return the column that Contains the comment
  18924. @return the column that Contains the comment
  18925. </member>
  18926. <member name="P:NPOI.HSSF.Record.NoteRecord.Flags">
  18927. Options flags.
  18928. @return the options flag
  18929. @see #NOTE_VISIBLE
  18930. @see #NOTE_HIDDEN
  18931. </member>
  18932. <member name="P:NPOI.HSSF.Record.NoteRecord.ShapeId">
  18933. Object id for OBJ record that Contains the comment
  18934. </member>
  18935. <member name="P:NPOI.HSSF.Record.NoteRecord.Author">
  18936. Name of the original comment author
  18937. @return the name of the original author of the comment
  18938. </member>
  18939. <member name="P:NPOI.HSSF.Record.NoteRecord.AuthorIsMultibyte">
  18940. For unit testing only!
  18941. </member>
  18942. <member name="T:NPOI.HSSF.Record.NumberRecord">
  18943. Contains a numeric cell value.
  18944. REFERENCE: PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18945. @author Andrew C. Oliver (acoliver at apache dot org)
  18946. @author Jason Height (jheight at chariot dot net dot au)
  18947. @version 2.0-pre
  18948. </member>
  18949. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor">
  18950. Creates new NumberRecord
  18951. </member>
  18952. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18953. Constructs a Number record and Sets its fields appropriately.
  18954. @param in the RecordInputstream to Read the record from
  18955. </member>
  18956. <member name="P:NPOI.HSSF.Record.NumberRecord.Value">
  18957. Get the value for the cell
  18958. @return double representing the value
  18959. </member>
  18960. <member name="T:NPOI.HSSF.Record.ObjectProtectRecord">
  18961. Title: Object Protect Record
  18962. Description: Protect embedded object with the lamest "security" ever invented.
  18963. This record tells "I want to protect my objects" with lame security. It
  18964. appears in conjunction with the PASSWORD and PROTECT records as well as its
  18965. scenario protect cousin.
  18966. REFERENCE: PG 368 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  18967. @author Andrew C. Oliver (acoliver at apache dot org)
  18968. </member>
  18969. <member name="M:NPOI.HSSF.Record.ObjectProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18970. Constructs a Protect record and Sets its fields appropriately.
  18971. @param in the RecordInputstream to Read the record from
  18972. </member>
  18973. <member name="P:NPOI.HSSF.Record.ObjectProtectRecord.Protect">
  18974. Get whether the sheet Is protected or not
  18975. @return whether to protect the sheet or not
  18976. </member>
  18977. <member name="T:NPOI.HSSF.Record.ObjRecord">
  18978. The obj record is used to hold various graphic objects and controls.
  18979. @author Glen Stampoultzis (glens at apache.org)
  18980. </member>
  18981. <member name="F:NPOI.HSSF.Record.ObjRecord._uninterpretedData">
  18982. used when POI has no idea what is going on
  18983. </member>
  18984. <member name="F:NPOI.HSSF.Record.ObjRecord._isPaddedToQuadByteMultiple">
  18985. Excel seems to tolerate padding to quad or double byte length
  18986. </member>
  18987. <member name="M:NPOI.HSSF.Record.ObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  18988. Constructs a OBJ record and Sets its fields appropriately.
  18989. @param in the RecordInputstream to Read the record from
  18990. </member>
  18991. <member name="M:NPOI.HSSF.Record.ObjRecord.CanPaddingBeDiscarded(System.Byte[],System.Int32)">
  18992. Some XLS files have ObjRecords with nearly 8Kb of excessive padding. These were probably
  18993. written by a version of POI (around 3.1) which incorrectly interpreted the second short of
  18994. the ftLbs subrecord (0x1FEE) as a length, and read that many bytes as padding (other bugs
  18995. helped allow this to occur).
  18996. Excel reads files with this excessive padding OK, truncating the over-sized ObjRecord back
  18997. to the its proper size. POI does the same.
  18998. </member>
  18999. <member name="P:NPOI.HSSF.Record.ObjRecord.RecordSize">
  19000. Size of record (excluding 4 byte header)
  19001. </member>
  19002. <member name="T:NPOI.HSSF.Record.PaletteRecord">
  19003. PaletteRecord - Supports custom palettes.
  19004. @author Andrew C. Oliver (acoliver at apache dot org)
  19005. @author Brian Sanders (bsanders at risklabs dot com) - custom palette editing
  19006. @version 2.0-pre
  19007. </member>
  19008. <member name="F:NPOI.HSSF.Record.PaletteRecord.STANDARD_PALETTE_SIZE">
  19009. The standard size of an XLS palette
  19010. </member>
  19011. <member name="F:NPOI.HSSF.Record.PaletteRecord.FIRST_COLOR_INDEX">
  19012. The byte index of the first color
  19013. </member>
  19014. <member name="M:NPOI.HSSF.Record.PaletteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19015. Constructs a PaletteRecord record and Sets its fields appropriately.
  19016. @param in the RecordInputstream to Read the record from
  19017. </member>
  19018. <member name="M:NPOI.HSSF.Record.PaletteRecord.ClearColors">
  19019. <summary>
  19020. Dangerous! Only call this if you intend to replace the colors!
  19021. </summary>
  19022. </member>
  19023. <member name="M:NPOI.HSSF.Record.PaletteRecord.GetColor(System.Int16)">
  19024. Returns the color value at a given index
  19025. @return the RGB triplet for the color, or null if the specified index
  19026. does not exist
  19027. </member>
  19028. <member name="M:NPOI.HSSF.Record.PaletteRecord.SetColor(System.Int16,System.Byte,System.Byte,System.Byte)">
  19029. Sets the color value at a given index
  19030. If the given index Is greater than the current last color index,
  19031. then black Is Inserted at every index required to make the palette continuous.
  19032. @param byteIndex the index to Set; if this index Is less than 0x8 or greater than
  19033. 0x40, then no modification Is made
  19034. </member>
  19035. <member name="M:NPOI.HSSF.Record.PaletteRecord.CreateDefaultPalette">
  19036. Creates the default palette as PaletteRecord binary data
  19037. @see org.apache.poi.hssf.model.Workbook#createPalette
  19038. </member>
  19039. <member name="T:NPOI.HSSF.Record.PColor">
  19040. PColor - element in the list of colors - consider it a "struct"
  19041. </member>
  19042. <member name="T:NPOI.HSSF.Record.PaneRecord">
  19043. * Describes the frozen and Unfozen panes.
  19044. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or
  19045. * Remove the record in src/records/definitions.
  19046. * @author Glen Stampoultzis (glens at apache.org)
  19047. </member>
  19048. <member name="M:NPOI.HSSF.Record.PaneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19049. Constructs a Pane record and Sets its fields appropriately.
  19050. @param in the RecordInputstream to Read the record from
  19051. </member>
  19052. <member name="P:NPOI.HSSF.Record.PaneRecord.X">
  19053. Get the x field for the Pane record.
  19054. </member>
  19055. <member name="P:NPOI.HSSF.Record.PaneRecord.Y">
  19056. Get the y field for the Pane record.
  19057. </member>
  19058. <member name="P:NPOI.HSSF.Record.PaneRecord.TopRow">
  19059. Get the top row field for the Pane record.
  19060. </member>
  19061. <member name="P:NPOI.HSSF.Record.PaneRecord.LeftColumn">
  19062. Get the left column field for the Pane record.
  19063. </member>
  19064. <member name="P:NPOI.HSSF.Record.PaneRecord.ActivePane">
  19065. Get the active pane field for the Pane record.
  19066. @return One of
  19067. ACTIVE_PANE_LOWER_RIGHT
  19068. ACTIVE_PANE_UPPER_RIGHT
  19069. ACTIVE_PANE_LOWER_LEFT
  19070. ACTIVE_PANE_UPPER_LEFT
  19071. </member>
  19072. <member name="T:NPOI.HSSF.Record.PasswordRecord">
  19073. Title: Password Record
  19074. Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
  19075. REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19076. @author Andrew C. Oliver (acoliver at apache dot org)
  19077. @version 2.0-pre
  19078. </member>
  19079. <member name="M:NPOI.HSSF.Record.PasswordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19080. Constructs a Password record and Sets its fields appropriately.
  19081. @param in the RecordInputstream to Read the record from
  19082. </member>
  19083. <member name="M:NPOI.HSSF.Record.PasswordRecord.Clone">
  19084. Clone this record.
  19085. </member>
  19086. <member name="P:NPOI.HSSF.Record.PasswordRecord.Password">
  19087. Get the password
  19088. @return short representing the password
  19089. </member>
  19090. <member name="T:NPOI.HSSF.Record.PasswordRev4Record">
  19091. Title: Protection Revision 4 password Record
  19092. Description: Stores the (2 byte??!!) encrypted password for a shared
  19093. workbook
  19094. REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19095. @author Andrew C. Oliver (acoliver at apache dot org)
  19096. @version 2.0-pre
  19097. </member>
  19098. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19099. Constructs a PasswordRev4 (PROT4REVPASS) record and Sets its fields appropriately.
  19100. @param in the RecordInputstream to Read the record from
  19101. </member>
  19102. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.SetPassword(System.Int16)">
  19103. set the password
  19104. @param pw representing the password
  19105. </member>
  19106. <member name="T:NPOI.HSSF.Record.PivotTable.DataItemRecord">
  19107. SXDI - Data Item (0x00C5)<br/>
  19108. @author Patrick Cheng
  19109. </member>
  19110. <member name="T:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord">
  19111. SXVDEX - Extended PivotTable View Fields (0x0100)<br/>
  19112. @author Patrick Cheng
  19113. </member>
  19114. <member name="F:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  19115. the value of the <c>cchSubName</c> field when the subName is not present
  19116. </member>
  19117. <member name="T:NPOI.HSSF.Record.PivotTable.PageItemRecord">
  19118. SXPI - Page Item (0x00B6)<br/>
  19119. @author Patrick Cheng
  19120. </member>
  19121. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvi">
  19122. Index to the View Item SXVI(0x00B2) record
  19123. </member>
  19124. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvd">
  19125. Index to the {@link ViewFieldsRecord} SXVD(0x00B1) record
  19126. </member>
  19127. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._idObj">
  19128. Object ID for the drop-down arrow
  19129. </member>
  19130. <member name="T:NPOI.HSSF.Record.PivotTable.StreamIDRecord">
  19131. SXIDSTM - Stream ID (0x00D5)<br/>
  19132. @author Patrick Cheng
  19133. </member>
  19134. <member name="T:NPOI.HSSF.Record.PivotTable.ViewDefinitionRecord">
  19135. SXVIEW - View Definition (0x00B0)<br/>
  19136. @author Patrick Cheng
  19137. </member>
  19138. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord">
  19139. SXVD - View Fields (0x00B1)<br/>
  19140. @author Patrick Cheng
  19141. </member>
  19142. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  19143. the value of the <c>cchName</c> field when the name is not present
  19144. </member>
  19145. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.BASE_SIZE">
  19146. 5 shorts
  19147. </member>
  19148. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.Axis">
  19149. values for the {@link ViewFieldsRecord#sxaxis} field
  19150. </member>
  19151. <member name="T:NPOI.HSSF.Record.PivotTable.ViewSourceRecord">
  19152. SXVS - View Source (0x00E3)<br/>
  19153. @author Patrick Cheng
  19154. </member>
  19155. <member name="T:NPOI.HSSF.Record.PrecisionRecord">
  19156. Title: Precision Record
  19157. Description: defines whether to store with full precision or what's Displayed by the gui
  19158. (meaning have really screwed up and skewed figures or only think you do!)
  19159. REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19160. @author Andrew C. Oliver (acoliver at apache dot org)
  19161. @version 2.0-pre
  19162. </member>
  19163. <member name="M:NPOI.HSSF.Record.PrecisionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19164. Constructs a Precision record and Sets its fields appropriately.
  19165. @param in the RecordInputstream to Read the record from
  19166. </member>
  19167. <member name="P:NPOI.HSSF.Record.PrecisionRecord.FullPrecision">
  19168. Get whether to use full precision or just skew all you figures all to hell.
  19169. @return fullprecision - or not
  19170. </member>
  19171. <member name="T:NPOI.HSSF.Record.PrintGridlinesRecord">
  19172. Title: Print Gridlines Record
  19173. Description: whether to print the gridlines when you enjoy you spReadsheet on paper.
  19174. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19175. @author Andrew C. Oliver (acoliver at apache dot org)
  19176. @author Jason Height (jheight at chariot dot net dot au)
  19177. @version 2.0-pre
  19178. </member>
  19179. <member name="M:NPOI.HSSF.Record.PrintGridlinesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19180. Constructs a PrintGridlines record and Sets its fields appropriately.
  19181. @param in the RecordInputstream to Read the record from
  19182. </member>
  19183. <member name="P:NPOI.HSSF.Record.PrintGridlinesRecord.PrintGridlines">
  19184. Get whether or not to print the gridlines (and make your spReadsheet ugly)
  19185. @return make spReadsheet ugly - Y/N
  19186. </member>
  19187. <member name="T:NPOI.HSSF.Record.PrintHeadersRecord">
  19188. Title: Print Headers Record
  19189. Description: Whether or not to print the row/column headers when you
  19190. enjoy your spReadsheet in the physical form.
  19191. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19192. @author Andrew C. Oliver (acoliver at apache dot org)
  19193. @author Jason Height (jheight at chariot dot net dot au)
  19194. @version 2.0-pre
  19195. </member>
  19196. <member name="M:NPOI.HSSF.Record.PrintHeadersRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19197. Constructs a PrintHeaders record and Sets its fields appropriately.
  19198. @param in the RecordInputstream to Read the record from
  19199. </member>
  19200. <member name="P:NPOI.HSSF.Record.PrintHeadersRecord.PrintHeaders">
  19201. <summary>
  19202. Get whether to print the headers - y/n
  19203. </summary>
  19204. <value><c>true</c> if [print headers]; otherwise, <c>false</c>.</value>
  19205. </member>
  19206. <member name="T:NPOI.HSSF.Record.PrintSetupRecord">
  19207. Title: Print Setup Record
  19208. Description: Stores print Setup options -- bogus for HSSF (and marked as such)
  19209. REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19210. @author Andrew C. Oliver (acoliver at apache dot org)
  19211. @author Jason Height (jheight at chariot dot net dot au)
  19212. @version 2.0-pre
  19213. </member>
  19214. <member name="M:NPOI.HSSF.Record.PrintSetupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19215. Constructs a PrintSetup (SetUP) record and Sets its fields appropriately.
  19216. @param in the RecordInputstream to Read the record from
  19217. </member>
  19218. <member name="T:NPOI.HSSF.Record.ProtectionRev4Record">
  19219. Title: Protection Revision 4 Record
  19220. Description: describes whether this is a protected shared/tracked workbook
  19221. ( HSSF does not support encryption because we don't feel like going to jail )
  19222. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19223. @author Andrew C. Oliver (acoliver at apache dot org)
  19224. @version 2.0-pre
  19225. </member>
  19226. <member name="M:NPOI.HSSF.Record.ProtectionRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19227. Constructs a ProtectionRev4 record and Sets its fields appropriately.
  19228. @param in the RecordInputstream to Read the record from
  19229. </member>
  19230. <member name="P:NPOI.HSSF.Record.ProtectionRev4Record.Protect">
  19231. Get whether the this is protected shared/tracked workbook or not
  19232. @return whether to protect the workbook or not
  19233. </member>
  19234. <member name="T:NPOI.HSSF.Record.ProtectRecord">
  19235. Title: Protect Record
  19236. Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
  19237. (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)
  19238. (after all terrorists will all use US-legal encrypton right??)
  19239. HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
  19240. ignore the password record entirely).
  19241. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19242. @author Andrew C. Oliver (acoliver at apache dot org)
  19243. </member>
  19244. <member name="M:NPOI.HSSF.Record.ProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19245. Constructs a Protect record and Sets its fields appropriately.
  19246. @param in the RecordInputstream to Read the record from
  19247. </member>
  19248. <member name="P:NPOI.HSSF.Record.ProtectRecord.Protect">
  19249. Get whether the sheet is protected or not
  19250. @return whether to protect the sheet or not
  19251. </member>
  19252. <member name="T:NPOI.HSSF.Record.RecalcIdRecord">
  19253. Title: Recalc Id Record
  19254. Description: This record Contains an ID that marks when a worksheet was last
  19255. recalculated. It's an optimization Excel uses to determine if it
  19256. needs to recalculate the spReadsheet when it's opened. So far, only
  19257. the two values <c>0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00</c>
  19258. (do not recalculate) and <c>0xC1 0x01 0x00 0x00 0x60 0x69 0x01
  19259. 0x00</c> have been seen. If the field <c>isNeeded</c> Is
  19260. Set to false (default), then this record Is swallowed during the
  19261. serialization Process
  19262. REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
  19263. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  19264. @version 2.0-pre
  19265. @see org.apache.poi.hssf.model.Workbook
  19266. </member>
  19267. <member name="F:NPOI.HSSF.Record.RecalcIdRecord._engineId">
  19268. An unsigned integer that specifies the recalculation engine identifier
  19269. of the recalculation engine that performed the last recalculation.
  19270. If the value is less than the recalculation engine identifier associated with the application,
  19271. the application will recalculate the results of all formulas on
  19272. this workbook immediately after loading the file
  19273. </member>
  19274. <member name="M:NPOI.HSSF.Record.RecalcIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19275. Constructs a RECALCID record and Sets its fields appropriately.
  19276. @param in the RecordInputstream to Read the record from
  19277. </member>
  19278. <member name="T:NPOI.HSSF.Record.RecordFactory">
  19279. Title: Record Factory
  19280. Description: Takes a stream and outputs an array of Record objects.
  19281. @deprecated use {@link org.apache.poi.hssf.eventmodel.EventRecordFactory} instead
  19282. @see org.apache.poi.hssf.eventmodel.EventRecordFactory
  19283. @author Andrew C. Oliver (acoliver at apache dot org)
  19284. @author Marc Johnson (mjohnson at apache dot org)
  19285. @author Glen Stampoultzis (glens at apache.org)
  19286. @author Csaba Nagy (ncsaba at yahoo dot com)
  19287. </member>
  19288. <member name="F:NPOI.HSSF.Record.RecordFactory._recordCreatorsById">
  19289. cache of the recordsToMap();
  19290. </member>
  19291. <member name="M:NPOI.HSSF.Record.RecordFactory.GetRecordClass(System.Int32)">
  19292. Debug / diagnosis method<br/>
  19293. Gets the POI implementation class for a given <tt>sid</tt>. Only a subset of the any BIFF
  19294. records are actually interpreted by POI. A few others are known but not interpreted
  19295. (see {@link UnknownRecord#getBiffName(int)}).
  19296. @return the POI implementation class for the specified record <tt>sid</tt>.
  19297. <code>null</code> if the specified record is not interpreted by POI.
  19298. </member>
  19299. <member name="M:NPOI.HSSF.Record.RecordFactory.SetCapacity(System.Int32)">
  19300. Changes the default capacity (10000) to handle larger files
  19301. </member>
  19302. <member name="M:NPOI.HSSF.Record.RecordFactory.CreateRecords(System.IO.Stream)">
  19303. Create an array of records from an input stream
  19304. @param in the InputStream from which the records will be
  19305. obtained
  19306. @return an array of Records Created from the InputStream
  19307. @exception RecordFormatException on error Processing the
  19308. InputStream
  19309. </member>
  19310. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertBlankRecords(NPOI.HSSF.Record.MulBlankRecord)">
  19311. Converts a {@link MulBlankRecord} into an equivalent array of {@link BlankRecord}s
  19312. </member>
  19313. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertToNumberRecord(NPOI.HSSF.Record.RKRecord)">
  19314. <summary>
  19315. RK record is a slightly smaller alternative to NumberRecord
  19316. POI likes NumberRecord better
  19317. </summary>
  19318. <param name="rk">The rk.</param>
  19319. <returns></returns>
  19320. </member>
  19321. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertRKRecords(NPOI.HSSF.Record.MulRKRecord)">
  19322. <summary>
  19323. Converts a MulRKRecord into an equivalent array of NumberRecords
  19324. </summary>
  19325. <param name="mrk">The MRK.</param>
  19326. <returns></returns>
  19327. </member>
  19328. <member name="T:NPOI.HSSF.Record.RecordFactory.ReflectionMethodRecordCreator">
  19329. A "create" method is used instead of the usual constructor if the created record might
  19330. be of a different class to the declaring class.
  19331. </member>
  19332. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream">
  19333. A stream based way to get at complete records, with
  19334. as low a memory footprint as possible.
  19335. This handles Reading from a RecordInputStream, turning
  19336. the data into full records, processing continue records
  19337. etc.
  19338. Most users should use {@link HSSFEventFactory} /
  19339. {@link HSSFListener} and have new records pushed to
  19340. them, but this does allow for a "pull" style of coding.
  19341. </member>
  19342. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordBuffer">
  19343. Temporarily stores a group of {@link Record}s, for future return by {@link #nextRecord()}.
  19344. This is used at the start of the workbook stream, and also when the most recently read
  19345. underlying record is a {@link MulRKRecord}
  19346. </member>
  19347. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordIndex">
  19348. used to help iterating over the unread records
  19349. </member>
  19350. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastRecord">
  19351. The most recent record that we gave to the user
  19352. </member>
  19353. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastDrawingRecord">
  19354. The most recent DrawingRecord seen
  19355. </member>
  19356. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.#ctor(System.IO.Stream,System.Boolean)">
  19357. @param shouldIncludeContinueRecords caller can pass <c>false</c> if loose
  19358. {@link ContinueRecord}s should be skipped (this is sometimes useful in event based
  19359. processing).
  19360. </member>
  19361. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.NextRecord">
  19362. Returns the next (complete) record from the
  19363. stream, or null if there are no more.
  19364. </member>
  19365. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.GetNextUnreadRecord">
  19366. @return the next {@link Record} from the multiple record group as expanded from
  19367. a recently read {@link MulRKRecord}. <code>null</code> if not present.
  19368. </member>
  19369. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.ReadNextRecord">
  19370. @return the next available record, or <code>null</code> if
  19371. this pass didn't return a record that's
  19372. suitable for returning (eg was a continue record).
  19373. </member>
  19374. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo">
  19375. Keeps track of the sizes of the Initial records up to and including {@link FilePassRecord}
  19376. Needed for protected files because each byte is encrypted with respect to its absolute
  19377. position from the start of the stream.
  19378. </member>
  19379. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.LastRecord">
  19380. @return last record scanned while looking for encryption info.
  19381. This will typically be the first or second record Read. Possibly <code>null</code>
  19382. if stream was empty
  19383. </member>
  19384. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.HasBOFRecord">
  19385. <c>false</c> in some test cases
  19386. </member>
  19387. <member name="T:NPOI.HSSF.Record.RecordInputStream">
  19388. Title: Record Input Stream
  19389. Description: Wraps a stream and provides helper methods for the construction of records.
  19390. @author Jason Height (jheight @ apache dot org)
  19391. </member>
  19392. <member name="F:NPOI.HSSF.Record.RecordInputStream.MAX_RECORD_DATA_SIZE">
  19393. Maximum size of a single record (minus the 4 byte header) without a continue
  19394. </member>
  19395. <member name="F:NPOI.HSSF.Record.RecordInputStream._bhi">
  19396. Header {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  19397. </member>
  19398. <member name="F:NPOI.HSSF.Record.RecordInputStream._dataInput">
  19399. Data {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  19400. </member>
  19401. <member name="F:NPOI.HSSF.Record.RecordInputStream.data">
  19402. the record identifier of the BIFF record currently being read
  19403. </member>
  19404. <member name="M:NPOI.HSSF.Record.RecordInputStream.Read">
  19405. This method will Read a byte from the current record
  19406. </member>
  19407. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadNextSid">
  19408. @return the sid of the next record or {@link #INVALID_SID_VALUE} if at end of stream
  19409. </member>
  19410. <member name="M:NPOI.HSSF.Record.RecordInputStream.NextRecord">
  19411. Moves to the next record in the stream.
  19412. <i>Note: The auto continue flag is Reset to true</i>
  19413. </member>
  19414. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadByte">
  19415. Reads an 8 bit, signed value
  19416. </member>
  19417. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadShort">
  19418. Reads a 16 bit, signed value
  19419. </member>
  19420. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUByte">
  19421. Reads an 8 bit, Unsigned value
  19422. </member>
  19423. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUShort">
  19424. Reads a 16 bit,un- signed value.
  19425. @return
  19426. </member>
  19427. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUnicodeLEString(System.Int32)">
  19428. given a byte array of 16-bit Unicode Chars, compress to 8-bit and
  19429. return a string
  19430. { 0x16, 0x00 } -0x16
  19431. @param Length the Length of the string
  19432. @return the Converted string
  19433. @exception ArgumentException if len is too large (i.e.,
  19434. there is not enough data in string to Create a String of that
  19435. Length)
  19436. </member>
  19437. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadRemainder">
  19438. Returns the remaining bytes for the current record.
  19439. @return The remaining bytes of the current record.
  19440. </member>
  19441. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadAllContinuedRemainder">
  19442. Reads all byte data for the current record, including any
  19443. that overlaps into any following continue records.
  19444. @deprecated Best to write a input stream that wraps this one where there Is
  19445. special sub record that may overlap continue records.
  19446. </member>
  19447. <member name="M:NPOI.HSSF.Record.RecordInputStream.GetNextSid">
  19448. @return sid of next record. Can be called after hasNextRecord()
  19449. </member>
  19450. <member name="P:NPOI.HSSF.Record.RecordInputStream.Remaining">
  19451. The remaining number of bytes in the <i>current</i> record.
  19452. @return The number of bytes remaining in the current record
  19453. </member>
  19454. <member name="P:NPOI.HSSF.Record.RecordInputStream.IsContinueNext">
  19455. Returns true iif a Continue record is next in the excel stream _currentDataOffset
  19456. @return True when a ContinueRecord is next.
  19457. </member>
  19458. <member name="T:NPOI.HSSF.Record.RefModeRecord">
  19459. Title: RefMode Record
  19460. Description: Describes which reference mode to use
  19461. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19462. @author Andrew C. Oliver (acoliver at apache dot org)
  19463. @author Jason Height (jheight at chariot dot net dot au)
  19464. @version 2.0-pre
  19465. </member>
  19466. <member name="M:NPOI.HSSF.Record.RefModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19467. Constructs a RefMode record and Sets its fields appropriately.
  19468. @param in the RecordInputstream to Read the record from
  19469. </member>
  19470. <member name="P:NPOI.HSSF.Record.RefModeRecord.Mode">
  19471. Get the reference mode to use (HSSF uses/assumes A1)
  19472. @return mode to use
  19473. @see #USE_A1_MODE
  19474. @see #USE_R1C1_MODE
  19475. </member>
  19476. <member name="T:NPOI.HSSF.Record.RefreshAllRecord">
  19477. Title: Refresh All Record
  19478. Description: Flag whether to refresh all external data when loading a sheet.
  19479. (which hssf doesn't support anyhow so who really cares?)
  19480. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19481. @author Andrew C. Oliver (acoliver at apache dot org)
  19482. @version 2.0-pre
  19483. </member>
  19484. <member name="M:NPOI.HSSF.Record.RefreshAllRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19485. Constructs a RefreshAll record and Sets its fields appropriately.
  19486. @param in the RecordInputstream to Read the record from
  19487. </member>
  19488. <member name="P:NPOI.HSSF.Record.RefreshAllRecord.RefreshAll">
  19489. Get whether to refresh all external data when loading a sheet
  19490. @return refreshall or not
  19491. </member>
  19492. <member name="T:NPOI.HSSF.Record.RightMarginRecord">
  19493. Record for the right margin. * NOTE: This source was automatically generated. * @author Shawn Laubach (slaubach at apache dot org)
  19494. </member>
  19495. <member name="M:NPOI.HSSF.Record.RightMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19496. 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)
  19497. </member>
  19498. <member name="P:NPOI.HSSF.Record.RightMarginRecord.Margin">
  19499. Get the margin field for the RightMargin record.
  19500. </member>
  19501. <member name="T:NPOI.HSSF.Record.RKRecord">
  19502. Title: RK Record
  19503. Description: An internal 32 bit number with the two most significant bits
  19504. storing the type. This is part of a bizarre scheme to save disk
  19505. space and memory (gee look at all the other whole records that
  19506. are in the file just "cause"..,far better to waste Processor
  19507. cycles on this then leave on of those "valuable" records out).
  19508. We support this in Read-ONLY mode. HSSF Converts these to NUMBER records
  19509. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19510. @author Andrew C. Oliver (acoliver at apache dot org)
  19511. @author Jason Height (jheight at chariot dot net dot au)
  19512. @version 2.0-pre
  19513. @see org.apache.poi.hssf.record.NumberRecord
  19514. </member>
  19515. <member name="M:NPOI.HSSF.Record.RKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19516. Constructs a RK record and Sets its fields appropriately.
  19517. @param in the RecordInputstream to Read the record from
  19518. </member>
  19519. <member name="P:NPOI.HSSF.Record.RKRecord.RKType">
  19520. Get the type of the number
  19521. @return one of these values:
  19522. <OL START="0">
  19523. <LI>RK_IEEE_NUMBER</LI>
  19524. <LI>RK_IEEE_NUMBER_TIMES_100</LI>
  19525. <LI>RK_INTEGER</LI>
  19526. <LI>RK_INTEGER_TIMES_100</LI>
  19527. </OL>
  19528. </member>
  19529. <member name="P:NPOI.HSSF.Record.RKRecord.RKNumber">
  19530. Extract the value of the number
  19531. The mechanism for determining the value is dependent on the two
  19532. low order bits of the raw number. If bit 1 is Set, the number
  19533. is an integer and can be cast directly as a double, otherwise,
  19534. it's apparently the exponent and mantissa of a double (and the
  19535. remaining low-order bits of the double's mantissa are 0's).
  19536. If bit 0 is Set, the result of the conversion to a double Is
  19537. divided by 100; otherwise, the value is left alone.
  19538. [Insert picture of Screwy Squirrel in full Napoleonic regalia]
  19539. @return the value as a proper double (hey, it <B>could</B>
  19540. happen)
  19541. </member>
  19542. <member name="T:NPOI.HSSF.Record.RowRecord">
  19543. Title: Row Record
  19544. Description: stores the row information for the sheet.
  19545. REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19546. @author Andrew C. Oliver (acoliver at apache dot org)
  19547. @author Jason Height (jheight at chariot dot net dot au)
  19548. @version 2.0-pre
  19549. </member>
  19550. <member name="F:NPOI.HSSF.Record.RowRecord.MAX_ROW_NUMBER">
  19551. The maximum row number that excel can handle (zero based) ie 65536 rows Is
  19552. max number of rows.
  19553. </member>
  19554. <member name="F:NPOI.HSSF.Record.RowRecord.field_7_option_flags">
  19555. 16 bit options flags
  19556. </member>
  19557. <member name="M:NPOI.HSSF.Record.RowRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19558. Constructs a Row record and Sets its fields appropriately.
  19559. @param in the RecordInputstream to Read the record from
  19560. </member>
  19561. <member name="P:NPOI.HSSF.Record.RowRecord.IsEmpty">
  19562. Get the logical row number for this row (0 based index)
  19563. @return row - the row number
  19564. </member>
  19565. <member name="P:NPOI.HSSF.Record.RowRecord.FirstCol">
  19566. Get the logical col number for the first cell this row (0 based index)
  19567. @return col - the col number
  19568. </member>
  19569. <member name="P:NPOI.HSSF.Record.RowRecord.LastCol">
  19570. Get the logical col number for the last cell this row plus one (0 based index)
  19571. @return col - the last col number + 1
  19572. </member>
  19573. <member name="P:NPOI.HSSF.Record.RowRecord.Height">
  19574. Get the height of the row
  19575. @return height of the row
  19576. </member>
  19577. <member name="P:NPOI.HSSF.Record.RowRecord.Optimize">
  19578. Get whether to optimize or not (Set to 0)
  19579. @return optimize (Set to 0)
  19580. </member>
  19581. <member name="P:NPOI.HSSF.Record.RowRecord.OptionFlags">
  19582. Gets the option bitmask. (use the individual bit Setters that refer to this
  19583. method)
  19584. @return options - the bitmask
  19585. </member>
  19586. <member name="P:NPOI.HSSF.Record.RowRecord.OutlineLevel">
  19587. Get the outline level of this row
  19588. @return ol - the outline level
  19589. @see #GetOptionFlags()
  19590. </member>
  19591. <member name="P:NPOI.HSSF.Record.RowRecord.Colapsed">
  19592. Get whether or not to colapse this row
  19593. @return c - colapse or not
  19594. @see #GetOptionFlags()
  19595. </member>
  19596. <member name="P:NPOI.HSSF.Record.RowRecord.ZeroHeight">
  19597. Get whether or not to Display this row with 0 height
  19598. @return - z height is zero or not.
  19599. @see #GetOptionFlags()
  19600. </member>
  19601. <member name="P:NPOI.HSSF.Record.RowRecord.BadFontHeight">
  19602. Get whether the font and row height are not compatible
  19603. @return - f -true if they aren't compatible (damn not logic)
  19604. @see #GetOptionFlags()
  19605. </member>
  19606. <member name="P:NPOI.HSSF.Record.RowRecord.Formatted">
  19607. Get whether the row has been formatted (even if its got all blank cells)
  19608. @return formatted or not
  19609. @see #GetOptionFlags()
  19610. </member>
  19611. <member name="P:NPOI.HSSF.Record.RowRecord.XFIndex">
  19612. if the row is formatted then this is the index to the extended format record
  19613. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  19614. @return index to the XF record or bogus value (undefined) if Isn't formatted
  19615. </member>
  19616. <member name="T:NPOI.HSSF.Record.SaveRecalcRecord">
  19617. Title: Save Recalc Record
  19618. Description: defines whether to recalculate before saving (Set to true)
  19619. REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19620. @author Andrew C. Oliver (acoliver at apache dot org)
  19621. @author Jason Height (jheight at chariot dot net dot au)
  19622. @version 2.0-pre
  19623. </member>
  19624. <member name="M:NPOI.HSSF.Record.SaveRecalcRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19625. Constructs an SaveRecalc record and Sets its fields appropriately.
  19626. @param in the RecordInputstream to Read the record from
  19627. </member>
  19628. <member name="P:NPOI.HSSF.Record.SaveRecalcRecord.Recalc">
  19629. Get whether to recalculate formulas/etc before saving or not
  19630. @return recalc - whether to recalculate or not
  19631. </member>
  19632. <member name="T:NPOI.HSSF.Record.ScenarioProtectRecord">
  19633. Title: Scenario Protect Record
  19634. Description: I have no idea what a Scenario is or why on would want to
  19635. protect it with the lamest "security" ever invented. However this record tells
  19636. excel "I want to protect my scenarios" (0xAF) with lame security. It appears
  19637. in conjunction with the PASSWORD and PROTECT records as well as its object
  19638. protect cousin.
  19639. REFERENCE: PG 383 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19640. @author Andrew C. Oliver (acoliver at apache dot org)
  19641. </member>
  19642. <member name="M:NPOI.HSSF.Record.ScenarioProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19643. Constructs a Protect record and Sets its fields appropriately.
  19644. @param in the RecordInputstream to Read the record from
  19645. </member>
  19646. <member name="P:NPOI.HSSF.Record.ScenarioProtectRecord.Protect">
  19647. Get whether the sheet is protected or not
  19648. @return whether to protect the sheet or not
  19649. </member>
  19650. <member name="T:NPOI.HSSF.Record.SCLRecord">
  19651. * Specifies the window's zoom magnification. If this record Isn't present then the windows zoom is 100%. see p384 Excel Dev Kit
  19652. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  19653. * Remove the record in src/records/definitions.
  19654. * @author Andrew C. Oliver (acoliver at apache.org)
  19655. </member>
  19656. <member name="M:NPOI.HSSF.Record.SCLRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19657. Constructs a SCL record and Sets its fields appropriately.
  19658. @param in the RecordInputstream to Read the record from
  19659. </member>
  19660. <member name="P:NPOI.HSSF.Record.SCLRecord.DataSize">
  19661. Size of record (exluding 4 byte header)
  19662. </member>
  19663. <member name="P:NPOI.HSSF.Record.SCLRecord.Numerator">
  19664. Get the numerator field for the SCL record.
  19665. </member>
  19666. <member name="P:NPOI.HSSF.Record.SCLRecord.Denominator">
  19667. Get the denominator field for the SCL record.
  19668. </member>
  19669. <member name="T:NPOI.HSSF.Record.SelectionRecord">
  19670. Title: Selection Record
  19671. Description: shows the user's selection on the sheet
  19672. for Write Set num refs to 0
  19673. TODO : Fully implement reference subrecords.
  19674. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19675. @author Andrew C. Oliver (acoliver at apache dot org)
  19676. @author Jason Height (jheight at chariot dot net dot au)
  19677. @author Glen Stampoultzis (glens at apache.org)
  19678. </member>
  19679. <member name="M:NPOI.HSSF.Record.SelectionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19680. <summary>
  19681. Constructs a Selection record and Sets its fields appropriately.
  19682. </summary>
  19683. <param name="in1">the RecordInputstream to Read the record from</param>
  19684. </member>
  19685. <member name="P:NPOI.HSSF.Record.SelectionRecord.Pane">
  19686. <summary>
  19687. Gets or sets the pane this is for.
  19688. </summary>
  19689. <value>The pane.</value>
  19690. </member>
  19691. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRow">
  19692. <summary>
  19693. Gets or sets the active cell row.
  19694. </summary>
  19695. <value>row number of active cell</value>
  19696. </member>
  19697. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellCol">
  19698. <summary>
  19699. Gets or sets the active cell's col
  19700. </summary>
  19701. <value>number of active cell</value>
  19702. </member>
  19703. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRef">
  19704. <summary>
  19705. Gets or sets the active cell's reference number
  19706. </summary>
  19707. <value>ref number of active cell</value>
  19708. </member>
  19709. <member name="T:NPOI.HSSF.Record.SharedFormulaRecord">
  19710. Title: SharedFormulaRecord
  19711. Description: Primarily used as an excel optimization so that multiple similar formulas
  19712. are not written out too many times. We should recognize this record and
  19713. Serialize as Is since this Is used when Reading templates.
  19714. Note: the documentation says that the SID Is BC where biffviewer reports 4BC. The hex dump shows
  19715. that the two byte sid representation to be 'BC 04' that Is consistent with the other high byte
  19716. record types.
  19717. @author Danny Mui at apache dot org
  19718. </member>
  19719. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19720. @param in the RecordInputstream to Read the record from
  19721. </member>
  19722. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.ToString">
  19723. print a sort of string representation ([SHARED FORMULA RECORD] id = x [/SHARED FORMULA RECORD])
  19724. </member>
  19725. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.GetFormulaTokens(NPOI.HSSF.Record.FormulaRecord)">
  19726. @return the equivalent {@link Ptg} array that the formula would have, were it not shared.
  19727. </member>
  19728. <member name="T:NPOI.HSSF.Record.SSTDeserializer">
  19729. Handles the task of deserializing a SST string. The two main entry points are
  19730. @author Glen Stampoultzis (glens at apache.org)
  19731. @author Jason Height (jheight at apache.org)
  19732. </member>
  19733. <member name="M:NPOI.HSSF.Record.SSTDeserializer.ManufactureStrings(System.Int32,NPOI.HSSF.Record.RecordInputStream)">
  19734. This Is the starting point where strings are constructed. Note that
  19735. strings may span across multiple continuations. Read the SST record
  19736. carefully before beginning to hack.
  19737. </member>
  19738. <member name="T:NPOI.HSSF.Record.SSTRecord">
  19739. Title: Static String Table Record
  19740. Description: This holds all the strings for LabelSSTRecords.
  19741. REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN:
  19742. 1-57231-498-2)
  19743. @author Andrew C. Oliver (acoliver at apache dot org)
  19744. @author Marc Johnson (mjohnson at apache dot org)
  19745. @author Glen Stampoultzis (glens at apache.org)
  19746. @see org.apache.poi.hssf.record.LabelSSTRecord
  19747. @see org.apache.poi.hssf.record.ContinueRecord
  19748. </member>
  19749. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_RECORD_SIZE">
  19750. how big can an SST record be? As big as any record can be: 8228 bytes
  19751. </member>
  19752. <member name="F:NPOI.HSSF.Record.SSTRecord.STD_RECORD_OVERHEAD">
  19753. standard record overhead: two shorts (record id plus data space size)
  19754. </member>
  19755. <member name="F:NPOI.HSSF.Record.SSTRecord.SST_RECORD_OVERHEAD">
  19756. SST overhead: the standard record overhead, plus the number of strings and the number of Unique strings -- two ints
  19757. </member>
  19758. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_DATA_SPACE">
  19759. how much data can we stuff into an SST record? That would be _max minus the standard SST record overhead
  19760. </member>
  19761. <member name="F:NPOI.HSSF.Record.SSTRecord.field_1_num_strings">
  19762. Union of strings in the SST and EXTSST
  19763. </member>
  19764. <member name="F:NPOI.HSSF.Record.SSTRecord.field_2_num_unique_strings">
  19765. according to docs ONLY SST
  19766. </member>
  19767. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketAbsoluteOffsets">
  19768. Offsets from the beginning of the SST record (even across continuations)
  19769. </member>
  19770. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketRelativeOffsets">
  19771. Offsets relative the start of the current SST or continue record
  19772. </member>
  19773. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor">
  19774. default constructor
  19775. </member>
  19776. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19777. Constructs an SST record and Sets its fields appropriately.
  19778. @param in the RecordInputstream to Read the record from
  19779. </member>
  19780. <member name="M:NPOI.HSSF.Record.SSTRecord.AddString(NPOI.HSSF.Record.UnicodeString)">
  19781. Add a string.
  19782. @param string string to be Added
  19783. @return the index of that string in the table
  19784. </member>
  19785. <member name="M:NPOI.HSSF.Record.SSTRecord.GetString(System.Int32)">
  19786. Get a particular string by its index
  19787. @param id index into the array of strings
  19788. @return the desired string
  19789. </member>
  19790. <member name="M:NPOI.HSSF.Record.SSTRecord.ToString">
  19791. Return a debugging string representation
  19792. @return string representation
  19793. </member>
  19794. <member name="M:NPOI.HSSF.Record.SSTRecord.GetHashCode">
  19795. @return hashcode
  19796. </member>
  19797. <member name="M:NPOI.HSSF.Record.SSTRecord.GetStrings">
  19798. @return an iterator of the strings we hold. All instances are
  19799. UnicodeStrings
  19800. </member>
  19801. <member name="M:NPOI.HSSF.Record.SSTRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  19802. called by the class that Is responsible for writing this sucker.
  19803. Subclasses should implement this so that their data Is passed back in a
  19804. byte array.
  19805. @return size
  19806. </member>
  19807. <member name="M:NPOI.HSSF.Record.SSTRecord.CreateExtSSTRecord(System.Int32)">
  19808. Creates an extended string record based on the current contents of
  19809. the current SST record. The offset within the stream to the SST record
  19810. Is required because the extended string record points directly to the
  19811. strings in the SST record.
  19812. NOTE: THIS FUNCTION MUST ONLY BE CALLED AFTER THE SST RECORD HAS BEEN
  19813. SERIALIZED.
  19814. @param sstOffset The offset in the stream to the start of the
  19815. SST record.
  19816. @return The new SST record.
  19817. </member>
  19818. <member name="M:NPOI.HSSF.Record.SSTRecord.CalcExtSSTRecordSize">
  19819. Calculates the size in bytes of the EXTSST record as it would be if the
  19820. record was Serialized.
  19821. @return The size of the ExtSST record in bytes.
  19822. </member>
  19823. <member name="P:NPOI.HSSF.Record.SSTRecord.NumStrings">
  19824. @return number of strings
  19825. </member>
  19826. <member name="P:NPOI.HSSF.Record.SSTRecord.NumUniqueStrings">
  19827. @return number of Unique strings
  19828. </member>
  19829. <member name="P:NPOI.HSSF.Record.SSTRecord.Sid">
  19830. @return sid
  19831. </member>
  19832. <member name="P:NPOI.HSSF.Record.SSTRecord.CountStrings">
  19833. @return count of the strings we hold.
  19834. </member>
  19835. <member name="T:NPOI.HSSF.Record.SSTSerializer">
  19836. This class handles serialization of SST records. It utilizes the record processor
  19837. class write individual records. This has been refactored from the SSTRecord class.
  19838. @author Glen Stampoultzis (glens at apache.org)
  19839. </member>
  19840. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketAbsoluteOffsets">
  19841. OffSets from the beginning of the SST record (even across continuations)
  19842. </member>
  19843. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketRelativeOffsets">
  19844. OffSets relative the start of the current SST or continue record
  19845. </member>
  19846. <member name="T:NPOI.HSSF.Record.StringRecord">
  19847. Supports the STRING record structure.
  19848. @author Glen Stampoultzis (glens at apache.org)
  19849. </member>
  19850. <member name="M:NPOI.HSSF.Record.StringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19851. Constructs a String record and Sets its fields appropriately.
  19852. @param in the RecordInputstream to Read the record from
  19853. </member>
  19854. <member name="M:NPOI.HSSF.Record.StringRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  19855. called by the class that Is responsible for writing this sucker.
  19856. Subclasses should implement this so that their data Is passed back in a
  19857. byte array.
  19858. @param offset to begin writing at
  19859. @param data byte array containing instance data
  19860. @return number of bytes written
  19861. </member>
  19862. <member name="P:NPOI.HSSF.Record.StringRecord.Sid">
  19863. return the non static version of the id for this record.
  19864. </member>
  19865. <member name="P:NPOI.HSSF.Record.StringRecord.String">
  19866. @return The string represented by this record.
  19867. </member>
  19868. <member name="T:NPOI.HSSF.Record.StyleRecord">
  19869. Title: Style Record
  19870. Description: Describes a builtin to the gui or user defined style
  19871. REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  19872. @author Andrew C. Oliver (acoliver at apache dot org)
  19873. @author aviks : string fixes for UserDefined Style
  19874. @version 2.0-pre
  19875. </member>
  19876. <member name="M:NPOI.HSSF.Record.StyleRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  19877. Constructs a Style record and Sets its fields appropriately.
  19878. @param in the RecordInputstream to Read the record from
  19879. </member>
  19880. <member name="M:NPOI.HSSF.Record.StyleRecord.SetBuiltinStyle(System.Int32)">
  19881. if this is a builtin style set the number of the built in style
  19882. @param builtinStyleId style number (0-7)
  19883. </member>
  19884. <member name="P:NPOI.HSSF.Record.StyleRecord.XFIndex">
  19885. Get the actual index of the style extended format record
  19886. @see #Index
  19887. @return index of the xf record
  19888. </member>
  19889. <member name="P:NPOI.HSSF.Record.StyleRecord.Name">
  19890. Get the style's name
  19891. @return name of the style
  19892. @see #NameLength
  19893. </member>
  19894. <member name="P:NPOI.HSSF.Record.StyleRecord.OutlineStyleLevel">
  19895. Get the row or column level of the style (if builtin 1||2)
  19896. </member>
  19897. <member name="T:NPOI.HSSF.Record.CommonObjectType">
  19898. * The common object data record is used to store all common preferences for an excel object.
  19899. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  19900. * Remove the record in src/records/definitions.
  19901. * @author Glen Stampoultzis (glens at apache.org)
  19902. </member>
  19903. <member name="M:NPOI.HSSF.Record.CommonObjectDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  19904. Constructs a CommonObjectData record and Sets its fields appropriately.
  19905. @param in the RecordInputstream to Read the record from
  19906. </member>
  19907. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.DataSize">
  19908. Size of record (exluding 4 byte header)
  19909. </member>
  19910. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectType">
  19911. Get the object type field for the CommonObjectData record.
  19912. </member>
  19913. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectId">
  19914. Get the object id field for the CommonObjectData record.
  19915. </member>
  19916. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Option">
  19917. Get the option field for the CommonObjectData record.
  19918. </member>
  19919. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved1">
  19920. Get the reserved1 field for the CommonObjectData record.
  19921. </member>
  19922. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved2">
  19923. Get the reserved2 field for the CommonObjectData record.
  19924. </member>
  19925. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved3">
  19926. Get the reserved3 field for the CommonObjectData record.
  19927. </member>
  19928. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsLocked">
  19929. true if object is locked when sheet has been protected
  19930. @return the locked field value.
  19931. </member>
  19932. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsPrintable">
  19933. object appears when printed
  19934. @return the printable field value.
  19935. </member>
  19936. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoFill">
  19937. whether object uses an automatic Fill style
  19938. @return the autoFill field value.
  19939. </member>
  19940. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoline">
  19941. whether object uses an automatic line style
  19942. @return the autoline field value.
  19943. </member>
  19944. <member name="T:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord">
  19945. A sub-record within the OBJ record which stores a reference to an object
  19946. stored in a Separate entry within the OLE2 compound file.
  19947. @author Daniel Noll
  19948. </member>
  19949. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_2_refPtg">
  19950. either an area or a cell ref
  19951. </member>
  19952. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_4_unknownByte">
  19953. Formulas often have a single non-zero trailing byte.
  19954. This is in a similar position to he pre-streamId padding
  19955. It is unknown if the value is important (it seems to mirror a value a few bytes earlier)
  19956. </member>
  19957. <member name="M:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  19958. Constructs an EmbeddedObjectRef record and Sets its fields appropriately.
  19959. @param in the record input stream.
  19960. </member>
  19961. <member name="P:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.StreamId">
  19962. Gets the stream ID containing the actual data. The data itself
  19963. can be found under a top-level directory entry in the OLE2 filesystem
  19964. under the name "MBD<var>xxxxxxxx</var>" where <var>xxxxxxxx</var> is
  19965. this ID converted into hex (in big endian order, funnily enough.)
  19966. @return the data stream ID. Possibly <c>null</c>
  19967. </member>
  19968. <member name="T:NPOI.HSSF.Record.EndSubRecord">
  19969. * The end data record is used to denote the end of the subrecords.
  19970. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  19971. * Remove the record in src/records/definitions.
  19972. * @author Glen Stampoultzis (glens at apache.org)
  19973. </member>
  19974. <member name="M:NPOI.HSSF.Record.EndSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  19975. Constructs a End record and Sets its fields appropriately.
  19976. @param in the RecordInputstream to Read the record from
  19977. </member>
  19978. <member name="P:NPOI.HSSF.Record.EndSubRecord.DataSize">
  19979. Size of record (exluding 4 byte header)
  19980. </member>
  19981. <member name="T:NPOI.HSSF.Record.GroupMarkerSubRecord">
  19982. * The Group marker record is used as a position holder for Groups.
  19983. * @author Glen Stampoultzis (glens at apache.org)
  19984. </member>
  19985. <member name="M:NPOI.HSSF.Record.GroupMarkerSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  19986. Constructs a Group marker record and Sets its fields appropriately.
  19987. @param in the RecordInputstream to Read the record from
  19988. </member>
  19989. <member name="P:NPOI.HSSF.Record.GroupMarkerSubRecord.DataSize">
  19990. Size of record (exluding 4 byte header)
  19991. </member>
  19992. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cbFContinued">
  19993. From [MS-XLS].pdf 2.5.147 FtLbsData:
  19994. An unsigned integer that indirectly specifies whether
  19995. some of the data in this structure appear in a subsequent Continue record.
  19996. If _cbFContinued is 0x00, all of the fields in this structure except sid and _cbFContinued
  19997. MUST NOT exist. If this entire structure is Contained within the same record,
  19998. then _cbFContinued MUST be greater than or equal to the size, in bytes,
  19999. of this structure, not including the four bytes for the ft and _cbFContinued fields
  20000. </member>
  20001. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._unknownPreFormulaInt">
  20002. a formula that specifies the range of cell values that are the items in this list.
  20003. </member>
  20004. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cLines">
  20005. An unsigned integer that specifies the number of items in the list.
  20006. </member>
  20007. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._iSel">
  20008. An unsigned integer that specifies the one-based index of the first selected item in this list.
  20009. A value of 0x00 specifies there is no currently selected item.
  20010. </member>
  20011. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._flags">
  20012. flags that tell what data follows
  20013. </member>
  20014. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._idEdit">
  20015. An ObjId that specifies the edit box associated with this list.
  20016. A value of 0x00 specifies that there is no edit box associated with this list.
  20017. </member>
  20018. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._dropData">
  20019. An optional LbsDropData that specifies properties for this dropdown control.
  20020. This field MUST exist if and only if the Containing Obj?s cmo.ot is equal to 0x14.
  20021. </member>
  20022. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._rgLines">
  20023. An optional array of strings where each string specifies an item in the list.
  20024. The number of elements in this array, if it exists, MUST be {@link #_cLines}
  20025. </member>
  20026. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._bsels">
  20027. An optional array of bools that specifies
  20028. which items in the list are part of a multiple selection
  20029. </member>
  20030. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32,System.Int32)">
  20031. @param in the stream to read data from
  20032. @param cbFContinued the seconf short in the record header
  20033. @param cmoOt the Containing Obj's {@link CommonObjectDataSubRecord#field_1_objectType}
  20034. </member>
  20035. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.CreateAutoFilterInstance">
  20036. @return a new instance of LbsDataSubRecord to construct auto-filters
  20037. @see org.apache.poi.hssf.model.ComboboxShape#createObjRecord(org.apache.poi.hssf.usermodel.HSSFSimpleShape, int)
  20038. </member>
  20039. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.Formula">
  20040. @return the formula that specifies the range of cell values that are the items in this list.
  20041. </member>
  20042. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.NumberOfItems">
  20043. @return the number of items in the list
  20044. </member>
  20045. <member name="T:NPOI.HSSF.Record.LbsDropData">
  20046. This structure specifies properties of the dropdown list control
  20047. </member>
  20048. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_DROPDOWN">
  20049. Combo dropdown control
  20050. </member>
  20051. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_EDIT_DROPDOWN">
  20052. Combo Edit dropdown control
  20053. </member>
  20054. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_SIMPLE_DROPDOWN">
  20055. Simple dropdown control (just the dropdown button)
  20056. </member>
  20057. <member name="F:NPOI.HSSF.Record.LbsDropData._wStyle">
  20058. An unsigned integer that specifies the style of this dropdown.
  20059. </member>
  20060. <member name="F:NPOI.HSSF.Record.LbsDropData._cLine">
  20061. An unsigned integer that specifies the number of lines to be displayed in the dropdown.
  20062. </member>
  20063. <member name="F:NPOI.HSSF.Record.LbsDropData._dxMin">
  20064. An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window
  20065. </member>
  20066. <member name="F:NPOI.HSSF.Record.LbsDropData._str">
  20067. a string that specifies the current string value in the dropdown
  20068. </member>
  20069. <member name="F:NPOI.HSSF.Record.LbsDropData._unused">
  20070. Optional, undefined and MUST be ignored.
  20071. This field MUST exist if and only if the size of str in bytes is an odd number
  20072. </member>
  20073. <member name="T:NPOI.HSSF.Record.NoteStructureSubRecord">
  20074. Represents a NoteStructure (0xD) sub record.
  20075. The docs say nothing about it. The Length of this record is always 26 bytes.
  20076. @author Yegor Kozlov
  20077. </member>
  20078. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor">
  20079. Construct a new <c>NoteStructureSubRecord</c> and
  20080. Fill its data with the default values
  20081. </member>
  20082. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  20083. Constructs a NoteStructureSubRecord and Sets its fields appropriately.
  20084. </member>
  20085. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.ToString">
  20086. Convert this record to string.
  20087. Used by BiffViewer and other utulities.
  20088. </member>
  20089. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  20090. Serialize the record data into the supplied array of bytes
  20091. @param offset offset in the <c>data</c>
  20092. @param data the data to Serialize into
  20093. @return size of the record
  20094. </member>
  20095. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.DataSize">
  20096. Size of record
  20097. </member>
  20098. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.Sid">
  20099. @return id of this record.
  20100. </member>
  20101. <member name="T:NPOI.HSSF.Record.ScrollableObjectSubRecord">
  20102. <summary>
  20103. FtSbs structure
  20104. </summary>
  20105. </member>
  20106. <member name="T:NPOI.HSSF.Record.SupBookRecord">
  20107. Title: Sup Book (EXTERNALBOOK)
  20108. Description: A External Workbook Description (Suplemental Book)
  20109. Its only a dummy record for making new ExternSheet Record
  20110. REFERENCE: 5.38
  20111. @author Libin Roman (Vista Portal LDT. Developer)
  20112. @author Andrew C. Oliver (acoliver@apache.org)
  20113. </member>
  20114. <member name="M:NPOI.HSSF.Record.SupBookRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20115. Constructs a Extern Sheet record and Sets its fields appropriately.
  20116. @param id id must be 0x16 or an exception will be throw upon validation
  20117. @param size the size of the data area of the record
  20118. @param data data of the record (should not contain sid/len)
  20119. </member>
  20120. <member name="T:NPOI.HSSF.Record.TabIdRecord">
  20121. Title: Sheet Tab Index Array Record
  20122. Description: Contains an array of sheet id's. Sheets always keep their ID
  20123. regardless of what their name Is.
  20124. REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20125. @author Andrew C. Oliver (acoliver at apache dot org)
  20126. @version 2.0-pre
  20127. </member>
  20128. <member name="M:NPOI.HSSF.Record.TabIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20129. Constructs a TabID record and Sets its fields appropriately.
  20130. @param in the RecordInputstream to Read the record from
  20131. </member>
  20132. <member name="M:NPOI.HSSF.Record.TabIdRecord.SetTabIdArray(System.Int16[])">
  20133. Set the tab array. (0,1,2).
  20134. @param array of tab id's {0,1,2}
  20135. </member>
  20136. <member name="M:NPOI.HSSF.Record.TabIdRecord.ToString">
  20137. Get the tab array. (0,1,2).
  20138. @return array of tab id's {0,1,2}
  20139. </member>
  20140. <member name="T:NPOI.HSSF.Record.TableRecord">
  20141. DATATABLE (0x0236)<p/>
  20142. TableRecord - The record specifies a data table.
  20143. This record Is preceded by a single Formula record that
  20144. defines the first cell in the data table, which should
  20145. only contain a single Ptg, {@link TblPtg}.
  20146. See p536 of the June 08 binary docs
  20147. </member>
  20148. <member name="T:NPOI.HSSF.Record.TableStylesRecord">
  20149. TABLESTYLES (0x088E)<br/>
  20150. @author Patrick Cheng
  20151. </member>
  20152. <member name="F:NPOI.HSSF.Record.TextObjectRecord._linkRefPtg">
  20153. expect tRef, tRef3D, tArea, tArea3D or tName
  20154. </member>
  20155. <member name="F:NPOI.HSSF.Record.TextObjectRecord._unknownPostFormulaByte">
  20156. Not clear if needed . Excel seems to be OK if this byte is not present.
  20157. Value is often the same as the earlier firstColumn byte.
  20158. </member>
  20159. <member name="P:NPOI.HSSF.Record.TextObjectRecord.TextOrientation">
  20160. Get the text orientation field for the TextObjectBase record.
  20161. @return a TextOrientation
  20162. </member>
  20163. <member name="P:NPOI.HSSF.Record.TextObjectRecord.HorizontalTextAlignment">
  20164. @return the Horizontal text alignment field value.
  20165. </member>
  20166. <member name="P:NPOI.HSSF.Record.TextObjectRecord.VerticalTextAlignment">
  20167. @return the Vertical text alignment field value.
  20168. </member>
  20169. <member name="P:NPOI.HSSF.Record.TextObjectRecord.IsTextLocked">
  20170. Text has been locked
  20171. @return the text locked field value.
  20172. </member>
  20173. <member name="T:NPOI.HSSF.Record.TopMarginRecord">
  20174. Record for the top margin.
  20175. NOTE: This source was automatically generated.
  20176. @author Shawn Laubach (slaubach at apache dot org)
  20177. </member>
  20178. <member name="M:NPOI.HSSF.Record.TopMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20179. Constructs a TopMargin record and Sets its fields appropriately.
  20180. @param in the RecordInputstream to Read the record from
  20181. </member>
  20182. <member name="P:NPOI.HSSF.Record.TopMarginRecord.Margin">
  20183. Get the margin field for the TopMargin record.
  20184. </member>
  20185. <member name="T:NPOI.HSSF.Record.UncalcedRecord">
  20186. Title: Uncalced Record
  20187. If this record occurs in the Worksheet Substream, it indicates that the formulas have not
  20188. been recalculated before the document was saved.
  20189. @author Olivier Leprince
  20190. </member>
  20191. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor">
  20192. Default constructor
  20193. </member>
  20194. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20195. Read constructor
  20196. </member>
  20197. <member name="T:NPOI.HSSF.Record.UnknownRecord">
  20198. Title: Unknown Record (for debugging)
  20199. Description: Unknown record just tells you the sid so you can figure out
  20200. what records you are missing. Also helps us Read/modify sheets we
  20201. don't know all the records to. (HSSF leaves these alone!)
  20202. Company: SuperLink Software, Inc.
  20203. @author Andrew C. Oliver (acoliver at apache dot org)
  20204. @author Jason Height (jheight at chariot dot net dot au)
  20205. @author Glen Stampoultzis (glens at apache.org)
  20206. </member>
  20207. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(System.Int32,System.Byte[])">
  20208. @param id id of the record -not Validated, just stored for serialization
  20209. @param data the data
  20210. </member>
  20211. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20212. construct an Unknown record. No fields are interperated and the record will
  20213. be Serialized in its original form more or less
  20214. @param in the RecordInputstream to Read the record from
  20215. </member>
  20216. <member name="M:NPOI.HSSF.Record.UnknownRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  20217. spit the record out AS IS. no interpretation or identification
  20218. </member>
  20219. <member name="M:NPOI.HSSF.Record.UnknownRecord.ToString">
  20220. print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
  20221. </member>
  20222. <member name="M:NPOI.HSSF.Record.UnknownRecord.GetBiffName(System.Int32)">
  20223. These BIFF record types are known but still uninterpreted by POI
  20224. @return the documented name of this BIFF record type, <code>null</code> if unknown to POI
  20225. </member>
  20226. <member name="M:NPOI.HSSF.Record.UnknownRecord.IsObservedButUnknown(System.Int32)">
  20227. @return <c>true</c> if the unknown record id has been observed in POI unit tests
  20228. </member>
  20229. <member name="M:NPOI.HSSF.Record.UnknownRecord.Clone">
  20230. Unlike the other Record.Clone methods this Is a shallow Clone
  20231. </member>
  20232. <member name="T:NPOI.HSSF.Record.UserSViewBegin">
  20233. The UserSViewBegin record specifies Settings for a custom view associated with the sheet.
  20234. This record also marks the start of custom view records, which save custom view Settings.
  20235. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view,
  20236. not Settings for the sheet itself.
  20237. @author Yegor Kozlov
  20238. </member>
  20239. <member name="M:NPOI.HSSF.Record.UserSViewBegin.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20240. construct an UserSViewBegin record. No fields are interpreted and the record will
  20241. be Serialized in its original form more or less
  20242. @param in the RecordInputstream to read the record from
  20243. </member>
  20244. <member name="M:NPOI.HSSF.Record.UserSViewBegin.Serialize(NPOI.Util.ILittleEndianOutput)">
  20245. spit the record out AS IS. no interpretation or identification
  20246. </member>
  20247. <member name="P:NPOI.HSSF.Record.UserSViewBegin.Guid">
  20248. @return Globally unique identifier for the custom view
  20249. </member>
  20250. <member name="T:NPOI.HSSF.Record.UserSViewEnd">
  20251. The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet
  20252. @author Yegor Kozlov
  20253. </member>
  20254. <member name="M:NPOI.HSSF.Record.UserSViewEnd.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20255. construct an UserSViewEnd record. No fields are interpreted and the record will
  20256. be Serialized in its original form more or less
  20257. @param in the RecordInputstream to read the record from
  20258. </member>
  20259. <member name="M:NPOI.HSSF.Record.UserSViewEnd.Serialize(NPOI.Util.ILittleEndianOutput)">
  20260. spit the record out AS IS. no interpretation or identification
  20261. </member>
  20262. <member name="T:NPOI.HSSF.Record.UseSelFSRecord">
  20263. Title: Use Natural Language Formulas Flag
  20264. Description: Tells the GUI if this was written by something that can use
  20265. "natural language" formulas. HSSF can't.
  20266. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20267. @author Andrew C. Oliver (acoliver at apache dot org)
  20268. @version 2.0-pre
  20269. </member>
  20270. <member name="M:NPOI.HSSF.Record.UseSelFSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20271. Constructs a UseSelFS record and Sets its fields appropriately.
  20272. @param in the RecordInputstream to Read the record from
  20273. </member>
  20274. <member name="T:NPOI.HSSF.Record.VCenterRecord">
  20275. Title: VCenter record
  20276. Description: tells whether to center the sheet between vertical margins
  20277. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20278. @author Andrew C. Oliver (acoliver at apache dot org)
  20279. @author Jason Height (jheight at chariot dot net dot au)
  20280. @version 2.0-pre
  20281. </member>
  20282. <member name="M:NPOI.HSSF.Record.VCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20283. Constructs a VCENTER record and Sets its fields appropriately.
  20284. @param in the RecordInputstream to Read the record from
  20285. </member>
  20286. <member name="P:NPOI.HSSF.Record.VCenterRecord.VCenter">
  20287. Get whether to center vertically or not
  20288. @return vcenter or not
  20289. </member>
  20290. <member name="T:NPOI.HSSF.Record.VerticalPageBreakRecord">
  20291. VerticalPageBreak record that stores page breaks at columns
  20292. This class Is just used so that SID Compares work properly in the RecordFactory
  20293. @see PageBreakRecord
  20294. @author Danny Mui (dmui at apache dot org)
  20295. </member>
  20296. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor">
  20297. </member>
  20298. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20299. @param in the RecordInputstream to Read the record from
  20300. </member>
  20301. <member name="T:NPOI.HSSF.Record.WindowOneRecord">
  20302. Title: Window1 Record
  20303. Description: Stores the attributes of the workbook window. This Is basically
  20304. so the gui knows how big to make the window holding the spReadsheet
  20305. document.
  20306. REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20307. @author Andrew C. Oliver (acoliver at apache dot org)
  20308. @version 2.0-pre
  20309. </member>
  20310. <member name="M:NPOI.HSSF.Record.WindowOneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20311. Constructs a WindowOne record and Sets its fields appropriately.
  20312. @param in the RecordInputstream to Read the record from
  20313. </member>
  20314. <member name="P:NPOI.HSSF.Record.WindowOneRecord.HorizontalHold">
  20315. Get the horizontal position of the window (in 1/20ths of a point)
  20316. @return h - horizontal location
  20317. </member>
  20318. <member name="P:NPOI.HSSF.Record.WindowOneRecord.VerticalHold">
  20319. Get the vertical position of the window (in 1/20ths of a point)
  20320. @return v - vertical location
  20321. </member>
  20322. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Width">
  20323. Get the width of the window
  20324. @return width
  20325. </member>
  20326. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Height">
  20327. Get the height of the window
  20328. @return height
  20329. </member>
  20330. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Options">
  20331. Get the options bitmask (see bit Setters)
  20332. @return o - the bitmask
  20333. </member>
  20334. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Hidden">
  20335. Get whether the window Is hidden or not
  20336. @return Ishidden or not
  20337. </member>
  20338. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Iconic">
  20339. Get whether the window has been iconized or not
  20340. @return iconize or not
  20341. </member>
  20342. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayHorizontalScrollbar">
  20343. Get whether to Display the horizontal scrollbar or not
  20344. @return Display or not
  20345. </member>
  20346. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayVerticalScrollbar">
  20347. Get whether to Display the vertical scrollbar or not
  20348. @return Display or not
  20349. </member>
  20350. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayTabs">
  20351. Get whether to Display the tabs or not
  20352. @return Display or not
  20353. </member>
  20354. <member name="P:NPOI.HSSF.Record.WindowOneRecord.ActiveSheetIndex">
  20355. @return the index of the currently Displayed sheet
  20356. </member>
  20357. <member name="P:NPOI.HSSF.Record.WindowOneRecord.SelectedTab">
  20358. deprecated May 2008
  20359. @deprecated - Misleading name - use GetActiveSheetIndex()
  20360. </member>
  20361. <member name="P:NPOI.HSSF.Record.WindowOneRecord.FirstVisibleTab">
  20362. @return the first visible sheet in the worksheet tab-bar.
  20363. I.E. the scroll position of the tab-bar.
  20364. </member>
  20365. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayedTab">
  20366. deprecated May 2008
  20367. @deprecated - Misleading name - use GetFirstVisibleTab()
  20368. </member>
  20369. <member name="P:NPOI.HSSF.Record.WindowOneRecord.NumSelectedTabs">
  20370. Get the number of selected tabs
  20371. @return number of tabs
  20372. </member>
  20373. <member name="P:NPOI.HSSF.Record.WindowOneRecord.TabWidthRatio">
  20374. ratio of the width of the tabs to the horizontal scrollbar
  20375. @return ratio
  20376. </member>
  20377. <member name="T:NPOI.HSSF.Record.WindowProtectRecord">
  20378. Title: Window Protect Record
  20379. Description: flags whether workbook windows are protected
  20380. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20381. @author Andrew C. Oliver (acoliver at apache dot org)
  20382. @version 2.0-pre
  20383. </member>
  20384. <member name="M:NPOI.HSSF.Record.WindowProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20385. Constructs a WindowProtect record and Sets its fields appropriately.
  20386. @param in the RecordInputstream to Read the record from
  20387. </member>
  20388. <member name="P:NPOI.HSSF.Record.WindowProtectRecord.Protect">
  20389. Is this window protected or not
  20390. @return protected or not
  20391. </member>
  20392. <member name="T:NPOI.HSSF.Record.WindowTwoRecord">
  20393. Title: Window Two Record
  20394. Description: sheet window Settings
  20395. REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20396. @author Andrew C. Oliver (acoliver at apache dot org)
  20397. @author Jason Height (jheight at chariot dot net dot au)
  20398. @version 2.0-pre
  20399. </member>
  20400. <member name="M:NPOI.HSSF.Record.WindowTwoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20401. Constructs a WindowTwo record and Sets its fields appropriately.
  20402. @param in the RecordInputstream to Read the record from
  20403. </member>
  20404. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Options">
  20405. Get the options bitmask or just use the bit Setters.
  20406. @return options
  20407. </member>
  20408. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayFormulas">
  20409. Get whether the window should Display formulas
  20410. @return formulas or not
  20411. </member>
  20412. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGridlines">
  20413. Get whether the window should Display gridlines
  20414. @return gridlines or not
  20415. </member>
  20416. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayRowColHeadings">
  20417. Get whether the window should Display row and column headings
  20418. @return headings or not
  20419. </member>
  20420. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanes">
  20421. Get whether the window should freeze panes
  20422. @return freeze panes or not
  20423. </member>
  20424. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayZeros">
  20425. Get whether the window should Display zero values
  20426. @return zeros or not
  20427. </member>
  20428. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DefaultHeader">
  20429. Get whether the window should Display a default header
  20430. @return header or not
  20431. </member>
  20432. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Arabic">
  20433. Is this arabic?
  20434. @return arabic or not
  20435. </member>
  20436. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGuts">
  20437. Get whether the outline symbols are displaed
  20438. @return symbols or not
  20439. </member>
  20440. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanesNoSplit">
  20441. freeze Unsplit panes or not
  20442. @return freeze or not
  20443. </member>
  20444. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsSelected">
  20445. sheet tab Is selected
  20446. @return selected or not
  20447. </member>
  20448. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsActive">
  20449. Is the sheet currently Displayed in the window
  20450. @return Displayed or not
  20451. </member>
  20452. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Paged">
  20453. deprecated May 2008
  20454. @deprecated use IsActive()
  20455. </member>
  20456. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.SavedInPageBreakPreview">
  20457. was the sheet saved in page break view
  20458. @return pagebreaksaved or not
  20459. </member>
  20460. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.TopRow">
  20461. Get the top row visible in the window
  20462. @return toprow
  20463. </member>
  20464. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.LeftCol">
  20465. Get the leftmost column Displayed in the window
  20466. @return leftmost
  20467. </member>
  20468. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.HeaderColor">
  20469. Get the palette index for the header color
  20470. @return color
  20471. </member>
  20472. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.PageBreakZoom">
  20473. zoom magification in page break view
  20474. @return zoom
  20475. </member>
  20476. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.NormalZoom">
  20477. Get the zoom magnification in normal view
  20478. @return zoom
  20479. </member>
  20480. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Reserved">
  20481. Get the reserved bits - why would you do this?
  20482. @return reserved stuff -probably garbage
  20483. </member>
  20484. <member name="T:NPOI.HSSF.Record.WriteAccessRecord">
  20485. Title: Write Access Record
  20486. Description: Stores the username of that who owns the spReadsheet generator
  20487. (on Unix the user's login, on Windoze its the name you typed when
  20488. you installed the thing)
  20489. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20490. @author Andrew C. Oliver (acoliver at apache dot org)
  20491. @version 2.0-pre
  20492. </member>
  20493. <member name="F:NPOI.HSSF.Record.WriteAccessRecord.PADDING">
  20494. this record is always padded to a constant length
  20495. </member>
  20496. <member name="M:NPOI.HSSF.Record.WriteAccessRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20497. Constructs a WriteAccess record and Sets its fields appropriately.
  20498. @param in the RecordInputstream to Read the record from
  20499. </member>
  20500. <member name="P:NPOI.HSSF.Record.WriteAccessRecord.Username">
  20501. Get the username for the user that Created the report. HSSF uses the logged in user. On
  20502. natively Created M$ Excel sheet this would be the name you typed in when you installed it
  20503. in most cases.
  20504. @return username of the user who Is logged in (probably "tomcat" or "apache")
  20505. </member>
  20506. <member name="T:NPOI.HSSF.Record.WriteProtectRecord">
  20507. Title: Write Protect Record
  20508. Description: Indicated that the sheet/workbook Is Write protected.
  20509. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20510. @version 3.0-pre
  20511. </member>
  20512. <member name="M:NPOI.HSSF.Record.WriteProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20513. Constructs a WriteAccess record and Sets its fields appropriately.
  20514. @param in the RecordInputstream to Read the record from
  20515. </member>
  20516. <member name="T:NPOI.HSSF.Record.WSBoolRecord">
  20517. Title: WSBool Record.
  20518. Description: stores workbook Settings (aka its a big "everything we didn't
  20519. put somewhere else")
  20520. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  20521. @author Andrew C. Oliver (acoliver at apache dot org)
  20522. @author Glen Stampoultzis (gstamp@iprimus.com.au)
  20523. @author Jason Height (jheight at chariot dot net dot au)
  20524. @version 2.0-pre
  20525. </member>
  20526. <member name="M:NPOI.HSSF.Record.WSBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20527. Constructs a WSBool record and Sets its fields appropriately.
  20528. @param in the RecordInputstream to Read the record from
  20529. </member>
  20530. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool1">
  20531. Get first byte (see bit Getters)
  20532. </member>
  20533. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Autobreaks">
  20534. <summary>
  20535. Whether to show automatic page breaks or not
  20536. </summary>
  20537. </member>
  20538. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Dialog">
  20539. <summary>
  20540. Whether sheet is a dialog sheet or not
  20541. </summary>
  20542. </member>
  20543. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsBelow">
  20544. <summary>
  20545. Get if row summaries appear below detail in the outline
  20546. </summary>
  20547. </member>
  20548. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsRight">
  20549. <summary>
  20550. Get if col summaries appear right of the detail in the outline
  20551. </summary>
  20552. </member>
  20553. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool2">
  20554. <summary>
  20555. Get the second byte (see bit Getters)
  20556. </summary>
  20557. </member>
  20558. <member name="P:NPOI.HSSF.Record.WSBoolRecord.FitToPage">
  20559. <summary>
  20560. fit to page option is on
  20561. </summary>
  20562. </member>
  20563. <member name="P:NPOI.HSSF.Record.WSBoolRecord.DisplayGuts">
  20564. <summary>
  20565. Whether to display the guts or not
  20566. </summary>
  20567. </member>
  20568. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateExpression">
  20569. <summary>
  20570. whether alternate expression evaluation is on
  20571. </summary>
  20572. </member>
  20573. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateFormula">
  20574. <summary>
  20575. whether alternative formula entry is on
  20576. </summary>
  20577. </member>
  20578. <member name="T:NPOI.HSSF.UserModel.HSSFChart">
  20579. Has methods for construction of a chart object.
  20580. @author Glen Stampoultzis (glens at apache.org)
  20581. </member>
  20582. <member name="M:NPOI.HSSF.UserModel.HSSFChart.CreateBarChart(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet)">
  20583. Creates a bar chart. API needs some work. :)
  20584. NOTE: Does not yet work... checking it in just so others
  20585. can take a look.
  20586. </member>
  20587. <member name="M:NPOI.HSSF.UserModel.HSSFChart.GetSheetCharts(NPOI.HSSF.UserModel.HSSFSheet)">
  20588. Returns all the charts for the given sheet.
  20589. NOTE: You won't be able to do very much with
  20590. these charts yet, as this is very limited support
  20591. </member>
  20592. <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})">
  20593. Set value range (basic Axis Options)
  20594. @param axisIndex 0 - primary axis, 1 - secondary axis
  20595. @param minimum minimum value; Double.NaN - automatic; null - no change
  20596. @param maximum maximum value; Double.NaN - automatic; null - no change
  20597. @param majorUnit major unit value; Double.NaN - automatic; null - no change
  20598. @param minorUnit minor unit value; Double.NaN - automatic; null - no change
  20599. </member>
  20600. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartX">
  20601. Get the X offset of the chart
  20602. </member>
  20603. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartY">
  20604. Get the Y offset of the chart
  20605. </member>
  20606. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartWidth">
  20607. Get the width of the chart. {@link ChartRecord}
  20608. </member>
  20609. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartHeight">
  20610. Get the height of the chart. {@link ChartRecord}
  20611. </member>
  20612. <member name="P:NPOI.HSSF.UserModel.HSSFChart.Series">
  20613. Returns the series of the chart
  20614. </member>
  20615. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartTitle">
  20616. Returns the chart's title, if there is one,
  20617. or null if not
  20618. </member>
  20619. <member name="T:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries">
  20620. A series in a chart
  20621. </member>
  20622. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataName">
  20623. @return record with data names
  20624. </member>
  20625. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataValues">
  20626. @return record with data values
  20627. </member>
  20628. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataCategoryLabels">
  20629. @return record with data category labels
  20630. </member>
  20631. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataSecondaryCategoryLabels">
  20632. @return record with data secondary category labels
  20633. </member>
  20634. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetSeries">
  20635. @return record with series
  20636. </member>
  20637. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.ValueType">
  20638. See {@link SeriesRecord}
  20639. </member>
  20640. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.SeriesTitle">
  20641. Returns the series' title, if there is one,
  20642. or null if not
  20643. </member>
  20644. <member name="T:NPOI.HSSF.UserModel.HSSFErrorConstants">
  20645. <summary>
  20646. Contains raw Excel error codes (as defined in OOO's excelfileformat.pdf (2.5.6)
  20647. @author Michael Harhen
  20648. </summary>
  20649. </member>
  20650. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NULL">
  20651. <b>#NULL!</b> - Intersection of two cell ranges is empty
  20652. </member>
  20653. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_DIV_0">
  20654. <b>#DIV/0!</b> - Division by zero
  20655. </member>
  20656. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_VALUE">
  20657. <b>#VALUE!</b> - Wrong type of operand
  20658. </member>
  20659. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_REF">
  20660. <b>#REF!</b> - Illegal or deleted cell reference
  20661. </member>
  20662. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NAME">
  20663. <b>#NAME?</b> - Wrong function or range name
  20664. </member>
  20665. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NUM">
  20666. <b>#NUM!</b> - Value range overflow
  20667. </member>
  20668. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NA">
  20669. <b>#N/A</b> - Argument or function not available
  20670. </member>
  20671. <member name="M:NPOI.HSSF.UserModel.HSSFErrorConstants.GetText(System.Int32)">
  20672. <summary>
  20673. Gets standard Excel error literal for the specified error code.
  20674. @throws ArgumentException if the specified error code is not one of the 7
  20675. standard error codes
  20676. </summary>
  20677. <param name="errorCode">The error code.</param>
  20678. <returns></returns>
  20679. </member>
  20680. <member name="M:NPOI.HSSF.UserModel.HSSFErrorConstants.IsValidCode(System.Int32)">
  20681. <summary>
  20682. Determines whether [is valid code] [the specified error code].
  20683. </summary>
  20684. <param name="errorCode">The error code.</param>
  20685. <returns>
  20686. <c>true</c> if the specified error code is a standard Excel error code.; otherwise, <c>false</c>.
  20687. </returns>
  20688. </member>
  20689. <member name="T:NPOI.POIFS.Common.POIFSBigBlockSize">
  20690. <p>A class describing attributes of the Big Block Size</p>
  20691. </member>
  20692. <member name="M:NPOI.POIFS.Common.POIFSBigBlockSize.GetHeaderValue">
  20693. Returns the value that Gets written into the
  20694. header.
  20695. Is the power of two that corresponds to the
  20696. size of the block, eg 512 => 9
  20697. </member>
  20698. <member name="T:NPOI.POIFS.Common.POIFSConstants">
  20699. <summary>
  20700. A repository for constants shared by POI classes.
  20701. @author Marc Johnson (mjohnson at apache dot org)
  20702. </summary>
  20703. </member>
  20704. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALLER_BIG_BLOCK_SIZE">
  20705. Most files use 512 bytes as their big block size
  20706. </member>
  20707. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGER_BIG_BLOCK_SIZE">
  20708. Some use 4096 bytes
  20709. </member>
  20710. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_SIZE">
  20711. Most files use 512 bytes as their big block size
  20712. </member>
  20713. <member name="F:NPOI.POIFS.Common.POIFSConstants.MINI_BLOCK_SIZE">
  20714. Most files use 512 bytes as their big block size
  20715. </member>
  20716. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALL_BLOCK_SIZE">
  20717. How big a block in the small block stream is. Fixed size
  20718. </member>
  20719. <member name="F:NPOI.POIFS.Common.POIFSConstants.PROPERTY_SIZE">
  20720. How big a single property is
  20721. </member>
  20722. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE">
  20723. The minimum size of a document before it's stored using
  20724. Big Blocks (normal streams). Smaller documents go in the
  20725. Mini Stream (SBAT / Small Blocks)
  20726. </member>
  20727. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGEST_REGULAR_SECTOR_NUMBER">
  20728. The highest sector number you're allowed, 0xFFFFFFFA
  20729. </member>
  20730. <member name="F:NPOI.POIFS.Common.POIFSConstants.FAT_SECTOR_BLOCK">
  20731. Indicates the sector holds a FAT block (0xFFFFFFFD)
  20732. </member>
  20733. <member name="F:NPOI.POIFS.Common.POIFSConstants.DIFAT_SECTOR_BLOCK">
  20734. Indicates the sector holds a DIFAT block (0xFFFFFFFC)
  20735. </member>
  20736. <member name="F:NPOI.POIFS.Common.POIFSConstants.END_OF_CHAIN">
  20737. Indicates the sector is the end of a chain (0xFFFFFFFE)
  20738. </member>
  20739. <member name="F:NPOI.POIFS.Common.POIFSConstants.UNUSED_BLOCK">
  20740. Indicates the sector is not used (0xFFFFFFFF)
  20741. </member>
  20742. <member name="F:NPOI.POIFS.Common.POIFSConstants.OOXML_FILE_HEADER">
  20743. The first 4 bytes of an OOXML file, used in detection
  20744. </member>
  20745. <member name="T:NPOI.POIFS.Dev.POIFSViewEngine">
  20746. <summary>
  20747. This class contains methods used to inspect POIFSViewable objects
  20748. @author Marc Johnson (mjohnson at apache dot org)
  20749. </summary>
  20750. </member>
  20751. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.InspectViewable(System.Object,System.Boolean,System.Int32,System.String)">
  20752. <summary>
  20753. Inspect an object that may be viewable, and drill down if told to
  20754. </summary>
  20755. <param name="viewable">the object to be viewed</param>
  20756. <param name="drilldown">if <c>true</c> and the object implements POIFSViewable, inspect the objects' contents</param>
  20757. <param name="indentLevel">how far in to indent each string</param>
  20758. <param name="indentString">string to use for indenting</param>
  20759. <returns>a List of Strings holding the content</returns>
  20760. </member>
  20761. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.Indent(System.Int32,System.String,System.String)">
  20762. <summary>
  20763. Indents the specified indent level.
  20764. </summary>
  20765. <param name="indentLevel">how far in to indent each string</param>
  20766. <param name="indentString">string to use for indenting</param>
  20767. <param name="data">The data.</param>
  20768. <returns></returns>
  20769. </member>
  20770. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReader">
  20771. <summary>
  20772. An event-driven Reader for POIFS file systems. Users of this class
  20773. first Create an instance of it, then use the RegisterListener
  20774. methods to Register POIFSReaderListener instances for specific
  20775. documents. Once all the listeners have been Registered, the Read()
  20776. method is called, which results in the listeners being notified as
  20777. their documents are Read.
  20778. @author Marc Johnson (mjohnson at apache dot org)
  20779. </summary>
  20780. </member>
  20781. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.#ctor">
  20782. <summary>
  20783. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSReader"/> class.
  20784. </summary>
  20785. </member>
  20786. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.Read(System.IO.Stream)">
  20787. <summary>
  20788. Read from an InputStream and Process the documents we Get
  20789. </summary>
  20790. <param name="stream">the InputStream from which to Read the data</param>
  20791. <returns>POIFSDocument list</returns>
  20792. </member>
  20793. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  20794. Register a POIFSReaderListener for all documents
  20795. @param listener the listener to be registered
  20796. @exception NullPointerException if listener is null
  20797. @exception IllegalStateException if read() has already been
  20798. called
  20799. </member>
  20800. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,System.String)">
  20801. Register a POIFSReaderListener for a document in the root
  20802. directory
  20803. @param listener the listener to be registered
  20804. @param name the document name
  20805. @exception NullPointerException if listener is null or name is
  20806. null or empty
  20807. @exception IllegalStateException if read() has already been
  20808. called
  20809. </member>
  20810. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20811. Register a POIFSReaderListener for a document in the specified
  20812. directory
  20813. @param listener the listener to be registered
  20814. @param path the document path; if null, the root directory is
  20815. assumed
  20816. @param name the document name
  20817. @exception NullPointerException if listener is null or name is
  20818. null or empty
  20819. @exception IllegalStateException if read() has already been
  20820. called
  20821. </member>
  20822. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.ProcessProperties(NPOI.POIFS.Storage.BlockList,NPOI.POIFS.Storage.BlockList,System.Collections.IEnumerator,NPOI.POIFS.FileSystem.POIFSDocumentPath)">
  20823. <summary>
  20824. Processes the properties.
  20825. </summary>
  20826. <param name="small_blocks">The small_blocks.</param>
  20827. <param name="big_blocks">The big_blocks.</param>
  20828. <param name="properties">The properties.</param>
  20829. <param name="path">The path.</param>
  20830. <returns></returns>
  20831. </member>
  20832. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEvent">
  20833. Class POIFSReaderEvent
  20834. @author Marc Johnson (mjohnson at apache dot org)
  20835. @version %I%, %G%
  20836. </member>
  20837. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.#ctor(NPOI.POIFS.FileSystem.DocumentInputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20838. package scoped constructor
  20839. @param stream the DocumentInputStream, freshly opened
  20840. @param path the path of the document
  20841. @param documentName the name of the document
  20842. </member>
  20843. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Stream">
  20844. @return the DocumentInputStream, freshly opened
  20845. </member>
  20846. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Path">
  20847. @return the document's path
  20848. </member>
  20849. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Name">
  20850. @return the document's name
  20851. </member>
  20852. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEventArgs">
  20853. <summary>
  20854. EventArgs for POIFSReader
  20855. author: Tony Qu
  20856. </summary>
  20857. </member>
  20858. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderListener">
  20859. Interface POIFSReaderListener
  20860. @author Marc Johnson (mjohnson at apache dot org)
  20861. @version %I%, %G%
  20862. </member>
  20863. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderListener.ProcessPOIFSReaderEvent(NPOI.POIFS.EventFileSystem.POIFSReaderEvent)">
  20864. Process a POIFSReaderEvent that this listener had Registered
  20865. for
  20866. @param event the POIFSReaderEvent
  20867. </member>
  20868. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry">
  20869. A registry for POIFSReaderListeners and the DocumentDescriptors of
  20870. the documents those listeners are interested in
  20871. @author Marc Johnson (mjohnson at apache dot org)
  20872. @version %I%, %G%
  20873. </member>
  20874. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.#ctor">
  20875. Construct the registry
  20876. </member>
  20877. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20878. Register a POIFSReaderListener for a particular document
  20879. @param listener the listener
  20880. @param path the path of the document of interest
  20881. @param documentName the name of the document of interest
  20882. </member>
  20883. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  20884. Register for all documents
  20885. @param listener the listener who wants to Get all documents
  20886. </member>
  20887. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.GetListeners(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  20888. Get am iterator of listeners for a particular document
  20889. @param path the document path
  20890. @param name the name of the document
  20891. @return an Iterator POIFSReaderListeners; may be empty
  20892. </member>
  20893. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell">
  20894. Represents a cell being used for forked Evaluation that has had a value Set different from the
  20895. corresponding cell in the shared master workbook.
  20896. @author Josh Micich
  20897. </member>
  20898. <member name="T:NPOI.SS.Formula.IEvaluationCell">
  20899. Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
  20900. and non-formula cells.<br/>
  20901. Implementors of this class must implement {@link #HashCode()} and {@link #Equals(Object)}
  20902. To provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
  20903. For POI internal use only
  20904. @author Josh Micich
  20905. </member>
  20906. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell._masterCell">
  20907. corresponding cell from master workbook
  20908. </member>
  20909. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet">
  20910. Represents a sheet being used for forked Evaluation. Initially, objects of this class contain
  20911. only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)},
  20912. the master cell object is logically Replaced with a {@link ForkedEvaluationCell} instance, which
  20913. will be used in all subsequent Evaluations.
  20914. @author Josh Micich
  20915. </member>
  20916. <member name="T:NPOI.SS.Formula.IEvaluationSheet">
  20917. Abstracts a sheet for the purpose of formula evaluation.<br/>
  20918. For POI internal use only
  20919. @author Josh Micich
  20920. </member>
  20921. <member name="M:NPOI.SS.Formula.IEvaluationSheet.GetCell(System.Int32,System.Int32)">
  20922. @return <c>null</c> if there is no cell at the specified coordinates
  20923. </member>
  20924. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet._sharedCellsByRowCol">
  20925. Only cells which have been split are Put in this map. (This has been done to conserve memory).
  20926. </member>
  20927. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationWorkbook">
  20928. Represents a workbook being used for forked Evaluation. Most operations are delegated to the
  20929. shared master workbook, except those that potentially involve cell values that may have been
  20930. updated After a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
  20931. @author Josh Micich
  20932. </member>
  20933. <member name="T:NPOI.SS.Formula.IEvaluationWorkbook">
  20934. Abstracts a workbook for the purpose of formula evaluation.<br/>
  20935. For POI internal use only
  20936. @author Josh Micich
  20937. </member>
  20938. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetSheetIndex(NPOI.SS.Formula.IEvaluationSheet)">
  20939. @return -1 if the specified sheet is from a different book
  20940. </member>
  20941. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.Int32)">
  20942. @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
  20943. </member>
  20944. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator">
  20945. An alternative workbook Evaluator that saves memory in situations where a single workbook is
  20946. concurrently and independently Evaluated many times. With standard formula Evaluation, around
  20947. 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link NPOI.xssf.usermodel.XSSFWorkbook}.
  20948. This class enables a 'master workbook' to be loaded just once and shared between many Evaluation
  20949. clients. Each Evaluation client Creates its own {@link ForkedEvaluator} and can Set cell values
  20950. that will be used for local Evaluations (and don't disturb Evaluations on other Evaluators).
  20951. @author Josh Micich
  20952. </member>
  20953. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  20954. @deprecated (Sep 2009) (reduce overloading) use {@link #Create(Workbook, IStabilityClassifier, UDFFinder)}
  20955. </member>
  20956. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  20957. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  20958. </member>
  20959. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.UpdateCell(System.String,System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  20960. Sets the specified cell to the supplied <tt>value</tt>
  20961. @param sheetName the name of the sheet Containing the cell
  20962. @param rowIndex zero based
  20963. @param columnIndex zero based
  20964. </member>
  20965. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.CopyUpdatedCells(NPOI.SS.UserModel.IWorkbook)">
  20966. Copies the values of all updated cells (modified by calls to {@link
  20967. #updateCell(String, int, int, ValueEval)}) to the supplied <tt>workbook</tt>.<br/>
  20968. Typically, the supplied <tt>workbook</tt> is a writable copy of the 'master workbook',
  20969. but at the very least it must contain sheets with the same names.
  20970. </member>
  20971. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Evaluate(System.String,System.Int32,System.Int32)">
  20972. If cell Contains a formula, the formula is Evaluated and returned,
  20973. else the CellValue simply copies the appropriate cell value from
  20974. the cell and also its cell type. This method should be preferred over
  20975. EvaluateInCell() when the call should not modify the contents of the
  20976. original cell.
  20977. @param sheetName the name of the sheet Containing the cell
  20978. @param rowIndex zero based
  20979. @param columnIndex zero based
  20980. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  20981. </member>
  20982. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.Eval.Forked.ForkedEvaluator[])">
  20983. Coordinates several formula Evaluators together so that formulas that involve external
  20984. references can be Evaluated.
  20985. @param workbookNames the simple file names used to identify the workbooks in formulas
  20986. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  20987. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  20988. </member>
  20989. <member name="T:NPOI.SS.Formula.Functions.Iserr">
  20990. contribute by Pavel Egorov
  20991. https://github.com/xoposhiy/npoi/commit/27b34a2389030c7115a666ace65daafda40d61af
  20992. </member>
  20993. <member name="T:NPOI.SS.Formula.Functions.LogicalFunction">
  20994. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  20995. </member>
  20996. <member name="M:NPOI.SS.Formula.Functions.LogicalFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval)">
  20997. @param arg any {@link ValueEval}, potentially {@link BlankEval} or {@link ErrorEval}.
  20998. </member>
  20999. <member name="T:NPOI.SS.Formula.PTG.SharedFormula">
  21000. Encapsulates logic to convert shared formulaa into non shared equivalent
  21001. </member>
  21002. <member name="M:NPOI.SS.Formula.PTG.SharedFormula.ConvertSharedFormulas(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  21003. Creates a non shared formula from the shared formula counterpart, i.e.
  21004. Converts the shared formula into the equivalent {@link org.apache.poi.ss.formula.ptg.Ptg} array that it would have,
  21005. were it not shared.
  21006. @param ptgs parsed tokens of the shared formula
  21007. @param formulaRow
  21008. @param formulaColumn
  21009. </member>
  21010. <member name="F:NPOI.SS.UserModel.BorderDiagonal.None">
  21011. <summary>
  21012. No diagional border
  21013. </summary>
  21014. </member>
  21015. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Backward">
  21016. <summary>
  21017. Backward diagional border, from left-top to right-bottom
  21018. </summary>
  21019. </member>
  21020. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Forward">
  21021. <summary>
  21022. Forward diagional border, from right-top to left-bottom
  21023. </summary>
  21024. </member>
  21025. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Both">
  21026. <summary>
  21027. Both forward and backward diagional border
  21028. </summary>
  21029. </member>
  21030. <member name="M:NPOI.SS.UserModel.Charts.IChartDataSource`1.GetPointAt(System.Int32)">
  21031. Returns point value at specified index.
  21032. @param index index to value from
  21033. @return point value at specified index.
  21034. @throws {@code IndexOutOfBoundsException} if index
  21035. parameter not in range {@code 0 &lt;= index &lt;= pointCount}
  21036. </member>
  21037. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.PointCount">
  21038. Return number of points contained by data source.
  21039. @return number of points contained by data source
  21040. </member>
  21041. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsReference">
  21042. Returns {@code true} if charts data source is valid cell range.
  21043. @return {@code true} if charts data source is valid cell range
  21044. </member>
  21045. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsNumeric">
  21046. Returns {@code true} if data source points should be treated as numbers.
  21047. @return {@code true} if data source points should be treated as numbers
  21048. </member>
  21049. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.FormulaString">
  21050. Returns formula representation of the data source. It is only applicable
  21051. for data source that is valid cell range.
  21052. @return formula representation of the data source
  21053. @throws {@code UnsupportedOperationException} if the data source is not a
  21054. reference.
  21055. </member>
  21056. <member name="T:NPOI.SS.UserModel.FontUnderline">
  21057. the different types of possible underline formatting
  21058. @author Gisella Bronzetti
  21059. </member>
  21060. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE">
  21061. Single-line underlining under each character in the cell.
  21062. The underline is drawn through the descenders of
  21063. characters such as g and p..
  21064. </member>
  21065. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE">
  21066. Double-line underlining under each character in the
  21067. cell. underlines are drawn through the descenders of
  21068. characters such as g and p.
  21069. </member>
  21070. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE_ACCOUNTING">
  21071. Single-line accounting underlining under each
  21072. character in the cell. The underline is drawn under the
  21073. descenders of characters such as g and p.
  21074. </member>
  21075. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE_ACCOUNTING">
  21076. Double-line accounting underlining under each
  21077. character in the cell. The underlines are drawn under
  21078. the descenders of characters such as g and p.
  21079. </member>
  21080. <member name="F:NPOI.SS.UserModel.FontUnderline.NONE">
  21081. No underline.
  21082. </member>
  21083. <member name="T:NPOI.Util.BlockingInputStream">
  21084. Implementation of a BlockingInputStream to provide data to
  21085. RawDataBlock that expects data in 512 byte chunks. Useful to read
  21086. data from slow (ie, non FileInputStream) sources, for example when
  21087. Reading an OLE2 Document over a network.
  21088. Possible extentions: add a timeout. Curently a call to Read(byte[]) on this
  21089. class is blocking, so use at your own peril if your underlying stream blocks.
  21090. @author Jens Gerhard
  21091. @author aviks - documentation cleanups.
  21092. </member>
  21093. <member name="M:NPOI.Util.BlockingInputStream.Read(System.Byte[])">
  21094. We had to revert to byte per byte Reading to keep
  21095. with slow network connections on one hand, without
  21096. missing the end-of-file.
  21097. This is the only method that does its own thing in this class
  21098. everything else is delegated to aggregated stream.
  21099. THIS IS A BLOCKING BLOCK READ!!!
  21100. </member>
  21101. <member name="M:NPOI.Util.ByteBuffer.Remaining">
  21102. <summary>
  21103. Returns the number of elements between the current position and the limit.
  21104. </summary>
  21105. <returns>The number of elements remaining in this buffer</returns>
  21106. </member>
  21107. <member name="M:NPOI.Util.ByteBuffer.HasRemaining">
  21108. <summary>
  21109. Tells whether there are any elements between the current position and the limit.
  21110. </summary>
  21111. <returns>true if, and only if, there is at least one element remaining in this buffer</returns>
  21112. </member>
  21113. <member name="T:NPOI.POIFS.FileSystem.DirectoryNode">
  21114. <summary>
  21115. Simple implementation of DirectoryEntry
  21116. @author Marc Johnson (mjohnson at apache dot org)
  21117. </summary>
  21118. </member>
  21119. <member name="T:NPOI.POIFS.FileSystem.EntryNode">
  21120. <summary>
  21121. Abstract implementation of Entry
  21122. Extending classes should override isDocument() or isDirectory(), as
  21123. appropriate
  21124. Extending classes must override isDeleteOK()
  21125. @author Marc Johnson (mjohnson at apache dot org)
  21126. </summary>
  21127. </member>
  21128. <member name="M:NPOI.POIFS.FileSystem.EntryNode.#ctor(NPOI.POIFS.Properties.Property,NPOI.POIFS.FileSystem.DirectoryNode)">
  21129. <summary>
  21130. Create a DocumentNode. ThIs method Is not public by design; it
  21131. Is intended strictly for the internal use of extending classes
  21132. </summary>
  21133. <param name="property">the Property for this Entry</param>
  21134. <param name="parent">the parent of this entry</param>
  21135. </member>
  21136. <member name="M:NPOI.POIFS.FileSystem.EntryNode.Delete">
  21137. <summary>
  21138. Delete this Entry. ThIs operation should succeed, but there are
  21139. special circumstances when it will not:
  21140. If this Entry Is the root of the Entry tree, it cannot be
  21141. deleted, as there Is no way to Create another one.
  21142. If this Entry Is a directory, it cannot be deleted unless it Is
  21143. empty.
  21144. </summary>
  21145. <returns>
  21146. true if the Entry was successfully deleted, else false
  21147. </returns>
  21148. </member>
  21149. <member name="M:NPOI.POIFS.FileSystem.EntryNode.RenameTo(System.String)">
  21150. <summary>
  21151. Rename this Entry. ThIs operation will fail if:
  21152. There Is a sibling Entry (i.e., an Entry whose parent Is the
  21153. same as this Entry's parent) with the same name.
  21154. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  21155. by the Filesystem and many not be Changed.
  21156. </summary>
  21157. <param name="newName">the new name for this Entry</param>
  21158. <returns>
  21159. true if the operation succeeded, else false
  21160. </returns>
  21161. </member>
  21162. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Property">
  21163. <summary>
  21164. grant access to the property
  21165. </summary>
  21166. <value>the property backing this entry</value>
  21167. </member>
  21168. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsRoot">
  21169. <summary>
  21170. Is this the root of the tree?
  21171. </summary>
  21172. <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  21173. </member>
  21174. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDeleteOK">
  21175. <summary>
  21176. extensions use this method to verify internal rules regarding
  21177. deletion of the underlying store.
  21178. </summary>
  21179. <value>
  21180. <c>true</c> if it's ok to Delete the underlying store; otherwise, <c>false</c>.
  21181. </value>
  21182. </member>
  21183. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Name">
  21184. <summary>
  21185. Get the name of the Entry
  21186. </summary>
  21187. <value>The name.</value>
  21188. Get the name of the Entry
  21189. @return name
  21190. </member>
  21191. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDirectoryEntry">
  21192. <summary>
  21193. Is this a DirectoryEntry?
  21194. </summary>
  21195. <value>
  21196. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  21197. </value>
  21198. </member>
  21199. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDocumentEntry">
  21200. <summary>
  21201. Is this a DocumentEntry?
  21202. </summary>
  21203. <value>
  21204. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  21205. </value>
  21206. </member>
  21207. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Parent">
  21208. <summary>
  21209. Get this Entry's parent (the DocumentEntry that owns this
  21210. Entry). All Entry objects, except the root Entry, has a parent.
  21211. </summary>
  21212. <value>this Entry's parent; null iff this Is the root Entry</value>
  21213. </member>
  21214. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  21215. <summary>
  21216. Create a DirectoryNode. This method Is not public by design; it
  21217. Is intended strictly for the internal use of this package
  21218. </summary>
  21219. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  21220. <param name="nFileSystem">the POIFSFileSystem we belong to</param>
  21221. <param name="parent">the parent of this entry</param>
  21222. </member>
  21223. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreatePOIFSDocumentReader(System.String)">
  21224. <summary>
  21225. open a document in the directory's entry's list of entries
  21226. </summary>
  21227. <param name="documentName">the name of the document to be opened</param>
  21228. <returns>a newly opened DocumentStream</returns>
  21229. </member>
  21230. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDocument(NPOI.POIFS.FileSystem.POIFSDocument)">
  21231. <summary>
  21232. Create a new DocumentEntry; the data will be provided later
  21233. </summary>
  21234. <param name="document">the name of the new documentEntry</param>
  21235. <returns>the new DocumentEntry</returns>
  21236. </member>
  21237. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.ChangeName(System.String,System.String)">
  21238. <summary>
  21239. Change a contained Entry's name
  21240. </summary>
  21241. <param name="oldName">the original name</param>
  21242. <param name="newName">the new name</param>
  21243. <returns>true if the operation succeeded, else false</returns>
  21244. </member>
  21245. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.DeleteEntry(NPOI.POIFS.FileSystem.EntryNode)">
  21246. <summary>
  21247. Deletes the entry.
  21248. </summary>
  21249. <param name="entry">the EntryNode to be Deleted</param>
  21250. <returns>true if the entry was Deleted, else false</returns>
  21251. </member>
  21252. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.GetEntry(System.String)">
  21253. <summary>
  21254. get a specified Entry by name
  21255. </summary>
  21256. <param name="name">the name of the Entry to obtain.</param>
  21257. <returns>
  21258. the specified Entry, if it is directly contained in
  21259. this DirectoryEntry
  21260. </returns>
  21261. </member>
  21262. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDirectory(System.String)">
  21263. <summary>
  21264. Create a new DirectoryEntry
  21265. </summary>
  21266. <param name="name">the name of the new DirectoryEntry</param>
  21267. <returns>the name of the new DirectoryEntry</returns>
  21268. </member>
  21269. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Path">
  21270. <summary>
  21271. Gets the path.
  21272. </summary>
  21273. <value>this directory's path representation</value>
  21274. </member>
  21275. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Entries">
  21276. <summary>
  21277. get an iterator of the Entry instances contained directly in
  21278. this instance (in other words, children only; no grandchildren
  21279. etc.)
  21280. </summary>
  21281. <value>
  21282. The entries.never null, but hasNext() may return false
  21283. immediately (i.e., this DirectoryEntry is empty). All
  21284. objects retrieved by next() are guaranteed to be
  21285. implementations of Entry.
  21286. </value>
  21287. </member>
  21288. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsEmpty">
  21289. <summary>
  21290. is this DirectoryEntry empty?
  21291. </summary>
  21292. <value>
  21293. <c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.
  21294. </value>
  21295. </member>
  21296. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryCount">
  21297. <summary>
  21298. find out how many Entry instances are contained directly within
  21299. this DirectoryEntry
  21300. </summary>
  21301. <value>
  21302. number of immediately (no grandchildren etc.) contained
  21303. Entry instances
  21304. </value>
  21305. </member>
  21306. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.StorageClsid">
  21307. <summary>
  21308. Gets or Sets the storage clsid for the directory entry
  21309. </summary>
  21310. <value>The storage ClassID.</value>
  21311. </member>
  21312. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDirectoryEntry">
  21313. <summary>
  21314. Is this a DirectoryEntry?
  21315. </summary>
  21316. <value>true if the Entry Is a DirectoryEntry, else false</value>
  21317. </member>
  21318. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDeleteOK">
  21319. <summary>
  21320. extensions use this method to verify internal rules regarding
  21321. deletion of the underlying store.
  21322. </summary>
  21323. <value> true if it's ok to Delete the underlying store, else
  21324. false</value>
  21325. </member>
  21326. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableArray">
  21327. <summary>
  21328. Get an array of objects, some of which may implement POIFSViewable
  21329. </summary>
  21330. <value>an array of Object; may not be null, but may be empty</value>
  21331. </member>
  21332. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableIterator">
  21333. <summary>
  21334. Get an Iterator of objects, some of which may implement
  21335. POIFSViewable
  21336. </summary>
  21337. <value>an Iterator; may not be null, but may have an empty
  21338. back end store</value>
  21339. </member>
  21340. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.PreferArray">
  21341. <summary>
  21342. Give viewers a hint as to whether to call GetViewableArray or
  21343. GetViewableIterator
  21344. </summary>
  21345. <value><c>true</c> if a viewer should call GetViewableArray; otherwise, <c>false</c>if
  21346. a viewer should call GetViewableIterator</value>
  21347. </member>
  21348. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ShortDescription">
  21349. <summary>
  21350. Provides a short description of the object, to be used when a
  21351. POIFSViewable object has not provided its contents.
  21352. </summary>
  21353. <value>The short description.</value>
  21354. </member>
  21355. <member name="T:NPOI.POIFS.FileSystem.DocumentDescriptor">
  21356. <summary>
  21357. Class DocumentDescriptor
  21358. @author Marc Johnson (mjohnson at apache dot org)
  21359. </summary>
  21360. </member>
  21361. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  21362. <summary>
  21363. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentDescriptor"/> class.
  21364. </summary>
  21365. <param name="path">the Document path</param>
  21366. <param name="name">the Document name</param>
  21367. </member>
  21368. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.Equals(System.Object)">
  21369. <summary>
  21370. equality. Two DocumentDescriptor instances are equal if they
  21371. have equal paths and names
  21372. </summary>
  21373. <param name="o">the object we're checking equality for</param>
  21374. <returns>true if the object is equal to this object</returns>
  21375. </member>
  21376. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.GetHashCode">
  21377. <summary>
  21378. Serves as a hash function for a particular type.
  21379. </summary>
  21380. <returns>
  21381. hashcode
  21382. </returns>
  21383. </member>
  21384. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.ToString">
  21385. <summary>
  21386. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  21387. </summary>
  21388. <returns>
  21389. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  21390. </returns>
  21391. </member>
  21392. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Path">
  21393. <summary>
  21394. Gets the path.
  21395. </summary>
  21396. <value>The path.</value>
  21397. </member>
  21398. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Name">
  21399. <summary>
  21400. Gets the name.
  21401. </summary>
  21402. <value>The name.</value>
  21403. </member>
  21404. <member name="T:NPOI.POIFS.FileSystem.DocumentEntry">
  21405. <summary>
  21406. This interface defines methods specific to Document objects
  21407. managed by a Filesystem instance.
  21408. @author Marc Johnson (mjohnson at apache dot org)
  21409. </summary>
  21410. </member>
  21411. <member name="P:NPOI.POIFS.FileSystem.DocumentEntry.Size">
  21412. <summary>
  21413. get the size of the document, in bytes
  21414. </summary>
  21415. <value>size in bytes</value>
  21416. </member>
  21417. <member name="T:NPOI.POIFS.FileSystem.DocumentNode">
  21418. <summary>
  21419. Simple implementation of DocumentEntry
  21420. @author Marc Johnson (mjohnson at apache dot org)
  21421. </summary>
  21422. </member>
  21423. <member name="M:NPOI.POIFS.FileSystem.DocumentNode.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.DirectoryNode)">
  21424. create a DocumentNode. This method Is not public by design; it
  21425. Is intended strictly for the internal use of this package
  21426. @param property the DocumentProperty for this DocumentEntry
  21427. @param parent the parent of this entry
  21428. </member>
  21429. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Document">
  21430. get the POIFSDocument
  21431. @return the internal POIFSDocument
  21432. </member>
  21433. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Size">
  21434. get the zize of the document, in bytes
  21435. @return size in bytes
  21436. </member>
  21437. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDocumentEntry">
  21438. Is this a DocumentEntry?
  21439. @return true if the Entry Is a DocumentEntry, else false
  21440. </member>
  21441. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDeleteOK">
  21442. extensions use this method to verify internal rules regarding
  21443. deletion of the underlying store.
  21444. @return true if it's ok to delete the underlying store, else
  21445. false
  21446. </member>
  21447. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableArray">
  21448. Get an array of objects, some of which may implement
  21449. POIFSViewable
  21450. @return an array of Object; may not be null, but may be empty
  21451. </member>
  21452. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableIterator">
  21453. Get an Iterator of objects, some of which may implement
  21454. POIFSViewable
  21455. @return an Iterator; may not be null, but may have an empty
  21456. back end store
  21457. </member>
  21458. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.PreferArray">
  21459. Give viewers a hint as to whether to call getViewableArray or
  21460. getViewableIterator
  21461. @return true if a viewer should call getViewableArray, false if
  21462. a viewer should call getViewableIterator
  21463. </member>
  21464. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ShortDescription">
  21465. Provides a short description of the object, to be used when a
  21466. POIFSViewable object has not provided its contents.
  21467. @return short description
  21468. </member>
  21469. <member name="T:NPOI.POIFS.FileSystem.OfficeXmlFileException">
  21470. <summary>
  21471. This exception is thrown when we try to open a file that's actually
  21472. an Office 2007+ XML file, rather than an OLE2 file (which is what
  21473. POI works with)
  21474. @author Nick Burch
  21475. </summary>
  21476. </member>
  21477. <member name="T:NPOI.POIFS.FileSystem.Ole10Native">
  21478. Represents an Ole10Native record which is wrapped around certain binary
  21479. files being embedded in OLE2 documents.
  21480. @author Rainer Schwarze
  21481. </member>
  21482. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  21483. <summary>
  21484. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  21485. to include a stream &quot;{01}Ole10Native&quot; which Contains the actual
  21486. data relevant for this class.
  21487. </summary>
  21488. <param name="poifs">poifs POI Filesystem object</param>
  21489. <returns>Returns an instance of this class</returns>
  21490. </member>
  21491. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.DirectoryNode)">
  21492. <summary>
  21493. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  21494. to include a stream &quot;{01}Ole10Native&quot; which contains the actual
  21495. data relevant for this class.
  21496. </summary>
  21497. <param name="directory">directory POI Filesystem object</param>
  21498. <returns>Returns an instance of this class</returns>
  21499. </member>
  21500. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32)">
  21501. Creates an instance and Fills the fields based on the data in the given buffer.
  21502. @param data The buffer Containing the Ole10Native record
  21503. @param offset The start offset of the record in the buffer
  21504. @throws Ole10NativeException on invalid or unexcepted data format
  21505. </member>
  21506. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32,System.Boolean)">
  21507. Creates an instance and Fills the fields based on the data in the given buffer.
  21508. @param data The buffer Containing the Ole10Native record
  21509. @param offset The start offset of the record in the buffer
  21510. @param plain Specified 'plain' format without filename
  21511. @throws Ole10NativeException on invalid or unexcepted data format
  21512. </member>
  21513. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetFlags1">
  21514. Returns flags1 - currently unknown - usually 0x0002.
  21515. @return the flags1
  21516. </member>
  21517. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetLabel">
  21518. Returns the label field - usually the name of the file (without directory) but
  21519. probably may be any name specified during packaging/embedding the data.
  21520. @return the label
  21521. </member>
  21522. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetFileName">
  21523. Returns the fileName field - usually the name of the file being embedded
  21524. including the full path.
  21525. @return the fileName
  21526. </member>
  21527. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetFlags2">
  21528. Returns flags2 - currently unknown - mostly 0x0000.
  21529. @return the flags2
  21530. </member>
  21531. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetUnknown1">
  21532. Returns unknown1 field - currently unknown.
  21533. @return the unknown1
  21534. </member>
  21535. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetUnknown2">
  21536. Returns the unknown2 field - currently being a byte[3] - mostly {0, 0, 0}.
  21537. @return the unknown2
  21538. </member>
  21539. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetCommand">
  21540. Returns the command field - usually the name of the file being embedded
  21541. including the full path, may be a command specified during embedding the file.
  21542. @return the command
  21543. </member>
  21544. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetDataSize">
  21545. Returns the size of the embedded file. If the size is 0 (zero), no data has been
  21546. embedded. To be sure, that no data has been embedded, check whether
  21547. {@link #getDataBuffer()} returns <code>null</code>.
  21548. @return the dataSize
  21549. </member>
  21550. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetDataBuffer">
  21551. Returns the buffer Containing the embedded file's data, or <code>null</code>
  21552. if no data was embedded. Note that an embedding may provide information about
  21553. the data, but the actual data is not included. (So label, filename etc. are
  21554. available, but this method returns <code>null</code>.)
  21555. @return the dataBuffer
  21556. </member>
  21557. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.GetFlags3">
  21558. Returns the flags3 - currently unknown.
  21559. @return the flags3
  21560. </member>
  21561. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.TotalSize">
  21562. Returns the value of the totalSize field - the total length of the structure
  21563. is totalSize + 4 (value of this field + size of this field).
  21564. @return the totalSize
  21565. </member>
  21566. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentPath">
  21567. <summary>
  21568. Class POIFSDocumentPath
  21569. @author Marc Johnson (mjohnson at apache dot org)
  21570. </summary>
  21571. </member>
  21572. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor">
  21573. <summary>
  21574. simple constructor for the path of a document that is in the
  21575. root of the POIFSFileSystem. The constructor that takes an
  21576. array of Strings can also be used to create such a
  21577. POIFSDocumentPath by passing it a null or empty String array
  21578. </summary>
  21579. </member>
  21580. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(System.String[])">
  21581. <summary>
  21582. constructor for the path of a document that is not in the root
  21583. of the POIFSFileSystem
  21584. </summary>
  21585. <param name="components">the Strings making up the path to a document.
  21586. The Strings must be ordered as they appear in
  21587. the directory hierarchy of the the document
  21588. -- the first string must be the name of a
  21589. directory in the root of the POIFSFileSystem,
  21590. and every Nth (for N &gt; 1) string thereafter
  21591. must be the name of a directory in the
  21592. directory identified by the (N-1)th string.
  21593. If the components parameter is null or has
  21594. zero length, the POIFSDocumentPath is
  21595. appropriate for a document that is in the
  21596. root of a POIFSFileSystem</param>
  21597. </member>
  21598. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String[])">
  21599. <summary>
  21600. constructor that adds additional subdirectories to an existing
  21601. path
  21602. </summary>
  21603. <param name="path">the existing path</param>
  21604. <param name="components">the additional subdirectory names to be added</param>
  21605. </member>
  21606. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.Equals(System.Object)">
  21607. <summary>
  21608. equality. Two POIFSDocumentPath instances are equal if they
  21609. have the same number of component Strings, and if each
  21610. component String is equal to its coresponding component String
  21611. </summary>
  21612. <param name="o">the object we're checking equality for</param>
  21613. <returns>true if the object is equal to this object</returns>
  21614. </member>
  21615. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetComponent(System.Int32)">
  21616. <summary>
  21617. get the specified component
  21618. </summary>
  21619. <param name="n">which component (0 ... length() - 1)</param>
  21620. <returns>the nth component;</returns>
  21621. </member>
  21622. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetHashCode">
  21623. <summary>
  21624. Serves as a hash function for a particular type.
  21625. </summary>
  21626. <returns>
  21627. A hash code for the current <see cref="T:System.Object"/>.
  21628. </returns>
  21629. </member>
  21630. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.ToString">
  21631. <summary>
  21632. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  21633. </summary>
  21634. <returns>
  21635. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  21636. </returns>
  21637. </member>
  21638. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Length">
  21639. <summary>
  21640. Gets the length.
  21641. </summary>
  21642. <value>the number of components</value>
  21643. </member>
  21644. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Parent">
  21645. <summary>
  21646. Returns the path's parent or <c>null</c> if this path
  21647. is the root path.
  21648. </summary>
  21649. <value>path of parent, or null if this path is the root path</value>
  21650. </member>
  21651. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentReader">
  21652. <summary>
  21653. This class provides methods to read a DocumentEntry managed by a
  21654. Filesystem instance.
  21655. @author Marc Johnson (mjohnson at apache dot org)
  21656. </summary>
  21657. </member>
  21658. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  21659. <summary>
  21660. Create an InputStream from the specified DocumentEntry
  21661. </summary>
  21662. <param name="document">the DocumentEntry to be read</param>
  21663. </member>
  21664. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  21665. <summary>
  21666. Create an InputStream from the specified Document
  21667. </summary>
  21668. <param name="document">the Document to be read</param>
  21669. </member>
  21670. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Close">
  21671. <summary>
  21672. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  21673. </summary>
  21674. </member>
  21675. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[])">
  21676. <summary>
  21677. Reads some number of bytes from the input stream and stores
  21678. them into the buffer array b. The number of bytes actually read
  21679. is returned as an integer. The definition of this method in
  21680. java.io.InputStream allows this method to block, but it won't.
  21681. If b is null, a NullPointerException is thrown. If the length
  21682. of b is zero, then no bytes are read and 0 is returned;
  21683. otherwise, there is an attempt to read at least one byte. If no
  21684. byte is available because the stream is at end of file, the
  21685. value -1 is returned; otherwise, at least one byte is read and
  21686. stored into b.
  21687. The first byte read is stored into element b[0], the next one
  21688. into b[1], and so on. The number of bytes read is, at most,
  21689. equal to the length of b. Let k be the number of bytes actually
  21690. read; these bytes will be stored in elements b[0] through
  21691. b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
  21692. If the first byte cannot be read for any reason other than end
  21693. of file, then an IOException is thrown. In particular, an
  21694. IOException is thrown if the input stream has been closed.
  21695. The read(b) method for class InputStream has the same effect as:
  21696. </summary>
  21697. <param name="b">the buffer into which the data is read.</param>
  21698. <returns>the total number of bytes read into the buffer, or -1
  21699. if there is no more data because the end of the stream
  21700. has been reached.</returns>
  21701. </member>
  21702. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[],System.Int32,System.Int32)">
  21703. <summary>
  21704. Reads up to len bytes of data from the input stream into an
  21705. array of bytes. An attempt is made to read as many as len
  21706. bytes, but a smaller number may be read, possibly zero. The
  21707. number of bytes actually read is returned as an integer.
  21708. The definition of this method in java.io.InputStream allows it
  21709. to block, but it won't.
  21710. If b is null, a NullPointerException is thrown.
  21711. If off is negative, or len is negative, or off+len is greater
  21712. than the length of the array b, then an
  21713. IndexOutOfBoundsException is thrown.
  21714. If len is zero, then no bytes are read and 0 is returned;
  21715. otherwise, there is an attempt to read at least one byte. If no
  21716. byte is available because the stream is at end of file, the
  21717. value -1 is returned; otherwise, at least one byte is read and
  21718. stored into b.
  21719. The first byte read is stored into element b[off], the next one
  21720. into b[off+1], and so on. The number of bytes read is, at most,
  21721. equal to len. Let k be the number of bytes actually read; these
  21722. bytes will be stored in elements b[off] through b[off+k-1],
  21723. leaving elements b[off+k] through b[off+len-1] unaffected.
  21724. In every case, elements b[0] through b[off] and elements
  21725. b[off+len] through b[b.length-1] are unaffected.
  21726. If the first byte cannot be read for any reason other than end
  21727. of file, then an IOException is thrown. In particular, an
  21728. IOException is thrown if the input stream has been closed.
  21729. </summary>
  21730. <param name="b">the buffer into which the data is read.</param>
  21731. <param name="off">the start offset in array b at which the data is
  21732. written.</param>
  21733. <param name="len">the maximum number of bytes to read.</param>
  21734. <returns>the total number of bytes read into the buffer, or -1
  21735. if there is no more data because the end of the stream
  21736. has been reached.</returns>
  21737. </member>
  21738. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.ReadByte">
  21739. <summary>
  21740. Reads the next byte of data from the input stream. The value
  21741. byte is returned as an int in the range 0 to 255. If no byte is
  21742. available because the end of the stream has been reached, the
  21743. value -1 is returned. The definition of this method in
  21744. java.io.InputStream allows this method to block, but it won't.
  21745. </summary>
  21746. <returns>the next byte of data, or -1 if the end of the stream
  21747. is reached.
  21748. </returns>
  21749. </member>
  21750. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Seek(System.Int64,System.IO.SeekOrigin)">
  21751. <summary>
  21752. When overridden in a derived class, sets the position within the current stream.
  21753. </summary>
  21754. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  21755. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  21756. <returns>
  21757. The new position within the current stream.
  21758. </returns>
  21759. <exception cref="T:System.IO.IOException">
  21760. An I/O error occurs.
  21761. </exception>
  21762. <exception cref="T:System.NotSupportedException">
  21763. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  21764. </exception>
  21765. <exception cref="T:System.ObjectDisposedException">
  21766. Methods were called after the stream was closed.
  21767. </exception>
  21768. </member>
  21769. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Skip(System.Int64)">
  21770. <summary>
  21771. Skips the specified n.
  21772. </summary>
  21773. <param name="n">The n.</param>
  21774. <returns></returns>
  21775. </member>
  21776. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Write(System.Byte[],System.Int32,System.Int32)">
  21777. <summary>
  21778. 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.
  21779. </summary>
  21780. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  21781. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  21782. <param name="count">The number of bytes to be written to the current stream.</param>
  21783. <exception cref="T:System.ArgumentException">
  21784. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  21785. </exception>
  21786. <exception cref="T:System.ArgumentNullException">
  21787. <paramref name="buffer"/> is null.
  21788. </exception>
  21789. <exception cref="T:System.ArgumentOutOfRangeException">
  21790. <paramref name="offset"/> or <paramref name="count"/> is negative.
  21791. </exception>
  21792. <exception cref="T:System.IO.IOException">
  21793. An I/O error occurs.
  21794. </exception>
  21795. <exception cref="T:System.NotSupportedException">
  21796. The stream does not support writing.
  21797. </exception>
  21798. <exception cref="T:System.ObjectDisposedException">
  21799. Methods were called after the stream was closed.
  21800. </exception>
  21801. </member>
  21802. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.EOD">
  21803. <summary>
  21804. at the end Of document.
  21805. </summary>
  21806. <returns></returns>
  21807. </member>
  21808. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Available">
  21809. <summary>
  21810. Returns the number of bytes that can be read (or skipped over)
  21811. from this input stream without blocking by the next caller of a
  21812. method for this input stream. The next caller might be the same
  21813. thread or or another thread.
  21814. </summary>
  21815. <value>the number of bytes that can be read from this input
  21816. stream without blocking.</value>
  21817. </member>
  21818. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanRead">
  21819. <summary>
  21820. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  21821. </summary>
  21822. <value></value>
  21823. <returns>true if the stream supports reading; otherwise, false.
  21824. </returns>
  21825. </member>
  21826. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanSeek">
  21827. <summary>
  21828. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  21829. </summary>
  21830. <value></value>
  21831. <returns>true if the stream supports seeking; otherwise, false.
  21832. </returns>
  21833. </member>
  21834. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanWrite">
  21835. <summary>
  21836. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  21837. </summary>
  21838. <value></value>
  21839. <returns>true if the stream supports writing; otherwise, false.
  21840. </returns>
  21841. </member>
  21842. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Length">
  21843. <summary>
  21844. When overridden in a derived class, gets the length in bytes of the stream.
  21845. </summary>
  21846. <value></value>
  21847. <returns>
  21848. A long value representing the length of the stream in bytes.
  21849. </returns>
  21850. <exception cref="T:System.NotSupportedException">
  21851. A class derived from Stream does not support seeking.
  21852. </exception>
  21853. <exception cref="T:System.ObjectDisposedException">
  21854. Methods were called after the stream was closed.
  21855. </exception>
  21856. </member>
  21857. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Position">
  21858. <summary>
  21859. When overridden in a derived class, gets or sets the position within the current stream.
  21860. </summary>
  21861. <value></value>
  21862. <returns>
  21863. The current position within the stream.
  21864. </returns>
  21865. <exception cref="T:System.IO.IOException">
  21866. An I/O error occurs.
  21867. </exception>
  21868. <exception cref="T:System.NotSupportedException">
  21869. The stream does not support seeking.
  21870. </exception>
  21871. <exception cref="T:System.ObjectDisposedException">
  21872. Methods were called after the stream was closed.
  21873. </exception>
  21874. </member>
  21875. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentWriter">
  21876. <summary>
  21877. This class provides a wrapper over an OutputStream so that Document
  21878. writers can't accidently go over their size limits
  21879. @author Marc Johnson (mjohnson at apache dot org)
  21880. </summary>
  21881. </member>
  21882. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.#ctor(System.IO.Stream,System.Int32)">
  21883. <summary>
  21884. Create a POIFSDocumentWriter
  21885. </summary>
  21886. <param name="stream">the OutputStream to which the data is actually</param>
  21887. <param name="limit">the maximum number of bytes that can be written</param>
  21888. </member>
  21889. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Close">
  21890. <summary>
  21891. Closes this output stream and releases any system resources
  21892. associated with this stream. The general contract of close is
  21893. that it closes the output stream. A closed stream cannot
  21894. perform output operations and cannot be reopened.
  21895. </summary>
  21896. </member>
  21897. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Flush">
  21898. <summary>
  21899. Flushes this output stream and forces any buffered output bytes
  21900. to be written out.
  21901. </summary>
  21902. </member>
  21903. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[])">
  21904. <summary>
  21905. Writes b.length bytes from the specified byte array
  21906. to this output stream.
  21907. </summary>
  21908. <param name="b">the data.</param>
  21909. </member>
  21910. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[],System.Int32,System.Int32)">
  21911. <summary>
  21912. Writes len bytes from the specified byte array starting at
  21913. offset off to this output stream. The general contract for
  21914. write(b, off, len) is that some of the bytes in the array b are
  21915. written to the output stream in order; element b[off] is the
  21916. first byte written and b[off+len-1] is the last byte written by
  21917. this operation.
  21918. If b is null, a NullPointerException is thrown.
  21919. If off is negative, or len is negative, or off+len is greater
  21920. than the length of the array b, then an
  21921. IndexOutOfBoundsException is thrown.
  21922. </summary>
  21923. <param name="b">the data.</param>
  21924. <param name="off">the start offset in the data.</param>
  21925. <param name="len">the number of bytes to write.</param>
  21926. </member>
  21927. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteByte(System.Byte)">
  21928. <summary>
  21929. Writes the specified byte to this output stream. The general
  21930. contract for write is that one byte is written to the output
  21931. stream. The byte to be written is the eight low-order bits of
  21932. the argument b. The 24 high-order bits of b are ignored.
  21933. </summary>
  21934. <param name="b">the byte.</param>
  21935. </member>
  21936. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteFiller(System.Int32,System.Byte)">
  21937. <summary>
  21938. write the rest of the document's data (fill in at the end)
  21939. </summary>
  21940. <param name="totalLimit">the actual number of bytes the corresponding
  21941. document must fill</param>
  21942. <param name="fill">the byte to fill remaining space with</param>
  21943. </member>
  21944. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanRead">
  21945. <summary>
  21946. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  21947. </summary>
  21948. <value></value>
  21949. <returns>true if the stream supports reading; otherwise, false.
  21950. </returns>
  21951. </member>
  21952. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanSeek">
  21953. <summary>
  21954. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  21955. </summary>
  21956. <value></value>
  21957. <returns>true if the stream supports seeking; otherwise, false.
  21958. </returns>
  21959. </member>
  21960. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanWrite">
  21961. <summary>
  21962. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  21963. </summary>
  21964. <value></value>
  21965. <returns>true if the stream supports writing; otherwise, false.
  21966. </returns>
  21967. </member>
  21968. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Length">
  21969. <summary>
  21970. When overridden in a derived class, gets the length in bytes of the stream.
  21971. </summary>
  21972. <value></value>
  21973. <returns>
  21974. A long value representing the length of the stream in bytes.
  21975. </returns>
  21976. <exception cref="T:System.NotSupportedException">
  21977. A class derived from Stream does not support seeking.
  21978. </exception>
  21979. <exception cref="T:System.ObjectDisposedException">
  21980. Methods were called after the stream was closed.
  21981. </exception>
  21982. </member>
  21983. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Position">
  21984. <summary>
  21985. When overridden in a derived class, gets or sets the position within the current stream.
  21986. </summary>
  21987. <value></value>
  21988. <returns>
  21989. The current position within the stream.
  21990. </returns>
  21991. <exception cref="T:System.IO.IOException">
  21992. An I/O error occurs.
  21993. </exception>
  21994. <exception cref="T:System.NotSupportedException">
  21995. The stream does not support seeking.
  21996. </exception>
  21997. <exception cref="T:System.ObjectDisposedException">
  21998. Methods were called after the stream was closed.
  21999. </exception>
  22000. </member>
  22001. <member name="T:NPOI.POIFS.FileSystem.POIFSFileSystem">
  22002. <summary>
  22003. This is the main class of the POIFS system; it manages the entire
  22004. life cycle of the filesystem.
  22005. @author Marc Johnson (mjohnson at apache dot org)
  22006. </summary>
  22007. </member>
  22008. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  22009. <summary>
  22010. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  22011. </summary>
  22012. <param name="stream">The stream.</param>
  22013. <example>
  22014. A convenience method (
  22015. CreateNonClosingInputStream()) has been provided for this purpose:
  22016. StreamwrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  22017. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  22018. is.reset();
  22019. doSomethingElse(is);
  22020. </example>
  22021. <returns></returns>
  22022. </member>
  22023. <member name="F:NPOI.POIFS.FileSystem.POIFSFileSystem.bigBlockSize">
  22024. What big block size the file uses. Most files
  22025. use 512 bytes, but a few use 4096
  22026. </member>
  22027. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor">
  22028. <summary>
  22029. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSFileSystem"/> class. intended for writing
  22030. </summary>
  22031. </member>
  22032. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.Stream)">
  22033. <summary>
  22034. Create a POIFSFileSystem from an Stream. Normally the stream is Read until
  22035. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  22036. needs to use it after this constructor completes, a work around is to wrap the
  22037. stream in order to trap the Close() call.
  22038. </summary>
  22039. <param name="stream">the Streamfrom which to Read the data</param>
  22040. </member>
  22041. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  22042. @param stream the stream to be Closed
  22043. @param success <c>false</c> if an exception is currently being thrown in the calling method
  22044. </member>
  22045. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  22046. <summary>
  22047. Checks that the supplied Stream(which MUST
  22048. support mark and reset, or be a PushbackInputStream)
  22049. has a POIFS (OLE2) header at the start of it.
  22050. If your Streamdoes not support mark / reset,
  22051. then wrap it in a PushBackInputStream, then be
  22052. sure to always use that, and not the original!
  22053. </summary>
  22054. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  22055. <returns>
  22056. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  22057. </returns>
  22058. </member>
  22059. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  22060. <summary>
  22061. Create a new document to be Added to the root directory
  22062. </summary>
  22063. <param name="stream"> the Streamfrom which the document's data will be obtained</param>
  22064. <param name="name">the name of the new POIFSDocument</param>
  22065. <returns>the new DocumentEntry</returns>
  22066. </member>
  22067. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  22068. <summary>
  22069. Create a new DocumentEntry in the root entry; the data will be
  22070. provided later
  22071. </summary>
  22072. <param name="name">the name of the new DocumentEntry</param>
  22073. <param name="size">the size of the new DocumentEntry</param>
  22074. <param name="writer">the Writer of the new DocumentEntry</param>
  22075. <returns>the new DocumentEntry</returns>
  22076. </member>
  22077. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDirectory(System.String)">
  22078. <summary>
  22079. Create a new DirectoryEntry in the root directory
  22080. </summary>
  22081. <param name="name">the name of the new DirectoryEntry</param>
  22082. <returns>the new DirectoryEntry</returns>
  22083. </member>
  22084. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocumentInputStream(System.String)">
  22085. open a document in the root entry's list of entries
  22086. @param documentName the name of the document to be opened
  22087. @return a newly opened DocumentInputStream
  22088. @exception IOException if the document does not exist or the
  22089. name is that of a DirectoryEntry
  22090. </member>
  22091. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  22092. <summary>
  22093. Writes the file system.
  22094. </summary>
  22095. <param name="stream">the OutputStream to which the filesystem will be
  22096. written</param>
  22097. </member>
  22098. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.POIFSDocument)">
  22099. <summary>
  22100. Add a new POIFSDocument
  22101. </summary>
  22102. <param name="document">the POIFSDocument being Added</param>
  22103. </member>
  22104. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  22105. <summary>
  22106. Add a new DirectoryProperty
  22107. </summary>
  22108. <param name="directory">The directory.</param>
  22109. </member>
  22110. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  22111. <summary>
  22112. Removes the specified entry.
  22113. </summary>
  22114. <param name="entry">The entry.</param>
  22115. </member>
  22116. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.Root">
  22117. <summary>
  22118. Get the root entry
  22119. </summary>
  22120. <value>The root.</value>
  22121. </member>
  22122. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ViewableArray">
  22123. <summary>
  22124. Get an array of objects, some of which may implement
  22125. POIFSViewable
  22126. </summary>
  22127. <value>an array of Object; may not be null, but may be empty</value>
  22128. </member>
  22129. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ViewableIterator">
  22130. <summary>
  22131. Get an Iterator of objects, some of which may implement
  22132. POIFSViewable
  22133. </summary>
  22134. <value>an Iterator; may not be null, but may have an empty
  22135. back end store</value>
  22136. </member>
  22137. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.PreferArray">
  22138. <summary>
  22139. Give viewers a hint as to whether to call GetViewableArray or
  22140. GetViewableIterator
  22141. </summary>
  22142. <value><c>true</c> if a viewer should call GetViewableArray, <c>false</c> if
  22143. a viewer should call GetViewableIterator </value>
  22144. </member>
  22145. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ShortDescription">
  22146. <summary>
  22147. Provides a short description of the object, to be used when a
  22148. POIFSViewable object has not provided its contents.
  22149. </summary>
  22150. <value>The short description.</value>
  22151. </member>
  22152. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.BigBlockSize">
  22153. <summary>
  22154. Gets The Big Block size, normally 512 bytes, sometimes 4096 bytes
  22155. </summary>
  22156. <value>The size of the big block.</value>
  22157. </member>
  22158. <member name="T:NPOI.POIFS.Properties.Child">
  22159. <summary>
  22160. This interface defines methods for finding and setting sibling
  22161. Property instances
  22162. @author Marc Johnson (mjohnson at apache dot org)
  22163. </summary>
  22164. </member>
  22165. <member name="P:NPOI.POIFS.Properties.Child.PreviousChild">
  22166. <summary>
  22167. Gets or sets the previous child.
  22168. </summary>
  22169. <value>The previous child.</value>
  22170. </member>
  22171. <member name="P:NPOI.POIFS.Properties.Child.NextChild">
  22172. <summary>
  22173. Gets or sets the next child.
  22174. </summary>
  22175. <value>The next child.</value>
  22176. </member>
  22177. <member name="T:NPOI.POIFS.Properties.DirectoryProperty">
  22178. <summary>
  22179. Trivial extension of Property for POIFSDocuments
  22180. @author Marc Johnson (mjohnson at apache dot org)
  22181. </summary>
  22182. </member>
  22183. <member name="T:NPOI.POIFS.Properties.Property">
  22184. <summary>
  22185. This abstract base class is the ancestor of all classes
  22186. implementing POIFS Property behavior.
  22187. @author Marc Johnson (mjohnson at apache dot org)
  22188. </summary>
  22189. </member>
  22190. <member name="M:NPOI.POIFS.Properties.Property.#ctor">
  22191. <summary>
  22192. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.Property"/> class.
  22193. </summary>
  22194. </member>
  22195. <member name="M:NPOI.POIFS.Properties.Property.#ctor(System.Int32,System.Byte[],System.Int32)">
  22196. <summary>
  22197. Constructor from byte data
  22198. </summary>
  22199. <param name="index">index number</param>
  22200. <param name="array">byte data</param>
  22201. <param name="offset">offset into byte data</param>
  22202. </member>
  22203. <member name="M:NPOI.POIFS.Properties.Property.WriteData(System.IO.Stream)">
  22204. <summary>
  22205. Write the raw data to an OutputStream.
  22206. </summary>
  22207. <param name="stream">the OutputStream to which the data Should be
  22208. written.</param>
  22209. </member>
  22210. <member name="M:NPOI.POIFS.Properties.Property.IsSmall(System.Int32)">
  22211. <summary>
  22212. does the length indicate a small document?
  22213. </summary>
  22214. <param name="length">length in bytes</param>
  22215. <returns>
  22216. <c>true</c> if the length Is less than
  22217. _big_block_minimum_bytes; otherwise, <c>false</c>.
  22218. </returns>
  22219. </member>
  22220. <member name="M:NPOI.POIFS.Properties.Property.PreWrite">
  22221. <summary>
  22222. Perform whatever activities need to be performed prior to
  22223. writing
  22224. </summary>
  22225. </member>
  22226. <member name="M:NPOI.POIFS.Properties.Property.IsValidIndex(System.Int32)">
  22227. <summary>
  22228. Determines whether the specified index Is valid
  22229. </summary>
  22230. <param name="index">value to be checked</param>
  22231. <returns>
  22232. <c>true</c> if the index Is valid; otherwise, <c>false</c>.
  22233. </returns>
  22234. </member>
  22235. <member name="P:NPOI.POIFS.Properties.Property.StartBlock">
  22236. <summary>
  22237. Gets or sets the start block for the document referred to by this
  22238. Property.
  22239. </summary>
  22240. <value>the start block index</value>
  22241. </member>
  22242. <member name="P:NPOI.POIFS.Properties.Property.ShouldUseSmallBlocks">
  22243. <summary>
  22244. Based on the currently defined size, Should this property use
  22245. small blocks?
  22246. </summary>
  22247. <returns>true if the size Is less than _big_block_minimum_bytes</returns>
  22248. </member>
  22249. <member name="P:NPOI.POIFS.Properties.Property.Name">
  22250. <summary>
  22251. Gets or sets the name of this property
  22252. </summary>
  22253. <value>property name</value>
  22254. </member>
  22255. <member name="P:NPOI.POIFS.Properties.Property.IsDirectory">
  22256. <summary>
  22257. Gets a value indicating whether this instance is directory.
  22258. </summary>
  22259. <value>
  22260. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  22261. </value>
  22262. </member>
  22263. <member name="P:NPOI.POIFS.Properties.Property.StorageClsid">
  22264. <summary>
  22265. Gets or sets the storage class ID for this property stream. ThIs Is the Class ID
  22266. of the COM object which can read and write this property stream </summary>
  22267. <value>Storage Class ID</value>
  22268. </member>
  22269. <member name="P:NPOI.POIFS.Properties.Property.PropertyType">
  22270. <summary>
  22271. Set the property type. Makes no attempt to validate the value.
  22272. </summary>
  22273. <value>the property type (root, file, directory)</value>
  22274. </member>
  22275. <member name="P:NPOI.POIFS.Properties.Property.NodeColor">
  22276. <summary>
  22277. Sets the color of the node.
  22278. </summary>
  22279. <value>the node color (red or black)</value>
  22280. </member>
  22281. <member name="P:NPOI.POIFS.Properties.Property.ChildProperty">
  22282. <summary>
  22283. Sets the child property.
  22284. </summary>
  22285. <value>the child property's index in the Property Table</value>
  22286. </member>
  22287. <member name="P:NPOI.POIFS.Properties.Property.ChildIndex">
  22288. <summary>
  22289. Get the child property (its index in the Property Table)
  22290. </summary>
  22291. <value>The index of the child.</value>
  22292. </member>
  22293. <member name="P:NPOI.POIFS.Properties.Property.Size">
  22294. <summary>
  22295. Gets or sets the size of the document associated with this Property
  22296. </summary>
  22297. <value>the size of the document, in bytes</value>
  22298. </member>
  22299. <member name="P:NPOI.POIFS.Properties.Property.Index">
  22300. <summary>
  22301. Gets or sets the index.
  22302. </summary>
  22303. <value>The index.</value>
  22304. Get the index for this Property
  22305. @return the index of this Property within its Property Table
  22306. </member>
  22307. <member name="P:NPOI.POIFS.Properties.Property.NextChildIndex">
  22308. <summary>
  22309. Gets the index of the next child.
  22310. </summary>
  22311. <value>The index of the next child.</value>
  22312. </member>
  22313. <member name="P:NPOI.POIFS.Properties.Property.PreviousChildIndex">
  22314. <summary>
  22315. Gets the index of the previous child.
  22316. </summary>
  22317. <value>The index of the previous child.</value>
  22318. </member>
  22319. <member name="P:NPOI.POIFS.Properties.Property.PreviousChild">
  22320. <summary>
  22321. Gets or sets the previous child.
  22322. </summary>
  22323. <value>the new 'previous' child; may be null, which has
  22324. the effect of saying there Is no 'previous' child</value>
  22325. </member>
  22326. <member name="P:NPOI.POIFS.Properties.Property.NextChild">
  22327. <summary>
  22328. Gets or sets the next Child
  22329. </summary>
  22330. <value> the new 'next' child; may be null, which has the
  22331. effect of saying there Is no 'next' child</value>
  22332. </member>
  22333. <member name="P:NPOI.POIFS.Properties.Property.ViewableArray">
  22334. <summary>
  22335. Get an array of objects, some of which may implement
  22336. POIFSViewable
  22337. </summary>
  22338. <value>an array of Object; may not be null, but may be empty</value>
  22339. </member>
  22340. <member name="P:NPOI.POIFS.Properties.Property.ViewableIterator">
  22341. <summary>
  22342. Get an Iterator of objects, some of which may implement POIFSViewable
  22343. </summary>
  22344. <value> may not be null, but may have an empty
  22345. back end store</value>
  22346. </member>
  22347. <member name="P:NPOI.POIFS.Properties.Property.PreferArray">
  22348. <summary>
  22349. Give viewers a hint as to whether to call GetViewableArray or
  22350. GetViewableIterator
  22351. </summary>
  22352. <value><c>true</c> if a viewer Should call GetViewableArray; otherwise, <c>false</c>
  22353. if a viewer Should call GetViewableIterator
  22354. </value>
  22355. </member>
  22356. <member name="P:NPOI.POIFS.Properties.Property.ShortDescription">
  22357. <summary>
  22358. Provides a short description of the object, to be used when a
  22359. POIFSViewable object has not provided its contents.
  22360. </summary>
  22361. <value>The short description.</value>
  22362. </member>
  22363. <member name="T:NPOI.POIFS.Properties.Parent">
  22364. <summary>
  22365. Behavior for parent (directory) properties
  22366. @author Marc Johnson27591@hotmail.com
  22367. </summary>
  22368. </member>
  22369. <member name="M:NPOI.POIFS.Properties.Parent.AddChild(NPOI.POIFS.Properties.Property)">
  22370. <summary>
  22371. Add a new child to the collection of children
  22372. </summary>
  22373. <param name="property">the new child to be added; must not be null</param>
  22374. </member>
  22375. <member name="P:NPOI.POIFS.Properties.Parent.Children">
  22376. <summary>
  22377. Get an iterator over the children of this Parent
  22378. all elements are instances of Property.
  22379. </summary>
  22380. <returns></returns>
  22381. </member>
  22382. <member name="P:NPOI.POIFS.Properties.Parent.PreviousChild">
  22383. <summary>
  22384. Sets the previous child.
  22385. </summary>
  22386. </member>
  22387. <member name="P:NPOI.POIFS.Properties.Parent.NextChild">
  22388. <summary>
  22389. Sets the next child.
  22390. </summary>
  22391. </member>
  22392. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.String)">
  22393. <summary>
  22394. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  22395. </summary>
  22396. <param name="name">the name of the directory</param>
  22397. </member>
  22398. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  22399. <summary>
  22400. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  22401. </summary>
  22402. <param name="index">index number</param>
  22403. <param name="array">byte data</param>
  22404. <param name="offset">offset into byte data</param>
  22405. </member>
  22406. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.ChangeName(NPOI.POIFS.Properties.Property,System.String)">
  22407. <summary>
  22408. Change a Property's name
  22409. </summary>
  22410. <param name="property">the Property whose name Is being Changed.</param>
  22411. <param name="newName">the new name for the Property</param>
  22412. <returns>true if the name Change could be made, else false</returns>
  22413. </member>
  22414. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.DeleteChild(NPOI.POIFS.Properties.Property)">
  22415. <summary>
  22416. Delete a Property
  22417. </summary>
  22418. <param name="property">the Property being Deleted</param>
  22419. <returns>true if the Property could be Deleted, else false</returns>
  22420. </member>
  22421. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PreWrite">
  22422. <summary>
  22423. Perform whatever activities need to be performed prior to
  22424. writing
  22425. </summary>
  22426. </member>
  22427. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.AddChild(NPOI.POIFS.Properties.Property)">
  22428. <summary>
  22429. Add a new child to the collection of children
  22430. </summary>
  22431. <param name="property">the new child to be added; must not be null</param>
  22432. </member>
  22433. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.IsDirectory">
  22434. <summary>
  22435. Gets a value indicating whether this instance is directory.
  22436. </summary>
  22437. <value>
  22438. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  22439. </value>
  22440. </member>
  22441. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.Children">
  22442. <summary>
  22443. Get an iterator over the children of this Parent; all elements
  22444. are instances of Property.
  22445. </summary>
  22446. <value>Iterator of children; may refer to an empty collection</value>
  22447. </member>
  22448. <member name="T:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator">
  22449. <summary>
  22450. Directory Property Comparer
  22451. </summary>
  22452. </member>
  22453. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Equals(System.Object)">
  22454. <summary>
  22455. Object equality, implemented as object identity
  22456. </summary>
  22457. <param name="o">Object we're being Compared to</param>
  22458. <returns>true if identical, else false</returns>
  22459. </member>
  22460. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Compare(NPOI.POIFS.Properties.Property,NPOI.POIFS.Properties.Property)">
  22461. <summary>
  22462. Compare method. Assumes both parameters are non-null
  22463. instances of Property. One property is less than another if
  22464. its name is shorter than the other property's name. If the
  22465. names are the same length, the property whose name comes
  22466. before the other property's name, alphabetically, is less
  22467. than the other property.
  22468. </summary>
  22469. <param name="o1">first object to compare, better be a Property</param>
  22470. <param name="o2">second object to compare, better be a Property</param>
  22471. <returns>negative value if o1 smaller than o2,
  22472. zero if o1 equals o2,
  22473. positive value if o1 bigger than o2.</returns>
  22474. </member>
  22475. <member name="T:NPOI.POIFS.Properties.DocumentProperty">
  22476. <summary>
  22477. Trivial extension of Property for POIFSDocuments
  22478. @author Marc Johnson (mjohnson at apache dot org)
  22479. </summary>
  22480. </member>
  22481. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.String,System.Int32)">
  22482. <summary>
  22483. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  22484. </summary>
  22485. <param name="name">POIFSDocument name</param>
  22486. <param name="size">POIFSDocument size</param>
  22487. </member>
  22488. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  22489. <summary>
  22490. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  22491. </summary>
  22492. <param name="index">index number</param>
  22493. <param name="array">byte data</param>
  22494. <param name="offset">offset into byte data</param>
  22495. </member>
  22496. <member name="M:NPOI.POIFS.Properties.DocumentProperty.PreWrite">
  22497. <summary>
  22498. Perform whatever activities need to be performed prior to
  22499. writing
  22500. </summary>
  22501. </member>
  22502. <member name="P:NPOI.POIFS.Properties.DocumentProperty.Document">
  22503. <summary>
  22504. Gets or sets the document.
  22505. </summary>
  22506. <value>the associated POIFSDocument</value>
  22507. </member>
  22508. <member name="P:NPOI.POIFS.Properties.DocumentProperty.IsDirectory">
  22509. <summary>
  22510. Determines whether this instance is directory.
  22511. </summary>
  22512. <returns>
  22513. <c>true</c> if this instance is directory; otherwise, <c>false</c>.
  22514. </returns>
  22515. </member>
  22516. <member name="T:NPOI.POIFS.Properties.PropertyConstants">
  22517. <summary>
  22518. Constants used by Properties namespace
  22519. </summary>
  22520. </member>
  22521. <member name="M:NPOI.POIFS.Properties.PropertyFactory.ConvertToProperties(NPOI.POIFS.Storage.ListManagedBlock[])">
  22522. <summary>
  22523. Convert raw data blocks to an array of Property's
  22524. </summary>
  22525. <param name="blocks">The blocks to be converted</param>
  22526. <returns>the converted List of Property objects. May contain
  22527. nulls, but will not be null</returns>
  22528. </member>
  22529. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock)">
  22530. Default constructor
  22531. </member>
  22532. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock,NPOI.POIFS.Storage.RawDataBlockList)">
  22533. reading constructor (used when we've read in a file and we want
  22534. to extract the property table from it). Populates the
  22535. properties thoroughly
  22536. @param startBlock the first block of the property table
  22537. @param blockList the list of blocks
  22538. @exception IOException if anything goes wrong (which should be
  22539. a result of the input being NFG)
  22540. </member>
  22541. <member name="M:NPOI.POIFS.Properties.PropertyTable.PreWrite">
  22542. Prepare to be written Leon
  22543. </member>
  22544. <member name="M:NPOI.POIFS.Properties.PropertyTable.WriteBlocks(System.IO.Stream)">
  22545. Write the storage to an Stream
  22546. @param stream the Stream to which the stored data should
  22547. be written
  22548. @exception IOException on problems writing to the specified
  22549. stream
  22550. </member>
  22551. <member name="P:NPOI.POIFS.Properties.PropertyTable.CountBlocks">
  22552. Return the number of BigBlock's this instance uses
  22553. @return count of BigBlock instances
  22554. </member>
  22555. <member name="M:NPOI.POIFS.Properties.RootProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  22556. <summary>
  22557. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.RootProperty"/> class.
  22558. </summary>
  22559. <param name="index">index number</param>
  22560. <param name="array">byte data</param>
  22561. <param name="offset">offset into byte data</param>
  22562. </member>
  22563. <member name="P:NPOI.POIFS.Properties.RootProperty.Size">
  22564. <summary>
  22565. Gets or sets the size of the document associated with this Property
  22566. </summary>
  22567. <value>the size of the document, in bytes</value>
  22568. </member>
  22569. <member name="T:NPOI.POIFS.Storage.BATBlock">
  22570. <summary>
  22571. A block of block allocation table entries. BATBlocks are created
  22572. only through a static factory method: createBATBlocks.
  22573. @author Marc Johnson (mjohnson at apache dot org)
  22574. </summary>
  22575. </member>
  22576. <member name="T:NPOI.POIFS.Storage.BigBlock">
  22577. <summary>
  22578. Abstract base class of all POIFS block storage classes. All
  22579. extensions of BigBlock should write 512 bytes of data when
  22580. requested to write their data.
  22581. This class has package scope, as there is no reason at this time to
  22582. make the class public.
  22583. @author Marc Johnson (mjohnson at apache dot org)
  22584. </summary>
  22585. </member>
  22586. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream,System.Byte[])">
  22587. <summary>
  22588. Default implementation of write for extending classes that
  22589. contain their data in a simple array of bytes.
  22590. </summary>
  22591. <param name="stream">the OutputStream to which the data should be written.</param>
  22592. <param name="data">the byte array of to be written.</param>
  22593. </member>
  22594. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteBlocks(System.IO.Stream)">
  22595. <summary>
  22596. Write the block's data to an OutputStream
  22597. </summary>
  22598. <param name="stream">the OutputStream to which the stored data should be written</param>
  22599. </member>
  22600. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream)">
  22601. <summary>
  22602. Write the storage to an OutputStream
  22603. </summary>
  22604. <param name="stream">the OutputStream to which the stored data should be written </param>
  22605. </member>
  22606. <member name="F:NPOI.POIFS.Storage.BATBlock._values">
  22607. For a regular fat block, these are 128 / 1024
  22608. next sector values.
  22609. For a XFat (DIFat) block, these are 127 / 1023
  22610. next sector values, then a chaining value.
  22611. </member>
  22612. <member name="F:NPOI.POIFS.Storage.BATBlock._has_free_sectors">
  22613. Does this BATBlock have any free sectors in it?
  22614. </member>
  22615. <member name="F:NPOI.POIFS.Storage.BATBlock.ourBlockIndex">
  22616. Where in the file are we?
  22617. </member>
  22618. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor">
  22619. <summary>
  22620. Create a single instance initialized with default values
  22621. </summary>
  22622. </member>
  22623. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32,System.Int32)">
  22624. Create a single instance initialized (perhaps partially) with entries
  22625. @param entries the array of block allocation table entries
  22626. @param start_index the index of the first entry to be written
  22627. to the block
  22628. @param end_index the index, plus one, of the last entry to be
  22629. written to the block (writing is for all index
  22630. k, start_index &lt;= k &lt; end_index)
  22631. </member>
  22632. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.IO.BinaryReader)">
  22633. Create a single BATBlock from the byte buffer, which must hold at least
  22634. one big block of data to be read.
  22635. </member>
  22636. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateEmptyBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.Boolean)">
  22637. **
  22638. </member>
  22639. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[])">
  22640. <summary>
  22641. Create an array of BATBlocks from an array of int block
  22642. allocation table entries
  22643. </summary>
  22644. <param name="bigBlockSize">the poifs bigBlockSize</param>
  22645. <param name="entries">the array of int entries</param>
  22646. <returns>the newly created array of BATBlocks</returns>
  22647. </member>
  22648. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateXBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32)">
  22649. <summary>
  22650. Create an array of XBATBlocks from an array of int block
  22651. allocation table entries
  22652. </summary>
  22653. <param name="bigBlockSize"></param>
  22654. <param name="entries">the array of int entries</param>
  22655. <param name="startBlock">the start block of the array of XBAT blocks</param>
  22656. <returns>the newly created array of BATBlocks</returns>
  22657. </member>
  22658. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateStorageRequirements(System.Int32)">
  22659. <summary>
  22660. Calculate how many BATBlocks are needed to hold a specified
  22661. number of BAT entries.
  22662. </summary>
  22663. <param name="entryCount">the number of entries</param>
  22664. <returns>the number of BATBlocks needed</returns>
  22665. </member>
  22666. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateXBATStorageRequirements(System.Int32)">
  22667. <summary>
  22668. Calculate how many XBATBlocks are needed to hold a specified
  22669. number of BAT entries.
  22670. </summary>
  22671. <param name="entryCount">the number of entries</param>
  22672. <returns>the number of XBATBlocks needed</returns>
  22673. </member>
  22674. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateMaximumSize(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  22675. Calculates the maximum size of a file which is addressable given the
  22676. number of FAT (BAT) sectors specified. (We don't care if those BAT
  22677. blocks come from the 109 in the header, or from header + XBATS, it
  22678. won't affect the calculation)
  22679. The actual file size will be between [size of fatCount-1 blocks] and
  22680. [size of fatCount blocks].
  22681. For 512 byte block sizes, this means we may over-estimate by up to 65kb.
  22682. For 4096 byte block sizes, this means we may over-estimate by up to 4mb
  22683. </member>
  22684. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(System.Int32[],System.Int32,System.Int32)">
  22685. <summary>
  22686. Create a single instance initialized (perhaps partially) with entries
  22687. </summary>
  22688. <param name="entries">the array of block allocation table entries</param>
  22689. <param name="start_index">the index of the first entry to be written
  22690. to the block</param>
  22691. <param name="end_index">the index, plus one, of the last entry to be
  22692. written to the block (writing is for all index
  22693. k, start_index less than k less than end_index)
  22694. </param>
  22695. </member>
  22696. <member name="M:NPOI.POIFS.Storage.BATBlock.WriteData(System.IO.Stream)">
  22697. <summary>
  22698. Write the block's data to an Stream
  22699. </summary>
  22700. <param name="stream">the Stream to which the stored data should
  22701. be written</param>
  22702. </member>
  22703. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerBlock">
  22704. <summary>
  22705. Gets the entries per block.
  22706. </summary>
  22707. <value>The number of entries per block</value>
  22708. </member>
  22709. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerXBATBlock">
  22710. <summary>
  22711. Gets the entries per XBAT block.
  22712. </summary>
  22713. <value>number of entries per XBAT block</value>
  22714. </member>
  22715. <member name="P:NPOI.POIFS.Storage.BATBlock.XBATChainOffset">
  22716. <summary>
  22717. Gets the XBAT chain offset.
  22718. </summary>
  22719. <value>offset of chain index of XBAT block</value>
  22720. </member>
  22721. <member name="P:NPOI.POIFS.Storage.BATBlock.HasFreeSectors">
  22722. Does this BATBlock have any free sectors in it, or
  22723. is it full?
  22724. </member>
  22725. <member name="P:NPOI.POIFS.Storage.BATBlock.OurBlockIndex">
  22726. Retrieve where in the file we live
  22727. </member>
  22728. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableReader">
  22729. <summary>
  22730. This class manages and creates the Block Allocation Table, which is
  22731. basically a set of linked lists of block indices.
  22732. Each block of the filesystem has an index. The first block, the
  22733. header, is skipped; the first block after the header is index 0,
  22734. the next is index 1, and so on.
  22735. A block's index is also its index into the Block Allocation
  22736. Table. The entry that it finds in the Block Allocation Table is the
  22737. index of the next block in the linked list of blocks making up a
  22738. file, or it is set to -2: end of list.
  22739. @author Marc Johnson (mjohnson at apache dot org)
  22740. </summary>
  22741. </member>
  22742. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32,System.Int32[],System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  22743. <summary>
  22744. create a BlockAllocationTableReader for an existing filesystem. Side
  22745. effect: when this method finishes, the BAT blocks will have
  22746. been Removed from the raw block list, and any blocks labeled as
  22747. 'unused' in the block allocation table will also have been
  22748. Removed from the raw block list. </summary>
  22749. <param name="bigBlockSizse">the poifs bigBlockSize</param>
  22750. <param name="block_count">the number of BAT blocks making up the block allocation table</param>
  22751. <param name="block_array">the array of BAT block indices from the
  22752. filesystem's header</param>
  22753. <param name="xbat_count">the number of XBAT blocks</param>
  22754. <param name="xbat_index">the index of the first XBAT block</param>
  22755. <param name="raw_block_list">the list of RawDataBlocks</param>
  22756. </member>
  22757. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  22758. <summary>
  22759. create a BlockAllocationTableReader from an array of raw data blocks
  22760. </summary>
  22761. <param name="bigBlockSize"></param>
  22762. <param name="blocks">the raw data</param>
  22763. <param name="raw_block_list">the list holding the managed blocks</param>
  22764. </member>
  22765. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  22766. <summary>
  22767. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableReader"/> class.
  22768. </summary>
  22769. </member>
  22770. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.FetchBlocks(System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  22771. <summary>
  22772. walk the entries from a specified point and return the
  22773. associated blocks. The associated blocks are Removed from the block list
  22774. </summary>
  22775. <param name="startBlock">the first block in the chain</param>
  22776. <param name="headerPropertiesStartBlock"></param>
  22777. <param name="blockList">the raw data block list</param>
  22778. <returns>array of ListManagedBlocks, in their correct order</returns>
  22779. </member>
  22780. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.IsUsed(System.Int32)">
  22781. <summary>
  22782. determine whether the block specified by index is used or not
  22783. </summary>
  22784. <param name="index">determine whether the block specified by index is used or not</param>
  22785. <returns>
  22786. <c>true</c> if the specified block is used; otherwise, <c>false</c>.
  22787. </returns>
  22788. </member>
  22789. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.GetNextBlockIndex(System.Int32)">
  22790. <summary>
  22791. return the next block index
  22792. </summary>
  22793. <param name="index">The index of the current block</param>
  22794. <returns>index of the next block (may be
  22795. POIFSConstants.END_OF_CHAIN, indicating end of chain
  22796. (duh))</returns>
  22797. </member>
  22798. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.SetEntries(NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  22799. <summary>
  22800. Convert an array of blocks into a Set of integer indices
  22801. </summary>
  22802. <param name="blocks">the array of blocks containing the indices</param>
  22803. <param name="raw_blocks">the list of blocks being managed. Unused
  22804. blocks will be eliminated from the list</param>
  22805. </member>
  22806. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableWriter">
  22807. <summary>
  22808. This class manages and creates the Block Allocation Table, which is
  22809. basically a set of linked lists of block indices.
  22810. Each block of the filesystem has an index. The first block, the
  22811. header, is skipped; the first block after the header is index 0,
  22812. the next is index 1, and so on.
  22813. A block's index is also its index into the Block Allocation
  22814. Table. The entry that it finds in the Block Allocation Table is the
  22815. index of the next block in the linked list of blocks making up a
  22816. file, or it is set to -2: end of list.
  22817. *
  22818. @author Marc Johnson (mjohnson at apache dot org)
  22819. </summary>
  22820. </member>
  22821. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  22822. <summary>
  22823. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableWriter"/> class.
  22824. </summary>
  22825. </member>
  22826. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.CreateBlocks">
  22827. <summary>
  22828. Create the BATBlocks we need
  22829. </summary>
  22830. <returns>start block index of BAT blocks</returns>
  22831. </member>
  22832. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.AllocateSpace(System.Int32)">
  22833. <summary>
  22834. Allocate space for a block of indices
  22835. </summary>
  22836. <param name="blockCount">the number of blocks to allocate space for</param>
  22837. <returns>the starting index of the blocks</returns>
  22838. </member>
  22839. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.SimpleCreateBlocks">
  22840. <summary>
  22841. create the BATBlocks
  22842. </summary>
  22843. </member>
  22844. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.WriteBlocks(System.IO.Stream)">
  22845. <summary>
  22846. Write the storage to an OutputStream
  22847. </summary>
  22848. <param name="stream">the OutputStream to which the stored data should be written</param>
  22849. </member>
  22850. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.StartBlock">
  22851. <summary>
  22852. Sets the start block for this instance
  22853. </summary>
  22854. <value>
  22855. index into the array of BigBlock instances making up the the filesystem
  22856. </value>
  22857. </member>
  22858. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.CountBlocks">
  22859. <summary>
  22860. Gets the number of BigBlock's this instance uses
  22861. </summary>
  22862. <value>count of BigBlock instances</value>
  22863. </member>
  22864. <member name="T:NPOI.POIFS.Storage.BlockList">
  22865. <summary>
  22866. Interface for lists of blocks that are mapped by block allocation
  22867. tables
  22868. @author Marc Johnson (mjohnson at apache dot org)
  22869. </summary>
  22870. </member>
  22871. <member name="M:NPOI.POIFS.Storage.BlockList.Zap(System.Int32)">
  22872. <summary>
  22873. remove the specified block from the list
  22874. </summary>
  22875. <param name="index">the index of the specified block; if the index is
  22876. out of range, that's ok</param>
  22877. </member>
  22878. <member name="M:NPOI.POIFS.Storage.BlockList.Remove(System.Int32)">
  22879. <summary>
  22880. Remove and return the specified block from the list
  22881. </summary>
  22882. <param name="index">the index of the specified block</param>
  22883. <returns>the specified block</returns>
  22884. </member>
  22885. <member name="M:NPOI.POIFS.Storage.BlockList.FetchBlocks(System.Int32,System.Int32)">
  22886. <summary>
  22887. get the blocks making up a particular stream in the list. The
  22888. blocks are removed from the list.
  22889. </summary>
  22890. <param name="startBlock">the index of the first block in the stream</param>
  22891. <param name="headerPropertiesStartBlock"></param>
  22892. <returns>the stream as an array of correctly ordered blocks</returns>
  22893. </member>
  22894. <member name="P:NPOI.POIFS.Storage.BlockList.BAT">
  22895. <summary>
  22896. set the associated BlockAllocationTable
  22897. </summary>
  22898. <value>the associated BlockAllocationTable</value>
  22899. </member>
  22900. <member name="M:NPOI.POIFS.Storage.BlockListImpl.#ctor">
  22901. <summary>
  22902. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockListImpl"/> class.
  22903. </summary>
  22904. </member>
  22905. <member name="M:NPOI.POIFS.Storage.BlockListImpl.SetBlocks(NPOI.POIFS.Storage.ListManagedBlock[])">
  22906. <summary>
  22907. provide blocks to manage
  22908. </summary>
  22909. <param name="blocks">blocks to be managed</param>
  22910. </member>
  22911. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Zap(System.Int32)">
  22912. <summary>
  22913. remove the specified block from the list
  22914. </summary>
  22915. <param name="index">the index of the specified block; if the index is
  22916. out of range, that's ok</param>
  22917. </member>
  22918. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Remove(System.Int32)">
  22919. <summary>
  22920. Remove and return the specified block from the list
  22921. </summary>
  22922. <param name="index">the index of the specified block</param>
  22923. <returns>the specified block</returns>
  22924. </member>
  22925. <member name="M:NPOI.POIFS.Storage.BlockListImpl.FetchBlocks(System.Int32,System.Int32)">
  22926. <summary>
  22927. get the blocks making up a particular stream in the list. The
  22928. blocks are removed from the list.
  22929. </summary>
  22930. <param name="startBlock">the index of the first block in the stream</param>
  22931. <param name="headerPropertiesStartBlock"></param>
  22932. <returns>
  22933. the stream as an array of correctly ordered blocks
  22934. </returns>
  22935. </member>
  22936. <member name="P:NPOI.POIFS.Storage.BlockListImpl.BAT">
  22937. <summary>
  22938. set the associated BlockAllocationTable
  22939. </summary>
  22940. <value>the associated BlockAllocationTable</value>
  22941. </member>
  22942. <member name="T:NPOI.POIFS.Storage.DataInputBlock">
  22943. Wraps a <c>byte</c> array and provides simple data input access.
  22944. Internally, this class maintains a buffer read index, so that for the most part, primitive
  22945. data can be read in a data-input-stream-like manner.<p/>
  22946. Note - the calling class should call the {@link #available()} method to detect end-of-buffer
  22947. and Move to the next data block when the current is exhausted.
  22948. For optimisation reasons, no error handling is performed in this class. Thus, mistakes in
  22949. calling code ran may raise ugly exceptions here, like {@link ArrayIndexOutOfBoundsException},
  22950. etc .<p/>
  22951. The multi-byte primitive input methods ({@link #readUshortLE()}, {@link #readIntLE()} and
  22952. {@link #readLongLE()}) have corresponding 'spanning Read' methods which (when required) perform
  22953. a read across the block boundary. These spanning read methods take the previous
  22954. {@link DataInputBlock} as a parameter.
  22955. Reads of larger amounts of data (into <c>byte</c> array buffers) must be managed by the caller
  22956. since these could conceivably involve more than two blocks.
  22957. @author Josh Micich
  22958. </member>
  22959. <member name="F:NPOI.POIFS.Storage.DataInputBlock._buf">
  22960. Possibly any size (usually 512K or 64K). Assumed to be at least 8 bytes for all blocks
  22961. before the end of the stream. The last block in the stream can be any size except zero.
  22962. </member>
  22963. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE">
  22964. Reads a <c>short</c> which was encoded in <em>little endian</em> format.
  22965. </member>
  22966. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE(NPOI.POIFS.Storage.DataInputBlock)">
  22967. Reads a <c>short</c> which spans the end of <c>prevBlock</c> and the start of this block.
  22968. </member>
  22969. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE">
  22970. Reads an <c>int</c> which was encoded in <em>little endian</em> format.
  22971. </member>
  22972. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  22973. Reads an <c>int</c> which spans the end of <c>prevBlock</c> and the start of this block.
  22974. </member>
  22975. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE">
  22976. Reads a <c>long</c> which was encoded in <em>little endian</em> format.
  22977. </member>
  22978. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  22979. Reads a <c>long</c> which spans the end of <c>prevBlock</c> and the start of this block.
  22980. </member>
  22981. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadSpanning(NPOI.POIFS.Storage.DataInputBlock,System.Int32,System.Byte[])">
  22982. Reads a small amount of data from across the boundary between two blocks.
  22983. The {@link #_readIndex} of this (the second) block is updated accordingly.
  22984. Note- this method (and other code) assumes that the second {@link DataInputBlock}
  22985. always is big enough to complete the read without being exhausted.
  22986. </member>
  22987. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadFully(System.Byte[],System.Int32,System.Int32)">
  22988. Reads <c>len</c> bytes from this block into the supplied buffer.
  22989. </member>
  22990. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(NPOI.POIFS.Storage.RawDataBlock)">
  22991. <summary>
  22992. create a document block from a raw data block
  22993. </summary>
  22994. <param name="block">The block.</param>
  22995. </member>
  22996. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  22997. <summary>
  22998. Create a single instance initialized with data.
  22999. </summary>
  23000. <param name="stream">the InputStream delivering the data.</param>
  23001. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23002. </member>
  23003. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  23004. <summary>
  23005. convert a single long array into an array of DocumentBlock
  23006. instances
  23007. </summary>
  23008. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23009. <param name="array">the byte array to be converted</param>
  23010. <param name="size">the intended size of the array (which may be smaller)</param>
  23011. <returns>an array of DocumentBlock instances, filled from the
  23012. input array</returns>
  23013. </member>
  23014. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Read(NPOI.POIFS.Storage.DocumentBlock[],System.Byte[],System.Int32)">
  23015. <summary>
  23016. Read data from an array of DocumentBlocks
  23017. </summary>
  23018. <param name="blocks">the blocks to Read from</param>
  23019. <param name="buffer">the buffer to Write the data into</param>
  23020. <param name="offset">the offset into the array of blocks to Read from</param>
  23021. </member>
  23022. <member name="M:NPOI.POIFS.Storage.DocumentBlock.WriteData(System.IO.Stream)">
  23023. <summary>
  23024. Write the storage to an OutputStream
  23025. </summary>
  23026. <param name="stream">the OutputStream to which the stored data should
  23027. be written</param>
  23028. </member>
  23029. <member name="P:NPOI.POIFS.Storage.DocumentBlock.Size">
  23030. <summary>
  23031. Get the number of bytes Read for this block.
  23032. </summary>
  23033. <value>bytes Read into the block</value>
  23034. </member>
  23035. <member name="P:NPOI.POIFS.Storage.DocumentBlock.PartiallyRead">
  23036. <summary>
  23037. Was this a partially Read block?
  23038. </summary>
  23039. <value><c>true</c> if the block was only partially filled with data</value>
  23040. </member>
  23041. <member name="P:NPOI.POIFS.Storage.DocumentBlock.FillByte">
  23042. <summary>
  23043. Gets the fill byte used
  23044. </summary>
  23045. <value>The fill byte.</value>
  23046. </member>
  23047. <member name="T:NPOI.POIFS.Storage.HeaderBlockReader">
  23048. <summary>
  23049. The block containing the archive header
  23050. @author Marc Johnson (mjohnson at apache dot org)
  23051. </summary>
  23052. </member>
  23053. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader.bigBlockSize">
  23054. What big block Size the file uses. Most files
  23055. use 512 bytes, but a few use 4096
  23056. </member>
  23057. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader._sbat_count">
  23058. Number of small block allocation table blocks (int)
  23059. (Number of MiniFAT Sectors in Microsoft parlance)
  23060. </member>
  23061. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.#ctor(System.IO.Stream)">
  23062. <summary>
  23063. create a new HeaderBlockReader from an Stream
  23064. </summary>
  23065. <param name="stream">the source Stream</param>
  23066. </member>
  23067. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.AlertShortRead(System.Int32,System.Int32)">
  23068. <summary>
  23069. Alerts the short read.
  23070. </summary>
  23071. <param name="read">The read.</param>
  23072. <param name="expectedReadSize">expected size to read</param>
  23073. </member>
  23074. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.PropertyStart">
  23075. <summary>
  23076. Get start of Property Table
  23077. </summary>
  23078. <value>the index of the first block of the Property Table</value>
  23079. </member>
  23080. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.SBATStart">
  23081. <summary>
  23082. Gets start of small block allocation table
  23083. </summary>
  23084. <value>The SBAT start.</value>
  23085. </member>
  23086. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATCount">
  23087. <summary>
  23088. Gets number of BAT blocks
  23089. </summary>
  23090. <value>The BAT count.</value>
  23091. </member>
  23092. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATArray">
  23093. <summary>
  23094. Gets the BAT array.
  23095. </summary>
  23096. <value>The BAT array.</value>
  23097. </member>
  23098. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATCount">
  23099. <summary>
  23100. Gets the XBAT count.
  23101. </summary>
  23102. <value>The XBAT count.</value>
  23103. @return XBAT count
  23104. </member>
  23105. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATIndex">
  23106. <summary>
  23107. Gets the index of the XBAT.
  23108. </summary>
  23109. <value>The index of the XBAT.</value>
  23110. </member>
  23111. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BigBlockSize">
  23112. <summary>
  23113. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  23114. </summary>
  23115. <value>The size of the big block.</value>
  23116. @return
  23117. </member>
  23118. <member name="T:NPOI.POIFS.Storage.HeaderBlockWriter">
  23119. <summary>
  23120. The block containing the archive header
  23121. @author Marc Johnson (mjohnson at apache dot org)
  23122. </summary>
  23123. </member>
  23124. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.SetBATBlocks(System.Int32,System.Int32)">
  23125. <summary>
  23126. Set BAT block parameters. Assumes that all BAT blocks are
  23127. contiguous. Will construct XBAT blocks if necessary and return
  23128. the array of newly constructed XBAT blocks.
  23129. </summary>
  23130. <param name="blockCount">count of BAT blocks</param>
  23131. <param name="startBlock">index of first BAT block</param>
  23132. <returns>array of XBAT blocks; may be zero Length, will not be
  23133. null</returns>
  23134. </member>
  23135. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.CalculateXBATStorageRequirements(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  23136. <summary>
  23137. For a given number of BAT blocks, calculate how many XBAT
  23138. blocks will be needed
  23139. </summary>
  23140. <param name="bigBlockSize"></param>
  23141. <param name="blockCount">number of BAT blocks</param>
  23142. <returns>number of XBAT blocks needed</returns>
  23143. </member>
  23144. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.WriteBlocks(System.IO.Stream)">
  23145. <summary>
  23146. Write the block's data to an Stream
  23147. </summary>
  23148. <param name="stream">the Stream to which the stored data should
  23149. be written
  23150. </param>
  23151. </member>
  23152. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.PropertyStart">
  23153. <summary>
  23154. Set start of Property Table
  23155. </summary>
  23156. <value>the index of the first block of the Property
  23157. Table</value>
  23158. </member>
  23159. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBAStart">
  23160. <summary>
  23161. Set start of small block allocation table
  23162. </summary>
  23163. <value>the index of the first big block of the small
  23164. block allocation table</value>
  23165. </member>
  23166. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBATBlockCount">
  23167. <summary>
  23168. Set count of SBAT blocks
  23169. </summary>
  23170. <value>the number of SBAT blocks</value>
  23171. </member>
  23172. <member name="T:NPOI.POIFS.Storage.ListManagedBlock">
  23173. <summary>
  23174. An interface for blocks managed by a list that works with a
  23175. BlockAllocationTable to keep block sequences straight
  23176. @author Marc Johnson (mjohnson at apache dot org
  23177. </summary>
  23178. </member>
  23179. <member name="P:NPOI.POIFS.Storage.ListManagedBlock.Data">
  23180. <summary>
  23181. Get the data from the block
  23182. </summary>
  23183. <value>the block's data as a byte array</value>
  23184. </member>
  23185. <member name="T:NPOI.POIFS.Storage.PropertyBlock">
  23186. <summary>
  23187. A block of Property instances
  23188. @author Marc Johnson (mjohnson at apache dot org)
  23189. </summary>
  23190. </member>
  23191. <member name="M:NPOI.POIFS.Storage.PropertyBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Properties.Property[],System.Int32)">
  23192. <summary>
  23193. Create a single instance initialized with default values
  23194. </summary>
  23195. <param name="bigBlockSize"></param>
  23196. <param name="properties">the properties to be inserted</param>
  23197. <param name="offset">the offset into the properties array</param>
  23198. </member>
  23199. <member name="M:NPOI.POIFS.Storage.PropertyBlock.CreatePropertyBlockArray(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.List{NPOI.POIFS.Properties.Property})">
  23200. <summary>
  23201. Create an array of PropertyBlocks from an array of Property
  23202. instances, creating empty Property instances to make up any
  23203. shortfall
  23204. </summary>
  23205. <param name="bigBlockSize"></param>
  23206. <param name="properties">the Property instances to be converted into PropertyBlocks, in a java List</param>
  23207. <returns>the array of newly created PropertyBlock instances</returns>
  23208. </member>
  23209. <member name="M:NPOI.POIFS.Storage.PropertyBlock.WriteData(System.IO.Stream)">
  23210. <summary>
  23211. Write the block's data to an OutputStream
  23212. </summary>
  23213. <param name="stream">the OutputStream to which the stored data should be written</param>
  23214. </member>
  23215. <member name="T:NPOI.POIFS.Storage.RawDataBlock">
  23216. <summary>
  23217. A big block created from an InputStream, holding the raw data
  23218. @author Marc Johnson (mjohnson at apache dot org
  23219. </summary>
  23220. </member>
  23221. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream)">
  23222. <summary>
  23223. Constructor RawDataBlock
  23224. </summary>
  23225. <param name="stream">the Stream from which the data will be read</param>
  23226. </member>
  23227. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream,System.Int32)">
  23228. <summary>
  23229. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlock"/> class.
  23230. </summary>
  23231. <param name="stream">the Stream from which the data will be read</param>
  23232. <param name="blockSize">the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}</param>
  23233. </member>
  23234. <member name="P:NPOI.POIFS.Storage.RawDataBlock.EOF">
  23235. <summary>
  23236. When we read the data, did we hit end of file?
  23237. </summary>
  23238. <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
  23239. it's possible to both have data, and also hit EoF...</value>
  23240. </member>
  23241. <member name="P:NPOI.POIFS.Storage.RawDataBlock.HasData">
  23242. <summary>
  23243. Did we actually find any data to read? It's possible,
  23244. in the event of a short last block, to both have hit
  23245. the EoF, but also to have data
  23246. </summary>
  23247. <value><c>true</c> if this instance has data; otherwise, <c>false</c>.</value>
  23248. </member>
  23249. <member name="P:NPOI.POIFS.Storage.RawDataBlock.Data">
  23250. <summary>
  23251. Get the data from the block
  23252. </summary>
  23253. <value>the block's data as a byte array</value>
  23254. </member>
  23255. <member name="T:NPOI.POIFS.Storage.RawDataBlockList">
  23256. <summary>
  23257. A list of RawDataBlocks instances, and methods to manage the list
  23258. @author Marc Johnson (mjohnson at apache dot org
  23259. </summary>
  23260. </member>
  23261. <member name="M:NPOI.POIFS.Storage.RawDataBlockList.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  23262. <summary>
  23263. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlockList"/> class.
  23264. </summary>
  23265. <param name="stream">the InputStream from which the data will be read</param>
  23266. <param name="bigBlockSize">The big block size, either 512 bytes or 4096 bytes</param>
  23267. </member>
  23268. <member name="T:NPOI.POIFS.Storage.SmallBlockTableReader">
  23269. <summary>
  23270. This class implements reading the small document block list from an
  23271. existing file
  23272. @author Marc Johnson (mjohnson at apache dot org)
  23273. </summary>
  23274. </member>
  23275. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader.GetSmallDocumentBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  23276. <summary>
  23277. fetch the small document block list from an existing file
  23278. </summary>
  23279. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23280. <param name="blockList">the raw data from which the small block table will be extracted</param>
  23281. <param name="root">the root property (which contains the start block and small block table size)</param>
  23282. <param name="sbatStart">the start block of the SBAT</param>
  23283. <returns>the small document block list</returns>
  23284. </member>
  23285. <member name="T:NPOI.POIFS.Storage.SmallBlockTableWriter">
  23286. <summary>
  23287. This class implements reading the small document block list from an
  23288. existing file
  23289. @author Marc Johnson (mjohnson at apache dot org)
  23290. </summary>
  23291. </member>
  23292. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.IList,NPOI.POIFS.Properties.RootProperty)">
  23293. <summary>
  23294. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallBlockTableWriter"/> class.
  23295. </summary>
  23296. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23297. <param name="documents">a IList of POIFSDocument instances</param>
  23298. <param name="root">the Filesystem's root property</param>
  23299. </member>
  23300. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.WriteBlocks(System.IO.Stream)">
  23301. <summary>
  23302. Write the storage to an OutputStream
  23303. </summary>
  23304. <param name="stream">the OutputStream to which the stored data should be written</param>
  23305. </member>
  23306. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBATBlockCount">
  23307. <summary>
  23308. Get the number of SBAT blocks
  23309. </summary>
  23310. <value>number of SBAT big blocks</value>
  23311. </member>
  23312. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBAT">
  23313. <summary>
  23314. Gets the SBAT.
  23315. </summary>
  23316. <value>the Small Block Allocation Table</value>
  23317. </member>
  23318. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.CountBlocks">
  23319. <summary>
  23320. Return the number of BigBlock's this instance uses
  23321. </summary>
  23322. <value>count of BigBlock instances</value>
  23323. </member>
  23324. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.StartBlock">
  23325. <summary>
  23326. Sets the start block.
  23327. </summary>
  23328. <value>The start block.</value>
  23329. </member>
  23330. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlock">
  23331. <summary>
  23332. Storage for documents that are too small to use regular
  23333. DocumentBlocks for their data
  23334. @author Marc Johnson (mjohnson at apache dot org)
  23335. </summary>
  23336. </member>
  23337. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  23338. <summary>
  23339. convert a single long array into an array of SmallDocumentBlock
  23340. instances
  23341. </summary>
  23342. <param name="bigBlockSize">the poifs bigBlockSize</param>
  23343. <param name="array">the byte array to be converted</param>
  23344. <param name="size">the intended size of the array (which may be smaller)</param>
  23345. <returns>an array of SmallDocumentBlock instances, filled from
  23346. the array</returns>
  23347. </member>
  23348. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Fill(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.IList)">
  23349. <summary>
  23350. fill out a List of SmallDocumentBlocks so that it fully occupies
  23351. a Set of big blocks
  23352. </summary>
  23353. <param name="bigBlockSize"></param>
  23354. <param name="blocks">the List to be filled out.</param>
  23355. <returns>number of big blocks the list encompasses</returns>
  23356. </member>
  23357. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.BlockWritable[],System.Int32)">
  23358. <summary>
  23359. Factory for creating SmallDocumentBlocks from DocumentBlocks
  23360. </summary>
  23361. <param name="bigBlocksSize"></param>
  23362. <param name="store">the original DocumentBlocks</param>
  23363. <param name="size">the total document size</param>
  23364. <returns>an array of new SmallDocumentBlocks instances</returns>
  23365. </member>
  23366. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Extract(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[])">
  23367. <summary>
  23368. create a list of SmallDocumentBlock's from raw data
  23369. </summary>
  23370. <param name="bigBlockSize"></param>
  23371. <param name="blocks">the raw data containing the SmallDocumentBlock</param>
  23372. <returns>a List of SmallDocumentBlock's extracted from the input</returns>
  23373. </member>
  23374. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Read(NPOI.POIFS.Storage.BlockWritable[],System.Byte[],System.Int32)">
  23375. <summary>
  23376. Read data from an array of SmallDocumentBlocks
  23377. </summary>
  23378. <param name="blocks">the blocks to Read from.</param>
  23379. <param name="buffer">the buffer to Write the data into.</param>
  23380. <param name="offset">the offset into the array of blocks to Read from</param>
  23381. </member>
  23382. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.CalcSize(System.Int32)">
  23383. <summary>
  23384. Calculate the storage size of a Set of SmallDocumentBlocks
  23385. </summary>
  23386. <param name="size"> number of SmallDocumentBlocks</param>
  23387. <returns>total size</returns>
  23388. </member>
  23389. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.MakeEmptySmallDocumentBlock(NPOI.POIFS.Common.POIFSBigBlockSize)">
  23390. <summary>
  23391. Makes the empty small document block.
  23392. </summary>
  23393. <returns></returns>
  23394. </member>
  23395. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.ConvertToBlockCount(System.Int32)">
  23396. <summary>
  23397. Converts to block count.
  23398. </summary>
  23399. <param name="size">The size.</param>
  23400. <returns></returns>
  23401. </member>
  23402. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.WriteBlocks(System.IO.Stream)">
  23403. <summary>
  23404. Write the storage to an OutputStream
  23405. </summary>
  23406. <param name="stream">the OutputStream to which the stored data should
  23407. be written</param>
  23408. </member>
  23409. <member name="P:NPOI.POIFS.Storage.SmallDocumentBlock.Data">
  23410. <summary>
  23411. Get the data from the block
  23412. </summary>
  23413. <value>the block's data as a byte array</value>
  23414. </member>
  23415. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlockList">
  23416. <summary>
  23417. A list of SmallDocumentBlocks instances, and methods to manage the list
  23418. @author Marc Johnson (mjohnson at apache dot org)
  23419. </summary>
  23420. </member>
  23421. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlockList.#ctor(System.Collections.Generic.List{NPOI.POIFS.Storage.SmallDocumentBlock})">
  23422. <summary>
  23423. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallDocumentBlockList"/> class.
  23424. </summary>
  23425. <param name="blocks">a list of SmallDocumentBlock instances</param>
  23426. </member>
  23427. <member name="T:NPOI.HSSF.Util.HSSFCellUtil">
  23428. <summary>
  23429. Various utility functions that make working with a cells and rows easier. The various
  23430. methods that deal with style's allow you to Create your HSSFCellStyles as you need them.
  23431. When you apply a style change to a cell, the code will attempt to see if a style already
  23432. exists that meets your needs. If not, then it will Create a new style. This is to prevent
  23433. creating too many styles. there is an upper limit in Excel on the number of styles that
  23434. can be supported.
  23435. @author Eric Pugh epugh@upstate.com
  23436. </summary>
  23437. </member>
  23438. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetRow(System.Int32,NPOI.HSSF.UserModel.HSSFSheet)">
  23439. <summary>
  23440. Get a row from the spreadsheet, and Create it if it doesn't exist.
  23441. </summary>
  23442. <param name="rowCounter">The 0 based row number</param>
  23443. <param name="sheet">The sheet that the row is part of.</param>
  23444. <returns>The row indicated by the rowCounter</returns>
  23445. </member>
  23446. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  23447. <summary>
  23448. Get a specific cell from a row. If the cell doesn't exist,
  23449. </summary>
  23450. <param name="row">The row that the cell is part of</param>
  23451. <param name="column">The column index that the cell is in.</param>
  23452. <returns>The cell indicated by the column.</returns>
  23453. </member>
  23454. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.HSSF.UserModel.HSSFCellStyle)">
  23455. <summary>
  23456. Creates a cell, gives it a value, and applies a style if provided
  23457. </summary>
  23458. <param name="row">the row to Create the cell in</param>
  23459. <param name="column">the column index to Create the cell in</param>
  23460. <param name="value">The value of the cell</param>
  23461. <param name="style">If the style is not null, then Set</param>
  23462. <returns>A new HSSFCell</returns>
  23463. </member>
  23464. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  23465. <summary>
  23466. Create a cell, and give it a value.
  23467. </summary>
  23468. <param name="row">the row to Create the cell in</param>
  23469. <param name="column">the column index to Create the cell in</param>
  23470. <param name="value">The value of the cell</param>
  23471. <returns>A new HSSFCell.</returns>
  23472. </member>
  23473. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.Int16)">
  23474. <summary>
  23475. Take a cell, and align it.
  23476. </summary>
  23477. <param name="cell">the cell to Set the alignment for</param>
  23478. <param name="workbook">The workbook that is being worked with.</param>
  23479. <param name="align">the column alignment to use.</param>
  23480. </member>
  23481. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFFont)">
  23482. <summary>
  23483. Take a cell, and apply a font to it
  23484. </summary>
  23485. <param name="cell">the cell to Set the alignment for</param>
  23486. <param name="workbook">The workbook that is being worked with.</param>
  23487. <param name="font">The HSSFFont that you want to Set...</param>
  23488. </member>
  23489. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.String,System.Object)">
  23490. This method attempt to find an already existing HSSFCellStyle that matches
  23491. what you want the style to be. If it does not find the style, then it
  23492. Creates a new one. If it does Create a new one, then it applies the
  23493. propertyName and propertyValue to the style. This is necessary because
  23494. Excel has an upper limit on the number of Styles that it supports.
  23495. @param workbook The workbook that is being worked with.
  23496. @param propertyName The name of the property that is to be
  23497. changed.
  23498. @param propertyValue The value of the property that is to be
  23499. changed.
  23500. @param cell The cell that needs it's style changes
  23501. @exception NestableException Thrown if an error happens.
  23502. </member>
  23503. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  23504. <summary>
  23505. Returns a map containing the format properties of the given cell style.
  23506. </summary>
  23507. <param name="style">cell style</param>
  23508. <returns>map of format properties (String -&gt; Object)</returns>
  23509. </member>
  23510. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.HSSF.UserModel.HSSFWorkbook,System.Collections.Hashtable)">
  23511. <summary>
  23512. Sets the format properties of the given style based on the given map.
  23513. </summary>
  23514. <param name="style">The cell style</param>
  23515. <param name="workbook">The parent workbook.</param>
  23516. <param name="properties">The map of format properties (String -&gt; Object).</param>
  23517. </member>
  23518. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetShort(System.Collections.Hashtable,System.String)">
  23519. <summary>
  23520. Utility method that returns the named short value form the given map.
  23521. Returns zero if the property does not exist, or is not a {@link Short}.
  23522. </summary>
  23523. <param name="properties">The map of named properties (String -&gt; Object)</param>
  23524. <param name="name">The property name.</param>
  23525. <returns>property value, or zero</returns>
  23526. </member>
  23527. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetBoolean(System.Collections.Hashtable,System.String)">
  23528. <summary>
  23529. Utility method that returns the named boolean value form the given map.
  23530. Returns false if the property does not exist, or is not a {@link Boolean}.
  23531. </summary>
  23532. <param name="properties">map of properties (String -&gt; Object)</param>
  23533. <param name="name">The property name.</param>
  23534. <returns>property value, or false</returns>
  23535. </member>
  23536. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.PutShort(System.Collections.Hashtable,System.String,System.Int16)">
  23537. <summary>
  23538. Utility method that Puts the named short value to the given map.
  23539. </summary>
  23540. <param name="properties">The map of properties (String -&gt; Object).</param>
  23541. <param name="name">The property name.</param>
  23542. <param name="value">The property value.</param>
  23543. </member>
  23544. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.PutBoolean(System.Collections.Hashtable,System.String,System.Boolean)">
  23545. <summary>
  23546. Utility method that Puts the named boolean value to the given map.
  23547. </summary>
  23548. <param name="properties">map of properties (String -&gt; Object)</param>
  23549. <param name="name">property name</param>
  23550. <param name="value">property value</param>
  23551. </member>
  23552. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  23553. <summary>
  23554. Looks for text in the cell that should be unicode, like alpha; and provides the
  23555. unicode version of it.
  23556. </summary>
  23557. <param name="cell">The cell to check for unicode values</param>
  23558. <returns>transalted to unicode</returns>
  23559. </member>
  23560. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil">
  23561. <summary>
  23562. Various utility functions that make working with a region of cells easier.
  23563. @author Eric Pugh epugh@upstate.com
  23564. </summary>
  23565. </member>
  23566. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderLeft(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23567. <summary>
  23568. Sets the left border for a region of cells by manipulating the cell style
  23569. of the individual cells on the left
  23570. </summary>
  23571. <param name="border">The new border</param>
  23572. <param name="region">The region that should have the border</param>
  23573. <param name="sheet">The sheet that the region is on.</param>
  23574. <param name="workbook">The workbook that the region is on.</param>
  23575. </member>
  23576. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23577. <summary>
  23578. Sets the leftBorderColor attribute of the HSSFRegionUtil object
  23579. </summary>
  23580. <param name="color">The color of the border</param>
  23581. <param name="region">The region that should have the border</param>
  23582. <param name="sheet">The sheet that the region is on.</param>
  23583. <param name="workbook">The workbook that the region is on.</param>
  23584. </member>
  23585. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderRight(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23586. <summary>
  23587. Sets the borderRight attribute of the HSSFRegionUtil object
  23588. </summary>
  23589. <param name="border">The new border</param>
  23590. <param name="region">The region that should have the border</param>
  23591. <param name="sheet">The sheet that the region is on.</param>
  23592. <param name="workbook">The workbook that the region is on.</param>
  23593. </member>
  23594. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23595. <summary>
  23596. Sets the rightBorderColor attribute of the HSSFRegionUtil object
  23597. </summary>
  23598. <param name="color">The color of the border</param>
  23599. <param name="region">The region that should have the border</param>
  23600. <param name="sheet">The workbook that the region is on.</param>
  23601. <param name="workbook">The sheet that the region is on.</param>
  23602. </member>
  23603. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderBottom(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23604. <summary>
  23605. Sets the borderBottom attribute of the HSSFRegionUtil object
  23606. </summary>
  23607. <param name="border">The new border</param>
  23608. <param name="region">The region that should have the border</param>
  23609. <param name="sheet">The sheet that the region is on.</param>
  23610. <param name="workbook">The workbook that the region is on.</param>
  23611. </member>
  23612. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23613. <summary>
  23614. Sets the bottomBorderColor attribute of the HSSFRegionUtil object
  23615. </summary>
  23616. <param name="color">The color of the border</param>
  23617. <param name="region">The region that should have the border</param>
  23618. <param name="sheet">The sheet that the region is on.</param>
  23619. <param name="workbook">The workbook that the region is on.</param>
  23620. </member>
  23621. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderTop(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23622. <summary>
  23623. Sets the borderBottom attribute of the HSSFRegionUtil object
  23624. </summary>
  23625. <param name="border">The new border</param>
  23626. <param name="region">The region that should have the border</param>
  23627. <param name="sheet">The sheet that the region is on.</param>
  23628. <param name="workbook">The workbook that the region is on.</param>
  23629. </member>
  23630. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  23631. <summary>
  23632. Sets the topBorderColor attribute of the HSSFRegionUtil object
  23633. </summary>
  23634. <param name="color">The color of the border</param>
  23635. <param name="region">The region that should have the border</param>
  23636. <param name="sheet">The sheet that the region is on.</param>
  23637. <param name="workbook">The workbook that the region is on.</param>
  23638. </member>
  23639. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil.CellPropertySetter">
  23640. <summary>
  23641. For setting the same property on many cells to the same value
  23642. </summary>
  23643. </member>
  23644. <member name="T:NPOI.HSSF.UserModel.EscherGraphics">
  23645. Translates Graphics calls into escher calls. The translation Is lossy so
  23646. many features are not supported and some just aren't implemented yet. If
  23647. in doubt test the specific calls you wish to make. Graphics calls are
  23648. always performed into an EscherGroup so one will need to be Created.
  23649. <b>Important:</b>
  23650. <blockquote>
  23651. One important concept worth considering Is that of font size. One of the
  23652. difficulties in Converting Graphics calls into escher Drawing calls Is that
  23653. Excel does not have the concept of absolute pixel positions. It measures
  23654. it's cell widths in 'Chars' and the cell heights in points.
  23655. Unfortunately it's not defined exactly what a type of Char it's
  23656. measuring. Presumably this Is due to the fact that the Excel will be
  23657. using different fonts on different platforms or even within the same
  23658. platform.
  23659. Because of this constraint we've had to calculate the
  23660. verticalPointsPerPixel. This the amount the font should be scaled by when
  23661. you Issue commands such as DrawString(). A good way to calculate this
  23662. Is to use the follow formula:
  23663. <pre>
  23664. multipler = GroupHeightInPoints / heightOfGroup
  23665. </pre>
  23666. The height of the Group Is calculated fairly simply by calculating the
  23667. difference between the y coordinates of the bounding box of the shape. The
  23668. height of the Group can be calculated by using a convenience called
  23669. <c>HSSFClientAnchor.GetAnchorHeightInPoints()</c>.
  23670. </blockquote>
  23671. @author Glen Stampoultzis (glens at apache.org)
  23672. </member>
  23673. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Single)">
  23674. Construct an escher graphics object.
  23675. @param escherGroup The escher Group to Write the graphics calls into.
  23676. @param workbook The workbook we are using.
  23677. @param forecolor The foreground color to use as default.
  23678. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  23679. </member>
  23680. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Drawing.Font,System.Single)">
  23681. Constructs an escher graphics object.
  23682. @param escherGroup The escher Group to Write the graphics calls into.
  23683. @param workbook The workbook we are using.
  23684. @param foreground The foreground color to use as default.
  23685. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  23686. @param font The font to use.
  23687. </member>
  23688. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.FillPolygon(System.Int32[],System.Int32[],System.Int32)">
  23689. Fills a (closed) polygon, as defined by a pair of arrays, which
  23690. hold the <i>x</i> and <i>y</i> coordinates.
  23691. This Draws the polygon, with <c>nPoint</c> line segments.
  23692. The first <c>nPoint - 1</c> line segments are
  23693. Drawn between sequential points
  23694. (<c>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</c>).
  23695. The line segment Is a closing one, from the last point to
  23696. the first (assuming they are different).
  23697. The area inside of the polygon Is defined by using an
  23698. even-odd Fill rule (also known as the alternating rule), and
  23699. the area inside of it Is Filled.
  23700. @param xPoints array of the <c>x</c> coordinates.
  23701. @param yPoints array of the <c>y</c> coordinates.
  23702. @param nPoints the total number of points in the polygon.
  23703. @see java.awt.Graphics#DrawPolygon(int[], int[], int)
  23704. </member>
  23705. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector">
  23706. Instances of this class keep track of multiple dependent cell evaluations due
  23707. to recursive calls to <c>HSSFFormulaEvaluator.internalEvaluate()</c>.
  23708. The main purpose of this class Is to detect an attempt to evaluate a cell
  23709. that Is alReady being evaluated. In other words, it detects circular
  23710. references in spReadsheet formulas.
  23711. @author Josh Micich
  23712. </member>
  23713. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.StartEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  23714. Notifies this evaluation tracker that evaluation of the specified cell Is
  23715. about to start.<br/>
  23716. In the case of a <c>true</c> return code, the caller should
  23717. continue evaluation of the specified cell, and also be sure to call
  23718. <c>endEvaluate()</c> when complete.<br/>
  23719. In the case of a <c>false</c> return code, the caller should
  23720. return an evaluation result of
  23721. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  23722. <br/>
  23723. @return <c>true</c> if the specified cell has not been visited yet in the current
  23724. evaluation. <c>false</c> if the specified cell Is alReady being evaluated.
  23725. </member>
  23726. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.EndEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  23727. Notifies this evaluation tracker that the evaluation of the specified
  23728. cell Is complete. <p/>
  23729. Every successful call to <c>startEvaluate</c> must be followed by a
  23730. call to <c>endEvaluate</c> (recommended in a finally block) to enable
  23731. proper tracking of which cells are being evaluated at any point in time.<p/>
  23732. Assuming a well behaved client, parameters to this method would not be
  23733. required. However, they have been included to assert correct behaviour,
  23734. and form more meaningful error messages.
  23735. </member>
  23736. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame">
  23737. Stores the parameters that identify the evaluation of one cell.<br/>
  23738. </member>
  23739. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame.FormatAsString">
  23740. @return human Readable string for debug purposes
  23741. </member>
  23742. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager">
  23743. This class makes an <c>EvaluationCycleDetector</c> instance available to
  23744. each thRead via a <c>ThReadLocal</c> in order to avoid Adding a parameter
  23745. to a few protected methods within <c>HSSFFormulaEvaluator</c>.
  23746. @author Josh Micich
  23747. </member>
  23748. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager.GetTracker">
  23749. @return
  23750. </member>
  23751. <member name="T:NPOI.HSSF.UserModel.FontDetails">
  23752. <summary>
  23753. Stores width and height details about a font.
  23754. @author Glen Stampoultzis (glens at apache.org)
  23755. </summary>
  23756. </member>
  23757. <member name="M:NPOI.HSSF.UserModel.FontDetails.#ctor(System.String,System.Int32)">
  23758. <summary>
  23759. Construct the font details with the given name and height.
  23760. </summary>
  23761. <param name="fontName">The font name.</param>
  23762. <param name="height">The height of the font.</param>
  23763. </member>
  23764. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetFontName">
  23765. <summary>
  23766. Gets the name of the font.
  23767. </summary>
  23768. <returns></returns>
  23769. </member>
  23770. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetHeight">
  23771. <summary>
  23772. Gets the height.
  23773. </summary>
  23774. <returns></returns>
  23775. </member>
  23776. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChar(System.Char,System.Int32)">
  23777. <summary>
  23778. Adds the char.
  23779. </summary>
  23780. <param name="c">The c.</param>
  23781. <param name="width">The width.</param>
  23782. </member>
  23783. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetCharWidth(System.Char)">
  23784. <summary>
  23785. Retrieves the width of the specified Char. If the metrics for
  23786. a particular Char are not available it defaults to returning the
  23787. width for the 'W' Char.
  23788. </summary>
  23789. <param name="c">The character.</param>
  23790. <returns></returns>
  23791. </member>
  23792. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChars(System.Char[],System.Int32[])">
  23793. <summary>
  23794. Adds the chars.
  23795. </summary>
  23796. <param name="Chars">The chars.</param>
  23797. <param name="widths">The widths.</param>
  23798. </member>
  23799. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontHeightProperty(System.String)">
  23800. <summary>
  23801. Builds the font height property.
  23802. </summary>
  23803. <param name="fontName">Name of the font.</param>
  23804. <returns></returns>
  23805. </member>
  23806. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontWidthsProperty(System.String)">
  23807. <summary>
  23808. Builds the font widths property.
  23809. </summary>
  23810. <param name="fontName">Name of the font.</param>
  23811. <returns></returns>
  23812. </member>
  23813. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontCharsProperty(System.String)">
  23814. <summary>
  23815. Builds the font chars property.
  23816. </summary>
  23817. <param name="fontName">Name of the font.</param>
  23818. <returns></returns>
  23819. </member>
  23820. <member name="M:NPOI.HSSF.UserModel.FontDetails.Create(System.String,NPOI.Util.Collections.Properties)">
  23821. <summary>
  23822. Create an instance of
  23823. <c>FontDetails</c>
  23824. by loading them from the
  23825. provided property object.
  23826. </summary>
  23827. <param name="fontName">the font name.</param>
  23828. <param name="fontMetricsProps">the property object holding the details of this
  23829. particular font.</param>
  23830. <returns>a new FontDetails instance.</returns>
  23831. </member>
  23832. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetStringWidth(System.String)">
  23833. <summary>
  23834. Gets the width of all Chars in a string.
  23835. </summary>
  23836. <param name="str">The string to measure.</param>
  23837. <returns>The width of the string for a 10 point font.</returns>
  23838. </member>
  23839. <member name="M:NPOI.HSSF.UserModel.FontDetails.Split(System.String,System.String,System.Int32)">
  23840. <summary>
  23841. Split the given string into an array of strings using the given
  23842. delimiter.
  23843. </summary>
  23844. <param name="text">The text.</param>
  23845. <param name="separator">The separator.</param>
  23846. <param name="max">The max.</param>
  23847. <returns></returns>
  23848. </member>
  23849. <member name="T:NPOI.HSSF.UserModel.HeaderFooter">
  23850. <summary>
  23851. Common class for HSSFHeader and HSSFFooter
  23852. </summary>
  23853. </member>
  23854. <member name="T:NPOI.SS.UserModel.IHeaderFooter">
  23855. <summary>
  23856. Common interface for NPOI.SS.UserModel.Header and NPOI.SS.UserModel.Footer
  23857. </summary>
  23858. </member>
  23859. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Left">
  23860. <summary>
  23861. Gets or sets the left side of the header or footer.
  23862. </summary>
  23863. <value>The string representing the left side.</value>
  23864. </member>
  23865. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Center">
  23866. <summary>
  23867. Gets or sets the center of the header or footer.
  23868. </summary>
  23869. <value>The string representing the center.</value>
  23870. </member>
  23871. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Right">
  23872. <summary>
  23873. Gets or sets the right side of the header or footer.
  23874. </summary>
  23875. <value>The string representing the right side.</value>
  23876. </member>
  23877. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.UpdateHeaderFooterText(System.String[])">
  23878. <summary>
  23879. Creates the complete footer string based on the left, center, and middle
  23880. strings.
  23881. </summary>
  23882. <param name="parts">The parts.</param>
  23883. </member>
  23884. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.SetHeaderFooterText(System.String)">
  23885. <summary>
  23886. Sets the header footer text.
  23887. </summary>
  23888. <param name="text">the new header footer text (contains mark-up tags). Possibly
  23889. empty string never </param>
  23890. </member>
  23891. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.FontSize(System.Int16)">
  23892. <summary>
  23893. Returns the string that represents the change in font size.
  23894. </summary>
  23895. <param name="size">the new font size.</param>
  23896. <returns>The special string to represent a new font size</returns>
  23897. </member>
  23898. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Font(System.String,System.String)">
  23899. <summary>
  23900. Returns the string that represents the change in font.
  23901. </summary>
  23902. <param name="font">the new font.</param>
  23903. <param name="style">the fonts style, one of regular, italic, bold, italic bold or bold italic.</param>
  23904. <returns>The special string to represent a new font size</returns>
  23905. </member>
  23906. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.StripFields(System.String)">
  23907. <summary>
  23908. Removes any fields (eg macros, page markers etc)
  23909. from the string.
  23910. Normally used to make some text suitable for showing
  23911. to humans, and the resultant text should not normally
  23912. be saved back into the document!
  23913. </summary>
  23914. <param name="text">The text.</param>
  23915. <returns></returns>
  23916. </member>
  23917. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.RawText">
  23918. @return the internal text representation (combining center, left and right parts).
  23919. Possibly empty string if no header or footer is set. Never <c>null</c>.
  23920. </member>
  23921. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Left">
  23922. <summary>
  23923. Get the left side of the header or footer.
  23924. </summary>
  23925. <value>The string representing the left side.</value>
  23926. </member>
  23927. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Center">
  23928. <summary>
  23929. Get the center of the header or footer.
  23930. </summary>
  23931. <value>The string representing the center.</value>
  23932. </member>
  23933. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Right">
  23934. <summary>
  23935. Get the right side of the header or footer.
  23936. </summary>
  23937. <value>The string representing the right side..</value>
  23938. </member>
  23939. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Page">
  23940. <summary>
  23941. Returns the string representing the current page number
  23942. </summary>
  23943. <value>The special string for page number.</value>
  23944. </member>
  23945. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.NumPages">
  23946. <summary>
  23947. Returns the string representing the number of pages.
  23948. </summary>
  23949. <value>The special string for the number of pages.</value>
  23950. </member>
  23951. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Date">
  23952. <summary>
  23953. Returns the string representing the current date
  23954. </summary>
  23955. <value>The special string for the date</value>
  23956. </member>
  23957. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Time">
  23958. <summary>
  23959. Gets the time.
  23960. </summary>
  23961. <value>The time.</value>
  23962. Returns the string representing the current time
  23963. @return The special string for the time
  23964. </member>
  23965. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.File">
  23966. <summary>
  23967. Returns the string representing the current file name
  23968. </summary>
  23969. <value>The special string for the file name.</value>
  23970. </member>
  23971. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Tab">
  23972. <summary>
  23973. Returns the string representing the current tab (sheet) name
  23974. </summary>
  23975. <value>The special string for tab name.</value>
  23976. </member>
  23977. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartBold">
  23978. <summary>
  23979. Returns the string representing the start bold
  23980. </summary>
  23981. <returns>The special string for start bold</returns>
  23982. </member>
  23983. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndBold">
  23984. <summary>
  23985. Returns the string representing the end bold
  23986. </summary>
  23987. <value>The special string for end bold.</value>
  23988. </member>
  23989. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartUnderline">
  23990. <summary>
  23991. Returns the string representing the start underline
  23992. </summary>
  23993. <value>The special string for start underline.</value>
  23994. </member>
  23995. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndUnderline">
  23996. <summary>
  23997. Returns the string representing the end underline
  23998. </summary>
  23999. <value>The special string for end underline.</value>
  24000. </member>
  24001. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartDoubleUnderline">
  24002. <summary>
  24003. Returns the string representing the start double underline
  24004. </summary>
  24005. <value>The special string for start double underline.</value>
  24006. </member>
  24007. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndDoubleUnderline">
  24008. <summary>
  24009. Returns the string representing the end double underline
  24010. </summary>
  24011. <value>The special string for end double underline.</value>
  24012. </member>
  24013. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.AreFieldsStripped">
  24014. <summary>
  24015. Are fields currently being Stripped from
  24016. the text that this {@link HeaderStories} returns?
  24017. Default is false, but can be changed
  24018. </summary>
  24019. <value><c>true</c> if [are fields stripped]; otherwise, <c>false</c>.</value>
  24020. </member>
  24021. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.Field">
  24022. <summary>
  24023. Represents a special field in a header or footer,
  24024. eg the page number
  24025. </summary>
  24026. </member>
  24027. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Field.sequence">
  24028. The character sequence that marks this field
  24029. </member>
  24030. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.PairField">
  24031. <summary>
  24032. A special field that normally comes in a pair, eg
  24033. turn on underline / turn off underline
  24034. </summary>
  24035. </member>
  24036. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Fields.instance">
  24037. <summary>
  24038. Instance to this class.
  24039. </summary>
  24040. </member>
  24041. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#cctor">
  24042. <summary>
  24043. Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
  24044. </summary>
  24045. </member>
  24046. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#ctor">
  24047. <summary>
  24048. Initialize AllFields.
  24049. </summary>
  24050. </member>
  24051. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Fields.Instance">
  24052. <summary>
  24053. Accessing the initialized instance.
  24054. </summary>
  24055. </member>
  24056. <member name="T:NPOI.HSSF.UserModel.HSSFAnchor">
  24057. <summary>
  24058. An anchor Is what specifics the position of a shape within a client object
  24059. or within another containing shape.
  24060. @author Glen Stampoultzis (glens at apache.org)
  24061. </summary>
  24062. </member>
  24063. <member name="M:NPOI.HSSF.UserModel.HSSFAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  24064. <summary>
  24065. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFAnchor"/> class.
  24066. </summary>
  24067. <param name="dx1">The DX1.</param>
  24068. <param name="dy1">The dy1.</param>
  24069. <param name="dx2">The DX2.</param>
  24070. <param name="dy2">The dy2.</param>
  24071. </member>
  24072. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx1">
  24073. <summary>
  24074. Gets or sets the DX1.
  24075. </summary>
  24076. <value>The DX1.</value>
  24077. </member>
  24078. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy1">
  24079. <summary>
  24080. Gets or sets the dy1.
  24081. </summary>
  24082. <value>The dy1.</value>
  24083. </member>
  24084. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy2">
  24085. <summary>
  24086. Gets or sets the dy2.
  24087. </summary>
  24088. <value>The dy2.</value>
  24089. </member>
  24090. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx2">
  24091. <summary>
  24092. Gets or sets the DX2.
  24093. </summary>
  24094. <value>The DX2.</value>
  24095. </member>
  24096. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsHorizontallyFlipped">
  24097. <summary>
  24098. Gets a value indicating whether this instance is horizontally flipped.
  24099. </summary>
  24100. <value>
  24101. <c>true</c> if this instance is horizontally flipped; otherwise, <c>false</c>.
  24102. </value>
  24103. </member>
  24104. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsVerticallyFlipped">
  24105. <summary>
  24106. Gets a value indicating whether this instance is vertically flipped.
  24107. </summary>
  24108. <value>
  24109. <c>true</c> if this instance is vertically flipped; otherwise, <c>false</c>.
  24110. </value>
  24111. </member>
  24112. <member name="T:NPOI.SS.UserModel.IAutoFilter">
  24113. Represents autofiltering for the specified worksheet.
  24114. <p>
  24115. Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table.
  24116. For example, you can filter to see only the values that you specify, filter to see the top or bottom values,
  24117. or filter to quickly see duplicate values.
  24118. </p>
  24119. TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells.
  24120. In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add
  24121. corresponding methods to this interface.
  24122. </member>
  24123. <member name="T:NPOI.HSSF.UserModel.HSSFBorderFormatting">
  24124. High level representation for Border Formatting component
  24125. of Conditional Formatting Settings
  24126. @author Dmitriy Kumshayev
  24127. </member>
  24128. <member name="T:NPOI.SS.UserModel.IBorderFormatting">
  24129. @author Dmitriy Kumshayev
  24130. @author Yegor Kozlov
  24131. </member>
  24132. <member name="T:NPOI.HSSF.UserModel.HSSFCell">
  24133. <summary>
  24134. High level representation of a cell in a row of a spReadsheet.
  24135. Cells can be numeric, formula-based or string-based (text). The cell type
  24136. specifies this. String cells cannot conatin numbers and numeric cells cannot
  24137. contain strings (at least according to our model). Client apps should do the
  24138. conversions themselves. Formula cells have the formula string, as well as
  24139. the formula result, which can be numeric or string.
  24140. Cells should have their number (0 based) before being Added to a row. Only
  24141. cells that have values should be Added.
  24142. </summary>
  24143. <remarks>
  24144. @author Andrew C. Oliver (acoliver at apache dot org)
  24145. @author Dan Sherman (dsherman at Isisph.com)
  24146. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  24147. @author Yegor Kozlov cell comments support
  24148. </remarks>
  24149. </member>
  24150. <member name="T:NPOI.SS.UserModel.ICell">
  24151. High level representation of a cell in a row of a spreadsheet.
  24152. <p>
  24153. Cells can be numeric, formula-based or string-based (text). The cell type
  24154. specifies this. String cells cannot conatin numbers and numeric cells cannot
  24155. contain strings (at least according to our model). Client apps should do the
  24156. conversions themselves. Formula cells have the formula string, as well as
  24157. the formula result, which can be numeric or string.
  24158. </p>
  24159. <p>
  24160. Cells should have their number (0 based) before being Added to a row.
  24161. </p>
  24162. </member>
  24163. <member name="M:NPOI.SS.UserModel.ICell.SetCellType(NPOI.SS.UserModel.CellType)">
  24164. <summary>
  24165. Set the cells type (numeric, formula or string)
  24166. </summary>
  24167. <param name="cellType"></param>
  24168. </member>
  24169. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Double)">
  24170. <summary>
  24171. Set a numeric value for the cell
  24172. </summary>
  24173. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  24174. precalculated value, for numerics we'll set its value. For other types we will change
  24175. the cell to a numeric cell and set its value.
  24176. </param>
  24177. </member>
  24178. <member name="M:NPOI.SS.UserModel.ICell.SetCellErrorValue(System.Byte)">
  24179. <summary>
  24180. Set a error value for the cell
  24181. </summary>
  24182. <param name="value">the error value to set this cell to. For formulas we'll set the
  24183. precalculated value , for errors we'll set its value. For other types we will change
  24184. the cell to an error cell and set its value.
  24185. </param>
  24186. </member>
  24187. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.DateTime)">
  24188. <summary>
  24189. Converts the supplied date to its equivalent Excel numeric value and Sets that into the cell.
  24190. </summary>
  24191. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  24192. precalculated value, for numerics we'll set its value. For other types we will change
  24193. the cell to a numerics cell and set its value.
  24194. </param>
  24195. </member>
  24196. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  24197. <summary>
  24198. Set a rich string value for the cell.
  24199. </summary>
  24200. <param name="value">value to set the cell to. For formulas we'll set the formula
  24201. string, for String cells we'll set its value. For other types we will
  24202. change the cell to a string cell and set its value.
  24203. If value is null then we will change the cell to a Blank cell.
  24204. </param>
  24205. </member>
  24206. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.String)">
  24207. <summary>
  24208. Set a string value for the cell.
  24209. </summary>
  24210. <param name="value">value to set the cell to. For formulas we'll set the formula
  24211. string, for String cells we'll set its value. For other types we will
  24212. change the cell to a string cell and set its value.
  24213. If value is null then we will change the cell to a blank cell.
  24214. </param>
  24215. </member>
  24216. <member name="M:NPOI.SS.UserModel.ICell.CopyCellTo(System.Int32)">
  24217. <summary>
  24218. Copy the cell to the target index. If the target cell exists, a new cell will be inserted before the existing cell.
  24219. </summary>
  24220. <param name="targetIndex">target index</param>
  24221. <returns>the new copied cell object</returns>
  24222. </member>
  24223. <member name="M:NPOI.SS.UserModel.ICell.SetCellFormula(System.String)">
  24224. <summary>
  24225. Sets formula for this cell.
  24226. </summary>
  24227. <param name="formula">the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.</param>
  24228. </member>
  24229. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Boolean)">
  24230. <summary>
  24231. Set a bool value for the cell
  24232. </summary>
  24233. <param name="value"></param>
  24234. </member>
  24235. <member name="M:NPOI.SS.UserModel.ICell.SetAsActiveCell">
  24236. <summary>
  24237. Sets this cell as the active cell for the worksheet
  24238. </summary>
  24239. </member>
  24240. <member name="M:NPOI.SS.UserModel.ICell.RemoveCellComment">
  24241. <summary>
  24242. Removes the comment for this cell, if there is one.
  24243. </summary>
  24244. </member>
  24245. <member name="P:NPOI.SS.UserModel.ICell.ColumnIndex">
  24246. <summary>
  24247. zero-based column index of a column in a sheet.
  24248. </summary>
  24249. </member>
  24250. <member name="P:NPOI.SS.UserModel.ICell.RowIndex">
  24251. <summary>
  24252. zero-based row index of a row in the sheet that contains this cell
  24253. </summary>
  24254. </member>
  24255. <member name="P:NPOI.SS.UserModel.ICell.Sheet">
  24256. <summary>
  24257. the sheet this cell belongs to
  24258. </summary>
  24259. </member>
  24260. <member name="P:NPOI.SS.UserModel.ICell.Row">
  24261. <summary>
  24262. the row this cell belongs to
  24263. </summary>
  24264. </member>
  24265. <member name="P:NPOI.SS.UserModel.ICell.CellType">
  24266. <summary>
  24267. Set the cells type (numeric, formula or string)
  24268. </summary>
  24269. </member>
  24270. <member name="P:NPOI.SS.UserModel.ICell.CachedFormulaResultType">
  24271. <summary>
  24272. Only valid for formula cells
  24273. </summary>
  24274. </member>
  24275. <member name="P:NPOI.SS.UserModel.ICell.CellFormula">
  24276. <summary>
  24277. Return a formula for the cell
  24278. </summary>
  24279. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is not CELL_TYPE_FORMULA </exception>
  24280. </member>
  24281. <member name="P:NPOI.SS.UserModel.ICell.NumericCellValue">
  24282. <summary>
  24283. Get the value of the cell as a number.
  24284. </summary>
  24285. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  24286. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  24287. </member>
  24288. <member name="P:NPOI.SS.UserModel.ICell.DateCellValue">
  24289. <summary>
  24290. Get the value of the cell as a date.
  24291. </summary>
  24292. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  24293. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  24294. </member>
  24295. <member name="P:NPOI.SS.UserModel.ICell.RichStringCellValue">
  24296. <summary>
  24297. Get the value of the cell RichTextString
  24298. </summary>
  24299. </member>
  24300. <member name="P:NPOI.SS.UserModel.ICell.ErrorCellValue">
  24301. <summary>
  24302. Get the value of the cell as an error code.
  24303. </summary>
  24304. </member>
  24305. <member name="P:NPOI.SS.UserModel.ICell.StringCellValue">
  24306. <summary>
  24307. Get the value of the cell as a string
  24308. </summary>
  24309. </member>
  24310. <member name="P:NPOI.SS.UserModel.ICell.BooleanCellValue">
  24311. <summary>
  24312. Get the value of the cell as a bool.
  24313. </summary>
  24314. </member>
  24315. <member name="P:NPOI.SS.UserModel.ICell.CellStyle">
  24316. <summary>
  24317. Return the cell's style.
  24318. </summary>
  24319. </member>
  24320. <member name="P:NPOI.SS.UserModel.ICell.CellComment">
  24321. <summary>
  24322. comment associated with this cell
  24323. </summary>
  24324. </member>
  24325. <member name="P:NPOI.SS.UserModel.ICell.Hyperlink">
  24326. <summary>
  24327. hyperlink associated with this cell
  24328. </summary>
  24329. </member>
  24330. <member name="P:NPOI.SS.UserModel.ICell.ArrayFormulaRange">
  24331. <summary>
  24332. Only valid for array formula cells
  24333. </summary>
  24334. <returns>range of the array formula group that the cell belongs to.</returns>
  24335. </member>
  24336. <member name="P:NPOI.SS.UserModel.ICell.IsPartOfArrayFormulaGroup">
  24337. <summary>
  24338. if this cell is part of group of cells having a common array formula.
  24339. </summary>
  24340. </member>
  24341. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16)">
  24342. <summary>
  24343. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  24344. from scratch.
  24345. When the cell is initially Created it is Set to CellType.Blank. Cell types
  24346. can be Changed/overwritten by calling SetCellValue with the appropriate
  24347. type as a parameter although conversions from one type to another may be
  24348. prohibited.
  24349. </summary>
  24350. <param name="book">Workbook record of the workbook containing this cell</param>
  24351. <param name="sheet">Sheet record of the sheet containing this cell</param>
  24352. <param name="row">the row of this cell</param>
  24353. <param name="col">the column for this cell</param>
  24354. </member>
  24355. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16,NPOI.SS.UserModel.CellType)">
  24356. <summary>
  24357. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  24358. from scratch.
  24359. </summary>
  24360. <param name="book">Workbook record of the workbook containing this cell</param>
  24361. <param name="sheet">Sheet record of the sheet containing this cell</param>
  24362. <param name="row">the row of this cell</param>
  24363. <param name="col">the column for this cell</param>
  24364. <param name="type">CellType.Numeric, CellType.String, CellType.Formula, CellType.Blank,
  24365. CellType.Boolean, CellType.Error</param>
  24366. </member>
  24367. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.CellValueRecordInterface)">
  24368. <summary>
  24369. Creates an Cell from a CellValueRecordInterface. HSSFSheet uses this when
  24370. reading in cells from an existing sheet.
  24371. </summary>
  24372. <param name="book">Workbook record of the workbook containing this cell</param>
  24373. <param name="sheet">Sheet record of the sheet containing this cell</param>
  24374. <param name="cval">the Cell Value Record we wish to represent</param>
  24375. </member>
  24376. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor">
  24377. private constructor to prevent blank construction
  24378. </member>
  24379. <member name="M:NPOI.HSSF.UserModel.HSSFCell.DetermineType(NPOI.HSSF.Record.CellValueRecordInterface)">
  24380. used internally -- given a cell value record, figure out its type
  24381. </member>
  24382. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  24383. <summary>
  24384. Set the cells type (numeric, formula or string)
  24385. </summary>
  24386. <param name="cellType">Type of the cell.</param>
  24387. </member>
  24388. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType,System.Boolean,System.Int32,System.Int32,System.Int16)">
  24389. <summary>
  24390. Sets the cell type. The SetValue flag indicates whether to bother about
  24391. trying to preserve the current value in the new record if one is Created.
  24392. The SetCellValue method will call this method with false in SetValue
  24393. since it will overWrite the cell value later
  24394. </summary>
  24395. <param name="cellType">Type of the cell.</param>
  24396. <param name="setValue">if set to <c>true</c> [set value].</param>
  24397. <param name="row">The row.</param>
  24398. <param name="col">The col.</param>
  24399. <param name="styleIndex">Index of the style.</param>
  24400. </member>
  24401. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Double)">
  24402. <summary>
  24403. Set a numeric value for the cell
  24404. </summary>
  24405. <param name="value">the numeric value to Set this cell to. For formulas we'll Set the
  24406. precalculated value, for numerics we'll Set its value. For other types we
  24407. will Change the cell to a numeric cell and Set its value.</param>
  24408. </member>
  24409. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.DateTime)">
  24410. <summary>
  24411. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
  24412. a date.
  24413. </summary>
  24414. <param name="value">the date value to Set this cell to. For formulas we'll Set the
  24415. precalculated value, for numerics we'll Set its value. For other types we
  24416. will Change the cell to a numeric cell and Set its value.</param>
  24417. </member>
  24418. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.String)">
  24419. <summary>
  24420. Set a string value for the cell. Please note that if you are using
  24421. full 16 bit Unicode you should call SetEncoding() first.
  24422. </summary>
  24423. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  24424. string, for String cells we'll Set its value. For other types we will
  24425. Change the cell to a string cell and Set its value.
  24426. If value is null then we will Change the cell to a Blank cell.</param>
  24427. </member>
  24428. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(System.Byte)">
  24429. set a error value for the cell
  24430. @param errorCode the error value to set this cell to. For formulas we'll set the
  24431. precalculated value , for errors we'll set
  24432. its value. For other types we will change the cell to an error
  24433. cell and set its value.
  24434. </member>
  24435. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  24436. <summary>
  24437. Set a string value for the cell. Please note that if you are using
  24438. full 16 bit Unicode you should call SetEncoding() first.
  24439. </summary>
  24440. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  24441. string, for String cells we'll Set its value. For other types we will
  24442. Change the cell to a string cell and Set its value.
  24443. If value is null then we will Change the cell to a Blank cell.</param>
  24444. </member>
  24445. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyFormulaChanging">
  24446. Should be called any time that a formula could potentially be deleted.
  24447. Does nothing if this cell currently does not hold a formula
  24448. </member>
  24449. <member name="M:NPOI.HSSF.UserModel.HSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  24450. <summary>
  24451. Used to help format error messages
  24452. </summary>
  24453. <param name="cellTypeCode">The cell type code.</param>
  24454. <returns></returns>
  24455. </member>
  24456. <member name="M:NPOI.HSSF.UserModel.HSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  24457. <summary>
  24458. Types the mismatch.
  24459. </summary>
  24460. <param name="expectedTypeCode">The expected type code.</param>
  24461. <param name="actualTypeCode">The actual type code.</param>
  24462. <param name="isFormulaCell">if set to <c>true</c> [is formula cell].</param>
  24463. <returns></returns>
  24464. </member>
  24465. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckFormulaCachedValueType(NPOI.SS.UserModel.CellType,NPOI.HSSF.Record.FormulaRecord)">
  24466. <summary>
  24467. Checks the type of the formula cached value.
  24468. </summary>
  24469. <param name="expectedTypeCode">The expected type code.</param>
  24470. <param name="fr">The fr.</param>
  24471. </member>
  24472. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Boolean)">
  24473. <summary>
  24474. Set a bool value for the cell
  24475. </summary>
  24476. <param name="value">the bool value to Set this cell to. For formulas we'll Set the
  24477. precalculated value, for bools we'll Set its value. For other types we
  24478. will Change the cell to a bool cell and Set its value.</param>
  24479. </member>
  24480. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ConvertCellValueToBoolean">
  24481. <summary>
  24482. Chooses a new bool value for the cell when its type is changing.
  24483. Usually the caller is calling SetCellType() with the intention of calling
  24484. SetCellValue(bool) straight afterwards. This method only exists to give
  24485. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  24486. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  24487. </summary>
  24488. <returns></returns>
  24489. </member>
  24490. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ApplyUserCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle)">
  24491. Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but
  24492. instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent.
  24493. The proceudre to apply a UDS is as follows:
  24494. 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex()
  24495. and xfType == ExtendedFormatRecord.XF_CELL.
  24496. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style
  24497. and set the parentIndex to be style.getIndex()
  24498. 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record
  24499. @param style the user style to apply
  24500. @return the index of a ExtendedFormatRecord record that will be referenced by the cell
  24501. </member>
  24502. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckBounds(System.Int32)">
  24503. <summary>
  24504. Checks the bounds.
  24505. </summary>
  24506. <param name="cellIndex">The cell num.</param>
  24507. <exception cref="T:System.Exception">if the bounds are exceeded.</exception>
  24508. </member>
  24509. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetAsActiveCell">
  24510. <summary>
  24511. Sets this cell as the active cell for the worksheet
  24512. </summary>
  24513. </member>
  24514. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ToString">
  24515. <summary>
  24516. Returns a string representation of the cell
  24517. This method returns a simple representation,
  24518. anthing more complex should be in user code, with
  24519. knowledge of the semantics of the sheet being Processed.
  24520. Formula cells return the formula string,
  24521. rather than the formula result.
  24522. Dates are Displayed in dd-MMM-yyyy format
  24523. Errors are Displayed as #ERR&lt;errIdx&gt;
  24524. </summary>
  24525. </member>
  24526. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveCellComment">
  24527. <summary>
  24528. Removes the comment for this cell, if
  24529. there is one.
  24530. </summary>
  24531. <remarks>WARNING - some versions of excel will loose
  24532. all comments after performing this action!</remarks>
  24533. </member>
  24534. <member name="M:NPOI.HSSF.UserModel.HSSFCell.UpdateCellNum(System.Int32)">
  24535. Updates the cell record's idea of what
  24536. column it belongs in (0 based)
  24537. @param num the new cell number
  24538. </member>
  24539. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging(System.String)">
  24540. <summary>
  24541. The purpose of this method is to validate the cell state prior to modification
  24542. </summary>
  24543. <param name="msg"></param>
  24544. </member>
  24545. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging">
  24546. <summary>
  24547. Called when this cell is modified.
  24548. The purpose of this method is to validate the cell state prior to modification.
  24549. </summary>
  24550. </member>
  24551. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BoundWorkbook">
  24552. <summary>
  24553. the Workbook that this Cell is bound to
  24554. </summary>
  24555. </member>
  24556. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Row">
  24557. <summary>
  24558. the HSSFRow this cell belongs to
  24559. </summary>
  24560. </member>
  24561. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellType">
  24562. <summary>
  24563. Get the cells type (numeric, formula or string)
  24564. </summary>
  24565. <value>The type of the cell.</value>
  24566. </member>
  24567. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellFormula">
  24568. <summary>
  24569. Gets or sets the cell formula.
  24570. </summary>
  24571. <value>The cell formula.</value>
  24572. </member>
  24573. <member name="P:NPOI.HSSF.UserModel.HSSFCell.NumericCellValue">
  24574. <summary>
  24575. Get the value of the cell as a number. For strings we throw an exception.
  24576. For blank cells we return a 0.
  24577. </summary>
  24578. <value>The numeric cell value.</value>
  24579. </member>
  24580. <member name="P:NPOI.HSSF.UserModel.HSSFCell.DateCellValue">
  24581. <summary>
  24582. Get the value of the cell as a date. For strings we throw an exception.
  24583. For blank cells we return a null.
  24584. </summary>
  24585. <value>The date cell value.</value>
  24586. </member>
  24587. <member name="P:NPOI.HSSF.UserModel.HSSFCell.StringCellValue">
  24588. <summary>
  24589. Get the value of the cell as a string - for numeric cells we throw an exception.
  24590. For blank cells we return an empty string.
  24591. For formulaCells that are not string Formulas, we return empty String
  24592. </summary>
  24593. <value>The string cell value.</value>
  24594. </member>
  24595. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RichStringCellValue">
  24596. <summary>
  24597. Get the value of the cell as a string - for numeric cells we throw an exception.
  24598. For blank cells we return an empty string.
  24599. For formulaCells that are not string Formulas, we return empty String
  24600. </summary>
  24601. <value>The rich string cell value.</value>
  24602. </member>
  24603. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BooleanCellValue">
  24604. <summary>
  24605. Get the value of the cell as a bool. For strings, numbers, and errors, we throw an exception.
  24606. For blank cells we return a false.
  24607. </summary>
  24608. <value><c>true</c> if [boolean cell value]; otherwise, <c>false</c>.</value>
  24609. </member>
  24610. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ErrorCellValue">
  24611. <summary>
  24612. Get the value of the cell as an error code. For strings, numbers, and bools, we throw an exception.
  24613. For blank cells we return a 0.
  24614. </summary>
  24615. <value>The error cell value.</value>
  24616. </member>
  24617. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellStyle">
  24618. <summary>
  24619. Get the style for the cell. This is a reference to a cell style contained in the workbook
  24620. object.
  24621. </summary>
  24622. <value>The cell style.</value>
  24623. </member>
  24624. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellValueRecord">
  24625. <summary>
  24626. Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record
  24627. </summary>
  24628. <value>the cell via the low level api.</value>
  24629. </member>
  24630. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellComment">
  24631. <summary>
  24632. Returns comment associated with this cell
  24633. </summary>
  24634. <value>The cell comment associated with this cell.</value>
  24635. </member>
  24636. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ColumnIndex">
  24637. <summary>
  24638. Gets the index of the column.
  24639. </summary>
  24640. <value>The index of the column.</value>
  24641. </member>
  24642. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RowIndex">
  24643. <summary>
  24644. Gets the (zero based) index of the row containing this cell
  24645. </summary>
  24646. <value>The index of the row.</value>
  24647. </member>
  24648. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Hyperlink">
  24649. <summary>
  24650. Returns hyperlink associated with this cell
  24651. </summary>
  24652. <value>The hyperlink associated with this cell or null if not found</value>
  24653. </member>
  24654. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CachedFormulaResultType">
  24655. <summary>
  24656. Only valid for formula cells
  24657. </summary>
  24658. <value>one of (CellType.Numeric,CellType.String, CellType.Boolean, CellType.Error) depending
  24659. on the cached value of the formula</value>
  24660. </member>
  24661. <member name="T:NPOI.HSSF.UserModel.HSSFCellStyle">
  24662. <summary>
  24663. High level representation of the style of a cell in a sheet of a workbook.
  24664. @author Andrew C. Oliver (acoliver at apache dot org)
  24665. @author Jason Height (jheight at chariot dot net dot au)
  24666. </summary>
  24667. </member>
  24668. <member name="M:NPOI.SS.UserModel.ICellStyle.GetDataFormatString">
  24669. Get the format string
  24670. </member>
  24671. <member name="M:NPOI.SS.UserModel.ICellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  24672. set the font for this style
  24673. @param font a font object Created or retreived from the Workbook object
  24674. @see Workbook#CreateFont()
  24675. @see Workbook#GetFontAt(short)
  24676. </member>
  24677. <member name="M:NPOI.SS.UserModel.ICellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  24678. Clones all the style information from another
  24679. CellStyle, onto this one. This
  24680. CellStyle will then have all the same
  24681. properties as the source, but the two may
  24682. be edited independently.
  24683. Any stylings on this CellStyle will be lost!
  24684. The source CellStyle could be from another
  24685. Workbook if you like. This allows you to
  24686. copy styles from one Workbook to another.
  24687. However, both of the CellStyles will need
  24688. to be of the same type (HSSFCellStyle or
  24689. XSSFCellStyle)
  24690. </member>
  24691. <member name="P:NPOI.SS.UserModel.ICellStyle.Index">
  24692. get the index within the Workbook (sequence within the collection of ExtnededFormat objects)
  24693. @return unique index number of the underlying record this style represents (probably you don't care
  24694. unless you're comparing which one is which)
  24695. </member>
  24696. <member name="P:NPOI.SS.UserModel.ICellStyle.DataFormat">
  24697. get the index of the format
  24698. @see DataFormat
  24699. </member>
  24700. <member name="P:NPOI.SS.UserModel.ICellStyle.FontIndex">
  24701. Gets the index of the font for this style
  24702. @see Workbook#GetFontAt(short)
  24703. </member>
  24704. <member name="P:NPOI.SS.UserModel.ICellStyle.IsHidden">
  24705. get whether the cell's using this style are to be hidden
  24706. @return hidden - whether the cell using this style should be hidden
  24707. </member>
  24708. <member name="P:NPOI.SS.UserModel.ICellStyle.IsLocked">
  24709. get whether the cell's using this style are to be locked
  24710. @return hidden - whether the cell using this style should be locked
  24711. </member>
  24712. <member name="P:NPOI.SS.UserModel.ICellStyle.Alignment">
  24713. get the type of horizontal alignment for the cell
  24714. @return align - the type of alignment
  24715. @see #ALIGN_GENERAL
  24716. @see #ALIGN_LEFT
  24717. @see #ALIGN_CENTER
  24718. @see #ALIGN_RIGHT
  24719. @see #ALIGN_FILL
  24720. @see #ALIGN_JUSTIFY
  24721. @see #ALIGN_CENTER_SELECTION
  24722. </member>
  24723. <member name="P:NPOI.SS.UserModel.ICellStyle.WrapText">
  24724. get whether the text should be wrapped
  24725. @return wrap text or not
  24726. </member>
  24727. <member name="P:NPOI.SS.UserModel.ICellStyle.VerticalAlignment">
  24728. get the type of vertical alignment for the cell
  24729. @return align the type of alignment
  24730. @see #VERTICAL_TOP
  24731. @see #VERTICAL_CENTER
  24732. @see #VERTICAL_BOTTOM
  24733. @see #VERTICAL_JUSTIFY
  24734. </member>
  24735. <member name="P:NPOI.SS.UserModel.ICellStyle.Rotation">
  24736. get the degree of rotation for the text in the cell
  24737. @return rotation degrees (between -90 and 90 degrees)
  24738. </member>
  24739. <member name="P:NPOI.SS.UserModel.ICellStyle.Indention">
  24740. get the number of spaces to indent the text in the cell
  24741. @return indent - number of spaces
  24742. </member>
  24743. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderLeft">
  24744. get the type of border to use for the left border of the cell
  24745. @return border type
  24746. @see #BORDER_NONE
  24747. @see #BORDER_THIN
  24748. @see #BORDER_MEDIUM
  24749. @see #BORDER_DASHED
  24750. @see #BORDER_DOTTED
  24751. @see #BORDER_THICK
  24752. @see #BORDER_DOUBLE
  24753. @see #BORDER_HAIR
  24754. @see #BORDER_MEDIUM_DASHED
  24755. @see #BORDER_DASH_DOT
  24756. @see #BORDER_MEDIUM_DASH_DOT
  24757. @see #BORDER_DASH_DOT_DOT
  24758. @see #BORDER_MEDIUM_DASH_DOT_DOT
  24759. @see #BORDER_SLANTED_DASH_DOT
  24760. </member>
  24761. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderRight">
  24762. get the type of border to use for the right border of the cell
  24763. @return border type
  24764. @see #BORDER_NONE
  24765. @see #BORDER_THIN
  24766. @see #BORDER_MEDIUM
  24767. @see #BORDER_DASHED
  24768. @see #BORDER_DOTTED
  24769. @see #BORDER_THICK
  24770. @see #BORDER_DOUBLE
  24771. @see #BORDER_HAIR
  24772. @see #BORDER_MEDIUM_DASHED
  24773. @see #BORDER_DASH_DOT
  24774. @see #BORDER_MEDIUM_DASH_DOT
  24775. @see #BORDER_DASH_DOT_DOT
  24776. @see #BORDER_MEDIUM_DASH_DOT_DOT
  24777. @see #BORDER_SLANTED_DASH_DOT
  24778. </member>
  24779. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderTop">
  24780. get the type of border to use for the top border of the cell
  24781. @return border type
  24782. @see #BORDER_NONE
  24783. @see #BORDER_THIN
  24784. @see #BORDER_MEDIUM
  24785. @see #BORDER_DASHED
  24786. @see #BORDER_DOTTED
  24787. @see #BORDER_THICK
  24788. @see #BORDER_DOUBLE
  24789. @see #BORDER_HAIR
  24790. @see #BORDER_MEDIUM_DASHED
  24791. @see #BORDER_DASH_DOT
  24792. @see #BORDER_MEDIUM_DASH_DOT
  24793. @see #BORDER_DASH_DOT_DOT
  24794. @see #BORDER_MEDIUM_DASH_DOT_DOT
  24795. @see #BORDER_SLANTED_DASH_DOT
  24796. </member>
  24797. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderBottom">
  24798. get the type of border to use for the bottom border of the cell
  24799. @return border type
  24800. @see #BORDER_NONE
  24801. @see #BORDER_THIN
  24802. @see #BORDER_MEDIUM
  24803. @see #BORDER_DASHED
  24804. @see #BORDER_DOTTED
  24805. @see #BORDER_THICK
  24806. @see #BORDER_DOUBLE
  24807. @see #BORDER_HAIR
  24808. @see #BORDER_MEDIUM_DASHED
  24809. @see #BORDER_DASH_DOT
  24810. @see #BORDER_MEDIUM_DASH_DOT
  24811. @see #BORDER_DASH_DOT_DOT
  24812. @see #BORDER_MEDIUM_DASH_DOT_DOT
  24813. @see #BORDER_SLANTED_DASH_DOT
  24814. </member>
  24815. <member name="P:NPOI.SS.UserModel.ICellStyle.LeftBorderColor">
  24816. get the color to use for the left border
  24817. </member>
  24818. <member name="P:NPOI.SS.UserModel.ICellStyle.RightBorderColor">
  24819. get the color to use for the left border
  24820. @return the index of the color defInition
  24821. </member>
  24822. <member name="P:NPOI.SS.UserModel.ICellStyle.TopBorderColor">
  24823. get the color to use for the top border
  24824. @return hhe index of the color defInition
  24825. </member>
  24826. <member name="P:NPOI.SS.UserModel.ICellStyle.BottomBorderColor">
  24827. get the color to use for the left border
  24828. @return the index of the color defInition
  24829. </member>
  24830. <member name="P:NPOI.SS.UserModel.ICellStyle.FillPattern">
  24831. get the fill pattern (??) - set to 1 to fill with foreground color
  24832. @return fill pattern
  24833. </member>
  24834. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColor">
  24835. get the background fill color
  24836. @return fill color
  24837. </member>
  24838. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColor">
  24839. get the foreground fill color
  24840. @return fill color
  24841. </member>
  24842. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalColor">
  24843. <summary>
  24844. Gets or sets the color to use for the diagional border
  24845. </summary>
  24846. <value>The index of the color definition.</value>
  24847. </member>
  24848. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalLineStyle">
  24849. <summary>
  24850. Gets or sets the line type to use for the diagional border
  24851. </summary>
  24852. <value>The line type.</value>
  24853. </member>
  24854. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonal">
  24855. <summary>
  24856. Gets or sets the type of diagional border
  24857. </summary>.
  24858. <value>The border diagional type.</value>
  24859. </member>
  24860. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColorColor">
  24861. Gets the color object representing the current
  24862. background fill, resolving indexes using
  24863. the supplied workbook.
  24864. This will work for both indexed and rgb
  24865. defined colors.
  24866. </member>
  24867. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColorColor">
  24868. Gets the color object representing the current
  24869. foreground fill, resolving indexes using
  24870. the supplied workbook.
  24871. This will work for both indexed and rgb
  24872. defined colors.
  24873. </member>
  24874. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.UserModel.HSSFWorkbook)">
  24875. <summary>
  24876. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  24877. </summary>
  24878. <param name="index">The index.</param>
  24879. <param name="rec">The record.</param>
  24880. <param name="workbook">The workbook.</param>
  24881. </member>
  24882. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.Model.InternalWorkbook)">
  24883. <summary>
  24884. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  24885. </summary>
  24886. <param name="index">The index.</param>
  24887. <param name="rec">The record.</param>
  24888. <param name="workbook">The workbook.</param>
  24889. </member>
  24890. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString">
  24891. <summary>
  24892. Get the contents of the format string, by looking up
  24893. the DataFormat against the bound workbook
  24894. </summary>
  24895. <returns></returns>
  24896. </member>
  24897. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.HSSF.Model.InternalWorkbook)">
  24898. <summary>
  24899. Get the contents of the format string, by looking up
  24900. the DataFormat against the supplied workbook
  24901. </summary>
  24902. <param name="workbook">The workbook.</param>
  24903. <returns></returns>
  24904. </member>
  24905. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  24906. <summary>
  24907. Set the font for this style
  24908. </summary>
  24909. <param name="font">a font object Created or retreived from the HSSFWorkbook object</param>
  24910. </member>
  24911. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetFont(NPOI.SS.UserModel.IWorkbook)">
  24912. <summary>
  24913. Gets the font for this style
  24914. </summary>
  24915. <param name="parentWorkbook">The parent workbook that this style belongs to.</param>
  24916. <returns></returns>
  24917. </member>
  24918. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.VerifyBelongsToWorkbook(NPOI.HSSF.UserModel.HSSFWorkbook)">
  24919. <summary>
  24920. Verifies that this style belongs to the supplied Workbook.
  24921. Will throw an exception if it belongs to a different one.
  24922. This is normally called when trying to assign a style to a
  24923. cell, to ensure the cell and the style are from the same
  24924. workbook (if they're not, it won't work)
  24925. </summary>
  24926. <param name="wb">The workbook.</param>
  24927. </member>
  24928. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CheckDefaultBackgroundFills">
  24929. <summary>
  24930. Checks if the background and foreground Fills are Set correctly when one
  24931. or the other is Set to the default color.
  24932. Works like the logic table below:
  24933. BACKGROUND FOREGROUND
  24934. NONE AUTOMATIC
  24935. 0x41 0x40
  24936. NONE RED/ANYTHING
  24937. 0x40 0xSOMETHING
  24938. </summary>
  24939. </member>
  24940. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  24941. Clones all the style information from another
  24942. HSSFCellStyle, onto this one. This
  24943. HSSFCellStyle will then have all the same
  24944. properties as the source, but the two may
  24945. be edited independently.
  24946. Any stylings on this HSSFCellStyle will be lost!
  24947. The source HSSFCellStyle could be from another
  24948. HSSFWorkbook if you like. This allows you to
  24949. copy styles from one HSSFWorkbook to another.
  24950. </member>
  24951. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.HSSF.UserModel.HSSFCellStyle)">
  24952. <summary>
  24953. Clones all the style information from another
  24954. HSSFCellStyle, onto this one. This
  24955. HSSFCellStyle will then have all the same
  24956. properties as the source, but the two may
  24957. be edited independently.
  24958. Any stylings on this HSSFCellStyle will be lost!
  24959. The source HSSFCellStyle could be from another
  24960. HSSFWorkbook if you like. This allows you to
  24961. copy styles from one HSSFWorkbook to another.
  24962. </summary>
  24963. <param name="source">The source.</param>
  24964. </member>
  24965. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetHashCode">
  24966. <summary>
  24967. Serves as a hash function for a particular type.
  24968. </summary>
  24969. <returns>
  24970. A hash code for the current <see cref="T:System.Object"/>.
  24971. </returns>
  24972. </member>
  24973. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.Equals(System.Object)">
  24974. <summary>
  24975. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  24976. </summary>
  24977. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  24978. <returns>
  24979. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  24980. </returns>
  24981. <exception cref="T:System.NullReferenceException">
  24982. The <paramref name="obj"/> parameter is null.
  24983. </exception>
  24984. </member>
  24985. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Index">
  24986. <summary>
  24987. Get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects)
  24988. </summary>
  24989. <value>Unique index number of the Underlying record this style represents (probably you don't care
  24990. Unless you're comparing which one is which)</value>
  24991. </member>
  24992. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ParentStyle">
  24993. <summary>
  24994. Gets the parent style.
  24995. </summary>
  24996. <value>the parent style for this cell style.
  24997. In most cases this will be null, but in a few
  24998. cases there'll be a fully defined parent.</value>
  24999. </member>
  25000. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.DataFormat">
  25001. <summary>
  25002. Get the index of the format
  25003. </summary>
  25004. <value>The data format.</value>
  25005. </member>
  25006. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FontIndex">
  25007. <summary>
  25008. Gets the index of the font for this style.
  25009. </summary>
  25010. <value>The index of the font.</value>
  25011. </member>
  25012. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsHidden">
  25013. <summary>
  25014. Get whether the cell's using this style are to be hidden
  25015. </summary>
  25016. <value>whether the cell using this style should be hidden</value>
  25017. </member>
  25018. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsLocked">
  25019. <summary>
  25020. Get whether the cell's using this style are to be locked
  25021. </summary>
  25022. <value>whether the cell using this style should be locked</value>
  25023. </member>
  25024. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Alignment">
  25025. <summary>
  25026. Get the type of horizontal alignment for the cell
  25027. </summary>
  25028. <value> the type of alignment</value>
  25029. </member>
  25030. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.WrapText">
  25031. <summary>
  25032. Gets or sets a value indicating whether the text should be wrapped
  25033. </summary>
  25034. <value><c>true</c> if [wrap text]; otherwise, <c>false</c>.</value>
  25035. </member>
  25036. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.VerticalAlignment">
  25037. <summary>
  25038. Gets or sets the vertical alignment for the cell.
  25039. </summary>
  25040. <value>the type of alignment</value>
  25041. </member>
  25042. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Rotation">
  25043. <summary>
  25044. Gets or sets the degree of rotation for the text in the cell
  25045. </summary>
  25046. <value>The rotation degrees (between -90 and 90 degrees).</value>
  25047. </member>
  25048. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Indention">
  25049. <summary>
  25050. Gets or sets the number of spaces to indent the text in the cell
  25051. </summary>
  25052. <value>number of spaces</value>
  25053. </member>
  25054. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderLeft">
  25055. <summary>
  25056. Gets or sets the type of border to use for the left border of the cell
  25057. </summary>
  25058. <value>The border type.</value>
  25059. </member>
  25060. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderRight">
  25061. <summary>
  25062. Gets or sets the type of border to use for the right border of the cell
  25063. </summary>
  25064. <value>The border type.</value>
  25065. </member>
  25066. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderTop">
  25067. <summary>
  25068. Gets or sets the type of border to use for the top border of the cell
  25069. </summary>
  25070. <value>The border type.</value>
  25071. </member>
  25072. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderBottom">
  25073. <summary>
  25074. Gets or sets the type of border to use for the bottom border of the cell
  25075. </summary>
  25076. <value>The border type.</value>
  25077. </member>
  25078. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.LeftBorderColor">
  25079. <summary>
  25080. Gets or sets the color to use for the left border
  25081. </summary>
  25082. <value>The index of the color definition</value>
  25083. </member>
  25084. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.RightBorderColor">
  25085. <summary>
  25086. Gets or sets the color to use for the left border.
  25087. </summary>
  25088. <value>The index of the color definition</value>
  25089. </member>
  25090. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.TopBorderColor">
  25091. <summary>
  25092. Gets or sets the color to use for the top border
  25093. </summary>
  25094. <value>The index of the color definition.</value>
  25095. </member>
  25096. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BottomBorderColor">
  25097. <summary>
  25098. Gets or sets the color to use for the left border
  25099. </summary>
  25100. <value>The index of the color definition.</value>
  25101. </member>
  25102. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalColor">
  25103. <summary>
  25104. Gets or sets the color to use for the diagional border
  25105. </summary>
  25106. <value>The index of the color definition.</value>
  25107. </member>
  25108. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalLineStyle">
  25109. <summary>
  25110. Gets or sets the line type to use for the diagional border
  25111. </summary>
  25112. <value>The line type.</value>
  25113. </member>
  25114. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonal">
  25115. <summary>
  25116. Gets or sets the type of diagional border
  25117. </summary>.
  25118. <value>The border diagional type.</value>
  25119. </member>
  25120. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ShrinkToFit">
  25121. <summary>
  25122. Gets or sets whether the cell is shrink-to-fit
  25123. </summary>
  25124. </member>
  25125. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillPattern">
  25126. <summary>
  25127. Gets or sets the fill pattern. - Set to 1 to Fill with foreground color
  25128. </summary>
  25129. <value>The fill pattern.</value>
  25130. </member>
  25131. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillBackgroundColor">
  25132. <summary>
  25133. Gets or sets the color of the fill background.
  25134. </summary>
  25135. <value>The color of the fill background.</value>
  25136. Set the background Fill color.
  25137. <example>
  25138. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  25139. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  25140. optionally a Foreground and background Fill can be applied:
  25141. Note: Ensure Foreground color is Set prior to background
  25142. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  25143. cs.SetFillForegroundColor(new HSSFColor.BLUE().Index);
  25144. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  25145. or, for the special case of SOLID_Fill:
  25146. cs.SetFillPattern(HSSFCellStyle.SOLID_FOREGROUND );
  25147. cs.SetFillForegroundColor(new HSSFColor.RED().Index);
  25148. It is necessary to Set the Fill style in order
  25149. for the color to be shown in the cell.
  25150. </example>
  25151. </member>
  25152. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillForegroundColor">
  25153. <summary>
  25154. Gets or sets the foreground Fill color
  25155. </summary>
  25156. <value>Fill color.</value>
  25157. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  25158. </member>
  25159. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.UserStyleName">
  25160. Gets the name of the user defined style.
  25161. Returns null for built in styles, and
  25162. styles where no name has been defined
  25163. </member>
  25164. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(NPOI.DDF.EscherChildAnchorRecord)">
  25165. create anchor from existing file
  25166. @param escherChildAnchorRecord
  25167. </member>
  25168. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  25169. create anchor from scratch
  25170. @param dx1 x coordinate of the left up corner
  25171. @param dy1 y coordinate of the left up corner
  25172. @param dx2 x coordinate of the right down corner
  25173. @param dy2 y coordinate of the right down corner
  25174. </member>
  25175. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.SetAnchor(System.Int32,System.Int32,System.Int32,System.Int32)">
  25176. @param dx1 x coordinate of the left up corner
  25177. @param dy1 y coordinate of the left up corner
  25178. @param dx2 x coordinate of the right down corner
  25179. @param dy2 y coordinate of the right down corner
  25180. </member>
  25181. <member name="T:NPOI.HSSF.UserModel.HSSFClientAnchor">
  25182. <summary>
  25183. A client anchor Is attached to an excel worksheet. It anchors against a
  25184. top-left and buttom-right cell.
  25185. @author Glen Stampoultzis (glens at apache.org)
  25186. </summary>
  25187. </member>
  25188. <member name="T:NPOI.SS.UserModel.IClientAnchor">
  25189. A client anchor is attached to an excel worksheet. It anchors against a
  25190. top-left and bottom-right cell.
  25191. @author Yegor Kozlov
  25192. </member>
  25193. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col1">
  25194. Returns the column (0 based) of the first cell.
  25195. @return 0-based column of the first cell.
  25196. </member>
  25197. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col2">
  25198. Returns the column (0 based) of the second cell.
  25199. @return 0-based column of the second cell.
  25200. </member>
  25201. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row1">
  25202. Returns the row (0 based) of the first cell.
  25203. @return 0-based row of the first cell.
  25204. </member>
  25205. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row2">
  25206. Returns the row (0 based) of the second cell.
  25207. @return 0-based row of the second cell.
  25208. </member>
  25209. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx1">
  25210. Returns the x coordinate within the first cell
  25211. @return the x coordinate within the first cell
  25212. </member>
  25213. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy1">
  25214. Returns the y coordinate within the first cell
  25215. @return the y coordinate within the first cell
  25216. </member>
  25217. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy2">
  25218. Sets the y coordinate within the second cell
  25219. @return the y coordinate within the second cell
  25220. </member>
  25221. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx2">
  25222. Returns the x coordinate within the second cell
  25223. @return the x coordinate within the second cell
  25224. </member>
  25225. <member name="P:NPOI.SS.UserModel.IClientAnchor.AnchorType">
  25226. s the anchor type
  25227. <p>
  25228. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  25229. </p>
  25230. @return the anchor type
  25231. @see #MOVE_AND_RESIZE
  25232. @see #MOVE_DONT_RESIZE
  25233. @see #DONT_MOVE_AND_RESIZE
  25234. </member>
  25235. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor">
  25236. <summary>
  25237. Creates a new client anchor and defaults all the anchor positions to 0.
  25238. </summary>
  25239. </member>
  25240. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  25241. <summary>
  25242. Creates a new client anchor and Sets the top-left and bottom-right
  25243. coordinates of the anchor.
  25244. </summary>
  25245. <param name="dx1">the x coordinate within the first cell.</param>
  25246. <param name="dy1">the y coordinate within the first cell.</param>
  25247. <param name="dx2">the x coordinate within the second cell.</param>
  25248. <param name="dy2">the y coordinate within the second cell.</param>
  25249. <param name="col1">the column (0 based) of the first cell.</param>
  25250. <param name="row1">the row (0 based) of the first cell.</param>
  25251. <param name="col2">the column (0 based) of the second cell.</param>
  25252. <param name="row2">the row (0 based) of the second cell.</param>
  25253. </member>
  25254. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetAnchorHeightInPoints(NPOI.SS.UserModel.ISheet)">
  25255. <summary>
  25256. Calculates the height of a client anchor in points.
  25257. </summary>
  25258. <param name="sheet">the sheet the anchor will be attached to</param>
  25259. <returns>the shape height.</returns>
  25260. </member>
  25261. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetRowHeightInPoints(NPOI.SS.UserModel.ISheet,System.Int32)">
  25262. <summary>
  25263. Gets the row height in points.
  25264. </summary>
  25265. <param name="sheet">The sheet.</param>
  25266. <param name="rowNum">The row num.</param>
  25267. <returns></returns>
  25268. </member>
  25269. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.SetAnchor(System.Int16,System.Int32,System.Int32,System.Int32,System.Int16,System.Int32,System.Int32,System.Int32)">
  25270. <summary>
  25271. Sets the top-left and bottom-right
  25272. coordinates of the anchor
  25273. </summary>
  25274. <param name="col1">the column (0 based) of the first cell.</param>
  25275. <param name="row1"> the row (0 based) of the first cell.</param>
  25276. <param name="x1">the x coordinate within the first cell.</param>
  25277. <param name="y1">the y coordinate within the first cell.</param>
  25278. <param name="col2">the column (0 based) of the second cell.</param>
  25279. <param name="row2">the row (0 based) of the second cell.</param>
  25280. <param name="x2">the x coordinate within the second cell.</param>
  25281. <param name="y2">the y coordinate within the second cell.</param>
  25282. </member>
  25283. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.CheckRange(System.Int32,System.Int32,System.Int32,System.String)">
  25284. <summary>
  25285. Checks the range.
  25286. </summary>
  25287. <param name="value">The value.</param>
  25288. <param name="minRange">The min range.</param>
  25289. <param name="maxRange">The max range.</param>
  25290. <param name="varName">Name of the variable.</param>
  25291. </member>
  25292. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col1">
  25293. <summary>
  25294. Gets or sets the col1.
  25295. </summary>
  25296. <value>The col1.</value>
  25297. </member>
  25298. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col2">
  25299. <summary>
  25300. Gets or sets the col2.
  25301. </summary>
  25302. <value>The col2.</value>
  25303. </member>
  25304. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row1">
  25305. <summary>
  25306. Gets or sets the row1.
  25307. </summary>
  25308. <value>The row1.</value>
  25309. </member>
  25310. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row2">
  25311. <summary>
  25312. Gets or sets the row2.
  25313. </summary>
  25314. <value>The row2.</value>
  25315. </member>
  25316. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsHorizontallyFlipped">
  25317. <summary>
  25318. Gets a value indicating whether this instance is horizontally flipped.
  25319. </summary>
  25320. <value>
  25321. <c>true</c> if the anchor goes from right to left; otherwise, <c>false</c>.
  25322. </value>
  25323. </member>
  25324. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsVerticallyFlipped">
  25325. <summary>
  25326. Gets a value indicating whether this instance is vertically flipped.
  25327. </summary>
  25328. <value>
  25329. <c>true</c> if the anchor goes from bottom to top.; otherwise, <c>false</c>.
  25330. </value>
  25331. </member>
  25332. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.AnchorType">
  25333. <summary>
  25334. Gets the anchor type
  25335. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  25336. </summary>
  25337. <value>The type of the anchor.</value>
  25338. </member>
  25339. <member name="T:NPOI.HSSF.UserModel.HSSFComment">
  25340. <summary>
  25341. Represents a cell comment - a sticky note associated with a cell.
  25342. @author Yegor Kozlov
  25343. </summary>
  25344. </member>
  25345. <member name="T:NPOI.HSSF.UserModel.HSSFTextbox">
  25346. <summary>
  25347. A textbox Is a shape that may hold a rich text string.
  25348. @author Glen Stampoultzis (glens at apache.org)
  25349. </summary>
  25350. </member>
  25351. <member name="M:NPOI.HSSF.UserModel.HSSFTextbox.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  25352. <summary>
  25353. Construct a new textbox with the given parent and anchor.
  25354. </summary>
  25355. <param name="parent">The parent.</param>
  25356. <param name="anchor">One of HSSFClientAnchor or HSSFChildAnchor</param>
  25357. </member>
  25358. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginLeft">
  25359. <summary>
  25360. Gets or sets the left margin within the textbox.
  25361. </summary>
  25362. <value>The margin left.</value>
  25363. </member>
  25364. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginRight">
  25365. <summary>
  25366. Gets or sets the right margin within the textbox.
  25367. </summary>
  25368. <value>The margin right.</value>
  25369. </member>
  25370. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginTop">
  25371. <summary>
  25372. Gets or sets the top margin within the textbox
  25373. </summary>
  25374. <value>The top margin.</value>
  25375. </member>
  25376. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginBottom">
  25377. <summary>
  25378. Gets or sets the bottom margin within the textbox.
  25379. </summary>
  25380. <value>The margin bottom.</value>
  25381. </member>
  25382. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.HorizontalAlignment">
  25383. <summary>
  25384. Gets or sets the horizontal alignment.
  25385. </summary>
  25386. <value>The horizontal alignment.</value>
  25387. </member>
  25388. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.VerticalAlignment">
  25389. <summary>
  25390. Gets or sets the vertical alignment.
  25391. </summary>
  25392. <value>The vertical alignment.</value>
  25393. </member>
  25394. <member name="P:NPOI.SS.UserModel.IComment.Visible">
  25395. Sets whether this comment is visible.
  25396. @return <c>true</c> if the comment is visible, <c>false</c> otherwise
  25397. </member>
  25398. <member name="P:NPOI.SS.UserModel.IComment.Row">
  25399. Return the row of the cell that Contains the comment
  25400. @return the 0-based row of the cell that Contains the comment
  25401. </member>
  25402. <member name="P:NPOI.SS.UserModel.IComment.Column">
  25403. Return the column of the cell that Contains the comment
  25404. @return the 0-based column of the cell that Contains the comment
  25405. </member>
  25406. <member name="P:NPOI.SS.UserModel.IComment.Author">
  25407. Name of the original comment author
  25408. @return the name of the original author of the comment
  25409. </member>
  25410. <member name="P:NPOI.SS.UserModel.IComment.String">
  25411. Fetches the rich text string of the comment
  25412. </member>
  25413. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  25414. <summary>
  25415. Construct a new comment with the given parent and anchor.
  25416. </summary>
  25417. <param name="parent"></param>
  25418. <param name="anchor">defines position of this anchor in the sheet</param>
  25419. </member>
  25420. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.Record.NoteRecord,NPOI.HSSF.Record.TextObjectRecord)">
  25421. <summary>
  25422. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> class.
  25423. </summary>
  25424. <param name="note">The note.</param>
  25425. <param name="txo">The txo.</param>
  25426. </member>
  25427. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Visible">
  25428. <summary>
  25429. Gets or sets a value indicating whether this <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> is visible.
  25430. </summary>
  25431. <value><c>true</c> if visible; otherwise, <c>false</c>.</value>
  25432. Sets whether this comment Is visible.
  25433. @return
  25434. <c>true</c>
  25435. if the comment Is visible,
  25436. <c>false</c>
  25437. otherwise
  25438. </member>
  25439. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Row">
  25440. <summary>
  25441. Gets or sets the row of the cell that Contains the comment
  25442. </summary>
  25443. <value>the 0-based row of the cell that Contains the comment</value>
  25444. </member>
  25445. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Column">
  25446. <summary>
  25447. Gets or sets the column of the cell that Contains the comment
  25448. </summary>
  25449. <value>the 0-based column of the cell that Contains the comment</value>
  25450. </member>
  25451. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Author">
  25452. <summary>
  25453. Gets or sets the name of the original comment author
  25454. </summary>
  25455. <value>the name of the original author of the comment</value>
  25456. </member>
  25457. <member name="P:NPOI.HSSF.UserModel.HSSFComment.NoteRecord">
  25458. <summary>
  25459. Gets the note record.
  25460. </summary>
  25461. <value>the underlying Note record.</value>
  25462. </member>
  25463. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting">
  25464. <summary>
  25465. HSSFConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  25466. The class can be used to make a copy HSSFConditionalFormatting Settings
  25467. </summary>
  25468. <example>
  25469. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  25470. newSheet.AddConditionalFormatting(cf);
  25471. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  25472. Use {@link HSSFSheet#GetConditionalFormattingAt(int)} to Get access to an instance of this class.
  25473. To Create a new Conditional Formatting Set use the following approach:
  25474. // Define a Conditional Formatting rule, which triggers formatting
  25475. // when cell's value Is greater or equal than 100.0 and
  25476. // applies patternFormatting defined below.
  25477. HSSFConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  25478. ComparisonOperator.GE,
  25479. "100.0", // 1st formula
  25480. null // 2nd formula Is not used for comparison operator GE
  25481. );
  25482. // Create pattern with red background
  25483. HSSFPatternFormatting patternFmt = rule.cretePatternFormatting();
  25484. patternFormatting.SetFillBackgroundColor(HSSFColor.RED.index);
  25485. // Define a region containing first column
  25486. Region [] regions =
  25487. {
  25488. new Region(1,(short)1,-1,(short)1)
  25489. };
  25490. // Apply Conditional Formatting rule defined above to the regions
  25491. sheet.AddConditionalFormatting(regions, rule);
  25492. </example>
  25493. <remarks>@author Dmitriy Kumshayev</remarks>
  25494. </member>
  25495. <member name="T:NPOI.SS.UserModel.IConditionalFormatting">
  25496. The ConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  25497. The class can be used
  25498. <UL>
  25499. <LI>
  25500. to make a copy ConditionalFormatting Settings.
  25501. </LI>
  25502. For example:
  25503. <PRE>
  25504. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  25505. newSheet.AddConditionalFormatting(cf);
  25506. </PRE>
  25507. <LI>
  25508. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  25509. </LI>
  25510. </UL>
  25511. Use {@link NPOI.HSSF.UserModel.Sheet#getSheetConditionalFormatting()} to Get access to an instance of this class.
  25512. To create a new Conditional Formatting Set use the following approach:
  25513. <PRE>
  25514. // Define a Conditional Formatting rule, which triggers formatting
  25515. // when cell's value is greater or equal than 100.0 and
  25516. // applies patternFormatting defined below.
  25517. ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  25518. ComparisonOperator.GE,
  25519. "100.0", // 1st formula
  25520. null // 2nd formula is not used for comparison operator GE
  25521. );
  25522. // Create pattern with red background
  25523. PatternFormatting patternFmt = rule.CretePatternFormatting();
  25524. patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
  25525. // Define a region Containing first column
  25526. Region [] regions =
  25527. {
  25528. new Region(1,(short)1,-1,(short)1)
  25529. };
  25530. // Apply Conditional Formatting rule defined above to the regions
  25531. sheet.AddConditionalFormatting(regions, rule);
  25532. </PRE>
  25533. @author Dmitriy Kumshayev
  25534. @author Yegor Kozlov
  25535. </member>
  25536. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetFormattingRanges">
  25537. @return array of <c>CellRangeAddress</c>s. Never <code>null</code>
  25538. </member>
  25539. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  25540. Replaces an existing Conditional Formatting rule at position idx.
  25541. Excel allows to create up to 3 Conditional Formatting rules.
  25542. This method can be useful to modify existing Conditional Formatting rules.
  25543. @param idx position of the rule. Should be between 0 and 2.
  25544. @param cfRule - Conditional Formatting rule
  25545. </member>
  25546. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  25547. Add a Conditional Formatting rule.
  25548. Excel allows to create up to 3 Conditional Formatting rules.
  25549. @param cfRule - Conditional Formatting rule
  25550. </member>
  25551. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetRule(System.Int32)">
  25552. @return the Conditional Formatting rule at position idx.
  25553. </member>
  25554. <member name="P:NPOI.SS.UserModel.IConditionalFormatting.NumberOfRules">
  25555. @return number of Conditional Formatting rules.
  25556. </member>
  25557. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  25558. <summary>
  25559. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting"/> class.
  25560. </summary>
  25561. <param name="workbook">The workbook.</param>
  25562. <param name="cfAggregate">The cf aggregate.</param>
  25563. </member>
  25564. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRegions">
  25565. <summary>
  25566. Gets the array of Regions
  25567. </summary>
  25568. <returns></returns>
  25569. </member>
  25570. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRanges">
  25571. <summary>
  25572. Gets array of CellRangeAddresses
  25573. </summary>
  25574. <returns></returns>
  25575. </member>
  25576. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.SetRule(System.Int32,NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  25577. <summary>
  25578. Replaces an existing Conditional Formatting rule at position idx.
  25579. Excel allows to Create up to 3 Conditional Formatting rules.
  25580. This method can be useful to modify existing Conditional Formatting rules.
  25581. </summary>
  25582. <param name="idx">position of the rule. Should be between 0 and 2.</param>
  25583. <param name="cfRule">Conditional Formatting rule</param>
  25584. </member>
  25585. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.AddRule(NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  25586. <summary>
  25587. Add a Conditional Formatting rule.
  25588. Excel allows to Create up to 3 Conditional Formatting rules.
  25589. </summary>
  25590. <param name="cfRule">Conditional Formatting rule</param>
  25591. </member>
  25592. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetRule(System.Int32)">
  25593. <summary>
  25594. Gets the Conditional Formatting rule at position idx
  25595. </summary>
  25596. <param name="idx">The index.</param>
  25597. <returns></returns>
  25598. </member>
  25599. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.ToString">
  25600. <summary>
  25601. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25602. </summary>
  25603. <returns>
  25604. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25605. </returns>
  25606. </member>
  25607. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.CFRecordsAggregate">
  25608. <summary>
  25609. Gets the CF records aggregate.
  25610. </summary>
  25611. <returns></returns>
  25612. </member>
  25613. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.NumberOfRules">
  25614. <summary>
  25615. Gets the number of Conditional Formatting rules.
  25616. </summary>
  25617. <value>The number of rules.</value>
  25618. </member>
  25619. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule">
  25620. High level representation of Conditional Formatting Rule.
  25621. It allows to specify formula based conditions for the Conditional Formatting
  25622. and the formatting Settings such as font, border and pattern.
  25623. @author Dmitriy Kumshayev
  25624. </member>
  25625. <member name="T:NPOI.SS.UserModel.IConditionalFormattingRule">
  25626. Represents a description of a conditional formatting rule
  25627. @author Dmitriy Kumshayev
  25628. @author Yegor Kozlov
  25629. </member>
  25630. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateBorderFormatting">
  25631. Create a new border formatting structure if it does not exist,
  25632. otherwise just return existing object.
  25633. @return - border formatting object, never returns <code>null</code>.
  25634. </member>
  25635. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetBorderFormatting">
  25636. @return - border formatting object if defined, <code>null</code> otherwise
  25637. </member>
  25638. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateFontFormatting">
  25639. Create a new font formatting structure if it does not exist,
  25640. otherwise just return existing object.
  25641. @return - font formatting object, never returns <code>null</code>.
  25642. </member>
  25643. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetFontFormatting">
  25644. @return - font formatting object if defined, <code>null</code> otherwise
  25645. </member>
  25646. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreatePatternFormatting">
  25647. Create a new pattern formatting structure if it does not exist,
  25648. otherwise just return existing object.
  25649. @return - pattern formatting object, never returns <code>null</code>.
  25650. </member>
  25651. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetPatternFormatting">
  25652. @return - pattern formatting object if defined, <code>null</code> otherwise
  25653. </member>
  25654. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ConditionType">
  25655. Type of conditional formatting rule.
  25656. <p>
  25657. MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA}
  25658. </p>
  25659. @return the type of condition
  25660. </member>
  25661. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ComparisonOperation">
  25662. The comparison function used when the type of conditional formatting is Set to
  25663. {@link #CONDITION_TYPE_CELL_VALUE_IS}
  25664. <p>
  25665. MUST be a constant from {@link ComparisonOperator}
  25666. </p>
  25667. @return the conditional format operator
  25668. </member>
  25669. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula1">
  25670. The formula used to Evaluate the first operand for the conditional formatting rule.
  25671. <p>
  25672. If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS},
  25673. this field is the first operand of the comparison.
  25674. If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used
  25675. to determine if the conditional formatting is applied.
  25676. </p>
  25677. <p>
  25678. If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  25679. </p>
  25680. @return the first formula
  25681. </member>
  25682. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula2">
  25683. The formula used to Evaluate the second operand of the comparison when
  25684. comparison type is {@link #CONDITION_TYPE_CELL_VALUE_IS} and operator
  25685. is either {@link ComparisonOperator#BETWEEN} or {@link ComparisonOperator#NOT_BETWEEN}
  25686. @return the second formula
  25687. </member>
  25688. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetFontFormatting">
  25689. @return - font formatting object if defined, <c>null</c> otherwise
  25690. </member>
  25691. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateFontFormatting">
  25692. Create a new font formatting structure if it does not exist,
  25693. otherwise just return existing object.
  25694. @return - font formatting object, never returns <c>null</c>.
  25695. </member>
  25696. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetBorderFormatting">
  25697. @return - border formatting object if defined, <c>null</c> otherwise
  25698. </member>
  25699. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateBorderFormatting">
  25700. Create a new border formatting structure if it does not exist,
  25701. otherwise just return existing object.
  25702. @return - border formatting object, never returns <c>null</c>.
  25703. </member>
  25704. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetPatternFormatting">
  25705. @return - pattern formatting object if defined, <c>null</c> otherwise
  25706. </member>
  25707. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreatePatternFormatting">
  25708. Create a new pattern formatting structure if it does not exist,
  25709. otherwise just return existing object.
  25710. @return - pattern formatting object, never returns <c>null</c>.
  25711. </member>
  25712. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ConditionType">
  25713. @return - the conditiontype for the cfrule
  25714. </member>
  25715. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ComparisonOperation">
  25716. @return - the comparisionoperatation for the cfrule
  25717. </member>
  25718. <member name="T:NPOI.SS.UserModel.ICreationHelper">
  25719. An object that handles instantiating concrete
  25720. classes of the various instances one needs for
  25721. HSSF and XSSF.
  25722. Works around a major shortcoming in Java, where we
  25723. can't have static methods on interfaces or abstract
  25724. classes.
  25725. This allows you to get the appropriate class for
  25726. a given interface, without you having to worry
  25727. about if you're dealing with HSSF or XSSF, despite
  25728. Java being quite rubbish.
  25729. </member>
  25730. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateRichTextString(System.String)">
  25731. Creates a new RichTextString instance
  25732. @param text The text to Initialise the RichTextString with
  25733. </member>
  25734. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateDataFormat">
  25735. Creates a new DataFormat instance
  25736. </member>
  25737. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateHyperlink(NPOI.SS.UserModel.HyperlinkType)">
  25738. Creates a new Hyperlink, of the given type
  25739. </member>
  25740. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateFormulaEvaluator">
  25741. Creates FormulaEvaluator - an object that Evaluates formula cells.
  25742. @return a FormulaEvaluator instance
  25743. </member>
  25744. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateFormulaEvaluator">
  25745. Creates a HSSFFormulaEvaluator, the object that Evaluates formula cells.
  25746. @return a HSSFFormulaEvaluator instance
  25747. </member>
  25748. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateClientAnchor">
  25749. Creates a HSSFClientAnchor. Use this object to position drawing object in a sheet
  25750. @return a HSSFClientAnchor instance
  25751. @see NPOI.SS.usermodel.Drawing
  25752. </member>
  25753. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.String)">
  25754. get the format index that matches the given format string.
  25755. Creates a new format if one is not found. Aliases text to the proper format.
  25756. @param format string matching a built in format
  25757. @return index of format.
  25758. </member>
  25759. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.Int16)">
  25760. get the format string that matches the given format index
  25761. @param index of a format
  25762. @return string represented at index of format or null if there is not a format at that index
  25763. </member>
  25764. <member name="F:NPOI.HSSF.UserModel.HSSFDataFormat.FIRST_USER_DEFINED_FORMAT_INDEX">
  25765. The first user-defined format starts at 164.
  25766. </member>
  25767. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.#ctor(NPOI.HSSF.Model.InternalWorkbook)">
  25768. <summary>
  25769. Construncts a new data formatter. It takes a workbook to have
  25770. access to the workbooks format records.
  25771. </summary>
  25772. <param name="workbook">the workbook the formats are tied to.</param>
  25773. </member>
  25774. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.String)">
  25775. <summary>
  25776. Get the format index that matches the given format string
  25777. Automatically Converts "text" to excel's format string to represent text.
  25778. </summary>
  25779. <param name="format">The format string matching a built in format.</param>
  25780. <returns>index of format or -1 if Undefined.</returns>
  25781. </member>
  25782. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.String)">
  25783. <summary>
  25784. Get the format index that matches the given format
  25785. string, creating a new format entry if required.
  25786. Aliases text to the proper format as required.
  25787. </summary>
  25788. <param name="pFormat">The format string matching a built in format.</param>
  25789. <returns>index of format.</returns>
  25790. </member>
  25791. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.Int16)">
  25792. <summary>
  25793. Get the format string that matches the given format index
  25794. </summary>
  25795. <param name="index">The index of a format.</param>
  25796. <returns>string represented at index of format or null if there Is not a format at that index</returns>
  25797. </member>
  25798. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.Int16)">
  25799. <summary>
  25800. Get the format string that matches the given format index
  25801. </summary>
  25802. <param name="index">The index of a built in format.</param>
  25803. <returns>string represented at index of format or null if there Is not a builtin format at that index</returns>
  25804. </member>
  25805. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.EnsureFormatsSize(System.Int32)">
  25806. Ensures that the formats list can hold entries
  25807. up to and including the entry with this index
  25808. </member>
  25809. <member name="P:NPOI.HSSF.UserModel.HSSFDataFormat.NumberOfBuiltinBuiltinFormats">
  25810. <summary>
  25811. Get the number of builtin and reserved builtinFormats
  25812. </summary>
  25813. <returns>number of builtin and reserved builtinFormats</returns>
  25814. </member>
  25815. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationCell">
  25816. <summary>
  25817. HSSF wrapper for a cell under evaluation
  25818. @author Josh Micich
  25819. </summary>
  25820. </member>
  25821. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationSheet">
  25822. HSSF wrapper for a sheet under evaluation
  25823. @author Josh Micich
  25824. </member>
  25825. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook">
  25826. Internal POI use only
  25827. @author Josh Micich
  25828. </member>
  25829. <member name="T:NPOI.SS.Formula.IFormulaRenderingWorkbook">
  25830. Abstracts a workbook for the purpose of converting formula To text.<br/>
  25831. For POI internal use only
  25832. @author Josh Micich
  25833. </member>
  25834. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetExternalSheet(System.Int32)">
  25835. @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
  25836. </member>
  25837. <member name="T:NPOI.SS.Formula.IFormulaParsingWorkbook">
  25838. Abstracts a workbook for the purpose of formula parsing.<br/>
  25839. For POI internal use only
  25840. @author Josh Micich
  25841. </member>
  25842. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetName(System.String,System.Int32)">
  25843. <summary>
  25844. named range name matching is case insensitive
  25845. </summary>
  25846. <param name="name">The name.</param>
  25847. <param name="sheetIndex">Index of the sheet.</param>
  25848. <returns></returns>
  25849. </member>
  25850. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetNameXPtg(System.String)">
  25851. <summary>
  25852. Gets the name XPTG.
  25853. </summary>
  25854. <param name="name">The name.</param>
  25855. <returns></returns>
  25856. </member>
  25857. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String)">
  25858. <summary>
  25859. Gets the externSheet index for a sheet from this workbook
  25860. </summary>
  25861. <param name="sheetName">Name of the sheet.</param>
  25862. <returns></returns>
  25863. </member>
  25864. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String,System.String)">
  25865. <summary>
  25866. Gets the externSheet index for a sheet from an external workbook
  25867. </summary>
  25868. <param name="workbookName">Name of the workbook, e.g. "BudGet.xls"</param>
  25869. <param name="sheetName">a name of a sheet in that workbook</param>
  25870. <returns></returns>
  25871. </member>
  25872. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetSpreadsheetVersion">
  25873. <summary>
  25874. Returns an enum holding spReadhseet properties specific to an Excel version (
  25875. max column and row numbers, max arguments to a function, etc.)
  25876. </summary>
  25877. <returns></returns>
  25878. </member>
  25879. <member name="T:NPOI.SS.Formula.IEvaluationName">
  25880. Abstracts a name record for formula evaluation.<br/>
  25881. For POI internal use only
  25882. @author Josh Micich
  25883. </member>
  25884. <member name="T:NPOI.HSSF.UserModel.HSSFFont">
  25885. <summary>
  25886. Represents a Font used in a workbook.
  25887. @version 1.0-pre
  25888. @author Andrew C. Oliver
  25889. </summary>
  25890. </member>
  25891. <member name="P:NPOI.SS.UserModel.IFont.FontName">
  25892. get the name for the font (i.e. Arial)
  25893. @return String representing the name of the font to use
  25894. </member>
  25895. <member name="P:NPOI.SS.UserModel.IFont.FontHeight">
  25896. get the font height in unit's of 1/20th of a point. Maybe you might want to
  25897. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  25898. @return short - height in 1/20ths of a point
  25899. @see #GetFontHeightInPoints()
  25900. </member>
  25901. <member name="P:NPOI.SS.UserModel.IFont.FontHeightInPoints">
  25902. get the font height
  25903. @return short - height in the familiar unit of measure - points
  25904. @see #GetFontHeight()
  25905. </member>
  25906. <member name="P:NPOI.SS.UserModel.IFont.IsItalic">
  25907. get whether to use italics or not
  25908. @return italics or not
  25909. </member>
  25910. <member name="P:NPOI.SS.UserModel.IFont.IsStrikeout">
  25911. get whether to use a strikeout horizontal line through the text or not
  25912. @return strikeout or not
  25913. </member>
  25914. <member name="P:NPOI.SS.UserModel.IFont.Color">
  25915. get the color for the font
  25916. @return color to use
  25917. @see #COLOR_NORMAL
  25918. @see #COLOR_RED
  25919. @see NPOI.HSSF.usermodel.HSSFPalette#GetColor(short)
  25920. </member>
  25921. <member name="P:NPOI.SS.UserModel.IFont.TypeOffset">
  25922. get normal,super or subscript.
  25923. @return offset type to use (none,super,sub)
  25924. </member>
  25925. <member name="P:NPOI.SS.UserModel.IFont.Underline">
  25926. get type of text underlining to use
  25927. @return underlining type
  25928. </member>
  25929. <member name="P:NPOI.SS.UserModel.IFont.Charset">
  25930. get character-set to use.
  25931. @return character-set
  25932. @see #ANSI_CHARSET
  25933. @see #DEFAULT_CHARSET
  25934. @see #SYMBOL_CHARSET
  25935. </member>
  25936. <member name="P:NPOI.SS.UserModel.IFont.Index">
  25937. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  25938. @return unique index number of the underlying record this Font represents (probably you don't care
  25939. unless you're comparing which one is which)
  25940. </member>
  25941. <member name="M:NPOI.HSSF.UserModel.HSSFFont.#ctor(System.Int16,NPOI.HSSF.Record.FontRecord)">
  25942. <summary>
  25943. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFont"/> class.
  25944. </summary>
  25945. <param name="index">The index.</param>
  25946. <param name="rec">The record.</param>
  25947. </member>
  25948. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHSSFColor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  25949. <summary>
  25950. get the color value for the font
  25951. </summary>
  25952. <param name="wb">HSSFWorkbook</param>
  25953. <returns></returns>
  25954. </member>
  25955. <member name="M:NPOI.HSSF.UserModel.HSSFFont.ToString">
  25956. <summary>
  25957. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25958. </summary>
  25959. <returns>
  25960. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  25961. </returns>
  25962. </member>
  25963. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHashCode">
  25964. <summary>
  25965. Serves as a hash function for a particular type.
  25966. </summary>
  25967. <returns>
  25968. A hash code for the current <see cref="T:System.Object"/>.
  25969. </returns>
  25970. </member>
  25971. <member name="M:NPOI.HSSF.UserModel.HSSFFont.Equals(System.Object)">
  25972. <summary>
  25973. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  25974. </summary>
  25975. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  25976. <returns>
  25977. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  25978. </returns>
  25979. <exception cref="T:System.NullReferenceException">
  25980. The <paramref name="obj"/> parameter is null.
  25981. </exception>
  25982. </member>
  25983. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontName">
  25984. <summary>
  25985. Get the name for the font (i.e. Arial)
  25986. </summary>
  25987. <value>the name of the font to use</value>
  25988. </member>
  25989. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Index">
  25990. <summary>
  25991. Get the index within the HSSFWorkbook (sequence within the collection of Font objects)
  25992. </summary>
  25993. <value>Unique index number of the Underlying record this Font represents (probably you don't care
  25994. Unless you're comparing which one is which)</value>
  25995. </member>
  25996. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeight">
  25997. <summary>
  25998. Get or sets the font height in Unit's of 1/20th of a point. Maybe you might want to
  25999. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  26000. </summary>
  26001. <value>height in 1/20ths of a point.</value>
  26002. </member>
  26003. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeightInPoints">
  26004. <summary>
  26005. Gets or sets the font height in points.
  26006. </summary>
  26007. <value>height in the familiar Unit of measure - points.</value>
  26008. </member>
  26009. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsItalic">
  26010. <summary>
  26011. Gets or sets whether to use italics or not
  26012. </summary>
  26013. <value><c>true</c> if this instance is italic; otherwise, <c>false</c>.</value>
  26014. </member>
  26015. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsStrikeout">
  26016. <summary>
  26017. Get whether to use a strikeout horizontal line through the text or not
  26018. </summary>
  26019. <value>
  26020. strikeout or not
  26021. </value>
  26022. </member>
  26023. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Color">
  26024. <summary>
  26025. Gets or sets the color for the font.
  26026. </summary>
  26027. <value>The color to use.</value>
  26028. </member>
  26029. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Boldweight">
  26030. <summary>
  26031. Gets or sets the boldness to use
  26032. </summary>
  26033. <value>The boldweight.</value>
  26034. </member>
  26035. <member name="P:NPOI.HSSF.UserModel.HSSFFont.TypeOffset">
  26036. <summary>
  26037. Gets or sets normal,base or subscript.
  26038. </summary>
  26039. <value>offset type to use (none,base,sub)</value>
  26040. </member>
  26041. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Underline">
  26042. <summary>
  26043. Gets or sets the type of text Underlining to use
  26044. </summary>
  26045. <value>The Underlining type.</value>
  26046. </member>
  26047. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Charset">
  26048. <summary>
  26049. Gets or sets the char set to use.
  26050. </summary>
  26051. <value>The char set.</value>
  26052. </member>
  26053. <member name="T:NPOI.HSSF.UserModel.HSSFFontFormatting">
  26054. High level representation for Font Formatting component
  26055. of Conditional Formatting Settings
  26056. @author Dmitriy Kumshayev
  26057. </member>
  26058. <member name="T:NPOI.SS.UserModel.IFontFormatting">
  26059. High level representation for Font Formatting component
  26060. of Conditional Formatting Settings
  26061. @author Dmitriy Kumshayev
  26062. @author Yegor Kozlov
  26063. </member>
  26064. <member name="M:NPOI.SS.UserModel.IFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  26065. Set font style options.
  26066. @param italic - if true, Set posture style to italic, otherwise to normal
  26067. @param bold if true, Set font weight to bold, otherwise to normal
  26068. </member>
  26069. <member name="M:NPOI.SS.UserModel.IFontFormatting.ResetFontStyle">
  26070. Set font style options to default values (non-italic, non-bold)
  26071. </member>
  26072. <member name="P:NPOI.SS.UserModel.IFontFormatting.EscapementType">
  26073. <summary>
  26074. get or set the type of super or subscript for the font
  26075. </summary>
  26076. </member>
  26077. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColorIndex">
  26078. <summary>
  26079. get or set font color index
  26080. </summary>
  26081. </member>
  26082. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontHeight">
  26083. <summary>
  26084. get or set the height of the font in 1/20th point units
  26085. </summary>
  26086. </member>
  26087. <member name="P:NPOI.SS.UserModel.IFontFormatting.UnderlineType">
  26088. <summary>
  26089. get or set the type of underlining for the font
  26090. </summary>
  26091. </member>
  26092. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsBold">
  26093. Get whether the font weight is Set to bold or not
  26094. @return bold - whether the font is bold or not
  26095. </member>
  26096. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsItalic">
  26097. @return true if font style was Set to <i>italic</i>
  26098. </member>
  26099. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.GetRawRecord">
  26100. @return
  26101. @see org.apache.poi.hssf.record.cf.FontFormatting#GetRawRecord()
  26102. </member>
  26103. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  26104. Set font style options.
  26105. @param italic - if true, Set posture style to italic, otherwise to normal
  26106. @param bold- if true, Set font weight to bold, otherwise to normal
  26107. </member>
  26108. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.ResetFontStyle">
  26109. Set font style options to default values (non-italic, non-bold)
  26110. </member>
  26111. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.EscapementType">
  26112. Get the type of base or subscript for the font
  26113. @return base or subscript option
  26114. </member>
  26115. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontColorIndex">
  26116. @return font color index
  26117. </member>
  26118. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontHeight">
  26119. Gets the height of the font in 1/20th point Units
  26120. @return fontheight (in points/20); or -1 if not modified
  26121. </member>
  26122. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontWeight">
  26123. Get the font weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  26124. 0x190 for normal and 0x2bc for bold
  26125. @return bw - a number between 100-1000 for the fonts "boldness"
  26126. </member>
  26127. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.UnderlineType">
  26128. Get the type of Underlining for the font
  26129. @return font Underlining type
  26130. @see #U_NONE
  26131. @see #U_SINGLE
  26132. @see #U_DOUBLE
  26133. @see #U_SINGLE_ACCOUNTING
  26134. @see #U_DOUBLE_ACCOUNTING
  26135. </member>
  26136. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsBold">
  26137. Get whether the font weight Is Set to bold or not
  26138. @return bold - whether the font Is bold or not
  26139. </member>
  26140. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsEscapementTypeModified">
  26141. @return true if escapement type was modified from default
  26142. </member>
  26143. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontCancellationModified">
  26144. @return true if font cancellation was modified from default
  26145. </member>
  26146. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontOutlineModified">
  26147. @return true if font outline type was modified from default
  26148. </member>
  26149. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontShadowModified">
  26150. @return true if font shadow type was modified from default
  26151. </member>
  26152. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontStyleModified">
  26153. @return true if font style was modified from default
  26154. </member>
  26155. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsItalic">
  26156. @return true if font style was Set to <i>italic</i>
  26157. </member>
  26158. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsOutlineOn">
  26159. @return true if font outline Is on
  26160. </member>
  26161. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsShadowOn">
  26162. @return true if font shadow Is on
  26163. </member>
  26164. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsStrikeout">
  26165. @return true if font strikeout Is on
  26166. </member>
  26167. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsUnderlineTypeModified">
  26168. @return true if font Underline type was modified from default
  26169. </member>
  26170. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontWeightModified">
  26171. @return true if font weight was modified from default
  26172. </member>
  26173. <member name="T:NPOI.HSSF.UserModel.HSSFFooter">
  26174. <summary>
  26175. Class to Read and manipulate the footer.
  26176. The footer works by having a left, center, and right side. The total cannot
  26177. be more that 255 bytes long. One uses this class by Getting the HSSFFooter
  26178. from HSSFSheet and then Getting or Setting the left, center, and right side.
  26179. For special things (such as page numbers and date), one can use a the methods
  26180. that return the Chars used to represent these. One can also Change the
  26181. fonts by using similar methods.
  26182. @author Shawn Laubach (slaubach at apache dot org)
  26183. </summary>
  26184. </member>
  26185. <member name="T:NPOI.SS.UserModel.IFooter">
  26186. <summary>
  26187. Common defInition of a HSSF or XSSF page footer.
  26188. For a list of all the different fields that can be
  26189. placed into a footer, such as page number,
  26190. bold, underline etc, see
  26191. </summary>
  26192. </member>
  26193. <member name="M:NPOI.HSSF.UserModel.HSSFFooter.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  26194. <summary>
  26195. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  26196. </summary>
  26197. <param name="psb">Footer record to create the footer with</param>
  26198. </member>
  26199. <member name="P:NPOI.HSSF.UserModel.HSSFFooter.RawText">
  26200. <summary>
  26201. Gets the raw footer.
  26202. </summary>
  26203. <value>The raw footer.</value>
  26204. </member>
  26205. <member name="T:NPOI.HSSF.UserModel.HSSFFormulaEvaluator">
  26206. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26207. </member>
  26208. <member name="T:NPOI.SS.UserModel.IFormulaEvaluator">
  26209. Evaluates formula cells.<p/>
  26210. For performance reasons, this class keeps a cache of all previously calculated intermediate
  26211. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  26212. calls to Evaluate~ methods on this class.
  26213. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  26214. @author Josh Micich
  26215. </member>
  26216. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.ClearAllCachedResultValues">
  26217. Should be called whenever there are Changes to input cells in the Evaluated workbook.
  26218. Failure to call this method after changing cell values will cause incorrect behaviour
  26219. of the Evaluate~ methods of this class
  26220. </member>
  26221. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  26222. Should be called to tell the cell value cache that the specified (value or formula) cell
  26223. has Changed.
  26224. Failure to call this method after changing cell values will cause incorrect behaviour
  26225. of the Evaluate~ methods of this class
  26226. </member>
  26227. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  26228. Should be called to tell the cell value cache that the specified cell has just become a
  26229. formula cell, or the formula text has Changed
  26230. </member>
  26231. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  26232. Should be called to tell the cell value cache that the specified (value or formula) cell
  26233. has changed.
  26234. Failure to call this method after changing cell values will cause incorrect behaviour
  26235. of the evaluate~ methods of this class
  26236. </member>
  26237. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  26238. If cell Contains a formula, the formula is Evaluated and returned,
  26239. else the CellValue simply copies the appropriate cell value from
  26240. the cell and also its cell type. This method should be preferred over
  26241. EvaluateInCell() when the call should not modify the contents of the
  26242. original cell.
  26243. @param cell
  26244. </member>
  26245. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateAll">
  26246. Loops over all cells in all sheets of the associated workbook.
  26247. For cells that contain formulas, their formulas are evaluated,
  26248. and the results are saved. These cells remain as formula cells.
  26249. For cells that do not contain formulas, no changes are made.
  26250. This is a helpful wrapper around looping over all cells, and
  26251. calling evaluateFormulaCell on each one.
  26252. </member>
  26253. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  26254. If cell Contains formula, it Evaluates the formula,
  26255. and saves the result of the formula. The cell
  26256. remains as a formula cell.
  26257. Else if cell does not contain formula, this method leaves
  26258. the cell unChanged.
  26259. Note that the type of the formula result is returned,
  26260. so you know what kind of value is also stored with
  26261. the formula.
  26262. <pre>
  26263. int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell);
  26264. </pre>
  26265. Be aware that your cell will hold both the formula,
  26266. and the result. If you want the cell Replaced with
  26267. the result of the formula, use {@link #EvaluateInCell(Cell)}
  26268. @param cell The cell to Evaluate
  26269. @return The type of the formula result (the cell's type remains as Cell.CELL_TYPE_FORMULA however)
  26270. </member>
  26271. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  26272. If cell Contains formula, it Evaluates the formula, and
  26273. Puts the formula result back into the cell, in place
  26274. of the old formula.
  26275. Else if cell does not contain formula, this method leaves
  26276. the cell unChanged.
  26277. Note that the same instance of Cell is returned to
  26278. allow chained calls like:
  26279. <pre>
  26280. int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType();
  26281. </pre>
  26282. Be aware that your cell value will be Changed to hold the
  26283. result of the formula. If you simply want the formula
  26284. value comPuted for you, use {@link #EvaluateFormulaCell(Cell)}
  26285. @param cell
  26286. </member>
  26287. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.DebugEvaluationOutputForNextEval">
  26288. * Perform detailed output of formula evaluation for next evaluation only?
  26289. * Is for developer use only (also developers using POI for their XLS files).
  26290. * Log-Level WARN is for basic info, INFO for detailed information. These quite
  26291. * high levels are used because you have to explicitly enable this specific logging.
  26292. * @param value whether to perform detailed output
  26293. </member>
  26294. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  26295. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  26296. for the (conservative) assumption that any cell may have its definition changed after
  26297. evaluation begins.
  26298. </member>
  26299. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  26300. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  26301. </member>
  26302. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  26303. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  26304. for the (conservative) assumption that any cell may have its definition changed after
  26305. evaluation begins.
  26306. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  26307. </member>
  26308. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.SetupEnvironment(System.String[],NPOI.HSSF.UserModel.HSSFFormulaEvaluator[])">
  26309. Coordinates several formula evaluators together so that formulas that involve external
  26310. references can be evaluated.
  26311. @param workbookNames the simple file names used to identify the workbooks in formulas
  26312. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  26313. @param evaluators all evaluators for the full set of workbooks required by the formulas.
  26314. </member>
  26315. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  26316. If cell Contains a formula, the formula is Evaluated and returned,
  26317. else the CellValue simply copies the appropriate cell value from
  26318. the cell and also its cell type. This method should be preferred over
  26319. EvaluateInCell() when the call should not modify the contents of the
  26320. original cell.
  26321. @param cell
  26322. If cell contains a formula, the formula is evaluated and returned,
  26323. else the CellValue simply copies the appropriate cell value from
  26324. the cell and also its cell type. This method should be preferred over
  26325. evaluateInCell() when the call should not modify the contents of the
  26326. original cell.
  26327. @param cell may be <c>null</c> signifying that the cell is not present (or blank)
  26328. @return <c>null</c> if the supplied cell is <c>null</c> or blank
  26329. </member>
  26330. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.ClearAllCachedResultValues">
  26331. Should be called whenever there are major changes (e.g. moving sheets) to input cells
  26332. in the evaluated workbook. If performance is not critical, a single call to this method
  26333. may be used instead of many specific calls to the notify~ methods.
  26334. Failure to call this method after changing cell values will cause incorrect behaviour
  26335. of the evaluate~ methods of this class
  26336. </member>
  26337. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  26338. Should be called to tell the cell value cache that the specified (value or formula) cell
  26339. has changed.
  26340. Failure to call this method after changing cell values will cause incorrect behaviour
  26341. of the evaluate~ methods of this class
  26342. </member>
  26343. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  26344. Should be called to tell the cell value cache that the specified cell has just been
  26345. deleted.
  26346. Failure to call this method after changing cell values will cause incorrect behaviour
  26347. of the evaluate~ methods of this class
  26348. </member>
  26349. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  26350. Should be called to tell the cell value cache that the specified (value or formula) cell
  26351. has changed.
  26352. Failure to call this method after changing cell values will cause incorrect behaviour
  26353. of the evaluate~ methods of this class
  26354. </member>
  26355. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  26356. If cell Contains formula, it Evaluates the formula,
  26357. and saves the result of the formula. The cell
  26358. remains as a formula cell.
  26359. Else if cell does not contain formula, this method leaves
  26360. the cell UnChanged.
  26361. Note that the type of the formula result is returned,
  26362. so you know what kind of value is also stored with
  26363. the formula.
  26364. <pre>
  26365. int EvaluatedCellType = evaluator.EvaluateFormulaCell(cell);
  26366. </pre>
  26367. Be aware that your cell will hold both the formula,
  26368. and the result. If you want the cell Replaced with
  26369. the result of the formula, use {@link #EvaluateInCell(HSSFCell)}
  26370. @param cell The cell to Evaluate
  26371. @return The type of the formula result (the cell's type remains as CellType.Formula however)
  26372. </member>
  26373. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  26374. Returns a CellValue wrapper around the supplied ValueEval instance.
  26375. @param eval
  26376. </member>
  26377. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  26378. If cell Contains formula, it Evaluates the formula, and
  26379. puts the formula result back into the cell, in place
  26380. of the old formula.
  26381. Else if cell does not contain formula, this method leaves
  26382. the cell UnChanged.
  26383. Note that the same instance of Cell is returned to
  26384. allow chained calls like:
  26385. <pre>
  26386. int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
  26387. </pre>
  26388. Be aware that your cell value will be Changed to hold the
  26389. result of the formula. If you simply want the formula
  26390. value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)}
  26391. @param cell
  26392. </member>
  26393. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.HSSF.UserModel.HSSFWorkbook)">
  26394. Loops over all cells in all sheets of the supplied
  26395. workbook.
  26396. For cells that contain formulas, their formulas are
  26397. Evaluated, and the results are saved. These cells
  26398. remain as formula cells.
  26399. For cells that do not contain formulas, no Changes
  26400. are made.
  26401. This is a helpful wrapper around looping over all
  26402. cells, and calling EvaluateFormulaCell on each one.
  26403. </member>
  26404. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  26405. Loops over all cells in all sheets of the supplied
  26406. workbook.
  26407. For cells that contain formulas, their formulas are
  26408. evaluated, and the results are saved. These cells
  26409. remain as formula cells.
  26410. For cells that do not contain formulas, no changes
  26411. are made.
  26412. This is a helpful wrapper around looping over all
  26413. cells, and calling evaluateFormulaCell on each one.
  26414. </member>
  26415. <member name="P:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.IgnoreMissingWorkbooks">
  26416. Whether to ignore missing references to external workbooks and
  26417. use cached formula results in the main workbook instead.
  26418. <p>
  26419. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  26420. With this method you can control how POI handles such missing references:
  26421. <ul>
  26422. <li>by default ignoreMissingWorkbooks=false and POI throws {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  26423. if an external reference cannot be resolved</li>
  26424. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  26425. that already exists in the main workbook</li>
  26426. </ul>
  26427. </p>
  26428. @param ignore whether to ignore missing references to external workbooks
  26429. </member>
  26430. <member name="P:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.DebugEvaluationOutputForNextEval">
  26431. {@inheritDoc}
  26432. </member>
  26433. <member name="T:NPOI.HSSF.UserModel.HSSFHeader">
  26434. <summary>
  26435. Class to Read and manipulate the header.
  26436. The header works by having a left, center, and right side. The total cannot
  26437. be more that 255 bytes long. One uses this class by Getting the HSSFHeader
  26438. from HSSFSheet and then Getting or Setting the left, center, and right side.
  26439. For special things (such as page numbers and date), one can use a the methods
  26440. that return the Chars used to represent these. One can also Change the
  26441. fonts by using similar methods.
  26442. @author Shawn Laubach (slaubach at apache dot org)
  26443. </summary>
  26444. </member>
  26445. <member name="T:NPOI.SS.UserModel.IHeader">
  26446. <summary>
  26447. Common defInition of a HSSF or XSSF page header.
  26448. For a list of all the different fields that can be
  26449. placed into a header, such as page number,
  26450. bold, underline etc, see
  26451. </summary>
  26452. </member>
  26453. <member name="M:NPOI.HSSF.UserModel.HSSFHeader.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  26454. <summary>
  26455. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  26456. </summary>
  26457. <param name="psb">Footer record to Create the footer with</param>
  26458. </member>
  26459. <member name="P:NPOI.HSSF.UserModel.HSSFHeader.RawText">
  26460. <summary>
  26461. Gets the raw footer.
  26462. </summary>
  26463. <value>The raw footer.</value>
  26464. </member>
  26465. <member name="T:NPOI.HSSF.UserModel.HSSFHyperlink">
  26466. <summary>
  26467. Represents an Excel hyperlink.
  26468. </summary>
  26469. <remarks>@author Yegor Kozlov (yegor at apache dot org)</remarks>
  26470. </member>
  26471. <member name="T:NPOI.SS.UserModel.IHyperlink">
  26472. <summary>
  26473. Represents an Excel hyperlink.
  26474. </summary>
  26475. </member>
  26476. <member name="P:NPOI.SS.UserModel.IHyperlink.Address">
  26477. <summary>
  26478. Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  26479. </summary>
  26480. </member>
  26481. <member name="P:NPOI.SS.UserModel.IHyperlink.Label">
  26482. <summary>
  26483. text label for this hyperlink
  26484. </summary>
  26485. </member>
  26486. <member name="P:NPOI.SS.UserModel.IHyperlink.Type">
  26487. <summary>
  26488. the type of this hyperlink
  26489. </summary>
  26490. </member>
  26491. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstRow">
  26492. <summary>
  26493. the row of the first cell that Contains the hyperlink
  26494. </summary>
  26495. </member>
  26496. <member name="P:NPOI.SS.UserModel.IHyperlink.LastRow">
  26497. <summary>
  26498. the row of the last cell that Contains the hyperlink
  26499. </summary>
  26500. </member>
  26501. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstColumn">
  26502. <summary>
  26503. the column of the first cell that Contains the hyperlink
  26504. </summary>
  26505. </member>
  26506. <member name="P:NPOI.SS.UserModel.IHyperlink.LastColumn">
  26507. <summary>
  26508. the column of the last cell that Contains the hyperlink
  26509. </summary>
  26510. </member>
  26511. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.record">
  26512. Low-level record object that stores the actual hyperlink data
  26513. </member>
  26514. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.link_type">
  26515. If we Create a new hypelrink remember its type
  26516. </member>
  26517. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  26518. <summary>
  26519. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  26520. </summary>
  26521. <param name="type">The type of hyperlink to Create.</param>
  26522. </member>
  26523. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.HSSF.Record.HyperlinkRecord)">
  26524. <summary>
  26525. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  26526. </summary>
  26527. <param name="record">The record.</param>
  26528. </member>
  26529. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstRow">
  26530. <summary>
  26531. Gets or sets the row of the first cell that Contains the hyperlink
  26532. </summary>
  26533. <value>the 0-based row of the cell that Contains the hyperlink.</value>
  26534. </member>
  26535. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastRow">
  26536. <summary>
  26537. Gets or sets the row of the last cell that Contains the hyperlink
  26538. </summary>
  26539. <value>the 0-based row of the last cell that Contains the hyperlink</value>
  26540. </member>
  26541. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstColumn">
  26542. <summary>
  26543. Gets or sets the column of the first cell that Contains the hyperlink
  26544. </summary>
  26545. <value>the 0-based column of the first cell that Contains the hyperlink</value>
  26546. </member>
  26547. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastColumn">
  26548. <summary>
  26549. Gets or sets the column of the last cell that Contains the hyperlink
  26550. </summary>
  26551. <value>the 0-based column of the last cell that Contains the hyperlink</value>
  26552. </member>
  26553. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Address">
  26554. <summary>
  26555. Gets or sets Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  26556. </summary>
  26557. <value>the Address of this hyperlink</value>
  26558. </member>
  26559. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.TextMark">
  26560. <summary>
  26561. Gets or sets the text mark.
  26562. </summary>
  26563. <value>The text mark.</value>
  26564. </member>
  26565. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.ShortFilename">
  26566. <summary>
  26567. Gets or sets the short filename.
  26568. </summary>
  26569. <value>The short filename.</value>
  26570. </member>
  26571. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Label">
  26572. <summary>
  26573. Gets or sets the text label for this hyperlink
  26574. </summary>
  26575. <value>text to Display</value>
  26576. </member>
  26577. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Type">
  26578. <summary>
  26579. Gets the type of this hyperlink
  26580. </summary>
  26581. <value>the type of this hyperlink</value>
  26582. </member>
  26583. <member name="T:NPOI.HSSF.UserModel.HSSFName">
  26584. <summary>
  26585. High Level Represantion of Named Range
  26586. </summary>
  26587. <remarks>@author Libin Roman (Vista Portal LDT. Developer)</remarks>
  26588. </member>
  26589. <member name="T:NPOI.SS.UserModel.IName">
  26590. Represents a defined name for a range of cells.
  26591. A name is a meaningful shorthand that makes it easier to understand the purpose of a
  26592. cell reference, constant or a formula.
  26593. </member>
  26594. <member name="M:NPOI.SS.UserModel.IName.SetFunction(System.Boolean)">
  26595. Indicates that the defined name refers to a user-defined function.
  26596. This attribute is used when there is an add-in or other code project associated with the file.
  26597. @param value <c>true</c> indicates the name refers to a function.
  26598. </member>
  26599. <member name="P:NPOI.SS.UserModel.IName.SheetName">
  26600. Get the sheets name which this named range is referenced to
  26601. @return sheet name, which this named range refered to
  26602. </member>
  26603. <member name="P:NPOI.SS.UserModel.IName.NameName">
  26604. Gets the name of the named range
  26605. @return named range name
  26606. </member>
  26607. <member name="P:NPOI.SS.UserModel.IName.RefersToFormula">
  26608. Returns the formula that the name is defined to refer to.
  26609. @return the reference for this name, <code>null</code> if it has not been set yet. Never empty string
  26610. @see #SetRefersToFormula(String)
  26611. </member>
  26612. <member name="P:NPOI.SS.UserModel.IName.IsFunctionName">
  26613. Checks if this name is a function name
  26614. @return true if this name is a function name
  26615. </member>
  26616. <member name="P:NPOI.SS.UserModel.IName.IsDeleted">
  26617. Checks if this name points to a cell that no longer exists
  26618. @return <c>true</c> if the name refers to a deleted cell, <c>false</c> otherwise
  26619. </member>
  26620. <member name="P:NPOI.SS.UserModel.IName.SheetIndex">
  26621. Returns the sheet index this name applies to.
  26622. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  26623. </member>
  26624. <member name="P:NPOI.SS.UserModel.IName.Comment">
  26625. Returns the comment the user provided when the name was Created.
  26626. @return the user comment for this named range
  26627. </member>
  26628. <member name="M:NPOI.HSSF.UserModel.HSSFName.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.NameRecord,NPOI.HSSF.Record.NameCommentRecord)">
  26629. <summary>
  26630. Creates new HSSFName - called by HSSFWorkbook to Create a sheet from
  26631. scratch.
  26632. </summary>
  26633. <param name="book">lowlevel Workbook object associated with the sheet.</param>
  26634. <param name="name">the Name Record</param>
  26635. <param name="comment"></param>
  26636. </member>
  26637. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetNameDefinition(NPOI.SS.Formula.PTG.Ptg[])">
  26638. <summary>
  26639. Sets the NameParsedFormula structure that specifies the formula for the defined name.
  26640. </summary>
  26641. <param name="ptgs">the sequence of {@link Ptg}s for the formula.</param>
  26642. </member>
  26643. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetFunction(System.Boolean)">
  26644. Indicates that the defined name refers to a user-defined function.
  26645. This attribute is used when there is an add-in or other code project associated with the file.
  26646. @param value <c>true</c> indicates the name refers to a function.
  26647. </member>
  26648. <member name="M:NPOI.HSSF.UserModel.HSSFName.ToString">
  26649. <summary>
  26650. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  26651. </summary>
  26652. <returns>
  26653. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  26654. </returns>
  26655. </member>
  26656. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetName">
  26657. <summary>
  26658. Gets or sets the sheets name which this named range is referenced to
  26659. </summary>
  26660. <value>sheet name, which this named range refered to</value>
  26661. </member>
  26662. <member name="P:NPOI.HSSF.UserModel.HSSFName.NameName">
  26663. <summary>
  26664. Gets or sets the name of the named range
  26665. </summary>
  26666. <value>named range name</value>
  26667. </member>
  26668. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetIndex">
  26669. Returns the sheet index this name applies to.
  26670. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  26671. </member>
  26672. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsDeleted">
  26673. <summary>
  26674. Tests if this name points to a cell that no longer exists
  26675. </summary>
  26676. <value>
  26677. <c>true</c> if the name refers to a deleted cell; otherwise, <c>false</c>.
  26678. </value>
  26679. </member>
  26680. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsFunctionName">
  26681. <summary>
  26682. Gets a value indicating whether this instance is function name.
  26683. </summary>
  26684. <value>
  26685. <c>true</c> if this instance is function name; otherwise, <c>false</c>.
  26686. </value>
  26687. </member>
  26688. <member name="T:NPOI.HSSF.UserModel.HSSFObjectData">
  26689. Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...
  26690. @author Daniel Noll
  26691. </member>
  26692. <member name="T:NPOI.HSSF.UserModel.HSSFPicture">
  26693. <summary>
  26694. Represents a escher picture. Eg. A GIF, JPEG etc...
  26695. @author Glen Stampoultzis
  26696. @author Yegor Kozlov (yegor at apache.org)
  26697. </summary>
  26698. </member>
  26699. <member name="T:NPOI.SS.UserModel.IPicture">
  26700. Repersents a picture in a SpreadsheetML document
  26701. @author Yegor Kozlov
  26702. </member>
  26703. <member name="M:NPOI.SS.UserModel.IPicture.Resize">
  26704. Reset the image to the original size.
  26705. </member>
  26706. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double)">
  26707. Reset the image to the original size.
  26708. @param scale the amount by which image dimensions are multiplied relative to the original size.
  26709. <code>resize(1.0)</code> Sets the original size, <code>resize(0.5)</code> resize to 50% of the original,
  26710. <code>resize(2.0)</code> resizes to 200% of the original.
  26711. </member>
  26712. <member name="P:NPOI.SS.UserModel.IPicture.PictureData">
  26713. Return picture data for this picture
  26714. @return picture data for this picture
  26715. </member>
  26716. <member name="F:NPOI.HSSF.UserModel.HSSFPicture.PX_DEFAULT">
  26717. width of 1px in columns with default width in Units of 1/256 of a Char width
  26718. </member>
  26719. <member name="F:NPOI.HSSF.UserModel.HSSFPicture.PX_MODIFIED">
  26720. width of 1px in columns with overridden width in Units of 1/256 of a Char width
  26721. </member>
  26722. <member name="F:NPOI.HSSF.UserModel.HSSFPicture.PX_ROW">
  26723. Height of 1px of a row
  26724. </member>
  26725. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  26726. <summary>
  26727. Constructs a picture object.
  26728. </summary>
  26729. <param name="parent">The parent.</param>
  26730. <param name="anchor">The anchor.</param>
  26731. </member>
  26732. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double)">
  26733. <summary>
  26734. Reset the image to the original size.
  26735. </summary>
  26736. </member>
  26737. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize">
  26738. <summary>
  26739. Reset the image to the original size.
  26740. </summary>
  26741. </member>
  26742. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double)">
  26743. <summary>
  26744. Calculate the preferred size for this picture.
  26745. </summary>
  26746. <param name="scale">the amount by which image dimensions are multiplied relative to the original size.</param>
  26747. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  26748. </member>
  26749. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize">
  26750. <summary>
  26751. Calculate the preferred size for this picture.
  26752. </summary>
  26753. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  26754. </member>
  26755. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetColumnWidthInPixels(System.Int32)">
  26756. <summary>
  26757. Gets the column width in pixels.
  26758. </summary>
  26759. <param name="column">The column.</param>
  26760. <returns></returns>
  26761. </member>
  26762. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetRowHeightInPixels(System.Int32)">
  26763. <summary>
  26764. Gets the row height in pixels.
  26765. </summary>
  26766. <param name="i">The row</param>
  26767. <returns></returns>
  26768. </member>
  26769. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPixelWidth(System.Int32)">
  26770. <summary>
  26771. Gets the width of the pixel.
  26772. </summary>
  26773. <param name="column">The column.</param>
  26774. <returns></returns>
  26775. </member>
  26776. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetResolution(System.Drawing.Image)">
  26777. <summary>
  26778. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  26779. Return the the "effective" dpi calculated as
  26780. <c>25.4/HorizontalPixelSize</c>
  26781. and
  26782. <c>25.4/VerticalPixelSize</c>
  26783. . Where 25.4 is the number of mm in inch.
  26784. </summary>
  26785. <param name="r">The image.</param>
  26786. <returns>the resolution</returns>
  26787. </member>
  26788. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetImageDimension">
  26789. <summary>
  26790. Return the dimension of this image
  26791. </summary>
  26792. <returns>image dimension</returns>
  26793. </member>
  26794. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureIndex">
  26795. <summary>
  26796. Gets or sets the index of the picture.
  26797. </summary>
  26798. <value>The index of the picture.</value>
  26799. </member>
  26800. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureData">
  26801. Return picture data for this shape
  26802. @return picture data for this shape
  26803. </member>
  26804. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.FileName">
  26805. The color applied to the lines of this shape.
  26806. </member>
  26807. <member name="F:NPOI.HSSF.UserModel.HSSFObjectData._root">
  26808. Reference to the filesystem root, required for retrieving the object data.
  26809. </member>
  26810. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetDirectory">
  26811. Gets the object data. Only call for ones that have
  26812. data though. See {@link #hasDirectoryEntry()}
  26813. @return the object data as an OLE2 directory.
  26814. @ if there was an error Reading the data.
  26815. </member>
  26816. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetObjectData">
  26817. Returns the data portion, for an ObjectData
  26818. that doesn't have an associated POIFS Directory
  26819. Entry
  26820. </member>
  26821. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.HasDirectoryEntry">
  26822. Does this ObjectData have an associated POIFS
  26823. Directory Entry?
  26824. (Not all do, those that don't have a data portion)
  26825. </member>
  26826. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.FindObjectRecord">
  26827. Finds the EmbeddedObjectRefSubRecord, or throws an
  26828. Exception if there wasn't one
  26829. </member>
  26830. <member name="P:NPOI.HSSF.UserModel.HSSFObjectData.OLE2ClassName">
  26831. Returns the OLE2 Class Name of the object
  26832. </member>
  26833. <member name="T:NPOI.HSSF.UserModel.HSSFOptimiser">
  26834. <summary>
  26835. Excel can Get cranky if you give it files containing too
  26836. many (especially duplicate) objects, and this class can
  26837. help to avoid those.
  26838. In general, it's much better to make sure you don't
  26839. duplicate the objects in your code, as this is likely
  26840. to be much faster than creating lots and lots of
  26841. excel objects+records, only to optimise them down to
  26842. many fewer at a later stage.
  26843. However, sometimes this is too hard / tricky to do, which
  26844. is where the use of this class comes in.
  26845. </summary>
  26846. </member>
  26847. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseFonts(NPOI.HSSF.UserModel.HSSFWorkbook)">
  26848. <summary>
  26849. Goes through the Workbook, optimising the fonts by
  26850. removing duplicate ones.
  26851. For now, only works on fonts used in HSSFCellStyle
  26852. and HSSFRichTextString. Any other font uses
  26853. (eg charts, pictures) may well end up broken!
  26854. This can be a slow operation, especially if you have
  26855. lots of cells, cell styles or rich text strings
  26856. </summary>
  26857. <param name="workbook">The workbook in which to optimise the fonts</param>
  26858. </member>
  26859. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseCellStyles(NPOI.HSSF.UserModel.HSSFWorkbook)">
  26860. <summary>
  26861. Goes through the Wokrbook, optimising the cell styles
  26862. by removing duplicate ones and ones that aren't used.
  26863. For best results, optimise the fonts via a call to
  26864. OptimiseFonts(HSSFWorkbook) first
  26865. </summary>
  26866. <param name="workbook">The workbook in which to optimise the cell styles</param>
  26867. </member>
  26868. <member name="T:NPOI.HSSF.UserModel.HSSFPalette">
  26869. <summary>
  26870. Represents a workbook color palette.
  26871. Internally, the XLS format refers to colors using an offset into the palette
  26872. record. Thus, the first color in the palette has the index 0x8, the second
  26873. has the index 0x9, etc. through 0x40
  26874. @author Brian Sanders (bsanders at risklabs dot com)
  26875. </summary>
  26876. </member>
  26877. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.GetColor(System.Int16)">
  26878. <summary>
  26879. Retrieves the color at a given index
  26880. </summary>
  26881. <param name="index">the palette index, between 0x8 to 0x40 inclusive.</param>
  26882. <returns>the color, or null if the index Is not populated</returns>
  26883. </member>
  26884. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindColor(System.Byte,System.Byte,System.Byte)">
  26885. <summary>
  26886. Finds the first occurance of a given color
  26887. </summary>
  26888. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  26889. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  26890. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  26891. <returns>the color, or null if the color does not exist in this palette</returns>
  26892. </member>
  26893. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindSimilarColor(System.Byte,System.Byte,System.Byte)">
  26894. <summary>
  26895. Finds the closest matching color in the custom palette. The
  26896. method for Finding the distance between the colors Is fairly
  26897. primative.
  26898. </summary>
  26899. <param name="red">The red component of the color to match.</param>
  26900. <param name="green">The green component of the color to match.</param>
  26901. <param name="blue">The blue component of the color to match.</param>
  26902. <returns>The closest color or null if there are no custom
  26903. colors currently defined.</returns>
  26904. </member>
  26905. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.SetColorAtIndex(System.Int16,System.Byte,System.Byte,System.Byte)">
  26906. <summary>
  26907. Sets the color at the given offset
  26908. </summary>
  26909. <param name="index">the palette index, between 0x8 to 0x40 inclusive</param>
  26910. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  26911. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  26912. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  26913. </member>
  26914. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.AddColor(System.Byte,System.Byte,System.Byte)">
  26915. <summary>
  26916. Adds a new color into an empty color slot.
  26917. </summary>
  26918. <param name="red">The red component</param>
  26919. <param name="green">The green component</param>
  26920. <param name="blue">The blue component</param>
  26921. <returns>The new custom color.</returns>
  26922. </member>
  26923. <member name="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor">
  26924. <summary>
  26925. user custom color
  26926. </summary>
  26927. </member>
  26928. <member name="T:NPOI.HSSF.Util.HSSFColor">
  26929. Intends to provide support for the very evil index to triplet Issue and
  26930. will likely replace the color constants interface for HSSF 2.0.
  26931. This class Contains static inner class members for representing colors.
  26932. Each color has an index (for the standard palette in Excel (tm) ),
  26933. native (RGB) triplet and string triplet. The string triplet Is as the
  26934. color would be represented by Gnumeric. Having (string) this here Is a bit of a
  26935. collusion of function between HSSF and the HSSFSerializer but I think its
  26936. a reasonable one in this case.
  26937. @author Andrew C. Oliver (acoliver at apache dot org)
  26938. @author Brian Sanders (bsanders at risklabs dot com) - full default color palette
  26939. </member>
  26940. <member name="M:NPOI.HSSF.Util.HSSFColor.#ctor">
  26941. Creates a new instance of HSSFColor
  26942. </member>
  26943. <member name="M:NPOI.HSSF.Util.HSSFColor.GetIndexHash">
  26944. this function returns all colors in a hastable. Its not implemented as a
  26945. static member/staticly initialized because that would be dirty in a
  26946. server environment as it Is intended. This means you'll eat the time
  26947. it takes to Create it once per request but you will not hold onto it
  26948. if you have none of those requests.
  26949. @return a hashtable containing all colors keyed by <c>int</c> excel-style palette indexes
  26950. </member>
  26951. <member name="M:NPOI.HSSF.Util.HSSFColor.GetMutableIndexHash">
  26952. This function returns all the Colours, stored in a Hashtable that
  26953. can be edited. No caching is performed. If you don't need to edit
  26954. the table, then call {@link #getIndexHash()} which returns a
  26955. statically cached imuatable map of colours.
  26956. </member>
  26957. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTripletHash">
  26958. <summary>
  26959. this function returns all colors in a hastable. Its not implemented as a
  26960. static member/staticly initialized because that would be dirty in a
  26961. server environment as it Is intended. This means you'll eat the time
  26962. it takes to Create it once per request but you will not hold onto it
  26963. if you have none of those requests.
  26964. </summary>
  26965. <returns>a hashtable containing all colors keyed by String gnumeric-like triplets</returns>
  26966. </member>
  26967. <member name="M:NPOI.HSSF.Util.HSSFColor.GetIndex">
  26968. @return index to the standard palette
  26969. </member>
  26970. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTriplet">
  26971. @return triplet representation like that in Excel
  26972. </member>
  26973. <member name="M:NPOI.HSSF.Util.HSSFColor.GetHexString">
  26974. @return a hex string exactly like a gnumeric triplet
  26975. </member>
  26976. <member name="T:NPOI.HSSF.Util.HSSFColor.Black">
  26977. Class BLACK
  26978. </member>
  26979. <member name="T:NPOI.HSSF.Util.HSSFColor.Brown">
  26980. Class BROWN
  26981. </member>
  26982. <member name="T:NPOI.HSSF.Util.HSSFColor.OliveGreen">
  26983. Class OLIVE_GREEN
  26984. </member>
  26985. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkGreen">
  26986. Class DARK_GREEN
  26987. </member>
  26988. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkTeal">
  26989. Class DARK_TEAL
  26990. </member>
  26991. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkBlue">
  26992. Class DARK_BLUE
  26993. </member>
  26994. <member name="T:NPOI.HSSF.Util.HSSFColor.Indigo">
  26995. Class INDIGO
  26996. </member>
  26997. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey80Percent">
  26998. Class GREY_80_PERCENT
  26999. </member>
  27000. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkRed">
  27001. Class DARK_RED
  27002. </member>
  27003. <member name="T:NPOI.HSSF.Util.HSSFColor.Orange">
  27004. Class ORANGE
  27005. </member>
  27006. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkYellow">
  27007. Class DARK_YELLOW
  27008. </member>
  27009. <member name="T:NPOI.HSSF.Util.HSSFColor.Green">
  27010. Class GREEN
  27011. </member>
  27012. <member name="T:NPOI.HSSF.Util.HSSFColor.Teal">
  27013. Class TEAL
  27014. </member>
  27015. <member name="T:NPOI.HSSF.Util.HSSFColor.Blue">
  27016. Class BLUE
  27017. </member>
  27018. <member name="T:NPOI.HSSF.Util.HSSFColor.BlueGrey">
  27019. Class BLUE_GREY
  27020. </member>
  27021. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey50Percent">
  27022. Class GREY_50_PERCENT
  27023. </member>
  27024. <member name="T:NPOI.HSSF.Util.HSSFColor.Red">
  27025. Class RED
  27026. </member>
  27027. <member name="T:NPOI.HSSF.Util.HSSFColor.LightOrange">
  27028. Class LIGHT_ORANGE
  27029. </member>
  27030. <member name="T:NPOI.HSSF.Util.HSSFColor.Lime">
  27031. Class LIME
  27032. </member>
  27033. <member name="T:NPOI.HSSF.Util.HSSFColor.SeaGreen">
  27034. Class SEA_GREEN
  27035. </member>
  27036. <member name="T:NPOI.HSSF.Util.HSSFColor.Aqua">
  27037. Class AQUA
  27038. </member>
  27039. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey40Percent">
  27040. Class GREY_40_PERCENT
  27041. </member>
  27042. <member name="T:NPOI.HSSF.Util.HSSFColor.Turquoise">
  27043. Class TURQUOISE
  27044. </member>
  27045. <member name="T:NPOI.HSSF.Util.HSSFColor.SkyBlue">
  27046. Class SKY_BLUE
  27047. </member>
  27048. <member name="T:NPOI.HSSF.Util.HSSFColor.Plum">
  27049. Class PLUM
  27050. </member>
  27051. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey25Percent">
  27052. Class GREY_25_PERCENT
  27053. </member>
  27054. <member name="T:NPOI.HSSF.Util.HSSFColor.Rose">
  27055. Class ROSE
  27056. </member>
  27057. <member name="T:NPOI.HSSF.Util.HSSFColor.Tan">
  27058. Class TAN
  27059. </member>
  27060. <member name="T:NPOI.HSSF.Util.HSSFColor.LightYellow">
  27061. Class LIGHT_YELLOW
  27062. </member>
  27063. <member name="T:NPOI.HSSF.Util.HSSFColor.LightGreen">
  27064. Class LIGHT_GREEN
  27065. </member>
  27066. <member name="T:NPOI.HSSF.Util.HSSFColor.LightTurquoise">
  27067. Class LIGHT_TURQUOISE
  27068. </member>
  27069. <member name="T:NPOI.HSSF.Util.HSSFColor.PaleBlue">
  27070. Class PALE_BLUE
  27071. </member>
  27072. <member name="T:NPOI.HSSF.Util.HSSFColor.Lavender">
  27073. Class LAVENDER
  27074. </member>
  27075. <member name="T:NPOI.HSSF.Util.HSSFColor.White">
  27076. Class WHITE
  27077. </member>
  27078. <member name="T:NPOI.HSSF.Util.HSSFColor.CornflowerBlue">
  27079. Class CORNFLOWER_BLUE
  27080. </member>
  27081. <member name="T:NPOI.HSSF.Util.HSSFColor.LemonChiffon">
  27082. Class LEMON_CHIFFON
  27083. </member>
  27084. <member name="T:NPOI.HSSF.Util.HSSFColor.Maroon">
  27085. Class MAROON
  27086. </member>
  27087. <member name="T:NPOI.HSSF.Util.HSSFColor.Orchid">
  27088. Class ORCHID
  27089. </member>
  27090. <member name="T:NPOI.HSSF.Util.HSSFColor.Coral">
  27091. Class CORAL
  27092. </member>
  27093. <member name="T:NPOI.HSSF.Util.HSSFColor.RoyalBlue">
  27094. Class ROYAL_BLUE
  27095. </member>
  27096. <member name="T:NPOI.HSSF.Util.HSSFColor.LightCornflowerBlue">
  27097. Class LIGHT_CORNFLOWER_BLUE
  27098. </member>
  27099. <member name="T:NPOI.HSSF.Util.HSSFColor.Automatic">
  27100. Special Default/Normal/Automatic color.
  27101. <i>Note:</i> This class Is NOT in the default HashTables returned by HSSFColor.
  27102. The index Is a special case which Is interpreted in the various SetXXXColor calls.
  27103. @author Jason
  27104. </member>
  27105. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte[])">
  27106. <summary>
  27107. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  27108. </summary>
  27109. <param name="byteOffset">The byte offset.</param>
  27110. <param name="colors">The colors.</param>
  27111. </member>
  27112. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte,System.Byte,System.Byte)">
  27113. <summary>
  27114. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  27115. </summary>
  27116. <param name="byteOffset">The byte offset.</param>
  27117. <param name="red">The red.</param>
  27118. <param name="green">The green.</param>
  27119. <param name="blue">The blue.</param>
  27120. </member>
  27121. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetIndex">
  27122. <summary>
  27123. Gets index to the standard palette
  27124. </summary>
  27125. <value></value>
  27126. </member>
  27127. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetTriplet">
  27128. <summary>
  27129. Gets triplet representation like that in Excel
  27130. </summary>
  27131. <value></value>
  27132. </member>
  27133. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetHexString">
  27134. <summary>
  27135. Gets a hex string exactly like a gnumeric triplet
  27136. </summary>
  27137. <value></value>
  27138. </member>
  27139. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetGnumericPart(System.Byte)">
  27140. <summary>
  27141. Gets the gnumeric part.
  27142. </summary>
  27143. <param name="color">The color.</param>
  27144. <returns></returns>
  27145. </member>
  27146. <member name="T:NPOI.HSSF.UserModel.HSSFPatriarch">
  27147. <summary>
  27148. The patriarch is the toplevel container for shapes in a sheet. It does
  27149. little other than act as a container for other shapes and Groups.
  27150. @author Glen Stampoultzis (glens at apache.org)
  27151. </summary>
  27152. </member>
  27153. <member name="T:NPOI.HSSF.UserModel.HSSFShapeContainer">
  27154. <summary>
  27155. An interface that indicates whether a class can contain children.
  27156. @author Glen Stampoultzis (glens at apache.org)
  27157. </summary>
  27158. </member>
  27159. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  27160. <summary>
  27161. dd shape to the list of child records
  27162. </summary>
  27163. <param name="shape">shape</param>
  27164. </member>
  27165. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  27166. <summary>
  27167. set coordinates of this group relative to the parent
  27168. </summary>
  27169. <param name="x1">x1</param>
  27170. <param name="y1">y1</param>
  27171. <param name="x2">x2</param>
  27172. <param name="y2">y2</param>
  27173. </member>
  27174. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  27175. remove first level shapes
  27176. @param shape to be removed
  27177. @return true if shape is removed else return false
  27178. </member>
  27179. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Children">
  27180. <summary>
  27181. Gets Any children contained by this shape.
  27182. </summary>
  27183. <value>The children.</value>
  27184. </member>
  27185. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X1">
  27186. <summary>
  27187. Get the top left x coordinate of this group.
  27188. </summary>
  27189. </member>
  27190. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y1">
  27191. <summary>
  27192. Get the top left y coordinate of this group.
  27193. </summary>
  27194. </member>
  27195. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X2">
  27196. <summary>
  27197. Get the bottom right x coordinate of this group.
  27198. </summary>
  27199. </member>
  27200. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y2">
  27201. <summary>
  27202. Get the bottom right y coordinate of this group.
  27203. </summary>
  27204. </member>
  27205. <member name="T:NPOI.SS.UserModel.IDrawing">
  27206. @author Yegor Kozlov
  27207. </member>
  27208. <member name="M:NPOI.SS.UserModel.IDrawing.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  27209. Creates a picture.
  27210. @param anchor the client anchor describes how this picture is
  27211. attached to the sheet.
  27212. @param pictureIndex the index of the picture in the workbook collection
  27213. of pictures.
  27214. @return the newly created picture.
  27215. </member>
  27216. <member name="M:NPOI.SS.UserModel.IDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  27217. Creates a comment.
  27218. @param anchor the client anchor describes how this comment is attached
  27219. to the sheet.
  27220. @return the newly created comment.
  27221. </member>
  27222. <member name="M:NPOI.SS.UserModel.IDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  27223. Creates a chart.
  27224. @param anchor the client anchor describes how this chart is attached to
  27225. the sheet.
  27226. @return the newly created chart
  27227. </member>
  27228. <member name="M:NPOI.SS.UserModel.IDrawing.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  27229. Creates a new client anchor and sets the top-left and bottom-right
  27230. coordinates of the anchor.
  27231. @param dx1 the x coordinate in EMU within the first cell.
  27232. @param dy1 the y coordinate in EMU within the first cell.
  27233. @param dx2 the x coordinate in EMU within the second cell.
  27234. @param dy2 the y coordinate in EMU within the second cell.
  27235. @param col1 the column (0 based) of the first cell.
  27236. @param row1 the row (0 based) of the first cell.
  27237. @param col2 the column (0 based) of the second cell.
  27238. @param row2 the row (0 based) of the second cell.
  27239. @return the newly created client anchor
  27240. </member>
  27241. <member name="F:NPOI.HSSF.UserModel.HSSFPatriarch._boundAggregate">
  27242. The EscherAggregate we have been bound to.
  27243. (This will handle writing us out into records,
  27244. and building up our shapes from the records)
  27245. </member>
  27246. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.EscherAggregate)">
  27247. <summary>
  27248. Creates the patriarch.
  27249. </summary>
  27250. <param name="sheet">the sheet this patriarch is stored in.</param>
  27251. <param name="boundAggregate">The bound aggregate.</param>
  27252. </member>
  27253. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.PreSerialize">
  27254. check if any shapes contain wrong data
  27255. At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
  27256. </member>
  27257. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  27258. @param shape to be removed
  27259. @return true of shape is removed
  27260. </member>
  27261. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateGroup(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  27262. <summary>
  27263. Creates a new Group record stored Under this patriarch.
  27264. </summary>
  27265. <param name="anchor">the client anchor describes how this Group is attached
  27266. to the sheet.</param>
  27267. <returns>the newly created Group.</returns>
  27268. </member>
  27269. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateSimpleShape(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  27270. <summary>
  27271. Creates a simple shape. This includes such shapes as lines, rectangles,
  27272. and ovals.
  27273. </summary>
  27274. <param name="anchor">the client anchor describes how this Group is attached
  27275. to the sheet.</param>
  27276. <returns>the newly created shape.</returns>
  27277. </member>
  27278. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32)">
  27279. <summary>
  27280. Creates a picture.
  27281. </summary>
  27282. <param name="anchor">the client anchor describes how this Group is attached
  27283. to the sheet.</param>
  27284. <param name="pictureIndex">Index of the picture.</param>
  27285. <returns>the newly created shape.</returns>
  27286. </member>
  27287. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  27288. <summary>
  27289. CreatePicture
  27290. </summary>
  27291. <param name="anchor">the client anchor describes how this picture is attached to the sheet.</param>
  27292. <param name="pictureIndex">the index of the picture in the workbook collection of pictures.</param>
  27293. <returns>return newly created shape</returns>
  27294. </member>
  27295. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePolygon(NPOI.SS.UserModel.IClientAnchor)">
  27296. <summary>
  27297. Creates a polygon
  27298. </summary>
  27299. <param name="anchor">the client anchor describes how this Group is attached
  27300. to the sheet.</param>
  27301. <returns>the newly Created shape.</returns>
  27302. </member>
  27303. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  27304. <summary>
  27305. Constructs a textbox Under the patriarch.
  27306. </summary>
  27307. <param name="anchor">the client anchor describes how this Group is attached
  27308. to the sheet.</param>
  27309. <returns>the newly Created textbox.</returns>
  27310. </member>
  27311. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComment(NPOI.HSSF.UserModel.HSSFAnchor)">
  27312. Constructs a cell comment.
  27313. @param anchor the client anchor describes how this comment is attached
  27314. to the sheet.
  27315. @return the newly created comment.
  27316. </member>
  27317. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComboBox(NPOI.HSSF.UserModel.HSSFAnchor)">
  27318. YK: used to create autofilters
  27319. @see org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(int, int, int, int)
  27320. </member>
  27321. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  27322. <summary>
  27323. Constructs a cell comment.
  27324. </summary>
  27325. <param name="anchor">the client anchor describes how this comment is attached
  27326. to the sheet.</param>
  27327. <returns>the newly created comment.</returns>
  27328. </member>
  27329. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  27330. add a shape to this drawing
  27331. </member>
  27332. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  27333. <summary>
  27334. Sets the coordinate space of this Group. All children are contrained
  27335. to these coordinates.
  27336. </summary>
  27337. <param name="x1">The x1.</param>
  27338. <param name="y1">The y1.</param>
  27339. <param name="x2">The x2.</param>
  27340. <param name="y2">The y2.</param>
  27341. </member>
  27342. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.ContainsChart">
  27343. <summary>
  27344. Does this HSSFPatriarch contain a chart?
  27345. (Technically a reference to a chart, since they
  27346. Get stored in a different block of records)
  27347. FIXME - detect chart in all cases (only seems
  27348. to work on some charts so far)
  27349. </summary>
  27350. <returns>
  27351. <c>true</c> if this instance contains chart; otherwise, <c>false</c>.
  27352. </returns>
  27353. </member>
  27354. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.GetBoundAggregate">
  27355. <summary>
  27356. Returns the aggregate escher record we're bound to
  27357. </summary>
  27358. <returns></returns>
  27359. </member>
  27360. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  27361. Creates a new client anchor and sets the top-left and bottom-right
  27362. coordinates of the anchor.
  27363. @param dx1 the x coordinate in EMU within the first cell.
  27364. @param dy1 the y coordinate in EMU within the first cell.
  27365. @param dx2 the x coordinate in EMU within the second cell.
  27366. @param dy2 the y coordinate in EMU within the second cell.
  27367. @param col1 the column (0 based) of the first cell.
  27368. @param row1 the row (0 based) of the first cell.
  27369. @param col2 the column (0 based) of the second cell.
  27370. @param row2 the row (0 based) of the second cell.
  27371. @return the newly created client anchor
  27372. </member>
  27373. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.BuildShapeTree">
  27374. create shape tree from existing escher records tree
  27375. </member>
  27376. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Children">
  27377. <summary>
  27378. Returns a list of all shapes contained by the patriarch.
  27379. </summary>
  27380. <value>The children.</value>
  27381. </member>
  27382. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.CountOfAllChildren">
  27383. <summary>
  27384. Total count of all children and their children's children.
  27385. </summary>
  27386. <value>The count of all children.</value>
  27387. </member>
  27388. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X1">
  27389. <summary>
  27390. The top left x coordinate of this Group.
  27391. </summary>
  27392. <value>The x1.</value>
  27393. </member>
  27394. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y1">
  27395. <summary>
  27396. The top left y coordinate of this Group.
  27397. </summary>
  27398. <value>The y1.</value>
  27399. </member>
  27400. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X2">
  27401. <summary>
  27402. The bottom right x coordinate of this Group.
  27403. </summary>
  27404. <value>The x2.</value>
  27405. </member>
  27406. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y2">
  27407. <summary>
  27408. The bottom right y coordinate of this Group.
  27409. </summary>
  27410. <value>The y2.</value>
  27411. </member>
  27412. <member name="T:NPOI.HSSF.UserModel.HSSFPatternFormatting">
  27413. <summary>
  27414. High level representation for Conditional Formatting Settings
  27415. @author Dmitriy Kumshayev
  27416. </summary>
  27417. </member>
  27418. <member name="T:NPOI.SS.UserModel.IPatternFormatting">
  27419. @author Yegor Kozlov
  27420. </member>
  27421. <member name="M:NPOI.HSSF.UserModel.HSSFPatternFormatting.#ctor(NPOI.HSSF.Record.CFRuleRecord)">
  27422. <summary>
  27423. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPatternFormatting"/> class.
  27424. </summary>
  27425. <param name="cfRuleRecord">The cf rule record.</param>
  27426. </member>
  27427. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.PatternFormattingBlock">
  27428. <summary>
  27429. Gets the pattern formatting block.
  27430. </summary>
  27431. <value>The pattern formatting block.</value>
  27432. </member>
  27433. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillBackgroundColor">
  27434. <summary>
  27435. Gets or sets the color of the fill background.
  27436. </summary>
  27437. <value>The color of the fill background.</value>
  27438. </member>
  27439. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillForegroundColor">
  27440. <summary>
  27441. Gets or sets the color of the fill foreground.
  27442. </summary>
  27443. <value>The color of the fill foreground.</value>
  27444. </member>
  27445. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillPattern">
  27446. <summary>
  27447. Gets or sets the fill pattern.
  27448. </summary>
  27449. <value>The fill pattern.</value>
  27450. </member>
  27451. <member name="T:NPOI.HSSF.UserModel.HSSFPictureData">
  27452. <summary>
  27453. Represents binary data stored in the file. Eg. A GIF, JPEG etc...
  27454. @author Daniel Noll
  27455. </summary>
  27456. </member>
  27457. <member name="M:NPOI.SS.UserModel.IPictureData.SuggestFileExtension">
  27458. Suggests a file extension for this image.
  27459. @return the file extension.
  27460. </member>
  27461. <member name="P:NPOI.SS.UserModel.IPictureData.Data">
  27462. Gets the picture data.
  27463. @return the picture data.
  27464. </member>
  27465. <member name="P:NPOI.SS.UserModel.IPictureData.MimeType">
  27466. Returns the mime type for the image
  27467. </member>
  27468. <member name="F:NPOI.HSSF.UserModel.HSSFPictureData.blip">
  27469. Underlying escher blip record containing the bitmap data.
  27470. </member>
  27471. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.#ctor(NPOI.DDF.EscherBlipRecord)">
  27472. <summary>
  27473. Constructs a picture object.
  27474. </summary>
  27475. <param name="blip">the underlying blip record containing the bitmap data.</param>
  27476. </member>
  27477. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.SuggestFileExtension">
  27478. <summary>
  27479. Suggests a file extension for this image.
  27480. </summary>
  27481. <returns>the file extension.</returns>
  27482. </member>
  27483. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Data">
  27484. <summary>
  27485. Gets the picture data.
  27486. </summary>
  27487. <value>the picture data.</value>
  27488. </member>
  27489. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Format">
  27490. <summary>
  27491. gets format of the picture.
  27492. </summary>
  27493. <value>The format.</value>
  27494. </member>
  27495. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.MimeType">
  27496. Returns the mime type for the image
  27497. </member>
  27498. <member name="T:NPOI.HSSF.UserModel.HSSFPolygon">
  27499. <summary>
  27500. @author Glen Stampoultzis (glens at baselinksoftware.com)
  27501. </summary>
  27502. </member>
  27503. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateSpContainer">
  27504. Generates the shape records for this shape.
  27505. </member>
  27506. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateObjRecord">
  27507. Creates the low level OBJ record for this shape.
  27508. </member>
  27509. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPoints(System.Int32[],System.Int32[])">
  27510. @param xPoints - array of x coordinates
  27511. @param yPoints - array of y coordinates
  27512. </member>
  27513. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPolygonDrawArea(System.Int32,System.Int32)">
  27514. Defines the width and height of the points in the polygon
  27515. @param width
  27516. @param height
  27517. </member>
  27518. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.XPoints">
  27519. @return array of x coordinates
  27520. </member>
  27521. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.YPoints">
  27522. @return array of y coordinates
  27523. </member>
  27524. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaWidth">
  27525. @return shape width
  27526. </member>
  27527. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaHeight">
  27528. @return shape height
  27529. </member>
  27530. <member name="T:NPOI.HSSF.UserModel.HSSFPrintSetup">
  27531. <summary>
  27532. Used to modify the print Setup.
  27533. @author Shawn Laubach (slaubach at apache dot org)
  27534. </summary>
  27535. </member>
  27536. <member name="P:NPOI.SS.UserModel.IPrintSetup.PaperSize">
  27537. Returns the paper size.
  27538. @return paper size
  27539. </member>
  27540. <member name="P:NPOI.SS.UserModel.IPrintSetup.Scale">
  27541. Returns the scale.
  27542. @return scale
  27543. </member>
  27544. <member name="P:NPOI.SS.UserModel.IPrintSetup.PageStart">
  27545. Returns the page start.
  27546. @return page start
  27547. </member>
  27548. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitWidth">
  27549. Returns the number of pages wide to fit sheet in.
  27550. @return number of pages wide to fit sheet in
  27551. </member>
  27552. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitHeight">
  27553. Returns the number of pages high to fit the sheet in.
  27554. @return number of pages high to fit the sheet in
  27555. </member>
  27556. <member name="P:NPOI.SS.UserModel.IPrintSetup.LeftToRight">
  27557. Returns the left to right print order.
  27558. @return left to right print order
  27559. </member>
  27560. <member name="P:NPOI.SS.UserModel.IPrintSetup.Landscape">
  27561. Returns the landscape mode.
  27562. @return landscape mode
  27563. </member>
  27564. <member name="P:NPOI.SS.UserModel.IPrintSetup.ValidSettings">
  27565. Returns the valid Settings.
  27566. @return valid Settings
  27567. </member>
  27568. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoColor">
  27569. Returns the black and white Setting.
  27570. @return black and white Setting
  27571. </member>
  27572. <member name="P:NPOI.SS.UserModel.IPrintSetup.Draft">
  27573. Returns the draft mode.
  27574. @return draft mode
  27575. </member>
  27576. <member name="P:NPOI.SS.UserModel.IPrintSetup.Notes">
  27577. Returns the print notes.
  27578. @return print notes
  27579. </member>
  27580. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoOrientation">
  27581. Returns the no orientation.
  27582. @return no orientation
  27583. </member>
  27584. <member name="P:NPOI.SS.UserModel.IPrintSetup.UsePage">
  27585. Returns the use page numbers.
  27586. @return use page numbers
  27587. </member>
  27588. <member name="P:NPOI.SS.UserModel.IPrintSetup.HResolution">
  27589. Returns the horizontal resolution.
  27590. @return horizontal resolution
  27591. </member>
  27592. <member name="P:NPOI.SS.UserModel.IPrintSetup.VResolution">
  27593. Returns the vertical resolution.
  27594. @return vertical resolution
  27595. </member>
  27596. <member name="P:NPOI.SS.UserModel.IPrintSetup.HeaderMargin">
  27597. Returns the header margin.
  27598. @return header margin
  27599. </member>
  27600. <member name="P:NPOI.SS.UserModel.IPrintSetup.FooterMargin">
  27601. Returns the footer margin.
  27602. @return footer margin
  27603. </member>
  27604. <member name="P:NPOI.SS.UserModel.IPrintSetup.Copies">
  27605. Returns the number of copies.
  27606. @return number of copies
  27607. </member>
  27608. <member name="M:NPOI.HSSF.UserModel.HSSFPrintSetup.#ctor(NPOI.HSSF.Record.PrintSetupRecord)">
  27609. <summary>
  27610. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPrintSetup"/> class.
  27611. </summary>
  27612. <param name="printSetupRecord">Takes the low level print Setup record.</param>
  27613. </member>
  27614. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PaperSize">
  27615. <summary>
  27616. Gets or sets the size of the paper.
  27617. </summary>
  27618. <value>The size of the paper.</value>
  27619. </member>
  27620. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Scale">
  27621. <summary>
  27622. Gets or sets the scale.
  27623. </summary>
  27624. <value>The scale.</value>
  27625. </member>
  27626. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PageStart">
  27627. <summary>
  27628. Gets or sets the page start.
  27629. </summary>
  27630. <value>The page start.</value>
  27631. </member>
  27632. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitWidth">
  27633. <summary>
  27634. Gets or sets the number of pages wide to fit sheet in.
  27635. </summary>
  27636. <value>the number of pages wide to fit sheet in</value>
  27637. </member>
  27638. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitHeight">
  27639. <summary>
  27640. Gets or sets number of pages high to fit the sheet in
  27641. </summary>
  27642. <value>number of pages high to fit the sheet in.</value>
  27643. </member>
  27644. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Options">
  27645. <summary>
  27646. Gets or sets the bit flags for the options.
  27647. </summary>
  27648. <value>the bit flags for the options.</value>
  27649. </member>
  27650. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.LeftToRight">
  27651. <summary>
  27652. Gets or sets the left to right print order.
  27653. </summary>
  27654. <value>the left to right print order.</value>
  27655. </member>
  27656. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Landscape">
  27657. <summary>
  27658. Gets or sets the landscape mode.
  27659. </summary>
  27660. <value>the landscape mode.</value>
  27661. </member>
  27662. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.ValidSettings">
  27663. <summary>
  27664. Gets or sets the valid Settings.
  27665. </summary>
  27666. <value>the valid Settings.</value>
  27667. </member>
  27668. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoColor">
  27669. <summary>
  27670. Gets or sets the black and white Setting.
  27671. </summary>
  27672. <value>black and white Setting</value>
  27673. </member>
  27674. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Draft">
  27675. <summary>
  27676. Gets or sets the draft mode.
  27677. </summary>
  27678. <value>the draft mode.</value>
  27679. </member>
  27680. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Notes">
  27681. <summary>
  27682. Gets or sets the print notes.
  27683. </summary>
  27684. <value>the print notes.</value>
  27685. </member>
  27686. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoOrientation">
  27687. <summary>
  27688. Gets or sets a value indicating whether [no orientation].
  27689. </summary>
  27690. <value><c>true</c> if [no orientation]; otherwise, <c>false</c>.</value>
  27691. </member>
  27692. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.UsePage">
  27693. <summary>
  27694. Gets or sets the use page numbers.
  27695. </summary>
  27696. <value>use page numbers. </value>
  27697. </member>
  27698. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HResolution">
  27699. <summary>
  27700. Gets or sets the horizontal resolution.
  27701. </summary>
  27702. <value>the horizontal resolution.</value>
  27703. </member>
  27704. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.VResolution">
  27705. <summary>
  27706. Gets or sets the vertical resolution.
  27707. </summary>
  27708. <value>the vertical resolution.</value>
  27709. </member>
  27710. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HeaderMargin">
  27711. <summary>
  27712. Gets or sets the header margin.
  27713. </summary>
  27714. <value>The header margin.</value>
  27715. </member>
  27716. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FooterMargin">
  27717. <summary>
  27718. Gets or sets the footer margin.
  27719. </summary>
  27720. <value>The footer margin.</value>
  27721. </member>
  27722. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Copies">
  27723. <summary>
  27724. Gets or sets the number of copies.
  27725. </summary>
  27726. <value>the number of copies.</value>
  27727. </member>
  27728. <member name="T:NPOI.HSSF.UserModel.HSSFRichTextString">
  27729. <summary>
  27730. Rich text Unicode string. These strings can have fonts applied to
  27731. arbitary parts of the string.
  27732. @author Glen Stampoultzis (glens at apache.org)
  27733. @author Jason Height (jheight at apache.org)
  27734. </summary>
  27735. </member>
  27736. <member name="T:NPOI.SS.UserModel.IRichTextString">
  27737. Rich text unicode string. These strings can have fonts
  27738. applied to arbitary parts of the string.
  27739. @author Glen Stampoultzis (glens at apache.org)
  27740. @author Jason Height (jheight at apache.org)
  27741. </member>
  27742. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  27743. Applies a font to the specified characters of a string.
  27744. @param startIndex The start index to apply the font to (inclusive)
  27745. @param endIndex The end index to apply the font to (exclusive)
  27746. @param fontIndex The font to use.
  27747. </member>
  27748. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  27749. Applies a font to the specified characters of a string.
  27750. @param startIndex The start index to apply the font to (inclusive)
  27751. @param endIndex The end index to apply to font to (exclusive)
  27752. @param font The index of the font to use.
  27753. </member>
  27754. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  27755. Sets the font of the entire string.
  27756. @param font The font to use.
  27757. </member>
  27758. <member name="M:NPOI.SS.UserModel.IRichTextString.ClearFormatting">
  27759. Removes any formatting that may have been applied to the string.
  27760. </member>
  27761. <member name="M:NPOI.SS.UserModel.IRichTextString.GetIndexOfFormattingRun(System.Int32)">
  27762. The index within the string to which the specified formatting run applies.
  27763. @param index the index of the formatting run
  27764. @return the index within the string.
  27765. </member>
  27766. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int16)">
  27767. Applies the specified font to the entire string.
  27768. @param fontIndex the font to apply.
  27769. </member>
  27770. <member name="P:NPOI.SS.UserModel.IRichTextString.String">
  27771. Returns the plain string representation.
  27772. </member>
  27773. <member name="P:NPOI.SS.UserModel.IRichTextString.Length">
  27774. @return the number of characters in the font.
  27775. </member>
  27776. <member name="P:NPOI.SS.UserModel.IRichTextString.NumFormattingRuns">
  27777. @return The number of formatting Runs used.
  27778. </member>
  27779. <member name="F:NPOI.HSSF.UserModel.HSSFRichTextString.NO_FONT">
  27780. Place holder for indicating that NO_FONT has been applied here
  27781. </member>
  27782. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor">
  27783. <summary>
  27784. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  27785. </summary>
  27786. </member>
  27787. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(System.String)">
  27788. <summary>
  27789. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  27790. </summary>
  27791. <param name="str">The string.</param>
  27792. </member>
  27793. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  27794. <summary>
  27795. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  27796. </summary>
  27797. <param name="book">The workbook.</param>
  27798. <param name="record">The record.</param>
  27799. </member>
  27800. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.SetWorkbookReferences(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  27801. <summary>
  27802. This must be called to Setup the internal work book references whenever
  27803. a RichTextString Is Added to a cell
  27804. </summary>
  27805. <param name="book">The workbook.</param>
  27806. <param name="record">The record.</param>
  27807. </member>
  27808. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CloneStringIfRequired">
  27809. <summary>
  27810. Called whenever the Unicode string Is modified. When it Is modified
  27811. we need to Create a new SST index, so that other LabelSSTRecords will not
  27812. be affected by Changes tat we make to this string.
  27813. </summary>
  27814. <returns></returns>
  27815. </member>
  27816. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.AddToSSTIfRequired">
  27817. <summary>
  27818. Adds to SST if required.
  27819. </summary>
  27820. </member>
  27821. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  27822. <summary>
  27823. Applies a font to the specified Chars of a string.
  27824. </summary>
  27825. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  27826. <param name="endIndex">The end index to apply the font to (exclusive).</param>
  27827. <param name="fontIndex">The font to use.</param>
  27828. </member>
  27829. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  27830. <summary>
  27831. Applies a font to the specified Chars of a string.
  27832. </summary>
  27833. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  27834. <param name="endIndex"> The end index to apply to font to (exclusive).</param>
  27835. <param name="font">The index of the font to use.</param>
  27836. </member>
  27837. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  27838. <summary>
  27839. Sets the font of the entire string.
  27840. </summary>
  27841. <param name="font">The font to use.</param>
  27842. </member>
  27843. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ClearFormatting">
  27844. <summary>
  27845. Removes any formatting that may have been applied to the string.
  27846. </summary>
  27847. </member>
  27848. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontAtIndex(System.Int32)">
  27849. <summary>
  27850. Returns the font in use at a particular index.
  27851. </summary>
  27852. <param name="index">The index.</param>
  27853. <returns>The font that's currently being applied at that
  27854. index or null if no font Is being applied or the
  27855. index Is out of range.</returns>
  27856. </member>
  27857. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  27858. <summary>
  27859. The index within the string to which the specified formatting run applies.
  27860. </summary>
  27861. <param name="index">the index of the formatting run</param>
  27862. <returns>the index within the string.</returns>
  27863. </member>
  27864. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  27865. <summary>
  27866. Gets the font used in a particular formatting run.
  27867. </summary>
  27868. <param name="index">the index of the formatting run.</param>
  27869. <returns>the font number used.</returns>
  27870. </member>
  27871. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CompareTo(NPOI.HSSF.UserModel.HSSFRichTextString)">
  27872. <summary>
  27873. Compares one rich text string to another.
  27874. </summary>
  27875. <param name="other">The other rich text string.</param>
  27876. <returns></returns>
  27877. </member>
  27878. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.Equals(System.Object)">
  27879. <summary>
  27880. Equalses the specified o.
  27881. </summary>
  27882. <param name="o">The o.</param>
  27883. <returns></returns>
  27884. </member>
  27885. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ToString">
  27886. <summary>
  27887. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  27888. </summary>
  27889. <returns>
  27890. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  27891. </returns>
  27892. </member>
  27893. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int16)">
  27894. <summary>
  27895. Applies the specified font to the entire string.
  27896. </summary>
  27897. <param name="fontIndex">Index of the font to apply.</param>
  27898. </member>
  27899. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.String">
  27900. <summary>
  27901. Returns the plain string representation.
  27902. </summary>
  27903. <value>The string.</value>
  27904. </member>
  27905. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.RawUnicodeString">
  27906. <summary>
  27907. Returns the raw, probably shared Unicode String.
  27908. Used when tweaking the styles, eg updating font
  27909. positions.
  27910. Changes to this string may well effect
  27911. other RichTextStrings too!
  27912. </summary>
  27913. <value>The raw unicode string.</value>
  27914. </member>
  27915. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.UnicodeString">
  27916. <summary>
  27917. Gets or sets the unicode string.
  27918. </summary>
  27919. <value>The unicode string.</value>
  27920. </member>
  27921. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.Length">
  27922. <summary>
  27923. Gets the number of Chars in the font..
  27924. </summary>
  27925. <value>The length.</value>
  27926. </member>
  27927. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.NumFormattingRuns">
  27928. <summary>
  27929. Gets the number of formatting runs used. There will always be at
  27930. least one of font NO_FONT.
  27931. </summary>
  27932. <value>The num formatting runs.</value>
  27933. </member>
  27934. <member name="T:NPOI.HSSF.UserModel.HSSFRow">
  27935. <summary>
  27936. High level representation of a row of a spReadsheet.
  27937. Only rows that have cells should be Added to a Sheet.
  27938. @author Andrew C. Oliver (acoliver at apache dot org)
  27939. @author Glen Stampoultzis (glens at apache.org)
  27940. </summary>
  27941. </member>
  27942. <member name="T:NPOI.SS.UserModel.IRow">
  27943. <summary>
  27944. High level representation of a row of a spreadsheet.
  27945. </summary>
  27946. </member>
  27947. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32)">
  27948. <summary>
  27949. Use this to create new cells within the row and return it.
  27950. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>.
  27951. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  27952. </summary>
  27953. <param name="column">the column number this cell represents</param>
  27954. <returns>Cell a high level representation of the created cell.</returns>
  27955. <throws>
  27956. ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  27957. (255 for *.xls, 1048576 for *.xlsx)
  27958. </throws>
  27959. </member>
  27960. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  27961. <summary>
  27962. Use this to create new cells within the row and return it.
  27963. 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
  27964. either through calling <code>SetCellValue</code> or <code>SetCellType</code>.
  27965. </summary>
  27966. <param name="column">the column number this cell represents</param>
  27967. <param name="type"></param>
  27968. <returns>Cell a high level representation of the created cell.</returns>
  27969. <throws>ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  27970. (255 for *.xls, 1048576 for *.xlsx)
  27971. </throws>
  27972. </member>
  27973. <member name="M:NPOI.SS.UserModel.IRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  27974. <summary>
  27975. Remove the Cell from this row.
  27976. </summary>
  27977. <param name="cell">the cell to remove</param>
  27978. </member>
  27979. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32)">
  27980. <summary>
  27981. Get the cell representing a given column (logical cell) 0-based. If you
  27982. ask for a cell that is not defined....you get a null.
  27983. </summary>
  27984. <param name="cellnum">0 based column number</param>
  27985. <returns>Cell representing that column or null if undefined.</returns>
  27986. <see cref="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)"/>
  27987. </member>
  27988. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  27989. <summary>
  27990. Returns the cell at the given (0 based) index, with the specified {@link NPOI.SS.usermodel.Row.MissingCellPolicy}
  27991. </summary>
  27992. <returns>the cell at the given (0 based) index</returns>
  27993. <throws>ArgumentException if cellnum &lt; 0 or the specified MissingCellPolicy is invalid</throws>
  27994. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK"/>
  27995. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL"/>
  27996. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK"/>
  27997. </member>
  27998. <member name="M:NPOI.SS.UserModel.IRow.GetEnumerator">
  27999. <summary>
  28000. Cell iterator of the physically defined cells. Note element 4 may
  28001. actually be row cell depending on how many are defined!
  28002. </summary>
  28003. </member>
  28004. <member name="M:NPOI.SS.UserModel.IRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  28005. <summary>
  28006. Moves the supplied cell to a new column, which
  28007. must not already have a cell there!
  28008. </summary>
  28009. <param name="cell">The cell to move</param>
  28010. <param name="newColumn">The new column number (0 based)</param>
  28011. </member>
  28012. <member name="M:NPOI.SS.UserModel.IRow.CopyRowTo(System.Int32)">
  28013. <summary>
  28014. Copy the current row to the target row
  28015. </summary>
  28016. <param name="targetIndex">row index of the target row</param>
  28017. <returns>the new copied row object</returns>
  28018. </member>
  28019. <member name="M:NPOI.SS.UserModel.IRow.CopyCell(System.Int32,System.Int32)">
  28020. <summary>
  28021. Copy the source cell to the target cell. If the target cell exists, the new copied cell will be inserted before the existing one
  28022. </summary>
  28023. <param name="sourceIndex">index of the source cell</param>
  28024. <param name="targetIndex">index of the target cell</param>
  28025. <returns>the new copied cell object</returns>
  28026. </member>
  28027. <member name="P:NPOI.SS.UserModel.IRow.RowNum">
  28028. <summary>
  28029. Get row number this row represents
  28030. </summary>
  28031. <returns>the row number (0 based)</returns>
  28032. </member>
  28033. <member name="P:NPOI.SS.UserModel.IRow.FirstCellNum">
  28034. <summary>
  28035. Get the number of the first cell Contained in this row.
  28036. </summary>
  28037. <returns>
  28038. short representing the first logical cell in the row,
  28039. or -1 if the row does not contain any cells.
  28040. </returns>
  28041. </member>
  28042. <member name="P:NPOI.SS.UserModel.IRow.LastCellNum">
  28043. <summary>
  28044. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  28045. happens to be the 1-based column number of the last cell. This value can be used as a
  28046. standard upper bound when iterating over cells:
  28047. <pre>
  28048. short minColIx = row.GetFirstCellNum();
  28049. short maxColIx = row.GetLastCellNum();
  28050. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  28051. Cell cell = row.GetCell(colIx);
  28052. if(cell == null) {
  28053. continue;
  28054. }
  28055. //... do something with cell
  28056. }
  28057. </pre>
  28058. </summary>
  28059. <returns>
  28060. short representing the last logical cell in the row <b>PLUS ONE</b>,
  28061. or -1 if the row does not contain any cells.
  28062. </returns>
  28063. </member>
  28064. <member name="P:NPOI.SS.UserModel.IRow.PhysicalNumberOfCells">
  28065. <summary>
  28066. Gets the number of defined cells (NOT number of cells in the actual row!).
  28067. That is to say if only columns 0,4,5 have values then there would be 3.
  28068. </summary>
  28069. <returns>int representing the number of defined cells in the row.</returns>
  28070. </member>
  28071. <member name="P:NPOI.SS.UserModel.IRow.ZeroHeight">
  28072. <summary>
  28073. Get whether or not to display this row with 0 height
  28074. </summary>
  28075. <returns>zHeight height is zero or not.</returns>
  28076. </member>
  28077. <member name="P:NPOI.SS.UserModel.IRow.Height">
  28078. <summary>
  28079. Get the row's height measured in twips (1/20th of a point).
  28080. If the height is not set, the default worksheet value is returned,
  28081. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  28082. </summary>
  28083. <returns>row height measured in twips (1/20th of a point)</returns>
  28084. </member>
  28085. <member name="P:NPOI.SS.UserModel.IRow.HeightInPoints">
  28086. <summary>
  28087. Returns row height measured in point size.
  28088. If the height is not set, the default worksheet value is returned,
  28089. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  28090. </summary>
  28091. <returns>row height measured in point size
  28092. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  28093. </returns>
  28094. </member>
  28095. <member name="P:NPOI.SS.UserModel.IRow.IsFormatted">
  28096. <summary>
  28097. Is this row formatted? Most aren't, but some rows
  28098. do have whole-row styles. For those that do, you
  28099. can get the formatting from <see cref="P:NPOI.SS.UserModel.IRow.RowStyle"/>
  28100. </summary>
  28101. </member>
  28102. <member name="P:NPOI.SS.UserModel.IRow.Sheet">
  28103. <summary>
  28104. Returns the Sheet this row belongs to
  28105. </summary>
  28106. <returns>the Sheet that owns this row</returns>
  28107. </member>
  28108. <member name="P:NPOI.SS.UserModel.IRow.RowStyle">
  28109. <summary>
  28110. Returns the whole-row cell styles. Most rows won't
  28111. have one of these, so will return null. Call IsFormmated to check first
  28112. </summary>
  28113. <value>The row style.</value>
  28114. </member>
  28115. <member name="P:NPOI.SS.UserModel.IRow.Cells">
  28116. <summary>
  28117. Get cells in the row
  28118. </summary>
  28119. </member>
  28120. <member name="F:NPOI.HSSF.UserModel.HSSFRow.INITIAL_CAPACITY">
  28121. <summary>
  28122. used for collections
  28123. </summary>
  28124. </member>
  28125. <member name="F:NPOI.HSSF.UserModel.HSSFRow.row">
  28126. reference to low level representation
  28127. </member>
  28128. <member name="F:NPOI.HSSF.UserModel.HSSFRow.book">
  28129. reference to containing low level Workbook
  28130. </member>
  28131. <member name="F:NPOI.HSSF.UserModel.HSSFRow.sheet">
  28132. reference to containing Sheet
  28133. </member>
  28134. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32)">
  28135. <summary>
  28136. Creates new HSSFRow from scratch. Only HSSFSheet should do this.
  28137. </summary>
  28138. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  28139. <param name="sheet">low-level Sheet object that Contains this Row</param>
  28140. <param name="rowNum">the row number of this row (0 based)</param>
  28141. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  28142. </member>
  28143. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.RowRecord)">
  28144. <summary>
  28145. Creates an HSSFRow from a low level RowRecord object. Only HSSFSheet should do
  28146. this. HSSFSheet uses this when an existing file is Read in.
  28147. </summary>
  28148. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  28149. <param name="sheet"> low-level Sheet object that Contains this Row</param>
  28150. <param name="record">the low level api object this row should represent</param>
  28151. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  28152. </member>
  28153. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32)">
  28154. <summary>
  28155. Use this to create new cells within the row and return it.
  28156. 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"/>).
  28157. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  28158. </summary>
  28159. <param name="column">the column number this cell represents</param>
  28160. <returns>a high level representation of the created cell.</returns>
  28161. </member>
  28162. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  28163. <summary>
  28164. Use this to create new cells within the row and return it.
  28165. The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
  28166. either through calling setCellValue or setCellType.
  28167. </summary>
  28168. <param name="columnIndex">the column number this cell represents</param>
  28169. <param name="type">a high level representation of the created cell.</param>
  28170. <returns></returns>
  28171. </member>
  28172. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  28173. <summary>
  28174. Remove the Cell from this row.
  28175. </summary>
  28176. <param name="cell">The cell to Remove.</param>
  28177. </member>
  28178. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell,System.Boolean)">
  28179. <summary>
  28180. Removes the cell.
  28181. </summary>
  28182. <param name="cell">The cell.</param>
  28183. <param name="alsoRemoveRecords">if set to <c>true</c> [also remove records].</param>
  28184. </member>
  28185. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewLastCellPlusOne(System.Int32)">
  28186. used internally to refresh the "last cell plus one" when the last cell is removed.
  28187. @return 0 when row contains no cells
  28188. </member>
  28189. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewFirstCell(System.Int32)">
  28190. used internally to refresh the "first cell" when the first cell is removed.
  28191. @return 0 when row contains no cells (also when first cell is occupied)
  28192. </member>
  28193. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCellFromRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  28194. <summary>
  28195. Create a high level Cell object from an existing low level record. Should
  28196. only be called from HSSFSheet or HSSFRow itself.
  28197. </summary>
  28198. <param name="cell">The low level cell to Create the high level representation from</param>
  28199. <returns> the low level record passed in</returns>
  28200. </member>
  28201. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveAllCells">
  28202. <summary>
  28203. Removes all the cells from the row, and their
  28204. records too.
  28205. </summary>
  28206. </member>
  28207. <member name="M:NPOI.HSSF.UserModel.HSSFRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  28208. <summary>
  28209. Moves the supplied cell to a new column, which
  28210. must not already have a cell there!
  28211. </summary>
  28212. <param name="cell">The cell to move</param>
  28213. <param name="newColumn">The new column number (0 based)</param>
  28214. </member>
  28215. <member name="M:NPOI.HSSF.UserModel.HSSFRow.AddCell(NPOI.SS.UserModel.ICell)">
  28216. <summary>
  28217. used internally to Add a cell.
  28218. </summary>
  28219. <param name="cell">The cell.</param>
  28220. </member>
  28221. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RetrieveCell(System.Int32)">
  28222. <summary>
  28223. Get the hssfcell representing a given column (logical cell)
  28224. 0-based. If you ask for a cell that is not defined, then
  28225. you Get a null.
  28226. This is the basic call, with no policies applied
  28227. </summary>
  28228. <param name="cellnum">0 based column number</param>
  28229. <returns>Cell representing that column or null if Undefined.</returns>
  28230. </member>
  28231. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int16)">
  28232. <summary>
  28233. Get the hssfcell representing a given column (logical cell)
  28234. 0-based. If you ask for a cell that is not defined then
  28235. you get a null, unless you have set a different
  28236. MissingCellPolicy on the base workbook.
  28237. Short method signature provided to retain binary
  28238. compatibility.
  28239. </summary>
  28240. <param name="cellnum">0 based column number</param>
  28241. <returns>Cell representing that column or null if undefined.</returns>
  28242. </member>
  28243. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32)">
  28244. <summary>
  28245. Get the hssfcell representing a given column (logical cell)
  28246. 0-based. If you ask for a cell that is not defined then
  28247. you get a null, unless you have set a different
  28248. MissingCellPolicy on the base workbook.
  28249. </summary>
  28250. <param name="cellnum">0 based column number</param>
  28251. <returns>Cell representing that column or null if undefined.</returns>
  28252. </member>
  28253. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  28254. <summary>
  28255. Get the hssfcell representing a given column (logical cell)
  28256. 0-based. If you ask for a cell that is not defined, then
  28257. your supplied policy says what to do
  28258. </summary>
  28259. <param name="cellnum">0 based column number</param>
  28260. <param name="policy">Policy on blank / missing cells</param>
  28261. <returns>that column or null if Undefined + policy allows.</returns>
  28262. </member>
  28263. <member name="M:NPOI.HSSF.UserModel.HSSFRow.FindFirstCell(System.Int32)">
  28264. <summary>
  28265. used internally to refresh the "first cell" when the first cell is Removed.
  28266. </summary>
  28267. <param name="firstcell">The first cell index.</param>
  28268. <returns></returns>
  28269. </member>
  28270. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetEnumerator">
  28271. <summary>
  28272. Gets the cell enumerator of the physically defined cells.
  28273. </summary>
  28274. <remarks>
  28275. Note that the 4th element might well not be cell 4, as the iterator
  28276. will not return Un-defined (null) cells.
  28277. Call CellNum on the returned cells to know which cell they are.
  28278. </remarks>
  28279. </member>
  28280. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CompareTo(System.Object)">
  28281. <summary>
  28282. 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.
  28283. </summary>
  28284. <param name="obj">An object to compare with this instance.</param>
  28285. <returns>
  28286. A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
  28287. Value
  28288. Meaning
  28289. Less than zero
  28290. This instance is less than <paramref name="obj"/>.
  28291. Zero
  28292. This instance is equal to <paramref name="obj"/>.
  28293. Greater than zero
  28294. This instance is greater than <paramref name="obj"/>.
  28295. </returns>
  28296. <exception cref="T:System.ArgumentException">
  28297. <paramref name="obj"/> is not the same type as this instance.
  28298. </exception>
  28299. </member>
  28300. <member name="M:NPOI.HSSF.UserModel.HSSFRow.Equals(System.Object)">
  28301. <summary>
  28302. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  28303. </summary>
  28304. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  28305. <returns>
  28306. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  28307. </returns>
  28308. <exception cref="T:System.NullReferenceException">
  28309. The <paramref name="obj"/> parameter is null.
  28310. </exception>
  28311. </member>
  28312. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetHashCode">
  28313. <summary>
  28314. Returns a hash code. In this case it is the number of the row.
  28315. </summary>
  28316. </member>
  28317. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsHidden">
  28318. <summary>
  28319. true, when the row is invisible. This is the case when the height is zero.
  28320. </summary>
  28321. </member>
  28322. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowNum">
  28323. <summary>
  28324. Get row number this row represents
  28325. </summary>
  28326. <value>the row number (0 based)</value>
  28327. </member>
  28328. <member name="P:NPOI.HSSF.UserModel.HSSFRow.OutlineLevel">
  28329. <summary>
  28330. Returns the rows outline level. Increased as you
  28331. put it into more Groups (outlines), reduced as
  28332. you take it out of them.
  28333. </summary>
  28334. <value>The outline level.</value>
  28335. </member>
  28336. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Sheet">
  28337. Returns the HSSFSheet this row belongs to
  28338. @return the HSSFSheet that owns this row
  28339. </member>
  28340. <member name="P:NPOI.HSSF.UserModel.HSSFRow.FirstCellNum">
  28341. <summary>
  28342. Get the number of the first cell contained in this row.
  28343. </summary>
  28344. <value>the first logical cell in the row, or -1 if the row does not contain any cells.</value>
  28345. </member>
  28346. <member name="P:NPOI.HSSF.UserModel.HSSFRow.LastCellNum">
  28347. <summary>
  28348. Gets the index of the last cell contained in this row PLUS ONE
  28349. . The result also happens to be the 1-based column number of the last cell. This value can be used as a
  28350. standard upper bound when iterating over cells:
  28351. </summary>
  28352. <value>
  28353. short representing the last logical cell in the row PLUS ONE, or -1 if the
  28354. row does not contain any cells.
  28355. </value>
  28356. <example>
  28357. short minColIx = row.GetFirstCellNum();
  28358. short maxColIx = row.GetLastCellNum();
  28359. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  28360. Cell cell = row.GetCell(colIx);
  28361. if(cell == null) {
  28362. continue;
  28363. }
  28364. //... do something with cell
  28365. }
  28366. </example>
  28367. </member>
  28368. <member name="P:NPOI.HSSF.UserModel.HSSFRow.PhysicalNumberOfCells">
  28369. <summary>
  28370. Gets the number of defined cells (NOT number of cells in the actual row!).
  28371. That is to say if only columns 0,4,5 have values then there would be 3.
  28372. </summary>
  28373. <value>the number of defined cells in the row.</value>
  28374. </member>
  28375. <member name="P:NPOI.HSSF.UserModel.HSSFRow.ZeroHeight">
  28376. <summary>
  28377. Gets or sets whether or not to Display this row with 0 height
  28378. </summary>
  28379. <value>height is zero or not.</value>
  28380. </member>
  28381. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Height">
  28382. <summary>
  28383. Get or sets the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
  28384. </summary>
  28385. <value>rowheight or 0xff for Undefined (use sheet default)</value>
  28386. </member>
  28387. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsFormatted">
  28388. <summary>
  28389. is this row formatted? Most aren't, but some rows
  28390. do have whole-row styles. For those that do, you
  28391. can get the formatting from {@link #getRowStyle()}
  28392. </summary>
  28393. <value>
  28394. <c>true</c> if this instance is formatted; otherwise, <c>false</c>.
  28395. </value>
  28396. </member>
  28397. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowStyle">
  28398. <summary>
  28399. Returns the whole-row cell styles. Most rows won't
  28400. have one of these, so will return null. Call IsFormmated to check first
  28401. </summary>
  28402. <value>The row style.</value>
  28403. </member>
  28404. <member name="P:NPOI.HSSF.UserModel.HSSFRow.HeightInPoints">
  28405. <summary>
  28406. Get the row's height or ff (-1) for Undefined/default-height in points (20*Height)
  28407. </summary>
  28408. <value>row height or 0xff for Undefined (use sheet default).</value>
  28409. </member>
  28410. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowRecord">
  28411. <summary>
  28412. Get the lowlevel RowRecord represented by this object - should only be called
  28413. by other parts of the high level API
  28414. </summary>
  28415. <value>RowRecord this row represents</value>
  28416. </member>
  28417. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Cells">
  28418. <summary>
  28419. Get cells in the row (existing cells only, no blanks)
  28420. </summary>
  28421. </member>
  28422. <member name="T:NPOI.HSSF.UserModel.HSSFShapeGroup">
  28423. <summary>
  28424. A shape Group may contain other shapes. It was no actual form on the
  28425. sheet.
  28426. @author Glen Stampoultzis (glens at apache.org)
  28427. </summary>
  28428. </member>
  28429. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateGroup(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  28430. <summary>
  28431. Create another Group Under this Group.
  28432. </summary>
  28433. <param name="anchor">the position of the new Group.</param>
  28434. <returns>the Group</returns>
  28435. </member>
  28436. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateShape(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  28437. <summary>
  28438. Create a new simple shape Under this Group.
  28439. </summary>
  28440. <param name="anchor">the position of the shape.</param>
  28441. <returns>the shape</returns>
  28442. </member>
  28443. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateTextbox(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  28444. <summary>
  28445. Create a new textbox Under this Group.
  28446. </summary>
  28447. <param name="anchor">the position of the shape.</param>
  28448. <returns>the textbox</returns>
  28449. </member>
  28450. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePolygon(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  28451. <summary>
  28452. Creates a polygon
  28453. </summary>
  28454. <param name="anchor">the client anchor describes how this Group Is attached
  28455. to the sheet.</param>
  28456. <returns>the newly Created shape.</returns>
  28457. </member>
  28458. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePicture(NPOI.HSSF.UserModel.HSSFChildAnchor,System.Int32)">
  28459. <summary>
  28460. Creates a picture.
  28461. </summary>
  28462. <param name="anchor">the client anchor describes how this Group Is attached
  28463. to the sheet.</param>
  28464. <param name="pictureIndex">Index of the picture.</param>
  28465. <returns>the newly Created shape.</returns>
  28466. </member>
  28467. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  28468. <summary>
  28469. Sets the coordinate space of this Group. All children are constrained
  28470. to these coordinates.
  28471. </summary>
  28472. <param name="x1">The x1.</param>
  28473. <param name="y1">The y1.</param>
  28474. <param name="x2">The x2.</param>
  28475. <param name="y2">The y2.</param>
  28476. </member>
  28477. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Children">
  28478. <summary>
  28479. Return all children contained by this shape.
  28480. </summary>
  28481. <value></value>
  28482. </member>
  28483. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X1">
  28484. <summary>
  28485. Gets The top left x coordinate of this Group.
  28486. </summary>
  28487. <value>The x1.</value>
  28488. </member>
  28489. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y1">
  28490. <summary>
  28491. Gets The top left y coordinate of this Group.
  28492. </summary>
  28493. <value>The y1.</value>
  28494. </member>
  28495. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X2">
  28496. <summary>
  28497. Gets The bottom right x coordinate of this Group.
  28498. </summary>
  28499. <value>The x2.</value>
  28500. </member>
  28501. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y2">
  28502. <summary>
  28503. Gets the bottom right y coordinate of this Group.
  28504. </summary>
  28505. <value>The y2.</value>
  28506. </member>
  28507. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.CountOfAllChildren">
  28508. <summary>
  28509. Count of all children and their childrens children.
  28510. </summary>
  28511. <value></value>
  28512. </member>
  28513. <member name="T:NPOI.HSSF.UserModel.HSSFSheet">
  28514. <summary>
  28515. High level representation of a worksheet.
  28516. </summary>
  28517. <remarks>
  28518. @author Andrew C. Oliver (acoliver at apache dot org)
  28519. @author Glen Stampoultzis (glens at apache.org)
  28520. @author Libin Roman (romal at vistaportal.com)
  28521. @author Shawn Laubach (slaubach at apache dot org) (Just a little)
  28522. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little, too)
  28523. @author Yegor Kozlov (yegor at apache.org) (Autosizing columns)
  28524. </remarks>
  28525. </member>
  28526. <member name="T:NPOI.SS.UserModel.ISheet">
  28527. <summary>
  28528. High level representation of a Excel worksheet.
  28529. </summary>
  28530. <remarks>
  28531. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  28532. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  28533. contain text, numbers, dates, and formulas. Cells can also be formatted.
  28534. </remarks>
  28535. </member>
  28536. <member name="M:NPOI.SS.UserModel.ISheet.CreateRow(System.Int32)">
  28537. <summary>
  28538. Create a new row within the sheet and return the high level representation
  28539. </summary>
  28540. <param name="rownum">The row number.</param>
  28541. <returns>high level Row object representing a row in the sheet</returns>
  28542. <see>RemoveRow(Row)</see>
  28543. </member>
  28544. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  28545. <summary>
  28546. Remove a row from this sheet. All cells Contained in the row are Removed as well
  28547. </summary>
  28548. <param name="row">a row to Remove.</param>
  28549. </member>
  28550. <member name="M:NPOI.SS.UserModel.ISheet.GetRow(System.Int32)">
  28551. <summary>
  28552. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  28553. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  28554. </summary>
  28555. <param name="rownum">row to get (0-based).</param>
  28556. <returns>the rownumber or null if its not defined on the sheet</returns>
  28557. </member>
  28558. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnHidden(System.Int32,System.Boolean)">
  28559. <summary>
  28560. Get the visibility state for a given column
  28561. </summary>
  28562. <param name="columnIndex">the column to get (0-based)</param>
  28563. <param name="hidden">the visiblity state of the column</param>
  28564. </member>
  28565. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnHidden(System.Int32)">
  28566. <summary>
  28567. Get the hidden state for a given column
  28568. </summary>
  28569. <param name="columnIndex">the column to set (0-based)</param>
  28570. <returns>hidden - <c>false</c> if the column is visible</returns>
  28571. </member>
  28572. <member name="M:NPOI.SS.UserModel.ISheet.CopyRow(System.Int32,System.Int32)">
  28573. <summary>
  28574. Copy the source row to the target row. If the target row exists, the new copied row will be inserted before the existing one
  28575. </summary>
  28576. <param name="sourceIndex">source index</param>
  28577. <param name="targetIndex">target index</param>
  28578. <returns>the new copied row object</returns>
  28579. </member>
  28580. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnWidth(System.Int32,System.Int32)">
  28581. <summary>
  28582. Set the width (in units of 1/256th of a character width)
  28583. </summary>
  28584. <param name="columnIndex">the column to set (0-based)</param>
  28585. <param name="width">the width in units of 1/256th of a character width</param>
  28586. <remarks>
  28587. The maximum column width for an individual cell is 255 characters.
  28588. This value represents the number of characters that can be displayed
  28589. in a cell that is formatted with the standard font.
  28590. </remarks>
  28591. </member>
  28592. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidth(System.Int32)">
  28593. <summary>
  28594. get the width (in units of 1/256th of a character width )
  28595. </summary>
  28596. <param name="columnIndex">the column to set (0-based)</param>
  28597. <returns>the width in units of 1/256th of a character width</returns>
  28598. </member>
  28599. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnStyle(System.Int32)">
  28600. <summary>
  28601. Returns the CellStyle that applies to the given
  28602. (0 based) column, or null if no style has been
  28603. set for that column
  28604. </summary>
  28605. <param name="column">The column.</param>
  28606. </member>
  28607. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  28608. <summary>
  28609. Adds a merged region of cells (hence those cells form one)
  28610. </summary>
  28611. <param name="region">(rowfrom/colfrom-rowto/colto) to merge.</param>
  28612. <returns>index of this region</returns>
  28613. </member>
  28614. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegion(System.Int32)">
  28615. <summary>
  28616. Removes a merged region of cells (hence letting them free)
  28617. </summary>
  28618. <param name="index">index of the region to unmerge</param>
  28619. </member>
  28620. <member name="M:NPOI.SS.UserModel.ISheet.GetMergedRegion(System.Int32)">
  28621. <summary>
  28622. Returns the merged region at the specified index
  28623. </summary>
  28624. <param name="index">The index.</param>
  28625. </member>
  28626. <member name="M:NPOI.SS.UserModel.ISheet.GetRowEnumerator">
  28627. <summary>
  28628. Gets the row enumerator.
  28629. </summary>
  28630. <returns>
  28631. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  28632. be the third row if say for instance the second row is undefined.
  28633. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  28634. if you care which one it is.
  28635. </returns>
  28636. </member>
  28637. <member name="M:NPOI.SS.UserModel.ISheet.GetEnumerator">
  28638. <summary>
  28639. Alias for GetRowEnumerator() to allow <c>foreach</c> loops.
  28640. </summary>
  28641. <returns>
  28642. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  28643. be the third row if say for instance the second row is undefined.
  28644. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  28645. if you care which one it is.
  28646. </returns>
  28647. </member>
  28648. <member name="M:NPOI.SS.UserModel.ISheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  28649. <summary>
  28650. Gets the size of the margin in inches.
  28651. </summary>
  28652. <param name="margin">which margin to get</param>
  28653. <returns>the size of the margin</returns>
  28654. </member>
  28655. <member name="M:NPOI.SS.UserModel.ISheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  28656. <summary>
  28657. Sets the size of the margin in inches.
  28658. </summary>
  28659. <param name="margin">which margin to get</param>
  28660. <param name="size">the size of the margin</param>
  28661. </member>
  28662. <member name="M:NPOI.SS.UserModel.ISheet.ProtectSheet(System.String)">
  28663. <summary>
  28664. Sets the protection enabled as well as the password
  28665. </summary>
  28666. <param name="password">to set for protection. Pass <code>null</code> to remove protection</param>
  28667. </member>
  28668. <member name="M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32,System.Int32)">
  28669. <summary>
  28670. Sets the zoom magnication for the sheet. The zoom is expressed as a
  28671. fraction. For example to express a zoom of 75% use 3 for the numerator
  28672. and 4 for the denominator.
  28673. </summary>
  28674. <param name="numerator">The numerator for the zoom magnification.</param>
  28675. <param name="denominator">denominator for the zoom magnification.</param>
  28676. </member>
  28677. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int16,System.Int16)">
  28678. <summary>
  28679. Sets desktop window pane display area, when the
  28680. file is first opened in a viewer.
  28681. </summary>
  28682. <param name="toprow"> the top row to show in desktop window pane</param>
  28683. <param name="leftcol"> the left column to show in desktop window pane</param>
  28684. </member>
  28685. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  28686. <summary>
  28687. Shifts rows between startRow and endRow n number of rows.
  28688. If you use a negative number, it will shift rows up.
  28689. Code ensures that rows don't wrap around.
  28690. Calls shiftRows(startRow, endRow, n, false, false);
  28691. Additionally shifts merged regions that are completely defined in these
  28692. rows (ie. merged 2 cells on a row to be shifted).
  28693. </summary>
  28694. <param name="startRow">the row to start shifting</param>
  28695. <param name="endRow">the row to end shifting</param>
  28696. <param name="n">the number of rows to shift</param>
  28697. </member>
  28698. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  28699. <summary>
  28700. Shifts rows between startRow and endRow n number of rows.
  28701. If you use a negative number, it will shift rows up.
  28702. Code ensures that rows don't wrap around
  28703. Additionally shifts merged regions that are completely defined in these
  28704. rows (ie. merged 2 cells on a row to be shifted).
  28705. </summary>
  28706. <param name="startRow">the row to start shifting</param>
  28707. <param name="endRow">the row to end shifting</param>
  28708. <param name="n">the number of rows to shift</param>
  28709. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  28710. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  28711. </member>
  28712. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  28713. <summary>
  28714. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  28715. </summary>
  28716. <param name="colSplit">Horizonatal position of split</param>
  28717. <param name="rowSplit">Vertical position of split</param>
  28718. <param name="leftmostColumn">Top row visible in bottom pane</param>
  28719. <param name="topRow">Left column visible in right pane</param>
  28720. </member>
  28721. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32)">
  28722. <summary>
  28723. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  28724. </summary>
  28725. <param name="colSplit">Horizonatal position of split.</param>
  28726. <param name="rowSplit">Vertical position of split.</param>
  28727. </member>
  28728. <member name="M:NPOI.SS.UserModel.ISheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  28729. <summary>
  28730. Creates a split pane. Any existing freezepane or split pane is overwritten.
  28731. </summary>
  28732. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point)</param>
  28733. <param name="ySplitPos">Vertical position of split (in 1/20th of a point)</param>
  28734. <param name="leftmostColumn">Left column visible in right pane</param>
  28735. <param name="topRow">Top row visible in bottom pane</param>
  28736. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  28737. @see #PANE_LOWER_LEFT
  28738. @see #PANE_LOWER_RIGHT
  28739. @see #PANE_UPPER_LEFT
  28740. @see #PANE_UPPER_RIGHT
  28741. </member>
  28742. <member name="M:NPOI.SS.UserModel.ISheet.IsRowBroken(System.Int32)">
  28743. <summary>
  28744. Determines if there is a page break at the indicated row
  28745. </summary>
  28746. <param name="row">The row.</param>
  28747. </member>
  28748. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRowBreak(System.Int32)">
  28749. <summary>
  28750. Removes the page break at the indicated row
  28751. </summary>
  28752. <param name="row">The row index.</param>
  28753. </member>
  28754. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCell(System.Int32,System.Int32)">
  28755. <summary>
  28756. Sets the active cell.
  28757. </summary>
  28758. <param name="row">The row.</param>
  28759. <param name="column">The column.</param>
  28760. </member>
  28761. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  28762. <summary>
  28763. Sets the active cell range.
  28764. </summary>
  28765. <param name="firstRow">The firstrow.</param>
  28766. <param name="lastRow">The lastrow.</param>
  28767. <param name="firstColumn">The firstcolumn.</param>
  28768. <param name="lastColumn">The lastcolumn.</param>
  28769. </member>
  28770. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  28771. <summary>
  28772. Sets the active cell range.
  28773. </summary>
  28774. <param name="cellranges">The cellranges.</param>
  28775. <param name="activeRange">The index of the active range.</param>
  28776. <param name="activeRow">The active row in the active range</param>
  28777. <param name="activeColumn">The active column in the active range</param>
  28778. </member>
  28779. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnBreak(System.Int32)">
  28780. <summary>
  28781. Sets a page break at the indicated column
  28782. </summary>
  28783. <param name="column">The column.</param>
  28784. </member>
  28785. <member name="M:NPOI.SS.UserModel.ISheet.SetRowBreak(System.Int32)">
  28786. <summary>
  28787. Sets the row break.
  28788. </summary>
  28789. <param name="row">The row.</param>
  28790. </member>
  28791. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnBroken(System.Int32)">
  28792. <summary>
  28793. Determines if there is a page break at the indicated column
  28794. </summary>
  28795. <param name="column">The column index.</param>
  28796. </member>
  28797. <member name="M:NPOI.SS.UserModel.ISheet.RemoveColumnBreak(System.Int32)">
  28798. <summary>
  28799. Removes a page break at the indicated column
  28800. </summary>
  28801. <param name="column">The column.</param>
  28802. </member>
  28803. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  28804. <summary>
  28805. Expands or collapses a column group.
  28806. </summary>
  28807. <param name="columnNumber">One of the columns in the group.</param>
  28808. <param name="collapsed">if set to <c>true</c>collapse group.<c>false</c>expand group.</param>
  28809. </member>
  28810. <member name="M:NPOI.SS.UserModel.ISheet.GroupColumn(System.Int32,System.Int32)">
  28811. <summary>
  28812. Create an outline for the provided column range.
  28813. </summary>
  28814. <param name="fromColumn">beginning of the column range.</param>
  28815. <param name="toColumn">end of the column range.</param>
  28816. </member>
  28817. <member name="M:NPOI.SS.UserModel.ISheet.UngroupColumn(System.Int32,System.Int32)">
  28818. <summary>
  28819. Ungroup a range of columns that were previously groupped
  28820. </summary>
  28821. <param name="fromColumn">start column (0-based).</param>
  28822. <param name="toColumn">end column (0-based).</param>
  28823. </member>
  28824. <member name="M:NPOI.SS.UserModel.ISheet.GroupRow(System.Int32,System.Int32)">
  28825. <summary>
  28826. Tie a range of rows toGether so that they can be collapsed or expanded
  28827. </summary>
  28828. <param name="fromRow">start row (0-based)</param>
  28829. <param name="toRow">end row (0-based)</param>
  28830. </member>
  28831. <member name="M:NPOI.SS.UserModel.ISheet.UngroupRow(System.Int32,System.Int32)">
  28832. <summary>
  28833. Ungroup a range of rows that were previously groupped
  28834. </summary>
  28835. <param name="fromRow">start row (0-based)</param>
  28836. <param name="toRow">end row (0-based)</param>
  28837. </member>
  28838. <member name="M:NPOI.SS.UserModel.ISheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  28839. <summary>
  28840. Set view state of a groupped range of rows
  28841. </summary>
  28842. <param name="row">start row of a groupped range of rows (0-based).</param>
  28843. <param name="collapse">whether to expand/collapse the detail rows.</param>
  28844. </member>
  28845. <member name="M:NPOI.SS.UserModel.ISheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  28846. <summary>
  28847. Sets the default column style for a given column. POI will only apply this style to new cells Added to the sheet.
  28848. </summary>
  28849. <param name="column">the column index</param>
  28850. <param name="style">the style to set</param>
  28851. </member>
  28852. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32)">
  28853. <summary>
  28854. Adjusts the column width to fit the contents.
  28855. </summary>
  28856. <param name="column">the column index</param>
  28857. <remarks>
  28858. This process can be relatively slow on large sheets, so this should
  28859. normally only be called once per column, at the end of your
  28860. processing.
  28861. </remarks>
  28862. </member>
  28863. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32,System.Boolean)">
  28864. <summary>
  28865. Adjusts the column width to fit the contents.
  28866. </summary>
  28867. <param name="column">the column index.</param>
  28868. <param name="useMergedCells">whether to use the contents of merged cells when
  28869. calculating the width of the column. Default is to ignore merged cells.</param>
  28870. <remarks>
  28871. This process can be relatively slow on large sheets, so this should
  28872. normally only be called once per column, at the end of your
  28873. processing.
  28874. </remarks>
  28875. </member>
  28876. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(System.Int32,System.Int32)">
  28877. <summary>
  28878. Returns cell comment for the specified row and column
  28879. </summary>
  28880. <param name="row">The row.</param>
  28881. <param name="column">The column.</param>
  28882. </member>
  28883. <member name="M:NPOI.SS.UserModel.ISheet.CreateDrawingPatriarch">
  28884. <summary>
  28885. Creates the top-level drawing patriarch.
  28886. </summary>
  28887. </member>
  28888. <member name="M:NPOI.SS.UserModel.ISheet.SetActive(System.Boolean)">
  28889. <summary>
  28890. Sets whether sheet is selected.
  28891. </summary>
  28892. <param name="sel">Whether to select the sheet or deselect the sheet.</param>
  28893. </member>
  28894. <member name="M:NPOI.SS.UserModel.ISheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  28895. <summary>
  28896. Sets array formula to specified region for result.
  28897. </summary>
  28898. <param name="formula">text representation of the formula</param>
  28899. <param name="range">Region of array formula for result</param>
  28900. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  28901. </member>
  28902. <member name="M:NPOI.SS.UserModel.ISheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  28903. <summary>
  28904. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  28905. </summary>
  28906. <param name="cell">any cell within Array Formula range</param>
  28907. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  28908. </member>
  28909. <member name="M:NPOI.SS.UserModel.ISheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  28910. <summary>
  28911. Checks if the provided region is part of the merged regions.
  28912. </summary>
  28913. <param name="mergedRegion">Region searched in the merged regions</param>
  28914. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  28915. </member>
  28916. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidationHelper">
  28917. <summary>
  28918. Create an instance of a DataValidationHelper.
  28919. </summary>
  28920. <returns>Instance of a DataValidationHelper</returns>
  28921. </member>
  28922. <member name="M:NPOI.SS.UserModel.ISheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  28923. <summary>
  28924. Creates a data validation object
  28925. </summary>
  28926. <param name="dataValidation">The data validation object settings</param>
  28927. </member>
  28928. <member name="M:NPOI.SS.UserModel.ISheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  28929. <summary>
  28930. Enable filtering for a range of cells
  28931. </summary>
  28932. <param name="range">the range of cells to filter</param>
  28933. </member>
  28934. <member name="P:NPOI.SS.UserModel.ISheet.PhysicalNumberOfRows">
  28935. <summary>
  28936. Returns the number of physically defined rows (NOT the number of rows in the sheet)
  28937. </summary>
  28938. <value>the number of physically defined rows in this sheet.</value>
  28939. </member>
  28940. <member name="P:NPOI.SS.UserModel.ISheet.FirstRowNum">
  28941. <summary>
  28942. Gets the first row on the sheet
  28943. </summary>
  28944. <value>the number of the first logical row on the sheet (0-based).</value>
  28945. </member>
  28946. <member name="P:NPOI.SS.UserModel.ISheet.LastRowNum">
  28947. <summary>
  28948. Gets the last row on the sheet
  28949. </summary>
  28950. <value>last row contained n this sheet (0-based)</value>
  28951. </member>
  28952. <member name="P:NPOI.SS.UserModel.ISheet.ForceFormulaRecalculation">
  28953. <summary>
  28954. whether force formula recalculation.
  28955. </summary>
  28956. </member>
  28957. <member name="P:NPOI.SS.UserModel.ISheet.DefaultColumnWidth">
  28958. <summary>
  28959. Get the default column width for the sheet (if the columns do not define their own width)
  28960. in characters
  28961. </summary>
  28962. <value>default column width measured in characters.</value>
  28963. </member>
  28964. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeight">
  28965. <summary>
  28966. Get the default row height for the sheet (if the rows do not define their own height) in
  28967. twips (1/20 of a point)
  28968. </summary>
  28969. <value>default row height measured in twips (1/20 of a point)</value>
  28970. </member>
  28971. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints">
  28972. <summary>
  28973. Get the default row height for the sheet (if the rows do not define their own height) in
  28974. points.
  28975. </summary>
  28976. <value>The default row height in points.</value>
  28977. </member>
  28978. <member name="P:NPOI.SS.UserModel.ISheet.HorizontallyCenter">
  28979. <summary>
  28980. Determine whether printed output for this sheet will be horizontally centered.
  28981. </summary>
  28982. </member>
  28983. <member name="P:NPOI.SS.UserModel.ISheet.VerticallyCenter">
  28984. <summary>
  28985. Determine whether printed output for this sheet will be vertically centered.
  28986. </summary>
  28987. </member>
  28988. <member name="P:NPOI.SS.UserModel.ISheet.NumMergedRegions">
  28989. <summary>
  28990. Returns the number of merged regions
  28991. </summary>
  28992. </member>
  28993. <member name="P:NPOI.SS.UserModel.ISheet.DisplayZeros">
  28994. <summary>
  28995. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  28996. When false, cells with zero value appear blank instead of showing the number zero.
  28997. </summary>
  28998. <value>whether all zero values on the worksheet are displayed.</value>
  28999. </member>
  29000. <member name="P:NPOI.SS.UserModel.ISheet.Autobreaks">
  29001. <summary>
  29002. Gets or sets a value indicating whether the sheet displays Automatic Page Breaks.
  29003. </summary>
  29004. </member>
  29005. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGuts">
  29006. <summary>
  29007. Get whether to display the guts or not,
  29008. </summary>
  29009. <value>default value is true</value>
  29010. </member>
  29011. <member name="P:NPOI.SS.UserModel.ISheet.FitToPage">
  29012. <summary>
  29013. Flag indicating whether the Fit to Page print option is enabled.
  29014. </summary>
  29015. </member>
  29016. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsBelow">
  29017. <summary>
  29018. Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
  29019. When true a summary row is inserted below the detailed data being summarized and a
  29020. new outline level is established on that row.
  29021. When false a summary row is inserted above the detailed data being summarized and a new outline level
  29022. is established on that row.
  29023. </summary>
  29024. <returns><c>true</c> if row summaries appear below detail in the outline</returns>
  29025. </member>
  29026. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsRight">
  29027. <summary>
  29028. Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
  29029. When true a summary column is inserted to the right of the detailed data being summarized
  29030. and a new outline level is established on that column.
  29031. When false a summary column is inserted to the left of the detailed data being
  29032. summarized and a new outline level is established on that column.
  29033. </summary>
  29034. <returns><c>true</c> if col summaries appear right of the detail in the outline</returns>
  29035. </member>
  29036. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintGridlines">
  29037. <summary>
  29038. Gets the flag indicating whether this sheet displays the lines
  29039. between rows and columns to make editing and reading easier.
  29040. </summary>
  29041. <returns><c>true</c> if this sheet displays gridlines.</returns>
  29042. </member>
  29043. <member name="P:NPOI.SS.UserModel.ISheet.PrintSetup">
  29044. <summary>
  29045. Gets the print Setup object.
  29046. </summary>
  29047. <returns>The user model for the print Setup object.</returns>
  29048. </member>
  29049. <member name="P:NPOI.SS.UserModel.ISheet.Header">
  29050. <summary>
  29051. Gets the user model for the default document header.
  29052. <p/>
  29053. Note that XSSF offers more kinds of document headers than HSSF does
  29054. </summary>
  29055. <returns>the document header. Never <code>null</code></returns>
  29056. </member>
  29057. <member name="P:NPOI.SS.UserModel.ISheet.Footer">
  29058. <summary>
  29059. Gets the user model for the default document footer.
  29060. <p/>
  29061. Note that XSSF offers more kinds of document footers than HSSF does.
  29062. </summary>
  29063. <returns>the document footer. Never <code>null</code></returns>
  29064. </member>
  29065. <member name="P:NPOI.SS.UserModel.ISheet.Protect">
  29066. <summary>
  29067. Answer whether protection is enabled or disabled
  29068. </summary>
  29069. <returns>true => protection enabled; false => protection disabled</returns>
  29070. </member>
  29071. <member name="P:NPOI.SS.UserModel.ISheet.ScenarioProtect">
  29072. <summary>
  29073. Answer whether scenario protection is enabled or disabled
  29074. </summary>
  29075. <returns>true => protection enabled; false => protection disabled</returns>
  29076. </member>
  29077. <member name="P:NPOI.SS.UserModel.ISheet.TabColorIndex">
  29078. <summary>
  29079. Gets or sets the tab color of the _sheet
  29080. </summary>
  29081. </member>
  29082. <member name="P:NPOI.SS.UserModel.ISheet.DrawingPatriarch">
  29083. <summary>
  29084. Returns the top-level drawing patriach, if there is one.
  29085. This will hold any graphics or charts for the _sheet.
  29086. WARNING - calling this will trigger a parsing of the
  29087. associated escher records. Any that aren't supported
  29088. (such as charts and complex drawing types) will almost
  29089. certainly be lost or corrupted when written out. Only
  29090. use this with simple drawings, otherwise call
  29091. HSSFSheet#CreateDrawingPatriarch() and
  29092. start from scratch!
  29093. </summary>
  29094. <value>The drawing patriarch.</value>
  29095. </member>
  29096. <member name="P:NPOI.SS.UserModel.ISheet.TopRow">
  29097. <summary>
  29098. The top row in the visible view when the sheet is
  29099. first viewed after opening it in a viewer
  29100. </summary>
  29101. <value>the rownum (0 based) of the top row.</value>
  29102. </member>
  29103. <member name="P:NPOI.SS.UserModel.ISheet.LeftCol">
  29104. <summary>
  29105. The left col in the visible view when the sheet is
  29106. first viewed after opening it in a viewer
  29107. </summary>
  29108. <value>the rownum (0 based) of the top row</value>
  29109. </member>
  29110. <member name="P:NPOI.SS.UserModel.ISheet.PaneInformation">
  29111. <summary>
  29112. Returns the information regarding the currently configured pane (split or freeze)
  29113. </summary>
  29114. <value>if no pane configured returns <c>null</c> else return the pane information.</value>
  29115. </member>
  29116. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGridlines">
  29117. <summary>
  29118. Returns if gridlines are displayed
  29119. </summary>
  29120. </member>
  29121. <member name="P:NPOI.SS.UserModel.ISheet.DisplayFormulas">
  29122. <summary>
  29123. Returns if formulas are displayed
  29124. </summary>
  29125. </member>
  29126. <member name="P:NPOI.SS.UserModel.ISheet.DisplayRowColHeadings">
  29127. <summary>
  29128. Returns if RowColHeadings are displayed.
  29129. </summary>
  29130. </member>
  29131. <member name="P:NPOI.SS.UserModel.ISheet.IsActive">
  29132. <summary>
  29133. Returns if RowColHeadings are displayed.
  29134. </summary>
  29135. </member>
  29136. <member name="P:NPOI.SS.UserModel.ISheet.RowBreaks">
  29137. <summary>
  29138. Retrieves all the horizontal page breaks
  29139. </summary>
  29140. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  29141. </member>
  29142. <member name="P:NPOI.SS.UserModel.ISheet.ColumnBreaks">
  29143. <summary>
  29144. Retrieves all the vertical page breaks
  29145. </summary>
  29146. <value>all the vertical page breaks, or null if there are no column page breaks.</value>
  29147. </member>
  29148. <member name="P:NPOI.SS.UserModel.ISheet.Workbook">
  29149. <summary>
  29150. Gets the parent workbook.
  29151. </summary>
  29152. </member>
  29153. <member name="P:NPOI.SS.UserModel.ISheet.SheetName">
  29154. <summary>
  29155. Gets the name of the sheet.
  29156. </summary>
  29157. </member>
  29158. <member name="P:NPOI.SS.UserModel.ISheet.IsSelected">
  29159. <summary>
  29160. Gets or sets a value indicating whether this sheet is currently selected.
  29161. </summary>
  29162. </member>
  29163. <member name="P:NPOI.SS.UserModel.ISheet.SheetConditionalFormatting">
  29164. <summary>
  29165. The 'Conditional Formatting' facet for this <c>Sheet</c>
  29166. </summary>
  29167. <returns>conditional formatting rule for this sheet</returns>
  29168. </member>
  29169. <member name="P:NPOI.SS.UserModel.ISheet.IsRightToLeft">
  29170. <summary>
  29171. Whether the text is displayed in right-to-left mode in the window
  29172. </summary>
  29173. </member>
  29174. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingRows">
  29175. <summary>
  29176. Get or set the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
  29177. <p/>
  29178. Repeating rows cover a range of contiguous rows, e.g.:
  29179. <pre>
  29180. Sheet1!$1:$1
  29181. Sheet2!$5:$8
  29182. </pre>
  29183. The {@link CellRangeAddress} returned contains a column part which spans
  29184. all columns, and a row part which specifies the contiguous range of
  29185. repeating rows.
  29186. <p/>
  29187. If the Sheet does not have any repeating rows defined, null is returned.
  29188. </summary>
  29189. </member>
  29190. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingColumns">
  29191. <summary>
  29192. Gets or set the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
  29193. <p/>
  29194. Repeating columns cover a range of contiguous columns, e.g.:
  29195. <pre>
  29196. Sheet1!$A:$A
  29197. Sheet2!$C:$F
  29198. </pre>
  29199. The {@link CellRangeAddress} returned contains a row part which spans all
  29200. rows, and a column part which specifies the contiguous range of
  29201. repeating columns.
  29202. <p/>
  29203. If the Sheet does not have any repeating columns defined, null is
  29204. returned.
  29205. </summary>
  29206. </member>
  29207. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.INITIAL_CAPACITY">
  29208. Used for compile-time optimization. This is the initial size for the collection of
  29209. rows. It is currently Set to 20. If you generate larger sheets you may benefit
  29210. by Setting this to a higher number and recompiling a custom edition of HSSFSheet.
  29211. </member>
  29212. <member name="F:NPOI.HSSF.UserModel.HSSFSheet._sheet">
  29213. reference to the low level Sheet object
  29214. </member>
  29215. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  29216. <summary>
  29217. Creates new HSSFSheet - called by HSSFWorkbook to create a _sheet from
  29218. scratch. You should not be calling this from application code (its protected anyhow).
  29219. </summary>
  29220. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  29221. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet"/>
  29222. </member>
  29223. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Model.InternalSheet)">
  29224. <summary>
  29225. Creates an HSSFSheet representing the given Sheet object. Should only be
  29226. called by HSSFWorkbook when reading in an exisiting file.
  29227. </summary>
  29228. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  29229. <param name="sheet">lowlevel Sheet object this _sheet will represent</param>
  29230. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)"/>
  29231. </member>
  29232. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CloneSheet(NPOI.HSSF.UserModel.HSSFWorkbook)">
  29233. <summary>
  29234. Clones the _sheet.
  29235. </summary>
  29236. <param name="workbook">The _workbook.</param>
  29237. <returns>the cloned sheet</returns>
  29238. </member>
  29239. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CopyRow(System.Int32,System.Int32)">
  29240. <summary>
  29241. Copy one row to the target row
  29242. </summary>
  29243. <param name="sourceIndex">index of the source row</param>
  29244. <param name="targetIndex">index of the target row</param>
  29245. </member>
  29246. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetPropertiesFromSheet(NPOI.HSSF.Model.InternalSheet)">
  29247. <summary>
  29248. used internally to Set the properties given a Sheet object
  29249. </summary>
  29250. <param name="sheet">The _sheet.</param>
  29251. </member>
  29252. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)">
  29253. <summary>
  29254. Create a new row within the _sheet and return the high level representation
  29255. </summary>
  29256. <param name="rownum">The row number.</param>
  29257. <returns></returns>
  29258. @see org.apache.poi.hssf.usermodel.HSSFRow
  29259. @see #RemoveRow(HSSFRow)
  29260. </member>
  29261. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRowFromRecord(NPOI.HSSF.Record.RowRecord)">
  29262. <summary>
  29263. Used internally to Create a high level Row object from a low level row object.
  29264. USed when Reading an existing file
  29265. </summary>
  29266. <param name="row">low level record to represent as a high level Row and Add to _sheet.</param>
  29267. <returns>HSSFRow high level representation</returns>
  29268. </member>
  29269. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  29270. <summary>
  29271. Remove a row from this _sheet. All cells contained in the row are Removed as well
  29272. </summary>
  29273. <param name="row">the row to Remove.</param>
  29274. </member>
  29275. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindLastRow(System.Int32)">
  29276. <summary>
  29277. used internally to refresh the "last row" when the last row is Removed.
  29278. </summary>
  29279. <param name="lastrow">The last row.</param>
  29280. <returns></returns>
  29281. </member>
  29282. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindFirstRow(System.Int32)">
  29283. <summary>
  29284. used internally to refresh the "first row" when the first row is Removed.
  29285. </summary>
  29286. <param name="firstrow">The first row.</param>
  29287. <returns></returns>
  29288. </member>
  29289. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddRow(NPOI.HSSF.UserModel.HSSFRow,System.Boolean)">
  29290. Add a row to the _sheet
  29291. @param AddLow whether to Add the row to the low level model - false if its already there
  29292. </member>
  29293. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnStyle(System.Int32)">
  29294. <summary>
  29295. Returns the HSSFCellStyle that applies to the given
  29296. (0 based) column, or null if no style has been
  29297. set for that column
  29298. </summary>
  29299. <param name="column">The column.</param>
  29300. <returns></returns>
  29301. </member>
  29302. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRow(System.Int32)">
  29303. <summary>
  29304. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  29305. defined you get a null. This is to say row 4 represents the fifth row on a _sheet.
  29306. </summary>
  29307. <param name="rowIndex">Index of the row to get.</param>
  29308. <returns>the row number or null if its not defined on the _sheet</returns>
  29309. </member>
  29310. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  29311. <summary>
  29312. Creates a data validation object
  29313. </summary>
  29314. <param name="dataValidation">The data validation object settings</param>
  29315. </member>
  29316. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  29317. <summary>
  29318. Get the visibility state for a given column.F:\Gloria\�о�\�ļ���ʽ\NPOI\src\NPOI\HSSF\Util\HSSFDataValidation.cs
  29319. </summary>
  29320. <param name="column">the column to Get (0-based).</param>
  29321. <param name="hidden">the visiblity state of the column.</param>
  29322. </member>
  29323. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnHidden(System.Int32)">
  29324. <summary>
  29325. Get the hidden state for a given column.
  29326. </summary>
  29327. <param name="column">the column to Set (0-based)</param>
  29328. <returns>the visiblity state of the column;
  29329. </returns>
  29330. </member>
  29331. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  29332. <summary>
  29333. Set the width (in Units of 1/256th of a Char width)
  29334. </summary>
  29335. <param name="column">the column to Set (0-based)</param>
  29336. <param name="width">the width in Units of 1/256th of a Char width</param>
  29337. </member>
  29338. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnWidth(System.Int32)">
  29339. <summary>
  29340. Get the width (in Units of 1/256th of a Char width )
  29341. </summary>
  29342. <param name="column">the column to Set (0-based)</param>
  29343. <returns>the width in Units of 1/256th of a Char width</returns>
  29344. </member>
  29345. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.Region)">
  29346. <summary>
  29347. Adds a merged region of cells (hence those cells form one)
  29348. </summary>
  29349. <param name="region">The region (rowfrom/colfrom-rowto/colto) to merge.</param>
  29350. <returns>index of this region</returns>
  29351. </member>
  29352. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  29353. <summary>
  29354. adds a merged region of cells (hence those cells form one)
  29355. </summary>
  29356. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  29357. <returns>index of this region</returns>
  29358. </member>
  29359. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegion(System.Int32)">
  29360. <summary>
  29361. Removes a merged region of cells (hence letting them free)
  29362. </summary>
  29363. <param name="index">index of the region to Unmerge</param>
  29364. </member>
  29365. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRowEnumerator">
  29366. <summary>
  29367. Gets the row enumerator.
  29368. </summary>
  29369. <returns>
  29370. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  29371. be the third row if say for instance the second row is undefined.
  29372. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  29373. if you care which one it is.
  29374. </returns>
  29375. </member>
  29376. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetEnumerator">
  29377. <summary>
  29378. Alias for GetRowEnumerator() to allow <c>foreach</c> loops.
  29379. </summary>
  29380. <returns>
  29381. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  29382. be the third row if say for instance the second row is undefined.
  29383. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  29384. if you care which one it is.
  29385. </returns>
  29386. </member>
  29387. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCell(System.Int32,System.Int32)">
  29388. <summary>
  29389. Sets the active cell.
  29390. </summary>
  29391. <param name="row">The row.</param>
  29392. <param name="column">The column.</param>
  29393. </member>
  29394. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  29395. <summary>
  29396. Sets the active cell range.
  29397. </summary>
  29398. <param name="firstRow">The first row.</param>
  29399. <param name="lastRow">The last row.</param>
  29400. <param name="firstColumn">The first column.</param>
  29401. <param name="lastColumn">The last column.</param>
  29402. </member>
  29403. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  29404. <summary>
  29405. Sets the active cell range.
  29406. </summary>
  29407. <param name="cellranges">The cellranges.</param>
  29408. <param name="activeRange">The index of the active range.</param>
  29409. <param name="activeRow">The active row in the active range</param>
  29410. <param name="activeColumn">The active column in the active range</param>
  29411. </member>
  29412. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActive(System.Boolean)">
  29413. <summary>
  29414. Sets whether sheet is selected.
  29415. </summary>
  29416. <param name="sel">Whether to select the sheet or deselect the sheet.</param>
  29417. </member>
  29418. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ProtectSheet(System.String)">
  29419. <summary>
  29420. Sets the protection enabled as well as the password
  29421. </summary>
  29422. <param name="password">password to set for protection, pass <code>null</code> to remove protection</param>
  29423. </member>
  29424. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32,System.Int32)">
  29425. <summary>
  29426. Sets the zoom magnication for the _sheet. The zoom is expressed as a
  29427. fraction. For example to express a zoom of 75% use 3 for the numerator
  29428. and 4 for the denominator.
  29429. </summary>
  29430. <param name="numerator">The numerator for the zoom magnification.</param>
  29431. <param name="denominator">The denominator for the zoom magnification.</param>
  29432. </member>
  29433. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetEnclosedBorderOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  29434. <summary>
  29435. Sets the enclosed border of region.
  29436. </summary>
  29437. <param name="region">The region.</param>
  29438. <param name="borderType">Type of the border.</param>
  29439. <param name="color">The color.</param>
  29440. </member>
  29441. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderRightOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  29442. <summary>
  29443. Sets the right border of region.
  29444. </summary>
  29445. <param name="region">The region.</param>
  29446. <param name="borderType">Type of the border.</param>
  29447. <param name="color">The color.</param>
  29448. </member>
  29449. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderLeftOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  29450. <summary>
  29451. Sets the left border of region.
  29452. </summary>
  29453. <param name="region">The region.</param>
  29454. <param name="borderType">Type of the border.</param>
  29455. <param name="color">The color.</param>
  29456. </member>
  29457. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderTopOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  29458. <summary>
  29459. Sets the top border of region.
  29460. </summary>
  29461. <param name="region">The region.</param>
  29462. <param name="borderType">Type of the border.</param>
  29463. <param name="color">The color.</param>
  29464. </member>
  29465. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderBottomOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  29466. <summary>
  29467. Sets the bottom border of region.
  29468. </summary>
  29469. <param name="region">The region.</param>
  29470. <param name="borderType">Type of the border.</param>
  29471. <param name="color">The color.</param>
  29472. </member>
  29473. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int16,System.Int16)">
  29474. <summary>
  29475. Sets desktop window pane display area, when the
  29476. file is first opened in a viewer.
  29477. </summary>
  29478. <param name="toprow">the top row to show in desktop window pane</param>
  29479. <param name="leftcol">the left column to show in desktop window pane</param>
  29480. </member>
  29481. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftMerged(System.Int32,System.Int32,System.Int32,System.Boolean)">
  29482. <summary>
  29483. Shifts the merged regions left or right depending on mode
  29484. TODO: MODE , this is only row specific
  29485. </summary>
  29486. <param name="startRow">The start row.</param>
  29487. <param name="endRow">The end row.</param>
  29488. <param name="n">The n.</param>
  29489. <param name="IsRow">if set to <c>true</c> [is row].</param>
  29490. </member>
  29491. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  29492. <summary>
  29493. Shifts rows between startRow and endRow n number of rows.
  29494. If you use a negative number, it will Shift rows up.
  29495. Code Ensures that rows don't wrap around.
  29496. Calls ShiftRows(startRow, endRow, n, false, false);
  29497. Additionally Shifts merged regions that are completely defined in these
  29498. rows (ie. merged 2 cells on a row to be Shifted).
  29499. </summary>
  29500. <param name="startRow">the row to start Shifting</param>
  29501. <param name="endRow">the row to end Shifting</param>
  29502. <param name="n">the number of rows to Shift</param>
  29503. </member>
  29504. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  29505. <summary>
  29506. Shifts rows between startRow and endRow n number of rows.
  29507. If you use a negative number, it will shift rows up.
  29508. Code ensures that rows don't wrap around
  29509. Additionally shifts merged regions that are completely defined in these
  29510. rows (ie. merged 2 cells on a row to be shifted).
  29511. TODO Might want to add bounds checking here
  29512. </summary>
  29513. <param name="startRow">the row to start shifting</param>
  29514. <param name="endRow">the row to end shifting</param>
  29515. <param name="n">the number of rows to shift</param>
  29516. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  29517. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  29518. </member>
  29519. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  29520. <summary>
  29521. Shifts rows between startRow and endRow n number of rows.
  29522. If you use a negative number, it will Shift rows up.
  29523. Code Ensures that rows don't wrap around
  29524. Additionally Shifts merged regions that are completely defined in these
  29525. rows (ie. merged 2 cells on a row to be Shifted).
  29526. TODO Might want to Add bounds Checking here
  29527. </summary>
  29528. <param name="startRow">the row to start Shifting</param>
  29529. <param name="endRow">the row to end Shifting</param>
  29530. <param name="n">the number of rows to Shift</param>
  29531. <param name="copyRowHeight">whether to copy the row height during the Shift</param>
  29532. <param name="resetOriginalRowHeight">whether to Set the original row's height to the default</param>
  29533. <param name="moveComments">if set to <c>true</c> [move comments].</param>
  29534. </member>
  29535. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.InsertChartRecords(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  29536. <summary>
  29537. Inserts the chart records.
  29538. </summary>
  29539. <param name="records">The records.</param>
  29540. </member>
  29541. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  29542. <summary>
  29543. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  29544. </summary>
  29545. <param name="colSplit">Horizonatal position of split.</param>
  29546. <param name="rowSplit">Vertical position of split.</param>
  29547. <param name="leftmostColumn">Top row visible in bottom pane</param>
  29548. <param name="topRow">Left column visible in right pane.</param>
  29549. </member>
  29550. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  29551. <summary>
  29552. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  29553. </summary>
  29554. <param name="colSplit">Horizonatal position of split.</param>
  29555. <param name="rowSplit">Vertical position of split.</param>
  29556. </member>
  29557. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  29558. <summary>
  29559. Creates a split pane. Any existing freezepane or split pane is overwritten.
  29560. </summary>
  29561. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point).</param>
  29562. <param name="ySplitPos">Vertical position of split (in 1/20th of a point).</param>
  29563. <param name="leftmostColumn">Left column visible in right pane.</param>
  29564. <param name="topRow">Top row visible in bottom pane.</param>
  29565. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT,PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  29566. </member>
  29567. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  29568. <summary>
  29569. Gets the size of the margin in inches.
  29570. </summary>
  29571. <param name="margin">which margin to get.</param>
  29572. <returns>the size of the margin</returns>
  29573. </member>
  29574. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  29575. <summary>
  29576. Sets the size of the margin in inches.
  29577. </summary>
  29578. <param name="margin">which margin to get.</param>
  29579. <param name="size">the size of the margin</param>
  29580. </member>
  29581. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowBreak(System.Int32)">
  29582. <summary>
  29583. Sets a page break at the indicated row
  29584. </summary>
  29585. <param name="row">The row.</param>
  29586. </member>
  29587. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsRowBroken(System.Int32)">
  29588. <summary>
  29589. Determines if there is a page break at the indicated row
  29590. </summary>
  29591. <param name="row">The row.</param>
  29592. <returns>
  29593. <c>true</c> if [is row broken] [the specified row]; otherwise, <c>false</c>.
  29594. </returns>
  29595. </member>
  29596. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRowBreak(System.Int32)">
  29597. <summary>
  29598. Removes the page break at the indicated row
  29599. </summary>
  29600. <param name="row">The row.</param>
  29601. </member>
  29602. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnBreak(System.Int32)">
  29603. <summary>
  29604. Sets a page break at the indicated column
  29605. </summary>
  29606. <param name="column">The column.</param>
  29607. </member>
  29608. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnBroken(System.Int32)">
  29609. <summary>
  29610. Determines if there is a page break at the indicated column
  29611. </summary>
  29612. <param name="column">The column.</param>
  29613. <returns>
  29614. <c>true</c> if [is column broken] [the specified column]; otherwise, <c>false</c>.
  29615. </returns>
  29616. </member>
  29617. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveColumnBreak(System.Int32)">
  29618. <summary>
  29619. Removes a page break at the indicated column
  29620. </summary>
  29621. <param name="column">The column.</param>
  29622. </member>
  29623. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateRow(System.Int32)">
  29624. <summary>
  29625. Runs a bounds Check for row numbers
  29626. </summary>
  29627. <param name="row">The row.</param>
  29628. </member>
  29629. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateColumn(System.Int32)">
  29630. <summary>
  29631. Runs a bounds Check for column numbers
  29632. </summary>
  29633. <param name="column">The column.</param>
  29634. </member>
  29635. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.DumpDrawingRecords(System.Boolean)">
  29636. <summary>
  29637. Aggregates the drawing records and dumps the escher record hierarchy
  29638. to the standard output.
  29639. </summary>
  29640. <param name="fat">if set to <c>true</c> [fat].</param>
  29641. </member>
  29642. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateDrawingPatriarch">
  29643. Creates the top-level drawing patriarch. This will have
  29644. the effect of removing any existing drawings on this
  29645. sheet.
  29646. This may then be used to add graphics or charts
  29647. @return The new patriarch.
  29648. </member>
  29649. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  29650. <summary>
  29651. Expands or collapses a column Group.
  29652. </summary>
  29653. <param name="columnNumber">One of the columns in the Group.</param>
  29654. <param name="collapsed">true = collapse Group, false = expand Group.</param>
  29655. </member>
  29656. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupColumn(System.Int32,System.Int32)">
  29657. <summary>
  29658. Create an outline for the provided column range.
  29659. </summary>
  29660. <param name="fromColumn">beginning of the column range.</param>
  29661. <param name="toColumn">end of the column range.</param>
  29662. </member>
  29663. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupColumn(System.Int32,System.Int32)">
  29664. <summary>
  29665. Ungroups the column.
  29666. </summary>
  29667. <param name="fromColumn">From column.</param>
  29668. <param name="toColumn">To column.</param>
  29669. </member>
  29670. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupRow(System.Int32,System.Int32)">
  29671. <summary>
  29672. Groups the row.
  29673. </summary>
  29674. <param name="fromRow">From row.</param>
  29675. <param name="toRow">To row.</param>
  29676. </member>
  29677. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  29678. <summary>
  29679. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  29680. </summary>
  29681. <param name="cell">any cell within Array Formula range</param>
  29682. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  29683. </member>
  29684. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  29685. <summary>
  29686. Also creates cells if they don't exist.
  29687. </summary>
  29688. </member>
  29689. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  29690. <summary>
  29691. Sets array formula to specified region for result.
  29692. </summary>
  29693. <param name="formula">text representation of the formula</param>
  29694. <param name="range">Region of array formula for result</param>
  29695. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  29696. </member>
  29697. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupRow(System.Int32,System.Int32)">
  29698. <summary>
  29699. Ungroups the row.
  29700. </summary>
  29701. <param name="fromRow">From row.</param>
  29702. <param name="toRow">To row.</param>
  29703. </member>
  29704. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  29705. <summary>
  29706. Sets the row group collapsed.
  29707. </summary>
  29708. <param name="row">The row.</param>
  29709. <param name="collapse">if set to <c>true</c> [collapse].</param>
  29710. </member>
  29711. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  29712. <summary>
  29713. Sets the default column style for a given column. POI will only apply this style to new cells Added to the _sheet.
  29714. </summary>
  29715. <param name="column">the column index</param>
  29716. <param name="style">the style to set</param>
  29717. </member>
  29718. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32)">
  29719. <summary>
  29720. Adjusts the column width to fit the contents.
  29721. This Process can be relatively slow on large sheets, so this should
  29722. normally only be called once per column, at the end of your
  29723. Processing.
  29724. </summary>
  29725. <param name="column">the column index.</param>
  29726. </member>
  29727. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  29728. <summary>
  29729. Adjusts the column width to fit the contents.
  29730. This Process can be relatively slow on large sheets, so this should
  29731. normally only be called once per column, at the end of your
  29732. Processing.
  29733. You can specify whether the content of merged cells should be considered or ignored.
  29734. Default is to ignore merged cells.
  29735. </summary>
  29736. <param name="column">the column index</param>
  29737. <param name="useMergedCells">whether to use the contents of merged cells when calculating the width of the column</param>
  29738. </member>
  29739. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  29740. <summary>
  29741. Checks if the provided region is part of the merged regions.
  29742. </summary>
  29743. <param name="mergedRegion">Region searched in the merged regions</param>
  29744. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  29745. </member>
  29746. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMergedRegion(System.Int32)">
  29747. <summary>
  29748. Gets the merged region at the specified index
  29749. </summary>
  29750. <param name="index">The index.</param>
  29751. <returns></returns>
  29752. </member>
  29753. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.HSSFFont2Font(NPOI.HSSF.UserModel.HSSFFont)">
  29754. <summary>
  29755. Convert HSSFFont to Font.
  29756. </summary>
  29757. <param name="font1">The font.</param>
  29758. <returns></returns>
  29759. </member>
  29760. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(System.Int32,System.Int32)">
  29761. <summary>
  29762. Returns cell comment for the specified row and column
  29763. </summary>
  29764. <param name="row">The row.</param>
  29765. <param name="column">The column.</param>
  29766. <returns>cell comment or null if not found</returns>
  29767. </member>
  29768. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetDataValidationHelper">
  29769. <summary>
  29770. Create an instance of a DataValidationHelper.
  29771. </summary>
  29772. <returns>Instance of a DataValidationHelper</returns>
  29773. </member>
  29774. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  29775. <summary>
  29776. Enable filtering for a range of cells
  29777. </summary>
  29778. <param name="range">the range of cells to filter</param>
  29779. </member>
  29780. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFSheet.CopySheet" -->
  29781. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemapCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle,System.Collections.Generic.Dictionary{System.Int16,System.Int16})">
  29782. <summary>
  29783. Translate color palette entries from the source to the destination sheet
  29784. </summary>
  29785. </member>
  29786. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayZeros">
  29787. Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
  29788. When false, cells with zero value appear blank instead of showing the number zero.
  29789. In Excel 2003 this option can be changed in the Options dialog on the View tab.
  29790. @return whether all zero values on the worksheet are displayed
  29791. </member>
  29792. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PhysicalNumberOfRows">
  29793. <summary>
  29794. Returns the number of phsyically defined rows (NOT the number of rows in the _sheet)
  29795. </summary>
  29796. <value>The physical number of rows.</value>
  29797. </member>
  29798. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FirstRowNum">
  29799. <summary>
  29800. Gets the first row on the _sheet
  29801. </summary>
  29802. <value>the number of the first logical row on the _sheet</value>
  29803. </member>
  29804. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LastRowNum">
  29805. <summary>
  29806. Gets the last row on the _sheet
  29807. </summary>
  29808. <value>last row contained n this _sheet.</value>
  29809. </member>
  29810. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultColumnWidth">
  29811. <summary>
  29812. Gets or sets the default width of the column.
  29813. </summary>
  29814. <value>The default width of the column.</value>
  29815. </member>
  29816. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeight">
  29817. <summary>
  29818. Get the default row height for the _sheet (if the rows do not define their own height) in
  29819. twips (1/20 of a point)
  29820. </summary>
  29821. <value>The default height of the row.</value>
  29822. </member>
  29823. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeightInPoints">
  29824. <summary>
  29825. Get the default row height for the _sheet (if the rows do not define their own height) in
  29826. points.
  29827. </summary>
  29828. <value>The default row height in points.</value>
  29829. </member>
  29830. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsGridsPrinted">
  29831. <summary>
  29832. Get whether gridlines are printed.
  29833. </summary>
  29834. <value>
  29835. <c>true</c> if printed; otherwise, <c>false</c>.
  29836. </value>
  29837. </member>
  29838. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ForceFormulaRecalculation">
  29839. <summary>
  29840. Whether a record must be Inserted or not at generation to indicate that
  29841. formula must be recalculated when _workbook is opened.
  29842. </summary>
  29843. <value>
  29844. <c>true</c> if [force formula recalculation]; otherwise, <c>false</c>.
  29845. </value>
  29846. @return true if an Uncalced record must be Inserted or not at generation
  29847. </member>
  29848. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.VerticallyCenter">
  29849. <summary>
  29850. Determine whether printed output for this _sheet will be vertically centered.
  29851. </summary>
  29852. <value><c>true</c> if [vertically center]; otherwise, <c>false</c>.</value>
  29853. </member>
  29854. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.HorizontallyCenter">
  29855. <summary>
  29856. Determine whether printed output for this _sheet will be horizontally centered.
  29857. </summary>
  29858. <value><c>true</c> if [horizontally center]; otherwise, <c>false</c>.</value>
  29859. </member>
  29860. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.NumMergedRegions">
  29861. <summary>
  29862. returns the number of merged regions
  29863. </summary>
  29864. <value>The number of merged regions</value>
  29865. </member>
  29866. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Sheet">
  29867. <summary>
  29868. used internally in the API to Get the low level Sheet record represented by this
  29869. Object.
  29870. </summary>
  29871. <value>low level representation of this HSSFSheet.</value>
  29872. </member>
  29873. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeExpression">
  29874. <summary>
  29875. Gets or sets whether alternate expression evaluation is on
  29876. </summary>
  29877. <value>
  29878. <c>true</c> if [alternative expression]; otherwise, <c>false</c>.
  29879. </value>
  29880. </member>
  29881. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeFormula">
  29882. <summary>
  29883. whether alternative formula entry is on
  29884. </summary>
  29885. <value><c>true</c> alternative formulas or not; otherwise, <c>false</c>.</value>
  29886. </member>
  29887. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Autobreaks">
  29888. <summary>
  29889. show automatic page breaks or not
  29890. </summary>
  29891. <value>whether to show auto page breaks</value>
  29892. </member>
  29893. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Dialog">
  29894. <summary>
  29895. Gets or sets a value indicating whether _sheet is a dialog _sheet
  29896. </summary>
  29897. <value><c>true</c> if is dialog; otherwise, <c>false</c>.</value>
  29898. </member>
  29899. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGuts">
  29900. <summary>
  29901. Gets or sets a value indicating whether to Display the guts or not.
  29902. </summary>
  29903. <value><c>true</c> if guts or no guts (or glory); otherwise, <c>false</c>.</value>
  29904. </member>
  29905. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FitToPage">
  29906. <summary>
  29907. Gets or sets a value indicating whether fit to page option is on
  29908. </summary>
  29909. <value><c>true</c> if [fit to page]; otherwise, <c>false</c>.</value>
  29910. </member>
  29911. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsBelow">
  29912. <summary>
  29913. Get if row summaries appear below detail in the outline
  29914. </summary>
  29915. <value><c>true</c> if below or not; otherwise, <c>false</c>.</value>
  29916. </member>
  29917. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsRight">
  29918. <summary>
  29919. Get if col summaries appear right of the detail in the outline
  29920. </summary>
  29921. <value><c>true</c> right or not; otherwise, <c>false</c>.</value>
  29922. </member>
  29923. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintGridlines">
  29924. <summary>
  29925. Gets or sets whether gridlines are printed.
  29926. </summary>
  29927. <value>
  29928. <c>true</c> Gridlines are printed; otherwise, <c>false</c>.
  29929. </value>
  29930. </member>
  29931. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PrintSetup">
  29932. <summary>
  29933. Gets the print setup object.
  29934. </summary>
  29935. <value>The user model for the print setup object.</value>
  29936. </member>
  29937. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Header">
  29938. <summary>
  29939. Gets the user model for the document header.
  29940. </summary>
  29941. <value>The Document header.</value>
  29942. </member>
  29943. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Footer">
  29944. <summary>
  29945. Gets the user model for the document footer.
  29946. </summary>
  29947. <value>The Document footer.</value>
  29948. </member>
  29949. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsRightToLeft">
  29950. <summary>
  29951. Gets or sets whether the worksheet is displayed from right to left instead of from left to right.
  29952. </summary>
  29953. <value>true for right to left, false otherwise</value>
  29954. <remarks>poi bug 47970</remarks>
  29955. </member>
  29956. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsSelected">
  29957. <summary>
  29958. Note - this is not the same as whether the _sheet is focused (isActive)
  29959. </summary>
  29960. <value>
  29961. <c>true</c> if this _sheet is currently selected; otherwise, <c>false</c>.
  29962. </value>
  29963. </member>
  29964. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsActive">
  29965. <summary>
  29966. Gets or sets a value indicating if this _sheet is currently focused.
  29967. </summary>
  29968. <value><c>true</c> if this _sheet is currently focused; otherwise, <c>false</c>.</value>
  29969. </member>
  29970. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Protect">
  29971. <summary>
  29972. Answer whether protection is enabled or disabled
  29973. </summary>
  29974. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  29975. </member>
  29976. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Password">
  29977. <summary>
  29978. Gets the hashed password
  29979. </summary>
  29980. <value>The password.</value>
  29981. </member>
  29982. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ObjectProtect">
  29983. <summary>
  29984. Answer whether object protection is enabled or disabled
  29985. </summary>
  29986. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  29987. </member>
  29988. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ScenarioProtect">
  29989. <summary>
  29990. Answer whether scenario protection is enabled or disabled
  29991. </summary>
  29992. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  29993. </member>
  29994. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TopRow">
  29995. <summary>
  29996. The top row in the visible view when the _sheet is
  29997. first viewed after opening it in a viewer
  29998. </summary>
  29999. <value>the rownum (0 based) of the top row</value>
  30000. </member>
  30001. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LeftCol">
  30002. <summary>
  30003. The left col in the visible view when the _sheet Is
  30004. first viewed after opening it in a viewer
  30005. </summary>
  30006. <value>the rownum (0 based) of the top row</value>
  30007. </member>
  30008. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PaneInformation">
  30009. <summary>
  30010. Returns the information regarding the currently configured pane (split or freeze).
  30011. </summary>
  30012. <value>null if no pane configured, or the pane information.</value>
  30013. </member>
  30014. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGridlines">
  30015. <summary>
  30016. Gets or sets if gridlines are Displayed.
  30017. </summary>
  30018. <value>whether gridlines are Displayed</value>
  30019. </member>
  30020. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayFormulas">
  30021. <summary>
  30022. Gets or sets a value indicating whether formulas are displayed.
  30023. </summary>
  30024. <value>whether formulas are Displayed</value>
  30025. </member>
  30026. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayRowColHeadings">
  30027. <summary>
  30028. Gets or sets a value indicating whether RowColHeadings are displayed.
  30029. </summary>
  30030. <value>
  30031. whether RowColHeadings are displayed
  30032. </value>
  30033. </member>
  30034. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowBreaks">
  30035. <summary>
  30036. Retrieves all the horizontal page breaks
  30037. </summary>
  30038. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  30039. </member>
  30040. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ColumnBreaks">
  30041. <summary>
  30042. Retrieves all the vertical page breaks
  30043. </summary>
  30044. <value>all the vertical page breaks, or null if there are no column page breaks</value>
  30045. </member>
  30046. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingEscherAggregate">
  30047. <summary>
  30048. Returns the agregate escher records for this _sheet,
  30049. it there is one.
  30050. WARNING - calling this will trigger a parsing of the
  30051. associated escher records. Any that aren't supported
  30052. (such as charts and complex drawing types) will almost
  30053. certainly be lost or corrupted when written out.
  30054. </summary>
  30055. <value>The drawing escher aggregate.</value>
  30056. </member>
  30057. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingPatriarch">
  30058. This will hold any graphics or charts for the sheet.
  30059. @return the top-level drawing patriarch, if there is one, else returns null
  30060. </member>
  30061. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TabColorIndex">
  30062. <summary>
  30063. Gets or sets the tab color of the _sheet
  30064. </summary>
  30065. </member>
  30066. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsAutoTabColor">
  30067. <summary>
  30068. Gets or sets whether the tab color of _sheet is automatic
  30069. </summary>
  30070. </member>
  30071. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetConditionalFormatting">
  30072. <summary>
  30073. Gets the sheet conditional formatting.
  30074. </summary>
  30075. <value>The sheet conditional formatting.</value>
  30076. </member>
  30077. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DVRecords">
  30078. <summary>
  30079. Get the DVRecords objects that are associated to this _sheet
  30080. </summary>
  30081. <value>a list of DVRecord instances</value>
  30082. </member>
  30083. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Workbook">
  30084. <summary>
  30085. Provide a reference to the parent workbook.
  30086. </summary>
  30087. </member>
  30088. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetName">
  30089. <summary>
  30090. Returns the name of this _sheet
  30091. </summary>
  30092. </member>
  30093. <member name="T:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting">
  30094. <summary>
  30095. The Conditional Formatting facet of HSSFSheet
  30096. @author Dmitriy Kumshayev
  30097. </summary>
  30098. </member>
  30099. <member name="T:NPOI.SS.UserModel.ISheetConditionalFormatting">
  30100. The 'Conditional Formatting' facet of <c>Sheet</c>
  30101. @author Dmitriy Kumshayev
  30102. @author Yegor Kozlov
  30103. @since 3.8
  30104. </member>
  30105. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  30106. <summary>
  30107. Add a new Conditional Formatting to the sheet.
  30108. </summary>
  30109. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  30110. <param name="rule">the rule to apply</param>
  30111. <returns>index of the newly Created Conditional Formatting object</returns>
  30112. </member>
  30113. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  30114. <summary>
  30115. Add a new Conditional Formatting consisting of two rules.
  30116. </summary>
  30117. <param name="regions"> list of rectangular regions to apply conditional formatting rules</param>
  30118. <param name="rule1">the first rule</param>
  30119. <param name="rule2">the second rule</param>
  30120. <returns>index of the newly Created Conditional Formatting object</returns>
  30121. </member>
  30122. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  30123. <summary>
  30124. Add a new Conditional Formatting Set to the sheet.
  30125. </summary>
  30126. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  30127. <param name="cfRules">Set of up to three conditional formatting rules</param>
  30128. <returns>index of the newly Created Conditional Formatting object</returns>
  30129. </member>
  30130. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  30131. <summary>
  30132. Adds a copy of a ConditionalFormatting object to the sheet
  30133. </summary>
  30134. <param name="cf">the Conditional Formatting to clone</param>
  30135. <returns>index of the new Conditional Formatting object</returns>
  30136. <remarks>
  30137. This method could be used to copy ConditionalFormatting object
  30138. from one sheet to another. For example:
  30139. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  30140. newSheet.AddConditionalFormatting(cf);
  30141. </remarks>
  30142. </member>
  30143. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  30144. A factory method allowing to create a conditional formatting rule
  30145. with a cell comparison operator
  30146. <p>
  30147. The Created conditional formatting rule Compares a cell value
  30148. to a formula calculated result, using the specified operator.
  30149. The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  30150. </p>
  30151. @param comparisonOperation - MUST be a constant value from
  30152. <c>{@link ComparisonOperator}</c>: <p>
  30153. <ul>
  30154. <li>BETWEEN</li>
  30155. <li>NOT_BETWEEN</li>
  30156. <li>EQUAL</li>
  30157. <li>NOT_EQUAL</li>
  30158. <li>GT</li>
  30159. <li>LT</li>
  30160. <li>GE</li>
  30161. <li>LE</li>
  30162. </ul>
  30163. </p>
  30164. @param formula1 - formula for the valued, Compared with the cell
  30165. @param formula2 - second formula (only used with
  30166. {@link ComparisonOperator#BETWEEN}) and {@link ComparisonOperator#NOT_BETWEEN} operations)
  30167. </member>
  30168. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String)">
  30169. <summary>
  30170. Create a conditional formatting rule that Compares a cell value to a formula calculated result, using an operator
  30171. </summary>
  30172. <param name="comparisonOperation">MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN</param>
  30173. <param name="formula">the formula to determine if the conditional formatting is applied</param>
  30174. <returns>a conditional formatting rule</returns>
  30175. </member>
  30176. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  30177. <summary>
  30178. Create a conditional formatting rule based on a Boolean formula.
  30179. When the formula result is true, the cell is highlighted.
  30180. </summary>
  30181. <param name="formula">the formula to Evaluate. MUST be a Boolean function.</param>
  30182. <returns>conditional formatting rule</returns>
  30183. </member>
  30184. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  30185. <summary>
  30186. Gets Conditional Formatting object at a particular index
  30187. </summary>
  30188. <param name="index">0-based index of the Conditional Formatting object to fetch</param>
  30189. <returns>Conditional Formatting object or null if not found</returns>
  30190. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  30191. </member>
  30192. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  30193. <summary>
  30194. Removes a Conditional Formatting object by index
  30195. </summary>
  30196. <param name="index">0-based index of the Conditional Formatting object to remove</param>
  30197. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  30198. </member>
  30199. <member name="P:NPOI.SS.UserModel.ISheetConditionalFormatting.NumConditionalFormattings">
  30200. <summary>
  30201. get the number of conditional formats in this sheet
  30202. </summary>
  30203. </member>
  30204. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  30205. <summary>
  30206. A factory method allowing to Create a conditional formatting rule
  30207. with a cell comparison operator
  30208. TODO - formulas containing cell references are currently not Parsed properly
  30209. </summary>
  30210. <param name="comparisonOperation">a constant value from HSSFConditionalFormattingRule.ComparisonOperator</param>
  30211. <param name="formula1">formula for the valued, Compared with the cell</param>
  30212. <param name="formula2">second formula (only used with HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN
  30213. and HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN operations)</param>
  30214. <returns></returns>
  30215. </member>
  30216. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  30217. <summary>
  30218. A factory method allowing to Create a conditional formatting rule with a formula.
  30219. The formatting rules are applied by Excel when the value of the formula not equal to 0.
  30220. TODO - formulas containing cell references are currently not Parsed properly
  30221. </summary>
  30222. <param name="formula">formula for the valued, Compared with the cell</param>
  30223. <returns></returns>
  30224. </member>
  30225. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  30226. <summary>
  30227. Adds a copy of HSSFConditionalFormatting object to the sheet
  30228. This method could be used to copy HSSFConditionalFormatting object
  30229. from one sheet to another.
  30230. </summary>
  30231. <param name="cf">HSSFConditionalFormatting object</param>
  30232. <returns>index of the new Conditional Formatting object</returns>
  30233. <example>
  30234. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  30235. newSheet.AddConditionalFormatting(cf);
  30236. </example>
  30237. </member>
  30238. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  30239. <summary>
  30240. Allows to Add a new Conditional Formatting Set to the sheet.
  30241. </summary>
  30242. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  30243. <param name="cfRules">Set of up to three conditional formatting rules</param>
  30244. <returns>index of the newly Created Conditional Formatting object</returns>
  30245. </member>
  30246. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  30247. <summary>
  30248. Adds the conditional formatting.
  30249. </summary>
  30250. <param name="regions">The regions.</param>
  30251. <param name="rule1">The rule1.</param>
  30252. <returns></returns>
  30253. </member>
  30254. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  30255. <summary>
  30256. Adds the conditional formatting.
  30257. </summary>
  30258. <param name="regions">The regions.</param>
  30259. <param name="rule1">The rule1.</param>
  30260. <param name="rule2">The rule2.</param>
  30261. <returns></returns>
  30262. </member>
  30263. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  30264. <summary>
  30265. Gets Conditional Formatting object at a particular index
  30266. @param index
  30267. of the Conditional Formatting object to fetch
  30268. </summary>
  30269. <param name="index">Conditional Formatting object</param>
  30270. <returns></returns>
  30271. </member>
  30272. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  30273. <summary>
  30274. Removes a Conditional Formatting object by index
  30275. </summary>
  30276. <param name="index">index of a Conditional Formatting object to Remove</param>
  30277. </member>
  30278. <member name="P:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.NumConditionalFormattings">
  30279. <summary>
  30280. the number of Conditional Formatting objects of the sheet
  30281. </summary>
  30282. <value>The num conditional formattings.</value>
  30283. </member>
  30284. <member name="T:NPOI.HSSF.UserModel.OperationEvaluatorFactory">
  30285. This class Creates <c>OperationEval</c> instances to help evaluate <c>OperationPtg</c>
  30286. formula tokens.
  30287. @author Josh Micich
  30288. </member>
  30289. <member name="M:NPOI.HSSF.UserModel.OperationEvaluatorFactory.Create(NPOI.SS.Formula.PTG.OperationPtg)">
  30290. returns the OperationEval concrete impl instance corresponding
  30291. to the supplied operationPtg
  30292. </member>
  30293. <member name="T:NPOI.HSSF.UserModel.StaticFontMetrics">
  30294. Allows the user to lookup the font metrics for a particular font without
  30295. actually having the font on the system. The font details are Loaded
  30296. as a resource from the POI jar file (or classpath) and should be contained
  30297. in path "/font_metrics.properties". The font widths are for a 10 point
  30298. version of the font. Use a multiplier for other sizes.
  30299. @author Glen Stampoultzis (glens at apache.org)
  30300. </member>
  30301. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontMetricsProps">
  30302. The font metrics property file we're using
  30303. </member>
  30304. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontDetailsMap">
  30305. Our cache of font details we've alReady looked up
  30306. </member>
  30307. <member name="M:NPOI.HSSF.UserModel.StaticFontMetrics.GetFontDetails(System.Drawing.Font)">
  30308. Retrieves the fake font details for a given font.
  30309. @param font the font to lookup.
  30310. @return the fake font.
  30311. </member>
  30312. <member name="F:NPOI.HSSF.Util.GUID._d1">
  30313. 4 bytes - little endian
  30314. </member>
  30315. <member name="F:NPOI.HSSF.Util.GUID._d2">
  30316. 2 bytes - little endian
  30317. </member>
  30318. <member name="F:NPOI.HSSF.Util.GUID._d3">
  30319. 2 bytes - little endian
  30320. </member>
  30321. <member name="F:NPOI.HSSF.Util.GUID._d4">
  30322. 8 bytes - serialized as big endian, stored with inverted endianness here
  30323. </member>
  30324. <member name="M:NPOI.HSSF.Util.GUID.Parse(System.String)">
  30325. Read a GUID in standard text form e.g.<br/>
  30326. 13579BDF-0246-8ACE-0123-456789ABCDEF
  30327. <br/> -&gt; <br/>
  30328. 0x13579BDF, 0x0246, 0x8ACE 0x0123456789ABCDEF
  30329. </member>
  30330. <member name="T:NPOI.HSSF.Util.HSSFCellRangeAddress">
  30331. <p>Title: HSSFCellRangeAddress</p>
  30332. <p>Description:
  30333. Implementation of the cell range Address lists,like Is described in
  30334. OpenOffice.org's Excel Documentation .
  30335. In BIFF8 there Is a common way to store absolute cell range Address
  30336. lists in several records (not formulas). A cell range Address list
  30337. consists of a field with the number of ranges and the list of the range
  30338. Addresses. Each cell range Address (called an AddR structure) Contains
  30339. 4 16-bit-values.</p>
  30340. <p>Copyright: Copyright (c) 2004</p>
  30341. <p>Company: </p>
  30342. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  30343. @version 2.0-pre
  30344. </member>
  30345. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_Addr_number">
  30346. Number of following AddR structures
  30347. </member>
  30348. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_regions_list">
  30349. List of AddR structures. Each structure represents a cell range
  30350. </member>
  30351. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  30352. Construct a new HSSFCellRangeAddress object and Sets its fields appropriately .
  30353. Even this Isn't an Excel record , I kept the same behavior for reading/writing
  30354. the object's data as for a regular record .
  30355. @param in the RecordInputstream to read the record from
  30356. </member>
  30357. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.AddAddRStructure(System.Int16,System.Int16,System.Int16,System.Int16)">
  30358. Add an AddR structure .
  30359. @param first_row - the upper left hand corner's row
  30360. @param first_col - the upper left hand corner's col
  30361. @param last_row - the lower right hand corner's row
  30362. @param last_col - the lower right hand corner's col
  30363. @return the index of this AddR structure
  30364. </member>
  30365. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.RemoveAddRStructureAt(System.Int32)">
  30366. Remove the AddR structure stored at the passed in index
  30367. @param index The AddR structure's index
  30368. </member>
  30369. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.GetAddRStructureAt(System.Int32)">
  30370. return the AddR structure at the given index.
  30371. @return AddrStructure representing
  30372. </member>
  30373. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddRStructureNumber">
  30374. Get the number of following AddR structures.
  30375. The number of this structures Is automatically Set when reading an Excel file
  30376. and/or increased when you manually Add a new AddR structure .
  30377. This Is the reason there Isn't a Set method for this field .
  30378. @return number of AddR structures
  30379. </member>
  30380. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstColumn">
  30381. Get the upper left hand corner column number
  30382. @return column number for the upper left hand corner
  30383. </member>
  30384. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstRow">
  30385. Get the upper left hand corner row number
  30386. @return row number for the upper left hand corner
  30387. </member>
  30388. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastColumn">
  30389. Get the lower right hand corner column number
  30390. @return column number for the lower right hand corner
  30391. </member>
  30392. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastRow">
  30393. Get the lower right hand corner row number
  30394. @return row number for the lower right hand corner
  30395. </member>
  30396. <member name="T:NPOI.HSSF.Util.RangeAddress">
  30397. * Title: Range Address
  30398. * Description: provides connectivity utilities for ranges
  30399. *
  30400. *
  30401. * REFERENCE:
  30402. * @author IgOr KaTz &amp; EuGeNe BuMaGiN (Tal Moshaiov) (VistaPortal LDT.)
  30403. @version 1.0
  30404. </member>
  30405. <member name="M:NPOI.HSSF.Util.RangeAddress.#ctor(System.String)">
  30406. Accepts an external reference from excel.
  30407. i.e. Sheet1!$A$4:$B$9
  30408. @param _url
  30409. </member>
  30410. <member name="P:NPOI.HSSF.Util.RangeAddress.Address">
  30411. @return String <b>note: </b> All absolute references are Removed
  30412. </member>
  30413. <member name="T:NPOI.HSSF.Util.RKUtil">
  30414. Utility class for helping convert RK numbers.
  30415. @author Andrew C. Oliver (acoliver at apache dot org)
  30416. @author Glen Stampoultzis (glens at apache.org)
  30417. @author Rolf-J黵gen Moll
  30418. @see org.apache.poi.hssf.record.MulRKRecord
  30419. @see org.apache.poi.hssf.record.RKRecord
  30420. </member>
  30421. <member name="M:NPOI.HSSF.Util.RKUtil.DecodeNumber(System.Int32)">
  30422. Do the dirty work of decoding; made a private static method to
  30423. facilitate testing the algorithm
  30424. </member>
  30425. <member name="T:NPOI.SS.Formula.Udf.UDFFinder">
  30426. Common interface for "Add-in" libraries and user defined function libraries.
  30427. @author PUdalau
  30428. </member>
  30429. <member name="M:NPOI.SS.Formula.Udf.UDFFinder.FindFunction(System.String)">
  30430. Returns executor by specified name. Returns <code>null</code> if the function name is unknown.
  30431. @param name Name of function.
  30432. @return Function executor.
  30433. </member>
  30434. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetSupportedFunctionNames">
  30435. Returns a collection of ATP function names implemented by POI.
  30436. @return an array of supported functions
  30437. @since 3.8 beta6
  30438. </member>
  30439. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetNotSupportedFunctionNames">
  30440. Returns a collection of ATP function names NOT implemented by POI.
  30441. @return an array of not supported functions
  30442. @since 3.8 beta6
  30443. </member>
  30444. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  30445. Register a ATP function in runtime.
  30446. @param name the function name
  30447. @param func the functoin to register
  30448. @throws ArgumentException if the function is unknown or already registered.
  30449. @since 3.8 beta6
  30450. </member>
  30451. <member name="T:NPOI.SS.Formula.Atp.MRound">
  30452. Implementation of Excel 'Analysis ToolPak' function MROUND()<br/>
  30453. Returns a number rounded to the desired multiple.<p/>
  30454. <b>Syntax</b><br/>
  30455. <b>MROUND</b>(<b>number</b>, <b>multiple</b>)
  30456. <p/>
  30457. @author Yegor Kozlov
  30458. </member>
  30459. <member name="T:NPOI.SS.Formula.Atp.ParityFunction">
  30460. Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()<br/>
  30461. @author Josh Micich
  30462. </member>
  30463. <member name="T:NPOI.SS.Formula.Atp.RandBetween">
  30464. * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()<br/>
  30465. *
  30466. * Returns a random integer number between the numbers you specify.<p/>
  30467. *
  30468. * <b>Syntax</b><br/>
  30469. * <b>RANDBETWEEN</b>(<b>bottom</b>, <b>top</b>)<p/>
  30470. *
  30471. * <b>bottom</b> is the smallest integer RANDBETWEEN will return.<br/>
  30472. * <b>top</b> is the largest integer RANDBETWEEN will return.<br/>
  30473. * @author Brendan Nolan
  30474. </member>
  30475. <member name="M:NPOI.SS.Formula.Atp.RandBetween.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  30476. Evaluate for RANDBETWEEN(). Must be given two arguments. Bottom must be greater than top.
  30477. Bottom is rounded up and top value is rounded down. After rounding top has to be set greater
  30478. than top.
  30479. @see org.apache.poi.ss.formula.functions.FreeRefFunction#evaluate(org.apache.poi.ss.formula.eval.ValueEval[], org.apache.poi.ss.formula.OperationEvaluationContext)
  30480. </member>
  30481. <member name="T:NPOI.SS.Formula.Atp.YearFrac">
  30482. Implementation of Excel 'Analysis ToolPak' function YEARFRAC()<br/>
  30483. Returns the fraction of the year spanned by two dates.<p/>
  30484. <b>Syntax</b><br/>
  30485. <b>YEARFRAC</b>(<b>startDate</b>, <b>endDate</b>, basis)<p/>
  30486. The <b>basis</b> optionally specifies the behaviour of YEARFRAC as follows:
  30487. <table border="0" cellpadding="1" cellspacing="0" summary="basis parameter description">
  30488. <tr><th>Value</th><th>Days per Month</th><th>Days per Year</th></tr>
  30489. <tr align='center'><td>0 (default)</td><td>30</td><td>360</td></tr>
  30490. <tr align='center'><td>1</td><td>actual</td><td>actual</td></tr>
  30491. <tr align='center'><td>2</td><td>actual</td><td>360</td></tr>
  30492. <tr align='center'><td>3</td><td>actual</td><td>365</td></tr>
  30493. <tr align='center'><td>4</td><td>30</td><td>360</td></tr>
  30494. </table>
  30495. </member>
  30496. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator">
  30497. <summary>
  30498. Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
  30499. Algorithm inspired by www.dwheeler.com/yearfrac
  30500. @author Josh Micich
  30501. </summary>
  30502. <remarks>
  30503. Date Count convention
  30504. http://en.wikipedia.org/wiki/Day_count_convention
  30505. </remarks>
  30506. <remarks>
  30507. Office Online Help on YEARFRAC
  30508. http://office.microsoft.com/en-us/excel/HP052093441033.aspx
  30509. </remarks>
  30510. </member>
  30511. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.MS_PER_HOUR">
  30512. use UTC time-zone to avoid daylight savings issues
  30513. </member>
  30514. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.LONG_MONTH_LEN">
  30515. the length of normal long months i.e. 31
  30516. </member>
  30517. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SHORT_MONTH_LEN">
  30518. the length of normal short months i.e. 30
  30519. </member>
  30520. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Calculate(System.Double,System.Double,System.Int32)">
  30521. <summary>
  30522. Calculates YEARFRAC()
  30523. </summary>
  30524. <param name="pStartDateVal">The start date.</param>
  30525. <param name="pEndDateVal">The end date.</param>
  30526. <param name="basis">The basis value.</param>
  30527. <returns></returns>
  30528. </member>
  30529. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis0(System.Int32,System.Int32)">
  30530. <summary>
  30531. Basis 0, 30/360 date convention
  30532. </summary>
  30533. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  30534. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  30535. <returns></returns>
  30536. </member>
  30537. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis1(System.Int32,System.Int32)">
  30538. <summary>
  30539. Basis 1, Actual/Actual date convention
  30540. </summary>
  30541. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  30542. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  30543. <returns></returns>
  30544. </member>
  30545. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis2(System.Int32,System.Int32)">
  30546. <summary>
  30547. Basis 2, Actual/360 date convention
  30548. </summary>
  30549. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  30550. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  30551. <returns></returns>
  30552. </member>
  30553. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis3(System.Double,System.Double)">
  30554. <summary>
  30555. Basis 3, Actual/365 date convention
  30556. </summary>
  30557. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  30558. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  30559. <returns></returns>
  30560. </member>
  30561. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis4(System.Int32,System.Int32)">
  30562. <summary>
  30563. Basis 4, European 30/360 date convention
  30564. </summary>
  30565. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  30566. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  30567. <returns></returns>
  30568. </member>
  30569. <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)">
  30570. <summary>
  30571. Calculates the adjusted.
  30572. </summary>
  30573. <param name="startDate">The start date.</param>
  30574. <param name="endDate">The end date.</param>
  30575. <param name="date1day">The date1day.</param>
  30576. <param name="date2day">The date2day.</param>
  30577. <returns></returns>
  30578. </member>
  30579. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  30580. <summary>
  30581. Determines whether [is last day of month] [the specified date].
  30582. </summary>
  30583. <param name="date">The date.</param>
  30584. <returns>
  30585. <c>true</c> if [is last day of month] [the specified date]; otherwise, <c>false</c>.
  30586. </returns>
  30587. </member>
  30588. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.GetLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  30589. <summary>
  30590. Gets the last day of month.
  30591. </summary>
  30592. <param name="date">The date.</param>
  30593. <returns></returns>
  30594. </member>
  30595. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.ShouldCountFeb29(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  30596. <summary>
  30597. Assumes dates are no more than 1 year apart.
  30598. </summary>
  30599. <param name="start">The start.</param>
  30600. <param name="end">The end.</param>
  30601. <returns><c>true</c>
  30602. if dates both within a leap year, or span a period including Feb 29</returns>
  30603. </member>
  30604. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.DateDiff(System.Int64,System.Int64)">
  30605. <summary>
  30606. return the whole number of days between the two time-stamps. Both time-stamps are
  30607. assumed to represent 12:00 midnight on the respective day.
  30608. </summary>
  30609. <param name="startDateTicks">The start date ticks.</param>
  30610. <param name="endDateTicks">The end date ticks.</param>
  30611. <returns></returns>
  30612. </member>
  30613. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.AverageYearLength(System.Int32,System.Int32)">
  30614. <summary>
  30615. Averages the length of the year.
  30616. </summary>
  30617. <param name="startYear">The start year.</param>
  30618. <param name="endYear">The end year.</param>
  30619. <returns></returns>
  30620. </member>
  30621. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLeapYear(System.Int32)">
  30622. <summary>
  30623. determine Leap Year
  30624. </summary>
  30625. <param name="i">the year</param>
  30626. <returns></returns>
  30627. </member>
  30628. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsGreaterThanOneYear(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  30629. <summary>
  30630. Determines whether [is greater than one year] [the specified start].
  30631. </summary>
  30632. <param name="start">The start date.</param>
  30633. <param name="end">The end date.</param>
  30634. <returns>
  30635. <c>true</c> if [is greater than one year] [the specified start]; otherwise, <c>false</c>.
  30636. </returns>
  30637. </member>
  30638. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CreateDate(System.Int32)">
  30639. <summary>
  30640. Creates the date.
  30641. </summary>
  30642. <param name="dayCount">The day count.</param>
  30643. <returns></returns>
  30644. </member>
  30645. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate">
  30646. <summary>
  30647. Simple Date Wrapper
  30648. </summary>
  30649. </member>
  30650. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.month">
  30651. 1-based month
  30652. </member>
  30653. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.day">
  30654. day of month
  30655. </member>
  30656. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.ticks">
  30657. milliseconds since 1970
  30658. </member>
  30659. <member name="T:NPOI.SS.Formula.CellCacheEntry">
  30660. Stores the parameters that identify the evaluation of one cell.<br/>
  30661. </member>
  30662. <member name="T:NPOI.SS.Formula.ICacheEntry">
  30663. A (mostly) opaque interface To allow test clients To trace cache values
  30664. Each spreadsheet cell Gets one unique cache entry instance. These objects
  30665. are safe To use as keys in {@link java.util.HashMap}s
  30666. </member>
  30667. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults">
  30668. Calls formulaCell.SetFormulaResult(null, null) recursively all the way up the tree of
  30669. dependencies. Calls usedCell.ClearConsumingCell(fc) for each child of a cell that Is
  30670. Cleared along the way.
  30671. @param formulaCells
  30672. </member>
  30673. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults(NPOI.SS.Formula.IEvaluationListener,System.Int32)">
  30674. Identical To {@link #RecurseClearCachedFormulaResults()} except for the listener call-backs
  30675. </member>
  30676. <member name="T:NPOI.SS.Formula.CellEvaluationFrame">
  30677. Stores details about the current evaluation of a cell.<br/>
  30678. </member>
  30679. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.AddSensitiveInputCell(NPOI.SS.Formula.CellCacheEntry)">
  30680. @param inputCell a cell directly used by the formula of this evaluation frame
  30681. </member>
  30682. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.GetSensitiveInputCells">
  30683. @return never <c>null</c>, (possibly empty) array of all cells directly used while
  30684. evaluating the formula of this frame.
  30685. </member>
  30686. <member name="T:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment">
  30687. Manages a collection of {@link WorkbookEvaluator}s, in order To support evaluation of formulas
  30688. across spreadsheets.<p/>
  30689. For POI internal use only
  30690. @author Josh Micich
  30691. </member>
  30692. <member name="M:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment.Unhook">
  30693. </member>
  30694. <member name="T:NPOI.SS.Formula.EvaluationCache">
  30695. Performance optimisation for {@link HSSFFormulaEvaluator}. This class stores previously
  30696. calculated values of already visited cells, To avoid unnecessary re-calculation when the
  30697. same cells are referenced multiple times
  30698. @author Josh Micich
  30699. </member>
  30700. <member name="F:NPOI.SS.Formula.EvaluationCache._evaluationListener">
  30701. only used for testing. <c>null</c> otherwise
  30702. </member>
  30703. <member name="M:NPOI.SS.Formula.EvaluationCache.Clear">
  30704. Should be called whenever there are Changes To input cells in the evaluated workbook.
  30705. </member>
  30706. <member name="T:NPOI.SS.Formula.EvaluationTracker">
  30707. <summary>
  30708. Instances of this class keep track of multiple dependent cell evaluations due
  30709. To recursive calls To <see cref="M:NPOI.SS.Formula.WorkbookEvaluator.Evaluate(NPOI.SS.Formula.IEvaluationCell)"/>
  30710. The main purpose of this class is To detect an attempt To evaluate a cell
  30711. that is already being evaluated. In other words, it detects circular
  30712. references in spreadsheet formulas.
  30713. </summary>
  30714. <remarks>
  30715. @author Josh Micich
  30716. </remarks>
  30717. </member>
  30718. <member name="M:NPOI.SS.Formula.EvaluationTracker.StartEvaluate(NPOI.SS.Formula.FormulaCellCacheEntry)">
  30719. Notifies this evaluation tracker that evaluation of the specified cell Is
  30720. about To start.<br/>
  30721. In the case of a <c>true</c> return code, the caller should
  30722. continue evaluation of the specified cell, and also be sure To call
  30723. <c>endEvaluate()</c> when complete.<br/>
  30724. In the case of a <c>null</c> return code, the caller should
  30725. return an evaluation result of
  30726. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  30727. <br/>
  30728. @return <c>false</c> if the specified cell is already being evaluated
  30729. </member>
  30730. <member name="M:NPOI.SS.Formula.EvaluationTracker.EndEvaluate(NPOI.SS.Formula.CellCacheEntry)">
  30731. Notifies this evaluation tracker that the evaluation of the specified cell is complete. <p/>
  30732. Every successful call To <c>startEvaluate</c> must be followed by a call To <c>endEvaluate</c> (recommended in a finally block) To enable
  30733. proper tracking of which cells are being evaluated at any point in time.<p/>
  30734. Assuming a well behaved client, parameters To this method would not be
  30735. required. However, they have been included To assert correct behaviour,
  30736. and form more meaningful error messages.
  30737. </member>
  30738. <member name="T:NPOI.SS.Formula.Eval.AreaEval">
  30739. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30740. </member>
  30741. <member name="T:NPOI.SS.Formula.TwoDEval">
  30742. Common interface of {@link AreaEval} and {@link NPOI.ss.formula.Eval.AreaEvalBase}
  30743. @author Josh Micich
  30744. </member>
  30745. <member name="T:NPOI.SS.Formula.Eval.ValueEval">
  30746. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30747. </member>
  30748. <member name="M:NPOI.SS.Formula.TwoDEval.GetValue(System.Int32,System.Int32)">
  30749. @param rowIndex relative row index (zero based)
  30750. @param columnIndex relative column index (zero based)
  30751. @return element at the specified row and column position
  30752. </member>
  30753. <member name="M:NPOI.SS.Formula.TwoDEval.GetRow(System.Int32)">
  30754. @param rowIndex relative row index (zero based)
  30755. @return a single row {@link TwoDEval}
  30756. </member>
  30757. <member name="M:NPOI.SS.Formula.TwoDEval.GetColumn(System.Int32)">
  30758. @param columnIndex relative column index (zero based)
  30759. @return a single column {@link TwoDEval}
  30760. </member>
  30761. <member name="M:NPOI.SS.Formula.TwoDEval.IsSubTotal(System.Int32,System.Int32)">
  30762. @return true if the cell at row and col is a subtotal
  30763. </member>
  30764. <member name="P:NPOI.SS.Formula.TwoDEval.IsRow">
  30765. @return <c>true</c> if the area has just a single row, this also includes
  30766. the trivial case when the area has just a single cell.
  30767. </member>
  30768. <member name="P:NPOI.SS.Formula.TwoDEval.IsColumn">
  30769. @return <c>true</c> if the area has just a single column, this also includes
  30770. the trivial case when the area has just a single cell.
  30771. </member>
  30772. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Contains(System.Int32,System.Int32)">
  30773. returns true if the cell at row and col specified
  30774. as absolute indexes in the sheet is contained in
  30775. this area.
  30776. @param row
  30777. @param col
  30778. </member>
  30779. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsColumn(System.Int32)">
  30780. returns true if the specified col is in range
  30781. @param col
  30782. </member>
  30783. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsRow(System.Int32)">
  30784. returns true if the specified row is in range
  30785. @param row
  30786. </member>
  30787. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetAbsoluteValue(System.Int32,System.Int32)">
  30788. @return the ValueEval from within this area at the specified row and col index. Never
  30789. <code>null</code> (possibly {@link BlankEval}). The specified indexes should be absolute
  30790. indexes in the sheet and not relative indexes within the area.
  30791. </member>
  30792. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetRelativeValue(System.Int32,System.Int32)">
  30793. @return the ValueEval from within this area at the specified relativeRowIndex and
  30794. relativeColumnIndex. Never <c>null</c> (possibly {@link BlankEval}). The
  30795. specified indexes should relative to the top left corner of this area.
  30796. </member>
  30797. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  30798. Creates an {@link AreaEval} offset by a relative amount from from the upper left cell
  30799. of this area
  30800. </member>
  30801. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstRow">
  30802. returns the 0-based index of the first row in
  30803. this area.
  30804. </member>
  30805. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastRow">
  30806. returns the 0-based index of the last row in
  30807. this area.
  30808. </member>
  30809. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstColumn">
  30810. returns the 0-based index of the first col in
  30811. this area.
  30812. </member>
  30813. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastColumn">
  30814. returns the 0-based index of the last col in
  30815. this area.
  30816. </member>
  30817. <member name="T:NPOI.SS.Formula.Eval.AreaEvalBase">
  30818. @author Josh Micich
  30819. </member>
  30820. <member name="M:NPOI.SS.Formula.Eval.AreaEvalBase.IsSubTotal(System.Int32,System.Int32)">
  30821. @return whether cell at rowIndex and columnIndex is a subtotal.
  30822. By default return false which means 'don't care about subtotals'
  30823. </member>
  30824. <member name="T:NPOI.SS.Formula.Eval.BlankEval">
  30825. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt; This class is a
  30826. marker class. It is a special value for empty cells.
  30827. </member>
  30828. <member name="T:NPOI.SS.Formula.Eval.BoolEval">
  30829. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30830. </member>
  30831. <member name="T:NPOI.SS.Formula.Eval.NumericValueEval">
  30832. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30833. </member>
  30834. <member name="T:NPOI.SS.Formula.Eval.StringValueEval">
  30835. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30836. </member>
  30837. <member name="P:NPOI.SS.Formula.Eval.StringValueEval.StringValue">
  30838. @return never <code>null</code>, possibly empty string.
  30839. </member>
  30840. <member name="M:NPOI.SS.Formula.Eval.BoolEval.ValueOf(System.Boolean)">
  30841. Convenience method for the following:<br/>
  30842. <c>(b ? BoolEval.TRUE : BoolEval.FALSE)</c>
  30843. @return a <c>BoolEval</c> instance representing <c>b</c>.
  30844. </member>
  30845. <member name="T:NPOI.SS.Formula.Eval.ConcatEval">
  30846. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30847. </member>
  30848. <member name="T:NPOI.SS.Formula.Functions.Fixed2ArgFunction">
  30849. Convenience base class for functions that must take exactly two arguments.
  30850. @author Josh Micich
  30851. </member>
  30852. <member name="T:NPOI.SS.Formula.Eval.ErrorEval">
  30853. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30854. </member>
  30855. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NULL_INTERSECTION">
  30856. <b>#NULL!</b> - Intersection of two cell ranges is empty
  30857. </member>
  30858. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.DIV_ZERO">
  30859. <b>#DIV/0!</b> - Division by zero
  30860. </member>
  30861. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.VALUE_INVALID">
  30862. <b>#VALUE!</b> - Wrong type of operand
  30863. </member>
  30864. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.REF_INVALID">
  30865. <b>#REF!</b> - Illegal or deleted cell reference
  30866. </member>
  30867. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NAME_INVALID">
  30868. <b>#NAME?</b> - Wrong function or range name
  30869. </member>
  30870. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NUM_ERROR">
  30871. <b>#NUM!</b> - Value range overflow
  30872. </member>
  30873. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NA">
  30874. <b>#N/A</b> - Argument or function not available
  30875. </member>
  30876. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.ValueOf(System.Int32)">
  30877. Translates an Excel internal error code into the corresponding POI ErrorEval instance
  30878. @param errorCode
  30879. </member>
  30880. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.GetText(System.Int32)">
  30881. Converts error codes to text. Handles non-standard error codes OK.
  30882. For debug/test purposes (and for formatting error messages).
  30883. @return the String representation of the specified Excel error code.
  30884. </member>
  30885. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.#ctor(System.Int32)">
  30886. @param errorCode an 8-bit value
  30887. </member>
  30888. <member name="T:NPOI.SS.Formula.Eval.Eval">
  30889. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30890. </member>
  30891. <member name="T:NPOI.SS.Formula.Eval.EvaluationException">
  30892. This class is used to simplify error handling logic <i>within</i> operator and function
  30893. implementations. Note - <c>OperationEval.Evaluate()</c> and <c>Function.Evaluate()</c>
  30894. method signatures do not throw this exception so it cannot propagate outside.<p/>
  30895. Here is an example coded without <c>EvaluationException</c>, to show how it can help:
  30896. <pre>
  30897. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  30898. // ...
  30899. Eval arg0 = args[0];
  30900. if(arg0 is ErrorEval) {
  30901. return arg0;
  30902. }
  30903. if(!(arg0 is AreaEval)) {
  30904. return ErrorEval.VALUE_INVALID;
  30905. }
  30906. double temp = 0;
  30907. AreaEval area = (AreaEval)arg0;
  30908. ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
  30909. for (int i = 0; i &lt; values.Length; i++) {
  30910. ValueEval ve = values[i];
  30911. if(ve is ErrorEval) {
  30912. return ve;
  30913. }
  30914. if(!(ve is NumericValueEval)) {
  30915. return ErrorEval.VALUE_INVALID;
  30916. }
  30917. temp += ((NumericValueEval)ve).NumberValue;
  30918. }
  30919. // ...
  30920. }
  30921. </pre>
  30922. In this example, if any error is encountered while Processing the arguments, an error is
  30923. returned immediately. This code is difficult to refactor due to all the points where errors
  30924. are returned.<br/>
  30925. Using <c>EvaluationException</c> allows the error returning code to be consolidated to one
  30926. place.<p/>
  30927. <pre>
  30928. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  30929. try {
  30930. // ...
  30931. AreaEval area = GetAreaArg(args[0]);
  30932. double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
  30933. // ...
  30934. } catch (EvaluationException e) {
  30935. return e.GetErrorEval();
  30936. }
  30937. }
  30938. private static AreaEval GetAreaArg(Eval arg0){
  30939. if (arg0 is ErrorEval) {
  30940. throw new EvaluationException((ErrorEval) arg0);
  30941. }
  30942. if (arg0 is AreaEval) {
  30943. return (AreaEval) arg0;
  30944. }
  30945. throw EvaluationException.InvalidValue();
  30946. }
  30947. private double sumValues(ValueEval[] values){
  30948. double temp = 0;
  30949. for (int i = 0; i &lt; values.Length; i++) {
  30950. ValueEval ve = values[i];
  30951. if (ve is ErrorEval) {
  30952. throw new EvaluationException((ErrorEval) ve);
  30953. }
  30954. if (!(ve is NumericValueEval)) {
  30955. throw EvaluationException.InvalidValue();
  30956. }
  30957. temp += ((NumericValueEval) ve).NumberValue;
  30958. }
  30959. return temp;
  30960. }
  30961. </pre>
  30962. It is not mandatory to use EvaluationException, doing so might give the following advantages:<br/>
  30963. - Methods can more easily be extracted, allowing for re-use.<br/>
  30964. - Type management (typecasting etc) is simpler because error conditions have been Separated from
  30965. intermediate calculation values.<br/>
  30966. - Fewer local variables are required. Local variables can have stronger types.<br/>
  30967. - It is easier to mimic common Excel error handling behaviour (exit upon encountering first
  30968. error), because exceptions conveniently propagate up the call stack regardless of execution
  30969. points or the number of levels of nested calls.<p/>
  30970. <b>Note</b> - Only standard evaluation errors are represented by <c>EvaluationException</c> (
  30971. i.e. conditions expected to be encountered when evaluating arbitrary Excel formulas). Conditions
  30972. that could never occur in an Excel spReadsheet should result in runtime exceptions. Care should
  30973. be taken to not translate any POI internal error into an Excel evaluation error code.
  30974. @author Josh Micich
  30975. </member>
  30976. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidValue">
  30977. <b>#VALUE!</b> - Wrong type of operand
  30978. </member>
  30979. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidRef">
  30980. <b>#REF!</b> - Illegal or deleted cell reference
  30981. </member>
  30982. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.NumberError">
  30983. <b>#NUM!</b> - Value range overflow
  30984. </member>
  30985. <member name="T:NPOI.SS.Formula.Eval.FunctionEval">
  30986. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  30987. </member>
  30988. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  30989. Register a new function in runtime.
  30990. @param name the function name
  30991. @param func the functoin to register
  30992. @throws ArgumentException if the function is unknown or already registered.
  30993. @since 3.8 beta6
  30994. </member>
  30995. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetSupportedFunctionNames">
  30996. Returns a collection of function names implemented by POI.
  30997. @return an array of supported functions
  30998. @since 3.8 beta6
  30999. </member>
  31000. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetNotSupportedFunctionNames">
  31001. Returns an array of function names NOT implemented by POI.
  31002. @return an array of not supported functions
  31003. @since 3.8 beta6
  31004. </member>
  31005. <member name="T:NPOI.SS.Formula.Eval.FunctionEval.FunctionID">
  31006. Some function IDs that require special treatment
  31007. </member>
  31008. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.IF">
  31009. 1
  31010. </member>
  31011. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.OFFSET">
  31012. 78
  31013. </member>
  31014. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.CHOOSE">
  31015. 100
  31016. </member>
  31017. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.INDIRECT">
  31018. 148
  31019. </member>
  31020. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.EXTERNAL_FUNC">
  31021. 255
  31022. </member>
  31023. <member name="T:NPOI.SS.Formula.Eval.IntersectionEval">
  31024. @author Josh Micich
  31025. </member>
  31026. <member name="M:NPOI.SS.Formula.Eval.IntersectionEval.ResolveRange(NPOI.SS.Formula.Eval.AreaEval,NPOI.SS.Formula.Eval.AreaEval)">
  31027. @return simple rectangular {@link AreaEval} which represents the intersection of areas
  31028. <c>aeA</c> and <c>aeB</c>. If the two areas do not intersect, the result is <code>null</code>.
  31029. </member>
  31030. <member name="T:NPOI.SS.Formula.Eval.NameEval">
  31031. @author Josh Micich
  31032. </member>
  31033. <member name="M:NPOI.SS.Formula.Eval.NameEval.#ctor(System.String)">
  31034. Creates a NameEval representing a function name
  31035. </member>
  31036. <member name="T:NPOI.SS.Formula.Eval.NameXEval">
  31037. @author Josh Micich
  31038. </member>
  31039. <member name="T:NPOI.SS.Formula.Eval.NumberEval">
  31040. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31041. </member>
  31042. <member name="T:NPOI.SS.Formula.Eval.NumericOperationEval">
  31043. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31044. </member>
  31045. <member name="T:NPOI.SS.Formula.Eval.OperationEval">
  31046. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31047. </member>
  31048. <member name="T:NPOI.SS.Formula.Eval.OperandResolver">
  31049. Provides functionality for evaluating arguments to functions and operators.
  31050. @author Josh Micich
  31051. </member>
  31052. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.GetSingleValue(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31053. Retrieves a single value from a variety of different argument types according to standard
  31054. Excel rules. Does not perform any type conversion.
  31055. @param arg the Evaluated argument as passed to the function or operator.
  31056. @param srcCellRow used when arg is a single column AreaRef
  31057. @param srcCellCol used when arg is a single row AreaRef
  31058. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c> or <c>BlankEval</c>.
  31059. Never <c>null</c> or <c>ErrorEval</c>.
  31060. @throws EvaluationException(#VALUE!) if srcCellRow or srcCellCol do not properly index into
  31061. an AreaEval. If the actual value retrieved is an ErrorEval, a corresponding
  31062. EvaluationException is thrown.
  31063. </member>
  31064. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  31065. Implements (some perhaps not well known) Excel functionality to select a single cell from an
  31066. area depending on the coordinates of the calling cell. Here is an example demonstrating
  31067. both selection from a single row area and a single column area in the same formula.
  31068. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  31069. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  31070. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  31071. <tr><th>2</th><td> </td><td> </td><td> </td><td>200</td></tr>
  31072. <tr><th>3</th><td> </td><td> </td><td> </td><td>300</td></tr>
  31073. <tr><th>3</th><td> </td><td> </td><td> </td><td>400</td></tr>
  31074. </table>
  31075. If the formula "=1000+A1:B1+D2:D3" is put into the 9 cells from A2 to C4, the spReadsheet
  31076. will look like this:
  31077. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  31078. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  31079. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  31080. <tr><th>2</th><td>1215</td><td>1220</td><td>#VALUE!</td><td>200</td></tr>
  31081. <tr><th>3</th><td>1315</td><td>1320</td><td>#VALUE!</td><td>300</td></tr>
  31082. <tr><th>4</th><td>#VALUE!</td><td>#VALUE!</td><td>#VALUE!</td><td>400</td></tr>
  31083. </table>
  31084. Note that the row area (A1:B1) does not include column C and the column area (D2:D3) does
  31085. not include row 4, so the values in C1(=25) and D4(=400) are not accessible to the formula
  31086. as written, but in the 4 cells A2:B3, the row and column selection works ok.<p/>
  31087. The same concept is extended to references across sheets, such that even multi-row,
  31088. multi-column areas can be useful.<p/>
  31089. Of course with carefully (or carelessly) chosen parameters, cyclic references can occur and
  31090. hence this method <b>can</b> throw a 'circular reference' EvaluationException. Note that
  31091. this method does not attempt to detect cycles. Every cell in the specified Area <c>ae</c>
  31092. has already been Evaluated prior to this method call. Any cell (or cell<b>s</b>) part of
  31093. <c>ae</c> that would incur a cyclic reference error if selected by this method, will
  31094. already have the value <c>ErrorEval.CIRCULAR_REF_ERROR</c> upon entry to this method. It
  31095. is assumed logic exists elsewhere to produce this behaviour.
  31096. @return whatever the selected cell's Evaluated value Is. Never <c>null</c>. Never
  31097. <c>ErrorEval</c>.
  31098. @if there is a problem with indexing into the area, or if the
  31099. Evaluated cell has an error.
  31100. </member>
  31101. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromAreaInternal(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  31102. @return possibly <c>ErrorEval</c>, and <c>null</c>
  31103. </member>
  31104. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToInt(NPOI.SS.Formula.Eval.ValueEval)">
  31105. Applies some conversion rules if the supplied value is not already an integer.<br/>
  31106. Value is first Coerced to a <c>double</c> ( See <c>CoerceValueTodouble()</c> ).<p/>
  31107. Excel typically Converts doubles to integers by truncating toward negative infinity.<br/>
  31108. The equivalent java code Is:<br/>
  31109. <c>return (int)Math.floor(d);</c><br/>
  31110. <b>not</b>:<br/>
  31111. <c>return (int)d; // wrong - rounds toward zero</c>
  31112. </member>
  31113. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToDouble(NPOI.SS.Formula.Eval.ValueEval)">
  31114. Applies some conversion rules if the supplied value is not already a number.
  31115. Note - <c>BlankEval</c> is not supported and must be handled by the caller.
  31116. @param ev must be a <c>NumberEval</c>, <c>StringEval</c> or <c>BoolEval</c>
  31117. @return actual, Parsed or interpreted double value (respectively).
  31118. @throws EvaluationException(#VALUE!) only if a StringEval is supplied and cannot be Parsed
  31119. as a double (See <c>Parsedouble()</c> for allowable formats).
  31120. @throws Exception if the supplied parameter is not <c>NumberEval</c>,
  31121. <c>StringEval</c> or <c>BoolEval</c>
  31122. </member>
  31123. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ParseDouble(System.String)">
  31124. Converts a string to a double using standard rules that Excel would use.<br/>
  31125. Tolerates currency prefixes, commas, leading and trailing spaces.<p/>
  31126. Some examples:<br/>
  31127. " 123 " -&gt; 123.0<br/>
  31128. ".123" -&gt; 0.123<br/>
  31129. These not supported yet:<br/>
  31130. " $ 1,000.00 " -&gt; 1000.0<br/>
  31131. "$1.25E4" -&gt; 12500.0<br/>
  31132. "5**2" -&gt; 500<br/>
  31133. "250%" -&gt; 2.5<br/>
  31134. @param text
  31135. @return <c>null</c> if the specified text cannot be Parsed as a number
  31136. </member>
  31137. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToString(NPOI.SS.Formula.Eval.ValueEval)">
  31138. @param ve must be a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>, or <c>BlankEval</c>
  31139. @return the Converted string value. never <c>null</c>
  31140. </member>
  31141. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToBoolean(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  31142. @return <c>null</c> to represent blank values
  31143. @throws EvaluationException if ve is an ErrorEval, or if a string value cannot be converted
  31144. </member>
  31145. <member name="T:NPOI.SS.Formula.Eval.PercentEval">
  31146. Implementation of Excel formula token '%'. <p/>
  31147. @author Josh Micich
  31148. </member>
  31149. <member name="T:NPOI.SS.Formula.Eval.RangeEval">
  31150. @author Josh Micich
  31151. </member>
  31152. <member name="T:NPOI.SS.Formula.Eval.RefEval">
  31153. @author Amol S Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31154. RefEval is the base interface for Ref2D and Ref3DEval. Basically a RefEval
  31155. impl should contain reference to the original ReferencePtg or Ref3DPtg as
  31156. well as the "value" resulting from the evaluation of the cell
  31157. reference. Thus if the HSSFCell has type CELL_TYPE_NUMERIC, the contained
  31158. value object should be of type NumberEval; if cell type is CELL_TYPE_STRING,
  31159. contained value object should be of type StringEval
  31160. </member>
  31161. <member name="M:NPOI.SS.Formula.Eval.RefEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  31162. Creates an {@link AreaEval} offset by a relative amount from this RefEval
  31163. </member>
  31164. <member name="P:NPOI.SS.Formula.Eval.RefEval.InnerValueEval">
  31165. The (possibly Evaluated) ValueEval contained
  31166. in this RefEval. eg. if cell A1 Contains "test"
  31167. then in a formula referring to cell A1
  31168. the RefEval representing
  31169. A1 will return as the InnerValueEval the
  31170. object of concrete type StringEval
  31171. </member>
  31172. <member name="P:NPOI.SS.Formula.Eval.RefEval.Column">
  31173. returns the zero based column index.
  31174. </member>
  31175. <member name="P:NPOI.SS.Formula.Eval.RefEval.Row">
  31176. returns the zero based row index.
  31177. </member>
  31178. <member name="T:NPOI.SS.Formula.Eval.EqualEval">
  31179. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31180. </member>
  31181. <member name="T:NPOI.SS.Formula.Eval.RelationalOperationEval">
  31182. @author Amol S. Deshmukh &lt; amolweb at ya hoo Dot com &gt;
  31183. </member>
  31184. <member name="T:NPOI.SS.Formula.Eval.GreaterEqualEval">
  31185. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31186. </member>
  31187. <member name="T:NPOI.SS.Formula.Eval.GreaterThanEval">
  31188. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31189. </member>
  31190. <member name="T:NPOI.SS.Formula.Eval.LessEqualEval">
  31191. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31192. </member>
  31193. <member name="T:NPOI.SS.Formula.Eval.LessThanEval">
  31194. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31195. </member>
  31196. <member name="T:NPOI.SS.Formula.Eval.NotEqualEval">
  31197. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31198. </member>
  31199. <member name="T:NPOI.SS.Formula.Eval.StringEval">
  31200. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31201. </member>
  31202. <member name="T:NPOI.SS.Formula.Eval.StringOperationEval">
  31203. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31204. </member>
  31205. <member name="M:NPOI.SS.Formula.Eval.StringOperationEval.SingleOperandEvaluate(NPOI.SS.Formula.Eval.Eval,System.Int32,System.Int16)">
  31206. Returns an is StringValueEval or ErrorEval or BlankEval
  31207. @param eval
  31208. @param srcRow
  31209. @param srcCol
  31210. </member>
  31211. <member name="T:NPOI.SS.Formula.Eval.AddEval">
  31212. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31213. This is a documentation of the observed behaviour of
  31214. the '+' operator in Excel:
  31215. - 1+TRUE = 2
  31216. - 1+FALSE = 1
  31217. - 1+"true" = #VALUE!
  31218. - 1+"1" = 2
  31219. - 1+A1 = #VALUE if A1 Contains "1"
  31220. - 1+A1 = 2 if A1 Contains ="1"
  31221. - 1+A1 = 2 if A1 Contains TRUE or =TRUE
  31222. - 1+A1 = #VALUE! if A1 Contains "TRUE" or ="TRUE"
  31223. </member>
  31224. <member name="T:NPOI.SS.Formula.Eval.DivideEval">
  31225. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31226. </member>
  31227. <member name="T:NPOI.SS.Formula.Eval.MultiplyEval">
  31228. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31229. </member>
  31230. <member name="T:NPOI.SS.Formula.Eval.PowerEval">
  31231. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31232. </member>
  31233. <member name="T:NPOI.SS.Formula.Eval.SubtractEval">
  31234. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31235. </member>
  31236. <member name="T:NPOI.SS.Formula.Eval.UnaryMinusEval">
  31237. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31238. </member>
  31239. <member name="T:NPOI.SS.Formula.Eval.UnaryPlusEval">
  31240. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31241. </member>
  31242. <member name="T:NPOI.SS.Formula.Eval.ValueEvalToNumericXlator">
  31243. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31244. </member>
  31245. <member name="M:NPOI.SS.Formula.Eval.ValueEvalToNumericXlator.AttemptXlateToNumeric(NPOI.SS.Formula.Eval.ValueEval)">
  31246. returned value can be either A NumericValueEval, BlankEval or ErrorEval.
  31247. The params can be either NumberEval, BoolEval, StringEval, or
  31248. RefEval
  31249. @param eval
  31250. </member>
  31251. <member name="M:NPOI.SS.Formula.Eval.ValueEvalToNumericXlator.XlateBlankEval(System.Int32)">
  31252. no args are required since BlankEval has only one
  31253. instance. If flag is Set, a zero
  31254. valued numbereval is returned, else BlankEval.INSTANCE
  31255. is returned.
  31256. </member>
  31257. <member name="M:NPOI.SS.Formula.Eval.ValueEvalToNumericXlator.XlateRefEval(NPOI.SS.Formula.Eval.RefEval)">
  31258. uses the relevant flags to decode the supplied RefVal
  31259. @param eval
  31260. </member>
  31261. <member name="M:NPOI.SS.Formula.Eval.ValueEvalToNumericXlator.XlateStringEval(NPOI.SS.Formula.Eval.StringEval)">
  31262. uses the relevant flags to decode the StringEval
  31263. @param eval
  31264. </member>
  31265. <member name="M:NPOI.SS.Formula.Eval.ValueEvalToNumericXlator.XlateRefStringEval(NPOI.SS.Formula.Eval.StringEval)">
  31266. uses the relevant flags to decode the StringEval
  31267. @param eval
  31268. </member>
  31269. <member name="T:NPOI.SS.Formula.IExternSheetReferenceToken">
  31270. Should be implemented by any {@link Ptg} subclass that needs Has an extern sheet index <br/>
  31271. For POI internal use only
  31272. @author Josh Micich
  31273. </member>
  31274. <member name="T:NPOI.SS.Formula.Formula">
  31275. Encapsulates an encoded formula token array.
  31276. @author Josh Micich
  31277. </member>
  31278. <member name="F:NPOI.SS.Formula.Formula._byteEncoding">
  31279. immutable
  31280. </member>
  31281. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput)">
  31282. Convenience method for {@link #read(int, LittleEndianInput, int)}
  31283. </member>
  31284. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput,System.Int32)">
  31285. When there are no array constants present, <c>encodedTokenLen</c>==<c>totalEncodedLen</c>
  31286. @param encodedTokenLen number of bytes in the stream taken by the plain formula tokens
  31287. @param totalEncodedLen the total number of bytes in the formula (includes trailing encoding
  31288. for array constants, but does not include 2 bytes for initial <c>ushort encodedTokenLen</c> field.
  31289. @return A new formula object as read from the stream. Possibly empty, never <code>null</code>.
  31290. </member>
  31291. <member name="M:NPOI.SS.Formula.Formula.Serialize(NPOI.Util.ILittleEndianOutput)">
  31292. Writes The formula encoding is includes:
  31293. <ul>
  31294. <li>ushort tokenDataLen</li>
  31295. <li>tokenData</li>
  31296. <li>arrayConstantData (if present)</li>
  31297. </ul>
  31298. </member>
  31299. <member name="M:NPOI.SS.Formula.Formula.Create(NPOI.SS.Formula.PTG.Ptg[])">
  31300. Creates a {@link Formula} object from a supplied {@link Ptg} array.
  31301. Handles <code>null</code>s OK.
  31302. @param ptgs may be <code>null</code>
  31303. @return Never <code>null</code> (Possibly empty if the supplied <c>ptgs</c> is <code>null</code>)
  31304. </member>
  31305. <member name="M:NPOI.SS.Formula.Formula.GetTokens(NPOI.SS.Formula.Formula)">
  31306. Gets the {@link Ptg} array from the supplied {@link Formula}.
  31307. Handles <code>null</code>s OK.
  31308. @param formula may be <code>null</code>
  31309. @return possibly <code>null</code> (if the supplied <c>formula</c> is <code>null</code>)
  31310. </member>
  31311. <member name="P:NPOI.SS.Formula.Formula.EncodedSize">
  31312. @return total formula encoding length. The formula encoding includes:
  31313. <ul>
  31314. <li>ushort tokenDataLen</li>
  31315. <li>tokenData</li>
  31316. <li>arrayConstantData (optional)</li>
  31317. </ul>
  31318. Note - this value is different to <c>tokenDataLength</c>
  31319. </member>
  31320. <member name="P:NPOI.SS.Formula.Formula.EncodedTokenSize">
  31321. This method is often used when the formula length does not appear immediately before
  31322. the encoded token data.
  31323. @return the encoded length of the plain formula tokens. This does <em>not</em> include
  31324. the leading ushort field, nor any trailing array constant data.
  31325. </member>
  31326. <member name="P:NPOI.SS.Formula.Formula.ExpReference">
  31327. Gets the locator for the corresponding {@link SharedFormulaRecord}, {@link ArrayRecord} or
  31328. {@link TableRecord} if this formula belongs to such a grouping. The {@link CellReference}
  31329. returned by this method will match the top left corner of the range of that grouping.
  31330. The return value is usually not the same as the location of the cell containing this formula.
  31331. @return the firstRow &amp; firstColumn of an array formula or shared formula that this formula
  31332. belongs to. <code>null</code> if this formula is not part of an array or shared formula.
  31333. </member>
  31334. <member name="T:NPOI.SS.Formula.FormulaCellCache">
  31335. @author Josh Micich
  31336. </member>
  31337. <member name="M:NPOI.SS.Formula.FormulaCellCache.Get(NPOI.SS.Formula.IEvaluationCell)">
  31338. @return <c>null</c> if not found
  31339. </member>
  31340. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntry">
  31341. Stores the cached result of a formula evaluation, along with the Set of sensititive input cells
  31342. @author Josh Micich
  31343. </member>
  31344. <member name="F:NPOI.SS.Formula.FormulaCellCacheEntry._sensitiveInputCells">
  31345. Cells 'used' in the current evaluation of the formula corresponding To this cache entry
  31346. If any of the following cells Change, this cache entry needs To be Cleared
  31347. </member>
  31348. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntrySet">
  31349. A custom implementation of {@link java.util.HashSet} in order To reduce memory consumption.
  31350. Profiling tests (Oct 2008) have shown that each element {@link FormulaCellCacheEntry} takes
  31351. around 32 bytes To store in a HashSet, but around 6 bytes To store here. For Spreadsheets with
  31352. thousands of formula cells with multiple interdependencies, the savings can be very significant.
  31353. @author Josh Micich
  31354. </member>
  31355. <member name="T:NPOI.SS.Formula.FormulaParseException">
  31356. <summary>
  31357. Specific exception thrown when a supplied formula does not Parse properly.
  31358. Primarily used by test cases when testing for specific parsing exceptions.
  31359. </summary>
  31360. </member>
  31361. <member name="M:NPOI.SS.Formula.FormulaParseException.#ctor(System.String)">
  31362. <summary>
  31363. This class was given package scope until it would become Clear that it is useful to general client code.
  31364. </summary>
  31365. <param name="msg"></param>
  31366. </member>
  31367. <member name="F:NPOI.SS.Formula.FormulaParser.look">
  31368. Lookahead Character.
  31369. Gets value '\0' when the input string is exhausted
  31370. </member>
  31371. <member name="M:NPOI.SS.Formula.FormulaParser.#ctor(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32)">
  31372. Create the formula Parser, with the string that is To be
  31373. Parsed against the supplied workbook.
  31374. A later call the Parse() method To return ptg list in
  31375. rpn order, then call the GetRPNPtg() To retrive the
  31376. Parse results.
  31377. This class is recommended only for single threaded use.
  31378. If you only have a usermodel.HSSFWorkbook, and not a
  31379. model.Workbook, then use the convenience method on
  31380. usermodel.HSSFFormulaEvaluator
  31381. </member>
  31382. <member name="M:NPOI.SS.Formula.FormulaParser.Parse(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  31383. Parse a formula into a array of tokens
  31384. @param formula the formula to parse
  31385. @param workbook the parent workbook
  31386. @param formulaType the type of the formula, see {@link FormulaType}
  31387. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  31388. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  31389. the scope of the name will be ignored and the parser will match names only by name
  31390. @return array of parsed tokens
  31391. @throws FormulaParseException if the formula is unparsable
  31392. </member>
  31393. <member name="M:NPOI.SS.Formula.FormulaParser.GetChar">
  31394. Read New Character From Input Stream
  31395. </member>
  31396. <member name="M:NPOI.SS.Formula.FormulaParser.expected(System.String)">
  31397. Report What Was Expected
  31398. </member>
  31399. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlpha(System.Char)">
  31400. Recognize an Alpha Character
  31401. </member>
  31402. <member name="M:NPOI.SS.Formula.FormulaParser.IsDigit(System.Char)">
  31403. Recognize a Decimal Digit
  31404. </member>
  31405. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlNum(System.Char)">
  31406. Recognize an Alphanumeric
  31407. </member>
  31408. <member name="M:NPOI.SS.Formula.FormulaParser.IsWhite(System.Char)">
  31409. Recognize White Space
  31410. </member>
  31411. <member name="M:NPOI.SS.Formula.FormulaParser.SkipWhite">
  31412. Skip Over Leading White Space
  31413. </member>
  31414. <member name="M:NPOI.SS.Formula.FormulaParser.Match(System.Char)">
  31415. Consumes the next input character if it is equal To the one specified otherwise throws an
  31416. unchecked exception. This method does <b>not</b> consume whitespace (before or after the
  31417. matched character).
  31418. </member>
  31419. <member name="M:NPOI.SS.Formula.FormulaParser.GetNum">
  31420. Get a Number
  31421. </member>
  31422. <member name="M:NPOI.SS.Formula.FormulaParser.NeedsMemFunc(NPOI.SS.Formula.ParseNode)">
  31423. From OOO doc: "Whenever one operand of the reference subexpression is a function,
  31424. a defined name, a 3D reference, or an external reference (and no error occurs),
  31425. a tMemFunc token is used"
  31426. </member>
  31427. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidDefinedNameChar(System.Char)">
  31428. @return <c>true</c> if the specified character may be used in a defined name
  31429. </member>
  31430. <member name="M:NPOI.SS.Formula.FormulaParser.CheckValidRangeOperand(System.String,System.Int32,NPOI.SS.Formula.ParseNode)">
  31431. @param currentParsePosition used to format a potential error message
  31432. </member>
  31433. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidRangeOperand(NPOI.SS.Formula.ParseNode)">
  31434. @return false if sub-expression represented the specified ParseNode definitely
  31435. cannot appear on either side of the range (':') operator
  31436. </member>
  31437. <member name="M:NPOI.SS.Formula.FormulaParser.ParseRangeable">
  31438. Parses area refs (things which could be the operand of ':') and simple factors
  31439. Examples
  31440. <pre>
  31441. A$1
  31442. $A$1 : $B1
  31443. A1 ....... C2
  31444. Sheet1 !$A1
  31445. a..b!A1
  31446. 'my sheet'!A1
  31447. .my.sheet!A1
  31448. my.named..range.
  31449. foo.bar(123.456, "abc")
  31450. 123.456
  31451. "abc"
  31452. true
  31453. </pre>
  31454. </member>
  31455. <member name="M:NPOI.SS.Formula.FormulaParser.ParseNonRange(System.Int32)">
  31456. Parses simple factors that are not primitive ranges or range components
  31457. i.e. '!', ':'(and equiv '...') do not appear
  31458. Examples
  31459. <pre>
  31460. my.named...range.
  31461. foo.bar(123.456, "abc")
  31462. 123.456
  31463. "abc"
  31464. true
  31465. </pre>
  31466. </member>
  31467. <member name="M:NPOI.SS.Formula.FormulaParser.CreateAreaRefParseNode(NPOI.SS.Formula.FormulaParser.SheetIdentifier,NPOI.SS.Formula.FormulaParser.SimpleRangePart,NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  31468. @param sheetIden may be <code>null</code>
  31469. @param part1
  31470. @param part2 may be <code>null</code>
  31471. </member>
  31472. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleRangePart">
  31473. Parses out a potential LHS or RHS of a ':' intended to produce a plain AreaRef. Normally these are
  31474. proper cell references but they could also be row or column refs like "$AC" or "10"
  31475. @return <code>null</code> (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
  31476. </member>
  31477. <member name="M:NPOI.SS.Formula.FormulaParser.ReduceRangeExpression(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.PTG.Ptg)">
  31478. "A1", "B3" -> "A1:B3"
  31479. "sheet1!A1", "B3" -> "sheet1!A1:B3"
  31480. @return <c>null</c> if the range expression cannot / shouldn't be reduced.
  31481. </member>
  31482. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetName">
  31483. Note - caller should reset {@link #_pointer} upon <code>null</code> result
  31484. @return The sheet name as an identifier <code>null</code> if '!' is not found in the right place
  31485. </member>
  31486. <member name="M:NPOI.SS.Formula.FormulaParser.IsUnquotedSheetNameChar(System.Char)">
  31487. very similar to {@link SheetNameFormatter#isSpecialChar(char)}
  31488. </member>
  31489. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidCellReference(System.String)">
  31490. @return <c>true</c> if the specified name is a valid cell reference
  31491. </member>
  31492. <member name="M:NPOI.SS.Formula.FormulaParser.Function(System.String)">
  31493. Note - Excel Function names are 'case aware but not case sensitive'. This method may end
  31494. up creating a defined name record in the workbook if the specified name is not an internal
  31495. Excel Function, and Has not been encountered before.
  31496. @param name case preserved Function name (as it was entered/appeared in the formula).
  31497. </member>
  31498. <member name="M:NPOI.SS.Formula.FormulaParser.GetFunction(System.String,NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.ParseNode[])">
  31499. * Generates the variable Function ptg for the formula.
  31500. *
  31501. * For IF Formulas, Additional PTGs are Added To the Tokens
  31502. * @param name a {@link NamePtg} or {@link NameXPtg} or <code>null</code>
  31503. * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
  31504. </member>
  31505. <member name="M:NPOI.SS.Formula.FormulaParser.Arguments">
  31506. Get arguments To a Function
  31507. </member>
  31508. <member name="M:NPOI.SS.Formula.FormulaParser.PowerFactor">
  31509. Parse and Translate a Math Factor
  31510. </member>
  31511. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleFactor">
  31512. factors (without ^ or % )
  31513. </member>
  31514. <member name="M:NPOI.SS.Formula.FormulaParser.GetNumberPtgFromString(System.String,System.String,System.String)">
  31515. Get a PTG for an integer from its string representation.
  31516. return Int or Number Ptg based on size of input
  31517. </member>
  31518. <member name="M:NPOI.SS.Formula.FormulaParser.Term">
  31519. Parse and Translate a Math Term
  31520. </member>
  31521. <member name="M:NPOI.SS.Formula.FormulaParser.AdditiveExpression">
  31522. Parse and Translate an Expression
  31523. </member>
  31524. <member name="M:NPOI.SS.Formula.FormulaParser.Parse">
  31525. API call To execute the parsing of the formula
  31526. </member>
  31527. <member name="T:NPOI.SS.Formula.FormulaParser.SimpleRangePart">
  31528. A1, $A1, A$1, $A$1, A, 1
  31529. </member>
  31530. <member name="M:NPOI.SS.Formula.FormulaParser.SimpleRangePart.IsCompatibleForArea(NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  31531. @return <c>true</c> if the two range parts can be combined in an
  31532. {@link AreaPtg} ( Note - the explicit range operator (:) may still be valid
  31533. when this method returns <c>false</c> )
  31534. </member>
  31535. <member name="T:NPOI.SS.Formula.FormulaRenderer">
  31536. Common logic for rendering formulas.<br/>
  31537. For POI internal use only
  31538. @author Josh Micich
  31539. </member>
  31540. <member name="M:NPOI.SS.Formula.FormulaRenderer.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  31541. Static method To convert an array of {@link Ptg}s in RPN order
  31542. To a human readable string format in infix mode.
  31543. @param book used for defined names and 3D references
  31544. @param ptgs must not be <c>null</c>
  31545. @return a human readable String
  31546. </member>
  31547. <member name="T:NPOI.SS.Formula.FormulaType">
  31548. Enumeration of various formula types.<br/>
  31549. For POI internal use only
  31550. @author Josh Micich
  31551. </member>
  31552. <member name="T:NPOI.SS.Formula.FormulaUsedBlankCellSet">
  31553. Optimisation - compacts many blank cell references used by a single formula.
  31554. @author Josh Micich
  31555. </member>
  31556. <member name="T:NPOI.SS.Formula.Functions.Address">
  31557. Creates a text reference as text, given specified row and column numbers.
  31558. @author Aniket Banerjee (banerjee@google.com)
  31559. </member>
  31560. <member name="T:NPOI.SS.Formula.Functions.AggregateFunction">
  31561. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31562. </member>
  31563. <member name="T:NPOI.SS.Formula.Functions.MultiOperandNumericFunction">
  31564. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31565. This Is the base class for all excel function evaluator
  31566. classes that take variable number of operands, and
  31567. where the order of operands does not matter
  31568. </member>
  31569. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.CollectValues(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.MultiOperandNumericFunction.DoubleList)">
  31570. Collects values from a single argument
  31571. </member>
  31572. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.GetNumberArray(NPOI.SS.Formula.Eval.ValueEval[])">
  31573. Returns a double array that contains values for the numeric cells
  31574. from among the list of operands. Blanks and Blank equivalent cells
  31575. are ignored. Error operands or cells containing operands of type
  31576. that are considered invalid and would result in #VALUE! error in
  31577. excel cause this function to return <c>null</c>.
  31578. @return never <c>null</c>
  31579. </member>
  31580. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.AreSubArraysConsistent(System.Double[][])">
  31581. Ensures that a two dimensional array has all sub-arrays present and the same Length
  31582. @return <c>false</c> if any sub-array Is missing, or Is of different Length
  31583. </member>
  31584. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.MaxNumOperands">
  31585. Maximum number of operands accepted by this function.
  31586. Subclasses may override to Change default value.
  31587. </member>
  31588. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.IsSubtotalCounted">
  31589. Whether to count nested subtotals.
  31590. </member>
  31591. <member name="P:NPOI.SS.Formula.Functions.SubtotalInstance.IsSubtotalCounted">
  31592. ignore nested subtotals.
  31593. </member>
  31594. <member name="T:NPOI.SS.Formula.Functions.BooleanFunction">
  31595. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31596. Here are the general rules concerning bool functions:
  31597. - Blanks are not either true or false
  31598. - Strings are not either true or false (even strings "true" or "TRUE" or "0" etc.)
  31599. - Numbers: 0 Is false. Any other number Is TRUE.
  31600. - References are Evaluated and above rules apply.
  31601. - Areas: Individual cells in area are Evaluated and Checked to
  31602. see if they are blanks, strings etc.
  31603. </member>
  31604. <member name="T:NPOI.SS.Formula.Functions.False">
  31605. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31606. </member>
  31607. <member name="T:NPOI.SS.Formula.Functions.Fixed0ArgFunction">
  31608. Convenience base class for functions that only take zero arguments.
  31609. @author Josh Micich
  31610. </member>
  31611. <member name="T:NPOI.SS.Formula.Functions.Function0Arg">
  31612. Implemented by all functions that can be called with zero arguments
  31613. @author Josh Micich
  31614. </member>
  31615. <member name="M:NPOI.SS.Formula.Functions.Function0Arg.Evaluate(System.Int32,System.Int32)">
  31616. see {@link Function#Evaluate(ValueEval[], int, int)}
  31617. </member>
  31618. <member name="T:NPOI.SS.Formula.Functions.True">
  31619. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31620. </member>
  31621. <member name="T:NPOI.SS.Formula.Functions.CalendarFieldFunction">
  31622. Implementation of Excel functions Date parsing functions:
  31623. Date - DAY, MONTH and YEAR
  31624. Time - HOUR, MINUTE and SECOND
  31625. @author Others (not mentioned in code)
  31626. @author Thies Wellpott
  31627. </member>
  31628. <member name="T:NPOI.SS.Formula.Functions.Ceiling">
  31629. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31630. </member>
  31631. <member name="T:NPOI.SS.Formula.Functions.Choose">
  31632. @author Josh Micich
  31633. </member>
  31634. <member name="T:NPOI.SS.Formula.Functions.Columns">
  31635. Implementation for Excel COLUMNS function.
  31636. @author Josh Micich
  31637. </member>
  31638. <member name="T:NPOI.SS.Formula.Functions.Combin">
  31639. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31640. </member>
  31641. <member name="T:NPOI.SS.Formula.Functions.Count">
  31642. Counts the number of cells that contain numeric data within
  31643. the list of arguments.
  31644. Excel Syntax
  31645. COUNT(value1,value2,...)
  31646. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  31647. TODO: Check this properly Matches excel on edge cases
  31648. like formula cells, error cells etc
  31649. </member>
  31650. <member name="M:NPOI.SS.Formula.Functions.Count.SubtotalInstance">
  31651. Create an instance of Count to use in {@link Subtotal}
  31652. <p>
  31653. If there are other subtotals within argument refs (or nested subtotals),
  31654. these nested subtotals are ignored to avoid double counting.
  31655. </p>
  31656. @see Subtotal
  31657. </member>
  31658. <member name="T:NPOI.SS.Formula.Functions.I_MatchPredicate">
  31659. Common interface for the matching criteria.
  31660. </member>
  31661. <member name="T:NPOI.SS.Formula.Functions.Counta">
  31662. Counts the number of cells that contain data within the list of arguments.
  31663. Excel Syntax
  31664. COUNTA(value1,value2,...)
  31665. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  31666. @author Josh Micich
  31667. </member>
  31668. <member name="M:NPOI.SS.Formula.Functions.Counta.SubtotalPredicate.Matches(NPOI.SS.Formula.TwoDEval,System.Int32,System.Int32)">
  31669. don't count cells that are subtotals
  31670. </member>
  31671. <member name="T:NPOI.SS.Formula.Functions.Countblank">
  31672. Implementation for the function COUNTBLANK
  31673. <p>
  31674. Syntax: COUNTBLANK ( range )
  31675. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  31676. <tr><th>range </th><td>is the range of cells to count blanks</td></tr>
  31677. </table>
  31678. </p>
  31679. @author Mads Mohr Christensen
  31680. </member>
  31681. <member name="T:NPOI.SS.Formula.Functions.Countif">
  31682. Implementation for the function COUNTIF<p/>
  31683. Syntax: COUNTIF ( range, criteria )
  31684. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  31685. <tr><th>range </th><td>is the range of cells to be Counted based on the criteria</td></tr>
  31686. <tr><th>criteria</th><td>is used to determine which cells to Count</td></tr>
  31687. </table>
  31688. <p/>
  31689. @author Josh Micich
  31690. </member>
  31691. <member name="M:NPOI.SS.Formula.Functions.Countif.CountMatchingCellsInArea(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.I_MatchPredicate)">
  31692. @return the number of evaluated cells in the range that match the specified criteria
  31693. </member>
  31694. <member name="M:NPOI.SS.Formula.Functions.Countif.EvaluateCriteriaArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31695. @return the de-referenced criteria arg (possibly {@link ErrorEval})
  31696. </member>
  31697. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateGeneralMatchPredicate(NPOI.SS.Formula.Eval.StringEval)">
  31698. When the second argument is a string, many things are possible
  31699. </member>
  31700. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateCriteriaPredicate(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31701. Creates a criteria predicate object for the supplied criteria arg
  31702. @return <code>null</code> if the arg evaluates to blank.
  31703. </member>
  31704. <member name="M:NPOI.SS.Formula.Functions.Countif.ParseBoolean(System.String)">
  31705. bool literals ('TRUE', 'FALSE') treated similarly but NOT same as numbers.
  31706. </member>
  31707. <member name="P:NPOI.SS.Formula.Functions.Countif.CmpOp.Length">
  31708. @return number of characters used to represent this operator
  31709. </member>
  31710. <member name="M:NPOI.SS.Formula.Functions.Countif.StringMatcher.GetWildCardPattern(System.String)">
  31711. <summary>
  31712. Translates Excel countif wildcard strings into .NET regex strings
  31713. </summary>
  31714. <param name="value">Excel wildcard expression</param>
  31715. <returns>return null if the specified value contains no special wildcard characters.</returns>
  31716. </member>
  31717. <member name="T:NPOI.SS.Formula.Functions.CountUtils">
  31718. Common logic for COUNT, COUNTA and COUNTIF
  31719. @author Josh Micich
  31720. </member>
  31721. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCell(NPOI.SS.Formula.Eval.RefEval,NPOI.SS.Formula.Functions.I_MatchPredicate)">
  31722. @return 1 if the evaluated cell matches the specified criteria
  31723. </member>
  31724. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInArea(NPOI.SS.Formula.TwoDEval,NPOI.SS.Formula.Functions.I_MatchPredicate)">
  31725. @return the number of evaluated cells in the range that match the specified criteria
  31726. </member>
  31727. <member name="T:NPOI.SS.Formula.Functions.DateFunc">
  31728. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  31729. </member>
  31730. <member name="T:NPOI.SS.Formula.Functions.Fixed3ArgFunction">
  31731. Convenience base class for functions that must take exactly three arguments.
  31732. @author Josh Micich
  31733. </member>
  31734. <member name="M:NPOI.SS.Formula.Functions.DateFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  31735. * Note - works with Java Calendar months, not Excel months
  31736. * Java Calendar month = Excel month + 1
  31737. </member>
  31738. <member name="T:NPOI.SS.Formula.Functions.Degrees">
  31739. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31740. </member>
  31741. <member name="T:NPOI.SS.Formula.Functions.Dollar">
  31742. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31743. </member>
  31744. <member name="T:NPOI.SS.Formula.Functions.Even">
  31745. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31746. </member>
  31747. <member name="T:NPOI.SS.Formula.Functions.Exp">
  31748. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31749. </member>
  31750. <member name="T:NPOI.SS.Formula.Functions.Fact">
  31751. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31752. </member>
  31753. <member name="T:NPOI.SS.Formula.Functions.FinanceFunction">
  31754. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31755. Super class for all Evals for financial function evaluation.
  31756. </member>
  31757. <member name="T:NPOI.SS.Formula.Functions.Function4Arg">
  31758. Implemented by all functions that can be called with four arguments
  31759. @author Josh Micich
  31760. </member>
  31761. <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)">
  31762. see {@link Function#Evaluate(ValueEval[], int, int)}
  31763. </member>
  31764. <member name="T:NPOI.SS.Formula.Functions.FinanceLib">
  31765. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31766. This class Is a functon library for common fiscal functions.
  31767. <b>Glossary of terms/abbreviations:</b>
  31768. <br/>
  31769. <ul>
  31770. <li><em>FV:</em> Future Value</li>
  31771. <li><em>PV:</em> Present Value</li>
  31772. <li><em>NPV:</em> Net Present Value</li>
  31773. <li><em>PMT:</em> (Periodic) Payment</li>
  31774. </ul>
  31775. For more info on the terms/abbreviations please use the references below
  31776. (hyperlinks are subject to Change):
  31777. <br/>Online References:
  31778. <ol>
  31779. <li>GNU Emacs Calc 2.02 Manual: http://theory.uwinnipeg.ca/gnu/calc/calc_203.html</li>
  31780. <li>Yahoo Financial Glossary: http://biz.yahoo.com/f/g/nn.html#y</li>
  31781. <li>MS Excel function reference: http://office.microsoft.com/en-us/assistance/CH062528251033.aspx</li>
  31782. </ol>
  31783. <h3>Implementation Notes:</h3>
  31784. Symbols used in the formulae that follow:<br/>
  31785. <ul>
  31786. <li>p: present value</li>
  31787. <li>f: future value</li>
  31788. <li>n: number of periods</li>
  31789. <li>y: payment (in each period)</li>
  31790. <li>r: rate</li>
  31791. <li>^: the power operator (NOT the java bitwise XOR operator!)</li>
  31792. </ul>
  31793. [From MS Excel function reference] Following are some of the key formulas
  31794. that are used in this implementation:
  31795. <pre>
  31796. p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
  31797. ny + p + f=0 ...{when r=0}
  31798. </pre>
  31799. </member>
  31800. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.fv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  31801. Future value of an amount given the number of payments, rate, amount
  31802. of individual payment, present value and bool value indicating whether
  31803. payments are due at the beginning of period
  31804. (false => payments are due at end of period)
  31805. @param r rate
  31806. @param n num of periods
  31807. @param y pmt per period
  31808. @param p future value
  31809. @param t type (true=pmt at end of period, false=pmt at begining of period)
  31810. </member>
  31811. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  31812. Present value of an amount given the number of future payments, rate, amount
  31813. of individual payment, future value and bool value indicating whether
  31814. payments are due at the beginning of period
  31815. (false => payments are due at end of period)
  31816. @param r
  31817. @param n
  31818. @param y
  31819. @param f
  31820. @param t
  31821. </member>
  31822. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.npv(System.Double,System.Double[])">
  31823. calculates the Net Present Value of a principal amount
  31824. given the disCount rate and a sequence of cash flows
  31825. (supplied as an array). If the amounts are income the value should
  31826. be positive, else if they are payments and not income, the
  31827. value should be negative.
  31828. @param r
  31829. @param cfs cashflow amounts
  31830. </member>
  31831. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pmt(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  31832. @param r
  31833. @param n
  31834. @param p
  31835. @param f
  31836. @param t
  31837. </member>
  31838. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.nper(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  31839. @param r
  31840. @param y
  31841. @param p
  31842. @param f
  31843. @param t
  31844. </member>
  31845. <member name="T:NPOI.SS.Formula.Functions.Fixed4ArgFunction">
  31846. Convenience base class for functions that must take exactly four arguments.
  31847. @author Josh Micich
  31848. </member>
  31849. <member name="T:NPOI.SS.Formula.Functions.Floor">
  31850. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31851. </member>
  31852. <member name="T:NPOI.SS.Formula.Functions.Hlookup">
  31853. Implementation of the HLOOKUP() function.<p/>
  31854. HLOOKUP Finds a column in a lookup table by the first row value and returns the value from another row.<br/>
  31855. <b>Syntax</b>:<br/>
  31856. <b>HLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>row_index_num</b>, range_lookup)<p/>
  31857. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  31858. <b>table_array</b> An area reference for the lookup data. <br/>
  31859. <b>row_index_num</b> a 1 based index specifying which row value of the lookup data will be returned.<br/>
  31860. <b>range_lookup</b> If TRUE (default), HLOOKUP Finds the largest value less than or equal to
  31861. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  31862. @author Josh Micich
  31863. </member>
  31864. <member name="M:NPOI.SS.Formula.Functions.Hlookup.CreateResultColumnVector(NPOI.SS.Formula.Eval.AreaEval,System.Int32)">
  31865. Returns one column from an <c>AreaEval</c>
  31866. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  31867. </member>
  31868. <member name="T:NPOI.SS.Formula.Functions.If">
  31869. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31870. </member>
  31871. <member name="T:NPOI.SS.Formula.Functions.Index">
  31872. Implementation for the Excel function INDEX
  31873. Syntax : <br/>
  31874. INDEX ( reference, row_num[, column_num [, area_num]])<br/>
  31875. INDEX ( array, row_num[, column_num])
  31876. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  31877. <tr><th>reference</th><td>typically an area reference, possibly a union of areas</td></tr>
  31878. <tr><th>array</th><td>a literal array value (currently not supported)</td></tr>
  31879. <tr><th>row_num</th><td>selects the row within the array or area reference</td></tr>
  31880. <tr><th>column_num</th><td>selects column within the array or area reference. default Is 1</td></tr>
  31881. <tr><th>area_num</th><td>used when reference Is a union of areas</td></tr>
  31882. </table>
  31883. @author Josh Micich
  31884. </member>
  31885. <member name="M:NPOI.SS.Formula.Functions.Index.GetValueFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
  31886. @param colArgWasPassed <c>false</c> if the INDEX argument lIst had just 2 items
  31887. (exactly 1 comma). If anything Is passed for the <c>column_num</c> argument
  31888. (including {@link BlankEval} or {@link MIssingArgEval}) this parameter will be
  31889. <c>true</c>. ThIs parameter is needed because error codes are slightly
  31890. different when only 2 args are passed.
  31891. </member>
  31892. <member name="M:NPOI.SS.Formula.Functions.Index.ResolveIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31893. @param arg a 1-based index.
  31894. @return the Resolved 1-based index. Zero if the arg was missing or blank
  31895. @throws EvaluationException if the arg Is an error value evaluates to a negative numeric value
  31896. </member>
  31897. <member name="T:NPOI.SS.Formula.Functions.Indirect">
  31898. Implementation for Excel function INDIRECT<p/>
  31899. INDIRECT() returns the cell or area reference denoted by the text argument.<p/>
  31900. <b>Syntax</b>:<br/>
  31901. <b>INDIRECT</b>(<b>ref_text</b>,isA1Style)<p/>
  31902. <b>ref_text</b> a string representation of the desired reference as it would normally be written
  31903. in a cell formula.<br/>
  31904. <b>isA1Style</b> (default TRUE) specifies whether the ref_text should be interpreted as A1-style
  31905. or R1C1-style.
  31906. @author Josh Micich
  31907. </member>
  31908. <member name="M:NPOI.SS.Formula.Functions.Indirect.ParseWorkbookAndSheetName(System.String)">
  31909. @return array of length 2: {workbookName, sheetName,}. Second element will always be
  31910. present. First element may be null if sheetName is unqualified.
  31911. Returns <code>null</code> if text cannot be parsed.
  31912. </member>
  31913. <member name="M:NPOI.SS.Formula.Functions.Indirect.UnescapeString(System.String)">
  31914. @return <code>null</code> if there is a syntax error in any escape sequence
  31915. (the typical syntax error is a single quote character not followed by another).
  31916. </member>
  31917. <member name="T:NPOI.SS.Formula.Functions.Int">
  31918. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31919. </member>
  31920. <member name="T:NPOI.SS.Formula.Functions.Irr">
  31921. Calculates the internal rate of return.
  31922. Syntax is IRR(values) or IRR(values,guess)
  31923. @author Marcel May
  31924. @author Yegor Kozlov
  31925. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">Wikipedia on IRR</a>
  31926. @see <a href="http://office.microsoft.com/en-us/excel-help/irr-HP005209146.aspx">Excel IRR</a>
  31927. </member>
  31928. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[])">
  31929. Computes the internal rate of return using an estimated irr of 10 percent.
  31930. @param income the income values.
  31931. @return the irr.
  31932. </member>
  31933. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[],System.Double)">
  31934. Calculates IRR using the Newton-Raphson Method.
  31935. <p>
  31936. Starting with the guess, the method cycles through the calculation until the result
  31937. is accurate within 0.00001 percent. If IRR can't find a result that works
  31938. after 20 tries, the Double.NaN is returned.
  31939. </p>
  31940. <p>
  31941. The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
  31942. @see <a href="http://commons.apache.org">http://commons.apache.org</a>
  31943. </p>
  31944. @param values the income values.
  31945. @param guess the initial guess of irr.
  31946. @return the irr value. The method returns <code>Double.NaN</code>
  31947. if the maximum iteration count is exceeded
  31948. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
  31949. http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
  31950. @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
  31951. http://en.wikipedia.org/wiki/Newton%27s_method</a>
  31952. </member>
  31953. <member name="T:NPOI.SS.Formula.Functions.Isblank">
  31954. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31955. </member>
  31956. <member name="T:NPOI.SS.Formula.Functions.Iserror">
  31957. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31958. </member>
  31959. <member name="T:NPOI.SS.Formula.Functions.Islogical">
  31960. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31961. </member>
  31962. <member name="T:NPOI.SS.Formula.Functions.Isna">
  31963. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31964. </member>
  31965. <member name="T:NPOI.SS.Formula.Functions.Isnontext">
  31966. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31967. </member>
  31968. <member name="T:NPOI.SS.Formula.Functions.Isnumber">
  31969. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31970. </member>
  31971. <member name="T:NPOI.SS.Formula.Functions.Isref">
  31972. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31973. </member>
  31974. <member name="T:NPOI.SS.Formula.Functions.Istext">
  31975. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  31976. </member>
  31977. <member name="T:NPOI.SS.Formula.Functions.ValueVector">
  31978. Represents a single row or column within an <c>AreaEval</c>.
  31979. </member>
  31980. <member name="T:NPOI.SS.Formula.Functions.Lookup">
  31981. Implementation of Excel function LOOKUP.<p/>
  31982. LOOKUP Finds an index row in a lookup table by the first column value and returns the value from another column.
  31983. <b>Syntax</b>:<br/>
  31984. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>lookup_vector</b>, result_vector)<p/>
  31985. <b>lookup_value</b> The value to be found in the lookup vector.<br/>
  31986. <b>lookup_vector</b> An area reference for the lookup data. <br/>
  31987. <b>result_vector</b> Single row or single column area reference from which the result value Is chosen.<br/>
  31988. @author Josh Micich
  31989. </member>
  31990. <member name="T:NPOI.SS.Formula.Functions.LookupUtils">
  31991. Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
  31992. @author Josh Micich
  31993. </member>
  31994. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.CreateVector(NPOI.SS.Formula.TwoDEval)">
  31995. @return <c>null</c> if the supplied area is neither a single row nor a single colum
  31996. </member>
  31997. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRowOrColIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31998. Processes the third argument to VLOOKUP, or HLOOKUP (<b>col_index_num</b>
  31999. or <b>row_index_num</b> respectively).<br/>
  32000. Sample behaviour:
  32001. <table border="0" cellpAdding="1" cellspacing="2" summary="Sample behaviour">
  32002. <tr><th>Input Return</th><th>Value </th><th>Thrown Error</th></tr>
  32003. <tr><td>5</td><td>4</td><td> </td></tr>
  32004. <tr><td>2.9</td><td>2</td><td> </td></tr>
  32005. <tr><td>"5"</td><td>4</td><td> </td></tr>
  32006. <tr><td>"2.18e1"</td><td>21</td><td> </td></tr>
  32007. <tr><td>"-$2"</td><td>-3</td><td>*</td></tr>
  32008. <tr><td>FALSE</td><td>-1</td><td>*</td></tr>
  32009. <tr><td>TRUE</td><td>0</td><td> </td></tr>
  32010. <tr><td>"TRUE"</td><td> </td><td>#REF!</td></tr>
  32011. <tr><td>"abc"</td><td> </td><td>#REF!</td></tr>
  32012. <tr><td>""</td><td> </td><td>#REF!</td></tr>
  32013. <tr><td>&lt;blank&gt;</td><td> </td><td>#VALUE!</td></tr>
  32014. </table><br/>
  32015. * Note - out of range errors (both too high and too low) are handled by the caller.
  32016. @return column or row index as a zero-based value
  32017. </member>
  32018. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveTableArrayArg(NPOI.SS.Formula.Eval.ValueEval)">
  32019. The second argument (table_array) should be an area ref, but can actually be a cell ref, in
  32020. which case it Is interpreted as a 1x1 area ref. Other scalar values cause #VALUE! error.
  32021. </member>
  32022. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRangeLookupArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  32023. Resolves the last (optional) parameter (<b>range_lookup</b>) to the VLOOKUP and HLOOKUP functions.
  32024. @param rangeLookupArg
  32025. @param srcCellRow
  32026. @param srcCellCol
  32027. @return
  32028. @throws EvaluationException
  32029. </member>
  32030. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.LookupIndexOfExactValue(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector)">
  32031. Finds first (lowest index) exact occurrence of specified value.
  32032. @param lookupValue the value to be found in column or row vector
  32033. @param vector the values to be searched. For VLOOKUP this Is the first column of the
  32034. tableArray. For HLOOKUP this Is the first row of the tableArray.
  32035. @return zero based index into the vector, -1 if value cannot be found
  32036. </member>
  32037. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.PerformBinarySearch(NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupValueComparer)">
  32038. Excel has funny behaviour when the some elements in the search vector are the wrong type.
  32039. </member>
  32040. <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)">
  32041. Excel seems to handle mismatched types initially by just stepping 'mid' ix forward to the
  32042. first compatible value.
  32043. @param midIx 'mid' index (value which has the wrong type)
  32044. @return usually -1, signifying that the BinarySearchIndex has been narrowed to the new mid
  32045. index. Zero or greater signifies that an exact match for the lookup value was found
  32046. </member>
  32047. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.FindLastIndexInRunOfEqualValues(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,System.Int32,System.Int32)">
  32048. Once the binary search has found a single match, (V/H)LOOKUP steps one by one over subsequent
  32049. values to choose the last matching item.
  32050. </member>
  32051. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparer.CompareTo(NPOI.SS.Formula.Eval.ValueEval)">
  32052. @return one of 4 instances or <c>CompareResult</c>: <c>LESS_THAN</c>, <c>EQUAL</c>,
  32053. <c>GREATER_THAN</c> or <c>TYPE_MISMATCH</c>
  32054. </member>
  32055. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparerBase.GetValueAsString">
  32056. used only for debug purposes
  32057. </member>
  32058. <member name="T:NPOI.SS.Formula.Functions.CompareResult">
  32059. Enumeration to support <b>4</b> valued comparison results.<p/>
  32060. Excel lookup functions have complex behaviour in the case where the lookup array has mixed
  32061. types, and/or Is Unordered. Contrary to suggestions in some Excel documentation, there
  32062. does not appear to be a Universal ordering across types. The binary search algorithm used
  32063. Changes behaviour when the Evaluated 'mid' value has a different type to the lookup value.<p/>
  32064. A simple int might have done the same job, but there Is risk in confusion with the well
  32065. known <c>Comparable.CompareTo()</c> and <c>Comparator.Compare()</c> which both use
  32066. a ubiquitous 3 value result encoding.
  32067. </member>
  32068. <member name="T:NPOI.SS.Formula.Functions.BinarySearchIndexes">
  32069. Encapsulates some standard binary search functionality so the Unusual Excel behaviour can
  32070. be clearly distinguished.
  32071. </member>
  32072. <member name="M:NPOI.SS.Formula.Functions.BinarySearchIndexes.GetMidIx">
  32073. @return -1 if the search range Is empty
  32074. </member>
  32075. <member name="T:NPOI.SS.Formula.Functions.Match">
  32076. Implementation for the MATCH() Excel function.<p/>
  32077. <b>Syntax:</b><br/>
  32078. <b>MATCH</b>(<b>lookup_value</b>, <b>lookup_array</b>, match_type)<p/>
  32079. Returns a 1-based index specifying at what position in the <b>lookup_array</b> the specified
  32080. <b>lookup_value</b> Is found.<p/>
  32081. Specific matching behaviour can be modified with the optional <b>match_type</b> parameter.
  32082. <table border="0" cellpAdding="1" cellspacing="0" summary="match_type parameter description">
  32083. <tr><th>Value</th><th>Matching Behaviour</th></tr>
  32084. <tr><td>1</td><td>(default) Find the largest value that Is less than or equal to lookup_value.
  32085. The lookup_array must be in ascending <i>order</i>*.</td></tr>
  32086. <tr><td>0</td><td>Find the first value that Is exactly equal to lookup_value.
  32087. The lookup_array can be in any order.</td></tr>
  32088. <tr><td>-1</td><td>Find the smallest value that Is greater than or equal to lookup_value.
  32089. The lookup_array must be in descending <i>order</i>*.</td></tr>
  32090. </table>
  32091. * Note regarding <i>order</i> - For the <b>match_type</b> cases that require the lookup_array to
  32092. be ordered, MATCH() can produce incorrect results if this requirement Is not met. Observed
  32093. behaviour in Excel Is to return the lowest index value for which every item after that index
  32094. breaks the match rule.<br/>
  32095. The (ascending) sort order expected by MATCH() Is:<br/>
  32096. numbers (low to high), strings (A to Z), bool (FALSE to TRUE)<br/>
  32097. MATCH() ignores all elements in the lookup_array with a different type to the lookup_value.
  32098. Type conversion of the lookup_array elements Is never performed.
  32099. @author Josh Micich
  32100. </member>
  32101. <member name="M:NPOI.SS.Formula.Functions.Match.FindIndexOfValue(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.ValueVector,System.Boolean,System.Boolean)">
  32102. @return zero based index
  32103. </member>
  32104. <member name="T:NPOI.SS.Formula.Functions.MathX">
  32105. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32106. This class Is an extension to the standard math library
  32107. provided by java.lang.Math class. It follows the Math class
  32108. in that it has a private constructor and all static methods.
  32109. </member>
  32110. <member name="M:NPOI.SS.Formula.Functions.MathX.round(System.Double,System.Int32)">
  32111. Returns a value rounded to p digits after decimal.
  32112. If p Is negative, then the number Is rounded to
  32113. places to the left of the decimal point. eg.
  32114. 10.23 rounded to -1 will give: 10. If p Is zero,
  32115. the returned value Is rounded to the nearest integral
  32116. value.
  32117. If n Is negative, the resulting value Is obtained
  32118. as the round value of absolute value of n multiplied
  32119. by the sign value of n (@see MathX.sign(double d)).
  32120. Thus, -0.6666666 rounded to p=0 will give -1 not 0.
  32121. If n Is NaN, returned value Is NaN.
  32122. @param n
  32123. @param p
  32124. </member>
  32125. <member name="M:NPOI.SS.Formula.Functions.MathX.roundUp(System.Double,System.Int32)">
  32126. Returns a value rounded-up to p digits after decimal.
  32127. If p Is negative, then the number Is rounded to
  32128. places to the left of the decimal point. eg.
  32129. 10.23 rounded to -1 will give: 20. If p Is zero,
  32130. the returned value Is rounded to the nearest integral
  32131. value.
  32132. If n Is negative, the resulting value Is obtained
  32133. as the round-up value of absolute value of n multiplied
  32134. by the sign value of n (@see MathX.sign(double d)).
  32135. Thus, -0.2 rounded-up to p=0 will give -1 not 0.
  32136. If n Is NaN, returned value Is NaN.
  32137. @param n
  32138. @param p
  32139. </member>
  32140. <member name="M:NPOI.SS.Formula.Functions.MathX.roundDown(System.Double,System.Int32)">
  32141. Returns a value rounded to p digits after decimal.
  32142. If p Is negative, then the number Is rounded to
  32143. places to the left of the decimal point. eg.
  32144. 10.23 rounded to -1 will give: 10. If p Is zero,
  32145. the returned value Is rounded to the nearest integral
  32146. value.
  32147. If n Is negative, the resulting value Is obtained
  32148. as the round-up value of absolute value of n multiplied
  32149. by the sign value of n (@see MathX.sign(double d)).
  32150. Thus, -0.8 rounded-down to p=0 will give 0 not -1.
  32151. If n Is NaN, returned value Is NaN.
  32152. @param n
  32153. @param p
  32154. </member>
  32155. <member name="M:NPOI.SS.Formula.Functions.MathX.average(System.Double[])">
  32156. average of all values
  32157. @param values
  32158. </member>
  32159. <member name="M:NPOI.SS.Formula.Functions.MathX.sum(System.Double[])">
  32160. sum of all values
  32161. @param values
  32162. </member>
  32163. <member name="M:NPOI.SS.Formula.Functions.MathX.sumsq(System.Double[])">
  32164. sum of squares of all values
  32165. @param values
  32166. </member>
  32167. <member name="M:NPOI.SS.Formula.Functions.MathX.product(System.Double[])">
  32168. product of all values
  32169. @param values
  32170. </member>
  32171. <member name="M:NPOI.SS.Formula.Functions.MathX.min(System.Double[])">
  32172. min of all values. If supplied array Is zero Length,
  32173. double.POSITIVE_INFINITY Is returned.
  32174. @param values
  32175. </member>
  32176. <member name="M:NPOI.SS.Formula.Functions.MathX.max(System.Double[])">
  32177. min of all values. If supplied array Is zero Length,
  32178. double.NEGATIVE_INFINITY Is returned.
  32179. @param values
  32180. </member>
  32181. <member name="M:NPOI.SS.Formula.Functions.MathX.floor(System.Double,System.Double)">
  32182. Note: this function Is different from java.lang.Math.floor(..).
  32183. When n and s are "valid" arguments, the returned value Is: Math.floor(n/s) * s;
  32184. <br/>
  32185. n and s are invalid if any of following conditions are true:
  32186. <ul>
  32187. <li>s Is zero</li>
  32188. <li>n Is negative and s Is positive</li>
  32189. <li>n Is positive and s Is negative</li>
  32190. </ul>
  32191. In all such cases, double.NaN Is returned.
  32192. @param n
  32193. @param s
  32194. </member>
  32195. <member name="M:NPOI.SS.Formula.Functions.MathX.ceiling(System.Double,System.Double)">
  32196. Note: this function Is different from java.lang.Math.ceil(..).
  32197. When n and s are "valid" arguments, the returned value Is: Math.ceiling(n/s) * s;
  32198. <br/>
  32199. n and s are invalid if any of following conditions are true:
  32200. <ul>
  32201. <li>s Is zero</li>
  32202. <li>n Is negative and s Is positive</li>
  32203. <li>n Is positive and s Is negative</li>
  32204. </ul>
  32205. In all such cases, double.NaN Is returned.
  32206. @param n
  32207. @param s
  32208. </member>
  32209. <member name="M:NPOI.SS.Formula.Functions.MathX.factorial(System.Int32)">
  32210. <br/> for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
  32211. <br/> else if n == 0; factorial n = 1
  32212. <br/> else if n &lt; 0; factorial n = double.NaN
  32213. <br/> Loss of precision can occur if n Is large enough.
  32214. If n Is large so that the resulting value would be greater
  32215. than double.MAX_VALUE; double.POSITIVE_INFINITY Is returned.
  32216. If n &lt; 0, double.NaN Is returned.
  32217. @param n
  32218. </member>
  32219. <member name="M:NPOI.SS.Formula.Functions.MathX.mod(System.Double,System.Double)">
  32220. returns the remainder resulting from operation:
  32221. n / d.
  32222. <br/> The result has the sign of the divisor.
  32223. <br/> Examples:
  32224. <ul>
  32225. <li>mod(3.4, 2) = 1.4</li>
  32226. <li>mod(-3.4, 2) = 0.6</li>
  32227. <li>mod(-3.4, -2) = -1.4</li>
  32228. <li>mod(3.4, -2) = -0.6</li>
  32229. </ul>
  32230. If d == 0, result Is NaN
  32231. @param n
  32232. @param d
  32233. </member>
  32234. <member name="M:NPOI.SS.Formula.Functions.MathX.acosh(System.Double)">
  32235. inverse hyperbolic cosine
  32236. @param d
  32237. </member>
  32238. <member name="M:NPOI.SS.Formula.Functions.MathX.asinh(System.Double)">
  32239. inverse hyperbolic sine
  32240. @param d
  32241. </member>
  32242. <member name="M:NPOI.SS.Formula.Functions.MathX.atanh(System.Double)">
  32243. inverse hyperbolic tangent
  32244. @param d
  32245. </member>
  32246. <member name="M:NPOI.SS.Formula.Functions.MathX.cosh(System.Double)">
  32247. hyperbolic cosine
  32248. @param d
  32249. </member>
  32250. <member name="M:NPOI.SS.Formula.Functions.MathX.sinh(System.Double)">
  32251. hyperbolic sine
  32252. @param d
  32253. </member>
  32254. <member name="M:NPOI.SS.Formula.Functions.MathX.tanh(System.Double)">
  32255. hyperbolic tangent
  32256. @param d
  32257. </member>
  32258. <member name="M:NPOI.SS.Formula.Functions.MathX.sumproduct(System.Double[][])">
  32259. returns the sum of product of corresponding double value in each
  32260. subarray. It Is the responsibility of the caller to Ensure that
  32261. all the subarrays are of equal Length. If the subarrays are
  32262. not of equal Length, the return value can be Unpredictable.
  32263. @param arrays
  32264. </member>
  32265. <member name="M:NPOI.SS.Formula.Functions.MathX.sumx2my2(System.Double[],System.Double[])">
  32266. returns the sum of difference of squares of corresponding double
  32267. value in each subarray: ie. sigma (xarr[i]^2-yarr[i]^2)
  32268. <br/>
  32269. It Is the responsibility of the caller
  32270. to Ensure that the two subarrays are of equal Length. If the
  32271. subarrays are not of equal Length, the return value can be
  32272. Unpredictable.
  32273. @param xarr
  32274. @param yarr
  32275. </member>
  32276. <member name="M:NPOI.SS.Formula.Functions.MathX.sumx2py2(System.Double[],System.Double[])">
  32277. returns the sum of sum of squares of corresponding double
  32278. value in each subarray: ie. sigma (xarr[i]^2 + yarr[i]^2)
  32279. <br/>
  32280. It Is the responsibility of the caller
  32281. to Ensure that the two subarrays are of equal Length. If the
  32282. subarrays are not of equal Length, the return value can be
  32283. Unpredictable.
  32284. @param xarr
  32285. @param yarr
  32286. </member>
  32287. <member name="M:NPOI.SS.Formula.Functions.MathX.sumxmy2(System.Double[],System.Double[])">
  32288. returns the sum of squares of difference of corresponding double
  32289. value in each subarray: ie. sigma ( (xarr[i]-yarr[i])^2 )
  32290. <br/>
  32291. It Is the responsibility of the caller
  32292. to Ensure that the two subarrays are of equal Length. If the
  32293. subarrays are not of equal Length, the return value can be
  32294. Unpredictable.
  32295. @param xarr
  32296. @param yarr
  32297. </member>
  32298. <member name="M:NPOI.SS.Formula.Functions.MathX.nChooseK(System.Int32,System.Int32)">
  32299. returns the total number of combinations possible when
  32300. k items are chosen out of total of n items. If the number
  32301. Is too large, loss of precision may occur (since returned
  32302. value Is double). If the returned value Is larger than
  32303. double.MAX_VALUE, double.POSITIVE_INFINITY Is returned.
  32304. If either of the parameters Is negative, double.NaN Is returned.
  32305. @param n
  32306. @param k
  32307. </member>
  32308. <member name="T:NPOI.SS.Formula.Functions.MinaMaxa">
  32309. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32310. </member>
  32311. <member name="T:NPOI.SS.Formula.Functions.Mod">
  32312. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32313. </member>
  32314. <member name="T:NPOI.SS.Formula.Functions.Mode">
  32315. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32316. </member>
  32317. <member name="M:NPOI.SS.Formula.Functions.Mode.Evaluate(System.Double[])">
  32318. if v is zero length or contains no duplicates, return value is
  32319. Double.NaN. Else returns the value that occurs most times and if there is
  32320. a tie, returns the first such value.
  32321. @param v
  32322. </member>
  32323. <member name="T:NPOI.SS.Formula.Functions.Na">
  32324. Implementation of Excel function NA()
  32325. @author Josh Micich
  32326. </member>
  32327. <member name="T:NPOI.SS.Formula.Functions.NotImplementedFunction">
  32328. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32329. This Is the default implementation of a Function class.
  32330. The default behaviour Is to return a non-standard ErrorEval
  32331. "ErrorEval.FUNCTION_NOT_IMPLEMENTED". This error should alert
  32332. the user that the formula contained a function that Is not
  32333. yet implemented.
  32334. </member>
  32335. <member name="T:NPOI.SS.Formula.Functions.Now">
  32336. Implementation of Excel NOW() Function
  32337. @author Frank Taffelt
  32338. </member>
  32339. <member name="T:NPOI.SS.Formula.Functions.Abs">
  32340. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32341. </member>
  32342. <member name="T:NPOI.SS.Formula.Functions.Acos">
  32343. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32344. </member>
  32345. <member name="T:NPOI.SS.Formula.Functions.Acosh">
  32346. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32347. Support for hyperbolic trig functions was Added as a part of
  32348. Java distribution only in JDK1.5. This class uses custom
  32349. naive implementation based on formulas at:
  32350. http://www.math2.org/math/trig/hyperbolics.htm
  32351. These formulas seem to agree with excel's implementation.
  32352. </member>
  32353. <member name="T:NPOI.SS.Formula.Functions.Asin">
  32354. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32355. </member>
  32356. <member name="T:NPOI.SS.Formula.Functions.Asinh">
  32357. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32358. Support for hyperbolic trig functions was Added as a part of
  32359. Java distribution only in JDK1.5. This class uses custom
  32360. naive implementation based on formulas at:
  32361. http://www.math2.org/math/trig/hyperbolics.htm
  32362. These formulas seem to agree with excel's implementation.
  32363. </member>
  32364. <member name="T:NPOI.SS.Formula.Functions.Atan">
  32365. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32366. </member>
  32367. <member name="T:NPOI.SS.Formula.Functions.Atan2">
  32368. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32369. </member>
  32370. <member name="T:NPOI.SS.Formula.Functions.Atanh">
  32371. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32372. Support for hyperbolic trig functions was Added as a part of
  32373. Java distribution only in JDK1.5. This class uses custom
  32374. naive implementation based on formulas at:
  32375. http://www.math2.org/math/trig/hyperbolics.htm
  32376. These formulas seem to agree with excel's implementation.
  32377. </member>
  32378. <member name="T:NPOI.SS.Formula.Functions.Cos">
  32379. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32380. </member>
  32381. <member name="T:NPOI.SS.Formula.Functions.Cosh">
  32382. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32383. </member>
  32384. <member name="T:NPOI.SS.Formula.Functions.Ln">
  32385. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32386. </member>
  32387. <member name="T:NPOI.SS.Formula.Functions.Log">
  32388. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32389. Log: LOG(number,[base])
  32390. </member>
  32391. <member name="T:NPOI.SS.Formula.Functions.Log10">
  32392. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32393. </member>
  32394. <member name="T:NPOI.SS.Formula.Functions.NumericFunction">
  32395. @author Amol S. Deshmukh &lt; amolweb at yahoo dot com &gt;
  32396. </member>
  32397. <member name="T:NPOI.SS.Formula.Functions.Pi">
  32398. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32399. </member>
  32400. <member name="M:NPOI.SS.Formula.Functions.Poisson.IsDefaultResult(System.Double,System.Double)">
  32401. This checks is x = 0 and the mean = 0.
  32402. Excel currently returns the value 1 where as the
  32403. maths common implementation will error.
  32404. @param x The number.
  32405. @param mean The mean.
  32406. @return If a default value should be returned.
  32407. </member>
  32408. <member name="F:NPOI.SS.Formula.Functions.Poisson.FACTORIALS">
  32409. All long-representable factorials
  32410. </member>
  32411. <member name="T:NPOI.SS.Formula.Functions.Rand">
  32412. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32413. </member>
  32414. <member name="T:NPOI.SS.Formula.Functions.Sin">
  32415. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32416. </member>
  32417. <member name="T:NPOI.SS.Formula.Functions.Sinh">
  32418. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32419. </member>
  32420. <member name="T:NPOI.SS.Formula.Functions.Sqrt">
  32421. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32422. </member>
  32423. <member name="T:NPOI.SS.Formula.Functions.Tan">
  32424. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32425. </member>
  32426. <member name="T:NPOI.SS.Formula.Functions.Tanh">
  32427. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32428. </member>
  32429. <member name="T:NPOI.SS.Formula.Functions.Odd">
  32430. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32431. </member>
  32432. <member name="T:NPOI.SS.Formula.Functions.Offset">
  32433. Implementation for Excel function OFFSet()<p/>
  32434. OFFSet returns an area reference that Is a specified number of rows and columns from a
  32435. reference cell or area.<p/>
  32436. <b>Syntax</b>:<br/>
  32437. <b>OFFSet</b>(<b>reference</b>, <b>rows</b>, <b>cols</b>, height, width)<p/>
  32438. <b>reference</b> Is the base reference.<br/>
  32439. <b>rows</b> Is the number of rows up or down from the base reference.<br/>
  32440. <b>cols</b> Is the number of columns left or right from the base reference.<br/>
  32441. <b>height</b> (default same height as base reference) Is the row Count for the returned area reference.<br/>
  32442. <b>width</b> (default same width as base reference) Is the column Count for the returned area reference.<br/>
  32443. @author Josh Micich
  32444. </member>
  32445. <member name="M:NPOI.SS.Formula.Functions.Offset.EvaluateIntArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  32446. OFFSet's numeric arguments (2..5) have similar Processing rules
  32447. </member>
  32448. <member name="M:NPOI.SS.Formula.Functions.Offset.ConvertDoubleToInt(System.Double)">
  32449. Fractional values are silently truncated by Excel.
  32450. Truncation Is toward negative infinity.
  32451. </member>
  32452. <member name="T:NPOI.SS.Formula.Functions.Offset.EvalEx">
  32453. Exceptions are used within this class to help simplify flow control when error conditions
  32454. are enCountered
  32455. </member>
  32456. <member name="T:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange">
  32457. A one dimensional base + offset. Represents either a row range or a column range.
  32458. Two instances of this class toGether specify an area range.
  32459. </member>
  32460. <member name="M:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange.NormaliseAndTranslate(System.Int32)">
  32461. Moves the range by the specified translation amount.<p/>
  32462. This method also 'normalises' the range: Excel specifies that the width and height
  32463. parameters (Length field here) cannot be negative. However, OFFSet() does produce
  32464. sensible results in these cases. That behavior Is replicated here. <p/>
  32465. @param translationAmount may be zero negative or positive
  32466. @return the equivalent <c>LinearOffsetRange</c> with a positive Length, moved by the
  32467. specified translationAmount.
  32468. </member>
  32469. <member name="T:NPOI.SS.Formula.Functions.Offset.BaseRef">
  32470. Encapsulates either an area or cell reference which may be 2d or 3d.
  32471. </member>
  32472. <member name="T:NPOI.SS.Formula.Functions.Pmt">
  32473. Implementation for the PMT() Excel function.<p/>
  32474. <b>Syntax:</b><br/>
  32475. <b>PMT</b>(<b>rate</b>, <b>nper</b>, <b>pv</b>, fv, type)<p/>
  32476. Returns the constant repayment amount required for a loan assuming a constant interest rate.<p/>
  32477. <b>rate</b> the loan interest rate.<br/>
  32478. <b>nper</b> the number of loan repayments.<br/>
  32479. <b>pv</b> the present value of the future payments (or principle).<br/>
  32480. <b>fv</b> the future value (default zero) surplus cash at the end of the loan lifetime.<br/>
  32481. <b>type</b> whether payments are due at the beginning(1) or end(0 - default) of each payment period.<br/>
  32482. </member>
  32483. <member name="T:NPOI.SS.Formula.Functions.Power">
  32484. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32485. </member>
  32486. <member name="T:NPOI.SS.Formula.Functions.Radians">
  32487. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32488. </member>
  32489. <member name="T:NPOI.SS.Formula.Functions.Rows">
  32490. Implementation for Excel ROWS function.
  32491. @author Josh Micich
  32492. </member>
  32493. <member name="T:NPOI.SS.Formula.Functions.StatsLib">
  32494. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32495. Library for common statistics functions
  32496. </member>
  32497. <member name="M:NPOI.SS.Formula.Functions.StatsLib.avedev(System.Double[])">
  32498. returns the mean of deviations from mean.
  32499. @param v
  32500. </member>
  32501. <member name="M:NPOI.SS.Formula.Functions.StatsLib.mode(System.Double[])">
  32502. if v Is zero Length or Contains no duplicates, return value
  32503. Is double.NaN. Else returns the value that occurs most times
  32504. and if there Is a tie, returns the first such value.
  32505. @param v
  32506. </member>
  32507. <member name="T:NPOI.SS.Formula.Functions.Subtotal">
  32508. Implementation for the Excel function SUBTOTAL<p>
  32509. <b>Syntax :</b> <br/>
  32510. SUBTOTAL ( <b>functionCode</b>, <b>ref1</b>, ref2 ... ) <br/>
  32511. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  32512. <tr><td><b>functionCode</b></td><td>(1-11) Selects the underlying aggregate function to be used (see table below)</td></tr>
  32513. <tr><td><b>ref1</b>, ref2 ...</td><td>Arguments to be passed to the underlying aggregate function</td></tr>
  32514. </table><br/>
  32515. </p>
  32516. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  32517. <tr><th>functionCode</th><th>Aggregate Function</th></tr>
  32518. <tr align='center'><td>1</td><td>AVERAGE</td></tr>
  32519. <tr align='center'><td>2</td><td>COUNT</td></tr>
  32520. <tr align='center'><td>3</td><td>COUNTA</td></tr>
  32521. <tr align='center'><td>4</td><td>MAX</td></tr>
  32522. <tr align='center'><td>5</td><td>MIN</td></tr>
  32523. <tr align='center'><td>6</td><td>PRODUCT</td></tr>
  32524. <tr align='center'><td>7</td><td>STDEV</td></tr>
  32525. <tr align='center'><td>8</td><td>STDEVP *</td></tr>
  32526. <tr align='center'><td>9</td><td>SUM</td></tr>
  32527. <tr align='center'><td>10</td><td>VAR *</td></tr>
  32528. <tr align='center'><td>11</td><td>VARP *</td></tr>
  32529. <tr align='center'><td>101-111</td><td>*</td></tr>
  32530. </table><br/>
  32531. * Not implemented in POI yet. Functions 101-111 are the same as functions 1-11 but with
  32532. the option 'ignore hidden values'.
  32533. <p/>
  32534. @author Paul Tomlin &lt; pault at bulk sms dot com &gt;
  32535. </member>
  32536. <member name="T:NPOI.SS.Formula.Functions.Sumif">
  32537. Implementation for the Excel function SUMIF<p>
  32538. Syntax : <br/>
  32539. SUMIF ( <b>range</b>, <b>criteria</b>, sum_range ) <br/>
  32540. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  32541. <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>
  32542. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  32543. <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>
  32544. </table><br/>
  32545. </p>
  32546. @author Josh Micich
  32547. </member>
  32548. <member name="M:NPOI.SS.Formula.Functions.Sumif.CreateSumRange(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  32549. @return a range of the same dimensions as aeRange using eval to define the top left corner.
  32550. @throws EvaluationException if eval is not a reference
  32551. </member>
  32552. <member name="M:NPOI.SS.Formula.Functions.Sumproduct.GetProductTerm(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  32553. Determines a <c>double</c> value for the specified <c>ValueEval</c>.
  32554. @param IsScalarProduct <c>false</c> for SUMPRODUCTs over area refs.
  32555. @throws EvalEx if <c>ve</c> represents an error value.
  32556. <p/>
  32557. Note - string values and empty cells are interpreted differently depending on
  32558. <c>isScalarProduct</c>. For scalar products, if any term Is blank or a string, the
  32559. error (#VALUE!) Is raised. For area (sum)products, if any term Is blank or a string, the
  32560. result Is zero.
  32561. </member>
  32562. <member name="T:NPOI.SS.Formula.Functions.XYNumericFunction">
  32563. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32564. </member>
  32565. <member name="M:NPOI.SS.Formula.Functions.XYNumericFunction.CreateAccumulator">
  32566. Constructs a new instance of the Accumulator used to calculated this function
  32567. </member>
  32568. <member name="T:NPOI.SS.Formula.Functions.TextFunction">
  32569. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32570. </member>
  32571. <member name="F:NPOI.SS.Formula.Functions.TextFunction.TRIM">
  32572. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  32573. <summary>
  32574. An implementation of the TRIM function:
  32575. <para>
  32576. Removes leading and trailing spaces from value if evaluated operand value is string.
  32577. </para>
  32578. </summary>
  32579. </member>
  32580. <member name="F:NPOI.SS.Formula.Functions.TextFunction.MID">
  32581. <summary>
  32582. An implementation of the MID function
  32583. MID returns a specific number of
  32584. characters from a text string, starting at the specified position.
  32585. Syntax: MID(text, start_num, num_chars)
  32586. </summary>
  32587. </member>
  32588. <member name="F:NPOI.SS.Formula.Functions.TextFunction.FIND">
  32589. @author Torstein Tauno Svendsen (torstei@officenet.no)
  32590. <summary>
  32591. Implementation of the FIND() function.
  32592. <para>
  32593. Syntax: FIND(Find_text, within_text, start_num)
  32594. </para>
  32595. <para> FIND returns the character position of the first (case sensitive) occurrence of
  32596. Find_text inside within_text. The third parameter,
  32597. start_num, is optional (default=1) and specifies where to start searching
  32598. from. Character positions are 1-based.</para>
  32599. </summary>
  32600. </member>
  32601. <member name="F:NPOI.SS.Formula.Functions.TextFunction.SEARCH">
  32602. <summary>
  32603. Implementation of the FIND() function. SEARCH is a case-insensitive version of FIND()
  32604. <para>
  32605. Syntax: SEARCH(Find_text, within_text, start_num)
  32606. </para>
  32607. </summary>
  32608. </member>
  32609. <member name="T:NPOI.SS.Formula.Functions.Concatenate">
  32610. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32611. </member>
  32612. <member name="T:NPOI.SS.Formula.Functions.Exact">
  32613. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32614. </member>
  32615. <member name="T:NPOI.SS.Formula.Functions.LeftRight">
  32616. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32617. </member>
  32618. <member name="T:NPOI.SS.Formula.Functions.Len">
  32619. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32620. </member>
  32621. <member name="T:NPOI.SS.Formula.Functions.Lower">
  32622. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32623. </member>
  32624. <member name="T:NPOI.SS.Formula.Functions.Mid">
  32625. <summary>
  32626. An implementation of the MID function
  32627. MID returns a specific number of
  32628. Chars from a text string, starting at the specified position.
  32629. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org;
  32630. </summary>
  32631. </member>
  32632. <member name="T:NPOI.SS.Formula.Functions.Replace">
  32633. An implementation of the Replace function:
  32634. Replaces part of a text string based on the number of Chars
  32635. you specify, with another text string.
  32636. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  32637. </member>
  32638. <member name="M:NPOI.SS.Formula.Functions.Replace.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  32639. Replaces part of a text string based on the number of Chars
  32640. you specify, with another text string.
  32641. @see org.apache.poi.hssf.record.formula.eval.Eval
  32642. </member>
  32643. <member name="T:NPOI.SS.Formula.Functions.Substitute">
  32644. An implementation of the SUBSTITUTE function:
  32645. Substitutes text in a text string with new text, some number of times.
  32646. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  32647. </member>
  32648. <member name="M:NPOI.SS.Formula.Functions.Substitute.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  32649. Substitutes text in a text string with new text, some number of times.
  32650. @see org.apache.poi.hssf.record.formula.eval.Eval
  32651. </member>
  32652. <member name="T:NPOI.SS.Formula.Functions.Text">
  32653. An implementation of the TEXT function
  32654. TEXT returns a number value formatted with the given number formatting string.
  32655. This function is not a complete implementation of the Excel function, but
  32656. handles most of the common cases. All work is passed down to
  32657. {@link DataFormatter} to be done, as this works much the same as the
  32658. display focused work that that does.
  32659. </member>
  32660. <member name="T:NPOI.SS.Formula.Functions.Trim">
  32661. An implementation of the TRIM function:
  32662. Removes leading and trailing spaces from value if Evaluated operand
  32663. value Is string.
  32664. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  32665. </member>
  32666. <member name="T:NPOI.SS.Formula.Functions.Upper">
  32667. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32668. </member>
  32669. <member name="T:NPOI.SS.Formula.Functions.TimeFunc">
  32670. Implementation for the Excel function TIME
  32671. @author Steven Butler (sebutler @ gmail dot com)
  32672. Based on POI {@link DateFunc}
  32673. </member>
  32674. <member name="M:NPOI.SS.Formula.Functions.TimeFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  32675. Converts the supplied hours, minutes and seconds to an Excel time value.
  32676. @param ds array of 3 doubles Containing hours, minutes and seconds.
  32677. Non-integer inputs are tRuncated to an integer before further calculation
  32678. of the time value.
  32679. @return An Excel representation of a time of day.
  32680. If the time value represents more than a day, the days are Removed from
  32681. the result, leaving only the time of day component.
  32682. @throws NPOI.SS.Formula.Eval.EvaluationException
  32683. If any of the arguments are greater than 32767 or the hours
  32684. minutes and seconds when combined form a time value less than 0, the function
  32685. Evaluates to an error.
  32686. </member>
  32687. <member name="F:NPOI.SS.Formula.Functions.Value.MIN_DISTANCE_BETWEEN_THOUSANDS_SEPARATOR">
  32688. "1,0000" is valid, "1,00" is not
  32689. </member>
  32690. <member name="M:NPOI.SS.Formula.Functions.Value.ConvertTextToNumber(System.String)">
  32691. TODO see if the same functionality is needed in {@link OperandResolver#parseDouble(String)}
  32692. @return <code>null</code> if there is any problem converting the text
  32693. </member>
  32694. <member name="T:NPOI.SS.Formula.Functions.Var3or4ArgFunction">
  32695. Convenience base class for any function which must take three or four
  32696. arguments
  32697. @author Josh Micich
  32698. </member>
  32699. <member name="T:NPOI.SS.Formula.Functions.Vlookup">
  32700. Implementation of the VLOOKUP() function.<p/>
  32701. VLOOKUP Finds a row in a lookup table by the first column value and returns the value from another column.<br/>
  32702. <b>Syntax</b>:<br/>
  32703. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>col_index_num</b>, range_lookup)<p/>
  32704. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  32705. <b>table_array</b> An area reference for the lookup data. <br/>
  32706. <b>col_index_num</b> a 1 based index specifying which column value of the lookup data will be returned.<br/>
  32707. <b>range_lookup</b> If TRUE (default), VLOOKUP Finds the largest value less than or equal to
  32708. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  32709. @author Josh Micich
  32710. </member>
  32711. <member name="M:NPOI.SS.Formula.Functions.Vlookup.CreateResultColumnVector(NPOI.SS.Formula.TwoDEval,System.Int32)">
  32712. Returns one column from an <c>AreaEval</c>
  32713. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  32714. </member>
  32715. <member name="T:NPOI.SS.Formula.Function.FunctionDataBuilder">
  32716. Temporarily collects <c>FunctionMetadata</c> instances for creation of a
  32717. <c>FunctionMetadataRegistry</c>.
  32718. @author Josh Micich
  32719. </member>
  32720. <member name="F:NPOI.SS.Formula.Function.FunctionDataBuilder._mutatingFunctionIndexes">
  32721. stores indexes of all functions with footnotes (i.e. whose definitions might Change)
  32722. </member>
  32723. <member name="T:NPOI.SS.Formula.Function.FunctionMetadata">
  32724. Holds information about Excel built-in functions.
  32725. @author Josh Micich
  32726. </member>
  32727. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataReader">
  32728. Converts the text meta-data file into a <c>FunctionMetadataRegistry</c>
  32729. @author Josh Micich
  32730. </member>
  32731. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataReader.ELLIPSIS">
  32732. plain ASCII text metadata file uses three dots for ellipsis
  32733. </member>
  32734. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataReader.ValidateFunctionName(System.String)">
  32735. Makes sure that footnote digits from the original OOO document have not been accidentally
  32736. left behind
  32737. </member>
  32738. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataRegistry">
  32739. Allows clients to Get <c>FunctionMetadata</c> instances for any built-in function of Excel.
  32740. @author Josh Micich
  32741. </member>
  32742. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataRegistry.FUNCTION_NAME_IF">
  32743. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  32744. </member>
  32745. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataRegistry.LookupIndexByName(System.String)">
  32746. Resolves a built-in function index.
  32747. @param name uppercase function name
  32748. @return a negative value if the function name is not found.
  32749. This typically occurs for external functions.
  32750. </member>
  32751. <member name="T:NPOI.SS.Formula.IEvaluationListener">
  32752. Tests can implement this class To track the internal working of the {@link WorkbookEvaluator}.<br/>
  32753. For POI internal testing use only
  32754. @author Josh Micich
  32755. </member>
  32756. <member name="M:NPOI.SS.Formula.IEvaluationListener.SortDependentCachedValues(NPOI.SS.Formula.ICacheEntry[])">
  32757. Internally, formula {@link ICacheEntry}s are stored in Sets which may Change ordering due
  32758. To seemingly trivial Changes. This method is provided To make the order of call-backs To
  32759. {@link #onClearDependentCachedValue(ICacheEntry, int)} more deterministic.
  32760. </member>
  32761. <member name="T:NPOI.SS.Formula.IStabilityClassifier">
  32762. Used to help optimise cell evaluation result caching by allowing applications to specify which
  32763. parts of a workbook are <em>final</em>.<br/>
  32764. The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.
  32765. This classification refers to potential actions (on the evaluated workbook) by the evaluating
  32766. application. It does not refer to operations performed by the evaluator ({@link
  32767. WorkbookEvaluator}).<br/>
  32768. <br/>
  32769. <b>General guidelines</b>:
  32770. <ul>
  32771. <li>a plain value cell can be marked as 'final' if it will not be changed after the first call
  32772. to {@link WorkbookEvaluator#evaluate(EvaluationCell)}.
  32773. </li>
  32774. <li>a formula cell can be marked as 'final' if its formula will not be changed after the first
  32775. call to {@link WorkbookEvaluator#evaluate(EvaluationCell)}. This remains true even if changes
  32776. in dependent values may cause the evaluated value to change.</li>
  32777. <li>plain value cells should be marked as 'not final' if their plain value value may change.
  32778. </li>
  32779. <li>formula cells should be marked as 'not final' if their formula definition may change.</li>
  32780. <li>cells which may switch between plain value and formula should also be marked as 'not final'.
  32781. </li>
  32782. </ul>
  32783. <b>Notes</b>:
  32784. <ul>
  32785. <li>If none of the spreadsheet cells is expected to have its definition changed after evaluation
  32786. begins, every cell can be marked as 'final'. This is the most efficient / least resource
  32787. intensive option.</li>
  32788. <li>To retain freedom to change any cell definition at any time, an application may classify all
  32789. cells as 'not final'. This freedom comes at the expense of greater memory consumption.</li>
  32790. <li>For the purpose of these classifications, setting the cached formula result of a cell (for
  32791. example in {@link HSSFFormulaEvaluator#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)})
  32792. does not constitute changing the definition of the cell.</li>
  32793. <li>Updating cells which have been classified as 'final' will cause the evaluator to behave
  32794. unpredictably (typically ignoring the update).</li>
  32795. </ul>
  32796. @author Josh Micich
  32797. </member>
  32798. <member name="F:NPOI.SS.Formula.IStabilityClassifier.TOTALLY_IMMUTABLE">
  32799. Convenience implementation for situations where all cell definitions remain fixed after
  32800. evaluation begins.
  32801. </member>
  32802. <member name="M:NPOI.SS.Formula.IStabilityClassifier.IsCellFinal(System.Int32,System.Int32,System.Int32)">
  32803. Checks if a cell's value(/formula) is fixed - in other words - not expected to be modified
  32804. between calls to the evaluator. (Note - this is an independent concept from whether a
  32805. formula cell's evaluated value may change during successive calls to the evaluator).
  32806. @param sheetIndex zero based index into workbook sheet list
  32807. @param rowIndex zero based row index of cell
  32808. @param columnIndex zero based column index of cell
  32809. @return <c>false</c> if the evaluating application may need to modify the specified
  32810. cell between calls to the evaluator.
  32811. </member>
  32812. <member name="T:NPOI.SS.Formula.LazyAreaEval">
  32813. @author Josh Micich
  32814. </member>
  32815. <member name="M:NPOI.SS.Formula.LazyAreaEval.IsSubTotal(System.Int32,System.Int32)">
  32816. @return whether cell at rowIndex and columnIndex is a subtotal
  32817. </member>
  32818. <member name="T:NPOI.SS.Formula.LazyRefEval">
  32819. @author Josh Micich
  32820. </member>
  32821. <member name="T:NPOI.SS.Formula.OperandClassTransformer">
  32822. This class performs 'operand class' transformation. Non-base Tokens are classified into three
  32823. operand classes:
  32824. <ul>
  32825. <li>reference</li>
  32826. <li>value</li>
  32827. <li>array</li>
  32828. </ul>
  32829. <p/>
  32830. The operand class chosen for each Token depends on the formula type and the Token's place
  32831. in the formula. If POI Gets the operand class wrong, Excel <em>may</em> interpret the formula
  32832. incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!',
  32833. but resolves correctly when the user presses F2, enter.<p/>
  32834. The logic implemented here was partially inspired by the description in
  32835. "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there
  32836. seems To be inconsistent with observed Excel behaviour (These differences have not been fully
  32837. investigated). The implementation in this class Has been heavily modified in order To satisfy
  32838. concrete examples of how Excel performs the same logic (see TestRVA).<p/>
  32839. Hopefully, as Additional important test cases are identified and Added To the test suite,
  32840. patterns might become more obvious in this code and allow for simplification.
  32841. @author Josh Micich
  32842. </member>
  32843. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformFormula(NPOI.SS.Formula.ParseNode)">
  32844. Traverses the supplied formula parse tree, calling <c>Ptg.SetClass()</c> for each non-base
  32845. Token To Set its operand class.
  32846. </member>
  32847. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformNode(NPOI.SS.Formula.ParseNode,System.Byte,System.Boolean)">
  32848. @param callerForceArrayFlag <c>true</c> if one of the current node's parents is a
  32849. function Ptg which Has been Changed from default 'V' To 'A' type (due To requirements on
  32850. the function return value).
  32851. </member>
  32852. <member name="T:NPOI.SS.Formula.OperationEvaluationContext">
  32853. Contains all the contextual information required to Evaluate an operation
  32854. within a formula
  32855. For POI internal use only
  32856. @author Josh Micich
  32857. </member>
  32858. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.CreateExternSheetRefEvaluator(System.String,System.String)">
  32859. @return <code>null</code> if either workbook or sheet is not found
  32860. </member>
  32861. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.GetDynamicReference(System.String,System.String,System.String,System.String,System.Boolean)">
  32862. Resolves a cell or area reference dynamically.
  32863. @param workbookName the name of the workbook Containing the reference. If <code>null</code>
  32864. the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
  32865. a {@link CollaboratingWorkbooksEnvironment} must be set up.
  32866. @param sheetName the name of the sheet Containing the reference. May be <code>null</code>
  32867. (when <c>workbookName</c> is also null) in which case the current workbook and sheet is
  32868. assumed.
  32869. @param refStrPart1 the single cell reference or first part of the area reference. Must not
  32870. be <code>null</code>.
  32871. @param refStrPart2 the second part of the area reference. For single cell references this
  32872. parameter must be <code>null</code>
  32873. @param isA1Style specifies the format for <c>refStrPart1</c> and <c>refStrPart2</c>.
  32874. Pass <c>true</c> for 'A1' style and <c>false</c> for 'R1C1' style.
  32875. TODO - currently POI only supports 'A1' reference style
  32876. @return a {@link RefEval} or {@link AreaEval}
  32877. </member>
  32878. <member name="T:NPOI.SS.Formula.OperationEvaluatorFactory">
  32879. This class Creates <c>OperationEval</c> instances To help evaluate <c>OperationPtg</c>
  32880. formula Tokens.
  32881. @author Josh Micich
  32882. </member>
  32883. <member name="M:NPOI.SS.Formula.OperationEvaluatorFactory.Evaluate(NPOI.SS.Formula.PTG.OperationPtg,NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  32884. returns the OperationEval concrete impl instance corresponding
  32885. to the supplied operationPtg
  32886. </member>
  32887. <member name="T:NPOI.SS.Formula.ParseNode">
  32888. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  32889. Token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  32890. <c>Ptg</c> is non-atomic.
  32891. @author Josh Micich
  32892. </member>
  32893. <member name="M:NPOI.SS.Formula.ParseNode.ToTokenArray(NPOI.SS.Formula.ParseNode)">
  32894. Collects the array of <c>Ptg</c> Tokens for the specified tree.
  32895. </member>
  32896. <member name="M:NPOI.SS.Formula.ParseNode.CollectIfPtgs(NPOI.SS.Formula.ParseNode.TokenCollector)">
  32897. The IF() function Gets marked up with two or three tAttr Tokens.
  32898. Similar logic will be required for CHOOSE() when it is supported
  32899. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  32900. </member>
  32901. <member name="T:NPOI.SS.Formula.PlainCellCache">
  32902. @author Josh Micich
  32903. </member>
  32904. <member name="T:NPOI.SS.Formula.PlainValueCellCacheEntry">
  32905. Used for non-formula cells, primarily To keep track of the referencing (formula) cells.
  32906. @author Josh Micich
  32907. </member>
  32908. <member name="T:NPOI.SS.Formula.PTG.AbstractFunctionPtg">
  32909. This class provides the base functionality for Excel sheet functions
  32910. There are two kinds of function Ptgs - tFunc and tFuncVar
  32911. Therefore, this class will have ONLY two subclasses
  32912. @author Avik Sengupta
  32913. @author Andrew C. Oliver (acoliver at apache dot org)
  32914. </member>
  32915. <member name="T:NPOI.SS.Formula.PTG.OperationPtg">
  32916. defines a Ptg that is an operation instead of an operand
  32917. @author andy
  32918. </member>
  32919. <member name="T:NPOI.SS.Formula.PTG.Ptg">
  32920. <c>Ptg</c> represents a syntactic token in a formula. 'PTG' is an acronym for
  32921. '<b>p</b>arse <b>t</b>hin<b>g</b>'. Originally, the name referred to the single
  32922. byte identifier at the start of the token, but in POI, <c>Ptg</c> encapsulates
  32923. the whole formula token (initial byte + value data).
  32924. <c>Ptg</c>s are logically arranged in a tree representing the structure of the
  32925. Parsed formula. However, in BIFF files <c>Ptg</c>s are written/Read in
  32926. <em>Reverse-Polish Notation</em> order. The RPN ordering also simplifies formula
  32927. evaluation logic, so POI mostly accesses <c>Ptg</c>s in the same way.
  32928. @author andy
  32929. @author avik
  32930. @author Jason Height (jheight at chariot dot net dot au)
  32931. </member>
  32932. <member name="M:NPOI.SS.Formula.PTG.Ptg.ReadTokens(System.Int32,NPOI.Util.ILittleEndianInput)">
  32933. Reads <c>size</c> bytes of the input stream, to Create an array of <c>Ptg</c>s.
  32934. Extra data (beyond <c>size</c>) may be Read if and <c>ArrayPtg</c>s are present.
  32935. </member>
  32936. <member name="M:NPOI.SS.Formula.PTG.Ptg.Clone">
  32937. @return a distinct copy of this <c>Ptg</c> if the class is mutable, or the same instance
  32938. if the class is immutable.
  32939. </member>
  32940. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSize(NPOI.SS.Formula.PTG.Ptg[])">
  32941. This method will return the same result as {@link #getEncodedSizeWithoutArrayData(Ptg[])}
  32942. if there are no array tokens present.
  32943. @return the full size taken to encode the specified <c>Ptg</c>s
  32944. </member>
  32945. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSizeWithoutArrayData(NPOI.SS.Formula.PTG.Ptg[])">
  32946. Used to calculate value that should be encoded at the start of the encoded Ptg token array;
  32947. @return the size of the encoded Ptg tokens not including any trailing array data.
  32948. </member>
  32949. <member name="M:NPOI.SS.Formula.PTG.Ptg.SerializePtgs(NPOI.SS.Formula.PTG.Ptg[],System.Byte[],System.Int32)">
  32950. Writes the ptgs to the data buffer, starting at the specified offset.
  32951. <br/>
  32952. The 2 byte encode Length field is <b>not</b> written by this method.
  32953. @return number of bytes written
  32954. </member>
  32955. <member name="M:NPOI.SS.Formula.PTG.Ptg.Write(NPOI.Util.ILittleEndianOutput)">
  32956. Write this Ptg to a byte array
  32957. </member>
  32958. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToFormulaString">
  32959. return a string representation of this token alone
  32960. </member>
  32961. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToString">
  32962. Overridden toString method to Ensure object hash is not printed.
  32963. This helps Get rid of gratuitous diffs when comparing two dumps
  32964. Subclasses may output more relevant information by overriding this method
  32965. </member>
  32966. <member name="P:NPOI.SS.Formula.PTG.Ptg.Size">
  32967. @return the encoded Length of this Ptg, including the initial Ptg type identifier byte.
  32968. </member>
  32969. <member name="P:NPOI.SS.Formula.PTG.Ptg.IsBaseToken">
  32970. @return <c>false</c> if this token is classified as 'reference', 'value', or 'array'
  32971. </member>
  32972. <member name="P:NPOI.SS.Formula.PTG.Ptg.PtgClass">
  32973. @return the 'operand class' (REF/VALUE/ARRAY) for this Ptg
  32974. </member>
  32975. <member name="P:NPOI.SS.Formula.PTG.Ptg.RVAType">
  32976. Debug / diagnostic method to get this token's 'operand class' type.
  32977. @return 'R' for 'reference', 'V' for 'value', 'A' for 'array' and '.' for base tokens
  32978. </member>
  32979. <member name="M:NPOI.SS.Formula.PTG.OperationPtg.ToFormulaString(System.String[])">
  32980. returns a string representation of the operations
  32981. the Length of the input array should equal the number returned by
  32982. @see #GetNumberOfOperands
  32983. </member>
  32984. <member name="P:NPOI.SS.Formula.PTG.OperationPtg.NumberOfOperands">
  32985. The number of operands expected by the operations
  32986. </member>
  32987. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_NAME_IF">
  32988. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  32989. </member>
  32990. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_INDEX_EXTERNAL">
  32991. All external functions have function index 255
  32992. </member>
  32993. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsBuiltInFunctionName(System.String)">
  32994. Used to detect whether a function name found in a formula is one of the standard excel functions
  32995. The name matching is case insensitive.
  32996. @return <c>true</c> if the name specifies a standard worksheet function,
  32997. <c>false</c> if the name should be assumed to be an external function.
  32998. </member>
  32999. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.LookupIndex(System.String)">
  33000. Resolves internal function names into function indexes.
  33001. The name matching is case insensitive.
  33002. @return the standard worksheet function index if found, otherwise <c>FUNCTION_INDEX_EXTERNAL</c>
  33003. </member>
  33004. <member name="P:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsExternalFunction">
  33005. external functions Get some special Processing
  33006. @return <c>true</c> if this is an external function
  33007. </member>
  33008. <member name="T:NPOI.SS.Formula.PTG.AddPtg">
  33009. Addition operator PTG the "+" binomial operator. If you need more
  33010. explanation than that then well...We really can't help you here.
  33011. @author Andrew C. Oliver (acoliver@apache.org)
  33012. @author Jason Height (jheight at chariot dot net dot au)
  33013. </member>
  33014. <member name="T:NPOI.SS.Formula.PTG.ValueOperatorPtg">
  33015. Common baseclass of all value operators.
  33016. Subclasses include all Unary and binary operators except for the reference operators (IntersectionPtg, RangePtg, UnionPtg)
  33017. @author Josh Micich
  33018. </member>
  33019. <member name="P:NPOI.SS.Formula.PTG.ValueOperatorPtg.IsBaseToken">
  33020. All Operator <c>Ptg</c>s are base tokens (i.e. are not RVA classified)
  33021. </member>
  33022. <member name="M:NPOI.SS.Formula.PTG.AddPtg.ToFormulaString(System.String[])">
  33023. implementation of method from OperationsPtg
  33024. </member>
  33025. <member name="T:NPOI.SS.Formula.PTG.Area2DPtgBase">
  33026. Common superclass of 2-D area refs
  33027. </member>
  33028. <member name="T:NPOI.SS.Formula.PTG.AreaPtgBase">
  33029. Specifies a rectangular area of cells A1:A4 for instance.
  33030. @author andy
  33031. @author Jason Height (jheight at chariot dot net dot au)
  33032. </member>
  33033. <member name="T:NPOI.SS.Formula.PTG.OperandPtg">
  33034. @author Josh Micich
  33035. </member>
  33036. <member name="P:NPOI.SS.Formula.PTG.OperandPtg.IsBaseToken">
  33037. All Operand <c>Ptg</c>s are classifed ('relative', 'value', 'array')
  33038. </member>
  33039. <member name="T:NPOI.SS.Formula.PTG.AreaI">
  33040. Common interface for AreaPtg and Area3DPtg, and their
  33041. child classes.
  33042. </member>
  33043. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstRow">
  33044. @return the first row in the area
  33045. </member>
  33046. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastRow">
  33047. @return last row in the range (x2 in x1,y1-x2,y2)
  33048. </member>
  33049. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstColumn">
  33050. @return the first column number in the area.
  33051. </member>
  33052. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastColumn">
  33053. @return lastcolumn in the area
  33054. </member>
  33055. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.NotImplemented">
  33056. TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.
  33057. see similar comment in ReferencePtg
  33058. </member>
  33059. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_1_first_row">
  33060. zero based, Unsigned 16 bit
  33061. </member>
  33062. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_2_last_row">
  33063. zero based, Unsigned 16 bit
  33064. </member>
  33065. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_3_first_column">
  33066. zero based, Unsigned 8 bit
  33067. </member>
  33068. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_4_last_column">
  33069. zero based, Unsigned 8 bit
  33070. </member>
  33071. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SetLastColumnRaw(System.Int16)">
  33072. Set the last column irrespective of the bitmasks
  33073. </member>
  33074. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstRow">
  33075. @return the first row in the area
  33076. </member>
  33077. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastRow">
  33078. @return last row in the range (x2 in x1,y1-x2,y2)
  33079. </member>
  33080. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstColumn">
  33081. @return the first column number in the area.
  33082. </member>
  33083. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstRowRelative">
  33084. @return whether or not the first row is a relative reference or not.
  33085. </member>
  33086. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstColRelative">
  33087. @return Isrelative first column to relative or not
  33088. </member>
  33089. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumn">
  33090. @return lastcolumn in the area
  33091. </member>
  33092. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumnRaw">
  33093. @return last column and bitmask (the raw field)
  33094. </member>
  33095. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastRowRelative">
  33096. @return last row relative or not
  33097. </member>
  33098. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastColRelative">
  33099. @return lastcol relative or not
  33100. </member>
  33101. <member name="T:NPOI.SS.Formula.PTG.Area3DPtg">
  33102. Title: Area 3D Ptg - 3D reference (Sheet + Area)
  33103. Description: Defined a area in Extern Sheet.
  33104. REFERENCE:
  33105. @author Libin Roman (Vista Portal LDT. Developer)
  33106. @author avik
  33107. @author Jason Height (jheight at chariot dot net dot au)
  33108. @version 1.0-pre
  33109. </member>
  33110. <member name="T:NPOI.SS.Formula.WorkbookDependentFormula">
  33111. Should be implemented by any {@link Ptg} subclass that needs a workbook To render its formula.
  33112. <br/>
  33113. For POI internal use only
  33114. @author Josh Micich
  33115. </member>
  33116. <member name="M:NPOI.SS.Formula.PTG.Area3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  33117. @return text representation of this area reference that can be used in text
  33118. formulas. The sheet name will get properly delimited if required.
  33119. </member>
  33120. <member name="T:NPOI.SS.Formula.PTG.AreaErrPtg">
  33121. AreaErr - handles deleted cell area references.
  33122. @author Daniel Noll (daniel at nuix dot com dot au)
  33123. </member>
  33124. <member name="T:NPOI.SS.Formula.PTG.AreaNPtg">
  33125. Specifies a rectangular area of cells A1:A4 for instance.
  33126. @author Jason Height (jheight at chariot dot net dot au)
  33127. </member>
  33128. <member name="T:NPOI.SS.Formula.PTG.AreaPtg">
  33129. Specifies a rectangular area of cells A1:A4 for instance.
  33130. @author Jason Height (jheight at chariot dot net dot au)
  33131. </member>
  33132. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg">
  33133. ArrayPtg - handles arrays
  33134. The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
  33135. includes the Ptg sid and the reserved bytes. The next Ptg in the expression then follows.
  33136. It is only after the "size" of all the Ptgs is met, that the ArrayPtg data is actually
  33137. held after this. So Ptg.CreateParsedExpression keeps track of the number of
  33138. ArrayPtg elements and need to Parse the data upto the FORMULA record size.
  33139. @author Jason Height (jheight at chariot dot net dot au)
  33140. </member>
  33141. <member name="F:NPOI.SS.Formula.PTG.ArrayPtg.PLAIN_TOKEN_SIZE">
  33142. The size of the plain tArray token written within the standard formula tokens
  33143. (not including the data which comes after all formula tokens)
  33144. </member>
  33145. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.#ctor(System.Object[][])">
  33146. @param values2d array values arranged in rows
  33147. </member>
  33148. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.GetValueIndex(System.Int32,System.Int32)">
  33149. Note - (2D) array elements are stored column by column
  33150. @return the index into the internal 1D array for the specified column and row
  33151. </member>
  33152. <member name="P:NPOI.SS.Formula.PTG.ArrayPtg.Size">
  33153. This size includes the size of the array Ptg plus the Array Ptg Token value size
  33154. </member>
  33155. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg.Initial">
  33156. Represents the initial plain tArray token (without the constant data that trails the whole
  33157. formula). Objects of this class are only temporary and cannot be used as {@link Ptg}s.
  33158. These temporary objects get converted to {@link ArrayPtg} by the
  33159. {@link #finishReading(LittleEndianInput)} method.
  33160. </member>
  33161. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.Initial.FinishReading(NPOI.Util.ILittleEndianInput)">
  33162. Read in the actual token (array) values. This occurs
  33163. AFTER the last Ptg in the expression.
  33164. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf
  33165. </member>
  33166. <member name="T:NPOI.SS.Formula.PTG.AttrPtg">
  33167. "Special Attributes"
  33168. This seems to be a Misc Stuff and Junk record. One function it serves Is
  33169. in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option Set)
  33170. @author andy
  33171. @author Jason Height (jheight at chariot dot net dot au)
  33172. </member>
  33173. <member name="T:NPOI.SS.Formula.PTG.ControlPtg">
  33174. Common baseclass for
  33175. tExp
  33176. tTbl
  33177. tParen
  33178. tNlr
  33179. tAttr
  33180. tSheet
  33181. tEndSheet
  33182. </member>
  33183. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._jumpTable">
  33184. only used for tAttrChoose: table of offsets to starts of args
  33185. </member>
  33186. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._chooseFuncOffset">
  33187. only used for tAttrChoose: offset to the tFuncVar for CHOOSE()
  33188. </member>
  33189. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSpace(NPOI.SS.Formula.PTG.AttrPtg.SpaceType,System.Int32)">
  33190. <summary>
  33191. Creates the space.
  33192. </summary>
  33193. <param name="type">a constant from SpaceType</param>
  33194. <param name="count">The count.</param>
  33195. </member>
  33196. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateIf(System.Int32)">
  33197. <summary>
  33198. Creates if.
  33199. </summary>
  33200. <param name="dist">distance (in bytes) to start of either
  33201. tFuncVar(IF) token (when false parameter is not present).</param>
  33202. </member>
  33203. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSkip(System.Int32)">
  33204. <summary>
  33205. Creates the skip.
  33206. </summary>
  33207. <param name="dist">distance (in bytes) to position behind tFuncVar(IF) token (minus 1).</param>
  33208. </member>
  33209. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBefore">
  33210. 00H = Spaces before the next token (not allowed before tParen token)
  33211. </member>
  33212. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBefore">
  33213. 01H = Carriage returns before the next token (not allowed before tParen token)
  33214. </member>
  33215. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeOpenParen">
  33216. 02H = Spaces before opening parenthesis (only allowed before tParen token)
  33217. </member>
  33218. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeOpenParen">
  33219. 03H = Carriage returns before opening parenthesis (only allowed before tParen token)
  33220. </member>
  33221. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeCloseParen">
  33222. 04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  33223. </member>
  33224. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeCloseParen">
  33225. 05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  33226. </member>
  33227. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceAfterEquality">
  33228. 06H = Spaces following the equality sign (only in macro sheets)
  33229. </member>
  33230. <member name="T:NPOI.SS.Formula.PTG.BoolPtg">
  33231. bool (bool)
  33232. Stores a (java) bool value in a formula.
  33233. @author Paul Krause (pkrause at soundbite dot com)
  33234. @author Andrew C. Oliver (acoliver at apache dot org)
  33235. @author Jason Height (jheight at chariot dot net dot au)
  33236. </member>
  33237. <member name="T:NPOI.SS.Formula.PTG.ScalarConstantPtg">
  33238. @author Josh Micich
  33239. </member>
  33240. <member name="T:NPOI.SS.Formula.PTG.ConcatPtg">
  33241. @author andy
  33242. @author Jason Height (jheight at chariot dot net dot au)
  33243. </member>
  33244. <member name="T:NPOI.SS.Formula.PTG.DeletedArea3DPtg">
  33245. Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
  33246. Description: Defined a area in Extern Sheet.
  33247. REFERENCE:
  33248. @author Patrick Luby
  33249. @version 1.0-pre
  33250. </member>
  33251. <member name="T:NPOI.SS.Formula.PTG.DeletedRef3DPtg">
  33252. Title: Deleted Reference 3D Ptg
  33253. Description: Defined a cell in extern sheet.
  33254. REFERENCE:
  33255. @author Patrick Luby
  33256. @version 1.0-pre
  33257. </member>
  33258. <member name="M:NPOI.SS.Formula.PTG.DeletedRef3DPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  33259. Creates new DeletedRef3DPtg
  33260. </member>
  33261. <member name="T:NPOI.SS.Formula.PTG.DividePtg">
  33262. This PTG implements the standard binomial divide "/"
  33263. @author Andrew C. Oliver acoliver at apache dot org
  33264. @author Jason Height (jheight at chariot dot net dot au)
  33265. </member>
  33266. <member name="T:NPOI.SS.Formula.PTG.EqualPtg">
  33267. @author andy
  33268. </member>
  33269. <member name="T:NPOI.SS.Formula.PTG.ErrPtg">
  33270. @author Daniel Noll (daniel at nuix dot com dot au)
  33271. </member>
  33272. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NULL_INTERSECTION">
  33273. <b>#NULL!</b> - Intersection of two cell ranges is empty
  33274. </member>
  33275. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.DIV_ZERO">
  33276. <b>#DIV/0!</b> - Division by zero
  33277. </member>
  33278. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.VALUE_INVALID">
  33279. <b>#VALUE!</b> - Wrong type of operand
  33280. </member>
  33281. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.REF_INVALID">
  33282. <b>#REF!</b> - Illegal or deleted cell reference
  33283. </member>
  33284. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NAME_INVALID">
  33285. <b>#NAME?</b> - Wrong function or range name
  33286. </member>
  33287. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NUM_ERROR">
  33288. <b>#NUM!</b> - Value range overflow
  33289. </member>
  33290. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.N_A">
  33291. <b>#N/A</b> - Argument or function not available
  33292. </member>
  33293. <member name="M:NPOI.SS.Formula.PTG.ErrPtg.#ctor(System.Int32)">
  33294. Creates new ErrPtg
  33295. </member>
  33296. <member name="T:NPOI.SS.Formula.PTG.ExpPtg">
  33297. @author andy
  33298. @author Jason Height (jheight at chariot dot net dot au)
  33299. @author dmui (save existing implementation)
  33300. </member>
  33301. <member name="T:NPOI.SS.Formula.FormulaShifter">
  33302. @author Josh Micich
  33303. </member>
  33304. <member name="F:NPOI.SS.Formula.FormulaShifter._externSheetIndex">
  33305. Extern sheet index of sheet where moving is occurring
  33306. </member>
  33307. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.Int32)">
  33308. Create an instance for shifting sheets.
  33309. For example, this will be called on {@link org.apache.poi.hssf.usermodel.HSSFWorkbook#setSheetOrder(String, int)}
  33310. </member>
  33311. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustFormula(NPOI.SS.Formula.PTG.Ptg[],System.Int32)">
  33312. @param ptgs - if necessary, will get modified by this method
  33313. @param currentExternSheetIx - the extern sheet index of the sheet that contains the formula being adjusted
  33314. @return <c>true</c> if a change was made to the formula tokens
  33315. </member>
  33316. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowMove(NPOI.SS.Formula.PTG.Ptg,System.Int32)">
  33317. @return <c>true</c> if this Ptg needed to be changed
  33318. </member>
  33319. <member name="T:NPOI.SS.Formula.PTG.FuncPtg">
  33320. @author aviks
  33321. @author Jason Height (jheight at chariot dot net dot au)
  33322. @author Danny Mui (dmui at apache dot org) (Leftover handling)
  33323. </member>
  33324. <member name="T:NPOI.SS.Formula.PTG.FuncVarPtg">
  33325. @author Jason Height (jheight at chariot dot net dot au)
  33326. </member>
  33327. <member name="F:NPOI.SS.Formula.PTG.FuncVarPtg.SUM">
  33328. Single instance of this token for 'sum() taking a single argument'
  33329. </member>
  33330. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(NPOI.Util.ILittleEndianInput)">
  33331. Creates new function pointer from a byte array
  33332. usually called while reading an excel file.
  33333. </member>
  33334. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(System.String,System.Int32)">
  33335. Create a function ptg from a string tokenised by the parser
  33336. </member>
  33337. <member name="T:NPOI.SS.Formula.PTG.GreaterEqualPtg">
  33338. PTG class to implement greater or equal to
  33339. @author fred at stsci dot edu
  33340. </member>
  33341. <member name="T:NPOI.SS.Formula.PTG.GreaterThanPtg">
  33342. Greater than operator PTG ">"
  33343. @author Cameron Riley (criley at ekmail.com)
  33344. </member>
  33345. <member name="M:NPOI.SS.Formula.PTG.GreaterThanPtg.ToFormulaString(System.String[])">
  33346. Implementation of method from OperationsPtg
  33347. @param operands a String array of operands
  33348. @return String the Formula as a String
  33349. </member>
  33350. <member name="P:NPOI.SS.Formula.PTG.GreaterThanPtg.NumberOfOperands">
  33351. Get the number of operands for the Less than operator
  33352. @return int the number of operands
  33353. </member>
  33354. <member name="T:NPOI.SS.Formula.PTG.IntersectionPtg">
  33355. @author Daniel Noll (daniel at nuix dot com dot au)
  33356. </member>
  33357. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString">
  33358. Implementation of method from Ptg
  33359. </member>
  33360. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString(System.String[])">
  33361. implementation of method from OperationsPtg
  33362. </member>
  33363. <member name="T:NPOI.SS.Formula.PTG.IntPtg">
  33364. Integer (unsigned short integer)
  33365. Stores an Unsigned short value (java int) in a formula
  33366. @author Andrew C. Oliver (acoliver at apache dot org)
  33367. @author Jason Height (jheight at chariot dot net dot au)
  33368. </member>
  33369. <member name="M:NPOI.SS.Formula.PTG.IntPtg.IsInRange(System.Int32)">
  33370. Excel represents integers 0..65535 with the tInt token.
  33371. @return <c>true</c> if the specified value is within the range of values
  33372. <c>IntPtg</c> can represent.
  33373. </member>
  33374. <member name="T:NPOI.SS.Formula.PTG.LessEqualPtg">
  33375. Ptg class to implement less than or equal
  33376. @author fred at stsci dot edu
  33377. </member>
  33378. <member name="T:NPOI.SS.Formula.PTG.LessThanPtg">
  33379. Less than operator PTG "&lt;". The SID is taken from the
  33380. Openoffice.orgs Documentation of the Excel File Format,
  33381. Table 3.5.7
  33382. @author Cameron Riley (criley at ekmail.com)
  33383. </member>
  33384. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.sid">
  33385. the sid for the less than operator as hex
  33386. </member>
  33387. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.LESSTHAN">
  33388. identifier for LESS THAN char
  33389. </member>
  33390. <member name="M:NPOI.SS.Formula.PTG.LessThanPtg.ToFormulaString(System.String[])">
  33391. Implementation of method from OperationsPtg
  33392. @param operands a String array of operands
  33393. @return String the Formula as a String
  33394. </member>
  33395. <member name="P:NPOI.SS.Formula.PTG.LessThanPtg.NumberOfOperands">
  33396. Get the number of operands for the Less than operator
  33397. @return int the number of operands
  33398. </member>
  33399. <member name="T:NPOI.SS.Formula.PTG.MemAreaPtg">
  33400. @author Daniel Noll (daniel at nuix dot com dot au)
  33401. </member>
  33402. <member name="M:NPOI.SS.Formula.PTG.MemAreaPtg.#ctor(System.Int32)">
  33403. Creates new MemAreaPtg
  33404. </member>
  33405. <member name="T:NPOI.SS.Formula.PTG.MemErrPtg">
  33406. @author andy
  33407. @author Jason Height (jheight at chariot dot net dot au)
  33408. @author Daniel Noll (daniel at nuix dot com dot au)
  33409. </member>
  33410. <member name="M:NPOI.SS.Formula.PTG.MemErrPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  33411. Creates new MemErrPtg
  33412. </member>
  33413. <member name="T:NPOI.SS.Formula.PTG.MemFuncPtg">
  33414. @author Glen Stampoultzis (glens at apache.org)
  33415. </member>
  33416. <member name="M:NPOI.SS.Formula.PTG.MemFuncPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  33417. Creates new function pointer from a byte array
  33418. usually called while Reading an excel file.
  33419. </member>
  33420. <member name="T:NPOI.SS.Formula.PTG.MissingArgPtg">
  33421. Missing Function Arguments
  33422. Avik Sengupta &lt;avik at apache.org&gt;
  33423. @author Jason Height (jheight at chariot dot net dot au)
  33424. </member>
  33425. <member name="T:NPOI.SS.Formula.PTG.MultiplyPtg">
  33426. Implements the standard mathmatical multiplication - *
  33427. @author Andrew C. Oliver (acoliver at apache dot org)
  33428. @author Jason Height (jheight at chariot dot net dot au)
  33429. </member>
  33430. <member name="T:NPOI.SS.Formula.PTG.NamePtg">
  33431. @author andy
  33432. @author Jason Height (jheight at chariot dot net dot au)
  33433. </member>
  33434. <member name="F:NPOI.SS.Formula.PTG.NamePtg.field_1_label_index">
  33435. one-based index to defined name record
  33436. </member>
  33437. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(System.Int32)">
  33438. @param nameIndex zero-based index to name within workbook
  33439. </member>
  33440. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(NPOI.Util.ILittleEndianInput)">
  33441. Creates new NamePtg
  33442. </member>
  33443. <member name="P:NPOI.SS.Formula.PTG.NamePtg.Index">
  33444. @return zero based index to a defined name record in the LinkTable
  33445. </member>
  33446. <member name="T:NPOI.SS.Formula.PTG.NameXPtg">
  33447. @author aviks
  33448. </member>
  33449. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._sheetRefIndex">
  33450. index to REF entry in externsheet record
  33451. </member>
  33452. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._nameNumber">
  33453. index to defined name or externname table(1 based)
  33454. </member>
  33455. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._reserved">
  33456. reserved must be 0
  33457. </member>
  33458. <member name="M:NPOI.SS.Formula.PTG.NameXPtg.#ctor(System.Int32,System.Int32)">
  33459. @param sheetRefIndex index to REF entry in externsheet record
  33460. @param nameIndex index to defined name or externname table
  33461. </member>
  33462. <member name="T:NPOI.SS.Formula.PTG.NotEqualPtg">
  33463. Ptg class to implement not equal
  33464. @author fred at stsci dot edu
  33465. </member>
  33466. <member name="T:NPOI.SS.Formula.PTG.NumberPtg">
  33467. Number
  33468. Stores a floating point value in a formula
  33469. value stored in a 8 byte field using IEEE notation
  33470. @author Avik Sengupta
  33471. @author Jason Height (jheight at chariot dot net dot au)
  33472. </member>
  33473. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  33474. Create a NumberPtg from a byte array Read from disk
  33475. </member>
  33476. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(System.String)">
  33477. Create a NumberPtg from a string representation of the number
  33478. Number format is not checked, it is expected to be validated in the parser
  33479. that calls this method.
  33480. @param value : String representation of a floating point number
  33481. </member>
  33482. <member name="T:NPOI.SS.Formula.PTG.ParenthesisPtg">
  33483. While formula tokens are stored in RPN order and thus do not need parenthesis for
  33484. precedence reasons, Parenthesis tokens ARE written to Ensure that user entered
  33485. parenthesis are Displayed as-is on Reading back
  33486. Avik Sengupta &lt;lists@aviksengupta.com&gt;
  33487. Andrew C. Oliver (acoliver at apache dot org)
  33488. @author Jason Height (jheight at chariot dot net dot au)
  33489. </member>
  33490. <member name="T:NPOI.SS.Formula.PTG.PercentPtg">
  33491. Percent PTG.
  33492. @author Daniel Noll (daniel at nuix.com.au)
  33493. </member>
  33494. <member name="T:NPOI.SS.Formula.PTG.PowerPtg">
  33495. @author andy
  33496. @author Jason Height (jheight at chariot dot net dot au)
  33497. </member>
  33498. <member name="T:NPOI.SS.Formula.PTG.RangePtg">
  33499. @author Daniel Noll (daniel at nuix dot com dot au)
  33500. </member>
  33501. <member name="M:NPOI.SS.Formula.PTG.RangePtg.ToFormulaString(System.String[])">
  33502. implementation of method from OperationsPtg
  33503. </member>
  33504. <member name="T:NPOI.SS.Formula.PTG.Ref2DPtgBase">
  33505. @author Josh Micich
  33506. </member>
  33507. <member name="T:NPOI.SS.Formula.PTG.RefPtgBase">
  33508. ReferencePtgBase - handles references (such as A1, A2, IA4)
  33509. @author Andrew C. Oliver (acoliver@apache.org)
  33510. @author Jason Height (jheight at chariot dot net dot au)
  33511. </member>
  33512. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_1_row">
  33513. The row index - zero based Unsigned 16 bit value
  33514. </member>
  33515. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_2_col">
  33516. Field 2
  33517. - lower 8 bits is the zero based Unsigned byte column index
  33518. - bit 16 - IsRowRelative
  33519. - bit 15 - IsColumnRelative
  33520. </member>
  33521. <member name="M:NPOI.SS.Formula.PTG.RefPtgBase.#ctor(System.String)">
  33522. Takes in a String representation of a cell reference and Fills out the
  33523. numeric fields.
  33524. </member>
  33525. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.Row">
  33526. Returns the row number as a short, which will be
  33527. wrapped (negative) for values between 32769 and 65535
  33528. </member>
  33529. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.RowAsInt">
  33530. Returns the row number as an int, between 0 and 65535
  33531. </member>
  33532. <member name="M:NPOI.SS.Formula.PTG.Ref2DPtgBase.#ctor(System.String)">
  33533. Takes in a String representation of a cell reference and fills out the
  33534. numeric fields.
  33535. </member>
  33536. <member name="T:NPOI.SS.Formula.PTG.Ref3DPtg">
  33537. Title: Reference 3D Ptg
  33538. Description: Defined a cell in extern sheet.
  33539. REFERENCE:
  33540. @author Libin Roman (Vista Portal LDT. Developer)
  33541. @author Jason Height (jheight at chariot dot net dot au)
  33542. @version 1.0-pre
  33543. </member>
  33544. <member name="F:NPOI.SS.Formula.PTG.Ref3DPtg.rowRelative">
  33545. Field 2
  33546. - lower 8 bits is the zero based Unsigned byte column index
  33547. - bit 16 - IsRowRelative
  33548. - bit 15 - IsColumnRelative
  33549. </member>
  33550. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.#ctor">
  33551. Creates new AreaPtg
  33552. </member>
  33553. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  33554. @return text representation of this cell reference that can be used in text
  33555. formulas. The sheet name will Get properly delimited if required.
  33556. </member>
  33557. <member name="T:NPOI.SS.Formula.PTG.RefErrorPtg">
  33558. RefError - handles deleted cell reference
  33559. @author Jason Height (jheight at chariot dot net dot au)
  33560. </member>
  33561. <member name="T:NPOI.SS.Formula.PTG.RefNPtg">
  33562. RefNPtg
  33563. @author Jason Height (jheight at apache dot com)
  33564. </member>
  33565. <member name="M:NPOI.SS.Formula.PTG.RefNPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  33566. Creates new ValueReferencePtg
  33567. </member>
  33568. <member name="T:NPOI.SS.Formula.PTG.RefPtg">
  33569. ReferencePtg - handles references (such as A1, A2, IA4)
  33570. @author Andrew C. Oliver (acoliver@apache.org)
  33571. @author Jason Height (jheight at chariot dot net dot au)
  33572. </member>
  33573. <member name="M:NPOI.SS.Formula.PTG.RefPtg.#ctor(System.String)">
  33574. Takes in a String representation of a cell reference and Fills out the
  33575. numeric fields.
  33576. </member>
  33577. <member name="T:NPOI.SS.Formula.PTG.StringPtg">
  33578. String Stores a String value in a formula value stored in the format
  33579. &lt;Length 2 bytes&gt;char[]
  33580. @author Werner Froidevaux
  33581. @author Jason Height (jheight at chariot dot net dot au)
  33582. @author Bernard Chesnoy
  33583. </member>
  33584. <member name="F:NPOI.SS.Formula.PTG.StringPtg.FORMULA_DELIMITER">
  33585. the Char (")used in formulas to delimit string literals
  33586. </member>
  33587. <member name="F:NPOI.SS.Formula.PTG.StringPtg.field_1_Length">
  33588. NOTE: OO doc says 16bit Length, but BiffViewer says 8 Book says something
  33589. totally different, so don't look there!
  33590. </member>
  33591. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  33592. Create a StringPtg from a stream
  33593. </member>
  33594. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(System.String)">
  33595. Create a StringPtg from a string representation of the number Number
  33596. format Is not Checked, it Is expected to be Validated in the Parser that
  33597. calls this method.
  33598. @param value :
  33599. String representation of a floating point number
  33600. </member>
  33601. <member name="T:NPOI.SS.Formula.PTG.SubtractPtg">
  33602. @author andy
  33603. @author Jason Height (jheight at chariot dot net dot au)
  33604. </member>
  33605. <member name="T:NPOI.SS.Formula.PTG.TblPtg">
  33606. This ptg indicates a data table.
  33607. It only occurs in a FORMULA record, never in an
  33608. ARRAY or NAME record. When ptgTbl occurs in a
  33609. formula, it is the only token in the formula.
  33610. This indicates that the cell containing the
  33611. formula is an interior cell in a data table;
  33612. the table description is found in a TABLE
  33613. record. Rows and columns which contain input
  33614. values to be substituted in the table do
  33615. not contain ptgTbl.
  33616. See page 811 of the june 08 binary docs.
  33617. </member>
  33618. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_1_first_row">
  33619. The row number of the upper left corner
  33620. </member>
  33621. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_2_first_col">
  33622. The column number of the upper left corner
  33623. </member>
  33624. <member name="T:NPOI.SS.Formula.PTG.UnaryMinusPtg">
  33625. Unary Plus operator
  33626. does not have any effect on the operand
  33627. @author Avik Sengupta
  33628. </member>
  33629. <member name="M:NPOI.SS.Formula.PTG.UnaryMinusPtg.ToFormulaString(System.String[])">
  33630. implementation of method from OperationsPtg
  33631. </member>
  33632. <member name="T:NPOI.SS.Formula.PTG.UnaryPlusPtg">
  33633. Unary Plus operator
  33634. does not have any effect on the operand
  33635. @author Avik Sengupta
  33636. </member>
  33637. <member name="M:NPOI.SS.Formula.PTG.UnaryPlusPtg.ToFormulaString(System.String[])">
  33638. implementation of method from OperationsPtg
  33639. </member>
  33640. <member name="T:NPOI.SS.Formula.PTG.UnionPtg">
  33641. @author Glen Stampoultzis (glens at apache.org)
  33642. </member>
  33643. <member name="M:NPOI.SS.Formula.PTG.UnionPtg.ToFormulaString(System.String[])">
  33644. implementation of method from OperationsPtg
  33645. </member>
  33646. <member name="T:NPOI.SS.Formula.PTG.UnknownPtg">
  33647. @author andy
  33648. @author Jason Height (jheight at chariot dot net dot au)
  33649. </member>
  33650. <member name="M:NPOI.SS.Formula.PTG.UnknownPtg.#ctor">
  33651. Creates new UnknownPtg
  33652. </member>
  33653. <member name="T:NPOI.SS.Formula.SheetNameFormatter">
  33654. Formats sheet names for use in formula expressions.
  33655. @author Josh Micich
  33656. </member>
  33657. <member name="M:NPOI.SS.Formula.SheetNameFormatter.Format(System.String)">
  33658. Used to format sheet names as they would appear in cell formula expressions.
  33659. @return the sheet name UnChanged if there is no need for delimiting. Otherwise the sheet
  33660. name is enclosed in single quotes ('). Any single quotes which were already present in the
  33661. sheet name will be converted to double single quotes ('').
  33662. </member>
  33663. <member name="M:NPOI.SS.Formula.SheetNameFormatter.AppendFormat(System.Text.StringBuilder,System.String)">
  33664. Convenience method for when a StringBuilder is already available
  33665. @param out - sheet name will be Appended here possibly with delimiting quotes
  33666. </member>
  33667. <member name="M:NPOI.SS.Formula.SheetNameFormatter.IsSpecialChar(System.Char)">
  33668. @return <c>true</c> if the presence of the specified Char in a sheet name would
  33669. require the sheet name to be delimited in formulas. This includes every non-alphanumeric
  33670. Char besides Underscore '_'.
  33671. </member>
  33672. <member name="M:NPOI.SS.Formula.SheetNameFormatter.CellReferenceIsWithinRange(System.String,System.String)">
  33673. Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they
  33674. look like cell references.
  33675. <p/>
  33676. This code is currently being used for translating formulas represented with <code>Ptg</code>
  33677. tokens into human readable text form. In formula expressions, a sheet name always has a
  33678. trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
  33679. method returns but it is worth noting the likely consumers of these formula text strings:
  33680. <ol>
  33681. <li>POI's own formula parser</li>
  33682. <li>Visual reading by human</li>
  33683. <li>VBA automation entry into Excel cell contents e.g. ActiveCell.Formula = "=c64!A1"</li>
  33684. <li>Manual entry into Excel cell contents</li>
  33685. <li>Some third party formula parser</li>
  33686. </ol>
  33687. At the time of writing, POI's formula parser tolerates cell-like sheet names in formulas
  33688. with or without delimiters. The same goes for Excel(2007), both manual and automated entry.
  33689. <p/>
  33690. For better or worse this implementation attempts to replicate Excel's formula renderer.
  33691. Excel uses range checking on the apparent 'row' and 'column' components. Note however that
  33692. the maximum sheet size varies across versions.
  33693. @see org.apache.poi.hssf.util.CellReference
  33694. </member>
  33695. <member name="M:NPOI.SS.Formula.SheetNameFormatter.NameLooksLikePlainCellReference(System.String)">
  33696. Note - this method assumes the specified rawSheetName has only letters and digits. It
  33697. cannot be used to match absolute or range references (using the dollar or colon char).
  33698. Some notable cases:
  33699. <blockquote><table border="0" cellpAdding="1" cellspacing="0"
  33700. summary="Notable cases.">
  33701. <tr><th>Input </th><th>Result </th><th>Comments</th></tr>
  33702. <tr><td>"A1" </td><td>true</td><td> </td></tr>
  33703. <tr><td>"a111" </td><td>true</td><td> </td></tr>
  33704. <tr><td>"AA" </td><td>false</td><td> </td></tr>
  33705. <tr><td>"aa1" </td><td>true</td><td> </td></tr>
  33706. <tr><td>"A1A" </td><td>false</td><td> </td></tr>
  33707. <tr><td>"A1A1" </td><td>false</td><td> </td></tr>
  33708. <tr><td>"A$1:$C$20" </td><td>false</td><td>Not a plain cell reference</td></tr>
  33709. <tr><td>"SALES20080101" </td><td>true</td>
  33710. <td>Still needs delimiting even though well out of range</td></tr>
  33711. </table></blockquote>
  33712. @return <c>true</c> if there is any possible ambiguity that the specified rawSheetName
  33713. could be interpreted as a valid cell name.
  33714. </member>
  33715. <member name="T:NPOI.SS.Formula.SheetRefEvaluator">
  33716. @author Josh Micich
  33717. </member>
  33718. <member name="M:NPOI.SS.Formula.SheetRefEvaluator.IsSubTotal(System.Int32,System.Int32)">
  33719. @return whether cell at rowIndex and columnIndex is a subtotal
  33720. @see org.apache.poi.ss.formula.functions.Subtotal
  33721. </member>
  33722. <member name="T:NPOI.SS.Formula.Udf.AggregatingUDFFinder">
  33723. Collects Add-in libraries and VB macro functions toGether into one UDF Finder
  33724. @author PUdalau
  33725. </member>
  33726. <member name="M:NPOI.SS.Formula.Udf.AggregatingUDFFinder.FindFunction(System.String)">
  33727. <summary>
  33728. Returns executor by specified name.
  33729. </summary>
  33730. <param name="name">Name of function.</param>
  33731. <returns>Function executor. null if not found</returns>
  33732. </member>
  33733. <member name="M:NPOI.SS.Formula.Udf.AggregatingUDFFinder.Add(NPOI.SS.Formula.Udf.UDFFinder)">
  33734. <summary>
  33735. Add a new toolpack
  33736. </summary>
  33737. <param name="toolPack"></param>
  33738. </member>
  33739. <member name="T:NPOI.SS.Formula.Udf.DefaultUDFFinder">
  33740. Default UDF Finder - for Adding your own user defined functions.
  33741. @author PUdalau
  33742. </member>
  33743. <member name="T:NPOI.SS.Formula.WorkbookEvaluator">
  33744. Evaluates formula cells.<p/>
  33745. For performance reasons, this class keeps a cache of all previously calculated intermediate
  33746. cell values. Be sure To call {@link #ClearCache()} if any workbook cells are Changed between
  33747. calls To evaluate~ methods on this class.<br/>
  33748. For POI internal use only
  33749. @author Josh Micich
  33750. </member>
  33751. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetName(System.Int32)">
  33752. also for debug use. Used in ToString methods
  33753. </member>
  33754. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.ClearAllCachedResultValues">
  33755. Should be called whenever there are Changes To input cells in the evaluated workbook.
  33756. Failure To call this method after changing cell values will cause incorrect behaviour
  33757. of the evaluate~ methods of this class
  33758. </member>
  33759. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyUpdateCell(NPOI.SS.Formula.IEvaluationCell)">
  33760. Should be called To tell the cell value cache that the specified (value or formula) cell
  33761. Has Changed.
  33762. </member>
  33763. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyDeleteCell(NPOI.SS.Formula.IEvaluationCell)">
  33764. Should be called To tell the cell value cache that the specified cell Has just been
  33765. deleted.
  33766. </member>
  33767. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetIndex(System.String)">
  33768. Case-insensitive.
  33769. @return -1 if sheet with specified name does not exist
  33770. </member>
  33771. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateAny(NPOI.SS.Formula.IEvaluationCell,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  33772. @return never <c>null</c>, never {@link BlankEval}
  33773. </member>
  33774. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.AddExceptionInfo(System.NotImplementedException,System.Int32,System.Int32,System.Int32)">
  33775. Adds the current cell reference to the exception for easier debugging.
  33776. Would be nice to get the formula text as well, but that seems to require
  33777. too much digging around and casting to get the FormulaRenderingWorkbook.
  33778. </member>
  33779. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetValueFromNonFormulaCell(NPOI.SS.Formula.IEvaluationCell)">
  33780. Gets the value from a non-formula cell.
  33781. @param cell may be <c>null</c>
  33782. @return {@link BlankEval} if cell is <c>null</c> or blank, never <c>null</c>
  33783. </member>
  33784. <member name="F:NPOI.SS.Formula.WorkbookEvaluator.dbgEvaluationOutputForNextEval">
  33785. whether print detailed messages about the next formula evaluation
  33786. </member>
  33787. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.CountTokensToBeSkipped(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  33788. Calculates the number of tokens that the evaluator should skip upon reaching a tAttrSkip.
  33789. @return the number of tokens (starting from <c>startIndex+1</c>) that need to be skipped
  33790. to achieve the specified <c>distInBytes</c> skip distance.
  33791. </member>
  33792. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.DereferenceResult(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33793. Dereferences a single value from any AreaEval or RefEval evaluation result.
  33794. If the supplied evaluationResult is just a plain value, it is returned as-is.
  33795. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>,
  33796. <c>BlankEval</c> or <c>ErrorEval</c>. Never <c>null</c>.
  33797. </member>
  33798. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetEvalForPtg(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.OperationEvaluationContext)">
  33799. returns an appropriate Eval impl instance for the Ptg. The Ptg must be
  33800. one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg,
  33801. StringPtg, BoolPtg <br/>special Note: OperationPtg subtypes cannot be
  33802. passed here!
  33803. </member>
  33804. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateReference(NPOI.SS.Formula.IEvaluationSheet,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  33805. Used by the lazy ref evals whenever they need To Get the value of a contained cell.
  33806. </member>
  33807. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSupportedFunctionNames">
  33808. Return a collection of functions that POI can evaluate
  33809. @return names of functions supported by POI
  33810. </member>
  33811. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetNotSupportedFunctionNames">
  33812. Return a collection of functions that POI does not support
  33813. @return names of functions NOT supported by POI
  33814. </member>
  33815. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  33816. Register a ATP function in runtime.
  33817. @param name the function name
  33818. @param func the functoin to register
  33819. @throws IllegalArgumentException if the function is unknown or already registered.
  33820. @since 3.8 beta6
  33821. </member>
  33822. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  33823. Register a function in runtime.
  33824. @param name the function name
  33825. @param func the functoin to register
  33826. @throws IllegalArgumentException if the function is unknown or already registered.
  33827. @since 3.8 beta6
  33828. </member>
  33829. <member name="P:NPOI.SS.Formula.WorkbookEvaluator.IgnoreMissingWorkbooks">
  33830. Whether to ignore missing references to external workbooks and
  33831. use cached formula results in the main workbook instead.
  33832. <p>
  33833. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  33834. With this method you can control how POI handles such missing references:
  33835. <ul>
  33836. <li>by default ignoreMissingWorkbooks=false and POI throws {@link WorkbookNotFoundException}
  33837. if an external reference cannot be resolved</li>
  33838. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  33839. that already exists in the main workbook</li>
  33840. </ul>
  33841. </p>
  33842. @param ignore whether to ignore missing references to external workbooks
  33843. @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575 for details</a>
  33844. </member>
  33845. <member name="T:NPOI.SS.SpreadsheetVersion">
  33846. This enum allows spReadsheets from multiple Excel versions to be handled by the common code.
  33847. Properties of this enum correspond to attributes of the <i>spReadsheet</i> that are easily
  33848. discernable to the user. It is not intended to deal with low-level issues like file formats.
  33849. <p/>
  33850. @author Josh Micich
  33851. @author Yegor Kozlov
  33852. </member>
  33853. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL97">
  33854. Excel97 format aka BIFF8
  33855. <ul>
  33856. <li>The total number of available columns is 256 (2^8)</li>
  33857. <li>The total number of available rows is 64k (2^16)</li>
  33858. <li>The maximum number of arguments to a function is 30</li>
  33859. <li>Number of conditional format conditions on a cell is 3</li>
  33860. <li>Length of text cell contents is unlimited </li>
  33861. <li>Length of text cell contents is 32767</li>
  33862. </ul>
  33863. </member>
  33864. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL2007">
  33865. Excel2007
  33866. <ul>
  33867. <li>The total number of available columns is 16K (2^14)</li>
  33868. <li>The total number of available rows is 1M (2^20)</li>
  33869. <li>The maximum number of arguments to a function is 255</li>
  33870. <li>Number of conditional format conditions on a cell is unlimited
  33871. (actually limited by available memory in Excel)</li>
  33872. <li>Length of text cell contents is unlimited </li>
  33873. </ul>
  33874. </member>
  33875. <member name="P:NPOI.SS.SpreadsheetVersion.MaxRows">
  33876. @return the maximum number of usable rows in each spReadsheet
  33877. </member>
  33878. <member name="P:NPOI.SS.SpreadsheetVersion.LastRowIndex">
  33879. @return the last (maximum) valid row index, equals to <code> GetMaxRows() - 1 </code>
  33880. </member>
  33881. <member name="P:NPOI.SS.SpreadsheetVersion.MaxColumns">
  33882. @return the maximum number of usable columns in each spReadsheet
  33883. </member>
  33884. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnIndex">
  33885. @return the last (maximum) valid column index, equals to <code> GetMaxColumns() - 1 </code>
  33886. </member>
  33887. <member name="P:NPOI.SS.SpreadsheetVersion.MaxFunctionArgs">
  33888. @return the maximum number arguments that can be passed to a multi-arg function (e.g. COUNTIF)
  33889. </member>
  33890. <member name="P:NPOI.SS.SpreadsheetVersion.MaxConditionalFormats">
  33891. @return the maximum number of conditional format conditions on a cell
  33892. </member>
  33893. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnName">
  33894. @return the last valid column index in a ALPHA-26 representation
  33895. (<code>IV</code> or <code>XFD</code>).
  33896. </member>
  33897. <member name="P:NPOI.SS.SpreadsheetVersion.MaxTextLength">
  33898. @return the maximum length of a text cell
  33899. </member>
  33900. <member name="T:NPOI.SS.UserModel.BorderStyle">
  33901. <summary>
  33902. The enumeration value indicating the line style of a border in a cell
  33903. </summary>
  33904. </member>
  33905. <member name="F:NPOI.SS.UserModel.BorderStyle.None">
  33906. <summary>
  33907. No border
  33908. </summary>
  33909. </member>
  33910. <member name="F:NPOI.SS.UserModel.BorderStyle.Thin">
  33911. <summary>
  33912. Thin border
  33913. </summary>
  33914. </member>
  33915. <member name="F:NPOI.SS.UserModel.BorderStyle.Medium">
  33916. <summary>
  33917. Medium border
  33918. </summary>
  33919. </member>
  33920. <member name="F:NPOI.SS.UserModel.BorderStyle.Dashed">
  33921. <summary>
  33922. dash border
  33923. </summary>
  33924. </member>
  33925. <member name="F:NPOI.SS.UserModel.BorderStyle.Dotted">
  33926. <summary>
  33927. dot border
  33928. </summary>
  33929. </member>
  33930. <member name="F:NPOI.SS.UserModel.BorderStyle.Thick">
  33931. <summary>
  33932. Thick border
  33933. </summary>
  33934. </member>
  33935. <member name="F:NPOI.SS.UserModel.BorderStyle.Double">
  33936. <summary>
  33937. double-line border
  33938. </summary>
  33939. </member>
  33940. <member name="F:NPOI.SS.UserModel.BorderStyle.Hair">
  33941. <summary>
  33942. hair-line border
  33943. </summary>
  33944. </member>
  33945. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashed">
  33946. <summary>
  33947. Medium dashed border
  33948. </summary>
  33949. </member>
  33950. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDot">
  33951. <summary>
  33952. dash-dot border
  33953. </summary>
  33954. </member>
  33955. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDot">
  33956. <summary>
  33957. medium dash-dot border
  33958. </summary>
  33959. </member>
  33960. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDotDot">
  33961. <summary>
  33962. dash-dot-dot border
  33963. </summary>
  33964. </member>
  33965. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDotDot">
  33966. <summary>
  33967. medium dash-dot-dot border
  33968. </summary>
  33969. </member>
  33970. <member name="F:NPOI.SS.UserModel.BorderStyle.SlantedDashDot">
  33971. <summary>
  33972. slanted dash-dot border
  33973. </summary>
  33974. </member>
  33975. <member name="T:NPOI.SS.UserModel.BuiltinFormats">
  33976. Utility to identify built-in formats. The following is a list of the formats as
  33977. returned by this class.<p/>
  33978. <p/>
  33979. 0, "General"<br/>
  33980. 1, "0"<br/>
  33981. 2, "0.00"<br/>
  33982. 3, "#,##0"<br/>
  33983. 4, "#,##0.00"<br/>
  33984. 5, "$#,##0_);($#,##0)"<br/>
  33985. 6, "$#,##0_);[Red]($#,##0)"<br/>
  33986. 7, "$#,##0.00);($#,##0.00)"<br/>
  33987. 8, "$#,##0.00_);[Red]($#,##0.00)"<br/>
  33988. 9, "0%"<br/>
  33989. 0xa, "0.00%"<br/>
  33990. 0xb, "0.00E+00"<br/>
  33991. 0xc, "# ?/?"<br/>
  33992. 0xd, "# ??/??"<br/>
  33993. 0xe, "m/d/yy"<br/>
  33994. 0xf, "d-mmm-yy"<br/>
  33995. 0x10, "d-mmm"<br/>
  33996. 0x11, "mmm-yy"<br/>
  33997. 0x12, "h:mm AM/PM"<br/>
  33998. 0x13, "h:mm:ss AM/PM"<br/>
  33999. 0x14, "h:mm"<br/>
  34000. 0x15, "h:mm:ss"<br/>
  34001. 0x16, "m/d/yy h:mm"<br/>
  34002. <p/>
  34003. // 0x17 - 0x24 reserved for international and undocumented
  34004. 0x25, "#,##0_);(#,##0)"<br/>
  34005. 0x26, "#,##0_);[Red](#,##0)"<br/>
  34006. 0x27, "#,##0.00_);(#,##0.00)"<br/>
  34007. 0x28, "#,##0.00_);[Red](#,##0.00)"<br/>
  34008. 0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"<br/>
  34009. 0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"<br/>
  34010. 0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"<br/>
  34011. 0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"<br/>
  34012. 0x2d, "mm:ss"<br/>
  34013. 0x2e, "[h]:mm:ss"<br/>
  34014. 0x2f, "mm:ss.0"<br/>
  34015. 0x30, "##0.0E+0"<br/>
  34016. 0x31, "@" - This is text format.<br/>
  34017. 0x31 "text" - Alias for "@"<br/>
  34018. <p/>
  34019. @author Yegor Kozlov
  34020. Modified 6/17/09 by Stanislav Shor - positive formats don't need starting '('
  34021. </member>
  34022. <member name="F:NPOI.SS.UserModel.BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX">
  34023. The first user-defined format starts at 164.
  34024. </member>
  34025. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormats">
  34026. @deprecated (May 2009) use {@link #getAll()}
  34027. </member>
  34028. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetAll">
  34029. @return array of built-in data formats
  34030. </member>
  34031. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.Int32)">
  34032. Get the format string that matches the given format index
  34033. @param index of a built in format
  34034. @return string represented at index of format or <code>null</code> if there is not a built-in format at that index
  34035. </member>
  34036. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.String)">
  34037. Get the format index that matches the given format string.
  34038. <p>
  34039. Automatically converts "text" to excel's format string to represent text.
  34040. </p>
  34041. @param pFmt string matching a built-in format
  34042. @return index of format or -1 if undefined.
  34043. </member>
  34044. <member name="T:NPOI.SS.UserModel.CellValue">
  34045. Mimics the 'data view' of a cell. This allows formula Evaluator
  34046. to return a CellValue instead of precasting the value to String
  34047. or Number or bool type.
  34048. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34049. </member>
  34050. <member name="P:NPOI.SS.UserModel.CellValue.BooleanValue">
  34051. @return Returns the boolValue.
  34052. </member>
  34053. <member name="P:NPOI.SS.UserModel.CellValue.NumberValue">
  34054. @return Returns the numberValue.
  34055. </member>
  34056. <member name="P:NPOI.SS.UserModel.CellValue.StringValue">
  34057. @return Returns the stringValue.
  34058. </member>
  34059. <member name="P:NPOI.SS.UserModel.CellValue.CellType">
  34060. @return Returns the cellType.
  34061. </member>
  34062. <member name="P:NPOI.SS.UserModel.CellValue.ErrorValue">
  34063. @return Returns the errorValue.
  34064. </member>
  34065. <member name="T:NPOI.SS.UserModel.IChart">
  34066. High level representation of a chart.
  34067. @author Roman Kashitsyn
  34068. </member>
  34069. <member name="T:NPOI.SS.UserModel.Charts.ManuallyPositionable">
  34070. Abstraction of chart element that can be positioned with manual
  34071. layout.
  34072. @author Roman Kashitsyn
  34073. </member>
  34074. <member name="M:NPOI.SS.UserModel.Charts.ManuallyPositionable.GetManualLayout">
  34075. Returns manual layout for the chart element.
  34076. @return manual layout for the chart element.
  34077. </member>
  34078. <member name="M:NPOI.SS.UserModel.IChart.GetChartDataFactory">
  34079. @return an appropriate ChartDataFactory implementation
  34080. </member>
  34081. <member name="M:NPOI.SS.UserModel.IChart.GetChartAxisFactory">
  34082. @return an appropriate ChartAxisFactory implementation
  34083. </member>
  34084. <member name="M:NPOI.SS.UserModel.IChart.GetOrCreateLegend">
  34085. @return chart legend instance
  34086. </member>
  34087. <member name="M:NPOI.SS.UserModel.IChart.DeleteLegend">
  34088. Delete current chart legend.
  34089. </member>
  34090. <member name="M:NPOI.SS.UserModel.IChart.GetAxis">
  34091. @return list of all chart axis
  34092. </member>
  34093. <member name="M:NPOI.SS.UserModel.IChart.Plot(NPOI.SS.UserModel.Charts.IChartData,NPOI.SS.UserModel.Charts.IChartAxis[])">
  34094. Plots specified data on the chart.
  34095. @param data a data to plot
  34096. </member>
  34097. <member name="T:NPOI.SS.UserModel.Charts.AxisCrossBetween">
  34098. Specifies the possible crossing states of an axis.
  34099. @author Roman Kashitsyn
  34100. </member>
  34101. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.Between">
  34102. Specifies the value axis shall cross the category axis
  34103. between data markers.
  34104. </member>
  34105. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.MidpointCategory">
  34106. Specifies the value axis shall cross the category axis at
  34107. the midpoint of a category.
  34108. </member>
  34109. <member name="T:NPOI.SS.UserModel.Charts.AxisCrosses">
  34110. Specifies the possible crossing points for an axis.
  34111. @author Roman Kashitsyn
  34112. </member>
  34113. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.AutoZero">
  34114. The category axis crosses at the zero point of the value axis (if
  34115. possible), or the minimum value (if the minimum is greater than zero) or
  34116. the maximum (if the maximum is less than zero).
  34117. </member>
  34118. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Min">
  34119. The axis crosses at the maximum value.
  34120. </member>
  34121. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Max">
  34122. Axis crosses at the minimum value of the chart.
  34123. </member>
  34124. <member name="T:NPOI.SS.UserModel.Charts.AxisOrientation">
  34125. Specifies the possible ways to place a picture on a data point, series, wall, or floor.
  34126. @author Roman Kashitsyn
  34127. </member>
  34128. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MaxToMin">
  34129. Specifies that the values on the axis shall be reversed
  34130. so they go from maximum to minimum.
  34131. </member>
  34132. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MinToMax">
  34133. Specifies that the axis values shall be in the usual
  34134. order, minimum to maximum.
  34135. </member>
  34136. <member name="T:NPOI.SS.UserModel.Charts.AxisPosition">
  34137. Enumeration of all possible axis positions.
  34138. @author Roman Kashitsyn
  34139. </member>
  34140. <member name="T:NPOI.SS.UserModel.Charts.IChartAxis">
  34141. High level representation of chart axis.
  34142. @author Roman Kashitsyn
  34143. </member>
  34144. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetId">
  34145. @return axis id
  34146. </member>
  34147. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetPosition">
  34148. @return axis position
  34149. </member>
  34150. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.SetPosition(NPOI.SS.UserModel.Charts.AxisPosition)">
  34151. @param position new axis position
  34152. </member>
  34153. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetNumberFormat">
  34154. @return axis number format
  34155. </member>
  34156. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.SetNumberFormat(System.String)">
  34157. @param format axis number format
  34158. </member>
  34159. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.IsSetLogBase">
  34160. @return true if log base is defined, false otherwise
  34161. </member>
  34162. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.SetLogBase(System.Double)">
  34163. @param logBase a number between 2 and 1000 (inclusive)
  34164. @throws ArgumentException if log base not within allowed range
  34165. </member>
  34166. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetLogBase">
  34167. @return axis log base or 0.0 if not Set
  34168. </member>
  34169. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMinimum">
  34170. @return true if minimum value is defined, false otherwise
  34171. </member>
  34172. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetMinimum">
  34173. @return axis minimum or 0.0 if not Set
  34174. </member>
  34175. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.SetMinimum(System.Double)">
  34176. @param min axis minimum
  34177. </member>
  34178. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMaximum">
  34179. @return true if maximum value is defined, false otherwise
  34180. </member>
  34181. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetMaximum">
  34182. @return axis maximum or 0.0 if not Set
  34183. </member>
  34184. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.SetMaximum(System.Double)">
  34185. @param max axis maximum
  34186. </member>
  34187. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetOrientation">
  34188. @return axis orientation
  34189. </member>
  34190. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.SetOrientation(NPOI.SS.UserModel.Charts.AxisOrientation)">
  34191. @param orientation axis orientation
  34192. </member>
  34193. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.SetCrosses(NPOI.SS.UserModel.Charts.AxisCrosses)">
  34194. @param crosses axis cross type
  34195. </member>
  34196. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.GetCrosses">
  34197. @return axis cross type
  34198. </member>
  34199. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.CrossAxis(NPOI.SS.UserModel.Charts.IChartAxis)">
  34200. Declare this axis cross another axis.
  34201. @param axis that this axis should cross
  34202. </member>
  34203. <member name="T:NPOI.SS.UserModel.Charts.IChartAxisFactory">
  34204. <summary>
  34205. A factory for different chart axis.
  34206. </summary>
  34207. <remarks>@author Roman Kashitsyn</remarks>
  34208. </member>
  34209. <member name="M:NPOI.SS.UserModel.Charts.IChartAxisFactory.CreateValueAxis(NPOI.SS.UserModel.Charts.AxisPosition)">
  34210. <summary>
  34211. returns new value axis
  34212. </summary>
  34213. <param name="pos"></param>
  34214. <returns></returns>
  34215. </member>
  34216. <member name="T:NPOI.SS.UserModel.Charts.IChartData">
  34217. <summary>
  34218. A base for all chart data types.
  34219. </summary>
  34220. <remarks>
  34221. @author Roman Kashitsyn
  34222. </remarks>
  34223. </member>
  34224. <member name="M:NPOI.SS.UserModel.Charts.IChartData.FillChart(NPOI.SS.UserModel.IChart,NPOI.SS.UserModel.Charts.IChartAxis[])">
  34225. <summary>
  34226. Fills a chart with data specified by implementation.
  34227. </summary>
  34228. <param name="chart">a chart to fill in</param>
  34229. <param name="axis">chart axis to use</param>
  34230. </member>
  34231. <member name="T:NPOI.SS.UserModel.Charts.IChartDataFactory">
  34232. <summary>
  34233. A factory for different chart data types.
  34234. </summary>
  34235. <remarks>
  34236. @author Roman Kashitsyn
  34237. </remarks>
  34238. </member>
  34239. <member name="M:NPOI.SS.UserModel.Charts.IChartDataFactory.CreateScatterChartData``2">
  34240. <summary>
  34241. returns an appropriate ScatterChartData instance
  34242. </summary>
  34243. <returns></returns>
  34244. </member>
  34245. <member name="T:NPOI.SS.UserModel.Charts.IChartLegend">
  34246. <summary>
  34247. High level representation of chart legend.
  34248. </summary>
  34249. <remarks>@author Roman Kashitsyn</remarks>
  34250. </member>
  34251. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.Position">
  34252. <summary>
  34253. legend position
  34254. </summary>
  34255. <returns></returns>
  34256. </member>
  34257. <member name="T:NPOI.SS.UserModel.Charts.LayoutMode">
  34258. <summary>
  34259. Specifies the possible ways to store a chart element's position.
  34260. </summary>
  34261. <remarks>
  34262. @author Roman Kashitsyn
  34263. </remarks>
  34264. </member>
  34265. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Edge">
  34266. <summary>
  34267. Specifies that the Width or Height shall be interpreted as the Right or Bottom of the chart element.
  34268. </summary>
  34269. </member>
  34270. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Factor">
  34271. <summary>
  34272. Specifies that the Width or Height shall be interpreted as the width or Height of the chart element.
  34273. </summary>
  34274. </member>
  34275. <member name="T:NPOI.SS.UserModel.Charts.LayoutTarget">
  34276. <summary>
  34277. Specifies whether to layout the plot area by its inside (not including axis
  34278. and axis labels) or outside (including axis and axis labels).
  34279. </summary>
  34280. <remarks>
  34281. @author Roman Kashitsyn
  34282. </remarks>
  34283. </member>
  34284. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Inner">
  34285. <summary>
  34286. Specifies that the plot area size shall determine the size of the plot area, not including the tick marks and axis labels.
  34287. </summary>
  34288. </member>
  34289. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Outer">
  34290. <summary>
  34291. Specifies that the plot area size shall determine the
  34292. size of the plot area, the tick marks, and the axis
  34293. labels.
  34294. </summary>
  34295. </member>
  34296. <member name="T:NPOI.SS.UserModel.Charts.LegendPosition">
  34297. <summary>
  34298. Enumeration of all possible chart legend positions.
  34299. </summary>
  34300. <remarks>
  34301. @author Roman Kashitsyn
  34302. </remarks>
  34303. </member>
  34304. <member name="T:NPOI.SS.UserModel.Charts.IManualLayout">
  34305. High level representation of chart element manual layout.
  34306. @author Roman Kashitsyn
  34307. </member>
  34308. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetTarget(NPOI.SS.UserModel.Charts.LayoutTarget)">
  34309. Sets the layout target.
  34310. @param target new layout target.
  34311. </member>
  34312. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetTarget">
  34313. Returns current layout target.
  34314. @return current layout target
  34315. </member>
  34316. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetXMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  34317. Sets the x-coordinate layout mode.
  34318. @param mode new x-coordinate layout mode.
  34319. </member>
  34320. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetXMode">
  34321. Returns current x-coordinnate layout mode.
  34322. @return current x-coordinate layout mode.
  34323. </member>
  34324. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetYMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  34325. Sets the y-coordinate layout mode.
  34326. @param mode new y-coordinate layout mode.
  34327. </member>
  34328. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetYMode">
  34329. Returns current y-coordinate layout mode.
  34330. @return current y-coordinate layout mode.
  34331. </member>
  34332. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetX">
  34333. Returns the x location of the chart element.
  34334. @return the x location (left) of the chart element or 0.0 if
  34335. not Set.
  34336. </member>
  34337. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetX(System.Double)">
  34338. Specifies the x location (left) of the chart element as a
  34339. fraction of the width of the chart. If Left Mode is Factor,
  34340. then the position is relative to the default position for the
  34341. chart element.
  34342. </member>
  34343. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetY">
  34344. Returns current y location of the chart element.
  34345. @return the y location (top) of the chart element or 0.0 if not
  34346. Set.
  34347. </member>
  34348. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetY(System.Double)">
  34349. Specifies the y location (top) of the chart element as a
  34350. fraction of the height of the chart. If Top Mode is Factor,
  34351. then the position is relative to the default position for the
  34352. chart element.
  34353. </member>
  34354. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  34355. Specifies how to interpret the Width element for this manual
  34356. layout.
  34357. @param mode new width layout mode of this manual layout.
  34358. </member>
  34359. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthMode">
  34360. Returns current width mode of this manual layout.
  34361. @return width mode of this manual layout.
  34362. </member>
  34363. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  34364. Specifies how to interpret the Height element for this manual
  34365. layout.
  34366. @param mode new height mode of this manual layout.
  34367. </member>
  34368. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightMode">
  34369. Returns current height mode of this
  34370. @return height mode of this manual layout.
  34371. </member>
  34372. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthRatio(System.Double)">
  34373. Specifies the width (if Width Mode is Factor) or right (if
  34374. Width Mode is Edge) of the chart element as a fraction of the
  34375. width of the chart.
  34376. @param ratio a fraction of the width of the chart.
  34377. </member>
  34378. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthRatio">
  34379. Returns current fraction of the width of the chart.
  34380. @return fraction of the width of the chart or 0.0 if not Set.
  34381. </member>
  34382. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightRatio(System.Double)">
  34383. Specifies the height (if Height Mode is Factor) or bottom (if
  34384. Height Mode is edge) of the chart element as a fraction of the
  34385. height of the chart.
  34386. @param ratio a fraction of the height of the chart.
  34387. </member>
  34388. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightRatio">
  34389. Returns current fraction of the height of the chart.
  34390. @return fraction of the height of the chart or 0.0 if not Set.
  34391. </member>
  34392. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartData`2">
  34393. @author Roman Kashitsyn
  34394. </member>
  34395. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.AddSerie(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  34396. @param xs data source to be used for X axis values
  34397. @param ys data source to be used for Y axis values
  34398. @return a new scatter charts serie
  34399. </member>
  34400. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.GetSeries">
  34401. @return list of all series
  34402. </member>
  34403. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartSerie`2">
  34404. Represents scatter charts serie.
  34405. @author Roman Kashitsyn
  34406. </member>
  34407. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSerie`2.GetXValues">
  34408. @return data source used for X axis values
  34409. </member>
  34410. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSerie`2.GetYValues">
  34411. @return data source used for Y axis values
  34412. </member>
  34413. <member name="T:NPOI.SS.UserModel.Charts.IValueAxis">
  34414. @author Roman Kashitsyn
  34415. </member>
  34416. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.GetCrossBetween">
  34417. @return cross between type
  34418. </member>
  34419. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.SetCrossBetween(NPOI.SS.UserModel.Charts.AxisCrossBetween)">
  34420. @param crossBetween cross between type
  34421. </member>
  34422. <member name="F:NPOI.SS.UserModel.AnchorType.MoveAndResize">
  34423. Move and Resize With Anchor Cells
  34424. <p>
  34425. Specifies that the current drawing shall move and
  34426. resize to maintain its row and column anchors (i.e. the
  34427. object is anchored to the actual from and to row and column)
  34428. </p>
  34429. </member>
  34430. <member name="F:NPOI.SS.UserModel.AnchorType.MoveDontResize">
  34431. Move With Cells but Do Not Resize
  34432. <p>
  34433. Specifies that the current drawing shall move with its
  34434. row and column (i.e. the object is anchored to the
  34435. actual from row and column), but that the size shall remain absolute.
  34436. </p>
  34437. <p>
  34438. If Additional rows/columns are Added between the from and to locations of the drawing,
  34439. the drawing shall move its to anchors as needed to maintain this same absolute size.
  34440. </p>
  34441. </member>
  34442. <member name="F:NPOI.SS.UserModel.AnchorType.DontMoveAndResize">
  34443. Do Not Move or Resize With Underlying Rows/Columns
  34444. <p>
  34445. Specifies that the current start and end positions shall
  34446. be maintained with respect to the distances from the
  34447. absolute start point of the worksheet.
  34448. </p>
  34449. <p>
  34450. If Additional rows/columns are Added before the
  34451. drawing, the drawing shall move its anchors as needed
  34452. to maintain this same absolute position.
  34453. </p>
  34454. </member>
  34455. <member name="T:NPOI.SS.UserModel.ComparisonOperator">
  34456. The conditional format operators used for "Highlight Cells That Contain..." rules.
  34457. <p>
  34458. For example, "highlight cells that begin with "M2" and contain "Mountain Gear".
  34459. </p>
  34460. @author Dmitriy Kumshayev
  34461. @author Yegor Kozlov
  34462. </member>
  34463. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Between">
  34464. 'Between' operator
  34465. </member>
  34466. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotBetween">
  34467. 'Not between' operator
  34468. </member>
  34469. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Equal">
  34470. 'Equal to' operator
  34471. </member>
  34472. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotEqual">
  34473. 'Not equal to' operator
  34474. </member>
  34475. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThan">
  34476. 'Greater than' operator
  34477. </member>
  34478. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThan">
  34479. 'Less than' operator
  34480. </member>
  34481. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThanOrEqual">
  34482. 'Greater than or equal to' operator
  34483. </member>
  34484. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThanOrEqual">
  34485. 'Less than or equal to' operator
  34486. </member>
  34487. <member name="F:NPOI.SS.UserModel.ConditionType.None">
  34488. <summary>
  34489. Allow accessing the Initial value.
  34490. </summary>
  34491. </member>
  34492. <member name="F:NPOI.SS.UserModel.ConditionType.CellValueIs">
  34493. This conditional formatting rule Compares a cell value
  34494. to a formula calculated result, using an operator
  34495. </member>
  34496. <member name="F:NPOI.SS.UserModel.ConditionType.Formula">
  34497. This conditional formatting rule Contains a formula to Evaluate.
  34498. When the formula result is true, the cell is highlighted.
  34499. </member>
  34500. <member name="T:NPOI.SS.UserModel.ERRORSTYLE">
  34501. Error style constants for error box
  34502. </member>
  34503. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.STOP">
  34504. STOP style
  34505. </member>
  34506. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.WARNING">
  34507. WARNING style
  34508. </member>
  34509. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.INFO">
  34510. INFO style
  34511. </member>
  34512. <member name="T:NPOI.SS.UserModel.ValidationType">
  34513. ValidationType enum
  34514. </member>
  34515. <member name="F:NPOI.SS.UserModel.ValidationType.ANY">
  34516. 'Any value' type - value not restricted
  34517. </member>
  34518. <member name="F:NPOI.SS.UserModel.ValidationType.INTEGER">
  34519. int ('Whole number') type
  34520. </member>
  34521. <member name="F:NPOI.SS.UserModel.ValidationType.DECIMAL">
  34522. Decimal type
  34523. </member>
  34524. <member name="F:NPOI.SS.UserModel.ValidationType.LIST">
  34525. List type ( combo box type )
  34526. </member>
  34527. <member name="F:NPOI.SS.UserModel.ValidationType.DATE">
  34528. Date type
  34529. </member>
  34530. <member name="F:NPOI.SS.UserModel.ValidationType.TIME">
  34531. Time type
  34532. </member>
  34533. <member name="F:NPOI.SS.UserModel.ValidationType.TEXT_LENGTH">
  34534. String length type
  34535. </member>
  34536. <member name="F:NPOI.SS.UserModel.ValidationType.FORMULA">
  34537. Formula ( 'Custom' ) type
  34538. </member>
  34539. <member name="T:NPOI.SS.UserModel.OperatorType">
  34540. Condition operator enum
  34541. </member>
  34542. <member name="F:NPOI.SS.UserModel.OperatorType.IGNORED">
  34543. default value to supply when the operator type is not used
  34544. </member>
  34545. <member name="T:NPOI.SS.UserModel.ErrorConstants">
  34546. Contains raw Excel error codes (as defined in OOO's excelfileformat.pdf (2.5.6)
  34547. @author Michael Harhen
  34548. </member>
  34549. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NULL">
  34550. <b>#NULL!</b> - Intersection of two cell ranges is empty
  34551. </member>
  34552. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_DIV_0">
  34553. <b>#DIV/0!</b> - Division by zero
  34554. </member>
  34555. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_VALUE">
  34556. <b>#VALUE!</b> - Wrong type of operand
  34557. </member>
  34558. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_REF">
  34559. <b>#REF!</b> - Illegal or deleted cell reference
  34560. </member>
  34561. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NAME">
  34562. <b>#NAME?</b> - Wrong function or range name
  34563. </member>
  34564. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NUM">
  34565. <b>#NUM!</b> - Value range overflow
  34566. </member>
  34567. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NA">
  34568. <b>#N/A</b> - Argument or function not available
  34569. </member>
  34570. <member name="M:NPOI.SS.UserModel.ErrorConstants.GetText(System.Int32)">
  34571. @return Standard Excel error literal for the specified error code.
  34572. @throws ArgumentException if the specified error code is not one of the 7
  34573. standard error codes
  34574. </member>
  34575. <member name="M:NPOI.SS.UserModel.ErrorConstants.IsValidCode(System.Int32)">
  34576. @return <c>true</c> if the specified error code is a standard Excel error code.
  34577. </member>
  34578. <member name="T:NPOI.SS.UserModel.ExcelStyleDateFormatter">
  34579. A wrapper around a {@link SimpleDateFormat} instance,
  34580. which handles a few Excel-style extensions that
  34581. are not supported by {@link SimpleDateFormat}.
  34582. Currently, the extensions are around the handling
  34583. of elapsed time, eg rendering 1 day 2 hours
  34584. as 26 hours.
  34585. </member>
  34586. <member name="T:NPOI.SS.Util.FormatBase">
  34587. <summary>
  34588. A substitute class for Format class in Java
  34589. </summary>
  34590. </member>
  34591. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.ProcessFormatPattern(System.String)">
  34592. Takes a format String, and Replaces Excel specific bits
  34593. with our detection sequences
  34594. </member>
  34595. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.SetDateToBeFormatted(System.Double)">
  34596. Used to let us know what the date being
  34597. formatted is, in Excel terms, which we
  34598. may wish to use when handling elapsed
  34599. times.
  34600. </member>
  34601. <member name="F:NPOI.SS.UserModel.FontUnderlineType.None">
  34602. not underlined
  34603. </member>
  34604. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Single">
  34605. single (normal) underline
  34606. </member>
  34607. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Double">
  34608. double underlined
  34609. </member>
  34610. <member name="F:NPOI.SS.UserModel.FontUnderlineType.SingleAccounting">
  34611. accounting style single underline
  34612. </member>
  34613. <member name="F:NPOI.SS.UserModel.FontUnderlineType.DoubleAccounting">
  34614. accounting style double underline
  34615. </member>
  34616. <member name="F:NPOI.SS.UserModel.FontSuperScript.None">
  34617. no type Offsetting (not super or subscript)
  34618. </member>
  34619. <member name="F:NPOI.SS.UserModel.FontSuperScript.Super">
  34620. superscript
  34621. </member>
  34622. <member name="F:NPOI.SS.UserModel.FontSuperScript.Sub">
  34623. subscript
  34624. </member>
  34625. <member name="F:NPOI.SS.UserModel.FontColor.None">
  34626. <summary>
  34627. Allow accessing the Initial value.
  34628. </summary>
  34629. </member>
  34630. <member name="F:NPOI.SS.UserModel.FontColor.Normal">
  34631. normal type of black color.
  34632. </member>
  34633. <member name="F:NPOI.SS.UserModel.FontColor.Red">
  34634. Dark Red color
  34635. </member>
  34636. <member name="F:NPOI.SS.UserModel.FontBoldWeight.None">
  34637. <summary>
  34638. Allow accessing the Initial value.
  34639. </summary>
  34640. </member>
  34641. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Normal">
  34642. Normal boldness (not bold)
  34643. </member>
  34644. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Bold">
  34645. Bold boldness (bold)
  34646. </member>
  34647. <member name="T:NPOI.SS.UserModel.FontCharset">
  34648. Charset represents the basic set of characters associated with a font (that it can display), and
  34649. corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language.
  34650. @author Gisella Bronzetti
  34651. </member>
  34652. <member name="P:NPOI.SS.UserModel.FontCharset.Value">
  34653. Returns value of this charset
  34654. @return value of this charset
  34655. </member>
  34656. <member name="T:NPOI.SS.UserModel.FontFamily">
  34657. The font family this font belongs to. A font family is a set of fonts having common stroke width and serif
  34658. characteristics. The font name overrides when there are conflicting values.
  34659. @author Gisella Bronzetti
  34660. </member>
  34661. <member name="P:NPOI.SS.UserModel.FontFamily.Value">
  34662. Returns index of this font family
  34663. @return index of this font family
  34664. </member>
  34665. <member name="T:NPOI.SS.UserModel.FontScheme">
  34666. Defines the font scheme to which this font belongs.
  34667. When a font defInition is part of a theme defInition, then the font is categorized as either a major or minor font scheme component.
  34668. 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
  34669. theme.
  34670. Usually major fonts are used for styles like headings, and minor fonts are used for body and paragraph text.
  34671. @author Gisella Bronzetti
  34672. </member>
  34673. <member name="T:NPOI.SS.UserModel.FormulaError">
  34674. Enumerates error values in SpreadsheetML formula calculations.
  34675. @author Yegor Kozlov
  34676. </member>
  34677. <member name="F:NPOI.SS.UserModel.FormulaError.NULL">
  34678. Intended to indicate when two areas are required to intersect, but do not.
  34679. <p>Example:
  34680. In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary
  34681. intersection operator, when a comma was intended. end example]
  34682. </p>
  34683. </member>
  34684. <member name="F:NPOI.SS.UserModel.FormulaError.DIV0">
  34685. Intended to indicate when any number, including zero, is divided by zero.
  34686. Note: However, any error code divided by zero results in that error code.
  34687. </member>
  34688. <member name="F:NPOI.SS.UserModel.FormulaError.VALUE">
  34689. Intended to indicate when an incompatible type argument is passed to a function, or
  34690. an incompatible type operand is used with an operator.
  34691. <p>Example:
  34692. In the case of a function argument, text was expected, but a number was provided
  34693. </p>
  34694. </member>
  34695. <member name="F:NPOI.SS.UserModel.FormulaError.REF">
  34696. Intended to indicate when a cell reference is invalid.
  34697. <p>Example:
  34698. If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted,
  34699. a #REF! error results. If a worksheet does not support 20,001 columns,
  34700. OFFSET(A1,0,20000) will result in a #REF! error.
  34701. </p>
  34702. </member>
  34703. <member name="F:NPOI.SS.UserModel.FormulaError.NUM">
  34704. Intended to indicate when an argument to a function has a compatible type, but has a
  34705. value that is outside the domain over which that function is defined. (This is known as
  34706. a domain error.)
  34707. <p>Example:
  34708. Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
  34709. </p>
  34710. Intended to indicate that the result of a function cannot be represented in a value of
  34711. the specified type, typically due to extreme magnitude. (This is known as a range
  34712. error.)
  34713. <p>Example: FACT(1000) might result in a range error. </p>
  34714. </member>
  34715. <member name="F:NPOI.SS.UserModel.FormulaError.NA">
  34716. Intended to indicate when a designated value is not available.
  34717. <p>Example:
  34718. Some functions, such as SUMX2MY2, perform a series of operations on corresponding
  34719. elements in two arrays. If those arrays do not have the same number of elements, then
  34720. for some elements in the longer array, there are no corresponding elements in the
  34721. shorter one; that is, one or more values in the shorter array are not available.
  34722. </p>
  34723. This error value can be produced by calling the function NA
  34724. </member>
  34725. <member name="P:NPOI.SS.UserModel.FormulaError.Code">
  34726. @return numeric code of the error
  34727. </member>
  34728. <member name="P:NPOI.SS.UserModel.FormulaError.String">
  34729. @return string representation of the error
  34730. </member>
  34731. <member name="T:NPOI.SS.UserModel.HorizontalAlignment">
  34732. The enumeration value indicating horizontal alignment of a cell,
  34733. i.e., whether it is aligned general, left, right, horizontally centered, Filled (replicated),
  34734. justified, centered across multiple cells, or distributed.
  34735. </member>
  34736. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.General">
  34737. The horizontal alignment is general-aligned. Text data is left-aligned.
  34738. Numbers, dates, and times are rightaligned. Boolean types are centered.
  34739. Changing the alignment does not change the type of data.
  34740. </member>
  34741. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Left">
  34742. The horizontal alignment is left-aligned, even in Rightto-Left mode.
  34743. Aligns contents at the left edge of the cell. If an indent amount is specified, the contents of
  34744. the cell is indented from the left by the specified number of character spaces. The character spaces are
  34745. based on the default font and font size for the workbook.
  34746. </member>
  34747. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Center">
  34748. The horizontal alignment is centered, meaning the text is centered across the cell.
  34749. </member>
  34750. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Right">
  34751. The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell,
  34752. even in Right-to-Left mode.
  34753. </member>
  34754. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Justify">
  34755. The horizontal alignment is justified (flush left and right).
  34756. For each line of text, aligns each line of the wrapped text in a cell to the right and left
  34757. (except the last line). If no single line of text wraps in the cell, then the text is not justified.
  34758. </member>
  34759. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Fill">
  34760. Indicates that the value of the cell should be Filled
  34761. across the entire width of the cell. If blank cells to the right also have the fill alignment,
  34762. they are also Filled with the value, using a convention similar to centerContinuous.
  34763. <p>
  34764. Additional rules:
  34765. <ol>
  34766. <li>Only whole values can be Appended, not partial values.</li>
  34767. <li>The column will not be widened to 'best fit' the Filled value</li>
  34768. <li>If Appending an Additional occurrence of the value exceeds the boundary of the cell
  34769. left/right edge, don't append the Additional occurrence of the value.</li>
  34770. <li>The display value of the cell is Filled, not the underlying raw number.</li>
  34771. </ol>
  34772. </p>
  34773. </member>
  34774. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.CenterSelection">
  34775. The horizontal alignment is centered across multiple cells.
  34776. The information about how many cells to span is expressed in the Sheet Part,
  34777. in the row of the cell in question. For each cell that is spanned in the alignment,
  34778. a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.
  34779. </member>
  34780. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Distributed">
  34781. Indicates that each 'word' in each line of text inside the cell is evenly distributed
  34782. across the width of the cell, with flush right and left margins.
  34783. <p>
  34784. When there is also an indent value to apply, both the left and right side of the cell
  34785. are pAdded by the indent value.
  34786. </p>
  34787. <p> A 'word' is a set of characters with no space character in them. </p>
  34788. <p> Two lines inside a cell are Separated by a carriage return. </p>
  34789. </member>
  34790. <member name="F:NPOI.SS.UserModel.HyperlinkType.Url">
  34791. <summary>
  34792. Link to an existing file or web page
  34793. </summary>
  34794. </member>
  34795. <member name="F:NPOI.SS.UserModel.HyperlinkType.Document">
  34796. <summary>
  34797. Link to a place in this document
  34798. </summary>
  34799. </member>
  34800. <member name="F:NPOI.SS.UserModel.HyperlinkType.Email">
  34801. <summary>
  34802. Link to an E-mail Address
  34803. </summary>
  34804. </member>
  34805. <member name="F:NPOI.SS.UserModel.HyperlinkType.File">
  34806. <summary>
  34807. Link to a file
  34808. </summary>
  34809. </member>
  34810. <member name="T:NPOI.SS.UserModel.IndexedColors">
  34811. A deprecated indexing scheme for colours that is still required for some records, and for backwards
  34812. compatibility with OLE2 formats.
  34813. <p>
  34814. Each element corresponds to a color index (zero-based). When using the default indexed color palette,
  34815. the values are not written out, but instead are implied. When the color palette has been modified from default,
  34816. then the entire color palette is used.
  34817. </p>
  34818. @author Yegor Kozlov
  34819. </member>
  34820. <member name="P:NPOI.SS.UserModel.IndexedColors.Index">
  34821. Returns index of this color
  34822. @return index of this color
  34823. </member>
  34824. <member name="T:NPOI.SS.UserModel.PageOrder">
  34825. Specifies printed page order.
  34826. @author Gisella Bronzetti
  34827. </member>
  34828. <member name="F:NPOI.SS.UserModel.PageOrder.DOWN_THEN_OVER">
  34829. Order pages vertically first, then move horizontally.
  34830. </member>
  34831. <member name="F:NPOI.SS.UserModel.PageOrder.OVER_THEN_DOWN">
  34832. Order pages horizontally first, then move vertically
  34833. </member>
  34834. <member name="T:NPOI.SS.UserModel.PaperSize">
  34835. The enumeration value indicating the possible paper size for a sheet
  34836. @author Daniele Montagni
  34837. </member>
  34838. <member name="F:NPOI.SS.UserModel.PaperSize.US_Letter">
  34839. <summary>
  34840. Allow accessing the Initial value.
  34841. </summary>
  34842. </member>
  34843. <member name="F:NPOI.SS.UserModel.PaperSize.A4_TRANSVERSE_PAPERSIZE">
  34844. <summary>
  34845. A4 Transverse - 210x297 mm
  34846. </summary>
  34847. </member>
  34848. <member name="F:NPOI.SS.UserModel.PaperSize.A4_PLUS_PAPERSIZE">
  34849. <summary>
  34850. A4 Plus - 210x330 mm
  34851. </summary>
  34852. </member>
  34853. <member name="F:NPOI.SS.UserModel.PaperSize.LETTER_ROTATED_PAPERSIZE">
  34854. <summary>
  34855. US Letter Rotated 11 x 8 1/2 in
  34856. </summary>
  34857. </member>
  34858. <member name="F:NPOI.SS.UserModel.PaperSize.A4_ROTATED_PAPERSIZE">
  34859. <summary>
  34860. A4 Rotated - 297x210 mm */
  34861. </summary>
  34862. </member>
  34863. <member name="F:NPOI.SS.UserModel.PictureType.None">
  34864. <summary>
  34865. Allow accessing the Initial value.
  34866. </summary>
  34867. </member>
  34868. <member name="F:NPOI.SS.UserModel.PictureType.EMF">
  34869. Extended windows meta file
  34870. </member>
  34871. <member name="F:NPOI.SS.UserModel.PictureType.WMF">
  34872. Windows Meta File
  34873. </member>
  34874. <member name="F:NPOI.SS.UserModel.PictureType.PICT">
  34875. Mac PICT format
  34876. </member>
  34877. <member name="F:NPOI.SS.UserModel.PictureType.JPEG">
  34878. JPEG format
  34879. </member>
  34880. <member name="F:NPOI.SS.UserModel.PictureType.PNG">
  34881. PNG format
  34882. </member>
  34883. <member name="F:NPOI.SS.UserModel.PictureType.DIB">
  34884. Device independant bitmap
  34885. </member>
  34886. <member name="T:NPOI.SS.UserModel.PrintCellComments">
  34887. These enumerations specify how cell comments shall be displayed for paper printing purposes.
  34888. @author Gisella Bronzetti
  34889. </member>
  34890. <member name="F:NPOI.SS.UserModel.PrintCellComments.NONE">
  34891. Do not print cell comments.
  34892. </member>
  34893. <member name="F:NPOI.SS.UserModel.PrintCellComments.AS_DISPLAYED">
  34894. Print cell comments as displayed.
  34895. </member>
  34896. <member name="F:NPOI.SS.UserModel.PrintCellComments.AT_END">
  34897. Print cell comments at end of document.
  34898. </member>
  34899. <member name="T:NPOI.SS.UserModel.PrintOrientation">
  34900. The enumeration value indicating the print orientation for a sheet.
  34901. @author Gisella Bronzetti
  34902. </member>
  34903. <member name="F:NPOI.SS.UserModel.PrintOrientation.DEFAULT">
  34904. orientation not specified
  34905. </member>
  34906. <member name="F:NPOI.SS.UserModel.PrintOrientation.PORTRAIT">
  34907. portrait orientation
  34908. </member>
  34909. <member name="F:NPOI.SS.UserModel.PrintOrientation.LANDSCAPE">
  34910. landscape orientations
  34911. </member>
  34912. <member name="T:NPOI.SS.UserModel.DisplayCellErrorType">
  34913. <summary>
  34914. Used by HSSFPrintSetup.CellError property
  34915. </summary>
  34916. </member>
  34917. <member name="T:NPOI.SS.UserModel.MissingCellPolicy">
  34918. <summary>
  34919. Used to specify the different possible policies
  34920. if for the case of null and blank cells
  34921. </summary>
  34922. </member>
  34923. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK">
  34924. <summary>Missing cells are returned as null, Blank cells are returned as normal</summary>
  34925. </member>
  34926. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL">
  34927. <summary>Missing cells are returned as null, as are blank cells</summary>
  34928. </member>
  34929. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK">
  34930. <summary>A new, blank cell is Created for missing cells. Blank cells are returned as normal</summary>
  34931. </member>
  34932. <member name="T:NPOI.SS.UserModel.ShapeTypes">
  34933. All known types of automatic shapes in DrawingML
  34934. @author Yegor Kozlov
  34935. </member>
  34936. <member name="F:NPOI.SS.UserModel.ShapeTypes.None">
  34937. <summary>
  34938. Allow accessing the Initial value.
  34939. </summary>
  34940. </member>
  34941. <member name="T:NPOI.SS.UserModel.MarginType">
  34942. <summary>
  34943. Indicate the position of the margin. One of left, right, top and bottom.
  34944. </summary>
  34945. </member>
  34946. <member name="F:NPOI.SS.UserModel.MarginType.LeftMargin">
  34947. <summary>
  34948. referes to the left margin
  34949. </summary>
  34950. </member>
  34951. <member name="F:NPOI.SS.UserModel.MarginType.RightMargin">
  34952. <summary>
  34953. referes to the right margin
  34954. </summary>
  34955. </member>
  34956. <member name="F:NPOI.SS.UserModel.MarginType.TopMargin">
  34957. <summary>
  34958. referes to the top margin
  34959. </summary>
  34960. </member>
  34961. <member name="F:NPOI.SS.UserModel.MarginType.BottomMargin">
  34962. <summary>
  34963. referes to the bottom margin
  34964. </summary>
  34965. </member>
  34966. <member name="T:NPOI.SS.UserModel.PanePosition">
  34967. <summary>
  34968. Define the position of the pane. One of lower/right, upper/right, lower/left and upper/left.
  34969. </summary>
  34970. </member>
  34971. <member name="F:NPOI.SS.UserModel.PanePosition.LowerRight">
  34972. <summary>
  34973. referes to the lower/right corner
  34974. </summary>
  34975. </member>
  34976. <member name="F:NPOI.SS.UserModel.PanePosition.UpperRight">
  34977. <summary>
  34978. referes to the upper/right corner
  34979. </summary>
  34980. </member>
  34981. <member name="F:NPOI.SS.UserModel.PanePosition.LowerLeft">
  34982. <summary>
  34983. referes to the lower/left corner
  34984. </summary>
  34985. </member>
  34986. <member name="F:NPOI.SS.UserModel.PanePosition.UpperLeft">
  34987. <summary>
  34988. referes to the upper/left corner
  34989. </summary>
  34990. </member>
  34991. <member name="P:NPOI.SS.UserModel.ITextbox.String">
  34992. @return the rich text string for this textbox.
  34993. </member>
  34994. <member name="P:NPOI.SS.UserModel.ITextbox.MarginLeft">
  34995. @return Returns the left margin within the textbox.
  34996. </member>
  34997. <member name="P:NPOI.SS.UserModel.ITextbox.MarginRight">
  34998. @return returns the right margin within the textbox.
  34999. </member>
  35000. <member name="P:NPOI.SS.UserModel.ITextbox.MarginTop">
  35001. @return returns the top margin within the textbox.
  35002. </member>
  35003. <member name="P:NPOI.SS.UserModel.ITextbox.MarginBottom">
  35004. s the bottom margin within the textbox.
  35005. </member>
  35006. <member name="T:NPOI.SS.UserModel.VerticalAlignment">
  35007. This enumeration value indicates the type of vertical alignment for a cell, i.e.,
  35008. whether it is aligned top, bottom, vertically centered, justified or distributed.
  35009. </member>
  35010. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Top">
  35011. The vertical alignment is aligned-to-top.
  35012. </member>
  35013. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Center">
  35014. The vertical alignment is centered across the height of the cell.
  35015. </member>
  35016. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Bottom">
  35017. The vertical alignment is aligned-to-bottom.
  35018. </member>
  35019. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Justify">
  35020. <p>
  35021. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  35022. where each line of text inside the cell is evenly distributed across the height of the cell,
  35023. with flush top and bottom margins.
  35024. </p>
  35025. <p>
  35026. When text direction is vertical: similar behavior as horizontal justification.
  35027. The alignment is justified (flush top and bottom in this case). For each line of text, each
  35028. line of the wrapped text in a cell is aligned to the top and bottom (except the last line).
  35029. If no single line of text wraps in the cell, then the text is not justified.
  35030. </p>
  35031. </member>
  35032. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Distributed">
  35033. <p>
  35034. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  35035. where each line of text inside the cell is evenly distributed across the height of the cell,
  35036. with flush top
  35037. </p>
  35038. <p>
  35039. When text direction is vertical: behaves exactly as distributed horizontal alignment.
  35040. The first words in a line of text (appearing at the top of the cell) are flush
  35041. 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,
  35042. and the line of text is distributed evenly from top to bottom.
  35043. </p>
  35044. </member>
  35045. <member name="F:NPOI.SS.UserModel.SheetState.Visible">
  35046. <summary>
  35047. Indicates the sheet is visible.
  35048. </summary>
  35049. </member>
  35050. <member name="F:NPOI.SS.UserModel.SheetState.Hidden">
  35051. <summary>
  35052. Indicates the book window is hidden, but can be shown by the user via the user interface.
  35053. </summary>
  35054. </member>
  35055. <member name="F:NPOI.SS.UserModel.SheetState.VeryHidden">
  35056. <summary>
  35057. Indicates the sheet is hidden and cannot be shown in the user interface (UI).
  35058. </summary>
  35059. <remarks>
  35060. In Excel this state is only available programmatically in VBA:
  35061. ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
  35062. </remarks>
  35063. </member>
  35064. <member name="F:NPOI.SS.Util.AreaReference.SHEET_NAME_DELIMITER">
  35065. The Char (!) that Separates sheet names from cell references
  35066. </member>
  35067. <member name="F:NPOI.SS.Util.AreaReference.CELL_DELIMITER">
  35068. The Char (:) that Separates the two cell references in a multi-cell area reference
  35069. </member>
  35070. <member name="F:NPOI.SS.Util.AreaReference.SPECIAL_NAME_DELIMITER">
  35071. The Char (') used to quote sheet names when they contain special Chars
  35072. </member>
  35073. <member name="M:NPOI.SS.Util.AreaReference.#ctor(System.String)">
  35074. Create an area ref from a string representation. Sheet names containing special Chars should be
  35075. delimited and escaped as per normal syntax rules for formulas.<br/>
  35076. The area reference must be contiguous (i.e. represent a single rectangle, not a Union of rectangles)
  35077. </member>
  35078. <member name="M:NPOI.SS.Util.AreaReference.#ctor(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  35079. Creates an area ref from a pair of Cell References.
  35080. </member>
  35081. <member name="M:NPOI.SS.Util.AreaReference.IsContiguous(System.String)">
  35082. is the reference for a contiguous (i.e.
  35083. Unbroken) area, or is it made up of
  35084. several different parts?
  35085. (If it Is, you will need to call
  35086. ....
  35087. </member>
  35088. <member name="M:NPOI.SS.Util.AreaReference.IsWholeColumnReference(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  35089. is the reference for a whole-column reference,
  35090. such as C:C or D:G ?
  35091. </member>
  35092. <member name="M:NPOI.SS.Util.AreaReference.GenerateContiguous(System.String)">
  35093. Takes a non-contiguous area reference, and
  35094. returns an array of contiguous area references.
  35095. </member>
  35096. <member name="M:NPOI.SS.Util.AreaReference.GetAllReferencedCells">
  35097. Returns a reference to every cell covered by this area
  35098. </member>
  35099. <member name="M:NPOI.SS.Util.AreaReference.FormatAsString">
  35100. Example return values:
  35101. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  35102. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  35103. <tr><td>A1:A1</td><td>Single cell area reference without sheet</td></tr>
  35104. <tr><td>A1:$C$1</td><td>Multi-cell area reference without sheet</td></tr>
  35105. <tr><td>Sheet1!A$1:B4</td><td>Standard sheet name</td></tr>
  35106. <tr><td>'O''Brien''s Sales'!B5:C6' </td><td>Sheet name with special Chars</td></tr>
  35107. </table>
  35108. @return the text representation of this area reference as it would appear in a formula.
  35109. </member>
  35110. <member name="M:NPOI.SS.Util.AreaReference.SeparateAreaRefs(System.String)">
  35111. Separates Area refs in two parts and returns them as Separate elements in a String array,
  35112. each qualified with the sheet name (if present)
  35113. @return array with one or two elements. never <c>null</c>
  35114. </member>
  35115. <member name="P:NPOI.SS.Util.AreaReference.IsSingleCell">
  35116. @return <c>false</c> if this area reference involves more than one cell
  35117. </member>
  35118. <member name="P:NPOI.SS.Util.AreaReference.FirstCell">
  35119. @return the first cell reference which defines this area. Usually this cell is in the upper
  35120. left corner of the area (but this is not a requirement).
  35121. </member>
  35122. <member name="P:NPOI.SS.Util.AreaReference.LastCell">
  35123. Note - if this area reference refers to a single cell, the return value of this method will
  35124. be identical to that of <c>GetFirstCell()</c>
  35125. @return the second cell reference which defines this area. For multi-cell areas, this is
  35126. cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner
  35127. of the area (but this is not a requirement).
  35128. </member>
  35129. <member name="T:NPOI.SS.Util.CellRangeAddressBase">
  35130. See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/>
  35131. Common subclass of 8-bit and 16-bit versions
  35132. @author Josh Micich
  35133. </member>
  35134. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Validate(NPOI.SS.SpreadsheetVersion)">
  35135. Validate the range limits against the supplied version of Excel
  35136. @param ssVersion the version of Excel to validate against
  35137. @throws IllegalArgumentException if the range limits are outside of the allowed range
  35138. </member>
  35139. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateRow(System.Int32,NPOI.SS.SpreadsheetVersion)">
  35140. Runs a bounds check for row numbers
  35141. @param row
  35142. </member>
  35143. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateColumn(System.Int32,NPOI.SS.SpreadsheetVersion)">
  35144. Runs a bounds check for column numbers
  35145. @param column
  35146. </member>
  35147. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstColumn">
  35148. @return column number for the upper left hand corner
  35149. </member>
  35150. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstRow">
  35151. @return row number for the upper left hand corner
  35152. </member>
  35153. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastColumn">
  35154. @return column number for the lower right hand corner
  35155. </member>
  35156. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastRow">
  35157. @return row number for the lower right hand corner
  35158. </member>
  35159. <member name="P:NPOI.SS.Util.CellRangeAddressBase.NumberOfCells">
  35160. @return the size of the range (number of cells in the area).
  35161. </member>
  35162. <member name="M:NPOI.SS.Util.CellRangeAddress.FormatAsString(System.String,System.Boolean)">
  35163. @return the text format of this range using specified sheet name.
  35164. </member>
  35165. <member name="M:NPOI.SS.Util.CellRangeAddress.ValueOf(System.String)">
  35166. <summary>
  35167. Creates a CellRangeAddress from a cell range reference string.
  35168. </summary>
  35169. <param name="reference">
  35170. usually a standard area ref (e.g. "B1:D8"). May be a single
  35171. cell ref (e.g. "B5") in which case the result is a 1 x 1 cell
  35172. range. May also be a whole row range (e.g. "3:5"), or a whole
  35173. column range (e.g. "C:F")
  35174. </param>
  35175. <returns>a CellRangeAddress object</returns>
  35176. </member>
  35177. <member name="F:NPOI.SS.Util.CellRangeAddressList._list">
  35178. List of <c>CellRangeAddress</c>es. Each structure represents a cell range
  35179. </member>
  35180. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  35181. Convenience constructor for creating a <c>CellRangeAddressList</c> with a single
  35182. <c>CellRangeAddress</c>. Other <c>CellRangeAddress</c>es may be Added later.
  35183. </member>
  35184. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  35185. @param in the RecordInputstream to read the record from
  35186. </member>
  35187. <member name="M:NPOI.SS.Util.CellRangeAddressList.CountRanges">
  35188. Get the number of following ADDR structures. The number of this
  35189. structures is automatically set when reading an Excel file and/or
  35190. increased when you manually Add a new ADDR structure . This is the reason
  35191. there isn't a set method for this field .
  35192. @return number of ADDR structures
  35193. </member>
  35194. <member name="M:NPOI.SS.Util.CellRangeAddressList.AddCellRangeAddress(System.Int32,System.Int32,System.Int32,System.Int32)">
  35195. Add a cell range structure.
  35196. @param firstRow - the upper left hand corner's row
  35197. @param firstCol - the upper left hand corner's col
  35198. @param lastRow - the lower right hand corner's row
  35199. @param lastCol - the lower right hand corner's col
  35200. @return the index of this ADDR structure
  35201. </member>
  35202. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetCellRangeAddress(System.Int32)">
  35203. @return <c>CellRangeAddress</c> at the given index
  35204. </member>
  35205. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetEncodedSize(System.Int32)">
  35206. @return the total size of for the specified number of ranges,
  35207. including the initial 2 byte range count
  35208. </member>
  35209. <member name="F:NPOI.SS.Util.NameType.None">
  35210. <summary>
  35211. Allow accessing the Initial value.
  35212. </summary>
  35213. </member>
  35214. <member name="T:NPOI.SS.Util.CellReference">
  35215. @author Avik Sengupta
  35216. @author Dennis doubleday (patch to seperateRowColumns())
  35217. </member>
  35218. <member name="F:NPOI.SS.Util.CellReference.ABSOLUTE_REFERENCE_MARKER">
  35219. The character ($) that signifies a row or column value is absolute instead of relative
  35220. </member>
  35221. <member name="F:NPOI.SS.Util.CellReference.SHEET_NAME_DELIMITER">
  35222. The character (!) that Separates sheet names from cell references
  35223. </member>
  35224. <member name="F:NPOI.SS.Util.CellReference.SPECIAL_NAME_DELIMITER">
  35225. The character (') used to quote sheet names when they contain special characters
  35226. </member>
  35227. <member name="F:NPOI.SS.Util.CellReference.CELL_REF_PATTERN">
  35228. Matches a run of one or more letters followed by a run of one or more digits.
  35229. The run of letters is group 1 and the run of digits is group 2.
  35230. Each group may optionally be prefixed with a single '$'.
  35231. </member>
  35232. <member name="F:NPOI.SS.Util.CellReference.COLUMN_REF_PATTERN">
  35233. Matches a run of one or more letters. The run of letters is group 1.
  35234. The text may optionally be prefixed with a single '$'.
  35235. </member>
  35236. <member name="F:NPOI.SS.Util.CellReference.ROW_REF_PATTERN">
  35237. Matches a run of one or more digits. The run of digits is group 1.
  35238. The text may optionally be prefixed with a single '$'.
  35239. </member>
  35240. <member name="F:NPOI.SS.Util.CellReference.NAMED_RANGE_NAME_PATTERN">
  35241. Named range names must start with a letter or underscore. Subsequent characters may include
  35242. digits or dot. (They can even end in dot).
  35243. </member>
  35244. <member name="M:NPOI.SS.Util.CellReference.#ctor(System.String)">
  35245. Create an cell ref from a string representation. Sheet names containing special characters should be
  35246. delimited and escaped as per normal syntax rules for formulas.
  35247. </member>
  35248. <member name="M:NPOI.SS.Util.CellReference.ConvertColStringToIndex(System.String)">
  35249. takes in a column reference portion of a CellRef and converts it from
  35250. ALPHA-26 number format to 0-based base 10.
  35251. 'A' -> 0
  35252. 'Z' -> 25
  35253. 'AA' -> 26
  35254. 'IV' -> 255
  35255. @return zero based column index
  35256. </member>
  35257. <member name="M:NPOI.SS.Util.CellReference.ConvertNumToColString(System.Int32)">
  35258. Takes in a 0-based base-10 column and returns a ALPHA-26
  35259. representation.
  35260. eg column #3 -> D
  35261. </member>
  35262. <member name="M:NPOI.SS.Util.CellReference.SeparateRefParts(System.String)">
  35263. Separates the row from the columns and returns an array of three Strings. The first element
  35264. is the sheet name. Only the first element may be null. The second element in is the column
  35265. name still in ALPHA-26 number format. The third element is the row.
  35266. </member>
  35267. <member name="M:NPOI.SS.Util.CellReference.FormatAsString">
  35268. Example return values:
  35269. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  35270. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  35271. <tr><td>A1</td><td>Cell reference without sheet</td></tr>
  35272. <tr><td>Sheet1!A1</td><td>Standard sheet name</td></tr>
  35273. <tr><td>'O''Brien''s Sales'!A1'</td><td>Sheet name with special characters</td></tr>
  35274. </table>
  35275. @return the text representation of this cell reference as it would appear in a formula.
  35276. </member>
  35277. <member name="M:NPOI.SS.Util.CellReference.AppendCellReference(System.Text.StringBuilder)">
  35278. Appends cell reference with '$' markers for absolute values as required.
  35279. Sheet name is not included.
  35280. </member>
  35281. <member name="M:NPOI.SS.Util.CellReference.CellReferenceIsWithinRange(System.String,System.String,NPOI.SS.SpreadsheetVersion)">
  35282. Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
  35283. interpreted as a cell reference. Names of that form can be also used for sheets and/or
  35284. named ranges, and in those circumstances, the question of whether the potential cell
  35285. reference is valid (in range) becomes important.
  35286. <p/>
  35287. Note - that the maximum sheet size varies across Excel versions:
  35288. <p/>
  35289. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  35290. summary="Notable cases.">
  35291. <tr><th>Version </th><th>File Format </th>
  35292. <th>Last Column </th><th>Last Row</th></tr>
  35293. <tr><td>97-2003</td><td>BIFF8</td><td>"IV" (2^8)</td><td>65536 (2^14)</td></tr>
  35294. <tr><td>2007</td><td>BIFF12</td><td>"XFD" (2^14)</td><td>1048576 (2^20)</td></tr>
  35295. </table></blockquote>
  35296. POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for
  35297. this method:
  35298. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  35299. summary="Notable cases.">
  35300. <tr><th>Input </th>
  35301. <th>Result </th></tr>
  35302. <tr><td>"A", "1"</td><td>true</td></tr>
  35303. <tr><td>"a", "111"</td><td>true</td></tr>
  35304. <tr><td>"A", "65536"</td><td>true</td></tr>
  35305. <tr><td>"A", "65537"</td><td>false</td></tr>
  35306. <tr><td>"iv", "1"</td><td>true</td></tr>
  35307. <tr><td>"IW", "1"</td><td>false</td></tr>
  35308. <tr><td>"AAA", "1"</td><td>false</td></tr>
  35309. <tr><td>"a", "111"</td><td>true</td></tr>
  35310. <tr><td>"Sheet", "1"</td><td>false</td></tr>
  35311. </table></blockquote>
  35312. @param colStr a string of only letter characters
  35313. @param rowStr a string of only digit characters
  35314. @return <c>true</c> if the row and col parameters are within range of a BIFF8 spreadsheet.
  35315. </member>
  35316. <member name="P:NPOI.SS.Util.CellReference.SheetName">
  35317. @return possibly <c>null</c> if this is a 2D reference. Special characters are not
  35318. escaped or delimited
  35319. </member>
  35320. <member name="P:NPOI.SS.Util.CellReference.CellRefParts">
  35321. Returns the three parts of the cell reference, the
  35322. Sheet name (or null if none supplied), the 1 based
  35323. row number, and the A based column letter.
  35324. This will not include any markers for absolute
  35325. references, so use {@link #formatAsString()}
  35326. to properly turn references into strings.
  35327. </member>
  35328. <member name="T:NPOI.SS.Util.CellUtil">
  35329. Various utility functions that make working with a cells and rows easier. The various methods
  35330. that deal with style's allow you to create your CellStyles as you need them. When you apply a
  35331. style change to a cell, the code will attempt to see if a style already exists that meets your
  35332. needs. If not, then it will create a new style. This is to prevent creating too many styles.
  35333. there is an upper limit in Excel on the number of styles that can be supported.
  35334. @author Eric Pugh epugh@upstate.com
  35335. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  35336. </member>
  35337. <member name="M:NPOI.SS.Util.CellUtil.GetRow(System.Int32,NPOI.SS.UserModel.ISheet)">
  35338. Get a row from the spreadsheet, and create it if it doesn't exist.
  35339. @param rowIndex The 0 based row number
  35340. @param sheet The sheet that the row is part of.
  35341. @return The row indicated by the rowCounter
  35342. </member>
  35343. <member name="M:NPOI.SS.Util.CellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  35344. Get a specific cell from a row. If the cell doesn't exist, then create it.
  35345. @param row The row that the cell is part of
  35346. @param columnIndex The column index that the cell is in.
  35347. @return The cell indicated by the column.
  35348. </member>
  35349. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.SS.UserModel.ICellStyle)">
  35350. Creates a cell, gives it a value, and applies a style if provided
  35351. @param row the row to create the cell in
  35352. @param column the column index to create the cell in
  35353. @param value The value of the cell
  35354. @param style If the style is not null, then set
  35355. @return A new Cell
  35356. </member>
  35357. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  35358. Create a cell, and give it a value.
  35359. @param row the row to create the cell in
  35360. @param column the column index to create the cell in
  35361. @param value The value of the cell
  35362. @return A new Cell.
  35363. </member>
  35364. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.Int16)">
  35365. Take a cell, and align it.
  35366. @param cell the cell to set the alignment for
  35367. @param workbook The workbook that is being worked with.
  35368. @param align the column alignment to use.
  35369. @see CellStyle for alignment options
  35370. </member>
  35371. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,NPOI.SS.UserModel.IFont)">
  35372. Take a cell, and apply a font to it
  35373. @param cell the cell to set the alignment for
  35374. @param workbook The workbook that is being worked with.
  35375. @param font The Font that you want to set...
  35376. </member>
  35377. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.String,System.Object)">
  35378. This method attempt to find an already existing CellStyle that matches what you want the
  35379. style to be. If it does not find the style, then it creates a new one. If it does create a
  35380. new one, then it applies the propertyName and propertyValue to the style. This is necessary
  35381. because Excel has an upper limit on the number of Styles that it supports.
  35382. @param workbook The workbook that is being worked with.
  35383. @param propertyName The name of the property that is to be changed.
  35384. @param propertyValue The value of the property that is to be changed.
  35385. @param cell The cell that needs it's style changes
  35386. </member>
  35387. <member name="M:NPOI.SS.Util.CellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  35388. Returns a map containing the format properties of the given cell style.
  35389. @param style cell style
  35390. @return map of format properties (String -> Object)
  35391. @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
  35392. </member>
  35393. <member name="M:NPOI.SS.Util.CellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.SS.UserModel.IWorkbook,System.Collections.Generic.Dictionary{System.String,System.Object})">
  35394. Sets the format properties of the given style based on the given map.
  35395. @param style cell style
  35396. @param workbook parent workbook
  35397. @param properties map of format properties (String -> Object)
  35398. @see #getFormatProperties(CellStyle)
  35399. </member>
  35400. <member name="M:NPOI.SS.Util.CellUtil.GetShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35401. Utility method that returns the named short value form the given map.
  35402. @return zero if the property does not exist, or is not a {@link Short}.
  35403. @param properties map of named properties (String -> Object)
  35404. @param name property name
  35405. @return property value, or zero
  35406. </member>
  35407. <member name="M:NPOI.SS.Util.CellUtil.GetBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  35408. Utility method that returns the named boolean value form the given map.
  35409. @return false if the property does not exist, or is not a {@link Boolean}.
  35410. @param properties map of properties (String -> Object)
  35411. @param name property name
  35412. @return property value, or false
  35413. </member>
  35414. <member name="M:NPOI.SS.Util.CellUtil.PutShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Int16)">
  35415. Utility method that puts the named short value to the given map.
  35416. @param properties map of properties (String -> Object)
  35417. @param name property name
  35418. @param value property value
  35419. </member>
  35420. <member name="M:NPOI.SS.Util.CellUtil.PutBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Boolean)">
  35421. Utility method that puts the named boolean value to the given map.
  35422. @param properties map of properties (String -> Object)
  35423. @param name property name
  35424. @param value property value
  35425. </member>
  35426. <member name="M:NPOI.SS.Util.CellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  35427. Looks for text in the cell that should be unicode, like an alpha and provides the
  35428. unicode version of it.
  35429. @param cell The cell to check for unicode values
  35430. @return translated to unicode
  35431. </member>
  35432. <member name="T:NPOI.SS.Util.CellWalk.ICellHandler">
  35433. Represents callback for CellWalk traverse method.
  35434. @author Roman Kashitsyn
  35435. </member>
  35436. <member name="M:NPOI.SS.Util.CellWalk.ICellHandler.OnCell(NPOI.SS.UserModel.ICell,NPOI.SS.Util.CellWalk.ICellWalkContext)">
  35437. @param cell current cell
  35438. @param ctx information about invokation context
  35439. </member>
  35440. <member name="T:NPOI.SS.Util.CellWalk.CellWalk">
  35441. Traverse cell range.
  35442. @author Roman Kashitsyn
  35443. </member>
  35444. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.IsTraverseEmptyCells">
  35445. Should we call handler on empty (blank) cells. Default is
  35446. false.
  35447. @return true if handler should be called on empty (blank)
  35448. cells, false otherwise.
  35449. </member>
  35450. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.SetTraverseEmptyCells(System.Boolean)">
  35451. Sets the traverseEmptyCells property.
  35452. @param traverseEmptyCells new property value
  35453. </member>
  35454. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.Traverse(NPOI.SS.Util.CellWalk.ICellHandler)">
  35455. Traverse cell range from top left to bottom right cell.
  35456. @param handler handler to call on each appropriate cell
  35457. </member>
  35458. <member name="T:NPOI.SS.Util.CellWalk.CellWalk.SimpleCellWalkContext">
  35459. Inner class to hold walk context.
  35460. @author Roman Kashitsyn
  35461. </member>
  35462. <member name="T:NPOI.SS.Util.CellWalk.ICellWalkContext">
  35463. @author Roman Kashitsyn
  35464. </member>
  35465. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.OrdinalNumber">
  35466. Returns ordinal number of cell in range. Numeration starts
  35467. from top left cell and ends at bottom right cell. Here is a
  35468. brief example (number in cell is it's ordinal number):
  35469. <table border="1">
  35470. <tbody>
  35471. <tr><td>1</td><td>2</td></tr>
  35472. <tr><td>3</td><td>4</td></tr>
  35473. </tbody>
  35474. </table>
  35475. @return ordinal number of current cell
  35476. </member>
  35477. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.RowNumber">
  35478. Returns number of current row.
  35479. @return number of current row
  35480. </member>
  35481. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.ColumnNumber">
  35482. Returns number of current column.
  35483. @return number of current column
  35484. </member>
  35485. <member name="F:NPOI.SS.Util.ExpandedDouble._significand">
  35486. Always 64 bits long (MSB, bit-63 is '1')
  35487. </member>
  35488. <member name="M:NPOI.SS.Util.ExpandedDouble.NormaliseBaseTen">
  35489. Convert to an equivalent {@link NormalisedDecimal} representation having 15 decimal digits of precision in the
  35490. non-fractional bits of the significand.
  35491. </member>
  35492. <member name="M:NPOI.SS.Util.ExpandedDouble.GetBinaryExponent">
  35493. @return the number of non-fractional bits after the MSB of the significand
  35494. </member>
  35495. <member name="T:NPOI.SS.Util.SSNFormat">
  35496. Format class for Excel's SSN Format. This class mimics Excel's built-in
  35497. SSN Formatting.
  35498. @author James May
  35499. </member>
  35500. <member name="M:NPOI.SS.Util.SSNFormat.Format(System.Object,System.Globalization.CultureInfo)">
  35501. Format a number as an SSN
  35502. </member>
  35503. <member name="T:NPOI.SS.Util.ZipPlusFourFormat">
  35504. Format class for Excel Zip + 4 Format. This class mimics Excel's
  35505. built-in Formatting for Zip + 4.
  35506. @author James May
  35507. </member>
  35508. <member name="M:NPOI.SS.Util.ZipPlusFourFormat.Format(System.Object,System.Globalization.CultureInfo)">
  35509. Format a number as Zip + 4
  35510. </member>
  35511. <member name="T:NPOI.SS.Util.PhoneFormat">
  35512. Format class for Excel phone number Format. This class mimics Excel's
  35513. built-in phone number Formatting.
  35514. @author James May
  35515. </member>
  35516. <member name="M:NPOI.SS.Util.PhoneFormat.Format(System.Object,System.Globalization.CultureInfo)">
  35517. Format a number as a phone number
  35518. </member>
  35519. <member name="T:NPOI.SS.Util.FractionFormat">
  35520. Format class that handles Excel style fractions, such as "# #/#" and "#/###"
  35521. </member>
  35522. <member name="T:NPOI.SS.Util.ConstantStringFormat">
  35523. Format class that does nothing and always returns a constant string.
  35524. This format is used to simulate Excel's handling of a format string
  35525. of all # when the value is 0. Excel will output "", Java will output "0".
  35526. @see DataFormatter#createFormat(double, int, String)
  35527. </member>
  35528. <member name="F:NPOI.SS.Util.IEEEDouble.BIASED_EXPONENT_SPECIAL_VALUE">
  35529. The value the exponent field Gets for all <i>NaN</i> and <i>InfInity</i> values
  35530. </member>
  35531. <member name="M:NPOI.SS.Util.IEEEDouble.GetBiasedExponent(System.Int64)">
  35532. @param rawBits the 64 bit binary representation of the double value
  35533. @return the top 12 bits (sign and biased exponent value)
  35534. </member>
  35535. <member name="F:NPOI.SS.Util.MutableFPNumber.C_64">
  35536. Width of a long
  35537. </member>
  35538. <member name="F:NPOI.SS.Util.MutableFPNumber.MIN_PRECISION">
  35539. Minimum precision after discarding whole 32-bit words from the significand
  35540. </member>
  35541. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MIN_BASE">
  35542. The minimum value in 'Base-10 normalised form'.<br/>
  35543. When {@link #_binaryExponent} == 46 this is the the minimum {@link #_frac} value
  35544. (10<sup>14</sup>-0.05) * 2^17
  35545. <br/>
  35546. Values between (10<sup>14</sup>-0.05) and 10<sup>14</sup> will be represented as '1'
  35547. followed by 14 zeros.
  35548. Values less than (10<sup>14</sup>-0.05) will get Shifted by one more power of 10
  35549. This frac value rounds to '1' followed by fourteen zeros with an incremented decimal exponent
  35550. </member>
  35551. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MAX_BASE">
  35552. For 'Base-10 normalised form'<br/>
  35553. The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
  35554. (10^15-0.5) * 2^14
  35555. </member>
  35556. <member name="M:NPOI.SS.Util.MutableFPNumber.Rounder.Round(NPOI.Util.BigInteger,System.Int32)">
  35557. @param nBits number of bits to shift right
  35558. </member>
  35559. <member name="T:NPOI.SS.Util.MutableFPNumber.TenPower">
  35560. Holds values for quick multiplication and division by 10
  35561. </member>
  35562. <member name="F:NPOI.SS.Util.NormalisedDecimal.EXPONENT_OFFSET">
  35563. Number of powers of ten Contained in the significand
  35564. </member>
  35565. <member name="F:NPOI.SS.Util.NormalisedDecimal.C_2_POW_19">
  35566. 2<sup>19</sup>
  35567. </member>
  35568. <member name="F:NPOI.SS.Util.NormalisedDecimal.FRAC_HALF">
  35569. the value of {@link #_fractionalPart} that represents 0.5
  35570. </member>
  35571. <member name="F:NPOI.SS.Util.NormalisedDecimal.MAX_REP_WHOLE_PART">
  35572. 10<sup>15</sup>
  35573. </member>
  35574. <member name="M:NPOI.SS.Util.NormalisedDecimal.RoundUnits">
  35575. Rounds at the digit with value 10<sup>decimalExponent</sup>
  35576. </member>
  35577. <member name="F:NPOI.SS.Util.NormalisedDecimal._relativeDecimalExponent">
  35578. The decimal exponent increased by one less than the digit count of {@link #_wholePart}
  35579. </member>
  35580. <member name="F:NPOI.SS.Util.NormalisedDecimal._wholePart">
  35581. The whole part of the significand (typically 15 digits).
  35582. 47-50 bits long (MSB may be anywhere from bit 46 to 49)
  35583. LSB is units bit.
  35584. </member>
  35585. <member name="F:NPOI.SS.Util.NormalisedDecimal._fractionalPart">
  35586. The fractional part of the significand.
  35587. 24 bits (only top 14-17 bits significant): a value between 0x000000 and 0xFFFF80
  35588. </member>
  35589. <member name="M:NPOI.SS.Util.NormalisedDecimal.NormaliseBaseTwo">
  35590. Convert to an equivalent {@link ExpandedDouble} representation (binary frac and exponent).
  35591. The resulting transformed object is easily Converted to a 64 bit IEEE double:
  35592. <ul>
  35593. <li>bits 2-53 of the {@link #GetSignificand()} become the 52 bit 'fraction'.</li>
  35594. <li>{@link #GetBinaryExponent()} is biased by 1023 to give the 'exponent'.</li>
  35595. </ul>
  35596. The sign bit must be obtained from somewhere else.
  35597. @return a new {@link NormalisedDecimal} normalised to base 2 representation.
  35598. </member>
  35599. <member name="M:NPOI.SS.Util.NormalisedDecimal.ComposeFrac">
  35600. @return the significand as a fixed point number (with 24 fraction bits and 47-50 whole bits)
  35601. </member>
  35602. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetSignificantDecimalDigitsLastDigitRounded">
  35603. Rounds the first whole digit position (considers only units digit, not frational part).
  35604. Caller should check total digit count of result to see whether the rounding operation caused
  35605. a carry out of the most significant digit
  35606. </member>
  35607. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetDecimalExponent">
  35608. @return the number of powers of 10 which have been extracted from the significand and binary exponent.
  35609. </member>
  35610. <member name="M:NPOI.SS.Util.NormalisedDecimal.CompareNormalised(NPOI.SS.Util.NormalisedDecimal)">
  35611. assumes both this and other are normalised
  35612. </member>
  35613. <member name="M:NPOI.SS.Util.NumberComparer.Compare(System.Double,System.Double)">
  35614. This class attempts to reproduce Excel's behaviour for comparing numbers. Results are
  35615. mostly the same as those from {@link Double#compare(double, double)} but with some
  35616. rounding. For numbers that are very close, this code converts to a format having 15
  35617. decimal digits of precision and a decimal exponent, before completing the comparison.
  35618. <p/>
  35619. In Excel formula evaluation, expressions like "(0.06-0.01)=0.05" evaluate to "TRUE" even
  35620. though the equivalent java expression is <c>false</c>. In examples like this,
  35621. Excel achieves the effect by having additional logic for comparison operations.
  35622. <p/>
  35623. <p/>
  35624. Note - Excel also gives special treatment to expressions like "0.06-0.01-0.05" which
  35625. evaluates to "0" (in java, rounding anomalies give a result of 6.9E-18). The special
  35626. behaviour here is for different reasons to the example above: If the last operator in a
  35627. cell formula is '+' or '-' and the result is less than 2<sup>50</sup> times smaller than
  35628. first operand, the result is rounded to zero.
  35629. Needless to say, the two rules are not consistent and it is relatively easy to find
  35630. examples that satisfy<br/>
  35631. "A=B" is "TRUE" but "A-B" is not "0"<br/>
  35632. and<br/>
  35633. "A=B" is "FALSE" but "A-B" is "0"<br/>
  35634. <br/>
  35635. This rule (for rounding the result of a final addition or subtraction), has not been
  35636. implemented in POI (as of Jul-2009).
  35637. @return <code>negative, 0, or positive</code> according to the standard Excel comparison
  35638. of values <c>a</c> and <c>b</c>.
  35639. </member>
  35640. <member name="M:NPOI.SS.Util.NumberComparer.CompareSubnormalNumbers(System.Int64,System.Int64,System.Boolean)">
  35641. If both numbers are subnormal, Excel seems to use standard comparison rules
  35642. </member>
  35643. <member name="M:NPOI.SS.Util.NumberComparer.CompareAcrossSubnormalThreshold(System.Int64,System.Int64,System.Boolean)">
  35644. Usually any normal number is greater (in magnitude) than any subnormal number.
  35645. However there are some anomalous cases around the threshold where Excel produces screwy results
  35646. @param isNegative both values are either negative or positive. This parameter affects the sign of the comparison result
  35647. @return usually <code>isNegative ? -1 : +1</code>
  35648. </member>
  35649. <member name="M:NPOI.SS.Util.NumberComparer.ToHex(System.Double)">
  35650. for formatting double values in error messages
  35651. </member>
  35652. <member name="M:NPOI.SS.Util.NumberToTextConverter.ToText(System.Double)">
  35653. Converts the supplied <c>value</c> to the text representation that Excel would give if
  35654. the value were to appear in an unformatted cell, or as a literal number in a formula.<br/>
  35655. Note - the results from this method differ slightly from those of <c>Double.ToString()</c>
  35656. In some special cases Excel behaves quite differently. This function attempts to reproduce
  35657. those results.
  35658. </member>
  35659. <member name="T:NPOI.SS.Util.PaneInformation">
  35660. Holds information regarding a split plane or freeze plane for a sheet.
  35661. </member>
  35662. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_RIGHT">
  35663. Constant for active pane being the lower right
  35664. </member>
  35665. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_RIGHT">
  35666. Constant for active pane being the upper right
  35667. </member>
  35668. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_LEFT">
  35669. Constant for active pane being the lower left
  35670. </member>
  35671. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_LEFT">
  35672. Constant for active pane being the upper left
  35673. </member>
  35674. <member name="M:NPOI.SS.Util.PaneInformation.IsFreezePane">
  35675. Returns true if this is a Freeze pane, false if it is a split pane.
  35676. </member>
  35677. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitPosition">
  35678. Returns the vertical position of the split.
  35679. @return 0 if there is no vertical spilt,
  35680. or for a freeze pane the number of columns in the TOP pane,
  35681. or for a split plane the position of the split in 1/20th of a point.
  35682. </member>
  35683. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitPosition">
  35684. Returns the horizontal position of the split.
  35685. @return 0 if there is no horizontal spilt,
  35686. or for a freeze pane the number of rows in the LEFT pane,
  35687. or for a split plane the position of the split in 1/20th of a point.
  35688. </member>
  35689. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitTopRow">
  35690. For a horizontal split returns the top row in the BOTTOM pane.
  35691. @return 0 if there is no horizontal split, or the top row of the bottom pane.
  35692. </member>
  35693. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitLeftColumn">
  35694. For a vertical split returns the left column in the RIGHT pane.
  35695. @return 0 if there is no vertical split, or the left column in the RIGHT pane.
  35696. </member>
  35697. <member name="P:NPOI.SS.Util.PaneInformation.ActivePane">
  35698. Returns the active pane
  35699. @see #PANE_LOWER_RIGHT
  35700. @see #PANE_UPPER_RIGHT
  35701. @see #PANE_LOWER_LEFT
  35702. @see #PANE_UPPER_LEFT
  35703. @return the active pane.
  35704. </member>
  35705. <member name="T:NPOI.SS.Util.Region">
  35706. Represents a from/to row/col square. This is a object primitive
  35707. that can be used to represent row,col - row,col just as one would use String
  35708. to represent a string of characters. Its really only useful for HSSF though.
  35709. @author Andrew C. Oliver acoliver at apache dot org
  35710. </member>
  35711. <member name="M:NPOI.SS.Util.Region.#ctor">
  35712. Creates a new instance of Region (0,0 - 0,0)
  35713. </member>
  35714. <member name="M:NPOI.SS.Util.Region.ConvertCellRangesToRegions(NPOI.SS.Util.CellRangeAddress[])">
  35715. Convert a List of CellRange objects to an array of regions
  35716. @param List of CellRange objects
  35717. @return regions
  35718. </member>
  35719. <member name="P:NPOI.SS.Util.Region.ColumnFrom">
  35720. Get the upper left hand corner column number
  35721. @return column number for the upper left hand corner
  35722. </member>
  35723. <member name="P:NPOI.SS.Util.Region.RowFrom">
  35724. Get the upper left hand corner row number
  35725. @return row number for the upper left hand corner
  35726. </member>
  35727. <member name="P:NPOI.SS.Util.Region.ColumnTo">
  35728. Get the lower right hand corner column number
  35729. @return column number for the lower right hand corner
  35730. </member>
  35731. <member name="P:NPOI.SS.Util.Region.RowTo">
  35732. Get the lower right hand corner row number
  35733. @return row number for the lower right hand corner
  35734. </member>
  35735. <member name="T:NPOI.SS.Util.RegionUtil">
  35736. Various utility functions that make working with a region of cells easier.
  35737. @author Eric Pugh epugh@upstate.com
  35738. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  35739. </member>
  35740. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderLeft(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35741. Sets the left border for a region of cells by manipulating the cell style of the individual
  35742. cells on the left
  35743. @param border The new border
  35744. @param region The region that should have the border
  35745. @param workbook The workbook that the region is on.
  35746. @param sheet The sheet that the region is on.
  35747. </member>
  35748. <member name="M:NPOI.SS.Util.RegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35749. Sets the leftBorderColor attribute of the RegionUtil object
  35750. @param color The color of the border
  35751. @param region The region that should have the border
  35752. @param workbook The workbook that the region is on.
  35753. @param sheet The sheet that the region is on.
  35754. </member>
  35755. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderRight(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35756. Sets the borderRight attribute of the RegionUtil object
  35757. @param border The new border
  35758. @param region The region that should have the border
  35759. @param workbook The workbook that the region is on.
  35760. @param sheet The sheet that the region is on.
  35761. </member>
  35762. <member name="M:NPOI.SS.Util.RegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35763. Sets the rightBorderColor attribute of the RegionUtil object
  35764. @param color The color of the border
  35765. @param region The region that should have the border
  35766. @param workbook The workbook that the region is on.
  35767. @param sheet The sheet that the region is on.
  35768. </member>
  35769. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderBottom(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35770. Sets the borderBottom attribute of the RegionUtil object
  35771. @param border The new border
  35772. @param region The region that should have the border
  35773. @param workbook The workbook that the region is on.
  35774. @param sheet The sheet that the region is on.
  35775. </member>
  35776. <member name="M:NPOI.SS.Util.RegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35777. Sets the bottomBorderColor attribute of the RegionUtil object
  35778. @param color The color of the border
  35779. @param region The region that should have the border
  35780. @param workbook The workbook that the region is on.
  35781. @param sheet The sheet that the region is on.
  35782. </member>
  35783. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderTop(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35784. Sets the borderBottom attribute of the RegionUtil object
  35785. @param border The new border
  35786. @param region The region that should have the border
  35787. @param workbook The workbook that the region is on.
  35788. @param sheet The sheet that the region is on.
  35789. </member>
  35790. <member name="M:NPOI.SS.Util.RegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  35791. Sets the topBorderColor attribute of the RegionUtil object
  35792. @param color The color of the border
  35793. @param region The region that should have the border
  35794. @param workbook The workbook that the region is on.
  35795. @param sheet The sheet that the region is on.
  35796. </member>
  35797. <member name="T:NPOI.SS.Util.RegionUtil.CellPropertySetter">
  35798. For setting the same property on many cells to the same value
  35799. </member>
  35800. <member name="T:NPOI.SS.Util.SheetBuilder">
  35801. Class {@code SheetBuilder} provides an easy way of building workbook sheets
  35802. from 2D array of Objects. It can be used in test cases to improve code
  35803. readability or in Swing applications with tables.
  35804. @author Roman Kashitsyn
  35805. </member>
  35806. <member name="M:NPOI.SS.Util.SheetBuilder.GetCreateEmptyCells">
  35807. Returns {@code true} if null array elements should be treated as empty
  35808. cells.
  35809. @return {@code true} if null objects should be treated as empty cells
  35810. and {@code false} otherwise
  35811. </member>
  35812. <member name="M:NPOI.SS.Util.SheetBuilder.SetCreateEmptyCells(System.Boolean)">
  35813. Specifies if null array elements should be treated as empty cells.
  35814. @param shouldCreateEmptyCells {@code true} if null array elements should be
  35815. treated as empty cells
  35816. @return {@code this}
  35817. </member>
  35818. <member name="M:NPOI.SS.Util.SheetBuilder.SetSheetName(System.String)">
  35819. Specifies name of the sheet to build. If not specified, default name (provided by
  35820. workbook) will be used instead.
  35821. @param sheetName sheet name to use
  35822. @return {@code this}
  35823. </member>
  35824. <member name="M:NPOI.SS.Util.SheetBuilder.Build">
  35825. Builds sheet from parent workbook and 2D array with cell
  35826. values. Creates rows anyway (even if row contains only null
  35827. cells), creates cells if either corresponding array value is not
  35828. null or createEmptyCells property is true.
  35829. The conversion is performed in the following way:
  35830. <p/>
  35831. <ul>
  35832. <li>Numbers become numeric cells.</li>
  35833. <li><code>java.util.Date</code> or <code>java.util.Calendar</code>
  35834. instances become date cells.</li>
  35835. <li>String with leading '=' char become formulas (leading '='
  35836. will be truncated).</li>
  35837. <li>Other objects become strings via <code>Object.toString()</code>
  35838. method call.</li>
  35839. </ul>
  35840. @return newly created sheet
  35841. </member>
  35842. <member name="M:NPOI.SS.Util.SheetBuilder.SetCellValue(NPOI.SS.UserModel.ICell,System.Object)">
  35843. Sets the cell value using object type information.
  35844. @param cell cell to change
  35845. @param value value to set
  35846. </member>
  35847. <member name="T:NPOI.SS.Util.SheetReferences">
  35848. Holds a collection of Sheet names and their associated
  35849. reference numbers.
  35850. @author Andrew C. Oliver (acoliver at apache dot org)
  35851. </member>
  35852. <member name="T:NPOI.SS.Util.SheetUtil">
  35853. Helper methods for when working with Usermodel sheets
  35854. @author Yegor Kozlov
  35855. </member>
  35856. <member name="F:NPOI.SS.Util.SheetUtil.dummyEvaluator">
  35857. Dummy formula Evaluator that does nothing.
  35858. YK: The only reason of having this class is that
  35859. {@link NPOI.SS.UserModel.DataFormatter#formatCellValue(NPOI.SS.UserModel.Cell)}
  35860. returns formula string for formula cells. Dummy Evaluator Makes it to format the cached formula result.
  35861. See Bugzilla #50021
  35862. </member>
  35863. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWidth(NPOI.SS.UserModel.ICell,System.Int32,NPOI.SS.UserModel.DataFormatter,System.Boolean)">
  35864. Compute width of a single cell
  35865. @param cell the cell whose width is to be calculated
  35866. @param defaultCharWidth the width of a single character
  35867. @param formatter formatter used to prepare the text to be measured
  35868. @param useMergedCells whether to use merged cells
  35869. @return the width in pixels
  35870. </member>
  35871. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean)">
  35872. Compute width of a column and return the result
  35873. @param sheet the sheet to calculate
  35874. @param column 0-based index of the column
  35875. @param useMergedCells whether to use merged cells
  35876. @return the width in pixels
  35877. </member>
  35878. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean,System.Int32,System.Int32)">
  35879. Compute width of a column based on a subset of the rows and return the result
  35880. @param sheet the sheet to calculate
  35881. @param column 0-based index of the column
  35882. @param useMergedCells whether to use merged cells
  35883. @param firstRow 0-based index of the first row to consider (inclusive)
  35884. @param lastRow 0-based index of the last row to consider (inclusive)
  35885. @return the width in pixels
  35886. </member>
  35887. <member name="M:NPOI.SS.Util.SheetUtil.IFont2Font(NPOI.SS.UserModel.IFont)">
  35888. <summary>
  35889. Convert HSSFFont to Font.
  35890. </summary>
  35891. <param name="font1">The font.</param>
  35892. <returns></returns>
  35893. </member>
  35894. <member name="T:NPOI.SS.Util.SSCellRange`1">
  35895. For POI internal use only
  35896. @author Josh Micich
  35897. </member>
  35898. <member name="T:NPOI.SS.Util.WorkbookUtil">
  35899. Helper methods for when working with Usermodel Workbooks
  35900. </member>
  35901. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String)">
  35902. Creates a valid sheet name, which is conform to the rules.
  35903. In any case, the result safely can be used for
  35904. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  35905. <br/>
  35906. Rules:
  35907. <ul>
  35908. <li>never null</li>
  35909. <li>minimum length is 1</li>
  35910. <li>maximum length is 31</li>
  35911. <li>doesn't contain special chars: 0x0000, 0x0003, / \ ? * ] [ </li>
  35912. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  35913. </ul>
  35914. Invalid characters are replaced by one space character ' '.
  35915. @param nameProposal can be any string, will be truncated if necessary,
  35916. allowed to be null
  35917. @return a valid string, "empty" if to short, "null" if null
  35918. </member>
  35919. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String,System.Char)">
  35920. Creates a valid sheet name, which is conform to the rules.
  35921. In any case, the result safely can be used for
  35922. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  35923. <br />
  35924. Rules:
  35925. <ul>
  35926. <li>never null</li>
  35927. <li>minimum length is 1</li>
  35928. <li>maximum length is 31</li>
  35929. <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
  35930. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  35931. </ul>
  35932. @param nameProposal can be any string, will be truncated if necessary,
  35933. allowed to be null
  35934. @param replaceChar the char to replace invalid characters.
  35935. @return a valid string, "empty" if to short, "null" if null
  35936. </member>
  35937. <member name="M:NPOI.SS.Util.WorkbookUtil.ValidateSheetName(System.String)">
  35938. Validates sheet name.
  35939. <p>
  35940. The character count <c>MUST</c> be greater than or equal to 1 and less than or equal to 31.
  35941. The string MUST NOT contain the any of the following characters:
  35942. <ul>
  35943. <li> 0x0000 </li>
  35944. <li> 0x0003 </li>
  35945. <li> colon (:) </li>
  35946. <li> backslash (\) </li>
  35947. <li> asterisk (*) </li>
  35948. <li> question mark (?) </li>
  35949. <li> forward slash (/) </li>
  35950. <li> opening square bracket ([) </li>
  35951. <li> closing square bracket (]) </li>
  35952. </ul>
  35953. The string MUST NOT begin or end with the single quote (') character.
  35954. </p>
  35955. @param sheetName the name to validate
  35956. </member>
  35957. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Byte)">
  35958. <summary>
  35959. Fills the specified array.
  35960. </summary>
  35961. <param name="array">The array.</param>
  35962. <param name="defaultValue">The default value.</param>
  35963. </member>
  35964. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Int32,System.Int32,System.Byte)">
  35965. <summary>
  35966. Assigns the specified byte value to each element of the specified
  35967. range of the specified array of bytes. The range to be filled
  35968. extends from index <tt>fromIndex</tt>, inclusive, to index
  35969. <tt>toIndex</tt>, exclusive. (If <tt>fromIndex==toIndex</tt>, the
  35970. range to be filled is empty.)
  35971. </summary>
  35972. <param name="a">the array to be filled</param>
  35973. <param name="fromIndex">the index of the first element (inclusive) to be filled with the specified value</param>
  35974. <param name="toIndex">the index of the last element (exclusive) to be filled with the specified value</param>
  35975. <param name="val">the value to be stored in all elements of the array</param>
  35976. <exception cref="T:System.ArgumentException">if <c>fromIndex &gt; toIndex</c></exception>
  35977. <exception cref="T:System.IndexOutOfRangeException"> if <c>fromIndex &lt; 0</c> or <c>toIndex &gt; a.length</c></exception>
  35978. </member>
  35979. <member name="M:NPOI.Util.Arrays.RangeCheck(System.Int32,System.Int32,System.Int32)">
  35980. <summary>
  35981. Checks that {@code fromIndex} and {@code toIndex} are in
  35982. the range and throws an appropriate exception, if they aren't.
  35983. </summary>
  35984. <param name="length"></param>
  35985. <param name="fromIndex"></param>
  35986. <param name="toIndex"></param>
  35987. </member>
  35988. <member name="M:NPOI.Util.Arrays.AsList(System.Array)">
  35989. <summary>
  35990. Convert Array to ArrayList
  35991. </summary>
  35992. <param name="arr">source array</param>
  35993. <returns></returns>
  35994. </member>
  35995. <member name="M:NPOI.Util.Arrays.Fill(System.Int32[],System.Byte)">
  35996. <summary>
  35997. Fills the specified array.
  35998. </summary>
  35999. <param name="array">The array.</param>
  36000. <param name="defaultValue">The default value.</param>
  36001. </member>
  36002. <member name="M:NPOI.Util.Arrays.Equals(System.Object,System.Object)">
  36003. <summary>
  36004. Equals the specified a1.
  36005. </summary>
  36006. <param name="a1">The a1.</param>
  36007. <param name="b1">The b1.</param>
  36008. <returns></returns>
  36009. </member>
  36010. <member name="M:NPOI.Util.Arrays.Equals(System.Object[],System.Object[])">
  36011. Returns <c>true</c> if the two specified arrays of Objects are
  36012. <i>equal</i> to one another. The two arrays are considered equal if
  36013. both arrays contain the same number of elements, and all corresponding
  36014. pairs of elements in the two arrays are equal. Two objects <c>e1</c>
  36015. and <c>e2</c> are considered <i>equal</i> if <c>(e1==null ? e2==null
  36016. : e1.equals(e2))</c>. In other words, the two arrays are equal if
  36017. they contain the same elements in the same order. Also, two array
  36018. references are considered equal if both are <c>null</c>.
  36019. @param a one array to be tested for equality
  36020. @param a2 the other array to be tested for equality
  36021. @return <c>true</c> if the two arrays are equal
  36022. </member>
  36023. <member name="M:NPOI.Util.Arrays.ArrayMoveWithin(System.Object[],System.Int32,System.Int32,System.Int32)">
  36024. <summary>
  36025. Moves a number of entries in an array to another point in the array, shifting those inbetween as required.
  36026. </summary>
  36027. <param name="array">The array to alter</param>
  36028. <param name="moveFrom">The (0 based) index of the first entry to move</param>
  36029. <param name="moveTo">The (0 based) index of the positition to move to</param>
  36030. <param name="numToMove">The number of entries to move</param>
  36031. </member>
  36032. <member name="M:NPOI.Util.Arrays.CopyOf(System.Byte[],System.Int32)">
  36033. <summary>
  36034. Copies the specified array, truncating or padding with zeros (if
  36035. necessary) so the copy has the specified length. This method is temporary
  36036. replace for Arrays.copyOf() until we start to require JDK 1.6.
  36037. </summary>
  36038. <param name="source">the array to be copied</param>
  36039. <param name="newLength">the length of the copy to be returned</param>
  36040. <returns>a copy of the original array, truncated or padded with zeros to obtain the specified length</returns>
  36041. </member>
  36042. <member name="M:NPOI.Util.Arrays.ToString(System.Object[])">
  36043. Returns a string representation of the contents of the specified array.
  36044. If the array contains other arrays as elements, they are converted to
  36045. strings by the {@link Object#toString} method inherited from
  36046. <tt>Object</tt>, which describes their <i>identities</i> rather than
  36047. their contents.
  36048. <p>The value returned by this method is equal to the value that would
  36049. be returned by <tt>Arrays.asList(a).toString()</tt>, unless <tt>a</tt>
  36050. is <tt>null</tt>, in which case <tt>"null"</tt> is returned.</p>
  36051. @param a the array whose string representation to return
  36052. @return a string representation of <tt>a</tt>
  36053. @see #deepToString(Object[])
  36054. @since 1.5
  36055. </member>
  36056. <member name="F:NPOI.Util.BigInteger.LONG_MASK">
  36057. This mask is used to obtain the value of an int as if it were unsigned.
  36058. </member>
  36059. <member name="F:NPOI.Util.BigInteger._signum">
  36060. The signum of this BigInteger: -1 for negative, 0 for zero, or
  36061. 1 for positive. Note that the BigInteger zero <i>must</i> have
  36062. a signum of 0. This is necessary to ensures that there is exactly one
  36063. representation for each BigInteger value.
  36064. @serial
  36065. </member>
  36066. <member name="F:NPOI.Util.BigInteger.mag">
  36067. The magnitude of this BigInteger, in <i>big-endian</i> order: the
  36068. zeroth element of this array is the most-significant int of the
  36069. magnitude. The magnitude must be "minimal" in that the most-significant
  36070. int ({@code mag[0]}) must be non-zero. This is necessary to
  36071. ensure that there is exactly one representation for each BigInteger
  36072. value. Note that this implies that the BigInteger zero has a
  36073. zero-length mag array.
  36074. </member>
  36075. <member name="F:NPOI.Util.BigInteger.bitCount">
  36076. One plus the bitCount of this BigInteger. Zeros means unitialized.
  36077. @serial
  36078. @see #bitCount
  36079. @deprecated Deprecated since logical value is offset from stored
  36080. value and correction factor is applied in accessor method.
  36081. </member>
  36082. <member name="F:NPOI.Util.BigInteger.bitLength">
  36083. One plus the bitLength of this BigInteger. Zeros means unitialized.
  36084. (either value is acceptable).
  36085. @serial
  36086. @see #bitLength()
  36087. @deprecated Deprecated since logical value is offset from stored
  36088. value and correction factor is applied in accessor method.
  36089. </member>
  36090. <member name="F:NPOI.Util.BigInteger.firstNonzeroIntNum">
  36091. Two plus the index of the lowest-order int in the magnitude of this
  36092. BigInteger that contains a nonzero int, or -2 (either value is acceptable).
  36093. The least significant int has int-number 0, the next int in order of
  36094. increasing significance has int-number 1, and so forth.
  36095. @deprecated Deprecated since logical value is offset from stored
  36096. value and correction factor is applied in accessor method.
  36097. </member>
  36098. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[],System.Int32)">
  36099. This internal constructor differs from its public cousin
  36100. with the arguments reversed in two ways: it assumes that its
  36101. arguments are correct, and it doesn't copy the magnitude array.
  36102. </member>
  36103. <member name="M:NPOI.Util.BigInteger.#ctor(System.Byte[])">
  36104. Translates a byte array containing the two's-complement binary
  36105. representation of a BigInteger into a BigInteger. The input array is
  36106. assumed to be in <i>big-endian</i> byte-order: the most significant
  36107. byte is in the zeroth element.
  36108. @param val big-endian two's-complement binary representation of
  36109. BigInteger.
  36110. @throws NumberFormatException {@code val} is zero bytes long.
  36111. </member>
  36112. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[])">
  36113. This private constructor translates an int array containing the
  36114. two's-complement binary representation of a BigInteger into a
  36115. BigInteger. The input array is assumed to be in <i>big-endian</i>
  36116. int-order: the most significant int is in the zeroth element.
  36117. </member>
  36118. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int64)">
  36119. Constructs a BigInteger with the specified value, which may not be zero.
  36120. </member>
  36121. <member name="M:NPOI.Util.BigInteger.TrustedStripLeadingZeroInts(System.Int32[])">
  36122. Returns the input array stripped of any leading zero bytes.
  36123. Since the source is trusted the copying may be skipped.
  36124. </member>
  36125. <member name="M:NPOI.Util.BigInteger.ToString(System.Int32)">
  36126. Returns the String representation of this BigInteger in the
  36127. given radix. If the radix is outside the range from {@link
  36128. Character#Min_RADIX} to {@link Character#Max_RADIX} inclusive,
  36129. it will default to 10 (as is the case for
  36130. {@code Integer.toString}). The digit-to-character mapping
  36131. provided by {@code Character.forDigit} is used, and a minus
  36132. sign is prepended if appropriate. (This representation is
  36133. compatible with the {@link #BigInteger(String, int) (String,
  36134. int)} constructor.)
  36135. @param radix radix of the String representation.
  36136. @return String representation of this BigInteger in the given radix.
  36137. @see Integer#toString
  36138. @see Character#forDigit
  36139. @see #BigInteger(java.lang.String, int)
  36140. </member>
  36141. <member name="F:NPOI.Util.BigInteger.ZERO">
  36142. The BigInteger constant zero.
  36143. @since 1.2
  36144. </member>
  36145. <member name="F:NPOI.Util.BigInteger.One">
  36146. The BigInteger constant one.
  36147. @since 1.2
  36148. </member>
  36149. <member name="F:NPOI.Util.BigInteger.Two">
  36150. The BigInteger constant two. (Not exported.)
  36151. </member>
  36152. <member name="F:NPOI.Util.BigInteger.TEN">
  36153. The BigInteger constant ten.
  36154. @since 1.5
  36155. </member>
  36156. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int64)">
  36157. Returns a BigInteger whose value is equal to that of the
  36158. specified {@code long}. This "static factory method" is
  36159. provided in preference to a ({@code long}) constructor
  36160. because it allows for reuse of frequently used BigIntegers.
  36161. @param val value of the BigInteger to return.
  36162. @return a BigInteger with the specified value.
  36163. </member>
  36164. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int32[])">
  36165. Returns a BigInteger with the given two's complement representation.
  36166. Assumes that the input array will not be modified (the returned
  36167. BigInteger will reference the input array if feasible).
  36168. </member>
  36169. <member name="M:NPOI.Util.BigInteger.BitLengthForInt(System.Int32)">
  36170. Package private method to return bit length for an integer.
  36171. </member>
  36172. <member name="M:NPOI.Util.BigInteger.BitCount">
  36173. Returns the number of bits in the two's complement representation
  36174. of this BigInteger that differ from its sign bit. This method is
  36175. useful when implementing bit-vector style sets atop BigIntegers.
  36176. @return number of bits in the two's complement representation
  36177. of this BigInteger that differ from its sign bit.
  36178. </member>
  36179. <member name="M:NPOI.Util.BigInteger.Abs">
  36180. Returns a BigInteger whose value is the absolute value of this
  36181. BigInteger.
  36182. @return {@code abs(this)}
  36183. </member>
  36184. <member name="M:NPOI.Util.BigInteger.Negate">
  36185. Returns a BigInteger whose value is {@code (-this)}.
  36186. @return {@code -this}
  36187. </member>
  36188. <member name="M:NPOI.Util.BigInteger.Pow(System.Int32)">
  36189. Returns a BigInteger whose value is <c>(this<sup>exponent</sup>)</c>.
  36190. Note that {@code exponent} is an integer rather than a BigInteger.
  36191. @param exponent exponent to which this BigInteger is to be raised.
  36192. @return <c>this<sup>exponent</sup></c>
  36193. @throws ArithmeticException {@code exponent} is negative. (This would
  36194. cause the operation to yield a non-integer value.)
  36195. </member>
  36196. <member name="M:NPOI.Util.BigInteger.MultiplyToLen(System.Int32[],System.Int32,System.Int32[],System.Int32,System.Int32[])">
  36197. Multiplies int arrays x and y to the specified lengths and places
  36198. the result into z. There will be no leading zeros in the resultant array.
  36199. </member>
  36200. <member name="M:NPOI.Util.BigInteger.mulAdd(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  36201. Multiply an array by one word k and add to result, return the carry
  36202. </member>
  36203. <member name="M:NPOI.Util.BigInteger.squareToLen(System.Int32[],System.Int32,System.Int32[])">
  36204. Squares the contents of the int array x. The result is placed into the
  36205. int array z. The contents of x are not changed.
  36206. </member>
  36207. <member name="M:NPOI.Util.BigInteger.addOne(System.Int32[],System.Int32,System.Int32,System.Int32)">
  36208. Add one word to the number a mlen words into a. Return the resulting
  36209. carry.
  36210. </member>
  36211. <member name="M:NPOI.Util.BigInteger.Signum">
  36212. Returns the signum function of this BigInteger.
  36213. @return -1, 0 or 1 as the value of this BigInteger is negative, zero or
  36214. positive.
  36215. </member>
  36216. <member name="M:NPOI.Util.BigInteger.ToByteArray">
  36217. Returns a byte array containing the two's-complement
  36218. representation of this BigInteger. The byte array will be in
  36219. <i>big-endian</i> byte-order: the most significant byte is in
  36220. the zeroth element. The array will contain the minimum number
  36221. of bytes required to represent this BigInteger, including at
  36222. least one sign bit, which is {@code (ceil((this.bitLength() +
  36223. 1)/8))}. (This representation is compatible with the
  36224. {@link #BigInteger(byte[]) (byte[])} constructor.)
  36225. @return a byte array containing the two's-complement representation of
  36226. this BigInteger.
  36227. @see #BigInteger(byte[])
  36228. </member>
  36229. <member name="M:NPOI.Util.BigInteger.intLength">
  36230. Returns the length of the two's complement representation in ints,
  36231. including space for at least one sign bit.
  36232. </member>
  36233. <member name="M:NPOI.Util.BigInteger.GetInt(System.Int32)">
  36234. Returns the specified int of the little-endian two's complement
  36235. representation (int 0 is the least significant). The int number can
  36236. be arbitrarily high (values are logically preceded by infinitely many
  36237. sign ints).
  36238. </member>
  36239. <member name="M:NPOI.Util.BigInteger.FirstNonzeroIntNum">
  36240. Returns the index of the int that contains the first nonzero int in the
  36241. little-endian binary representation of the magnitude (int 0 is the
  36242. least significant). If the magnitude is zero, return value is undefined.
  36243. </member>
  36244. <member name="M:NPOI.Util.BigInteger.stripLeadingZeroBytes(System.Byte[])">
  36245. Returns a copy of the input array stripped of any leading zero bytes.
  36246. </member>
  36247. <member name="M:NPOI.Util.BigInteger.makePositive(System.Byte[])">
  36248. Takes an array a representing a negative 2's-complement number and
  36249. returns the minimal (no leading zero bytes) unsigned whose value is -a.
  36250. </member>
  36251. <member name="M:NPOI.Util.BigInteger.makePositive(System.Int32[])">
  36252. Takes an array a representing a negative 2's-complement number and
  36253. returns the minimal (no leading zero ints) unsigned whose value is -a.
  36254. </member>
  36255. <member name="M:NPOI.Util.BigInteger.NumberOfLeadingZeros(System.Int32)">
  36256. Returns the number of zero bits preceding the highest-order
  36257. ("leftmost") one-bit in the two's complement binary representation
  36258. of the specified {@code int} value. Returns 32 if the
  36259. specified value has no one-bits in its two's complement representation,
  36260. in other words if it is equal to zero.
  36261. Note that this method is closely related to the logarithm base 2.
  36262. For all positive {@code int} values x:
  36263. <ul>
  36264. <li>floor(log<sub>2</sub>(x)) = {@code 31 - numberOfLeadingZeros(x)}</li>
  36265. <li>ceil(log<sub>2</sub>(x)) = {@code 32 - numberOfLeadingZeros(x - 1)}</li>
  36266. </ul>
  36267. @return the number of zero bits preceding the highest-order
  36268. ("leftmost") one-bit in the two's complement binary representation
  36269. of the specified {@code int} value, or 32 if the value
  36270. is equal to zero.
  36271. @since 1.5
  36272. </member>
  36273. <member name="M:NPOI.Util.BigInteger.NumberOfTrailingZeros(System.Int32)">
  36274. Returns the number of zero bits following the lowest-order ("rightmost")
  36275. one-bit in the two's complement binary representation of the specified
  36276. {@code int} value. Returns 32 if the specified value has no
  36277. one-bits in its two's complement representation, in other words if it is
  36278. equal to zero.
  36279. @return the number of zero bits following the lowest-order ("rightmost")
  36280. one-bit in the two's complement binary representation of the
  36281. specified {@code int} value, or 32 if the value is equal
  36282. to zero.
  36283. @since 1.5
  36284. </member>
  36285. <member name="M:NPOI.Util.BigInteger.BitCountForInt(System.Int32)">
  36286. Returns the number of one-bits in the two's complement binary
  36287. representation of the specified {@code int} value. This function is
  36288. sometimes referred to as the <i>population count</i>.
  36289. @return the number of one-bits in the two's complement binary
  36290. representation of the specified {@code int} value.
  36291. @since 1.5
  36292. </member>
  36293. <member name="M:NPOI.Util.BigInteger.compareMagnitude(NPOI.Util.BigInteger)">
  36294. Compares the magnitude array of this BigInteger with the specified
  36295. BigInteger's. This is the version of compareTo ignoring sign.
  36296. @param val BigInteger whose magnitude array to be compared.
  36297. @return -1, 0 or 1 as this magnitude array is less than, equal to or
  36298. greater than the magnitude aray for the specified BigInteger's.
  36299. </member>
  36300. <member name="M:NPOI.Util.BigInteger.Equals(System.Object)">
  36301. Compares this BigInteger with the specified Object for equality.
  36302. @param x Object to which this BigInteger is to be compared.
  36303. @return {@code true} if and only if the specified Object is a
  36304. BigInteger whose value is numerically equal to this BigInteger.
  36305. </member>
  36306. <member name="M:NPOI.Util.BigInteger.Min(NPOI.Util.BigInteger)">
  36307. Returns the minimum of this BigInteger and {@code val}.
  36308. @param val value with which the minimum is to be computed.
  36309. @return the BigInteger whose value is the lesser of this BigInteger and
  36310. {@code val}. If they are equal, either may be returned.
  36311. </member>
  36312. <member name="M:NPOI.Util.BigInteger.Max(NPOI.Util.BigInteger)">
  36313. Returns the maximum of this BigInteger and {@code val}.
  36314. @param val value with which the maximum is to be computed.
  36315. @return the BigInteger whose value is the greater of this and
  36316. {@code val}. If they are equal, either may be returned.
  36317. </member>
  36318. <member name="M:NPOI.Util.BigInteger.GetHashCode">
  36319. Returns the hash code for this BigInteger.
  36320. @return hash code for this BigInteger.
  36321. </member>
  36322. <member name="M:NPOI.Util.BigInteger.IntValue">
  36323. Converts this BigInteger to an {@code int}. This
  36324. conversion is analogous to a
  36325. <i>narrowing primitive conversion</i> from {@code long} to
  36326. {@code int} as defined in section 5.1.3 of
  36327. <cite>The Java(TM) Language Specification</cite>:
  36328. if this BigInteger is too big to fit in an
  36329. {@code int}, only the low-order 32 bits are returned.
  36330. Note that this conversion can lose information about the
  36331. overall magnitude of the BigInteger value as well as return a
  36332. result with the opposite sign.
  36333. @return this BigInteger converted to an {@code int}.
  36334. </member>
  36335. <member name="M:NPOI.Util.BigInteger.LongValue">
  36336. Converts this BigInteger to a {@code long}. This
  36337. conversion is analogous to a
  36338. <i>narrowing primitive conversion</i> from {@code long} to
  36339. {@code int} as defined in section 5.1.3 of
  36340. <cite>The Java(TM) Language Specification</cite>:
  36341. if this BigInteger is too big to fit in a
  36342. {@code long}, only the low-order 64 bits are returned.
  36343. Note that this conversion can lose information about the
  36344. overall magnitude of the BigInteger value as well as return a
  36345. result with the opposite sign.
  36346. @return this BigInteger converted to a {@code long}.
  36347. </member>
  36348. <member name="M:NPOI.Util.BigInteger.ShiftRight(System.Int32)">
  36349. Returns a BigInteger whose value is {@code (this >> n)}. Sign
  36350. extension is performed. The shift distance, {@code n}, may be
  36351. negative, in which case this method performs a left shift.
  36352. (Computes <c>floor(this / 2<sup>n</sup>)</c>.)
  36353. @param n shift distance, in bits.
  36354. @return {@code this >> n}
  36355. @throws ArithmeticException if the shift distance is {@code
  36356. Integer.Min_VALUE}.
  36357. @see #shiftLeft
  36358. </member>
  36359. <member name="M:NPOI.Util.BigInteger.Not">
  36360. Returns a BigInteger whose value is {@code (~this)}. (This method
  36361. returns a negative value if and only if this BigInteger is
  36362. non-negative.)
  36363. @return {@code ~this}
  36364. </member>
  36365. <member name="M:NPOI.Util.BigInteger.Or(NPOI.Util.BigInteger)">
  36366. Returns a BigInteger whose value is {@code (this | val)}. (This method
  36367. returns a negative BigInteger if and only if either this or val is
  36368. negative.)
  36369. @param val value to be OR'ed with this BigInteger.
  36370. @return {@code this | val}
  36371. </member>
  36372. <member name="M:NPOI.Util.BigInteger.Multiply(System.Int64)">
  36373. Package private methods used by BigDecimal code to multiply a BigInteger
  36374. with a long. Assumes v is not equal to INFLATED.
  36375. </member>
  36376. <member name="M:NPOI.Util.BigInteger.Multiply(NPOI.Util.BigInteger)">
  36377. Returns a BigInteger whose value is {@code (this * val)}.
  36378. @param val value to be multiplied by this BigInteger.
  36379. @return {@code this * val}
  36380. </member>
  36381. <member name="M:NPOI.Util.BigInteger.Add(NPOI.Util.BigInteger)">
  36382. Returns a BigInteger whose value is {@code (this + val)}.
  36383. @param val value to be added to this BigInteger.
  36384. @return {@code this + val}
  36385. </member>
  36386. <member name="M:NPOI.Util.BigInteger.add(System.Int32[],System.Int32[])">
  36387. Adds the contents of the int arrays x and y. This method allocates
  36388. a new int array to hold the answer and returns a reference to that
  36389. array.
  36390. </member>
  36391. <member name="M:NPOI.Util.BigInteger.Subtract(NPOI.Util.BigInteger)">
  36392. Returns a BigInteger whose value is {@code (this - val)}.
  36393. @param val value to be subtracted from this BigInteger.
  36394. @return {@code this - val}
  36395. </member>
  36396. <member name="M:NPOI.Util.BigInteger.Subtract(System.Int32[],System.Int32[])">
  36397. Subtracts the contents of the second int arrays (little) from the
  36398. first (big). The first int array (big) must represent a larger number
  36399. than the second. This method allocates the space necessary to hold the
  36400. answer.
  36401. </member>
  36402. <member name="M:NPOI.Util.BigInteger.Divide(NPOI.Util.BigInteger)">
  36403. Returns a BigInteger whose value is {@code (this / val)}.
  36404. @param val value by which this BigInteger is to be divided.
  36405. @return {@code this / val}
  36406. @throws ArithmeticException if {@code val} is zero.
  36407. </member>
  36408. <member name="F:NPOI.Util.MutableBigInteger._value">
  36409. Holds the magnitude of this MutableBigInteger in big endian order.
  36410. The magnitude may start at an offset into the value array, and it may
  36411. end before the length of the value array.
  36412. </member>
  36413. <member name="F:NPOI.Util.MutableBigInteger.intLen">
  36414. The number of ints of the value array that are currently used
  36415. to hold the magnitude of this MutableBigInteger. The magnitude starts
  36416. at an offset and offset + intLen may be less than value.Length.
  36417. </member>
  36418. <member name="F:NPOI.Util.MutableBigInteger.offset">
  36419. The offset into the value array where the magnitude of this
  36420. MutableBigInteger begins.
  36421. </member>
  36422. <member name="F:NPOI.Util.MutableBigInteger.One">
  36423. MutableBigInteger with one element value array with the value 1. Used by
  36424. BigDecimal divideAndRound to increment the quotient. Use this constant
  36425. only when the method is not going to modify this object.
  36426. </member>
  36427. <member name="M:NPOI.Util.MutableBigInteger.#ctor">
  36428. The default constructor. An empty MutableBigInteger is created with
  36429. a one word capacity.
  36430. </member>
  36431. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32)">
  36432. Construct a new MutableBigInteger with a magnitude specified by
  36433. the int val.
  36434. </member>
  36435. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32[])">
  36436. Construct a new MutableBigInteger with the specified value array
  36437. up to the length of the array supplied.
  36438. </member>
  36439. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.BigInteger)">
  36440. Construct a new MutableBigInteger with a magnitude equal to the
  36441. specified BigInteger.
  36442. </member>
  36443. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.MutableBigInteger)">
  36444. Construct a new MutableBigInteger with a magnitude equal to the
  36445. specified MutableBigInteger.
  36446. </member>
  36447. <member name="M:NPOI.Util.MutableBigInteger.getMagnitudeArray">
  36448. Internal helper method to return the magnitude array. The caller is not
  36449. supposed to modify the returned array.
  36450. </member>
  36451. <member name="M:NPOI.Util.MutableBigInteger.toLong">
  36452. Convert this MutableBigInteger to a long value. The caller has to make
  36453. sure this MutableBigInteger can be fit into long.
  36454. </member>
  36455. <member name="M:NPOI.Util.MutableBigInteger.toBigInteger(System.Int32)">
  36456. Convert this MutableBigInteger to a BigInteger object.
  36457. </member>
  36458. <member name="M:NPOI.Util.MutableBigInteger.clear">
  36459. Clear out a MutableBigInteger for reuse.
  36460. </member>
  36461. <member name="M:NPOI.Util.MutableBigInteger.reset">
  36462. Set a MutableBigInteger to zero, removing its offset.
  36463. </member>
  36464. <member name="M:NPOI.Util.MutableBigInteger.compare(NPOI.Util.MutableBigInteger)">
  36465. Compare the magnitude of two MutableBigIntegers. Returns -1, 0 or 1
  36466. as this MutableBigInteger is numerically less than, equal to, or
  36467. greater than <c>b</c>.
  36468. </member>
  36469. <member name="M:NPOI.Util.MutableBigInteger.compareHalf(NPOI.Util.MutableBigInteger)">
  36470. Compare this against half of a MutableBigInteger object (Needed for
  36471. remainder tests).
  36472. Assumes no leading unnecessary zeros, which holds for results
  36473. from divide().
  36474. </member>
  36475. <member name="M:NPOI.Util.MutableBigInteger.getLowestSetBit">
  36476. Return the index of the lowest set bit in this MutableBigInteger. If the
  36477. magnitude of this MutableBigInteger is zero, -1 is returned.
  36478. </member>
  36479. <member name="M:NPOI.Util.MutableBigInteger.getInt(System.Int32)">
  36480. Return the int in use in this MutableBigInteger at the specified
  36481. index. This method is not used because it is not inlined on all
  36482. platforms.
  36483. </member>
  36484. <member name="M:NPOI.Util.MutableBigInteger.getLong(System.Int32)">
  36485. Return a long which is equal to the unsigned value of the int in
  36486. use in this MutableBigInteger at the specified index. This method is
  36487. not used because it is not inlined on all platforms.
  36488. </member>
  36489. <member name="M:NPOI.Util.MutableBigInteger.normalize">
  36490. Ensure that the MutableBigInteger is in normal form, specifically
  36491. making sure that there are no leading zeros, and that if the
  36492. magnitude is zero, then intLen is zero.
  36493. </member>
  36494. <member name="M:NPOI.Util.MutableBigInteger.ensureCapacity(System.Int32)">
  36495. If this MutableBigInteger cannot hold len words, increase the size
  36496. of the value array to len words.
  36497. </member>
  36498. <member name="M:NPOI.Util.MutableBigInteger.toIntArray">
  36499. Convert this MutableBigInteger into an int array with no leading
  36500. zeros, of a length that is equal to this MutableBigInteger's intLen.
  36501. </member>
  36502. <member name="M:NPOI.Util.MutableBigInteger.setInt(System.Int32,System.Int32)">
  36503. Sets the int at index+offset in this MutableBigInteger to val.
  36504. This does not get inlined on all platforms so it is not used
  36505. as often as originally intended.
  36506. </member>
  36507. <member name="M:NPOI.Util.MutableBigInteger.setValue(System.Int32[],System.Int32)">
  36508. Sets this MutableBigInteger's value array to the specified array.
  36509. The intLen is set to the specified length.
  36510. </member>
  36511. <member name="M:NPOI.Util.MutableBigInteger.copyValue(NPOI.Util.MutableBigInteger)">
  36512. Sets this MutableBigInteger's value array to a copy of the specified
  36513. array. The intLen is set to the length of the new array.
  36514. </member>
  36515. <member name="M:NPOI.Util.MutableBigInteger.copyValue(System.Int32[])">
  36516. Sets this MutableBigInteger's value array to a copy of the specified
  36517. array. The intLen is set to the length of the specified array.
  36518. </member>
  36519. <member name="M:NPOI.Util.MutableBigInteger.isOne">
  36520. Returns true iff this MutableBigInteger has a value of one.
  36521. </member>
  36522. <member name="M:NPOI.Util.MutableBigInteger.isZero">
  36523. Returns true iff this MutableBigInteger has a value of zero.
  36524. </member>
  36525. <member name="M:NPOI.Util.MutableBigInteger.isEven">
  36526. Returns true iff this MutableBigInteger is even.
  36527. </member>
  36528. <member name="M:NPOI.Util.MutableBigInteger.isOdd">
  36529. Returns true iff this MutableBigInteger is odd.
  36530. </member>
  36531. <member name="M:NPOI.Util.MutableBigInteger.isNormal">
  36532. Returns true iff this MutableBigInteger is in normal form. A
  36533. MutableBigInteger is in normal form if it has no leading zeros
  36534. after the offset, and intLen + offset &lt;= value.Length.
  36535. </member>
  36536. <member name="M:NPOI.Util.MutableBigInteger.toString">
  36537. Returns a String representation of this MutableBigInteger in radix 10.
  36538. </member>
  36539. <member name="M:NPOI.Util.MutableBigInteger.rightShift(System.Int32)">
  36540. Right shift this MutableBigInteger n bits. The MutableBigInteger is left
  36541. in normal form.
  36542. </member>
  36543. <member name="M:NPOI.Util.MutableBigInteger.leftShift(System.Int32)">
  36544. Left shift this MutableBigInteger n bits.
  36545. </member>
  36546. <member name="M:NPOI.Util.MutableBigInteger.divadd(System.Int32[],System.Int32[],System.Int32)">
  36547. A primitive used for division. This method adds in one multiple of the
  36548. divisor a back to the dividend result at a specified offset. It is used
  36549. when qhat was estimated too large, and must be adjusted.
  36550. </member>
  36551. <member name="M:NPOI.Util.MutableBigInteger.mulsub(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  36552. This method is used for division. It multiplies an n word input a by one
  36553. word input x, and subtracts the n word product from q. This is needed
  36554. when subtracting qhat*divisor from dividend.
  36555. </member>
  36556. <member name="M:NPOI.Util.MutableBigInteger.primitiveRightShift(System.Int32)">
  36557. Right shift this MutableBigInteger n bits, where n is
  36558. less than 32.
  36559. Assumes that intLen > 0, n > 0 for speed
  36560. </member>
  36561. <member name="M:NPOI.Util.MutableBigInteger.primitiveLeftShift(System.Int32)">
  36562. Left shift this MutableBigInteger n bits, where n is
  36563. less than 32.
  36564. Assumes that intLen > 0, n > 0 for speed
  36565. </member>
  36566. <member name="M:NPOI.Util.MutableBigInteger.add(NPOI.Util.MutableBigInteger)">
  36567. Adds the contents of two MutableBigInteger objects.The result
  36568. is placed within this MutableBigInteger.
  36569. The contents of the addend are not changed.
  36570. </member>
  36571. <member name="M:NPOI.Util.MutableBigInteger.subtract(NPOI.Util.MutableBigInteger)">
  36572. Subtracts the smaller of this and b from the larger and places the
  36573. result into this MutableBigInteger.
  36574. </member>
  36575. <member name="M:NPOI.Util.MutableBigInteger.difference(NPOI.Util.MutableBigInteger)">
  36576. Subtracts the smaller of a and b from the larger and places the result
  36577. into the larger. Returns 1 if the answer is in a, -1 if in b, 0 if no
  36578. operation was performed.
  36579. </member>
  36580. <member name="M:NPOI.Util.MutableBigInteger.multiply(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  36581. Multiply the contents of two MutableBigInteger objects. The result is
  36582. placed into MutableBigInteger z. The contents of y are not changed.
  36583. </member>
  36584. <member name="M:NPOI.Util.MutableBigInteger.mul(System.Int32,NPOI.Util.MutableBigInteger)">
  36585. Multiply the contents of this MutableBigInteger by the word y. The
  36586. result is placed into z.
  36587. </member>
  36588. <member name="M:NPOI.Util.MutableBigInteger.divideOneWord(System.Int32,NPOI.Util.MutableBigInteger)">
  36589. This method is used for division of an n word dividend by a one word
  36590. divisor. The quotient is placed into quotient. The one word divisor is
  36591. specified by divisor.
  36592. @return the remainder of the division is returned.
  36593. </member>
  36594. <member name="M:NPOI.Util.MutableBigInteger.divide(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  36595. Calculates the quotient of this div b and places the quotient in the
  36596. provided MutableBigInteger objects and the remainder object is returned.
  36597. Uses Algorithm D in Knuth section 4.3.1.
  36598. Many optimizations to that algorithm have been adapted from the Colin
  36599. Plumb C library.
  36600. It special cases one word divisors for speed. The content of b is not
  36601. changed.
  36602. </member>
  36603. <member name="M:NPOI.Util.MutableBigInteger.divide(System.Int64,NPOI.Util.MutableBigInteger)">
  36604. Internally used to calculate the quotient of this div v and places the
  36605. quotient in the provided MutableBigInteger object and the remainder is
  36606. returned.
  36607. @return the remainder of the division will be returned.
  36608. </member>
  36609. <member name="M:NPOI.Util.MutableBigInteger.divideMagnitude(System.Int32[],NPOI.Util.MutableBigInteger)">
  36610. Divide this MutableBigInteger by the divisor represented by its magnitude
  36611. array. The quotient will be placed into the provided quotient object &amp;
  36612. the remainder object is returned.
  36613. </member>
  36614. <member name="M:NPOI.Util.MutableBigInteger.unsignedLongCompare(System.Int64,System.Int64)">
  36615. Compare two longs as if they were unsigned.
  36616. Returns true iff one is bigger than two.
  36617. </member>
  36618. <member name="M:NPOI.Util.MutableBigInteger.divWord(System.Int32[],System.Int64,System.Int32)">
  36619. This method divides a long quantity by an int to estimate
  36620. qhat for two multi precision numbers. It is used when
  36621. the signed value of n is less than zero.
  36622. </member>
  36623. <member name="M:NPOI.Util.MutableBigInteger.hybridGCD(NPOI.Util.MutableBigInteger)">
  36624. Calculate GCD of this and b. This and b are changed by the computation.
  36625. </member>
  36626. <member name="M:NPOI.Util.MutableBigInteger.binaryGCD(NPOI.Util.MutableBigInteger)">
  36627. Calculate GCD of this and v.
  36628. Assumes that this and v are not zero.
  36629. </member>
  36630. <member name="M:NPOI.Util.MutableBigInteger.binaryGcd(System.Int32,System.Int32)">
  36631. Calculate GCD of a and b interpreted as unsigned integers.
  36632. </member>
  36633. <member name="M:NPOI.Util.MutableBigInteger.mutableModInverse(NPOI.Util.MutableBigInteger)">
  36634. Returns the modInverse of this mod p. This and p are not affected by
  36635. the operation.
  36636. </member>
  36637. <member name="M:NPOI.Util.MutableBigInteger.modInverse(NPOI.Util.MutableBigInteger)">
  36638. Calculate the multiplicative inverse of this mod mod, where mod is odd.
  36639. This and mod are not changed by the calculation.
  36640. This method implements an algorithm due to Richard Schroeppel, that uses
  36641. the same intermediate representation as Montgomery Reduction
  36642. ("Montgomery Form"). The algorithm is described in an unpublished
  36643. manuscript entitled "Fast Modular Reciprocals."
  36644. </member>
  36645. <member name="M:NPOI.Util.MutableBigInteger.euclidModInverse(System.Int32)">
  36646. Uses the extended Euclidean algorithm to compute the modInverse of base
  36647. mod a modulus that is a power of 2. The modulus is 2^k.
  36648. </member>
  36649. <member name="T:NPOI.Util.BitField">
  36650. <summary>
  36651. Manage operations dealing with bit-mapped fields.
  36652. @author Marc Johnson (mjohnson at apache dot org)
  36653. @author Andrew C. Oliver (acoliver at apache dot org)
  36654. </summary>
  36655. </member>
  36656. <member name="M:NPOI.Util.BitField.#ctor(System.Int32)">
  36657. <summary>
  36658. Create a <see cref="T:NPOI.Util.BitField"/> instance
  36659. </summary>
  36660. <param name="mask">
  36661. the mask specifying which bits apply to this
  36662. BitField. Bits that are set in this mask are the
  36663. bits that this BitField operates on
  36664. </param>
  36665. </member>
  36666. <member name="M:NPOI.Util.BitField.#ctor(System.UInt32)">
  36667. <summary>
  36668. Create a <see cref="T:NPOI.Util.BitField"/> instance
  36669. </summary>
  36670. <param name="mask">
  36671. the mask specifying which bits apply to this
  36672. BitField. Bits that are set in this mask are the
  36673. bits that this BitField operates on
  36674. </param>
  36675. </member>
  36676. <member name="M:NPOI.Util.BitField.Clear(System.Int32)">
  36677. <summary>
  36678. Clear the bits.
  36679. </summary>
  36680. <param name="holder">the int data containing the bits we're interested in</param>
  36681. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  36682. </member>
  36683. <member name="M:NPOI.Util.BitField.ClearShort(System.Int16)">
  36684. <summary>
  36685. Clear the bits.
  36686. </summary>
  36687. <param name="holder">the short data containing the bits we're interested in</param>
  36688. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  36689. </member>
  36690. <member name="M:NPOI.Util.BitField.GetRawValue(System.Int32)">
  36691. <summary>
  36692. Obtain the value for the specified BitField, appropriately
  36693. shifted right. Many users of a BitField will want to treat the
  36694. specified bits as an int value, and will not want to be aware
  36695. that the value is stored as a BitField (and so shifted left so
  36696. many bits)
  36697. </summary>
  36698. <param name="holder">the int data containing the bits we're interested in</param>
  36699. <returns>the selected bits, shifted right appropriately</returns>
  36700. </member>
  36701. <member name="M:NPOI.Util.BitField.GetShortRawValue(System.Int16)">
  36702. <summary>
  36703. Obtain the value for the specified BitField, unshifted
  36704. </summary>
  36705. <param name="holder">the short data containing the bits we're interested in</param>
  36706. <returns>the selected bits</returns>
  36707. </member>
  36708. <member name="M:NPOI.Util.BitField.GetShortValue(System.Int16)">
  36709. <summary>
  36710. Obtain the value for the specified BitField, appropriately
  36711. shifted right, as a short. Many users of a BitField will want
  36712. to treat the specified bits as an int value, and will not want
  36713. to be aware that the value is stored as a BitField (and so
  36714. shifted left so many bits)
  36715. </summary>
  36716. <param name="holder">the short data containing the bits we're interested in</param>
  36717. <returns>the selected bits, shifted right appropriately</returns>
  36718. </member>
  36719. <member name="M:NPOI.Util.BitField.GetValue(System.Int32)">
  36720. <summary>
  36721. Obtain the value for the specified BitField, appropriately
  36722. shifted right. Many users of a BitField will want to treat the
  36723. specified bits as an int value, and will not want to be aware
  36724. that the value is stored as a BitField (and so shifted left so
  36725. many bits)
  36726. </summary>
  36727. <param name="holder">the int data containing the bits we're interested in</param>
  36728. <returns>the selected bits, shifted right appropriately</returns>
  36729. </member>
  36730. <member name="M:NPOI.Util.BitField.IsAllSet(System.Int32)">
  36731. <summary>
  36732. Are all of the bits set or not? This is a stricter test than
  36733. isSet, in that all of the bits in a multi-bit set must be set
  36734. for this method to return true
  36735. </summary>
  36736. <param name="holder">the int data containing the bits we're interested in</param>
  36737. <returns>
  36738. <c>true</c> if all of the bits are set otherwise, <c>false</c>.
  36739. </returns>
  36740. </member>
  36741. <member name="M:NPOI.Util.BitField.IsSet(System.Int32)">
  36742. <summary>
  36743. is the field set or not? This is most commonly used for a
  36744. single-bit field, which is often used to represent a boolean
  36745. value; the results of using it for a multi-bit field is to
  36746. determine whether *any* of its bits are set
  36747. </summary>
  36748. <param name="holder">the int data containing the bits we're interested in</param>
  36749. <returns>
  36750. <c>true</c> if any of the bits are set; otherwise, <c>false</c>.
  36751. </returns>
  36752. </member>
  36753. <member name="M:NPOI.Util.BitField.Set(System.Int32)">
  36754. <summary>
  36755. Set the bits.
  36756. </summary>
  36757. <param name="holder">the int data containing the bits we're interested in</param>
  36758. <returns>the value of holder with the specified bits set to 1</returns>
  36759. </member>
  36760. <member name="M:NPOI.Util.BitField.SetBoolean(System.Int32,System.Boolean)">
  36761. <summary>
  36762. Set a boolean BitField
  36763. </summary>
  36764. <param name="holder">the int data containing the bits we're interested in</param>
  36765. <param name="flag">indicating whether to set or clear the bits</param>
  36766. <returns>the value of holder with the specified bits set or cleared</returns>
  36767. </member>
  36768. <member name="M:NPOI.Util.BitField.SetShort(System.Int16)">
  36769. <summary>
  36770. Set the bits.
  36771. </summary>
  36772. <param name="holder">the short data containing the bits we're interested in</param>
  36773. <returns>the value of holder with the specified bits set to 1</returns>
  36774. </member>
  36775. <member name="M:NPOI.Util.BitField.SetShortBoolean(System.Int16,System.Boolean)">
  36776. <summary>
  36777. Set a boolean BitField
  36778. </summary>
  36779. <param name="holder">the short data containing the bits we're interested in</param>
  36780. <param name="flag">indicating whether to set or clear the bits</param>
  36781. <returns>the value of holder with the specified bits set or cleared</returns>
  36782. </member>
  36783. <member name="M:NPOI.Util.BitField.SetShortValue(System.Int16,System.Int16)">
  36784. <summary>
  36785. Obtain the value for the specified BitField, appropriately
  36786. shifted right, as a short. Many users of a BitField will want
  36787. to treat the specified bits as an int value, and will not want
  36788. to be aware that the value is stored as a BitField (and so
  36789. shifted left so many bits)
  36790. </summary>
  36791. <param name="holder">the short data containing the bits we're interested in</param>
  36792. <param name="value">the new value for the specified bits</param>
  36793. <returns>the selected bits, shifted right appropriately</returns>
  36794. </member>
  36795. <member name="M:NPOI.Util.BitField.SetValue(System.Int32,System.Int32)">
  36796. <summary>
  36797. Sets the value.
  36798. </summary>
  36799. <param name="holder">the byte data containing the bits we're interested in</param>
  36800. <param name="value">The value.</param>
  36801. <returns></returns>
  36802. </member>
  36803. <member name="M:NPOI.Util.BitField.SetByteBoolean(System.Byte,System.Boolean)">
  36804. <summary>
  36805. Set a boolean BitField
  36806. </summary>
  36807. <param name="holder"> the byte data containing the bits we're interested in</param>
  36808. <param name="flag">indicating whether to set or clear the bits</param>
  36809. <returns>the value of holder with the specified bits set or cleared</returns>
  36810. </member>
  36811. <member name="M:NPOI.Util.BitField.ClearByte(System.Byte)">
  36812. <summary>
  36813. Clears the bits.
  36814. </summary>
  36815. <param name="holder">the byte data containing the bits we're interested in</param>
  36816. <returns>the value of holder with the specified bits cleared</returns>
  36817. </member>
  36818. <member name="M:NPOI.Util.BitField.SetByte(System.Byte)">
  36819. <summary>
  36820. Set the bits.
  36821. </summary>
  36822. <param name="holder">the byte data containing the bits we're interested in</param>
  36823. <returns>the value of holder with the specified bits set to 1</returns>
  36824. </member>
  36825. <member name="T:NPOI.Util.BitFieldFactory">
  36826. <summary>
  36827. Returns immutable Btfield instances.
  36828. @author Jason Height (jheight at apache dot org)
  36829. </summary>
  36830. </member>
  36831. <member name="M:NPOI.Util.BitFieldFactory.GetInstance(System.Int32)">
  36832. <summary>
  36833. Gets the instance.
  36834. </summary>
  36835. <param name="mask">The mask.</param>
  36836. <returns></returns>
  36837. </member>
  36838. <member name="T:NPOI.Util.ByteField">
  36839. <summary>
  36840. representation of a byte (8-bit) field at a fixed location within a
  36841. byte array
  36842. @author Marc Johnson (mjohnson at apache dot org
  36843. </summary>
  36844. </member>
  36845. <member name="T:NPOI.Util.FixedField">
  36846. <summary>
  36847. behavior of a field at a fixed location within a byte array
  36848. @author Marc Johnson (mjohnson at apache dot org
  36849. </summary>
  36850. </member>
  36851. <member name="M:NPOI.Util.FixedField.ReadFromBytes(System.Byte[])">
  36852. <summary>
  36853. set the value from its offset into an array of bytes
  36854. </summary>
  36855. <param name="data">the byte array from which the value is to be read</param>
  36856. </member>
  36857. <member name="M:NPOI.Util.FixedField.ReadFromStream(System.IO.Stream)">
  36858. <summary>
  36859. set the value from an Stream
  36860. </summary>
  36861. <param name="stream">the Stream from which the value is to be read</param>
  36862. </member>
  36863. <member name="M:NPOI.Util.FixedField.ToString">
  36864. <summary>
  36865. return the value as a String
  36866. </summary>
  36867. <returns></returns>
  36868. </member>
  36869. <member name="M:NPOI.Util.FixedField.WriteToBytes(System.Byte[])">
  36870. <summary>
  36871. write the value out to an array of bytes at the appropriate offset
  36872. </summary>
  36873. <param name="data">the array of bytes to which the value is to be written</param>
  36874. </member>
  36875. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32)">
  36876. <summary>
  36877. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  36878. </summary>
  36879. <param name="offset">The offset.</param>
  36880. </member>
  36881. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte)">
  36882. <summary>
  36883. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  36884. </summary>
  36885. <param name="offset">The offset.</param>
  36886. <param name="value">The value.</param>
  36887. </member>
  36888. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte[])">
  36889. <summary>
  36890. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  36891. </summary>
  36892. <param name="offset">The offset.</param>
  36893. <param name="data">The data.</param>
  36894. </member>
  36895. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte,System.Byte[])">
  36896. <summary>
  36897. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  36898. </summary>
  36899. <param name="offset">The offset.</param>
  36900. <param name="_value">The _value.</param>
  36901. <param name="data">The data.</param>
  36902. </member>
  36903. <member name="M:NPOI.Util.ByteField.ReadFromBytes(System.Byte[])">
  36904. <summary>
  36905. set the value from its offset into an array of bytes
  36906. </summary>
  36907. <param name="data">the byte array from which the value is to be read</param>
  36908. </member>
  36909. <member name="M:NPOI.Util.ByteField.ReadFromStream(System.IO.Stream)">
  36910. <summary>
  36911. set the value from an Stream
  36912. </summary>
  36913. <param name="stream">the Stream from which the value is to be read</param>
  36914. </member>
  36915. <member name="M:NPOI.Util.ByteField.Set(System.Byte,System.Byte[])">
  36916. <summary>
  36917. set the ByteField's current value and write it to a byte array
  36918. </summary>
  36919. <param name="value">value to be set</param>
  36920. <param name="data">the byte array to write the value to</param>
  36921. </member>
  36922. <member name="M:NPOI.Util.ByteField.ToString">
  36923. <summary>
  36924. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  36925. </summary>
  36926. <returns>
  36927. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  36928. </returns>
  36929. </member>
  36930. <member name="M:NPOI.Util.ByteField.WriteToBytes(System.Byte[])">
  36931. <summary>
  36932. write the value out to an array of bytes at the appropriate offset
  36933. </summary>
  36934. <param name="data">the array of bytes to which the value is to be written</param>
  36935. </member>
  36936. <member name="P:NPOI.Util.ByteField.Value">
  36937. <summary>
  36938. Gets or sets the value.
  36939. </summary>
  36940. <value>The value.</value>
  36941. </member>
  36942. <member name="T:NPOI.Util.ClassID">
  36943. <summary>
  36944. Represents a class ID (16 bytes). Unlike other little-endian
  36945. type the {@link ClassID} is not just 16 bytes stored in the wrong
  36946. order. Instead, it is a double word (4 bytes) followed by two
  36947. words (2 bytes each) followed by 8 bytes.
  36948. @author Rainer Klute
  36949. <a href="mailto:klute@rainer-klute.de">klute@rainer-klute.de</a>
  36950. @version $Id: ClassID.java 489730 2006-12-22 19:18:16Z bayard $
  36951. @since 2002-02-09
  36952. </summary>
  36953. </member>
  36954. <member name="F:NPOI.Util.ClassID.LENGTH">
  36955. The number of bytes occupied by this object in the byte
  36956. stream.
  36957. </member>
  36958. <member name="F:NPOI.Util.ClassID.bytes">
  36959. The bytes making out the class ID in correct order,
  36960. i.e. big-endian.
  36961. </member>
  36962. <member name="M:NPOI.Util.ClassID.#ctor(System.Byte[],System.Int32)">
  36963. <summary>
  36964. Creates a <see cref="T:NPOI.Util.ClassID"/> and Reads its value from a byte array.
  36965. </summary>
  36966. <param name="src">The byte array to Read from.</param>
  36967. <param name="offset">The offset of the first byte to Read.</param>
  36968. </member>
  36969. <member name="M:NPOI.Util.ClassID.#ctor">
  36970. <summary>
  36971. Creates a <see cref="T:NPOI.Util.ClassID"/> and initializes its value with 0x00 bytes.
  36972. </summary>
  36973. </member>
  36974. <member name="M:NPOI.Util.ClassID.Read(System.Byte[],System.Int32)">
  36975. <summary>
  36976. Reads the class ID's value from a byte array by turning little-endian into big-endian.
  36977. </summary>
  36978. <param name="src">The byte array to Read from</param>
  36979. <param name="offset">The offset within the </param>
  36980. <returns>A byte array containing the class ID.</returns>
  36981. </member>
  36982. <member name="M:NPOI.Util.ClassID.Write(System.Byte[],System.Int32)">
  36983. <summary>
  36984. Writes the class ID to a byte array in the little-endian format.
  36985. </summary>
  36986. <param name="dst">The byte array to Write to.</param>
  36987. <param name="offset">The offset within the </param>
  36988. </member>
  36989. <member name="M:NPOI.Util.ClassID.Equals(System.Object)">
  36990. <summary>
  36991. Checks whether this ClassID is equal to another
  36992. object.
  36993. </summary>
  36994. <param name="o">the object to compare this PropertySet with</param>
  36995. <returns>true if the objects are equal, else
  36996. false</returns>
  36997. </member>
  36998. <member name="M:NPOI.Util.ClassID.GetHashCode">
  36999. <summary>
  37000. Serves as a hash function for a particular type.
  37001. </summary>
  37002. <returns>
  37003. A hash code for the current <see cref="T:System.Object"/>.
  37004. </returns>
  37005. </member>
  37006. <member name="M:NPOI.Util.ClassID.ToString">
  37007. <summary>
  37008. Returns a human-Readable representation of the Class ID in standard
  37009. format <c>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</c>.
  37010. </summary>
  37011. <returns>
  37012. A String representation of the Class ID represented by this object..
  37013. </returns>
  37014. </member>
  37015. <member name="P:NPOI.Util.ClassID.Length">
  37016. <summary>
  37017. Gets the length.
  37018. </summary>
  37019. <value>The number of bytes occupied by this object in the byte stream.</value>
  37020. </member>
  37021. <member name="P:NPOI.Util.ClassID.Bytes">
  37022. <summary>
  37023. Gets or sets the bytes making out the class ID. They are returned in correct order, i.e. big-endian.
  37024. </summary>
  37025. <value>the bytes making out the class ID..</value>
  37026. </member>
  37027. <member name="T:NPOI.Util.Collections.HashSet">
  37028. <summary>
  37029. This class comes from Java
  37030. </summary>
  37031. </member>
  37032. <member name="T:NPOI.Util.Collections.ISet">
  37033. <summary>
  37034. This interface comes from Java
  37035. </summary>
  37036. </member>
  37037. <member name="M:NPOI.Util.Collections.ISet.Add(System.Object)">
  37038. <summary>
  37039. Adds the specified o.
  37040. </summary>
  37041. <param name="o">The o.</param>
  37042. </member>
  37043. <member name="M:NPOI.Util.Collections.ISet.Contains(System.Object)">
  37044. <summary>
  37045. Determines whether [contains] [the specified o].
  37046. </summary>
  37047. <param name="o">The o.</param>
  37048. <returns>
  37049. <c>true</c> if [contains] [the specified o]; otherwise, <c>false</c>.
  37050. </returns>
  37051. </member>
  37052. <member name="M:NPOI.Util.Collections.ISet.Remove(System.Object)">
  37053. <summary>
  37054. Removes the specified o.
  37055. </summary>
  37056. <param name="o">The o.</param>
  37057. </member>
  37058. <member name="M:NPOI.Util.Collections.ISet.Clear">
  37059. <summary>
  37060. Removes all of the elements from this set (optional operation).
  37061. The set will be empty after this call returns.
  37062. </summary>
  37063. </member>
  37064. <member name="M:NPOI.Util.Collections.HashSet.#ctor">
  37065. <summary>
  37066. Initializes a new instance of the <see cref="T:NPOI.Util.Collections.HashSet"/> class.
  37067. </summary>
  37068. </member>
  37069. <member name="M:NPOI.Util.Collections.HashSet.#ctor(NPOI.Util.Collections.ISet)">
  37070. <summary>
  37071. Initializes a new instance of the <see cref="T:NPOI.Util.Collections.HashSet"/> class.
  37072. </summary>
  37073. <param name="s">The s.</param>
  37074. </member>
  37075. <member name="M:NPOI.Util.Collections.HashSet.Add(System.Object)">
  37076. <summary>
  37077. Adds the specified o.
  37078. </summary>
  37079. <param name="o">The o.</param>
  37080. </member>
  37081. <member name="M:NPOI.Util.Collections.HashSet.Contains(System.Object)">
  37082. <summary>
  37083. Determines whether [contains] [the specified o].
  37084. </summary>
  37085. <param name="o">The o.</param>
  37086. <returns>
  37087. <c>true</c> if [contains] [the specified o]; otherwise, <c>false</c>.
  37088. </returns>
  37089. </member>
  37090. <member name="M:NPOI.Util.Collections.HashSet.CopyTo(System.Array,System.Int32)">
  37091. <summary>
  37092. 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.
  37093. </summary>
  37094. <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>
  37095. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  37096. <exception cref="T:System.ArgumentNullException">
  37097. <paramref name="array"/> is null.
  37098. </exception>
  37099. <exception cref="T:System.ArgumentOutOfRangeException">
  37100. <paramref name="index"/> is less than zero.
  37101. </exception>
  37102. <exception cref="T:System.ArgumentException">
  37103. <paramref name="array"/> is multidimensional.
  37104. -or-
  37105. <paramref name="index"/> is equal to or greater than the length of <paramref name="array"/>.
  37106. -or-
  37107. 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"/>.
  37108. </exception>
  37109. <exception cref="T:System.ArgumentException">
  37110. The type of the source <see cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
  37111. </exception>
  37112. </member>
  37113. <member name="M:NPOI.Util.Collections.HashSet.GetEnumerator">
  37114. <summary>
  37115. Returns an enumerator that iterates through a collection.
  37116. </summary>
  37117. <returns>
  37118. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  37119. </returns>
  37120. </member>
  37121. <member name="M:NPOI.Util.Collections.HashSet.Remove(System.Object)">
  37122. <summary>
  37123. Removes the specified o.
  37124. </summary>
  37125. <param name="o">The o.</param>
  37126. </member>
  37127. <member name="M:NPOI.Util.Collections.HashSet.Clear">
  37128. <summary>
  37129. Removes all of the elements from this set.
  37130. The set will be empty after this call returns.
  37131. </summary>
  37132. </member>
  37133. <member name="P:NPOI.Util.Collections.HashSet.Count">
  37134. <summary>
  37135. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  37136. </summary>
  37137. <value></value>
  37138. <returns>
  37139. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  37140. </returns>
  37141. </member>
  37142. <member name="P:NPOI.Util.Collections.HashSet.IsSynchronized">
  37143. <summary>
  37144. Gets a value indicating whether access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread safe).
  37145. </summary>
  37146. <value></value>
  37147. <returns>true if access to the <see cref="T:System.Collections.ICollection"/> is synchronized (thread safe); otherwise, false.
  37148. </returns>
  37149. </member>
  37150. <member name="P:NPOI.Util.Collections.HashSet.SyncRoot">
  37151. <summary>
  37152. Gets an object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  37153. </summary>
  37154. <value></value>
  37155. <returns>
  37156. An object that can be used to synchronize access to the <see cref="T:System.Collections.ICollection"/>.
  37157. </returns>
  37158. </member>
  37159. <member name="T:NPOI.Util.Collections.Properties">
  37160. <summary>
  37161. This class comes from Java
  37162. </summary>
  37163. </member>
  37164. <member name="M:NPOI.Util.Collections.Properties.#ctor">
  37165. <summary>
  37166. Initializes a new instance of the <see cref="T:NPOI.Util.Collections.Properties"/> class.
  37167. </summary>
  37168. </member>
  37169. <member name="M:NPOI.Util.Collections.Properties.Remove(System.String)">
  37170. <summary>
  37171. Removes the specified key.
  37172. </summary>
  37173. <param name="key">The key.</param>
  37174. <returns></returns>
  37175. </member>
  37176. <member name="M:NPOI.Util.Collections.Properties.GetEnumerator">
  37177. <summary>
  37178. Gets the enumerator.
  37179. </summary>
  37180. <returns></returns>
  37181. </member>
  37182. <member name="M:NPOI.Util.Collections.Properties.ContainsKey(System.String)">
  37183. <summary>
  37184. Determines whether the specified key contains key.
  37185. </summary>
  37186. <param name="key">The key.</param>
  37187. <returns>
  37188. <c>true</c> if the specified key contains key; otherwise, <c>false</c>.
  37189. </returns>
  37190. </member>
  37191. <member name="M:NPOI.Util.Collections.Properties.Add(System.String,System.String)">
  37192. <summary>
  37193. Adds the specified key.
  37194. </summary>
  37195. <param name="key">The key.</param>
  37196. <param name="value">The value.</param>
  37197. </member>
  37198. <member name="M:NPOI.Util.Collections.Properties.Clear">
  37199. <summary>
  37200. Clears this instance.
  37201. </summary>
  37202. </member>
  37203. <member name="M:NPOI.Util.Collections.Properties.Load(System.IO.Stream)">
  37204. <summary>
  37205. Loads the specified in stream.
  37206. </summary>
  37207. <param name="inStream">The in stream.</param>
  37208. </member>
  37209. <member name="M:NPOI.Util.Collections.Properties.LoadConvert(System.String)">
  37210. <summary>
  37211. Loads the convert.
  37212. </summary>
  37213. <param name="theString">The string.</param>
  37214. <returns></returns>
  37215. <remarks>
  37216. Converts encoded &#92;uxxxx to unicode chars
  37217. and changes special saved chars to their original forms
  37218. </remarks>
  37219. </member>
  37220. <member name="M:NPOI.Util.Collections.Properties.ContinueLine(System.String)">
  37221. <summary>
  37222. Continues the line.
  37223. </summary>
  37224. <param name="line">The line.</param>
  37225. <returns></returns>
  37226. </member>
  37227. <member name="P:NPOI.Util.Collections.Properties.Count">
  37228. <summary>
  37229. Gets the count.
  37230. </summary>
  37231. <value>The count.</value>
  37232. </member>
  37233. <member name="P:NPOI.Util.Collections.Properties.Item(System.String)">
  37234. <summary>
  37235. Gets or sets the <see cref="T:System.String"/> with the specified key.
  37236. </summary>
  37237. <value></value>
  37238. </member>
  37239. <member name="P:NPOI.Util.Collections.Properties.Keys">
  37240. <summary>
  37241. Gets the keys.
  37242. </summary>
  37243. <value>The keys.</value>
  37244. </member>
  37245. <member name="T:NPOI.Util.CRC32">
  37246. <summary>
  37247. CRC Verification
  37248. </summary>
  37249. </member>
  37250. <member name="M:NPOI.Util.CRC32.#ctor">
  37251. <summary>
  37252. Initializes a new instance of the <see cref="T:NPOI.Util.CRC32"/> class.
  37253. </summary>
  37254. </member>
  37255. <member name="M:NPOI.Util.CRC32.ByteCRC(System.Byte[]@)">
  37256. <summary>
  37257. CRC Bytes.
  37258. </summary>
  37259. <param name="buffer">The buffer.</param>
  37260. <returns></returns>
  37261. </member>
  37262. <member name="M:NPOI.Util.CRC32.StringCRC(System.String)">
  37263. <summary>
  37264. String CRC
  37265. </summary>
  37266. <param name="sInputString">the string</param>
  37267. <returns></returns>
  37268. </member>
  37269. <member name="M:NPOI.Util.CRC32.FileCRC(System.String)">
  37270. <summary>
  37271. File CRC
  37272. </summary>
  37273. <param name="sInputFilename">the input file</param>
  37274. <returns></returns>
  37275. </member>
  37276. <member name="M:NPOI.Util.CRC32.StreamCRC(System.IO.Stream)">
  37277. <summary>
  37278. Stream CRC
  37279. </summary>
  37280. <param name="inFile">the input stream</param>
  37281. <returns></returns>
  37282. </member>
  37283. <member name="T:NPOI.Util.HexDump">
  37284. <summary>
  37285. dump data in hexadecimal format; derived from a HexDump utility I
  37286. wrote in June 2001.
  37287. @author Marc Johnson
  37288. @author Glen Stampoultzis (glens at apache.org)
  37289. </summary>
  37290. </member>
  37291. <member name="M:NPOI.Util.HexDump.ShortToHex(System.Int32)">
  37292. <summary>
  37293. Shorts to hex.
  37294. </summary>
  37295. <param name="value">The value.</param>
  37296. <returns>char array of 2 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37297. </member>
  37298. <member name="M:NPOI.Util.HexDump.ByteToHex(System.Int32)">
  37299. <summary>
  37300. Bytes to hex.
  37301. </summary>
  37302. <param name="value">The value.</param>
  37303. <returns>char array of 1 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37304. </member>
  37305. <member name="M:NPOI.Util.HexDump.IntToHex(System.Int32)">
  37306. <summary>
  37307. Ints to hex.
  37308. </summary>
  37309. <param name="value">The value.</param>
  37310. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37311. </member>
  37312. <member name="M:NPOI.Util.HexDump.LongToHex(System.Int64)">
  37313. <summary>
  37314. char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'
  37315. </summary>
  37316. <param name="value">The value.</param>
  37317. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  37318. </member>
  37319. <member name="M:NPOI.Util.HexDump.ToHexChars(System.Int64,System.Int32)">
  37320. <summary>
  37321. Toes the hex chars.
  37322. </summary>
  37323. <param name="pValue">The p value.</param>
  37324. <param name="nBytes">The n bytes.</param>
  37325. <returns>char array of uppercase hex chars, zero padded and prefixed with '0x'</returns>
  37326. </member>
  37327. <member name="M:NPOI.Util.HexRead.ReadData(System.String)">
  37328. <summary>
  37329. This method reads hex data from a filename and returns a byte array.
  37330. The file may contain line comments that are preceeded with a # symbol.
  37331. </summary>
  37332. <param name="filename">The filename to read</param>
  37333. <returns>The bytes read from the file.</returns>
  37334. <exception cref="T:System.IO.IOException">If there was a problem while reading the file.</exception>
  37335. </member>
  37336. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.String)">
  37337. <summary>
  37338. Same as ReadData(String) except that this method allows you to specify sections within
  37339. a file. Sections are referenced using section headers in the form:
  37340. </summary>
  37341. <param name="stream">The stream.</param>
  37342. <param name="section">The section.</param>
  37343. <returns></returns>
  37344. </member>
  37345. <member name="M:NPOI.Util.HexRead.ReadData(System.String,System.String)">
  37346. <summary>
  37347. Reads the data.
  37348. </summary>
  37349. <param name="filename">The filename.</param>
  37350. <param name="section">The section.</param>
  37351. <returns></returns>
  37352. </member>
  37353. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.Int32)">
  37354. <summary>
  37355. Reads the data.
  37356. </summary>
  37357. <param name="stream">The stream.</param>
  37358. <param name="eofChar">The EOF char.</param>
  37359. <returns></returns>
  37360. </member>
  37361. <member name="M:NPOI.Util.HexRead.ReadFromString(System.String)">
  37362. <summary>
  37363. Reads from string.
  37364. </summary>
  37365. <param name="data">The data.</param>
  37366. <returns></returns>
  37367. </member>
  37368. <member name="M:NPOI.Util.HexRead.ReadToEOL(System.IO.Stream)">
  37369. <summary>
  37370. Reads to EOL.
  37371. </summary>
  37372. <param name="stream">The stream.</param>
  37373. </member>
  37374. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32)">
  37375. <summary>
  37376. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing byte array class.
  37377. </summary>
  37378. <param name="offset">offset of the field within its byte array.</param>
  37379. </member>
  37380. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32)">
  37381. <summary>
  37382. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  37383. byte array and initialize its value
  37384. </summary>
  37385. <param name="offset">offset of the field within its byte array</param>
  37386. <param name="value">the initial value</param>
  37387. </member>
  37388. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Byte[])">
  37389. <summary>
  37390. Construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  37391. byte array and initialize its value from its byte array
  37392. </summary>
  37393. <param name="offset">offset of the field within its byte array</param>
  37394. <param name="data">the byte array to Read the value from</param>
  37395. </member>
  37396. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32,System.Byte[])">
  37397. <summary>
  37398. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  37399. byte array, initialize its value, and write the value to a byte
  37400. </summary>
  37401. <param name="offset">offset of the field within its byte array</param>
  37402. <param name="value">the initial value</param>
  37403. <param name="data">the byte array to write the value to</param>
  37404. </member>
  37405. <member name="M:NPOI.Util.IntegerField.Set(System.Int32,System.Byte[])">
  37406. <summary>
  37407. Set the IntegerField's current value and write it to a byte array
  37408. </summary>
  37409. <param name="value">value to be Set</param>
  37410. <param name="data">the byte array to write the value to</param>
  37411. </member>
  37412. <member name="M:NPOI.Util.IntegerField.ReadFromBytes(System.Byte[])">
  37413. <summary>
  37414. Set the value from its offset into an array of bytes
  37415. </summary>
  37416. <param name="data">The data.</param>
  37417. </member>
  37418. <member name="M:NPOI.Util.IntegerField.ReadFromStream(System.IO.Stream)">
  37419. <summary>
  37420. Set the value from an Stream
  37421. </summary>
  37422. <param name="stream">the Stream from which the value is to be Read</param>
  37423. </member>
  37424. <member name="M:NPOI.Util.IntegerField.WriteToBytes(System.Byte[])">
  37425. <summary>
  37426. write the value out to an array of bytes at the appropriate offset
  37427. </summary>
  37428. <param name="data"> the array of bytes to which the value is to be written </param>
  37429. </member>
  37430. <member name="M:NPOI.Util.IntegerField.Write(System.Int32,System.Int32,System.Byte[])">
  37431. <summary>
  37432. Same as using the constructor <see cref="T:NPOI.Util.IntegerField"/> with the same
  37433. parameter list. Avoid creation of an useless object.
  37434. </summary>
  37435. <param name="offset">offset of the field within its byte array</param>
  37436. <param name="value">the initial value</param>
  37437. <param name="data">the byte array to write the value to</param>
  37438. </member>
  37439. <member name="M:NPOI.Util.IntegerField.ToString">
  37440. <summary>
  37441. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  37442. </summary>
  37443. <returns>
  37444. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  37445. </returns>
  37446. </member>
  37447. <member name="P:NPOI.Util.IntegerField.Value">
  37448. <summary>
  37449. get or Set the IntegerField's current value
  37450. </summary>
  37451. <value>The value.</value>
  37452. <returns></returns>
  37453. </member>
  37454. <member name="T:NPOI.Util.IntList">
  37455. <summary>
  37456. 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
  37457. the mimicry of List is as follows:
  37458. <ul>
  37459. <li> if possible, operations designated 'optional' in the List
  37460. interface are attempted</li>
  37461. <li> wherever the List interface refers to an Object, substitute
  37462. int</li>
  37463. <li> wherever the List interface refers to a Collection or List,
  37464. substitute IntList</li>
  37465. </ul>
  37466. the mimicry is not perfect, however:
  37467. <ul>
  37468. <li> operations involving Iterators or ListIterators are not
  37469. supported</li>
  37470. <li> Remove(Object) becomes RemoveValue to distinguish it from
  37471. Remove(int index)</li>
  37472. <li> subList is not supported</li>
  37473. </ul>
  37474. @author Marc Johnson
  37475. </summary>
  37476. </member>
  37477. <member name="M:NPOI.Util.IntList.#ctor">
  37478. <summary>
  37479. create an IntList of default size
  37480. </summary>
  37481. </member>
  37482. <member name="M:NPOI.Util.IntList.#ctor(NPOI.Util.IntList)">
  37483. <summary>
  37484. create a copy of an existing IntList
  37485. </summary>
  37486. <param name="list">the existing IntList</param>
  37487. </member>
  37488. <member name="M:NPOI.Util.IntList.#ctor(System.Int32,System.Int32)">
  37489. <summary>
  37490. create an IntList with a predefined Initial size
  37491. </summary>
  37492. <param name="initialCapacity">the size for the internal array</param>
  37493. <param name="fillvalue"></param>
  37494. </member>
  37495. <member name="M:NPOI.Util.IntList.Add(System.Int32,System.Int32)">
  37496. <summary>
  37497. add the specfied value at the specified index
  37498. </summary>
  37499. <param name="index">the index where the new value is to be Added</param>
  37500. <param name="value">the new value</param>
  37501. </member>
  37502. <member name="M:NPOI.Util.IntList.Add(System.Int32)">
  37503. <summary>
  37504. Appends the specified element to the end of this list
  37505. </summary>
  37506. <param name="value">element to be Appended to this list.</param>
  37507. <returns>return true (as per the general contract of the Collection.add method</returns>
  37508. </member>
  37509. <member name="M:NPOI.Util.IntList.AddAll(NPOI.Util.IntList)">
  37510. <summary>
  37511. Appends all of the elements in the specified collection to the
  37512. end of this list, in the order that they are returned by the
  37513. specified collection's iterator. The behavior of this
  37514. operation is unspecified if the specified collection is
  37515. modified while the operation is in progress. (Note that this
  37516. will occur if the specified collection is this list, and it's
  37517. nonempty.)
  37518. </summary>
  37519. <param name="c">collection whose elements are to be Added to this list.</param>
  37520. <returns>return true if this list Changed as a result of the call.</returns>
  37521. </member>
  37522. <member name="M:NPOI.Util.IntList.AddAll(System.Int32,NPOI.Util.IntList)">
  37523. <summary>
  37524. Inserts all of the elements in the specified collection into
  37525. this list at the specified position. Shifts the element
  37526. currently at that position (if any) and any subsequent elements
  37527. to the right (increases their indices). The new elements will
  37528. appear in this list in the order that they are returned by the
  37529. specified collection's iterator. The behavior of this
  37530. operation is unspecified if the specified collection is
  37531. modified while the operation is in progress. (Note that this
  37532. will occur if the specified collection is this list, and it's
  37533. nonempty.)
  37534. </summary>
  37535. <param name="index">index at which to insert first element from the specified collection.</param>
  37536. <param name="c">elements to be inserted into this list.</param>
  37537. <returns>return true if this list Changed as a result of the call.</returns>
  37538. </member>
  37539. <member name="M:NPOI.Util.IntList.Clear">
  37540. <summary>
  37541. Removes all of the elements from this list. This list will be
  37542. empty After this call returns (unless it throws an exception).
  37543. </summary>
  37544. </member>
  37545. <member name="M:NPOI.Util.IntList.Contains(System.Int32)">
  37546. <summary>
  37547. Returns true if this list Contains the specified element. More
  37548. formally, returns true if and only if this list Contains at
  37549. least one element e such that o == e
  37550. </summary>
  37551. <param name="o">element whose presence in this list is to be Tested.</param>
  37552. <returns>return true if this list Contains the specified element.</returns>
  37553. </member>
  37554. <member name="M:NPOI.Util.IntList.ContainsAll(NPOI.Util.IntList)">
  37555. <summary>
  37556. Returns true if this list Contains all of the elements of the
  37557. specified collection.
  37558. </summary>
  37559. <param name="c">collection to be Checked for Containment in this list.</param>
  37560. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  37561. </member>
  37562. <member name="M:NPOI.Util.IntList.Equals(System.Object)">
  37563. <summary>
  37564. Compares the specified object with this list for Equality.
  37565. Returns true if and only if the specified object is also a
  37566. list, both lists have the same size, and all corresponding
  37567. pairs of elements in the two lists are Equal. (Two elements e1
  37568. and e2 are equal if e1 == e2.) In other words, two lists are
  37569. defined to be equal if they contain the same elements in the
  37570. same order. This defInition ensures that the Equals method
  37571. works properly across different implementations of the List
  37572. interface.
  37573. </summary>
  37574. <param name="o">the object to be Compared for Equality with this list.</param>
  37575. <returns>return true if the specified object is equal to this list.</returns>
  37576. </member>
  37577. <member name="M:NPOI.Util.IntList.Get(System.Int32)">
  37578. <summary>
  37579. Returns the element at the specified position in this list.
  37580. </summary>
  37581. <param name="index">index of element to return.</param>
  37582. <returns>return the element at the specified position in this list.</returns>
  37583. </member>
  37584. <member name="M:NPOI.Util.IntList.GetHashCode">
  37585. <summary>
  37586. Returns the hash code value for this list. The hash code of a
  37587. list is defined to be the result of the following calculation:
  37588. <code>
  37589. hashCode = 1;
  37590. Iterator i = list.Iterator();
  37591. while (i.HasNext()) {
  37592. Object obj = i.Next();
  37593. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  37594. }
  37595. </code>
  37596. This ensures that list1.Equals(list2) implies that
  37597. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  37598. list2, as required by the general contract of Object.HashCode.
  37599. </summary>
  37600. <returns>return the hash code value for this list.</returns>
  37601. </member>
  37602. <member name="M:NPOI.Util.IntList.IndexOf(System.Int32)">
  37603. <summary>
  37604. Returns the index in this list of the first occurrence of the
  37605. specified element, or -1 if this list does not contain this
  37606. element. More formally, returns the lowest index i such that
  37607. (o == Get(i)), or -1 if there is no such index.
  37608. </summary>
  37609. <param name="o">element to search for.</param>
  37610. <returns>return the index in this list of the first occurrence of the
  37611. specified element, or -1 if this list does not contain
  37612. this element.</returns>
  37613. </member>
  37614. <member name="M:NPOI.Util.IntList.IsEmpty">
  37615. <summary>
  37616. Returns true if this list Contains no elements.
  37617. </summary>
  37618. <returns>return true if this list Contains no elements.</returns>
  37619. </member>
  37620. <member name="M:NPOI.Util.IntList.LastIndexOf(System.Int32)">
  37621. <summary>
  37622. Returns the index in this list of the last occurrence of the
  37623. specified element, or -1 if this list does not contain this
  37624. element. More formally, returns the highest index i such that
  37625. (o == Get(i)), or -1 if there is no such index.
  37626. </summary>
  37627. <param name="o">element to search for.</param>
  37628. <returns>the index in this list of the last occurrence of the
  37629. specified element, or -1 if this list does not contain
  37630. this element.
  37631. </returns>
  37632. </member>
  37633. <member name="M:NPOI.Util.IntList.Remove(System.Int32)">
  37634. <summary>
  37635. Removes the element at the specified position in this list.
  37636. Shifts any subsequent elements to the left (subtracts one from
  37637. their indices). Returns the element that was Removed from the
  37638. list.
  37639. </summary>
  37640. <param name="index">the index of the element to Removed.</param>
  37641. <returns>return the element previously at the specified position.</returns>
  37642. </member>
  37643. <member name="M:NPOI.Util.IntList.RemoveValue(System.Int32)">
  37644. <summary>
  37645. Removes the first occurrence in this list of the specified
  37646. element (optional operation). If this list does not contain
  37647. the element, it is unChanged. More formally, Removes the
  37648. element with the lowest index i such that (o.Equals(get(i)))
  37649. (if such an element exists).
  37650. </summary>
  37651. <param name="o">element to be Removed from this list, if present.</param>
  37652. <returns>return true if this list Contained the specified element.</returns>
  37653. </member>
  37654. <member name="M:NPOI.Util.IntList.RemoveAll(NPOI.Util.IntList)">
  37655. <summary>
  37656. Removes from this list all the elements that are Contained in
  37657. the specified collection
  37658. </summary>
  37659. <param name="c">collection that defines which elements will be Removed from the list.</param>
  37660. <returns>return true if this list Changed as a result of the call.</returns>
  37661. </member>
  37662. <member name="M:NPOI.Util.IntList.RetainAll(NPOI.Util.IntList)">
  37663. <summary>
  37664. Retains only the elements in this list that are Contained in
  37665. the specified collection. In other words, Removes from this
  37666. list all the elements that are not Contained in the specified
  37667. collection.
  37668. </summary>
  37669. <param name="c">collection that defines which elements this Set will retain.</param>
  37670. <returns>return true if this list Changed as a result of the call.</returns>
  37671. </member>
  37672. <member name="M:NPOI.Util.IntList.Set(System.Int32,System.Int32)">
  37673. <summary>
  37674. Replaces the element at the specified position in this list with the specified element
  37675. </summary>
  37676. <param name="index">index of element to Replace.</param>
  37677. <param name="element">element to be stored at the specified position.</param>
  37678. <returns>the element previously at the specified position.</returns>
  37679. </member>
  37680. <member name="M:NPOI.Util.IntList.Size">
  37681. <summary>
  37682. Returns the number of elements in this list. If this list
  37683. Contains more than Int32.MaxValue elements, returns
  37684. Int32.MaxValue.
  37685. </summary>
  37686. <returns>the number of elements in this IntList</returns>
  37687. </member>
  37688. <member name="M:NPOI.Util.IntList.ToArray">
  37689. <summary>
  37690. Returns an array Containing all of the elements in this list in
  37691. proper sequence. Obeys the general contract of the
  37692. Collection.ToArray method.
  37693. </summary>
  37694. <returns>an array Containing all of the elements in this list in proper sequence.</returns>
  37695. </member>
  37696. <member name="M:NPOI.Util.IntList.ToArray(System.Int32[])">
  37697. <summary>
  37698. Returns an array Containing all of the elements in this list in
  37699. proper sequence. Obeys the general contract of the
  37700. Collection.ToArray(Object[]) method.
  37701. </summary>
  37702. <param name="a">the array into which the elements of this list are to
  37703. be stored, if it is big enough; otherwise, a new array
  37704. is allocated for this purpose.</param>
  37705. <returns>return an array Containing the elements of this list.</returns>
  37706. </member>
  37707. <member name="P:NPOI.Util.IntList.Count">
  37708. <summary>
  37709. the number of elements in this IntList
  37710. </summary>
  37711. </member>
  37712. <member name="T:NPOI.Util.IntMapper`1">
  37713. <summary>
  37714. A List of objects that are indexed AND keyed by an int; also allows for Getting
  37715. the index of a value in the list
  37716. <p>I am happy is someone wants to re-implement this without using the
  37717. internal list and hashmap. If so could you please make sure that
  37718. you can add elements half way into the list and have the value-key mappings
  37719. update</p>
  37720. </summary>
  37721. <typeparam name="T"></typeparam>
  37722. <remarks>@author Jason Height</remarks>
  37723. </member>
  37724. <member name="M:NPOI.Util.IntMapper`1.#ctor">
  37725. <summary>
  37726. create an IntMapper of default size
  37727. </summary>
  37728. </member>
  37729. <member name="M:NPOI.Util.IntMapper`1.Add(`0)">
  37730. <summary>
  37731. Appends the specified element to the end of this list
  37732. </summary>
  37733. <param name="value">element to be Appended to this list.</param>
  37734. <returns>return true (as per the general contract of the Collection.add method)</returns>
  37735. </member>
  37736. <member name="M:NPOI.Util.IntMapper`1.GetIndex(`0)">
  37737. <summary>
  37738. Gets the index of T object.
  37739. </summary>
  37740. <param name="o">The o.</param>
  37741. <returns></returns>
  37742. </member>
  37743. <member name="M:NPOI.Util.IntMapper`1.GetEnumerator">
  37744. <summary>
  37745. Gets the enumerator.
  37746. </summary>
  37747. <returns></returns>
  37748. </member>
  37749. <member name="P:NPOI.Util.IntMapper`1.Size">
  37750. <summary>
  37751. Gets the size.
  37752. </summary>
  37753. </member>
  37754. <member name="P:NPOI.Util.IntMapper`1.Item(System.Int32)">
  37755. <summary>
  37756. Gets the T object at the specified index.
  37757. </summary>
  37758. <param name="index"></param>
  37759. <returns></returns>
  37760. </member>
  37761. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream)">
  37762. <summary>
  37763. Reads all the data from the input stream, and returns
  37764. the bytes Read.
  37765. </summary>
  37766. <param name="stream">The stream.</param>
  37767. <returns></returns>
  37768. <remarks>Tony Qu changed the code</remarks>
  37769. </member>
  37770. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[])">
  37771. <summary>
  37772. Reads the fully.
  37773. </summary>
  37774. <param name="stream">The stream.</param>
  37775. <param name="b">The b.</param>
  37776. <returns></returns>
  37777. </member>
  37778. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  37779. <summary>
  37780. Same as the normal
  37781. <c>in.Read(b, off, len)</c>
  37782. , but tries to ensure that the entire len number of bytes is Read.
  37783. If the end of file is reached before any bytes are Read, returns -1.
  37784. If the end of the file is reached after some bytes are
  37785. Read, returns the number of bytes Read.
  37786. If the end of the file isn't reached before len
  37787. bytes have been Read, will return len bytes.
  37788. </summary>
  37789. <param name="stream">The stream.</param>
  37790. <param name="b">The b.</param>
  37791. <param name="off">The off.</param>
  37792. <param name="len">The len.</param>
  37793. <returns></returns>
  37794. </member>
  37795. <member name="M:NPOI.Util.IOUtils.Copy(System.IO.Stream,System.IO.Stream)">
  37796. <summary>
  37797. Copies all the data from the given InputStream to the OutputStream. It
  37798. leaves both streams open, so you will still need to close them once done.
  37799. </summary>
  37800. <param name="inp"></param>
  37801. <param name="out1"></param>
  37802. </member>
  37803. <member name="T:NPOI.Util.LittleEndianByteArrayInputStream">
  37804. <summary>
  37805. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianInput"/>
  37806. </summary>
  37807. <remarks>@author Josh Micich</remarks>
  37808. </member>
  37809. <member name="T:NPOI.Util.LittleEndianByteArrayOutputStream">
  37810. <summary>
  37811. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  37812. </summary>
  37813. <remarks>@author Josh Micich</remarks>
  37814. </member>
  37815. <member name="T:NPOI.Util.LittleEndianInputStream">
  37816. <summary>
  37817. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianInput"/><p/>
  37818. This class does not buffer any input, so the stream Read position maintained
  37819. by this class is consistent with that of the inner stream.
  37820. </summary>
  37821. <remarks>
  37822. @author Josh Micich
  37823. </remarks>
  37824. </member>
  37825. <member name="T:NPOI.Util.LittleEndianOutputStream">
  37826. <summary>
  37827. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  37828. </summary>
  37829. <remarks>@author Josh Micich</remarks>
  37830. </member>
  37831. <member name="T:NPOI.Util.LittleEndian">
  37832. <summary>
  37833. a utility class for handling little-endian numbers, which the 80x86 world is
  37834. replete with. The methods are all static, and input/output is from/to byte
  37835. arrays, or from InputStreams.
  37836. </summary>
  37837. <remarks>
  37838. @author Marc Johnson (mjohnson at apache dot org)
  37839. @author Andrew Oliver (acoliver at apache dot org)
  37840. </remarks>
  37841. </member>
  37842. <member name="M:NPOI.Util.LittleEndian.#ctor">
  37843. <summary>
  37844. Initializes a new instance of the <see cref="T:NPOI.Util.LittleEndian"/> class.
  37845. </summary>
  37846. </member>
  37847. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[],System.Int32)">
  37848. <summary>
  37849. get a short value from a byte array
  37850. </summary>
  37851. <param name="data">the byte array</param>
  37852. <param name="offset">a starting offset into the byte array</param>
  37853. <returns>the short (16-bit) value</returns>
  37854. </member>
  37855. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[],System.Int32)">
  37856. <summary>
  37857. get an unsigned short value from a byte array
  37858. </summary>
  37859. <param name="data">the byte array</param>
  37860. <param name="offset">a starting offset into the byte array</param>
  37861. <returns>the unsigned short (16-bit) value in an integer</returns>
  37862. </member>
  37863. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[])">
  37864. <summary>
  37865. get a short value from a byte array
  37866. </summary>
  37867. <param name="data">a starting offset into the byte array</param>
  37868. <returns>the short (16-bit) value</returns>
  37869. </member>
  37870. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[])">
  37871. <summary>
  37872. get a short value from a byte array
  37873. </summary>
  37874. <param name="data">the unsigned short (16-bit) value in an integer</param>
  37875. <returns></returns>
  37876. </member>
  37877. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[],System.Int32)">
  37878. <summary>
  37879. get an int value from a byte array
  37880. </summary>
  37881. <param name="data">the byte array</param>
  37882. <param name="offset">a starting offset into the byte array</param>
  37883. <returns>the int (32-bit) value</returns>
  37884. </member>
  37885. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[])">
  37886. <summary>
  37887. get an int value from the beginning of a byte array
  37888. </summary>
  37889. <param name="data">the byte array</param>
  37890. <returns>the int (32-bit) value</returns>
  37891. </member>
  37892. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[],System.Int32)">
  37893. <summary>
  37894. Gets the U int.
  37895. </summary>
  37896. <param name="data">the byte array</param>
  37897. <param name="offset">a starting offset into the byte array</param>
  37898. <returns>the unsigned int (32-bit) value in a long</returns>
  37899. </member>
  37900. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[])">
  37901. <summary>
  37902. Gets the U int.
  37903. </summary>
  37904. <param name="data">the byte array</param>
  37905. <returns>the unsigned int (32-bit) value in a long</returns>
  37906. </member>
  37907. <member name="M:NPOI.Util.LittleEndian.GetLong(System.Byte[],System.Int32)">
  37908. <summary>
  37909. get a long value from a byte array
  37910. </summary>
  37911. <param name="data">the byte array</param>
  37912. <param name="offset">a starting offset into the byte array</param>
  37913. <returns>the long (64-bit) value</returns>
  37914. </member>
  37915. <member name="M:NPOI.Util.LittleEndian.GetDouble(System.Byte[],System.Int32)">
  37916. <summary>
  37917. get a double value from a byte array, reads it in little endian format
  37918. then converts the resulting revolting IEEE 754 (curse them) floating
  37919. point number to a c# double
  37920. </summary>
  37921. <param name="data">the byte array</param>
  37922. <param name="offset">a starting offset into the byte array</param>
  37923. <returns>the double (64-bit) value</returns>
  37924. </member>
  37925. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int32,System.Int16)">
  37926. <summary>
  37927. Puts the short.
  37928. </summary>
  37929. <param name="data">the byte array</param>
  37930. <param name="offset">a starting offset into the byte array</param>
  37931. <param name="value">The value.</param>
  37932. </member>
  37933. <member name="M:NPOI.Util.LittleEndian.PutByte(System.Byte[],System.Int32,System.Int32)">
  37934. <summary>
  37935. Added for consistency with other put~() methods
  37936. </summary>
  37937. <param name="data">the byte array</param>
  37938. <param name="offset">a starting offset into the byte array</param>
  37939. <param name="value">The value.</param>
  37940. </member>
  37941. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32,System.Int32)">
  37942. <summary>
  37943. Puts the U short.
  37944. </summary>
  37945. <param name="data">the byte array</param>
  37946. <param name="offset">a starting offset into the byte array</param>
  37947. <param name="value">The value.</param>
  37948. </member>
  37949. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int16)">
  37950. <summary>
  37951. put a short value into beginning of a byte array
  37952. </summary>
  37953. <param name="data">the byte array</param>
  37954. <param name="value">the short (16-bit) value</param>
  37955. </member>
  37956. <member name="M:NPOI.Util.LittleEndian.PutShort(System.IO.Stream,System.Int16)">
  37957. Put signed short into output stream
  37958. @param value
  37959. the short (16-bit) value
  37960. @param outputStream
  37961. output stream
  37962. @throws IOException
  37963. if an I/O error occurs
  37964. </member>
  37965. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32,System.Int32)">
  37966. <summary>
  37967. put an int value into a byte array
  37968. </summary>
  37969. <param name="data">the byte array</param>
  37970. <param name="offset">a starting offset into the byte array</param>
  37971. <param name="value">the int (32-bit) value</param>
  37972. </member>
  37973. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32)">
  37974. <summary>
  37975. put an int value into beginning of a byte array
  37976. </summary>
  37977. <param name="data">the byte array</param>
  37978. <param name="value">the int (32-bit) value</param>
  37979. </member>
  37980. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Int32,System.IO.Stream)">
  37981. <summary>
  37982. Put int into output stream
  37983. </summary>
  37984. <param name="value">the int (32-bit) value</param>
  37985. <param name="outputStream">output stream</param>
  37986. </member>
  37987. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int32,System.Int64)">
  37988. <summary>
  37989. put a long value into a byte array
  37990. </summary>
  37991. <param name="data">the byte array</param>
  37992. <param name="offset">a starting offset into the byte array</param>
  37993. <param name="value">the long (64-bit) value</param>
  37994. </member>
  37995. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Int32,System.Double)">
  37996. <summary>
  37997. put a double value into a byte array
  37998. </summary>
  37999. <param name="data">the byte array</param>
  38000. <param name="offset">a starting offset into the byte array</param>
  38001. <param name="value">the double (64-bit) value</param>
  38002. </member>
  38003. <member name="M:NPOI.Util.LittleEndian.ReadShort(System.IO.Stream)">
  38004. <summary>
  38005. Reads the short.
  38006. </summary>
  38007. <param name="stream">The stream.</param>
  38008. <returns></returns>
  38009. </member>
  38010. <member name="M:NPOI.Util.LittleEndian.ReadInt(System.IO.Stream)">
  38011. <summary>
  38012. get an int value from an Stream
  38013. </summary>
  38014. <param name="stream">the Stream from which the int is to be read</param>
  38015. <returns>the int (32-bit) value</returns>
  38016. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  38017. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  38018. </member>
  38019. <member name="M:NPOI.Util.LittleEndian.ReadLong(System.IO.Stream)">
  38020. <summary>
  38021. get a long value from a Stream
  38022. </summary>
  38023. <param name="stream">the Stream from which the long is to be read</param>
  38024. <returns>the long (64-bit) value</returns>
  38025. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  38026. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  38027. </member>
  38028. <member name="M:NPOI.Util.LittleEndian.UByteToInt(System.Byte)">
  38029. <summary>
  38030. Us the byte to int.
  38031. </summary>
  38032. <param name="b">The b.</param>
  38033. <returns></returns>
  38034. </member>
  38035. <member name="M:NPOI.Util.LittleEndian.GetUnsignedByte(System.Byte[],System.Int32)">
  38036. <summary>
  38037. get the unsigned value of a byte.
  38038. </summary>
  38039. <param name="data">the byte array.</param>
  38040. <param name="offset">a starting offset into the byte array.</param>
  38041. <returns>the unsigned value of the byte as a 32 bit integer</returns>
  38042. </member>
  38043. <member name="M:NPOI.Util.LittleEndian.GetByteArray(System.Byte[],System.Int32,System.Int32)">
  38044. <summary>
  38045. Copy a portion of a byte array
  38046. </summary>
  38047. <param name="data"> the original byte array</param>
  38048. <param name="offset">Where to start copying from.</param>
  38049. <param name="size">Number of bytes to copy.</param>
  38050. <returns>The byteArray value</returns>
  38051. <exception cref="T:System.IndexOutOfRangeException">
  38052. if copying would cause access ofdata outside array bounds.
  38053. </exception>
  38054. </member>
  38055. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[])">
  38056. <summary>
  38057. Gets the unsigned byte.
  38058. </summary>
  38059. <param name="data">the byte array</param>
  38060. <returns></returns>
  38061. </member>
  38062. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[],System.Int32)">
  38063. <summary>
  38064. Gets the unsigned byte.
  38065. </summary>
  38066. <param name="data">the byte array</param>
  38067. <param name="offset">a starting offset into the byte array</param>
  38068. <returns></returns>
  38069. </member>
  38070. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Double)">
  38071. <summary>
  38072. Puts the double.
  38073. </summary>
  38074. <param name="data">the byte array</param>
  38075. <param name="value">The value.</param>
  38076. </member>
  38077. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Double,System.IO.Stream)">
  38078. put a double value into a byte array
  38079. @param value
  38080. the double (64-bit) value
  38081. @param outputStream
  38082. output stream
  38083. @throws IOException
  38084. if an I/O error occurs
  38085. </member>
  38086. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.UInt32)">
  38087. <summary>
  38088. Puts the uint.
  38089. </summary>
  38090. <param name="data">the byte array</param>
  38091. <param name="value">The value.</param>
  38092. </member>
  38093. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Int64,System.IO.Stream)">
  38094. Put unsigned int into output stream
  38095. @param value
  38096. the int (32-bit) value
  38097. @param outputStream
  38098. output stream
  38099. @throws IOException
  38100. if an I/O error occurs
  38101. </member>
  38102. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.Int32,System.UInt32)">
  38103. <summary>
  38104. Puts the uint.
  38105. </summary>
  38106. <param name="data">the byte array</param>
  38107. <param name="offset">a starting offset into the byte array</param>
  38108. <param name="value">The value.</param>
  38109. </member>
  38110. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int64)">
  38111. <summary>
  38112. Puts the long.
  38113. </summary>
  38114. <param name="data">the byte array</param>
  38115. <param name="value">The value.</param>
  38116. </member>
  38117. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Int64,System.IO.Stream)">
  38118. Put long into output stream
  38119. @param value
  38120. the long (64-bit) value
  38121. @param outputStream
  38122. output stream
  38123. @throws IOException
  38124. if an I/O error occurs
  38125. </member>
  38126. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.UInt64)">
  38127. <summary>
  38128. Puts the long.
  38129. </summary>
  38130. <param name="data">the byte array</param>
  38131. <param name="value">The value.</param>
  38132. </member>
  38133. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.Int32,System.UInt64)">
  38134. <summary>
  38135. Puts the ulong.
  38136. </summary>
  38137. <param name="data">the byte array</param>
  38138. <param name="offset">a starting offset into the byte array</param>
  38139. <param name="value">The value.</param>
  38140. </member>
  38141. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.Int64,System.Int32)">
  38142. <summary>
  38143. Puts the number.
  38144. </summary>
  38145. <param name="data">the byte array</param>
  38146. <param name="offset">a starting offset into the byte array</param>
  38147. <param name="value">The value.</param>
  38148. <param name="size">The size.</param>
  38149. </member>
  38150. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.UInt64,System.Int32)">
  38151. <summary>
  38152. Puts the number.
  38153. </summary>
  38154. <param name="data">the byte array</param>
  38155. <param name="offset">a starting offset into the byte array</param>
  38156. <param name="value">The value.</param>
  38157. <param name="size">The size.</param>
  38158. </member>
  38159. <member name="M:NPOI.Util.LittleEndian.PutShortArray(System.Byte[],System.Int32,System.Int16[])">
  38160. <summary>
  38161. Puts the short array.
  38162. </summary>
  38163. <param name="data">the byte array</param>
  38164. <param name="offset">a starting offset into the byte array</param>
  38165. <param name="value">The value.</param>
  38166. </member>
  38167. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32)">
  38168. <summary>
  38169. Puts the U short.
  38170. </summary>
  38171. <param name="data">the byte array</param>
  38172. <param name="value">The value.</param>
  38173. </member>
  38174. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Int32,System.IO.Stream)">
  38175. Put unsigned short into output stream
  38176. @param value
  38177. the unsigned short (16-bit) value
  38178. @param outputStream
  38179. output stream
  38180. @throws IOException
  38181. if an I/O error occurs
  38182. </member>
  38183. <member name="M:NPOI.Util.LittleEndian.ReadFromStream(System.IO.Stream,System.Int32)">
  38184. <summary>
  38185. Reads from stream.
  38186. </summary>
  38187. <param name="stream">The stream.</param>
  38188. <param name="size">The size.</param>
  38189. <returns></returns>
  38190. </member>
  38191. <member name="M:NPOI.Util.LittleEndian.ReadULong(System.IO.Stream)">
  38192. <summary>
  38193. Reads the long.
  38194. </summary>
  38195. <param name="stream">The stream.</param>
  38196. <returns></returns>
  38197. </member>
  38198. <member name="M:NPOI.Util.LongField.#ctor(System.Int32)">
  38199. <summary>
  38200. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  38201. </summary>
  38202. <param name="offset">The offset.</param>
  38203. </member>
  38204. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64)">
  38205. <summary>
  38206. construct the LongField with its offset into its containing
  38207. byte array and initialize its value
  38208. </summary>
  38209. <param name="offset">offset of the field within its byte array</param>
  38210. <param name="value">the initial value</param>
  38211. </member>
  38212. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Byte[])">
  38213. <summary>
  38214. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  38215. byte array and initialize its value from its byte array
  38216. </summary>
  38217. <param name="offset">The offset of the field within its byte array</param>
  38218. <param name="data">the byte array to read the value from</param>
  38219. </member>
  38220. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64,System.Byte[])">
  38221. <summary>
  38222. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  38223. byte array, initialize its value, and write the value to a byte
  38224. array
  38225. </summary>
  38226. <param name="offset">offset of the field within its byte array</param>
  38227. <param name="value">the initial value</param>
  38228. <param name="data">the byte array to write the value to</param>
  38229. </member>
  38230. <member name="M:NPOI.Util.LongField.Set(System.Int64,System.Byte[])">
  38231. <summary>
  38232. set the LongField's current value and write it to a byte array
  38233. </summary>
  38234. <param name="value">value to be set</param>
  38235. <param name="data">the byte array to write the value to</param>
  38236. </member>
  38237. <member name="M:NPOI.Util.LongField.ReadFromBytes(System.Byte[])">
  38238. <summary>
  38239. set the value from its offset into an array of bytes
  38240. </summary>
  38241. <param name="data">the byte array from which the value is to be read</param>
  38242. </member>
  38243. <member name="M:NPOI.Util.LongField.ReadFromStream(System.IO.Stream)">
  38244. <summary>
  38245. set the value from an Stream
  38246. </summary>
  38247. <param name="stream">the Stream from which the value is to be</param>
  38248. </member>
  38249. <member name="M:NPOI.Util.LongField.WriteToBytes(System.Byte[])">
  38250. <summary>
  38251. write the value out to an array of bytes at the appropriate offset
  38252. </summary>
  38253. <param name="data">the array of bytes to which the value is to be written</param>
  38254. </member>
  38255. <member name="M:NPOI.Util.LongField.Write(System.Int32,System.Int64,System.Byte[])">
  38256. <summary>
  38257. Same as using the constructor <see cref="T:NPOI.Util.LongField"/> with the same
  38258. parameter list. Avoid creation of an useless object.
  38259. </summary>
  38260. <param name="offset">offset of the field within its byte array</param>
  38261. <param name="value">the initial value</param>
  38262. <param name="data">the byte array to write the value to</param>
  38263. </member>
  38264. <member name="M:NPOI.Util.LongField.ToString">
  38265. <summary>
  38266. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  38267. </summary>
  38268. <returns>
  38269. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  38270. </returns>
  38271. </member>
  38272. <member name="P:NPOI.Util.LongField.Value">
  38273. <summary>
  38274. Getg or sets the LongField's current value
  38275. </summary>
  38276. <value>The current value</value>
  38277. </member>
  38278. <member name="T:NPOI.Util.LZWDecompresser">
  38279. This class provides common functionality for the
  38280. various LZW implementations in the different file
  38281. formats.
  38282. It's currently used by HDGF and HMEF.
  38283. Two good resources on LZW are:
  38284. http://en.wikipedia.org/wiki/LZW
  38285. http://marknelson.us/1989/10/01/lzw-data-compression/
  38286. </member>
  38287. <member name="F:NPOI.Util.LZWDecompresser.maskMeansCompressed">
  38288. Does the mask bit mean it's compressed or uncompressed?
  38289. </member>
  38290. <member name="F:NPOI.Util.LZWDecompresser.codeLengthIncrease">
  38291. How much to append to the code length in the stream
  38292. to Get the real code length? Normally 2 or 3
  38293. </member>
  38294. <member name="F:NPOI.Util.LZWDecompresser.positionIsBigEndian">
  38295. Does the 12 bits of the position Get stored in
  38296. Little Endian or Big Endian form?
  38297. This controls whether a pos+length of 0x12 0x34
  38298. becomes a position of 0x123 or 0x312
  38299. </member>
  38300. <member name="M:NPOI.Util.LZWDecompresser.populateDictionary(System.Byte[])">
  38301. Populates the dictionary, and returns where in it
  38302. to begin writing new codes.
  38303. Generally, if the dictionary is pre-populated, then new
  38304. codes should be placed at the end of that block.
  38305. Equally, if the dictionary is left with all zeros, then
  38306. usually the new codes can go in at the start.
  38307. </member>
  38308. <member name="M:NPOI.Util.LZWDecompresser.adjustDictionaryOffset(System.Int32)">
  38309. Adjusts the position offset if needed when looking
  38310. something up in the dictionary.
  38311. </member>
  38312. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream)">
  38313. Decompresses the given input stream, returning the array of bytes
  38314. of the decompressed input.
  38315. </member>
  38316. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream,System.IO.Stream)">
  38317. Perform a streaming decompression of the input.
  38318. Works by:
  38319. 1) Reading a flag byte, the 8 bits of which tell you if the
  38320. following 8 codes are compressed our un-compressed
  38321. 2) Consider the 8 bits in turn
  38322. 3) If the bit is Set, the next code is un-compressed, so
  38323. add it to the dictionary and output it
  38324. 4) If the bit isn't Set, then read in the length and start
  38325. position in the dictionary, and output the bytes there
  38326. 5) Loop until we've done all 8 bits, then read in the next
  38327. flag byte
  38328. </member>
  38329. <member name="M:NPOI.Util.LZWDecompresser.fromInt(System.Int32)">
  38330. Given an integer, turn it into a java byte, handling
  38331. the wrapping.
  38332. This is a convenience method
  38333. </member>
  38334. <member name="M:NPOI.Util.LZWDecompresser.fromByte(System.Byte)">
  38335. Given a java byte, turn it into an integer between 0
  38336. and 255 (i.e. handle the unwrapping).
  38337. This is a convenience method
  38338. </member>
  38339. <member name="T:NPOI.Util.NullLogger">
  38340. <summary>
  38341. A Logger class that strives to make it as easy as possible for
  38342. developers to write Log calls, while simultaneously making those
  38343. calls as cheap as possible by performing lazy evaluation of the Log
  38344. message.
  38345. @author Marc Johnson (mjohnson at apache dot org)
  38346. @author Glen Stampoultzis (glens at apache.org)
  38347. @author Nicola Ken Barozzi (nicolaken at apache.org)
  38348. </summary>
  38349. </member>
  38350. <member name="M:NPOI.Util.POILogger.#ctor">
  38351. package scope so it cannot be instantiated outside of the util
  38352. package. You need a POILogger? Go to the POILogFactory for one
  38353. </member>
  38354. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object)">
  38355. Log a message
  38356. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38357. @param obj1 The object to Log. This is converted to a string.
  38358. </member>
  38359. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Exception)">
  38360. Log a message
  38361. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38362. @param obj1 The object to Log. This is converted to a string.
  38363. @param exception An exception to be Logged
  38364. </member>
  38365. <member name="M:NPOI.Util.POILogger.Check(System.Int32)">
  38366. Check if a Logger is enabled to Log at the specified level
  38367. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38368. </member>
  38369. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object)">
  38370. Log a message. Lazily appends Object parameters together.
  38371. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38372. @param obj1 first object to place in the message
  38373. @param obj2 second object to place in the message
  38374. </member>
  38375. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  38376. Log a message. Lazily appends Object parameters together.
  38377. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38378. @param obj1 first Object to place in the message
  38379. @param obj2 second Object to place in the message
  38380. @param obj3 third Object to place in the message
  38381. </member>
  38382. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  38383. Log a message. Lazily appends Object parameters together.
  38384. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38385. @param obj1 first Object to place in the message
  38386. @param obj2 second Object to place in the message
  38387. @param obj3 third Object to place in the message
  38388. @param obj4 fourth Object to place in the message
  38389. </member>
  38390. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38391. Log a message. Lazily appends Object parameters together.
  38392. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38393. @param obj1 first Object to place in the message
  38394. @param obj2 second Object to place in the message
  38395. @param obj3 third Object to place in the message
  38396. @param obj4 fourth Object to place in the message
  38397. @param obj5 fifth Object to place in the message
  38398. </member>
  38399. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38400. Log a message. Lazily appends Object parameters together.
  38401. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38402. @param obj1 first Object to place in the message
  38403. @param obj2 second Object to place in the message
  38404. @param obj3 third Object to place in the message
  38405. @param obj4 fourth Object to place in the message
  38406. @param obj5 fifth Object to place in the message
  38407. @param obj6 sixth Object to place in the message
  38408. </member>
  38409. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38410. Log a message. Lazily appends Object parameters together.
  38411. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38412. @param obj1 first Object to place in the message
  38413. @param obj2 second Object to place in the message
  38414. @param obj3 third Object to place in the message
  38415. @param obj4 fourth Object to place in the message
  38416. @param obj5 fifth Object to place in the message
  38417. @param obj6 sixth Object to place in the message
  38418. @param obj7 seventh Object to place in the message
  38419. </member>
  38420. <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)">
  38421. Log a message. Lazily appends Object parameters together.
  38422. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38423. @param obj1 first Object to place in the message
  38424. @param obj2 second Object to place in the message
  38425. @param obj3 third Object to place in the message
  38426. @param obj4 fourth Object to place in the message
  38427. @param obj5 fifth Object to place in the message
  38428. @param obj6 sixth Object to place in the message
  38429. @param obj7 seventh Object to place in the message
  38430. @param obj8 eighth Object to place in the message
  38431. </member>
  38432. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Exception)">
  38433. Log an exception, without a message
  38434. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38435. @param exception An exception to be Logged
  38436. </member>
  38437. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  38438. Log a message. Lazily appends Object parameters together.
  38439. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38440. @param obj1 first Object to place in the message
  38441. @param obj2 second Object to place in the message
  38442. @param exception An exception to be Logged
  38443. </member>
  38444. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  38445. Log a message. Lazily appends Object parameters together.
  38446. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38447. @param obj1 first Object to place in the message
  38448. @param obj2 second Object to place in the message
  38449. @param obj3 third object to place in the message
  38450. @param exception An error message to be Logged
  38451. </member>
  38452. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38453. Log a message. Lazily appends Object parameters together.
  38454. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38455. @param obj1 first Object to place in the message
  38456. @param obj2 second Object to place in the message
  38457. @param obj3 third object to place in the message
  38458. @param obj4 fourth object to place in the message
  38459. @param exception An exception to be Logged
  38460. </member>
  38461. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38462. Log a message. Lazily appends Object parameters together.
  38463. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38464. @param obj1 first Object to place in the message
  38465. @param obj2 second Object to place in the message
  38466. @param obj3 third object to place in the message
  38467. @param obj4 fourth object to place in the message
  38468. @param obj5 fifth object to place in the message
  38469. @param exception An exception to be Logged
  38470. </member>
  38471. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38472. Log a message. Lazily appends Object parameters together.
  38473. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38474. @param obj1 first Object to place in the message
  38475. @param obj2 second Object to place in the message
  38476. @param obj3 third object to place in the message
  38477. @param obj4 fourth object to place in the message
  38478. @param obj5 fifth object to place in the message
  38479. @param obj6 sixth object to place in the message
  38480. @param exception An exception to be Logged
  38481. </member>
  38482. <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)">
  38483. Log a message. Lazily appends Object parameters together.
  38484. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38485. @param obj1 first Object to place in the message
  38486. @param obj2 second Object to place in the message
  38487. @param obj3 third object to place in the message
  38488. @param obj4 fourth object to place in the message
  38489. @param obj5 fifth object to place in the message
  38490. @param obj6 sixth object to place in the message
  38491. @param obj7 seventh object to place in the message
  38492. @param exception An exception to be Logged
  38493. </member>
  38494. <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)">
  38495. Log a message. Lazily appends Object parameters together.
  38496. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38497. @param obj1 first Object to place in the message
  38498. @param obj2 second Object to place in the message
  38499. @param obj3 third object to place in the message
  38500. @param obj4 fourth object to place in the message
  38501. @param obj5 fifth object to place in the message
  38502. @param obj6 sixth object to place in the message
  38503. @param obj7 seventh object to place in the message
  38504. @param obj8 eighth object to place in the message
  38505. @param exception An exception to be Logged
  38506. </member>
  38507. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object)">
  38508. Logs a formated message. The message itself may contain %
  38509. characters as place holders. This routine will attempt to match
  38510. the placeholder by looking at the type of parameter passed to
  38511. obj1.
  38512. If the parameter is an array, it traverses the array first and
  38513. matches parameters sequentially against the array items.
  38514. Otherwise the parameters after <c>message</c> are matched
  38515. in order.
  38516. If the place holder matches against a number it is printed as a
  38517. whole number. This can be overridden by specifying a precision
  38518. in the form %n.m where n is the padding for the whole part and
  38519. m is the number of decimal places to display. n can be excluded
  38520. if desired. n and m may not be more than 9.
  38521. If the last parameter (after flattening) is a Exception it is
  38522. Logged specially.
  38523. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38524. @param message The message to Log.
  38525. @param obj1 The first object to match against.
  38526. </member>
  38527. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object)">
  38528. Logs a formated message. The message itself may contain %
  38529. characters as place holders. This routine will attempt to match
  38530. the placeholder by looking at the type of parameter passed to
  38531. obj1.
  38532. If the parameter is an array, it traverses the array first and
  38533. matches parameters sequentially against the array items.
  38534. Otherwise the parameters after <c>message</c> are matched
  38535. in order.
  38536. If the place holder matches against a number it is printed as a
  38537. whole number. This can be overridden by specifying a precision
  38538. in the form %n.m where n is the padding for the whole part and
  38539. m is the number of decimal places to display. n can be excluded
  38540. if desired. n and m may not be more than 9.
  38541. If the last parameter (after flattening) is a Exception it is
  38542. Logged specially.
  38543. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38544. @param message The message to Log.
  38545. @param obj1 The first object to match against.
  38546. @param obj2 The second object to match against.
  38547. </member>
  38548. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object)">
  38549. Logs a formated message. The message itself may contain %
  38550. characters as place holders. This routine will attempt to match
  38551. the placeholder by looking at the type of parameter passed to
  38552. obj1.
  38553. If the parameter is an array, it traverses the array first and
  38554. matches parameters sequentially against the array items.
  38555. Otherwise the parameters after <c>message</c> are matched
  38556. in order.
  38557. If the place holder matches against a number it is printed as a
  38558. whole number. This can be overridden by specifying a precision
  38559. in the form %n.m where n is the padding for the whole part and
  38560. m is the number of decimal places to display. n can be excluded
  38561. if desired. n and m may not be more than 9.
  38562. If the last parameter (after flattening) is a Exception it is
  38563. Logged specially.
  38564. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38565. @param message The message to Log.
  38566. @param obj1 The first object to match against.
  38567. @param obj2 The second object to match against.
  38568. @param obj3 The third object to match against.
  38569. </member>
  38570. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object,System.Object)">
  38571. Logs a formated message. The message itself may contain %
  38572. characters as place holders. This routine will attempt to match
  38573. the placeholder by looking at the type of parameter passed to
  38574. obj1.
  38575. If the parameter is an array, it traverses the array first and
  38576. matches parameters sequentially against the array items.
  38577. Otherwise the parameters after <c>message</c> are matched
  38578. in order.
  38579. If the place holder matches against a number it is printed as a
  38580. whole number. This can be overridden by specifying a precision
  38581. in the form %n.m where n is the padding for the whole part and
  38582. m is the number of decimal places to display. n can be excluded
  38583. if desired. n and m may not be more than 9.
  38584. If the last parameter (after flattening) is a Exception it is
  38585. Logged specially.
  38586. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38587. @param message The message to Log.
  38588. @param obj1 The first object to match against.
  38589. @param obj2 The second object to match against.
  38590. @param obj3 The third object to match against.
  38591. @param obj4 The forth object to match against.
  38592. </member>
  38593. <member name="M:NPOI.Util.POILogger.FlattenArrays(System.Object[])">
  38594. Flattens any contained objects. Only tranverses one level deep.
  38595. </member>
  38596. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object)">
  38597. Log a message
  38598. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38599. @param obj1 The object to Log.
  38600. </member>
  38601. <member name="M:NPOI.Util.NullLogger.Check(System.Int32)">
  38602. Check if a Logger is enabled to Log at the specified level
  38603. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38604. </member>
  38605. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object)">
  38606. Log a message. Lazily appends Object parameters together.
  38607. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38608. @param obj1 first object to place in the message
  38609. @param obj2 second object to place in the message
  38610. </member>
  38611. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  38612. Log a message. Lazily appends Object parameters together.
  38613. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38614. @param obj1 first Object to place in the message
  38615. @param obj2 second Object to place in the message
  38616. @param obj3 third Object to place in the message
  38617. </member>
  38618. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  38619. Log a message. Lazily appends Object parameters together.
  38620. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38621. @param obj1 first Object to place in the message
  38622. @param obj2 second Object to place in the message
  38623. @param obj3 third Object to place in the message
  38624. @param obj4 fourth Object to place in the message
  38625. </member>
  38626. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38627. Log a message. Lazily appends Object parameters together.
  38628. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38629. @param obj1 first Object to place in the message
  38630. @param obj2 second Object to place in the message
  38631. @param obj3 third Object to place in the message
  38632. @param obj4 fourth Object to place in the message
  38633. @param obj5 fifth Object to place in the message
  38634. </member>
  38635. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38636. Log a message. Lazily appends Object parameters together.
  38637. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38638. @param obj1 first Object to place in the message
  38639. @param obj2 second Object to place in the message
  38640. @param obj3 third Object to place in the message
  38641. @param obj4 fourth Object to place in the message
  38642. @param obj5 fifth Object to place in the message
  38643. @param obj6 sixth Object to place in the message
  38644. </member>
  38645. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  38646. Log a message. Lazily appends Object parameters together.
  38647. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38648. @param obj1 first Object to place in the message
  38649. @param obj2 second Object to place in the message
  38650. @param obj3 third Object to place in the message
  38651. @param obj4 fourth Object to place in the message
  38652. @param obj5 fifth Object to place in the message
  38653. @param obj6 sixth Object to place in the message
  38654. @param obj7 seventh Object to place in the message
  38655. </member>
  38656. <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)">
  38657. Log a message. Lazily appends Object parameters together.
  38658. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38659. @param obj1 first Object to place in the message
  38660. @param obj2 second Object to place in the message
  38661. @param obj3 third Object to place in the message
  38662. @param obj4 fourth Object to place in the message
  38663. @param obj5 fifth Object to place in the message
  38664. @param obj6 sixth Object to place in the message
  38665. @param obj7 seventh Object to place in the message
  38666. @param obj8 eighth Object to place in the message
  38667. </member>
  38668. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Exception)">
  38669. Log a message
  38670. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38671. @param obj1 The object to Log. This is converted to a string.
  38672. @param exception An exception to be Logged
  38673. </member>
  38674. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  38675. Log a message. Lazily appends Object parameters together.
  38676. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38677. @param obj1 first Object to place in the message
  38678. @param obj2 second Object to place in the message
  38679. @param exception An exception to be Logged
  38680. </member>
  38681. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  38682. Log a message. Lazily appends Object parameters together.
  38683. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38684. @param obj1 first Object to place in the message
  38685. @param obj2 second Object to place in the message
  38686. @param obj3 third object to place in the message
  38687. @param exception An error message to be Logged
  38688. </member>
  38689. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38690. Log a message. Lazily appends Object parameters together.
  38691. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38692. @param obj1 first Object to place in the message
  38693. @param obj2 second Object to place in the message
  38694. @param obj3 third object to place in the message
  38695. @param obj4 fourth object to place in the message
  38696. @param exception An exception to be Logged
  38697. </member>
  38698. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38699. Log a message. Lazily appends Object parameters together.
  38700. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38701. @param obj1 first Object to place in the message
  38702. @param obj2 second Object to place in the message
  38703. @param obj3 third object to place in the message
  38704. @param obj4 fourth object to place in the message
  38705. @param obj5 fifth object to place in the message
  38706. @param exception An exception to be Logged
  38707. </member>
  38708. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  38709. Log a message. Lazily appends Object parameters together.
  38710. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38711. @param obj1 first Object to place in the message
  38712. @param obj2 second Object to place in the message
  38713. @param obj3 third object to place in the message
  38714. @param obj4 fourth object to place in the message
  38715. @param obj5 fifth object to place in the message
  38716. @param obj6 sixth object to place in the message
  38717. @param exception An exception to be Logged
  38718. </member>
  38719. <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)">
  38720. Log a message. Lazily appends Object parameters together.
  38721. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38722. @param obj1 first Object to place in the message
  38723. @param obj2 second Object to place in the message
  38724. @param obj3 third object to place in the message
  38725. @param obj4 fourth object to place in the message
  38726. @param obj5 fifth object to place in the message
  38727. @param obj6 sixth object to place in the message
  38728. @param obj7 seventh object to place in the message
  38729. @param exception An exception to be Logged
  38730. </member>
  38731. <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)">
  38732. Log a message. Lazily appends Object parameters together.
  38733. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38734. @param obj1 first Object to place in the message
  38735. @param obj2 second Object to place in the message
  38736. @param obj3 third object to place in the message
  38737. @param obj4 fourth object to place in the message
  38738. @param obj5 fifth object to place in the message
  38739. @param obj6 sixth object to place in the message
  38740. @param obj7 seventh object to place in the message
  38741. @param obj8 eighth object to place in the message
  38742. @param exception An exception to be Logged
  38743. </member>
  38744. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object)">
  38745. Logs a formated message. The message itself may contain %
  38746. characters as place holders. This routine will attempt to match
  38747. the placeholder by looking at the type of parameter passed to
  38748. obj1.
  38749. If the parameter is an array, it traverses the array first and
  38750. matches parameters sequentially against the array items.
  38751. Otherwise the parameters after <c>message</c> are matched
  38752. in order.
  38753. If the place holder matches against a number it is printed as a
  38754. whole number. This can be overridden by specifying a precision
  38755. in the form %n.m where n is the padding for the whole part and
  38756. m is the number of decimal places to display. n can be excluded
  38757. if desired. n and m may not be more than 9.
  38758. If the last parameter (after flattening) is a Exception it is
  38759. Logged specially.
  38760. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38761. @param message The message to Log.
  38762. @param obj1 The first object to match against.
  38763. </member>
  38764. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object)">
  38765. Logs a formated message. The message itself may contain %
  38766. characters as place holders. This routine will attempt to match
  38767. the placeholder by looking at the type of parameter passed to
  38768. obj1.
  38769. If the parameter is an array, it traverses the array first and
  38770. matches parameters sequentially against the array items.
  38771. Otherwise the parameters after <c>message</c> are matched
  38772. in order.
  38773. If the place holder matches against a number it is printed as a
  38774. whole number. This can be overridden by specifying a precision
  38775. in the form %n.m where n is the padding for the whole part and
  38776. m is the number of decimal places to display. n can be excluded
  38777. if desired. n and m may not be more than 9.
  38778. If the last parameter (after flattening) is a Exception it is
  38779. Logged specially.
  38780. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38781. @param message The message to Log.
  38782. @param obj1 The first object to match against.
  38783. @param obj2 The second object to match against.
  38784. </member>
  38785. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object)">
  38786. Logs a formated message. The message itself may contain %
  38787. characters as place holders. This routine will attempt to match
  38788. the placeholder by looking at the type of parameter passed to
  38789. obj1.
  38790. If the parameter is an array, it traverses the array first and
  38791. matches parameters sequentially against the array items.
  38792. Otherwise the parameters after <c>message</c> are matched
  38793. in order.
  38794. If the place holder matches against a number it is printed as a
  38795. whole number. This can be overridden by specifying a precision
  38796. in the form %n.m where n is the padding for the whole part and
  38797. m is the number of decimal places to display. n can be excluded
  38798. if desired. n and m may not be more than 9.
  38799. If the last parameter (after flattening) is a Exception it is
  38800. Logged specially.
  38801. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38802. @param message The message to Log.
  38803. @param obj1 The first object to match against.
  38804. @param obj2 The second object to match against.
  38805. @param obj3 The third object to match against.
  38806. </member>
  38807. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object,System.Object)">
  38808. Logs a formated message. The message itself may contain %
  38809. characters as place holders. This routine will attempt to match
  38810. the placeholder by looking at the type of parameter passed to
  38811. obj1.
  38812. If the parameter is an array, it traverses the array first and
  38813. matches parameters sequentially against the array items.
  38814. Otherwise the parameters after <c>message</c> are matched
  38815. in order.
  38816. If the place holder matches against a number it is printed as a
  38817. whole number. This can be overridden by specifying a precision
  38818. in the form %n.m where n is the padding for the whole part and
  38819. m is the number of decimal places to display. n can be excluded
  38820. if desired. n and m may not be more than 9.
  38821. If the last parameter (after flattening) is a Exception it is
  38822. Logged specially.
  38823. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  38824. @param message The message to Log.
  38825. @param obj1 The first object to match against.
  38826. @param obj2 The second object to match against.
  38827. @param obj3 The third object to match against.
  38828. @param obj4 The forth object to match against.
  38829. </member>
  38830. <member name="F:NPOI.Util.PngUtils.PNG_FILE_HEADER">
  38831. File header for PNG format.
  38832. </member>
  38833. <member name="M:NPOI.Util.PngUtils.MatchesPngHeader(System.Byte[],System.Int32)">
  38834. Checks if the offset matches the PNG header.
  38835. @param data the data to check.
  38836. @param offset the offset to check at.
  38837. @return {@code true} if the offset matches.
  38838. </member>
  38839. <member name="F:NPOI.Util.POILogFactory._loggers">
  38840. Map of POILogger instances, with classes as keys
  38841. </member>
  38842. <member name="F:NPOI.Util.POILogFactory._nullLogger">
  38843. A common instance of NullLogger, as it does nothing
  38844. we only need the one
  38845. </member>
  38846. <member name="F:NPOI.Util.POILogFactory._loggerClassName">
  38847. The name of the class to use. Initialised the
  38848. first time we need it
  38849. </member>
  38850. <member name="M:NPOI.Util.POILogFactory.#ctor">
  38851. <summary>
  38852. Initializes a new instance of the <see cref="T:NPOI.Util.POILogFactory"/> class.
  38853. </summary>
  38854. </member>
  38855. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.Type)">
  38856. <summary>
  38857. Get a logger, based on a class name
  38858. </summary>
  38859. <param name="type">the class whose name defines the log</param>
  38860. <returns>a POILogger for the specified class</returns>
  38861. </member>
  38862. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.String)">
  38863. <summary>
  38864. Get a logger, based on a String
  38865. </summary>
  38866. <param name="cat">the String that defines the log</param>
  38867. <returns>a POILogger for the specified class</returns>
  38868. </member>
  38869. <member name="M:NPOI.Util.PushbackStream.ReadByte">
  38870. <summary>
  38871. 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.
  38872. </summary>
  38873. <returns>
  38874. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  38875. </returns>
  38876. <exception cref="T:System.NotSupportedException">
  38877. The stream does not support reading.
  38878. </exception>
  38879. <exception cref="T:System.ObjectDisposedException">
  38880. Methods were called after the stream was closed.
  38881. </exception>
  38882. </member>
  38883. <member name="M:NPOI.Util.PushbackStream.Read(System.Byte[],System.Int32,System.Int32)">
  38884. <summary>
  38885. 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.
  38886. </summary>
  38887. <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>
  38888. <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>
  38889. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  38890. <returns>
  38891. 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.
  38892. </returns>
  38893. <exception cref="T:System.ArgumentException">
  38894. The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
  38895. </exception>
  38896. <exception cref="T:System.ArgumentNullException">
  38897. <paramref name="buffer"/> is null.
  38898. </exception>
  38899. <exception cref="T:System.ArgumentOutOfRangeException">
  38900. <paramref name="offset"/> or <paramref name="count"/> is negative.
  38901. </exception>
  38902. <exception cref="T:System.IO.IOException">
  38903. An I/O error occurs.
  38904. </exception>
  38905. <exception cref="T:System.NotSupportedException">
  38906. The stream does not support reading.
  38907. </exception>
  38908. <exception cref="T:System.ObjectDisposedException">
  38909. Methods were called after the stream was closed.
  38910. </exception>
  38911. </member>
  38912. <member name="M:NPOI.Util.PushbackStream.Unread(System.Int32)">
  38913. <summary>
  38914. Unreads the specified b.
  38915. </summary>
  38916. <param name="b">The b.</param>
  38917. </member>
  38918. <member name="M:NPOI.Util.PushbackStream.Close">
  38919. <summary>
  38920. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  38921. </summary>
  38922. </member>
  38923. <member name="M:NPOI.Util.PushbackStream.Flush">
  38924. <summary>
  38925. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  38926. </summary>
  38927. <exception cref="T:System.IO.IOException">
  38928. An I/O error occurs.
  38929. </exception>
  38930. </member>
  38931. <member name="M:NPOI.Util.PushbackStream.Seek(System.Int64,System.IO.SeekOrigin)">
  38932. <summary>
  38933. When overridden in a derived class, sets the position within the current stream.
  38934. </summary>
  38935. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  38936. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  38937. <returns>
  38938. The new position within the current stream.
  38939. </returns>
  38940. <exception cref="T:System.IO.IOException">
  38941. An I/O error occurs.
  38942. </exception>
  38943. <exception cref="T:System.NotSupportedException">
  38944. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  38945. </exception>
  38946. <exception cref="T:System.ObjectDisposedException">
  38947. Methods were called after the stream was closed.
  38948. </exception>
  38949. </member>
  38950. <member name="M:NPOI.Util.PushbackStream.SetLength(System.Int64)">
  38951. <summary>
  38952. When overridden in a derived class, sets the length of the current stream.
  38953. </summary>
  38954. <param name="value">The desired length of the current stream in bytes.</param>
  38955. <exception cref="T:System.IO.IOException">
  38956. An I/O error occurs.
  38957. </exception>
  38958. <exception cref="T:System.NotSupportedException">
  38959. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  38960. </exception>
  38961. <exception cref="T:System.ObjectDisposedException">
  38962. Methods were called after the stream was closed.
  38963. </exception>
  38964. </member>
  38965. <member name="M:NPOI.Util.PushbackStream.Write(System.Byte[],System.Int32,System.Int32)">
  38966. <summary>
  38967. 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.
  38968. </summary>
  38969. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  38970. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  38971. <param name="count">The number of bytes to be written to the current stream.</param>
  38972. <exception cref="T:System.ArgumentException">
  38973. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  38974. </exception>
  38975. <exception cref="T:System.ArgumentNullException">
  38976. <paramref name="buffer"/> is null.
  38977. </exception>
  38978. <exception cref="T:System.ArgumentOutOfRangeException">
  38979. <paramref name="offset"/> or <paramref name="count"/> is negative.
  38980. </exception>
  38981. <exception cref="T:System.IO.IOException">
  38982. An I/O error occurs.
  38983. </exception>
  38984. <exception cref="T:System.NotSupportedException">
  38985. The stream does not support writing.
  38986. </exception>
  38987. <exception cref="T:System.ObjectDisposedException">
  38988. Methods were called after the stream was closed.
  38989. </exception>
  38990. </member>
  38991. <member name="M:NPOI.Util.PushbackStream.WriteByte(System.Byte)">
  38992. <summary>
  38993. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  38994. </summary>
  38995. <param name="value">The byte to write to the stream.</param>
  38996. <exception cref="T:System.IO.IOException">
  38997. An I/O error occurs.
  38998. </exception>
  38999. <exception cref="T:System.NotSupportedException">
  39000. The stream does not support writing, or the stream is already closed.
  39001. </exception>
  39002. <exception cref="T:System.ObjectDisposedException">
  39003. Methods were called after the stream was closed.
  39004. </exception>
  39005. </member>
  39006. <member name="P:NPOI.Util.PushbackStream.CanRead">
  39007. <summary>
  39008. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  39009. </summary>
  39010. <value></value>
  39011. <returns>true if the stream supports reading; otherwise, false.
  39012. </returns>
  39013. </member>
  39014. <member name="P:NPOI.Util.PushbackStream.CanSeek">
  39015. <summary>
  39016. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  39017. </summary>
  39018. <value></value>
  39019. <returns>true if the stream supports seeking; otherwise, false.
  39020. </returns>
  39021. </member>
  39022. <member name="P:NPOI.Util.PushbackStream.CanWrite">
  39023. <summary>
  39024. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  39025. </summary>
  39026. <value></value>
  39027. <returns>true if the stream supports writing; otherwise, false.
  39028. </returns>
  39029. </member>
  39030. <member name="P:NPOI.Util.PushbackStream.Length">
  39031. <summary>
  39032. When overridden in a derived class, gets the length in bytes of the stream.
  39033. </summary>
  39034. <value></value>
  39035. <returns>
  39036. A long value representing the length of the stream in bytes.
  39037. </returns>
  39038. <exception cref="T:System.NotSupportedException">
  39039. A class derived from Stream does not support seeking.
  39040. </exception>
  39041. <exception cref="T:System.ObjectDisposedException">
  39042. Methods were called after the stream was closed.
  39043. </exception>
  39044. </member>
  39045. <member name="P:NPOI.Util.PushbackStream.Position">
  39046. <summary>
  39047. When overridden in a derived class, gets or sets the position within the current stream.
  39048. </summary>
  39049. <value></value>
  39050. <returns>
  39051. The current position within the stream.
  39052. </returns>
  39053. <exception cref="T:System.IO.IOException">
  39054. An I/O error occurs.
  39055. </exception>
  39056. <exception cref="T:System.NotSupportedException">
  39057. The stream does not support seeking.
  39058. </exception>
  39059. <exception cref="T:System.ObjectDisposedException">
  39060. Methods were called after the stream was closed.
  39061. </exception>
  39062. </member>
  39063. <member name="T:NPOI.Util.RecordFormatException">
  39064. A common exception thrown by our binary format Parsers
  39065. (especially HSSF and DDF), when they hit invalid
  39066. format or data when Processing a record.
  39067. </member>
  39068. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32)">
  39069. <summary>
  39070. construct the ShortField with its offset into its containing
  39071. byte array
  39072. </summary>
  39073. <param name="offset">offset of the field within its byte array</param>
  39074. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  39075. </member>
  39076. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16)">
  39077. <summary>
  39078. construct the ShortField with its offset into its containing byte array and initialize its value
  39079. </summary>
  39080. <param name="offset">offset of the field within its byte array</param>
  39081. <param name="value">the initial value</param>
  39082. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  39083. </member>
  39084. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Byte[])">
  39085. <summary>
  39086. Construct the ShortField with its offset into its containing
  39087. byte array and initialize its value from its byte array
  39088. </summary>
  39089. <param name="offset">offset of the field within its byte array</param>
  39090. <param name="data">the byte array to read the value from</param>
  39091. <exception cref="T:System.IndexOutOfRangeException">if the offset is not
  39092. within the range of 0..(data.length - 1)</exception>
  39093. </member>
  39094. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16,System.Byte[]@)">
  39095. <summary>
  39096. construct the ShortField with its offset into its containing
  39097. byte array, initialize its value, and write its value to its
  39098. byte array
  39099. </summary>
  39100. <param name="offset">offset of the field within its byte array</param>
  39101. <param name="value">the initial value</param>
  39102. <param name="data">the byte array to write the value to</param>
  39103. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  39104. </member>
  39105. <member name="M:NPOI.Util.ShortField.Set(System.Int16,System.Byte[]@)">
  39106. <summary>
  39107. set the ShortField's current value and write it to a byte array
  39108. </summary>
  39109. <param name="value">value to be set</param>
  39110. <param name="data">the byte array to write the value to</param>
  39111. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  39112. of range</exception>
  39113. </member>
  39114. <member name="M:NPOI.Util.ShortField.ReadFromBytes(System.Byte[])">
  39115. <summary>
  39116. set the value from its offset into an array of bytes
  39117. </summary>
  39118. <param name="data">the byte array from which the value is to be read</param>
  39119. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  39120. of range</exception>
  39121. </member>
  39122. <member name="M:NPOI.Util.ShortField.ReadFromStream(System.IO.Stream)">
  39123. <summary>
  39124. set the value from an Stream
  39125. </summary>
  39126. <param name="stream">the Stream from which the value is to be
  39127. read</param>
  39128. <exception cref="T:System.IO.IOException">if an IOException is thrown from reading
  39129. the Stream</exception>
  39130. <exception cref="T:NPOI.Util.BufferUnderrunException">if there is not enough data
  39131. available from the Stream</exception>
  39132. </member>
  39133. <member name="M:NPOI.Util.ShortField.WriteToBytes(System.Byte[])">
  39134. <summary>
  39135. write the value out to an array of bytes at the appropriate
  39136. offset
  39137. </summary>
  39138. <param name="data">the array of bytes to which the value is to be
  39139. written</param>
  39140. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  39141. of range</exception>
  39142. </member>
  39143. <member name="M:NPOI.Util.ShortField.Write(System.Int32,System.Int16,System.Byte[]@)">
  39144. <summary>
  39145. Same as using the constructor <see cref="T:NPOI.Util.ShortField"/> with the same
  39146. parameter list. Avoid creation of an useless object.
  39147. </summary>
  39148. <param name="offset">offset of the field within its byte array</param>
  39149. <param name="value">the initial value</param>
  39150. <param name="data">the byte array to write the value to</param>
  39151. </member>
  39152. <member name="M:NPOI.Util.ShortField.ToString">
  39153. <summary>
  39154. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39155. </summary>
  39156. <returns>
  39157. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39158. </returns>
  39159. </member>
  39160. <member name="P:NPOI.Util.ShortField.Value">
  39161. <summary>
  39162. Gets or sets the value.
  39163. </summary>
  39164. <value>The value.</value>
  39165. </member>
  39166. <member name="T:NPOI.Util.ShortList">
  39167. <summary>
  39168. A List of short's; as full an implementation of the java.Util.List
  39169. interface as possible, with an eye toward minimal creation of
  39170. objects
  39171. the mimicry of List is as follows:
  39172. <ul>
  39173. <li> if possible, operations designated 'optional' in the List
  39174. interface are attempted</li>
  39175. <li> wherever the List interface refers to an Object, substitute
  39176. short</li>
  39177. <li> wherever the List interface refers to a Collection or List,
  39178. substitute shortList</li>
  39179. </ul>
  39180. the mimicry is not perfect, however:
  39181. <ul>
  39182. <li> operations involving Iterators or ListIterators are not
  39183. supported</li>
  39184. <li> Remove(Object) becomes RemoveValue to distinguish it from
  39185. Remove(short index)</li>
  39186. <li> subList is not supported</li>
  39187. </ul>
  39188. </summary>
  39189. </member>
  39190. <member name="M:NPOI.Util.ShortList.#ctor">
  39191. <summary>
  39192. create an shortList of default size
  39193. </summary>
  39194. </member>
  39195. <member name="M:NPOI.Util.ShortList.#ctor(NPOI.Util.ShortList)">
  39196. <summary>
  39197. create a copy of an existing shortList
  39198. </summary>
  39199. <param name="list">the existing shortList</param>
  39200. </member>
  39201. <member name="M:NPOI.Util.ShortList.#ctor(System.Int32)">
  39202. <summary>
  39203. create an shortList with a predefined Initial size
  39204. </summary>
  39205. <param name="InitialCapacity">the size for the internal array</param>
  39206. </member>
  39207. <member name="M:NPOI.Util.ShortList.Add(System.Int32,System.Int16)">
  39208. <summary>
  39209. add the specfied value at the specified index
  39210. </summary>
  39211. <param name="index">the index where the new value is to be Added</param>
  39212. <param name="value">the new value</param>
  39213. </member>
  39214. <member name="M:NPOI.Util.ShortList.Add(System.Int16)">
  39215. <summary>
  39216. Appends the specified element to the end of this list
  39217. </summary>
  39218. <param name="value">element to be Appended to this list.</param>
  39219. <returns>return true (as per the general contract of the Collection.add method).</returns>
  39220. </member>
  39221. <member name="M:NPOI.Util.ShortList.AddAll(NPOI.Util.ShortList)">
  39222. <summary>
  39223. Appends all of the elements in the specified collection to the
  39224. end of this list, in the order that they are returned by the
  39225. specified collection's iterator. The behavior of this
  39226. operation is unspecified if the specified collection is
  39227. modified while the operation is in progress. (Note that this
  39228. will occur if the specified collection is this list, and it's
  39229. nonempty.)
  39230. </summary>
  39231. <param name="c">collection whose elements are to be Added to this list.</param>
  39232. <returns>return true if this list Changed as a result of the call.</returns>
  39233. </member>
  39234. <member name="M:NPOI.Util.ShortList.AddAll(System.Int32,NPOI.Util.ShortList)">
  39235. <summary>
  39236. Inserts all of the elements in the specified collection into
  39237. this list at the specified position. Shifts the element
  39238. currently at that position (if any) and any subsequent elements
  39239. to the right (increases their indices). The new elements will
  39240. appear in this list in the order that they are returned by the
  39241. specified collection's iterator. The behavior of this
  39242. operation is unspecified if the specified collection is
  39243. modified while the operation is in progress. (Note that this
  39244. will occur if the specified collection is this list, and it's
  39245. nonempty.)
  39246. </summary>
  39247. <param name="index">index at which to insert first element from the specified collection.</param>
  39248. <param name="c">elements to be inserted into this list.</param>
  39249. <returns>return true if this list Changed as a result of the call.</returns>
  39250. <exception cref="T:System.IndexOutOfRangeException"> if the index is out of range (index &lt; 0 || index &gt; size())</exception>
  39251. </member>
  39252. <member name="M:NPOI.Util.ShortList.Clear">
  39253. <summary>
  39254. Removes all of the elements from this list. This list will be
  39255. empty After this call returns (unless it throws an exception).
  39256. </summary>
  39257. </member>
  39258. <member name="M:NPOI.Util.ShortList.Contains(System.Int16)">
  39259. <summary>
  39260. Returns true if this list Contains the specified element. More
  39261. formally, returns true if and only if this list Contains at
  39262. least one element e such that o == e
  39263. </summary>
  39264. <param name="o">element whose presence in this list is to be Tested.</param>
  39265. <returns>return true if this list Contains the specified element.</returns>
  39266. </member>
  39267. <member name="M:NPOI.Util.ShortList.ContainsAll(NPOI.Util.ShortList)">
  39268. <summary>
  39269. Returns true if this list Contains all of the elements of the specified collection.
  39270. </summary>
  39271. <param name="c">collection to be Checked for Containment in this list.</param>
  39272. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  39273. </member>
  39274. <member name="M:NPOI.Util.ShortList.Equals(System.Object)">
  39275. <summary>
  39276. Compares the specified object with this list for Equality.
  39277. Returns true if and only if the specified object is also a
  39278. list, both lists have the same size, and all corresponding
  39279. pairs of elements in the two lists are Equal. (Two elements e1
  39280. and e2 are equal if e1 == e2.) In other words, two lists are
  39281. defined to be equal if they contain the same elements in the
  39282. same order. This defInition ensures that the Equals method
  39283. works properly across different implementations of the List
  39284. interface.
  39285. </summary>
  39286. <param name="o">the object to be Compared for Equality with this list.</param>
  39287. <returns>return true if the specified object is equal to this list.</returns>
  39288. </member>
  39289. <member name="M:NPOI.Util.ShortList.Get(System.Int32)">
  39290. <summary>
  39291. Returns the element at the specified position in this list.
  39292. </summary>
  39293. <param name="index">index of element to return.</param>
  39294. <returns>return the element at the specified position in this list.</returns>
  39295. </member>
  39296. <member name="M:NPOI.Util.ShortList.GetHashCode">
  39297. <summary>
  39298. Returns the hash code value for this list. The hash code of a
  39299. list is defined to be the result of the following calculation:
  39300. <code>
  39301. hashCode = 1;
  39302. Iterator i = list.Iterator();
  39303. while (i.HasNext()) {
  39304. Object obj = i.Next();
  39305. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  39306. }
  39307. </code>
  39308. This ensures that list1.Equals(list2) implies that
  39309. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  39310. list2, as required by the general contract of Object.HashCode.
  39311. </summary>
  39312. <returns>return the hash code value for this list.</returns>
  39313. </member>
  39314. <member name="M:NPOI.Util.ShortList.IndexOf(System.Int16)">
  39315. <summary>
  39316. Returns the index in this list of the first occurrence of the
  39317. specified element, or -1 if this list does not contain this
  39318. element. More formally, returns the lowest index i such that
  39319. (o == Get(i)), or -1 if there is no such index.
  39320. </summary>
  39321. <param name="o">element to search for.</param>
  39322. <returns>the index in this list of the first occurrence of the
  39323. specified element, or -1 if this list does not contain
  39324. this element.
  39325. </returns>
  39326. </member>
  39327. <member name="M:NPOI.Util.ShortList.IsEmpty">
  39328. <summary>
  39329. Returns true if this list Contains no elements.
  39330. </summary>
  39331. <returns>return true if this list Contains no elements.</returns>
  39332. </member>
  39333. <member name="M:NPOI.Util.ShortList.LastIndexOf(System.Int16)">
  39334. <summary>
  39335. Returns the index in this list of the last occurrence of the
  39336. specified element, or -1 if this list does not contain this
  39337. element. More formally, returns the highest index i such that
  39338. (o == Get(i)), or -1 if there is no such index.
  39339. </summary>
  39340. <param name="o">element to search for.</param>
  39341. <returns>return the index in this list of the last occurrence of the
  39342. specified element, or -1 if this list does not contain this element.</returns>
  39343. </member>
  39344. <member name="M:NPOI.Util.ShortList.Remove(System.Int32)">
  39345. <summary>
  39346. Removes the element at the specified position in this list.
  39347. Shifts any subsequent elements to the left (subtracts one from
  39348. their indices). Returns the element that was Removed from the
  39349. list.
  39350. </summary>
  39351. <param name="index">the index of the element to Removed.</param>
  39352. <returns>return the element previously at the specified position.</returns>
  39353. </member>
  39354. <member name="M:NPOI.Util.ShortList.RemoveValue(System.Int16)">
  39355. <summary>
  39356. Removes the first occurrence in this list of the specified
  39357. element (optional operation). If this list does not contain
  39358. the element, it is unChanged. More formally, Removes the
  39359. element with the lowest index i such that (o.Equals(get(i)))
  39360. (if such an element exists).
  39361. </summary>
  39362. <param name="o">element to be Removed from this list, if present.</param>
  39363. <returns>return true if this list Contained the specified element.</returns>
  39364. </member>
  39365. <member name="M:NPOI.Util.ShortList.RemoveAll(NPOI.Util.ShortList)">
  39366. <summary>
  39367. Removes from this list all the elements that are Contained in the specified collection
  39368. </summary>
  39369. <param name="c">collection that defines which elements will be removed from this list.</param>
  39370. <returns>return true if this list Changed as a result of the call.</returns>
  39371. </member>
  39372. <member name="M:NPOI.Util.ShortList.RetainAll(NPOI.Util.ShortList)">
  39373. <summary>
  39374. Retains only the elements in this list that are Contained in
  39375. the specified collection. In other words, Removes from this
  39376. list all the elements that are not Contained in the specified
  39377. collection.
  39378. </summary>
  39379. <param name="c">collection that defines which elements this Set will retain.</param>
  39380. <returns>return true if this list Changed as a result of the call.</returns>
  39381. </member>
  39382. <member name="M:NPOI.Util.ShortList.Set(System.Int32,System.Int16)">
  39383. <summary>
  39384. Replaces the element at the specified position in this list with the specified element
  39385. </summary>
  39386. <param name="index">index of element to Replace.</param>
  39387. <param name="element">element to be stored at the specified position.</param>
  39388. <returns>return the element previously at the specified position.</returns>
  39389. </member>
  39390. <member name="M:NPOI.Util.ShortList.Size">
  39391. <summary>
  39392. Returns the number of elements in this list. If this list
  39393. Contains more than Int32.MaxValue elements, returns
  39394. Int32.MaxValue.
  39395. </summary>
  39396. <returns>return the number of elements in this shortList</returns>
  39397. </member>
  39398. <member name="M:NPOI.Util.ShortList.ToArray">
  39399. <summary>
  39400. Returns an array Containing all of the elements in this list in
  39401. proper sequence. Obeys the general contract of the
  39402. Collection.ToArray method.
  39403. </summary>
  39404. <returns>an array Containing all of the elements in this list in
  39405. proper sequence.</returns>
  39406. </member>
  39407. <member name="M:NPOI.Util.ShortList.ToArray(System.Int16[])">
  39408. <summary>
  39409. Returns an array Containing all of the elements in this list in
  39410. proper sequence. Obeys the general contract of the
  39411. Collection.ToArray(Object[]) method.
  39412. </summary>
  39413. <param name="a">the array into which the elements of this list are to
  39414. be stored, if it is big enough; otherwise, a new array
  39415. is allocated for this purpose.</param>
  39416. <returns>return an array Containing the elements of this list.</returns>
  39417. </member>
  39418. <member name="P:NPOI.Util.ShortList.Count">
  39419. <summary>
  39420. the number of elements in this shortList
  39421. </summary>
  39422. </member>
  39423. <member name="T:NPOI.Util.StringUtil">
  39424. <summary>
  39425. Title: String Utility Description: Collection of string handling utilities
  39426. @author Andrew C. Oliver
  39427. @author Sergei Kozello (sergeikozello at mail.ru)
  39428. @author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
  39429. @since May 10, 2002
  39430. @version 1.0
  39431. </summary>
  39432. </member>
  39433. <member name="M:NPOI.Util.StringUtil.#ctor">
  39434. Constructor for the StringUtil object
  39435. </member>
  39436. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[],System.Int32,System.Int32)">
  39437. <summary>
  39438. Given a byte array of 16-bit unicode characters in Little Endian
  39439. Format (most important byte last), return a Java String representation
  39440. of it.
  39441. { 0x16, 0x00 } -0x16
  39442. </summary>
  39443. <param name="str">the byte array to be converted</param>
  39444. <param name="offset">the initial offset into the
  39445. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  39446. <param name="len">the Length of the string</param>
  39447. <returns>the converted string</returns>
  39448. </member>
  39449. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[])">
  39450. <summary>
  39451. Given a byte array of 16-bit unicode characters in little endian
  39452. Format (most important byte last), return a Java String representation
  39453. of it.
  39454. { 0x16, 0x00 } -0x16
  39455. </summary>
  39456. <param name="str">the byte array to be converted</param>
  39457. <returns>the converted string</returns>
  39458. </member>
  39459. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[],System.Int32,System.Int32)">
  39460. <summary>
  39461. Given a byte array of 16-bit unicode characters in big endian
  39462. Format (most important byte first), return a Java String representation
  39463. of it.
  39464. { 0x00, 0x16 } -0x16
  39465. </summary>
  39466. <param name="str">the byte array to be converted</param>
  39467. <param name="offset">the initial offset into the
  39468. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  39469. <param name="len">the Length of the string</param>
  39470. <returns> the converted string</returns>
  39471. </member>
  39472. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[])">
  39473. <summary>
  39474. Given a byte array of 16-bit unicode characters in big endian
  39475. Format (most important byte first), return a Java String representation
  39476. of it.
  39477. { 0x00, 0x16 } -0x16
  39478. </summary>
  39479. <param name="str">the byte array to be converted</param>
  39480. <returns>the converted string</returns>
  39481. </member>
  39482. <member name="M:NPOI.Util.StringUtil.GetFromCompressedUnicode(System.Byte[],System.Int32,System.Int32)">
  39483. <summary>
  39484. Read 8 bit data (in IsO-8859-1 codepage) into a (unicode) Java
  39485. String and return.
  39486. (In Excel terms, read compressed 8 bit unicode as a string)
  39487. </summary>
  39488. <param name="str">byte array to read</param>
  39489. <param name="offset">offset to read byte array</param>
  39490. <param name="len">Length to read byte array</param>
  39491. <returns>generated String instance by reading byte array</returns>
  39492. </member>
  39493. <member name="M:NPOI.Util.StringUtil.PutCompressedUnicode(System.String,System.Byte[],System.Int32)">
  39494. <summary>
  39495. Takes a unicode (java) string, and returns it as 8 bit data (in IsO-8859-1
  39496. codepage).
  39497. (In Excel terms, write compressed 8 bit unicode)
  39498. </summary>
  39499. <param name="input">the String containing the data to be written</param>
  39500. <param name="output">the byte array to which the data Is to be written</param>
  39501. <param name="offset">an offset into the byte arrat at which the data Is start when written</param>
  39502. </member>
  39503. <member name="M:NPOI.Util.StringUtil.PutUnicodeLE(System.String,System.Byte[],System.Int32)">
  39504. <summary>
  39505. Takes a unicode string, and returns it as little endian (most
  39506. important byte last) bytes in the supplied byte array.
  39507. (In Excel terms, write uncompressed unicode)
  39508. </summary>
  39509. <param name="input">the String containing the unicode data to be written</param>
  39510. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String</param>
  39511. <param name="offset">the offset to start writing into the byte array</param>
  39512. </member>
  39513. <member name="M:NPOI.Util.StringUtil.PutUnicodeBE(System.String,System.Byte[],System.Int32)">
  39514. <summary>
  39515. Takes a unicode string, and returns it as big endian (most
  39516. important byte first) bytes in the supplied byte array.
  39517. (In Excel terms, write uncompressed unicode)
  39518. </summary>
  39519. <param name="input">the String containing the unicode data to be written</param>
  39520. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String.</param>
  39521. <param name="offset">the offset to start writing into the byte array</param>
  39522. </member>
  39523. <member name="M:NPOI.Util.StringUtil.GetPreferredEncoding">
  39524. <summary>
  39525. Gets the preferred encoding.
  39526. </summary>
  39527. <returns>the encoding we want to use, currently hardcoded to IsO-8859-1</returns>
  39528. </member>
  39529. <member name="M:NPOI.Util.StringUtil.HasMultibyte(System.String)">
  39530. <summary>
  39531. check the parameter Has multibyte character
  39532. </summary>
  39533. <param name="value"> string to check</param>
  39534. <returns>
  39535. <c>true</c> if Has at least one multibyte character; otherwise, <c>false</c>.
  39536. </returns>
  39537. </member>
  39538. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput)">
  39539. InputStream <c>in</c> is expected to contain:
  39540. <ol>
  39541. <li>ushort nChars</li>
  39542. <li>byte is16BitFlag</li>
  39543. <li>byte[]/char[] characterData</li>
  39544. </ol>
  39545. For this encoding, the is16BitFlag is always present even if nChars==0.
  39546. </member>
  39547. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput,System.Int32)">
  39548. InputStream <c>in</c> is expected to contain:
  39549. <ol>
  39550. <li>byte is16BitFlag</li>
  39551. <li>byte[]/char[] characterData</li>
  39552. </ol>
  39553. For this encoding, the is16BitFlag is always present even if nChars==0.
  39554. <br/>
  39555. This method should be used when the nChars field is <em>not</em> stored
  39556. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  39557. #readUnicodeString(LittleEndianInput)} can be used.
  39558. </member>
  39559. <member name="M:NPOI.Util.StringUtil.WriteUnicodeString(NPOI.Util.ILittleEndianOutput,System.String)">
  39560. OutputStream <c>out</c> will get:
  39561. <ol>
  39562. <li>ushort nChars</li>
  39563. <li>byte is16BitFlag</li>
  39564. <li>byte[]/char[] characterData</li>
  39565. </ol>
  39566. For this encoding, the is16BitFlag is always present even if nChars==0.
  39567. </member>
  39568. <member name="M:NPOI.Util.StringUtil.WriteUnicodeStringFlagAndData(NPOI.Util.ILittleEndianOutput,System.String)">
  39569. OutputStream <c>out</c> will get:
  39570. <ol>
  39571. <li>byte is16BitFlag</li>
  39572. <li>byte[]/char[] characterData</li>
  39573. </ol>
  39574. For this encoding, the is16BitFlag is always present even if nChars==0.
  39575. <br/>
  39576. This method should be used when the nChars field is <em>not</em> stored
  39577. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  39578. #writeUnicodeString(LittleEndianOutput, String)} can be used.
  39579. </member>
  39580. <member name="M:NPOI.Util.StringUtil.GetEncodedSize(System.String)">
  39581. <summary>
  39582. Gets the number of bytes that would be written by WriteUnicodeString(LittleEndianOutput, String)
  39583. </summary>
  39584. <param name="value">The value.</param>
  39585. <returns></returns>
  39586. </member>
  39587. <member name="M:NPOI.Util.StringUtil.IsUnicodeString(System.String)">
  39588. <summary>
  39589. Checks to see if a given String needs to be represented as Unicode
  39590. </summary>
  39591. <param name="value">The value.</param>
  39592. <returns>
  39593. <c>true</c> if string needs Unicode to be represented.; otherwise, <c>false</c>.
  39594. </returns>
  39595. <remarks>Tony Qu change the logic</remarks>
  39596. </member>
  39597. <member name="M:NPOI.Util.StringUtil.ToHexString(System.String)">
  39598. <summary>
  39599. Encodes non-US-ASCII characters in a string, good for encoding file names for download
  39600. http://www.acriticsreview.com/List.aspx?listid=42
  39601. </summary>
  39602. <param name="s"></param>
  39603. <returns></returns>
  39604. </member>
  39605. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Char)">
  39606. <summary>
  39607. Encodes a non-US-ASCII character.
  39608. </summary>
  39609. <param name="chr"></param>
  39610. <returns></returns>
  39611. </member>
  39612. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int16)">
  39613. <summary>
  39614. Encodes a non-US-ASCII character.
  39615. </summary>
  39616. <param name="chr"></param>
  39617. <returns></returns>
  39618. </member>
  39619. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int32)">
  39620. <summary>
  39621. Encodes a non-US-ASCII character.
  39622. </summary>
  39623. <param name="chr"></param>
  39624. <returns></returns>
  39625. </member>
  39626. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int64)">
  39627. <summary>
  39628. Encodes a non-US-ASCII character.
  39629. </summary>
  39630. <param name="chr"></param>
  39631. <returns></returns>
  39632. </member>
  39633. <member name="M:NPOI.Util.StringUtil.NeedToEncode(System.Char)">
  39634. <summary>
  39635. Determines if the character needs to be encoded.
  39636. http://www.acriticsreview.com/List.aspx?listid=42
  39637. </summary>
  39638. <param name="chr"></param>
  39639. <returns></returns>
  39640. </member>
  39641. <member name="T:NPOI.Util.SystemOutLogger">
  39642. <summary>
  39643. A logger class that strives to make it as easy as possible for
  39644. developers to write log calls, while simultaneously making those
  39645. calls as cheap as possible by performing lazy Evaluation of the log
  39646. message.
  39647. </summary>
  39648. <remarks>
  39649. @author Marc Johnson (mjohnson at apache dot org)
  39650. @author Glen Stampoultzis (glens at apache.org)
  39651. @author Nicola Ken Barozzi (nicolaken at apache.org)
  39652. </remarks>
  39653. </member>
  39654. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object)">
  39655. <summary>
  39656. Log a message
  39657. </summary>
  39658. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  39659. <param name="obj1">The object to log.</param>
  39660. </member>
  39661. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object,System.Exception)">
  39662. <summary>
  39663. Log a message
  39664. </summary>
  39665. <param name="level"> One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  39666. <param name="obj1">The object to log. This is Converted to a string.</param>
  39667. <param name="exception">An exception to be logged</param>
  39668. </member>
  39669. <member name="M:NPOI.Util.SystemOutLogger.Check(System.Int32)">
  39670. <summary>
  39671. Check if a logger is enabled to log at the specified level
  39672. </summary>
  39673. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  39674. <returns></returns>
  39675. </member>
  39676. <member name="M:NPOI.Util.TempFile.CreateTempFile(System.String,System.String)">
  39677. Creates a temporary file. Files are collected into one directory and by default are
  39678. deleted on exit from the VM. Files can be kept by defining the system property
  39679. <c>poi.keep.tmp.files</c>.
  39680. Dont forget to close all files or it might not be possible to delete them.
  39681. </member>
  39682. <member name="T:NPOI.Util.ULongField">
  39683. <summary>
  39684. </summary>
  39685. </member>
  39686. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32)">
  39687. <summary>
  39688. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  39689. </summary>
  39690. <param name="offset">The offset.</param>
  39691. </member>
  39692. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64)">
  39693. <summary>
  39694. construct the LongField with its offset into its containing
  39695. byte array and initialize its value
  39696. </summary>
  39697. <param name="offset">offset of the field within its byte array</param>
  39698. <param name="value">the initial value</param>
  39699. </member>
  39700. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.Byte[])">
  39701. <summary>
  39702. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  39703. byte array and initialize its value from its byte array
  39704. </summary>
  39705. <param name="offset">The offset of the field within its byte array</param>
  39706. <param name="data">the byte array to read the value from</param>
  39707. </member>
  39708. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64,System.Byte[])">
  39709. <summary>
  39710. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  39711. byte array, initialize its value, and write the value to a byte
  39712. array
  39713. </summary>
  39714. <param name="offset">offset of the field within its byte array</param>
  39715. <param name="value">the initial value</param>
  39716. <param name="data">the byte array to write the value to</param>
  39717. </member>
  39718. <member name="M:NPOI.Util.ULongField.Set(System.UInt64,System.Byte[])">
  39719. <summary>
  39720. set the LongField's current value and write it to a byte array
  39721. </summary>
  39722. <param name="value">value to be set</param>
  39723. <param name="data">the byte array to write the value to</param>
  39724. </member>
  39725. <member name="M:NPOI.Util.ULongField.ReadFromBytes(System.Byte[])">
  39726. <summary>
  39727. set the value from its offset into an array of bytes
  39728. </summary>
  39729. <param name="data">the byte array from which the value is to be read</param>
  39730. </member>
  39731. <member name="M:NPOI.Util.ULongField.ReadFromStream(System.IO.Stream)">
  39732. <summary>
  39733. set the value from an Stream
  39734. </summary>
  39735. <param name="stream">the Stream from which the value is to be</param>
  39736. </member>
  39737. <member name="M:NPOI.Util.ULongField.WriteToBytes(System.Byte[])">
  39738. <summary>
  39739. write the value out to an array of bytes at the appropriate offset
  39740. </summary>
  39741. <param name="data">the array of bytes to which the value is to be written</param>
  39742. </member>
  39743. <member name="M:NPOI.Util.ULongField.ToString">
  39744. <summary>
  39745. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39746. </summary>
  39747. <returns>
  39748. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  39749. </returns>
  39750. </member>
  39751. <member name="P:NPOI.Util.ULongField.Value">
  39752. <summary>
  39753. Getg or sets the LongField's current value
  39754. </summary>
  39755. <value>The current value</value>
  39756. </member>
  39757. <member name="T:NPOI.SS.UserModel.FillPattern">
  39758. The enumeration value indicating the style of fill pattern being used for a cell format.
  39759. </member>
  39760. <member name="F:NPOI.SS.UserModel.FillPattern.NoFill">
  39761. No background
  39762. </member>
  39763. <member name="F:NPOI.SS.UserModel.FillPattern.SolidForeground">
  39764. Solidly Filled
  39765. </member>
  39766. <member name="F:NPOI.SS.UserModel.FillPattern.FineDots">
  39767. Small fine dots
  39768. </member>
  39769. <member name="F:NPOI.SS.UserModel.FillPattern.AltBars">
  39770. Wide dots
  39771. </member>
  39772. <member name="F:NPOI.SS.UserModel.FillPattern.SparseDots">
  39773. Sparse dots
  39774. </member>
  39775. <member name="F:NPOI.SS.UserModel.FillPattern.ThickHorizontalBands">
  39776. Thick horizontal bands
  39777. </member>
  39778. <member name="F:NPOI.SS.UserModel.FillPattern.ThickVerticalBands">
  39779. Thick vertical bands
  39780. </member>
  39781. <member name="F:NPOI.SS.UserModel.FillPattern.ThickBackwardDiagonals">
  39782. Thick backward facing diagonals
  39783. </member>
  39784. <member name="F:NPOI.SS.UserModel.FillPattern.ThickForwardDiagonals">
  39785. Thick forward facing diagonals
  39786. </member>
  39787. <member name="F:NPOI.SS.UserModel.FillPattern.BigSpots">
  39788. Large spots
  39789. </member>
  39790. <member name="F:NPOI.SS.UserModel.FillPattern.Bricks">
  39791. Brick-like layout
  39792. </member>
  39793. <member name="F:NPOI.SS.UserModel.FillPattern.ThinHorizontalBands">
  39794. Thin horizontal bands
  39795. </member>
  39796. <member name="F:NPOI.SS.UserModel.FillPattern.ThinVerticalBands">
  39797. Thin vertical bands
  39798. </member>
  39799. <member name="F:NPOI.SS.UserModel.FillPattern.ThinBackwardDiagonals">
  39800. Thin backward diagonal
  39801. </member>
  39802. <member name="F:NPOI.SS.UserModel.FillPattern.ThinForwardDiagonals">
  39803. Thin forward diagonal
  39804. </member>
  39805. <member name="F:NPOI.SS.UserModel.FillPattern.Squares">
  39806. Squares
  39807. </member>
  39808. <member name="F:NPOI.SS.UserModel.FillPattern.Diamonds">
  39809. Diamonds
  39810. </member>
  39811. <member name="F:NPOI.SS.UserModel.FillPattern.LessDots">
  39812. Less Dots
  39813. </member>
  39814. <member name="F:NPOI.SS.UserModel.FillPattern.LeastDots">
  39815. Least Dots
  39816. </member>
  39817. </members>
  39818. </doc>