NPOI.XML 2.2 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322373233732437325373263732737328373293733037331373323733337334373353733637337373383733937340373413734237343373443734537346373473734837349373503735137352373533735437355373563735737358373593736037361373623736337364373653736637367373683736937370373713737237373373743737537376373773737837379373803738137382373833738437385373863738737388373893739037391373923739337394373953739637397373983739937400374013740237403374043740537406374073740837409374103741137412374133741437415374163741737418374193742037421374223742337424374253742637427374283742937430374313743237433374343743537436374373743837439374403744137442374433744437445374463744737448374493745037451374523745337454374553745637457374583745937460374613746237463374643746537466374673746837469374703747137472374733747437475374763747737478374793748037481374823748337484374853748637487374883748937490374913749237493374943749537496374973749837499375003750137502375033750437505375063750737508375093751037511375123751337514375153751637517375183751937520375213752237523375243752537526375273752837529375303753137532375333753437535375363753737538375393754037541375423754337544375453754637547375483754937550375513755237553375543755537556375573755837559375603756137562375633756437565375663756737568375693757037571375723757337574375753757637577375783757937580375813758237583375843758537586375873758837589375903759137592375933759437595375963759737598375993760037601376023760337604376053760637607376083760937610376113761237613376143761537616376173761837619376203762137622376233762437625376263762737628376293763037631376323763337634376353763637637376383763937640376413764237643376443764537646376473764837649376503765137652376533765437655376563765737658376593766037661376623766337664376653766637667376683766937670376713767237673376743767537676376773767837679376803768137682376833768437685376863768737688376893769037691376923769337694376953769637697376983769937700377013770237703377043770537706377073770837709377103771137712377133771437715377163771737718377193772037721377223772337724377253772637727377283772937730377313773237733377343773537736377373773837739377403774137742377433774437745377463774737748377493775037751377523775337754377553775637757377583775937760377613776237763377643776537766377673776837769377703777137772377733777437775377763777737778377793778037781377823778337784377853778637787377883778937790377913779237793377943779537796377973779837799378003780137802378033780437805378063780737808378093781037811378123781337814378153781637817378183781937820378213782237823378243782537826378273782837829378303783137832378333783437835378363783737838378393784037841378423784337844378453784637847378483784937850378513785237853378543785537856378573785837859378603786137862378633786437865378663786737868378693787037871378723787337874378753787637877378783787937880378813788237883378843788537886378873788837889378903789137892378933789437895378963789737898378993790037901379023790337904379053790637907379083790937910379113791237913379143791537916379173791837919379203792137922379233792437925379263792737928379293793037931379323793337934379353793637937379383793937940379413794237943379443794537946379473794837949379503795137952379533795437955379563795737958379593796037961379623796337964379653796637967379683796937970379713797237973379743797537976379773797837979379803798137982379833798437985379863798737988379893799037991379923799337994379953799637997379983799938000380013800238003380043800538006380073800838009380103801138012380133801438015380163801738018380193802038021380223802338024380253802638027380283802938030380313803238033380343803538036380373803838039380403804138042380433804438045380463804738048380493805038051380523805338054380553805638057380583805938060380613806238063380643806538066380673806838069380703807138072380733807438075380763807738078380793808038081380823808338084380853808638087380883808938090380913809238093380943809538096380973809838099381003810138102381033810438105381063810738108381093811038111381123811338114381153811638117381183811938120381213812238123381243812538126381273812838129381303813138132381333813438135381363813738138381393814038141381423814338144381453814638147381483814938150381513815238153381543815538156381573815838159381603816138162381633816438165381663816738168381693817038171381723817338174381753817638177381783817938180381813818238183381843818538186381873818838189381903819138192381933819438195381963819738198381993820038201382023820338204382053820638207382083820938210382113821238213382143821538216382173821838219382203822138222382233822438225382263822738228382293823038231382323823338234382353823638237382383823938240382413824238243382443824538246382473824838249382503825138252382533825438255382563825738258382593826038261382623826338264382653826638267382683826938270382713827238273382743827538276382773827838279382803828138282382833828438285382863828738288382893829038291382923829338294382953829638297382983829938300383013830238303383043830538306383073830838309383103831138312383133831438315383163831738318383193832038321383223832338324383253832638327383283832938330383313833238333383343833538336383373833838339383403834138342383433834438345383463834738348383493835038351383523835338354383553835638357383583835938360383613836238363383643836538366383673836838369383703837138372383733837438375383763837738378383793838038381383823838338384383853838638387383883838938390383913839238393383943839538396383973839838399384003840138402384033840438405384063840738408384093841038411384123841338414384153841638417384183841938420384213842238423384243842538426384273842838429384303843138432384333843438435384363843738438384393844038441384423844338444384453844638447384483844938450384513845238453384543845538456384573845838459384603846138462384633846438465384663846738468384693847038471384723847338474384753847638477384783847938480384813848238483384843848538486384873848838489384903849138492384933849438495384963849738498384993850038501385023850338504385053850638507385083850938510385113851238513385143851538516385173851838519385203852138522385233852438525385263852738528385293853038531385323853338534385353853638537385383853938540385413854238543385443854538546385473854838549385503855138552385533855438555385563855738558385593856038561385623856338564385653856638567385683856938570385713857238573385743857538576385773857838579385803858138582385833858438585385863858738588385893859038591385923859338594385953859638597385983859938600386013860238603386043860538606386073860838609386103861138612386133861438615386163861738618386193862038621386223862338624386253862638627386283862938630386313863238633386343863538636386373863838639386403864138642386433864438645386463864738648386493865038651386523865338654386553865638657386583865938660386613866238663386643866538666386673866838669386703867138672386733867438675386763867738678386793868038681386823868338684386853868638687386883868938690386913869238693386943869538696386973869838699387003870138702387033870438705387063870738708387093871038711387123871338714387153871638717387183871938720387213872238723387243872538726387273872838729387303873138732387333873438735387363873738738387393874038741387423874338744387453874638747387483874938750387513875238753387543875538756387573875838759387603876138762387633876438765387663876738768387693877038771387723877338774387753877638777387783877938780387813878238783387843878538786387873878838789387903879138792387933879438795387963879738798387993880038801388023880338804388053880638807388083880938810388113881238813388143881538816388173881838819388203882138822388233882438825388263882738828388293883038831388323883338834388353883638837388383883938840388413884238843388443884538846388473884838849388503885138852388533885438855388563885738858388593886038861388623886338864388653886638867388683886938870388713887238873388743887538876388773887838879388803888138882388833888438885388863888738888388893889038891388923889338894388953889638897388983889938900389013890238903389043890538906389073890838909389103891138912389133891438915389163891738918389193892038921389223892338924389253892638927389283892938930389313893238933389343893538936389373893838939389403894138942389433894438945389463894738948389493895038951389523895338954389553895638957389583895938960389613896238963389643896538966389673896838969389703897138972389733897438975389763897738978389793898038981389823898338984389853898638987389883898938990389913899238993389943899538996389973899838999390003900139002390033900439005390063900739008390093901039011390123901339014390153901639017390183901939020390213902239023390243902539026390273902839029390303903139032390333903439035390363903739038390393904039041390423904339044390453904639047390483904939050390513905239053390543905539056390573905839059390603906139062390633906439065390663906739068390693907039071390723907339074390753907639077390783907939080390813908239083390843908539086390873908839089390903909139092390933909439095390963909739098390993910039101391023910339104391053910639107391083910939110391113911239113391143911539116391173911839119391203912139122391233912439125391263912739128391293913039131391323913339134391353913639137391383913939140391413914239143391443914539146391473914839149391503915139152391533915439155391563915739158391593916039161391623916339164391653916639167391683916939170391713917239173391743917539176391773917839179391803918139182391833918439185391863918739188391893919039191391923919339194391953919639197391983919939200392013920239203392043920539206392073920839209392103921139212392133921439215392163921739218392193922039221392223922339224392253922639227392283922939230392313923239233392343923539236392373923839239392403924139242392433924439245392463924739248392493925039251392523925339254392553925639257392583925939260392613926239263392643926539266392673926839269392703927139272392733927439275392763927739278392793928039281392823928339284392853928639287392883928939290392913929239293392943929539296392973929839299393003930139302393033930439305393063930739308393093931039311393123931339314393153931639317393183931939320393213932239323393243932539326393273932839329393303933139332393333933439335393363933739338393393934039341393423934339344393453934639347393483934939350393513935239353393543935539356393573935839359393603936139362393633936439365393663936739368393693937039371393723937339374393753937639377393783937939380393813938239383393843938539386393873938839389393903939139392393933939439395393963939739398393993940039401394023940339404394053940639407394083940939410394113941239413394143941539416394173941839419394203942139422394233942439425394263942739428394293943039431394323943339434394353943639437394383943939440394413944239443394443944539446394473944839449394503945139452394533945439455394563945739458394593946039461394623946339464394653946639467394683946939470394713947239473394743947539476394773947839479394803948139482394833948439485394863948739488394893949039491394923949339494394953949639497394983949939500395013950239503395043950539506395073950839509395103951139512395133951439515395163951739518395193952039521395223952339524395253952639527395283952939530395313953239533395343953539536395373953839539395403954139542395433954439545395463954739548395493955039551395523955339554395553955639557395583955939560395613956239563395643956539566395673956839569395703957139572395733957439575395763957739578395793958039581395823958339584395853958639587395883958939590395913959239593395943959539596395973959839599396003960139602396033960439605396063960739608396093961039611396123961339614396153961639617396183961939620396213962239623396243962539626396273962839629396303963139632396333963439635396363963739638396393964039641396423964339644396453964639647396483964939650396513965239653396543965539656396573965839659396603966139662396633966439665396663966739668396693967039671396723967339674396753967639677396783967939680396813968239683396843968539686396873968839689396903969139692396933969439695396963969739698396993970039701397023970339704397053970639707397083970939710397113971239713397143971539716397173971839719397203972139722397233972439725397263972739728397293973039731397323973339734397353973639737397383973939740397413974239743397443974539746397473974839749397503975139752397533975439755397563975739758397593976039761397623976339764397653976639767397683976939770397713977239773397743977539776397773977839779397803978139782397833978439785397863978739788397893979039791397923979339794397953979639797397983979939800398013980239803398043980539806398073980839809398103981139812398133981439815398163981739818398193982039821398223982339824398253982639827398283982939830398313983239833398343983539836398373983839839398403984139842398433984439845398463984739848398493985039851398523985339854398553985639857398583985939860398613986239863398643986539866398673986839869398703987139872398733987439875398763987739878398793988039881398823988339884398853988639887398883988939890398913989239893398943989539896398973989839899399003990139902399033990439905399063990739908399093991039911399123991339914399153991639917399183991939920399213992239923399243992539926399273992839929399303993139932399333993439935399363993739938399393994039941399423994339944399453994639947399483994939950399513995239953399543995539956399573995839959399603996139962399633996439965399663996739968399693997039971399723997339974399753997639977399783997939980399813998239983399843998539986399873998839989399903999139992399933999439995399963999739998399994000040001400024000340004400054000640007400084000940010400114001240013400144001540016400174001840019400204002140022400234002440025400264002740028400294003040031400324003340034400354003640037400384003940040400414004240043400444004540046400474004840049400504005140052400534005440055400564005740058400594006040061400624006340064400654006640067400684006940070400714007240073400744007540076400774007840079400804008140082400834008440085400864008740088400894009040091400924009340094400954009640097400984009940100401014010240103401044010540106401074010840109401104011140112401134011440115401164011740118401194012040121401224012340124401254012640127401284012940130401314013240133401344013540136401374013840139401404014140142401434014440145401464014740148401494015040151401524015340154401554015640157401584015940160401614016240163401644016540166401674016840169401704017140172401734017440175401764017740178401794018040181401824018340184401854018640187401884018940190401914019240193401944019540196401974019840199402004020140202402034020440205402064020740208402094021040211402124021340214402154021640217402184021940220402214022240223402244022540226402274022840229402304023140232402334023440235402364023740238402394024040241402424024340244402454024640247402484024940250402514025240253402544025540256402574025840259402604026140262402634026440265402664026740268402694027040271402724027340274402754027640277402784027940280402814028240283402844028540286402874028840289402904029140292402934029440295402964029740298402994030040301403024030340304403054030640307403084030940310403114031240313403144031540316403174031840319403204032140322403234032440325403264032740328403294033040331403324033340334403354033640337403384033940340403414034240343403444034540346403474034840349403504035140352403534035440355403564035740358403594036040361403624036340364403654036640367403684036940370403714037240373403744037540376403774037840379403804038140382403834038440385403864038740388403894039040391403924039340394403954039640397403984039940400404014040240403404044040540406404074040840409404104041140412404134041440415404164041740418404194042040421404224042340424404254042640427404284042940430404314043240433404344043540436404374043840439404404044140442404434044440445404464044740448404494045040451404524045340454404554045640457404584045940460404614046240463404644046540466404674046840469404704047140472404734047440475404764047740478404794048040481404824048340484404854048640487404884048940490404914049240493404944049540496404974049840499405004050140502405034050440505405064050740508405094051040511405124051340514405154051640517405184051940520405214052240523405244052540526405274052840529405304053140532405334053440535405364053740538405394054040541405424054340544405454054640547405484054940550405514055240553405544055540556405574055840559405604056140562405634056440565405664056740568405694057040571405724057340574405754057640577405784057940580405814058240583405844058540586405874058840589405904059140592405934059440595405964059740598405994060040601406024060340604406054060640607406084060940610406114061240613406144061540616406174061840619406204062140622406234062440625406264062740628406294063040631406324063340634406354063640637406384063940640406414064240643406444064540646406474064840649406504065140652406534065440655406564065740658406594066040661406624066340664406654066640667406684066940670406714067240673406744067540676406774067840679406804068140682406834068440685406864068740688406894069040691406924069340694406954069640697406984069940700407014070240703407044070540706407074070840709407104071140712407134071440715407164071740718407194072040721407224072340724407254072640727407284072940730407314073240733407344073540736407374073840739407404074140742407434074440745407464074740748407494075040751407524075340754407554075640757407584075940760407614076240763407644076540766407674076840769407704077140772407734077440775407764077740778407794078040781407824078340784407854078640787407884078940790407914079240793407944079540796407974079840799408004080140802408034080440805408064080740808408094081040811408124081340814408154081640817408184081940820408214082240823408244082540826408274082840829408304083140832408334083440835408364083740838408394084040841408424084340844408454084640847408484084940850408514085240853408544085540856408574085840859408604086140862408634086440865408664086740868408694087040871408724087340874408754087640877408784087940880408814088240883408844088540886408874088840889408904089140892408934089440895408964089740898408994090040901409024090340904409054090640907409084090940910409114091240913409144091540916409174091840919409204092140922409234092440925409264092740928409294093040931409324093340934409354093640937409384093940940409414094240943409444094540946409474094840949409504095140952409534095440955409564095740958409594096040961409624096340964409654096640967409684096940970409714097240973409744097540976409774097840979409804098140982409834098440985409864098740988409894099040991409924099340994409954099640997409984099941000410014100241003410044100541006410074100841009410104101141012410134101441015410164101741018410194102041021410224102341024410254102641027410284102941030410314103241033410344103541036410374103841039410404104141042410434104441045410464104741048410494105041051410524105341054410554105641057410584105941060410614106241063410644106541066410674106841069410704107141072410734107441075410764107741078410794108041081410824108341084410854108641087410884108941090410914109241093410944109541096410974109841099411004110141102411034110441105411064110741108411094111041111411124111341114411154111641117411184111941120411214112241123411244112541126411274112841129411304113141132411334113441135411364113741138411394114041141411424114341144411454114641147411484114941150411514115241153411544115541156411574115841159411604116141162411634116441165411664116741168411694117041171411724117341174411754117641177411784117941180411814118241183411844118541186411874118841189411904119141192411934119441195411964119741198411994120041201412024120341204412054120641207412084120941210412114121241213412144121541216412174121841219412204122141222412234122441225412264122741228412294123041231412324123341234412354123641237412384123941240412414124241243412444124541246412474124841249412504125141252412534125441255412564125741258412594126041261412624126341264412654126641267412684126941270412714127241273412744127541276412774127841279412804128141282412834128441285412864128741288412894129041291412924129341294412954129641297412984129941300413014130241303413044130541306413074130841309413104131141312413134131441315413164131741318413194132041321413224132341324413254132641327413284132941330413314133241333413344133541336413374133841339413404134141342413434134441345413464134741348413494135041351413524135341354413554135641357413584135941360413614136241363413644136541366413674136841369413704137141372413734137441375413764137741378413794138041381413824138341384413854138641387413884138941390413914139241393413944139541396413974139841399414004140141402414034140441405414064140741408414094141041411414124141341414414154141641417414184141941420414214142241423414244142541426414274142841429414304143141432414334143441435414364143741438414394144041441414424144341444414454144641447414484144941450414514145241453414544145541456414574145841459414604146141462414634146441465414664146741468414694147041471414724147341474414754147641477414784147941480414814148241483414844148541486414874148841489414904149141492414934149441495414964149741498414994150041501415024150341504415054150641507415084150941510415114151241513415144151541516415174151841519415204152141522415234152441525415264152741528415294153041531415324153341534415354153641537415384153941540415414154241543415444154541546415474154841549415504155141552415534155441555415564155741558415594156041561415624156341564415654156641567415684156941570415714157241573415744157541576415774157841579415804158141582415834158441585415864158741588415894159041591415924159341594415954159641597415984159941600416014160241603416044160541606416074160841609416104161141612416134161441615416164161741618416194162041621416224162341624416254162641627416284162941630416314163241633416344163541636416374163841639416404164141642416434164441645416464164741648416494165041651416524165341654416554165641657416584165941660416614166241663416644166541666416674166841669416704167141672416734167441675416764167741678416794168041681416824168341684416854168641687416884168941690416914169241693416944169541696416974169841699417004170141702417034170441705417064170741708417094171041711417124171341714417154171641717417184171941720417214172241723417244172541726417274172841729417304173141732417334173441735417364173741738417394174041741417424174341744417454174641747417484174941750417514175241753417544175541756417574175841759417604176141762417634176441765417664176741768417694177041771417724177341774417754177641777417784177941780417814178241783417844178541786417874178841789417904179141792417934179441795417964179741798417994180041801418024180341804418054180641807418084180941810418114181241813418144181541816418174181841819418204182141822418234182441825418264182741828418294183041831418324183341834418354183641837418384183941840418414184241843418444184541846418474184841849418504185141852418534185441855418564185741858418594186041861418624186341864418654186641867418684186941870418714187241873418744187541876418774187841879418804188141882418834188441885418864188741888418894189041891418924189341894418954189641897418984189941900419014190241903419044190541906419074190841909419104191141912419134191441915419164191741918419194192041921419224192341924419254192641927419284192941930419314193241933419344193541936419374193841939419404194141942419434194441945419464194741948419494195041951419524195341954419554195641957419584195941960419614196241963419644196541966419674196841969419704197141972419734197441975419764197741978419794198041981419824198341984419854198641987419884198941990419914199241993419944199541996419974199841999420004200142002420034200442005420064200742008420094201042011420124201342014420154201642017420184201942020420214202242023420244202542026420274202842029420304203142032420334203442035420364203742038420394204042041420424204342044420454204642047420484204942050420514205242053420544205542056420574205842059420604206142062420634206442065420664206742068420694207042071420724207342074420754207642077420784207942080420814208242083420844208542086420874208842089420904209142092420934209442095420964209742098420994210042101421024210342104421054210642107421084210942110421114211242113421144211542116421174211842119421204212142122421234212442125421264212742128421294213042131421324213342134421354213642137421384213942140421414214242143421444214542146421474214842149421504215142152421534215442155421564215742158421594216042161421624216342164421654216642167421684216942170421714217242173421744217542176421774217842179421804218142182421834218442185421864218742188421894219042191421924219342194421954219642197421984219942200422014220242203422044220542206422074220842209422104221142212422134221442215422164221742218422194222042221422224222342224422254222642227422284222942230422314223242233422344223542236422374223842239422404224142242422434224442245422464224742248422494225042251422524225342254422554225642257422584225942260422614226242263422644226542266422674226842269422704227142272422734227442275422764227742278422794228042281422824228342284422854228642287422884228942290422914229242293422944229542296422974229842299423004230142302423034230442305423064230742308423094231042311423124231342314423154231642317423184231942320423214232242323423244232542326423274232842329423304233142332423334233442335423364233742338423394234042341423424234342344423454234642347423484234942350423514235242353423544235542356423574235842359423604236142362423634236442365423664236742368423694237042371423724237342374423754237642377423784237942380423814238242383423844238542386423874238842389423904239142392423934239442395423964239742398423994240042401424024240342404424054240642407424084240942410424114241242413424144241542416424174241842419424204242142422424234242442425424264242742428424294243042431424324243342434424354243642437424384243942440424414244242443424444244542446424474244842449424504245142452424534245442455424564245742458424594246042461424624246342464424654246642467424684246942470424714247242473424744247542476424774247842479424804248142482424834248442485424864248742488424894249042491424924249342494424954249642497424984249942500425014250242503425044250542506425074250842509425104251142512425134251442515425164251742518425194252042521425224252342524425254252642527425284252942530425314253242533425344253542536425374253842539425404254142542425434254442545425464254742548425494255042551425524255342554425554255642557425584255942560425614256242563425644256542566425674256842569425704257142572425734257442575425764257742578425794258042581425824258342584425854258642587425884258942590425914259242593425944259542596425974259842599426004260142602426034260442605426064260742608426094261042611426124261342614426154261642617426184261942620426214262242623426244262542626426274262842629426304263142632426334263442635426364263742638426394264042641426424264342644426454264642647426484264942650426514265242653426544265542656426574265842659426604266142662426634266442665426664266742668426694267042671426724267342674426754267642677426784267942680426814268242683426844268542686426874268842689426904269142692426934269442695426964269742698426994270042701427024270342704427054270642707427084270942710427114271242713427144271542716427174271842719427204272142722427234272442725427264272742728427294273042731427324273342734427354273642737427384273942740427414274242743427444274542746427474274842749427504275142752427534275442755427564275742758427594276042761427624276342764427654276642767427684276942770427714277242773427744277542776427774277842779427804278142782427834278442785427864278742788427894279042791427924279342794427954279642797427984279942800428014280242803428044280542806428074280842809428104281142812428134281442815428164281742818428194282042821428224282342824428254282642827428284282942830428314283242833428344283542836428374283842839428404284142842428434284442845428464284742848428494285042851428524285342854428554285642857428584285942860428614286242863428644286542866428674286842869428704287142872428734287442875428764287742878428794288042881428824288342884428854288642887428884288942890428914289242893428944289542896428974289842899429004290142902429034290442905429064290742908429094291042911429124291342914429154291642917429184291942920429214292242923429244292542926429274292842929429304293142932429334293442935429364293742938429394294042941429424294342944429454294642947429484294942950429514295242953429544295542956429574295842959429604296142962429634296442965429664296742968429694297042971429724297342974429754297642977429784297942980429814298242983429844298542986429874298842989429904299142992429934299442995429964299742998429994300043001430024300343004430054300643007430084300943010430114301243013430144301543016430174301843019430204302143022430234302443025430264302743028430294303043031430324303343034430354303643037430384303943040430414304243043430444304543046430474304843049430504305143052430534305443055430564305743058430594306043061430624306343064430654306643067430684306943070430714307243073430744307543076430774307843079430804308143082430834308443085430864308743088430894309043091430924309343094430954309643097430984309943100431014310243103431044310543106431074310843109431104311143112431134311443115431164311743118431194312043121431224312343124431254312643127431284312943130431314313243133431344313543136431374313843139431404314143142431434314443145431464314743148431494315043151431524315343154431554315643157431584315943160431614316243163431644316543166431674316843169431704317143172431734317443175431764317743178431794318043181431824318343184431854318643187431884318943190431914319243193431944319543196431974319843199432004320143202432034320443205432064320743208432094321043211432124321343214432154321643217432184321943220432214322243223432244322543226432274322843229432304323143232432334323443235432364323743238432394324043241432424324343244432454324643247432484324943250432514325243253432544325543256432574325843259432604326143262432634326443265432664326743268432694327043271432724327343274432754327643277432784327943280432814328243283432844328543286432874328843289432904329143292432934329443295432964329743298432994330043301433024330343304433054330643307433084330943310433114331243313433144331543316433174331843319433204332143322433234332443325433264332743328433294333043331433324333343334433354333643337433384333943340433414334243343433444334543346433474334843349433504335143352433534335443355433564335743358433594336043361433624336343364433654336643367433684336943370433714337243373433744337543376433774337843379433804338143382433834338443385433864338743388433894339043391433924339343394433954339643397433984339943400434014340243403434044340543406434074340843409434104341143412434134341443415434164341743418434194342043421434224342343424434254342643427434284342943430434314343243433434344343543436434374343843439434404344143442434434344443445434464344743448434494345043451434524345343454434554345643457434584345943460434614346243463434644346543466434674346843469434704347143472434734347443475434764347743478434794348043481434824348343484434854348643487434884348943490434914349243493434944349543496434974349843499435004350143502435034350443505435064350743508435094351043511435124351343514435154351643517435184351943520435214352243523435244352543526435274352843529435304353143532435334353443535435364353743538435394354043541435424354343544435454354643547435484354943550435514355243553435544355543556435574355843559435604356143562435634356443565435664356743568435694357043571435724357343574435754357643577435784357943580435814358243583435844358543586435874358843589435904359143592435934359443595435964359743598435994360043601436024360343604436054360643607436084360943610436114361243613436144361543616436174361843619436204362143622436234362443625436264362743628436294363043631436324363343634436354363643637436384363943640436414364243643436444364543646436474364843649436504365143652436534365443655436564365743658436594366043661436624366343664436654366643667436684366943670436714367243673436744367543676436774367843679436804368143682436834368443685436864368743688436894369043691436924369343694436954369643697436984369943700437014370243703437044370543706437074370843709437104371143712437134371443715437164371743718437194372043721437224372343724437254372643727437284372943730437314373243733437344373543736437374373843739437404374143742437434374443745437464374743748437494375043751437524375343754437554375643757437584375943760437614376243763437644376543766437674376843769437704377143772437734377443775437764377743778437794378043781437824378343784437854378643787437884378943790437914379243793437944379543796437974379843799438004380143802438034380443805438064380743808438094381043811438124381343814438154381643817438184381943820438214382243823438244382543826438274382843829438304383143832438334383443835438364383743838438394384043841438424384343844438454384643847438484384943850438514385243853438544385543856438574385843859438604386143862438634386443865438664386743868438694387043871438724387343874438754387643877438784387943880438814388243883438844388543886438874388843889438904389143892438934389443895438964389743898438994390043901439024390343904439054390643907439084390943910439114391243913439144391543916439174391843919439204392143922439234392443925439264392743928439294393043931439324393343934439354393643937439384393943940439414394243943439444394543946439474394843949439504395143952439534395443955439564395743958439594396043961439624396343964439654396643967439684396943970439714397243973439744397543976439774397843979439804398143982439834398443985439864398743988439894399043991439924399343994439954399643997439984399944000440014400244003440044400544006440074400844009440104401144012440134401444015440164401744018440194402044021440224402344024440254402644027440284402944030440314403244033440344403544036440374403844039440404404144042440434404444045440464404744048440494405044051440524405344054440554405644057440584405944060440614406244063440644406544066440674406844069440704407144072440734407444075440764407744078440794408044081440824408344084440854408644087440884408944090440914409244093440944409544096440974409844099441004410144102441034410444105441064410744108441094411044111441124411344114441154411644117441184411944120441214412244123441244412544126441274412844129441304413144132441334413444135441364413744138441394414044141441424414344144441454414644147441484414944150441514415244153441544415544156441574415844159441604416144162441634416444165441664416744168441694417044171441724417344174441754417644177441784417944180441814418244183441844418544186441874418844189441904419144192441934419444195441964419744198441994420044201442024420344204442054420644207442084420944210442114421244213442144421544216442174421844219442204422144222442234422444225442264422744228442294423044231442324423344234442354423644237442384423944240442414424244243442444424544246442474424844249442504425144252442534425444255442564425744258442594426044261442624426344264442654426644267442684426944270442714427244273442744427544276442774427844279442804428144282442834428444285442864428744288442894429044291442924429344294442954429644297442984429944300443014430244303443044430544306443074430844309443104431144312443134431444315443164431744318443194432044321443224432344324443254432644327443284432944330443314433244333443344433544336443374433844339443404434144342443434434444345443464434744348443494435044351443524435344354443554435644357443584435944360443614436244363443644436544366443674436844369443704437144372443734437444375443764437744378443794438044381443824438344384443854438644387443884438944390443914439244393443944439544396443974439844399444004440144402444034440444405444064440744408444094441044411444124441344414444154441644417444184441944420444214442244423444244442544426444274442844429444304443144432444334443444435444364443744438444394444044441444424444344444444454444644447444484444944450444514445244453444544445544456444574445844459444604446144462444634446444465444664446744468444694447044471444724447344474444754447644477444784447944480444814448244483444844448544486444874448844489444904449144492444934449444495444964449744498444994450044501445024450344504445054450644507445084450944510445114451244513445144451544516445174451844519445204452144522445234452444525445264452744528445294453044531445324453344534445354453644537445384453944540445414454244543445444454544546445474454844549445504455144552445534455444555445564455744558445594456044561445624456344564445654456644567445684456944570445714457244573445744457544576445774457844579445804458144582445834458444585445864458744588445894459044591445924459344594445954459644597445984459944600446014460244603446044460544606446074460844609446104461144612446134461444615446164461744618446194462044621446224462344624446254462644627446284462944630446314463244633446344463544636446374463844639446404464144642446434464444645446464464744648446494465044651446524465344654446554465644657446584465944660446614466244663446644466544666446674466844669446704467144672446734467444675446764467744678446794468044681446824468344684446854468644687446884468944690446914469244693446944469544696446974469844699447004470144702447034470444705447064470744708447094471044711447124471344714447154471644717447184471944720447214472244723447244472544726447274472844729447304473144732447334473444735447364473744738447394474044741447424474344744447454474644747447484474944750447514475244753447544475544756447574475844759447604476144762447634476444765447664476744768447694477044771447724477344774447754477644777447784477944780447814478244783447844478544786447874478844789447904479144792447934479444795447964479744798447994480044801448024480344804448054480644807448084480944810448114481244813448144481544816448174481844819448204482144822448234482444825448264482744828448294483044831448324483344834448354483644837448384483944840448414484244843448444484544846448474484844849448504485144852448534485444855448564485744858448594486044861448624486344864448654486644867448684486944870448714487244873448744487544876448774487844879448804488144882448834488444885448864488744888448894489044891448924489344894448954489644897448984489944900449014490244903449044490544906449074490844909449104491144912449134491444915449164491744918449194492044921449224492344924449254492644927449284492944930449314493244933449344493544936449374493844939449404494144942449434494444945449464494744948449494495044951449524495344954449554495644957449584495944960449614496244963449644496544966449674496844969449704497144972449734497444975449764497744978449794498044981449824498344984449854498644987449884498944990449914499244993449944499544996449974499844999450004500145002450034500445005450064500745008450094501045011450124501345014450154501645017450184501945020450214502245023450244502545026450274502845029450304503145032450334503445035450364503745038450394504045041450424504345044450454504645047450484504945050450514505245053450544505545056450574505845059450604506145062450634506445065450664506745068450694507045071450724507345074450754507645077450784507945080450814508245083450844508545086450874508845089450904509145092450934509445095450964509745098450994510045101451024510345104451054510645107451084510945110451114511245113451144511545116451174511845119451204512145122451234512445125451264512745128451294513045131451324513345134451354513645137451384513945140451414514245143451444514545146451474514845149451504515145152451534515445155451564515745158451594516045161451624516345164451654516645167451684516945170451714517245173451744517545176451774517845179451804518145182451834518445185451864518745188451894519045191451924519345194451954519645197451984519945200452014520245203452044520545206452074520845209452104521145212452134521445215452164521745218452194522045221452224522345224452254522645227452284522945230452314523245233452344523545236452374523845239452404524145242452434524445245452464524745248452494525045251452524525345254452554525645257452584525945260452614526245263452644526545266452674526845269452704527145272452734527445275452764527745278452794528045281452824528345284452854528645287452884528945290452914529245293452944529545296452974529845299453004530145302453034530445305453064530745308453094531045311453124531345314453154531645317453184531945320453214532245323453244532545326453274532845329453304533145332453334533445335453364533745338453394534045341453424534345344453454534645347453484534945350453514535245353453544535545356453574535845359453604536145362453634536445365453664536745368453694537045371453724537345374453754537645377453784537945380453814538245383453844538545386453874538845389453904539145392453934539445395453964539745398453994540045401454024540345404454054540645407454084540945410454114541245413454144541545416454174541845419454204542145422454234542445425454264542745428454294543045431454324543345434454354543645437454384543945440454414544245443454444544545446454474544845449454504545145452454534545445455454564545745458454594546045461454624546345464454654546645467454684546945470454714547245473454744547545476454774547845479454804548145482454834548445485454864548745488454894549045491454924549345494454954549645497454984549945500455014550245503455044550545506455074550845509455104551145512455134551445515455164551745518455194552045521455224552345524455254552645527455284552945530455314553245533455344553545536455374553845539455404554145542455434554445545455464554745548455494555045551455524555345554455554555645557455584555945560455614556245563455644556545566455674556845569455704557145572455734557445575455764557745578455794558045581455824558345584455854558645587455884558945590455914559245593455944559545596455974559845599456004560145602456034560445605456064560745608456094561045611456124561345614456154561645617456184561945620456214562245623456244562545626456274562845629456304563145632456334563445635456364563745638456394564045641456424564345644456454564645647456484564945650456514565245653456544565545656456574565845659456604566145662456634566445665456664566745668456694567045671456724567345674456754567645677456784567945680456814568245683456844568545686456874568845689456904569145692456934569445695456964569745698456994570045701457024570345704457054570645707457084570945710457114571245713457144571545716457174571845719457204572145722457234572445725457264572745728457294573045731457324573345734457354573645737457384573945740457414574245743457444574545746457474574845749457504575145752457534575445755457564575745758457594576045761457624576345764457654576645767457684576945770457714577245773457744577545776457774577845779457804578145782457834578445785457864578745788457894579045791457924579345794457954579645797457984579945800458014580245803458044580545806
  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="M:NPOI.DDF.AbstractEscherOptRecord.AddEscherProperty(NPOI.DDF.EscherProperty)">
  14. Add a property to this record.
  15. </member>
  16. <member name="P:NPOI.DDF.AbstractEscherOptRecord.EscherProperties">
  17. The list of properties stored by this record.
  18. </member>
  19. <member name="M:NPOI.DDF.AbstractEscherOptRecord.GetEscherProperty(System.Int32)">
  20. The list of properties stored by this record.
  21. </member>
  22. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SortProperties">
  23. Records should be sorted by property number before being stored.
  24. </member>
  25. <member name="M:NPOI.DDF.AbstractEscherOptRecord.SetEscherProperty(NPOI.DDF.EscherProperty)">
  26. * Set an escher property. If a property with given propId already
  27. exists it is replaced.
  28. *
  29. * @param value the property to set.
  30. </member>
  31. <member name="M:NPOI.DDF.AbstractEscherOptRecord.ToString">
  32. Retrieve the string representation of this record.
  33. </member>
  34. <member name="T:NPOI.DDF.SysIndexProcedure">
  35. The following enum specifies values that indicate special procedural properties that
  36. are used to modify the color components of another color. These values are combined with
  37. those of the {@link SysIndexSource} enum or with a user-specified color.
  38. The first six values are mutually exclusive.
  39. </member>
  40. <member name="T:NPOI.DDF.EscherColorRef">
  41. An OfficeArtCOLORREF structure entry which also handles color extension opid data
  42. </member>
  43. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexSource">
  44. @return {@link SysIndexSource} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  45. </member>
  46. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexProcedure">
  47. Return the {@link SysIndexProcedure} - for invert flag use {@link #getSysIndexInvert()}
  48. @return {@link SysIndexProcedure} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  49. </member>
  50. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexInvert">
  51. @return 0 for no invert flag, 1 for {@link SysIndexProcedure#INVERT_AFTER} and
  52. 2 for {@link SysIndexProcedure#INVERT_HIGHBIT_AFTER}
  53. </member>
  54. <member name="M:NPOI.DDF.EscherColorRef.GetSchemeIndex">
  55. @return index of the scheme color or -1 if {@link #hasSchemeIndexFlag()} is {@code false}
  56. @see NPOI.HSLF.Record.ColorSchemeAtom#getColor(int)
  57. </member>
  58. <member name="M:NPOI.DDF.EscherColorRef.GetPaletteIndex">
  59. @return index of current palette (color) or -1 if {@link #hasPaletteIndexFlag()} is {@code false}
  60. </member>
  61. <member name="T:NPOI.DDF.EscherTertiaryOptRecord">
  62. "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
  63. -- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
  64. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  65. </member>
  66. <member name="T:NPOI.DDF.DefaultEscherRecordFactory">
  67. <summary>
  68. Generates escher records when provided the byte array containing those records.
  69. @author Glen Stampoultzis
  70. @author Nick Burch (nick at torchbox . com)
  71. </summary>
  72. </member>
  73. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.#ctor">
  74. <summary>
  75. Initializes a new instance of the <see cref="T:NPOI.DDF.DefaultEscherRecordFactory"/> class.
  76. </summary>
  77. </member>
  78. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  79. <summary>
  80. Generates an escher record including the any children contained under that record.
  81. An exception is thrown if the record could not be generated.
  82. </summary>
  83. <param name="data">The byte array containing the records</param>
  84. <param name="offset">The starting offset into the byte array</param>
  85. <returns>The generated escher record</returns>
  86. </member>
  87. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.RecordsToMap(System.Type[])">
  88. <summary>
  89. Converts from a list of classes into a map that Contains the record id as the key and
  90. the Constructor in the value part of the map. It does this by using reflection to look up
  91. the RECORD_ID field then using reflection again to find a reference to the constructor.
  92. </summary>
  93. <param name="records">The records to convert</param>
  94. <returns>The map containing the id/constructor pairs.</returns>
  95. </member>
  96. <member name="T:NPOI.DDF.EscherArrayProperty">
  97. <summary>
  98. Escher array properties are the most wierd construction ever invented
  99. with all sorts of special cases. I'm hopeful I've got them all.
  100. @author Glen Stampoultzis (glens at superlinksoftware.com)
  101. </summary>
  102. </member>
  103. <member name="F:NPOI.DDF.EscherArrayProperty.FIXED_SIZE">
  104. The size of the header that goes at the
  105. start of the array, before the data
  106. </member>
  107. <member name="F:NPOI.DDF.EscherArrayProperty.sizeIncludesHeaderSize">
  108. Normally, the size recorded in the simple data (for the complex
  109. data) includes the size of the header.
  110. There are a few cases when it doesn't though...
  111. </member>
  112. <member name="F:NPOI.DDF.EscherArrayProperty.emptyComplexPart">
  113. When Reading a property from data stream remeber if the complex part is empty and Set this flag.
  114. </member>
  115. <member name="M:NPOI.DDF.EscherArrayProperty.GetElement(System.Int32)">
  116. <summary>
  117. Gets the element.
  118. </summary>
  119. <param name="index">The index.</param>
  120. <returns></returns>
  121. </member>
  122. <member name="M:NPOI.DDF.EscherArrayProperty.SetElement(System.Int32,System.Byte[])">
  123. <summary>
  124. Sets the element.
  125. </summary>
  126. <param name="index">The index.</param>
  127. <param name="element">The element.</param>
  128. </member>
  129. <member name="M:NPOI.DDF.EscherArrayProperty.ToString">
  130. <summary>
  131. Retrieves the string representation for this property.
  132. </summary>
  133. <returns></returns>
  134. </member>
  135. <member name="M:NPOI.DDF.EscherArrayProperty.SetArrayData(System.Byte[],System.Int32)">
  136. <summary>
  137. We have this method because the way in which arrays in escher works
  138. is screwed for seemly arbitary reasons. While most properties are
  139. fairly consistent and have a predictable array size, escher arrays
  140. have special cases.
  141. </summary>
  142. <param name="data">The data array containing the escher array information</param>
  143. <param name="offset">The offset into the array to start Reading from.</param>
  144. <returns>the number of bytes used by this complex property.</returns>
  145. </member>
  146. <member name="M:NPOI.DDF.EscherArrayProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  147. <summary>
  148. Serializes the simple part of this property. ie the first 6 bytes.
  149. Needs special code to handle the case when the size doesn't
  150. include the size of the header block
  151. </summary>
  152. <param name="data"></param>
  153. <param name="pos"></param>
  154. <returns></returns>
  155. </member>
  156. <member name="M:NPOI.DDF.EscherArrayProperty.GetActualSizeOfElements(System.Int16)">
  157. <summary>
  158. Sometimes the element size is stored as a negative number. We
  159. negate it and shift it to Get the real value.
  160. </summary>
  161. <param name="sizeOfElements">The size of elements.</param>
  162. <returns></returns>
  163. </member>
  164. <member name="T:NPOI.DDF.EscherBitmapBlip">
  165. <summary>
  166. @author Glen Stampoultzis
  167. @version $Id: EscherBitmapBlip.java 569827 2007-08-26 15:26:29Z yegor $
  168. </summary>
  169. </member>
  170. <member name="M:NPOI.DDF.EscherBitmapBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  171. <summary>
  172. This method deSerializes the record from a byte array.
  173. </summary>
  174. <param name="data"> The byte array containing the escher record information</param>
  175. <param name="offset">The starting offset into </param>
  176. <param name="recordFactory">May be null since this is not a container record.</param>
  177. <returns>The number of bytes Read from the byte array.</returns>
  178. </member>
  179. <member name="M:NPOI.DDF.EscherBitmapBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  180. <summary>
  181. Serializes the record to an existing byte array.
  182. </summary>
  183. <param name="offset">the offset within the byte array</param>
  184. <param name="data">the data array to Serialize to</param>
  185. <param name="listener">a listener for begin and end serialization events.</param>
  186. <returns>the number of bytes written.</returns>
  187. </member>
  188. <member name="P:NPOI.DDF.EscherBitmapBlip.RecordSize">
  189. <summary>
  190. Returns the number of bytes that are required to Serialize this record.
  191. </summary>
  192. <value> Number of bytes</value>
  193. </member>
  194. <member name="P:NPOI.DDF.EscherBitmapBlip.UID">
  195. <summary>
  196. Gets or sets the UID.
  197. </summary>
  198. <value>The UID.</value>
  199. </member>
  200. <member name="P:NPOI.DDF.EscherBitmapBlip.Marker">
  201. <summary>
  202. Gets or sets the marker.
  203. </summary>
  204. <value>The marker.</value>
  205. </member>
  206. <member name="M:NPOI.DDF.EscherBitmapBlip.ToString">
  207. <summary>
  208. Toes the string.
  209. </summary>
  210. <returns></returns>
  211. </member>
  212. <member name="T:NPOI.DDF.EscherBlipRecord">
  213. <summary>
  214. @author Glen Stampoultzis
  215. @version $Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $
  216. </summary>
  217. </member>
  218. <member name="M:NPOI.DDF.EscherBlipRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  219. <summary>
  220. This method deSerializes the record from a byte array.
  221. </summary>
  222. <param name="data">The byte array containing the escher record information</param>
  223. <param name="offset">The starting offset into </param>
  224. <param name="recordFactory">May be null since this is not a container record.</param>
  225. <returns>The number of bytes Read from the byte array.</returns>
  226. </member>
  227. <member name="M:NPOI.DDF.EscherBlipRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  228. <summary>
  229. Serializes the record to an existing byte array.
  230. </summary>
  231. <param name="offset"> the offset within the byte array</param>
  232. <param name="data">the data array to Serialize to</param>
  233. <param name="listener">a listener for begin and end serialization events.</param>
  234. <returns>the number of bytes written.</returns>
  235. </member>
  236. <member name="P:NPOI.DDF.EscherBlipRecord.RecordSize">
  237. <summary>
  238. Returns the number of bytes that are required to Serialize this record.
  239. </summary>
  240. <value>Number of bytes</value>
  241. </member>
  242. <member name="P:NPOI.DDF.EscherBlipRecord.RecordName">
  243. <summary>
  244. The short name for this record
  245. </summary>
  246. <value></value>
  247. </member>
  248. <member name="P:NPOI.DDF.EscherBlipRecord.PictureData">
  249. <summary>
  250. Gets or sets the picture data.
  251. </summary>
  252. <value>The picture data.</value>
  253. </member>
  254. <member name="M:NPOI.DDF.EscherBlipRecord.ToString">
  255. <summary>
  256. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  257. </summary>
  258. <returns>
  259. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  260. </returns>
  261. </member>
  262. <member name="T:NPOI.DDF.EscherBoolProperty">
  263. <summary>
  264. Represents a bool property. The actual utility of this property is in doubt because many
  265. of the properties marked as bool seem to actually contain special values. In other words
  266. they're not true bools.
  267. @author Glen Stampoultzis
  268. </summary>
  269. </member>
  270. <member name="M:NPOI.DDF.EscherBoolProperty.#ctor(System.Int16,System.Int32)">
  271. <summary>
  272. Create an instance of an escher bool property.
  273. </summary>
  274. <param name="propertyNumber">The property number (or id)</param>
  275. <param name="value">The 32 bit value of this bool property</param>
  276. </member>
  277. <member name="P:NPOI.DDF.EscherBoolProperty.IsTrue">
  278. <summary>
  279. Whether this bool property is true
  280. </summary>
  281. <value><c>true</c> if this instance is true; otherwise, <c>false</c>.</value>
  282. </member>
  283. <member name="P:NPOI.DDF.EscherBoolProperty.IsFalse">
  284. <summary>
  285. Whether this bool property is false
  286. </summary>
  287. <value><c>true</c> if this instance is false; otherwise, <c>false</c>.</value>
  288. </member>
  289. <member name="T:NPOI.DDF.EscherBSERecord">
  290. <summary>
  291. The BSE record is related closely to the EscherBlipRecord and stores
  292. extra information about the blip. A blip record is actually stored inside
  293. the BSE record even though the BSE record isn't actually a container record.
  294. @author Glen Stampoultzis
  295. @see EscherBlipRecord
  296. </summary>
  297. </member>
  298. <member name="M:NPOI.DDF.EscherBSERecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  299. <summary>
  300. This method deSerializes the record from a byte array.
  301. </summary>
  302. <param name="data">The byte array containing the escher record information</param>
  303. <param name="offset">The starting offset into data</param>
  304. <param name="recordFactory">May be null since this is not a container record.</param>
  305. <returns>The number of bytes Read from the byte array.</returns>
  306. </member>
  307. <member name="M:NPOI.DDF.EscherBSERecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  308. <summary>
  309. This method Serializes this escher record into a byte array.
  310. </summary>
  311. <param name="offset">The offset into
  312. data to start writing the record data to</param>
  313. <param name="data">The byte array to Serialize to.</param>
  314. <param name="listener">a listener for begin and end serialization events.</param>
  315. <returns>The number of bytes written.</returns>
  316. </member>
  317. <member name="P:NPOI.DDF.EscherBSERecord.RecordSize">
  318. <summary>
  319. Returns the number of bytes that are required to Serialize this record.
  320. </summary>
  321. <value>Number of bytes</value>
  322. </member>
  323. <member name="P:NPOI.DDF.EscherBSERecord.RecordName">
  324. <summary>
  325. The short name for this record
  326. </summary>
  327. <value></value>
  328. </member>
  329. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeWin32">
  330. <summary>
  331. Gets or sets the expected blip type under windows (failure to match this blip type will result in
  332. Excel converting to this format).
  333. </summary>
  334. <value>The blip type win32.</value>
  335. </member>
  336. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeMacOS">
  337. <summary>
  338. Gets or sets the expected blip type under MacOS (failure to match this blip type will result in
  339. Excel converting to this format).
  340. </summary>
  341. <value>The blip type mac OS.</value>
  342. </member>
  343. <member name="P:NPOI.DDF.EscherBSERecord.UID">
  344. <summary>
  345. Gets or sets 16 byte MD4 checksum.
  346. </summary>
  347. <value>The UID.</value>
  348. </member>
  349. <member name="P:NPOI.DDF.EscherBSERecord.Tag">
  350. <summary>
  351. Gets or sets the tag. (Unused)
  352. </summary>
  353. <value>The tag.</value>
  354. </member>
  355. <member name="P:NPOI.DDF.EscherBSERecord.Size">
  356. <summary>
  357. Gets or sets Blip size in stream..
  358. </summary>
  359. <value>The size.</value>
  360. </member>
  361. <member name="P:NPOI.DDF.EscherBSERecord.Ref">
  362. <summary>
  363. Gets or sets the reference count of this blip.
  364. </summary>
  365. <value>The ref.</value>
  366. </member>
  367. <member name="P:NPOI.DDF.EscherBSERecord.Offset">
  368. <summary>
  369. Gets or sets the offset in the delay stream..
  370. </summary>
  371. <value>The offset.</value>
  372. </member>
  373. <member name="P:NPOI.DDF.EscherBSERecord.Usage">
  374. <summary>
  375. Defines the way this blip is used.
  376. </summary>
  377. <value>The usage.</value>
  378. </member>
  379. <member name="P:NPOI.DDF.EscherBSERecord.Name">
  380. <summary>
  381. Gets or sets the blip name.
  382. </summary>
  383. <value>The name.</value>
  384. </member>
  385. <member name="P:NPOI.DDF.EscherBSERecord.Unused2">
  386. <summary>
  387. Gets or sets the unused2.
  388. </summary>
  389. <value>The unused2.</value>
  390. </member>
  391. <member name="P:NPOI.DDF.EscherBSERecord.Unused3">
  392. <summary>
  393. Gets or sets the unused3.
  394. </summary>
  395. <value>The unused3.</value>
  396. </member>
  397. <member name="P:NPOI.DDF.EscherBSERecord.BlipRecord">
  398. <summary>
  399. Gets or sets the blip record.
  400. </summary>
  401. <value>The blip record.</value>
  402. </member>
  403. <member name="P:NPOI.DDF.EscherBSERecord.RemainingData">
  404. <summary>
  405. Gets or sets any remaining data in this record.
  406. </summary>
  407. <value>The remaining data.</value>
  408. </member>
  409. <member name="M:NPOI.DDF.EscherBSERecord.ToString">
  410. <summary>
  411. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  412. </summary>
  413. <returns>
  414. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  415. </returns>
  416. </member>
  417. <member name="M:NPOI.DDF.EscherBSERecord.GetBlipType(System.Byte)">
  418. <summary>
  419. Retrieve the string representation given a blip id.
  420. </summary>
  421. <param name="b">The b.</param>
  422. <returns></returns>
  423. </member>
  424. <member name="T:NPOI.DDF.EscherChildAnchorRecord">
  425. <summary>
  426. The escher child achor record is used to specify the position of a shape under an
  427. existing group. The first level of shape records use a EscherClientAnchor record instead.
  428. @author Glen Stampoultzis
  429. </summary>
  430. </member>
  431. <member name="M:NPOI.DDF.EscherChildAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  432. <summary>
  433. This method deSerializes the record from a byte array.
  434. </summary>
  435. <param name="data">The byte array containing the escher record information</param>
  436. <param name="offset">The starting offset into data</param>
  437. <param name="recordFactory">May be null since this is not a container record.</param>
  438. <returns>The number of bytes Read from the byte array.</returns>
  439. </member>
  440. <member name="M:NPOI.DDF.EscherChildAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  441. <summary>
  442. This method Serializes this escher record into a byte array.
  443. </summary>
  444. <param name="offset">The offset into data to start writing the record data to.</param>
  445. <param name="data">The byte array to Serialize to.</param>
  446. <param name="listener">a listener for begin and end serialization events.</param>
  447. <returns>The number of bytes written.</returns>
  448. </member>
  449. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordSize">
  450. <summary>
  451. Returns the number of bytes that are required to Serialize this record.
  452. </summary>
  453. <value>Number of bytes</value>
  454. </member>
  455. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordId">
  456. <summary>
  457. The record id for the EscherChildAnchorRecord.
  458. </summary>
  459. <value></value>
  460. </member>
  461. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordName">
  462. <summary>
  463. The short name for this record
  464. </summary>
  465. <value></value>
  466. </member>
  467. <member name="M:NPOI.DDF.EscherChildAnchorRecord.ToString">
  468. <summary>
  469. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  470. </summary>
  471. <returns>
  472. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  473. </returns>
  474. </member>
  475. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx1">
  476. <summary>
  477. Gets or sets offset within the parent coordinate space for the top left point.
  478. </summary>
  479. <value>The DX1.</value>
  480. </member>
  481. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy1">
  482. <summary>
  483. Gets or sets the offset within the parent coordinate space for the top left point.
  484. </summary>
  485. <value>The dy1.</value>
  486. </member>
  487. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx2">
  488. <summary>
  489. Gets or sets the offset within the parent coordinate space for the bottom right point.
  490. </summary>
  491. <value>The DX2.</value>
  492. </member>
  493. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy2">
  494. <summary>
  495. Gets or sets the offset within the parent coordinate space for the bottom right point.
  496. </summary>
  497. <value>The dy2.</value>
  498. </member>
  499. <member name="T:NPOI.DDF.EscherClientAnchorRecord">
  500. <summary>
  501. The escher client anchor specifies which rows and cells the shape is bound to as well as
  502. the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless
  503. of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most
  504. shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
  505. @author Glen Stampoultzis
  506. </summary>
  507. </member>
  508. <member name="F:NPOI.DDF.EscherClientAnchorRecord.field_1_flag">
  509. bit[0] - fMove (1 bit): A bit that specifies whether the shape will be kept intact when the cells are moved.
  510. 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.
  511. bit[2-4] - reserved, MUST be 0 and MUST be ignored
  512. bit[5-15]- Undefined and MUST be ignored.
  513. it can take values: 0, 2, 3
  514. </member>
  515. <member name="M:NPOI.DDF.EscherClientAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  516. <summary>
  517. This method deSerializes the record from a byte array.
  518. </summary>
  519. <param name="data">The byte array containing the escher record information</param>
  520. <param name="offset">The starting offset into data</param>
  521. <param name="recordFactory">May be null since this is not a container record.</param>
  522. <returns>The number of bytes Read from the byte array.</returns>
  523. </member>
  524. <member name="M:NPOI.DDF.EscherClientAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  525. <summary>
  526. This method Serializes this escher record into a byte array.
  527. </summary>
  528. <param name="offset">The offset into data to start writing the record data to.</param>
  529. <param name="data">The byte array to Serialize to.</param>
  530. <param name="listener">a listener for begin and end serialization events.</param>
  531. <returns>The number of bytes written.</returns>
  532. </member>
  533. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordSize">
  534. <summary>
  535. Returns the number of bytes that are required to Serialize this record.
  536. </summary>
  537. <value>Number of bytes</value>
  538. </member>
  539. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordId">
  540. <summary>
  541. The record id for this record.
  542. </summary>
  543. <value></value>
  544. </member>
  545. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordName">
  546. <summary>
  547. The short name for this record
  548. </summary>
  549. <value></value>
  550. </member>
  551. <member name="M:NPOI.DDF.EscherClientAnchorRecord.ToString">
  552. <summary>
  553. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  554. </summary>
  555. <returns>
  556. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  557. </returns>
  558. </member>
  559. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Flag">
  560. <summary>
  561. Gets or sets the flag.
  562. </summary>
  563. <value>0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</value>
  564. </member>
  565. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col1">
  566. <summary>
  567. Gets or sets The column number for the top-left position. 0 based.
  568. </summary>
  569. <value>The col1.</value>
  570. </member>
  571. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx1">
  572. <summary>
  573. Gets or sets The x offset within the top-left cell. Range is from 0 to 1023.
  574. </summary>
  575. <value>The DX1.</value>
  576. </member>
  577. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row1">
  578. <summary>
  579. Gets or sets The row number for the top-left corner of the shape.
  580. </summary>
  581. <value>The row1.</value>
  582. </member>
  583. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy1">
  584. <summary>
  585. Gets or sets The y offset within the top-left corner of the current shape.
  586. </summary>
  587. <value>The dy1.</value>
  588. </member>
  589. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col2">
  590. <summary>
  591. Gets or sets The column of the bottom right corner of this shape.
  592. </summary>
  593. <value>The col2.</value>
  594. </member>
  595. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx2">
  596. <summary>
  597. Gets or sets The x offset withing the cell for the bottom-right corner of this shape.
  598. </summary>
  599. <value>The DX2.</value>
  600. </member>
  601. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row2">
  602. <summary>
  603. Gets or sets The row number for the bottom-right corner of the current shape.
  604. </summary>
  605. <value>The row2.</value>
  606. </member>
  607. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy2">
  608. <summary>
  609. Gets or sets The y offset withing the cell for the bottom-right corner of this shape.
  610. </summary>
  611. <value>The dy2.</value>
  612. </member>
  613. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RemainingData">
  614. <summary>
  615. Gets or sets the remaining data.
  616. </summary>
  617. <value>The remaining data.</value>
  618. </member>
  619. <member name="T:NPOI.DDF.EscherClientDataRecord">
  620. <summary>
  621. The EscherClientDataRecord is used to store client specific data about the position of a
  622. shape within a container.
  623. @author Glen Stampoultzis
  624. </summary>
  625. </member>
  626. <member name="M:NPOI.DDF.EscherClientDataRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  627. <summary>
  628. This method deSerializes the record from a byte array.
  629. </summary>
  630. <param name="data">The byte array containing the escher record information</param>
  631. <param name="offset">The starting offset into data</param>
  632. <param name="recordFactory">May be null since this is not a container record.</param>
  633. <returns>The number of bytes Read from the byte array.</returns>
  634. </member>
  635. <member name="M:NPOI.DDF.EscherClientDataRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  636. This method Serializes this escher record into a byte array.
  637. @param offset The offset into <c>data</c> to start writing the record data to.
  638. @param data The byte array to Serialize to.
  639. @param listener A listener to retrieve start and end callbacks. Use a <c>NullEscherSerailizationListener</c> to ignore these events.
  640. @return The number of bytes written.
  641. @see NullEscherSerializationListener
  642. </member>
  643. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordSize">
  644. Returns the number of bytes that are required to Serialize this record.
  645. @return Number of bytes
  646. </member>
  647. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordId">
  648. Returns the identifier of this record.
  649. </member>
  650. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordName">
  651. The short name for this record
  652. </member>
  653. <member name="M:NPOI.DDF.EscherClientDataRecord.ToString">
  654. Returns the string representation of this record.
  655. </member>
  656. <member name="P:NPOI.DDF.EscherClientDataRecord.RemainingData">
  657. Any data recording this record.
  658. </member>
  659. <member name="T:NPOI.DDF.EscherComplexProperty">
  660. <summary>
  661. A complex property differs from a simple property in that the data can not fit inside a 32 bit
  662. integer. See the specification for more detailed information regarding exactly what is
  663. stored here.
  664. @author Glen Stampoultzis
  665. </summary>
  666. </member>
  667. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Byte[])">
  668. <summary>
  669. Create a complex property using the property id and a byte array containing the complex
  670. data value.
  671. </summary>
  672. <param name="id"> The id consists of the property number, a flag indicating whether this is a blip id and a flag
  673. indicating that this is a complex property.</param>
  674. <param name="complexData">The value of this property.</param>
  675. </member>
  676. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Boolean,System.Byte[])">
  677. <summary>
  678. Create a complex property using the property number, a flag to indicate whether this is a
  679. blip reference and the complex property data.
  680. </summary>
  681. <param name="propertyNumber">The property number.</param>
  682. <param name="isBlipId">Whether this is a blip id. Should be false.</param>
  683. <param name="complexData">The value of this complex property.</param>
  684. </member>
  685. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  686. <summary>
  687. Serializes the simple part of this property. ie the first 6 bytes.
  688. </summary>
  689. <param name="data"></param>
  690. <param name="pos"></param>
  691. <returns></returns>
  692. </member>
  693. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  694. <summary>
  695. Serializes the complex part of this property
  696. </summary>
  697. <param name="data">The data array to Serialize to</param>
  698. <param name="pos">The offset within data to start serializing to.</param>
  699. <returns>The number of bytes Serialized.</returns>
  700. </member>
  701. <member name="P:NPOI.DDF.EscherComplexProperty.ComplexData">
  702. <summary>
  703. Gets the complex data.
  704. </summary>
  705. <value>The complex data.</value>
  706. </member>
  707. <member name="M:NPOI.DDF.EscherComplexProperty.Equals(System.Object)">
  708. <summary>
  709. Determine whether this property is equal to another property.
  710. </summary>
  711. <param name="o">The object to compare to.</param>
  712. <returns>True if the objects are equal.</returns>
  713. </member>
  714. <member name="P:NPOI.DDF.EscherComplexProperty.PropertySize">
  715. <summary>
  716. Caclulates the number of bytes required to Serialize this property.
  717. </summary>
  718. <value>Number of bytes</value>
  719. </member>
  720. <member name="M:NPOI.DDF.EscherComplexProperty.GetHashCode">
  721. <summary>
  722. Serves as a hash function for a particular type.
  723. </summary>
  724. <returns>
  725. A hash code for the current <see cref="T:System.Object"/>.
  726. </returns>
  727. </member>
  728. <member name="M:NPOI.DDF.EscherComplexProperty.ToString">
  729. <summary>
  730. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  731. </summary>
  732. <returns>
  733. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  734. </returns>
  735. </member>
  736. <member name="T:NPOI.DDF.EscherContainerRecord">
  737. <summary>
  738. Escher container records store other escher records as children.
  739. The container records themselves never store any information beyond
  740. the standard header used by all escher records. This one record is
  741. used to represent many different types of records.
  742. @author Glen Stampoultzis
  743. </summary>
  744. </member>
  745. <member name="F:NPOI.DDF.EscherContainerRecord._remainingLength">
  746. in case if document contains any charts we have such document structure:
  747. BOF
  748. ...
  749. DrawingRecord
  750. ...
  751. ObjRecord|TxtObjRecord
  752. ...
  753. EOF
  754. ...
  755. BOF(Chart begin)
  756. ...
  757. DrawingRecord
  758. ...
  759. ObjRecord|TxtObjRecord
  760. ...
  761. EOF
  762. So, when we call EscherAggregate.createAggregate() we have not all needed data.
  763. When we got warning "WARNING: " + bytesRemaining + " bytes remaining but no space left"
  764. we should save value of bytesRemaining
  765. and add it to container size when we serialize it
  766. </member>
  767. <member name="M:NPOI.DDF.EscherContainerRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  768. <summary>
  769. The contract of this method is to deSerialize an escher record including
  770. it's children.
  771. </summary>
  772. <param name="data">The byte array containing the Serialized escher
  773. records.</param>
  774. <param name="offset">The offset into the byte array.</param>
  775. <param name="recordFactory">A factory for creating new escher records</param>
  776. <returns>The number of bytes written.</returns>
  777. </member>
  778. <member name="M:NPOI.DDF.EscherContainerRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  779. <summary>
  780. Serializes to an existing byte array without serialization listener.
  781. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  782. </summary>
  783. <param name="offset">the offset within the data byte array.</param>
  784. <param name="data"> the data array to Serialize to.</param>
  785. <param name="listener">a listener for begin and end serialization events.</param>
  786. <returns>The number of bytes written.</returns>
  787. </member>
  788. <member name="P:NPOI.DDF.EscherContainerRecord.RecordSize">
  789. <summary>
  790. Subclasses should effeciently return the number of bytes required to
  791. Serialize the record.
  792. </summary>
  793. <value>number of bytes</value>
  794. </member>
  795. <member name="M:NPOI.DDF.EscherContainerRecord.HasChildOfType(System.Int16)">
  796. <summary>
  797. Do any of our (top level) children have the
  798. given recordId?
  799. </summary>
  800. <param name="recordId">The record id.</param>
  801. <returns>
  802. <c>true</c> if [has child of type] [the specified record id]; otherwise, <c>false</c>.
  803. </returns>
  804. </member>
  805. <member name="P:NPOI.DDF.EscherContainerRecord.ChildRecords">
  806. <summary>
  807. Returns a list of all the child (escher) records
  808. of the container.
  809. </summary>
  810. <value></value>
  811. </member>
  812. <member name="P:NPOI.DDF.EscherContainerRecord.ChildContainers">
  813. <summary>
  814. Returns all of our children which are also
  815. EscherContainers (may be 0, 1, or vary rarely
  816. 2 or 3)
  817. </summary>
  818. <value>The child containers.</value>
  819. </member>
  820. <member name="P:NPOI.DDF.EscherContainerRecord.RecordName">
  821. <summary>
  822. Subclasses should return the short name for this escher record.
  823. </summary>
  824. <value></value>
  825. </member>
  826. <member name="M:NPOI.DDF.EscherContainerRecord.Display(System.Int32)">
  827. <summary>
  828. The display methods allows escher variables to print the record names
  829. according to their hierarchy.
  830. </summary>
  831. <param name="indent">The current indent level.</param>
  832. </member>
  833. <member name="M:NPOI.DDF.EscherContainerRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  834. <summary>
  835. Adds the child record.
  836. </summary>
  837. <param name="record">The record.</param>
  838. </member>
  839. <member name="M:NPOI.DDF.EscherContainerRecord.ToString">
  840. <summary>
  841. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  842. </summary>
  843. <returns>
  844. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  845. </returns>
  846. </member>
  847. <member name="M:NPOI.DDF.EscherContainerRecord.GetChildById(System.Int16)">
  848. <summary>
  849. Gets the child by id.
  850. </summary>
  851. <param name="recordId">The record id.</param>
  852. <returns></returns>
  853. </member>
  854. <member name="M:NPOI.DDF.EscherContainerRecord.GetRecordsById(System.Int16,System.Collections.ArrayList@)">
  855. <summary>
  856. Recursively find records with the specified record ID
  857. </summary>
  858. <param name="recordId"></param>
  859. <param name="out1">list to store found records</param>
  860. </member>
  861. <member name="T:NPOI.DDF.EscherDggRecord">
  862. <summary>
  863. This record defines the drawing groups used for a particular sheet.
  864. </summary>
  865. </member>
  866. <member name="M:NPOI.DDF.EscherDggRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  867. <summary>
  868. This method deSerializes the record from a byte array.
  869. </summary>
  870. <param name="data">The byte array containing the escher record information</param>
  871. <param name="offset">The starting offset into data</param>
  872. <param name="recordFactory">May be null since this is not a container record.</param>
  873. <returns>The number of bytes Read from the byte array.</returns>
  874. </member>
  875. <member name="M:NPOI.DDF.EscherDggRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  876. <summary>
  877. This method Serializes this escher record into a byte array.
  878. </summary>
  879. <param name="offset">The offset into data to start writing the record data to.</param>
  880. <param name="data">The byte array to Serialize to.</param>
  881. <param name="listener">a listener for begin and end serialization events.</param>
  882. <returns>The number of bytes written.</returns>
  883. </member>
  884. <member name="P:NPOI.DDF.EscherDggRecord.RecordSize">
  885. <summary>
  886. Returns the number of bytes that are required to Serialize this record.
  887. </summary>
  888. <value>Number of bytes</value>
  889. </member>
  890. <member name="P:NPOI.DDF.EscherDggRecord.RecordId">
  891. <summary>
  892. Return the current record id.
  893. </summary>
  894. <value>The 16 bit record id.</value>
  895. </member>
  896. <member name="P:NPOI.DDF.EscherDggRecord.RecordName">
  897. <summary>
  898. The short name for this record
  899. </summary>
  900. <value></value>
  901. </member>
  902. <member name="M:NPOI.DDF.EscherDggRecord.ToString">
  903. <summary>
  904. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  905. </summary>
  906. <returns>
  907. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  908. </returns>
  909. </member>
  910. <member name="P:NPOI.DDF.EscherDggRecord.ShapeIdMax">
  911. <summary>
  912. Gets or sets the shape id max.
  913. </summary>
  914. <value>The shape id max.</value>
  915. </member>
  916. <member name="P:NPOI.DDF.EscherDggRecord.NumIdClusters">
  917. <summary>
  918. Gets the Number of id clusters + 1
  919. </summary>
  920. <value>The num id clusters.</value>
  921. </member>
  922. <member name="P:NPOI.DDF.EscherDggRecord.NumShapesSaved">
  923. <summary>
  924. Gets or sets the num shapes saved.
  925. </summary>
  926. <value>The num shapes saved.</value>
  927. </member>
  928. <member name="P:NPOI.DDF.EscherDggRecord.DrawingsSaved">
  929. <summary>
  930. Gets or sets the drawings saved.
  931. </summary>
  932. <value>The drawings saved.</value>
  933. </member>
  934. <member name="P:NPOI.DDF.EscherDggRecord.MaxDrawingGroupId">
  935. <summary>
  936. Gets or sets the max drawing group id.
  937. </summary>
  938. <value>The max drawing group id.</value>
  939. </member>
  940. <member name="P:NPOI.DDF.EscherDggRecord.FileIdClusters">
  941. <summary>
  942. Gets or sets the file id clusters.
  943. </summary>
  944. <value>The file id clusters.</value>
  945. </member>
  946. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32)">
  947. <summary>
  948. Adds the cluster.
  949. </summary>
  950. <param name="dgId">The dg id.</param>
  951. <param name="numShapedUsed">The num shaped used.</param>
  952. </member>
  953. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32,System.Boolean)">
  954. <summary>
  955. Adds the cluster.
  956. </summary>
  957. <param name="dgId">id of the drawing group (stored in the record options)</param>
  958. <param name="numShapedUsed">initial value of the numShapedUsed field</param>
  959. <param name="sort">if set to <c>true</c> if true then sort clusters by drawing group id.(
  960. In Excel the clusters are sorted but in PPT they are not).</param>
  961. </member>
  962. <member name="T:NPOI.DDF.EscherDgRecord">
  963. <summary>
  964. This record simply holds the number of shapes in the drawing group and the
  965. last shape id used for this drawing group.
  966. @author Glen Stampoultzis
  967. </summary>
  968. </member>
  969. <member name="M:NPOI.DDF.EscherDgRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  970. <summary>
  971. This method deSerializes the record from a byte array.
  972. </summary>
  973. <param name="data">The byte array containing the escher record information</param>
  974. <param name="offset">The starting offset into data</param>
  975. <param name="recordFactory">May be null since this is not a container record.</param>
  976. <returns>The number of bytes Read from the byte array.</returns>
  977. </member>
  978. <member name="M:NPOI.DDF.EscherDgRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  979. <summary>
  980. This method Serializes this escher record into a byte array.
  981. </summary>
  982. <param name="offset"> The offset into data to start writing the record data to.</param>
  983. <param name="data"> The byte array to Serialize to.</param>
  984. <returns>The number of bytes written.</returns>
  985. <param name="listener">a listener for begin and end serialization events.</param>
  986. </member>
  987. <member name="P:NPOI.DDF.EscherDgRecord.RecordSize">
  988. <summary>
  989. Returns the number of bytes that are required to Serialize this record.
  990. </summary>
  991. <value>Number of bytes</value>
  992. </member>
  993. <member name="P:NPOI.DDF.EscherDgRecord.RecordId">
  994. <summary>
  995. Return the current record id.
  996. </summary>
  997. <value>The 16 bit record id.</value>
  998. </member>
  999. <member name="P:NPOI.DDF.EscherDgRecord.RecordName">
  1000. <summary>
  1001. The short name for this record
  1002. </summary>
  1003. <value></value>
  1004. </member>
  1005. <member name="M:NPOI.DDF.EscherDgRecord.ToString">
  1006. <summary>
  1007. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1008. </summary>
  1009. <returns>
  1010. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1011. </returns>
  1012. </member>
  1013. <member name="P:NPOI.DDF.EscherDgRecord.NumShapes">
  1014. <summary>
  1015. Gets or sets The number of shapes in this drawing group.
  1016. </summary>
  1017. <value>The num shapes.</value>
  1018. </member>
  1019. <member name="P:NPOI.DDF.EscherDgRecord.LastMSOSPID">
  1020. <summary>
  1021. Gets or sets The last shape id used in this drawing group.
  1022. </summary>
  1023. <value>The last MSOSPID.</value>
  1024. </member>
  1025. <member name="P:NPOI.DDF.EscherDgRecord.DrawingGroupId">
  1026. <summary>
  1027. Gets the drawing group id for this record. This is encoded in the
  1028. instance part of the option record.
  1029. </summary>
  1030. <value>The drawing group id.</value>
  1031. </member>
  1032. <member name="M:NPOI.DDF.EscherDgRecord.IncrementShapeCount">
  1033. <summary>
  1034. Increments the shape count.
  1035. </summary>
  1036. </member>
  1037. <member name="T:NPOI.DDF.EscherDump">
  1038. <summary>
  1039. Used to dump the contents of escher records to a PrintStream.
  1040. @author Glen Stampoultzis (glens at apache.org)
  1041. </summary>
  1042. </member>
  1043. <member name="M:NPOI.DDF.EscherDump.Dump(System.Byte[],System.Int32,System.Int32)">
  1044. <summary>
  1045. Decodes the escher stream from a byte array and dumps the results to
  1046. a print stream.
  1047. </summary>
  1048. <param name="data">The data array containing the escher records.</param>
  1049. <param name="offset">The starting offset within the data array.</param>
  1050. <param name="size">The number of bytes to Read.</param>
  1051. </member>
  1052. <member name="M:NPOI.DDF.EscherDump.DumpOld(System.Int64,System.IO.Stream)">
  1053. <summary>
  1054. This version of dump is a translation from the open office escher dump routine.
  1055. </summary>
  1056. <param name="maxLength">The number of bytes to Read</param>
  1057. <param name="in1">An input stream to Read from.</param>
  1058. </member>
  1059. <member name="M:NPOI.DDF.EscherDump.PropertyName(System.Int16)">
  1060. <summary>
  1061. Returns a property name given a property id. This is used only by the
  1062. old escher dump routine.
  1063. </summary>
  1064. <param name="propertyId">The property number for the name</param>
  1065. <returns>A descriptive name.</returns>
  1066. </member>
  1067. <member name="M:NPOI.DDF.EscherDump.GetBlipType(System.Byte)">
  1068. <summary>
  1069. Returns the blip description given a blip id.
  1070. </summary>
  1071. <param name="b">blip id</param>
  1072. <returns> A description.</returns>
  1073. </member>
  1074. <member name="M:NPOI.DDF.EscherDump.Dec1616(System.Int32)">
  1075. <summary>
  1076. Straight conversion from OO. Converts a type of float.
  1077. </summary>
  1078. <param name="n32">The N32.</param>
  1079. <returns></returns>
  1080. </member>
  1081. <member name="M:NPOI.DDF.EscherDump.OutHex(System.Int32,System.IO.Stream)">
  1082. <summary>
  1083. Dumps out a hex value by Reading from a input stream.
  1084. </summary>
  1085. <param name="bytes">How many bytes this hex value consists of.</param>
  1086. <param name="in1">The stream to Read the hex value from.</param>
  1087. </member>
  1088. <member name="M:NPOI.DDF.EscherDump.Dump(System.Int32,System.Byte[])">
  1089. <summary>
  1090. Dumps the specified record size.
  1091. </summary>
  1092. <param name="recordSize">Size of the record.</param>
  1093. <param name="data">The data.</param>
  1094. </member>
  1095. <member name="T:NPOI.DDF.EscherMetafileBlip">
  1096. <summary>
  1097. @author Daniel Noll
  1098. </summary>
  1099. </member>
  1100. <member name="F:NPOI.DDF.EscherMetafileBlip.SIGNATURE_EMF">
  1101. BLIP signatures as defined in the escher spec
  1102. </member>
  1103. <member name="F:NPOI.DDF.EscherMetafileBlip.field_2_UID">
  1104. The primary UID is only saved to disk if (blip_instance ^ blip_signature == 1)
  1105. </member>
  1106. <member name="M:NPOI.DDF.EscherMetafileBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1107. <summary>
  1108. This method deSerializes the record from a byte array.
  1109. </summary>
  1110. <param name="data">The byte array containing the escher record information</param>
  1111. <param name="offset">The starting offset into</param>
  1112. <param name="recordFactory">May be null since this is not a container record.</param>
  1113. <returns>
  1114. The number of bytes Read from the byte array.
  1115. </returns>
  1116. </member>
  1117. <member name="M:NPOI.DDF.EscherMetafileBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1118. <summary>
  1119. Serializes the record to an existing byte array.
  1120. </summary>
  1121. <param name="offset">the offset within the byte array</param>
  1122. <param name="data">the data array to Serialize to</param>
  1123. <param name="listener">a listener for begin and end serialization events.</param>
  1124. <returns>the number of bytes written.</returns>
  1125. </member>
  1126. <member name="M:NPOI.DDF.EscherMetafileBlip.InflatePictureData(System.Byte[])">
  1127. <summary>
  1128. Decompresses the provided data, returning the inflated result.
  1129. </summary>
  1130. <param name="data">the deflated picture data.</param>
  1131. <returns>the inflated picture data.</returns>
  1132. </member>
  1133. <member name="P:NPOI.DDF.EscherMetafileBlip.RecordSize">
  1134. <summary>
  1135. Returns the number of bytes that are required to Serialize this record.
  1136. </summary>
  1137. <value>Number of bytes</value>
  1138. </member>
  1139. <member name="P:NPOI.DDF.EscherMetafileBlip.UID">
  1140. <summary>
  1141. Gets or sets the UID.
  1142. </summary>
  1143. <value>The UID.</value>
  1144. </member>
  1145. <member name="P:NPOI.DDF.EscherMetafileBlip.PrimaryUID">
  1146. <summary>
  1147. Gets or sets the primary UID.
  1148. </summary>
  1149. <value>The primary UID.</value>
  1150. </member>
  1151. <member name="P:NPOI.DDF.EscherMetafileBlip.UncompressedSize">
  1152. <summary>
  1153. Gets or sets the size of the uncompressed.
  1154. </summary>
  1155. <value>The size of the uncompressed.</value>
  1156. </member>
  1157. <member name="P:NPOI.DDF.EscherMetafileBlip.Bounds">
  1158. <summary>
  1159. Gets or sets the bounds.
  1160. </summary>
  1161. <value>The bounds.</value>
  1162. </member>
  1163. <member name="P:NPOI.DDF.EscherMetafileBlip.SizeEMU">
  1164. <summary>
  1165. Gets or sets the size EMU.
  1166. </summary>
  1167. <value>The size EMU.</value>
  1168. </member>
  1169. <member name="P:NPOI.DDF.EscherMetafileBlip.CompressedSize">
  1170. <summary>
  1171. Gets or sets the size of the compressed.
  1172. </summary>
  1173. <value>The size of the compressed.</value>
  1174. </member>
  1175. <member name="P:NPOI.DDF.EscherMetafileBlip.IsCompressed">
  1176. <summary>
  1177. Gets or sets a value indicating whether this instance is compressed.
  1178. </summary>
  1179. <value>
  1180. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  1181. </value>
  1182. </member>
  1183. <member name="M:NPOI.DDF.EscherMetafileBlip.ToString">
  1184. <summary>
  1185. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1186. </summary>
  1187. <returns>
  1188. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1189. </returns>
  1190. </member>
  1191. <member name="P:NPOI.DDF.EscherMetafileBlip.Signature">
  1192. <summary>
  1193. Return the blip signature
  1194. </summary>
  1195. <value>the blip signature</value>
  1196. </member>
  1197. <member name="T:NPOI.DDF.EscherOptRecord">
  1198. <summary>
  1199. The opt record is used to store property values for a shape. It is the key to determining
  1200. the attributes of a shape. Properties can be of two types: simple or complex. Simple types
  1201. are fixed Length. Complex properties are variable Length.
  1202. @author Glen Stampoultzis
  1203. </summary>
  1204. </member>
  1205. <member name="P:NPOI.DDF.EscherOptRecord.Options">
  1206. <summary>
  1207. Automatically recalculate the correct option
  1208. </summary>
  1209. <value></value>
  1210. </member>
  1211. <member name="P:NPOI.DDF.EscherOptRecord.RecordName">
  1212. <summary>
  1213. The short name for this record
  1214. </summary>
  1215. <value></value>
  1216. </member>
  1217. <member name="T:NPOI.DDF.EscherPictBlip">
  1218. <summary>
  1219. @author Daniel Noll
  1220. </summary>
  1221. </member>
  1222. <member name="M:NPOI.DDF.EscherPictBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1223. <summary>
  1224. This method deSerializes the record from a byte array.
  1225. </summary>
  1226. <param name="data">The byte array containing the escher record information</param>
  1227. <param name="offset">The starting offset into</param>
  1228. <param name="recordFactory">May be null since this is not a container record.</param>
  1229. <returns>
  1230. The number of bytes Read from the byte array.
  1231. </returns>
  1232. </member>
  1233. <member name="M:NPOI.DDF.EscherPictBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1234. <summary>
  1235. Serializes the record to an existing byte array.
  1236. </summary>
  1237. <param name="offset">the offset within the byte array</param>
  1238. <param name="data">the data array to Serialize to</param>
  1239. <param name="listener">a listener for begin and end serialization events.</param>
  1240. <returns>the number of bytes written.</returns>
  1241. </member>
  1242. <member name="M:NPOI.DDF.EscherPictBlip.InflatePictureData(System.Byte[])">
  1243. <summary>
  1244. Decompresses the provided data, returning the inflated result.
  1245. </summary>
  1246. <param name="data">the deflated picture data.</param>
  1247. <returns>the inflated picture data.</returns>
  1248. </member>
  1249. <member name="P:NPOI.DDF.EscherPictBlip.RecordSize">
  1250. <summary>
  1251. Returns the number of bytes that are required to Serialize this record.
  1252. </summary>
  1253. <value>Number of bytes</value>
  1254. </member>
  1255. <member name="P:NPOI.DDF.EscherPictBlip.UID">
  1256. <summary>
  1257. Gets or sets the UID.
  1258. </summary>
  1259. <value>The UID.</value>
  1260. </member>
  1261. <member name="P:NPOI.DDF.EscherPictBlip.UncompressedSize">
  1262. <summary>
  1263. Gets or sets the size of the uncompressed.
  1264. </summary>
  1265. <value>The size of the uncompressed.</value>
  1266. </member>
  1267. <member name="P:NPOI.DDF.EscherPictBlip.Bounds">
  1268. <summary>
  1269. Gets or sets the bounds.
  1270. </summary>
  1271. <value>The bounds.</value>
  1272. </member>
  1273. <member name="P:NPOI.DDF.EscherPictBlip.SizeEMU">
  1274. <summary>
  1275. Gets or sets the size EMU.
  1276. </summary>
  1277. <value>The size EMU.</value>
  1278. </member>
  1279. <member name="P:NPOI.DDF.EscherPictBlip.CompressedSize">
  1280. <summary>
  1281. Gets or sets the size of the compressed.
  1282. </summary>
  1283. <value>The size of the compressed.</value>
  1284. </member>
  1285. <member name="P:NPOI.DDF.EscherPictBlip.IsCompressed">
  1286. <summary>
  1287. Gets a value indicating whether this instance is compressed.
  1288. </summary>
  1289. <value>
  1290. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  1291. </value>
  1292. </member>
  1293. <member name="M:NPOI.DDF.EscherPictBlip.ToString">
  1294. <summary>
  1295. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1296. </summary>
  1297. <returns>
  1298. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1299. </returns>
  1300. </member>
  1301. <member name="T:NPOI.DDF.EscherProperties">
  1302. <summary>
  1303. Provides a list of all known escher properties including the description and
  1304. type.
  1305. @author Glen Stampoultzis (glens at apache.org)
  1306. </summary>
  1307. </member>
  1308. <member name="M:NPOI.DDF.EscherProperties.InitProps">
  1309. <summary>
  1310. Inits the props.
  1311. </summary>
  1312. </member>
  1313. <member name="M:NPOI.DDF.EscherProperties.AddProp(System.Int32,NPOI.DDF.EscherPropertyMetaData)">
  1314. <summary>
  1315. Adds the prop.
  1316. </summary>
  1317. <param name="s">The s.</param>
  1318. <param name="data">The data.</param>
  1319. </member>
  1320. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String,System.Byte)">
  1321. <summary>
  1322. Gets the data.
  1323. </summary>
  1324. <param name="propName">Name of the prop.</param>
  1325. <param name="type">The type.</param>
  1326. <returns></returns>
  1327. </member>
  1328. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String)">
  1329. <summary>
  1330. Gets the data.
  1331. </summary>
  1332. <param name="propName">Name of the prop.</param>
  1333. <returns></returns>
  1334. </member>
  1335. <member name="M:NPOI.DDF.EscherProperties.GetPropertyName(System.Int16)">
  1336. <summary>
  1337. Gets the name of the property.
  1338. </summary>
  1339. <param name="propertyId">The property id.</param>
  1340. <returns></returns>
  1341. </member>
  1342. <member name="M:NPOI.DDF.EscherProperties.GetPropertyType(System.Int16)">
  1343. <summary>
  1344. Gets the type of the property.
  1345. </summary>
  1346. <param name="propertyId">The property id.</param>
  1347. <returns></returns>
  1348. </member>
  1349. <member name="T:NPOI.DDF.EscherProperty">
  1350. <summary>
  1351. This is the abstract base class for all escher properties.
  1352. @see EscherOptRecord
  1353. @author Glen Stampoultzis (glens at apache.org)
  1354. </summary>
  1355. </member>
  1356. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16)">
  1357. <summary>
  1358. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.
  1359. </summary>
  1360. <param name="id">The id is distinct from the actual property number. The id includes the property number the blip id
  1361. flag and an indicator whether the property is complex or not.</param>
  1362. </member>
  1363. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16,System.Boolean,System.Boolean)">
  1364. <summary>
  1365. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.The three parameters are combined to form a property
  1366. id.
  1367. </summary>
  1368. <param name="propertyNumber">The property number.</param>
  1369. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1370. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1371. </member>
  1372. <member name="P:NPOI.DDF.EscherProperty.Id">
  1373. <summary>
  1374. Gets the id.
  1375. </summary>
  1376. <value>The id.</value>
  1377. </member>
  1378. <member name="P:NPOI.DDF.EscherProperty.PropertyNumber">
  1379. <summary>
  1380. Gets the property number.
  1381. </summary>
  1382. <value>The property number.</value>
  1383. </member>
  1384. <member name="P:NPOI.DDF.EscherProperty.IsComplex">
  1385. <summary>
  1386. Gets a value indicating whether this instance is complex.
  1387. </summary>
  1388. <value>
  1389. <c>true</c> if this instance is complex; otherwise, <c>false</c>.
  1390. </value>
  1391. </member>
  1392. <member name="P:NPOI.DDF.EscherProperty.IsBlipId">
  1393. <summary>
  1394. Gets a value indicating whether this instance is blip id.
  1395. </summary>
  1396. <value>
  1397. <c>true</c> if this instance is blip id; otherwise, <c>false</c>.
  1398. </value>
  1399. </member>
  1400. <member name="P:NPOI.DDF.EscherProperty.Name">
  1401. <summary>
  1402. Gets the name.
  1403. </summary>
  1404. <value>The name.</value>
  1405. </member>
  1406. <member name="P:NPOI.DDF.EscherProperty.PropertySize">
  1407. <summary>
  1408. Most properties are just 6 bytes in Length. Override this if we're
  1409. dealing with complex properties.
  1410. </summary>
  1411. <value>The size of the property.</value>
  1412. </member>
  1413. <member name="M:NPOI.DDF.EscherProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1414. <summary>
  1415. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1416. The fixed Length part is Serialized first.
  1417. </summary>
  1418. <param name="data">The data.</param>
  1419. <param name="pos">The pos.</param>
  1420. <returns></returns>
  1421. </member>
  1422. <member name="M:NPOI.DDF.EscherProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1423. <summary>
  1424. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1425. The fixed Length part is Serialized first.
  1426. </summary>
  1427. <param name="data">The data.</param>
  1428. <param name="pos">The pos.</param>
  1429. <returns></returns>
  1430. </member>
  1431. <member name="T:NPOI.DDF.EscherPropertyFactory">
  1432. <summary>
  1433. Generates a property given a reference into the byte array storing that property.
  1434. @author Glen Stampoultzis
  1435. </summary>
  1436. </member>
  1437. <member name="M:NPOI.DDF.EscherPropertyFactory.CreateProperties(System.Byte[],System.Int32,System.Int16)">
  1438. <summary>
  1439. Create new properties from a byte array.
  1440. </summary>
  1441. <param name="data">The byte array containing the property</param>
  1442. <param name="offset">The starting offset into the byte array</param>
  1443. <param name="numProperties">The new properties</param>
  1444. <returns></returns>
  1445. </member>
  1446. <member name="T:NPOI.DDF.EscherPropertyMetaData">
  1447. <summary>
  1448. This class stores the type and description of an escher property.
  1449. @author Glen Stampoultzis (glens at apache.org)
  1450. </summary>
  1451. </member>
  1452. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String)">
  1453. <summary>
  1454. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1455. </summary>
  1456. <param name="description">The description of the escher property.</param>
  1457. </member>
  1458. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String,System.Byte)">
  1459. <summary>
  1460. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1461. </summary>
  1462. <param name="description">The description of the escher property.</param>
  1463. <param name="type">The type of the property.</param>
  1464. </member>
  1465. <member name="P:NPOI.DDF.EscherPropertyMetaData.Description">
  1466. <summary>
  1467. Gets the description.
  1468. </summary>
  1469. <value>The description.</value>
  1470. </member>
  1471. <member name="P:NPOI.DDF.EscherPropertyMetaData.Type">
  1472. <summary>
  1473. Gets the type.
  1474. </summary>
  1475. <value>The type.</value>
  1476. </member>
  1477. <member name="T:NPOI.DDF.EscherRecord">
  1478. <summary>
  1479. The base abstract record from which all escher records are defined. Subclasses will need
  1480. to define methods for serialization/deserialization and for determining the record size.
  1481. </summary>
  1482. </member>
  1483. <member name="M:NPOI.DDF.EscherRecord.#ctor">
  1484. <summary>
  1485. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRecord"/> class.
  1486. </summary>
  1487. </member>
  1488. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],NPOI.DDF.IEscherRecordFactory)">
  1489. <summary>
  1490. Delegates to FillFields(byte[], int, EscherRecordFactory)
  1491. </summary>
  1492. <param name="data">the bytes to serialize from</param>
  1493. <param name="f">the escher record factory</param>
  1494. <returns>The number of bytes written.</returns>
  1495. </member>
  1496. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1497. <summary>
  1498. The contract of this method is to deSerialize an escher record including
  1499. it's children.
  1500. </summary>
  1501. <param name="data">The byte array containing the Serialized escher
  1502. records.</param>
  1503. <param name="offset">The offset into the byte array.</param>
  1504. <param name="recordFactory">A factory for creating new escher records.</param>
  1505. <returns>The number of bytes written.</returns>
  1506. </member>
  1507. <member name="M:NPOI.DDF.EscherRecord.ReadHeader(System.Byte[],System.Int32)">
  1508. <summary>
  1509. Reads the 8 byte header information and populates the
  1510. <c>options</c>
  1511. and
  1512. <c>recordId</c>
  1513. records.
  1514. </summary>
  1515. <param name="data">the byte array to Read from</param>
  1516. <param name="offset">the offset to start Reading from</param>
  1517. <returns>the number of bytes remaining in this record. This</returns>
  1518. </member>
  1519. <member name="M:NPOI.DDF.EscherRecord.ReadInstance(System.Byte[],System.Int32)">
  1520. <summary>
  1521. Read the options field from header and return instance part of it.
  1522. </summary>
  1523. <param name="data">the byte array to read from</param>
  1524. <param name="offset">the offset to start reading from</param>
  1525. <returns>value of instance part of options field</returns>
  1526. </member>
  1527. <member name="P:NPOI.DDF.EscherRecord.IsContainerRecord">
  1528. <summary>
  1529. Determine whether this is a container record by inspecting the option
  1530. field.
  1531. </summary>
  1532. <value>
  1533. <c>true</c> if this instance is container record; otherwise, <c>false</c>.
  1534. </value>
  1535. </member>
  1536. <member name="P:NPOI.DDF.EscherRecord.Options">
  1537. <summary>
  1538. Gets or sets the options field for this record. All records have one
  1539. </summary>
  1540. <value>The options.</value>
  1541. </member>
  1542. <member name="M:NPOI.DDF.EscherRecord.Serialize">
  1543. <summary>
  1544. Serializes to a new byte array. This is done by delegating to
  1545. Serialize(int, byte[]);
  1546. </summary>
  1547. <returns>the Serialized record.</returns>
  1548. </member>
  1549. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[])">
  1550. <summary>
  1551. Serializes to an existing byte array without serialization listener.
  1552. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  1553. </summary>
  1554. <param name="offset">the offset within the data byte array.</param>
  1555. <param name="data">the data array to Serialize to.</param>
  1556. <returns>The number of bytes written.</returns>
  1557. </member>
  1558. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1559. <summary>
  1560. Serializes the record to an existing byte array.
  1561. </summary>
  1562. <param name="offset">the offset within the byte array.</param>
  1563. <param name="data">the offset within the byte array</param>
  1564. <param name="listener">a listener for begin and end serialization events. This.
  1565. is useful because the serialization is
  1566. hierarchical/recursive and sometimes you need to be able
  1567. break into that.
  1568. </param>
  1569. <returns></returns>
  1570. </member>
  1571. <member name="P:NPOI.DDF.EscherRecord.RecordSize">
  1572. <summary>
  1573. Subclasses should effeciently return the number of bytes required to
  1574. Serialize the record.
  1575. </summary>
  1576. <value>number of bytes</value>
  1577. </member>
  1578. <member name="P:NPOI.DDF.EscherRecord.RecordId">
  1579. <summary>
  1580. Return the current record id.
  1581. </summary>
  1582. <value>The 16 bit record id.</value>
  1583. </member>
  1584. <member name="P:NPOI.DDF.EscherRecord.ChildRecords">
  1585. <summary>
  1586. Gets or sets the child records.
  1587. </summary>
  1588. <value>Returns the children of this record. By default this will
  1589. be an empty list. EscherCotainerRecord is the only record that may contain children.</value>
  1590. </member>
  1591. <member name="M:NPOI.DDF.EscherRecord.Clone">
  1592. <summary>
  1593. Creates a new object that is a copy of the current instance.
  1594. </summary>
  1595. <returns>
  1596. A new object that is a copy of this instance.
  1597. </returns>
  1598. </member>
  1599. <member name="M:NPOI.DDF.EscherRecord.GetChild(System.Int32)">
  1600. <summary>
  1601. Returns the indexed child record.
  1602. </summary>
  1603. <param name="index">The index.</param>
  1604. <returns></returns>
  1605. </member>
  1606. <member name="M:NPOI.DDF.EscherRecord.Display(System.Int32)">
  1607. <summary>
  1608. The display methods allows escher variables to print the record names
  1609. according to their hierarchy.
  1610. </summary>
  1611. <param name="indent">The current indent level.</param>
  1612. </member>
  1613. <member name="P:NPOI.DDF.EscherRecord.RecordName">
  1614. <summary>
  1615. Gets the name of the record.
  1616. </summary>
  1617. <value>The name of the record.</value>
  1618. </member>
  1619. <member name="T:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader">
  1620. <summary>
  1621. This class Reads the standard escher header.
  1622. </summary>
  1623. </member>
  1624. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ReadHeader(System.Byte[],System.Int32)">
  1625. <summary>
  1626. Reads the header.
  1627. </summary>
  1628. <param name="data">The data.</param>
  1629. <param name="offset">The off set.</param>
  1630. <returns></returns>
  1631. </member>
  1632. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.Options">
  1633. <summary>
  1634. Gets the options.
  1635. </summary>
  1636. <value>The options.</value>
  1637. </member>
  1638. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RecordId">
  1639. <summary>
  1640. Gets the record id.
  1641. </summary>
  1642. <value>The record id.</value>
  1643. </member>
  1644. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RemainingBytes">
  1645. <summary>
  1646. Gets the remaining bytes.
  1647. </summary>
  1648. <value>The remaining bytes.</value>
  1649. </member>
  1650. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ToString">
  1651. <summary>
  1652. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1653. </summary>
  1654. <returns>
  1655. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1656. </returns>
  1657. </member>
  1658. <member name="P:NPOI.DDF.EscherRecord.Instance">
  1659. <summary>
  1660. Get or set the instance part of the option record.
  1661. </summary>
  1662. </member>
  1663. <member name="P:NPOI.DDF.EscherRecord.Version">
  1664. <summary>
  1665. Get or set the version part of the option record.
  1666. </summary>
  1667. </member>
  1668. <member name="M:NPOI.DDF.EscherRecord.ToXml(System.String)">
  1669. @param tab - each children must be a right of his parent
  1670. @return xml representation of this record
  1671. </member>
  1672. <member name="T:NPOI.DDF.IEscherRecordFactory">
  1673. <summary>
  1674. The escher record factory interface allows for the creation of escher
  1675. records from a pointer into a data array.
  1676. @author Glen Stampoultzis (glens at apache.org)
  1677. </summary>
  1678. </member>
  1679. <member name="M:NPOI.DDF.IEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  1680. <summary>
  1681. Create a new escher record from the data provided. Does not attempt
  1682. to Fill the contents of the record however.
  1683. </summary>
  1684. <param name="data">The data.</param>
  1685. <param name="offset">The off set.</param>
  1686. <returns></returns>
  1687. </member>
  1688. <member name="T:NPOI.DDF.EscherRGBProperty">
  1689. <summary>
  1690. A color property.
  1691. @author Glen Stampoultzis (glens at apache.org)
  1692. </summary>
  1693. </member>
  1694. <member name="M:NPOI.DDF.EscherRGBProperty.#ctor(System.Int16,System.Int32)">
  1695. <summary>
  1696. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRGBProperty"/> class.
  1697. </summary>
  1698. <param name="propertyNumber">The property number.</param>
  1699. <param name="rgbColor">Color of the RGB.</param>
  1700. </member>
  1701. <member name="P:NPOI.DDF.EscherRGBProperty.RgbColor">
  1702. <summary>
  1703. Gets the color of the RGB.
  1704. </summary>
  1705. <value>The color of the RGB.</value>
  1706. </member>
  1707. <member name="P:NPOI.DDF.EscherRGBProperty.Red">
  1708. <summary>
  1709. Gets the red.
  1710. </summary>
  1711. <value>The red.</value>
  1712. </member>
  1713. <member name="P:NPOI.DDF.EscherRGBProperty.Green">
  1714. <summary>
  1715. Gets the green.
  1716. </summary>
  1717. <value>The green.</value>
  1718. </member>
  1719. <member name="P:NPOI.DDF.EscherRGBProperty.Blue">
  1720. <summary>
  1721. Gets the blue.
  1722. </summary>
  1723. <value>The blue.</value>
  1724. </member>
  1725. <member name="T:NPOI.DDF.EscherSerializationListener">
  1726. Interface for listening to escher serialization events.
  1727. @author Glen Stampoultzis (glens at apache.org)
  1728. </member>
  1729. <member name="M:NPOI.DDF.EscherSerializationListener.BeforeRecordSerialize(System.Int32,System.Int16,NPOI.DDF.EscherRecord)">
  1730. Fired before a given escher record is Serialized.
  1731. @param offset The position in the data array at which the record will be Serialized.
  1732. @param recordId The id of the record about to be Serialized.
  1733. </member>
  1734. <member name="M:NPOI.DDF.EscherSerializationListener.AfterRecordSerialize(System.Int32,System.Int16,System.Int32,NPOI.DDF.EscherRecord)">
  1735. Fired after a record has been Serialized.
  1736. @param offset The position of the end of the Serialized record + 1
  1737. @param recordId The id of the record about to be Serialized
  1738. @param size The number of bytes written for this record. If it is a container
  1739. record then this will include the size of any included records.
  1740. </member>
  1741. <member name="T:NPOI.DDF.EscherShapePathProperty">
  1742. <summary>
  1743. Defines the constants for the various possible shape paths.
  1744. @author Glen Stampoultzis (glens at apache.org)
  1745. </summary>
  1746. </member>
  1747. <member name="M:NPOI.DDF.EscherShapePathProperty.#ctor(System.Int16,System.Int32)">
  1748. <summary>
  1749. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherShapePathProperty"/> class.
  1750. </summary>
  1751. <param name="propertyNumber">The property number.</param>
  1752. <param name="shapePath">The shape path.</param>
  1753. </member>
  1754. <member name="T:NPOI.DDF.EscherSimpleProperty">
  1755. <summary>
  1756. A simple property is of fixed Length and as a property number in Addition
  1757. to a 32-bit value. Properties that can't be stored in only 32-bits are
  1758. stored as EscherComplexProperty objects.
  1759. @author Glen Stampoultzis (glens at apache.org)
  1760. </summary>
  1761. </member>
  1762. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Int32)">
  1763. <summary>
  1764. The id is distinct from the actual property number. The id includes the property number the blip id
  1765. flag and an indicator whether the property is complex or not.
  1766. </summary>
  1767. <param name="id">The id.</param>
  1768. <param name="propertyValue">The property value.</param>
  1769. </member>
  1770. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Boolean,System.Boolean,System.Int32)">
  1771. <summary>
  1772. Constructs a new escher property. The three parameters are combined to form a property
  1773. id.
  1774. </summary>
  1775. <param name="propertyNumber">The property number.</param>
  1776. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1777. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1778. <param name="propertyValue">The property value.</param>
  1779. </member>
  1780. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1781. <summary>
  1782. Serialize the simple part of the escher record.
  1783. </summary>
  1784. <param name="data">The data.</param>
  1785. <param name="offset">The off set.</param>
  1786. <returns>the number of bytes Serialized.</returns>
  1787. </member>
  1788. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1789. <summary>
  1790. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1791. The fixed Length part is Serialized first.
  1792. </summary>
  1793. <param name="data"></param>
  1794. <param name="pos"></param>
  1795. <returns></returns>
  1796. </member>
  1797. <member name="P:NPOI.DDF.EscherSimpleProperty.PropertyValue">
  1798. <summary>
  1799. Return the 32 bit value of this property.
  1800. </summary>
  1801. <value>The property value.</value>
  1802. </member>
  1803. <member name="M:NPOI.DDF.EscherSimpleProperty.Equals(System.Object)">
  1804. <summary>
  1805. Returns true if one escher property is equal to another.
  1806. </summary>
  1807. <param name="o">The o.</param>
  1808. <returns></returns>
  1809. </member>
  1810. <member name="M:NPOI.DDF.EscherSimpleProperty.GetHashCode">
  1811. <summary>
  1812. Serves as a hash function for a particular type.
  1813. </summary>
  1814. <returns>
  1815. A hash code for the current <see cref="T:System.Object"/>.
  1816. </returns>
  1817. </member>
  1818. <member name="M:NPOI.DDF.EscherSimpleProperty.ToString">
  1819. <summary>
  1820. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1821. </summary>
  1822. <returns>
  1823. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1824. </returns>
  1825. </member>
  1826. <member name="T:NPOI.DDF.EscherSpgrRecord">
  1827. <summary>
  1828. The spgr record defines information about a shape group. Groups in escher
  1829. are simply another form of shape that you can't physically see.
  1830. @author Glen Stampoultzis (glens at apache.org)
  1831. </summary>
  1832. </member>
  1833. <member name="M:NPOI.DDF.EscherSpgrRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1834. <summary>
  1835. This method deSerializes the record from a byte array.
  1836. </summary>
  1837. <param name="data">The byte array containing the escher record information</param>
  1838. <param name="offset">The starting offset into data</param>
  1839. <param name="recordFactory">May be null since this is not a container record.</param>
  1840. <returns>The number of bytes Read from the byte array.</returns>
  1841. </member>
  1842. <member name="M:NPOI.DDF.EscherSpgrRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1843. <summary>
  1844. This method Serializes this escher record into a byte array
  1845. </summary>
  1846. <param name="offset">The offset into data
  1847. to start writing the record data to.</param>
  1848. <param name="data">The byte array to Serialize to.</param>
  1849. <param name="listener">a listener for begin and end serialization events.</param>
  1850. <returns>The number of bytes written.</returns>
  1851. </member>
  1852. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordSize">
  1853. <summary>
  1854. Returns the number of bytes that are required to Serialize this record.
  1855. </summary>
  1856. <value>Number of bytes</value>
  1857. </member>
  1858. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordId">
  1859. <summary>
  1860. Return the current record id.
  1861. </summary>
  1862. <value>The 16 bit identifier of this shape group record.</value>
  1863. </member>
  1864. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordName">
  1865. <summary>
  1866. The short name for this record
  1867. </summary>
  1868. <value></value>
  1869. </member>
  1870. <member name="M:NPOI.DDF.EscherSpgrRecord.ToString">
  1871. <summary>
  1872. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1873. </summary>
  1874. <returns>
  1875. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1876. </returns>
  1877. </member>
  1878. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX1">
  1879. <summary>
  1880. Gets or sets the starting top-left coordinate of child records.
  1881. </summary>
  1882. <value>The rect x1.</value>
  1883. </member>
  1884. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX2">
  1885. <summary>
  1886. Gets or sets the starting bottom-right coordinate of child records.
  1887. </summary>
  1888. <value>The rect x2.</value>
  1889. </member>
  1890. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY1">
  1891. <summary>
  1892. Gets or sets the starting top-left coordinate of child records.
  1893. </summary>
  1894. <value>The rect y1.</value>
  1895. </member>
  1896. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY2">
  1897. <summary>
  1898. Gets or sets the starting bottom-right coordinate of child records.
  1899. </summary>
  1900. <value>The rect y2.</value>
  1901. </member>
  1902. <member name="T:NPOI.DDF.EscherSplitMenuColorsRecord">
  1903. <summary>
  1904. A list of the most recently used colours for the drawings contained in
  1905. this document.
  1906. @author Glen Stampoultzis (glens at apache.org)
  1907. </summary>
  1908. </member>
  1909. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1910. <summary>
  1911. This method deSerializes the record from a byte array.
  1912. </summary>
  1913. <param name="data">The byte array containing the escher record information</param>
  1914. <param name="offset">The starting offset into data</param>
  1915. <param name="recordFactory">May be null since this is not a container record.</param>
  1916. <returns>The number of bytes Read from the byte array.</returns>
  1917. </member>
  1918. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1919. <summary>
  1920. This method Serializes this escher record into a byte array
  1921. </summary>
  1922. <param name="offset">The offset into data
  1923. to start writing the record data to.</param>
  1924. <param name="data">The byte array to Serialize to.</param>
  1925. <param name="listener">a listener for begin and end serialization events.</param>
  1926. <returns>The number of bytes written.</returns>
  1927. </member>
  1928. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordSize">
  1929. <summary>
  1930. Returns the number of bytes that are required to Serialize this record.
  1931. </summary>
  1932. <value>number of bytes</value>
  1933. </member>
  1934. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordId">
  1935. <summary>
  1936. Return the current record id.
  1937. </summary>
  1938. <value>the 16 bit identifer for this record.</value>
  1939. </member>
  1940. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordName">
  1941. <summary>
  1942. Gets the short name for this record
  1943. </summary>
  1944. <value>The name of the record.</value>
  1945. </member>
  1946. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.ToString">
  1947. <summary>
  1948. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1949. </summary>
  1950. <returns>
  1951. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1952. </returns>
  1953. @return a string representation of this record.
  1954. </member>
  1955. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color1">
  1956. <summary>
  1957. Gets or sets the color1.
  1958. </summary>
  1959. <value>The color1.</value>
  1960. </member>
  1961. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color2">
  1962. <summary>
  1963. Gets or sets the color2.
  1964. </summary>
  1965. <value>The color2.</value>
  1966. </member>
  1967. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color3">
  1968. <summary>
  1969. Gets or sets the color3.
  1970. </summary>
  1971. <value>The color3.</value>
  1972. </member>
  1973. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color4">
  1974. <summary>
  1975. Gets or sets the color4.
  1976. </summary>
  1977. <value>The color4.</value>
  1978. </member>
  1979. <member name="T:NPOI.DDF.EscherSpRecord">
  1980. <summary>
  1981. ToGether the the EscherOptRecord this record defines some of the basic
  1982. properties of a shape.
  1983. @author Glen Stampoultzis (glens at apache.org)
  1984. </summary>
  1985. </member>
  1986. <member name="M:NPOI.DDF.EscherSpRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1987. <summary>
  1988. The contract of this method is to deSerialize an escher record including
  1989. it's children.
  1990. </summary>
  1991. <param name="data">The byte array containing the Serialized escher
  1992. records.</param>
  1993. <param name="offset">The offset into the byte array.</param>
  1994. <param name="recordFactory">A factory for creating new escher records</param>
  1995. <returns>The number of bytes written.</returns>
  1996. </member>
  1997. <member name="M:NPOI.DDF.EscherSpRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1998. <summary>
  1999. Serializes to an existing byte array without serialization listener.
  2000. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  2001. </summary>
  2002. <param name="offset">the offset within the data byte array.</param>
  2003. <param name="data"> the data array to Serialize to.</param>
  2004. <param name="listener">a listener for begin and end serialization events.</param>
  2005. <returns>The number of bytes written.</returns>
  2006. </member>
  2007. <member name="P:NPOI.DDF.EscherSpRecord.RecordSize">
  2008. <summary>
  2009. Returns the number of bytes that are required to Serialize this record.
  2010. </summary>
  2011. <value>Number of bytes</value>
  2012. </member>
  2013. <member name="P:NPOI.DDF.EscherSpRecord.RecordId">
  2014. <summary>
  2015. @return the 16 bit identifier for this record.
  2016. </summary>
  2017. <value></value>
  2018. </member>
  2019. <member name="P:NPOI.DDF.EscherSpRecord.RecordName">
  2020. <summary>
  2021. The short name for this record
  2022. </summary>
  2023. <value></value>
  2024. </member>
  2025. <member name="M:NPOI.DDF.EscherSpRecord.ToString">
  2026. <summary>
  2027. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2028. </summary>
  2029. <returns>
  2030. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2031. </returns>
  2032. </member>
  2033. <member name="M:NPOI.DDF.EscherSpRecord.DecodeFlags(System.Int32)">
  2034. <summary>
  2035. Converts the shape flags into a more descriptive name.
  2036. </summary>
  2037. <param name="flags">The flags.</param>
  2038. <returns></returns>
  2039. </member>
  2040. <member name="P:NPOI.DDF.EscherSpRecord.ShapeId">
  2041. <summary>
  2042. Gets or sets A number that identifies this shape
  2043. </summary>
  2044. <value>The shape id.</value>
  2045. </member>
  2046. <member name="P:NPOI.DDF.EscherSpRecord.Flags">
  2047. <summary>
  2048. The flags that apply to this shape.
  2049. </summary>
  2050. <value>The flags.</value>
  2051. </member>
  2052. <member name="P:NPOI.DDF.EscherSpRecord.ShapeType">
  2053. <summary>
  2054. Get or set shape type. Must be one of MSOSPT values (see [MS-ODRAW] for details).
  2055. </summary>
  2056. </member>
  2057. <member name="T:NPOI.DDF.EscherTextboxRecord">
  2058. <summary>
  2059. Holds data from the parent application. Most commonly used to store
  2060. text in the format of the parent application, rather than in
  2061. Escher format. We don't attempt to understand the contents, since
  2062. they will be in the parent's format, not Escher format.
  2063. @author Glen Stampoultzis (glens at apache.org)
  2064. @author Nick Burch (nick at torchbox dot com)
  2065. </summary>
  2066. </member>
  2067. <member name="F:NPOI.DDF.EscherTextboxRecord._thedata">
  2068. The data for this record not including the the 8 byte header
  2069. </member>
  2070. <member name="M:NPOI.DDF.EscherTextboxRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2071. This method deserializes the record from a byte array.
  2072. @param data The byte array containing the escher record information
  2073. @param offset The starting offset into <c>data</c>.
  2074. @param recordFactory May be null since this is not a container record.
  2075. @return The number of bytes Read from the byte array.
  2076. </member>
  2077. <member name="M:NPOI.DDF.EscherTextboxRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2078. <summary>
  2079. Writes this record and any contained records to the supplied byte
  2080. </summary>
  2081. <param name="offset"></param>
  2082. <param name="data"></param>
  2083. <param name="listener">a listener for begin and end serialization events.</param>
  2084. <returns>the number of bytes written.</returns>
  2085. </member>
  2086. <member name="P:NPOI.DDF.EscherTextboxRecord.Data">
  2087. <summary>
  2088. Returns any extra data associated with this record. In practice excel
  2089. does not seem to put anything here, but with PowerPoint this will
  2090. contain the bytes that make up a TextHeaderAtom followed by a
  2091. TextBytesAtom/TextCharsAtom
  2092. </summary>
  2093. <value>The data.</value>
  2094. </member>
  2095. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[],System.Int32,System.Int32)">
  2096. <summary>
  2097. Sets the extra data (in the parent application's format) to be
  2098. contained by the record. Used when the parent application changes
  2099. the contents.
  2100. </summary>
  2101. <param name="b">The b.</param>
  2102. <param name="start">The start.</param>
  2103. <param name="length">The length.</param>
  2104. </member>
  2105. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[])">
  2106. <summary>
  2107. Sets the data.
  2108. </summary>
  2109. <param name="b">The b.</param>
  2110. </member>
  2111. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordSize">
  2112. <summary>
  2113. Returns the number of bytes that are required to serialize this record.
  2114. </summary>
  2115. <value>Number of bytes</value>
  2116. </member>
  2117. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordName">
  2118. <summary>
  2119. The short name for this record
  2120. </summary>
  2121. <value></value>
  2122. </member>
  2123. <member name="M:NPOI.DDF.EscherTextboxRecord.ToString">
  2124. <summary>
  2125. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2126. </summary>
  2127. <returns>
  2128. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2129. </returns>
  2130. </member>
  2131. <member name="T:NPOI.DDF.UnknownEscherRecord">
  2132. <summary>
  2133. This record is used whenever a escher record is encountered that
  2134. we do not explicitly support.
  2135. @author Glen Stampoultzis (glens at apache.org)
  2136. </summary>
  2137. </member>
  2138. <member name="F:NPOI.DDF.UnknownEscherRecord._thedata">
  2139. The data for this record not including the the 8 byte header
  2140. </member>
  2141. <member name="M:NPOI.DDF.UnknownEscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2142. <summary>
  2143. This method deSerializes the record from a byte array.
  2144. </summary>
  2145. <param name="data"> The byte array containing the escher record information</param>
  2146. <param name="offset">The starting offset into data </param>
  2147. <param name="recordFactory">May be null since this is not a container record.</param>
  2148. <returns>The number of bytes Read from the byte array.</returns>
  2149. </member>
  2150. <member name="M:NPOI.DDF.UnknownEscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2151. <summary>
  2152. Writes this record and any contained records to the supplied byte
  2153. array.
  2154. </summary>
  2155. <param name="offset"></param>
  2156. <param name="data"></param>
  2157. <param name="listener">a listener for begin and end serialization events.</param>
  2158. <returns>the number of bytes written.</returns>
  2159. </member>
  2160. <member name="P:NPOI.DDF.UnknownEscherRecord.Data">
  2161. <summary>
  2162. Gets the data.
  2163. </summary>
  2164. <value>The data.</value>
  2165. </member>
  2166. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordSize">
  2167. <summary>
  2168. Returns the number of bytes that are required to Serialize this record.
  2169. </summary>
  2170. <value>Number of bytes</value>
  2171. </member>
  2172. <member name="P:NPOI.DDF.UnknownEscherRecord.ChildRecords">
  2173. <summary>
  2174. Returns the children of this record. By default this will
  2175. be an empty list. EscherCotainerRecord is the only record
  2176. that may contain children.
  2177. </summary>
  2178. <value></value>
  2179. </member>
  2180. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordName">
  2181. <summary>
  2182. The short name for this record
  2183. </summary>
  2184. <value></value>
  2185. </member>
  2186. <member name="M:NPOI.DDF.UnknownEscherRecord.ToString">
  2187. <summary>
  2188. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2189. </summary>
  2190. <returns>
  2191. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2192. </returns>
  2193. </member>
  2194. <member name="M:NPOI.DDF.UnknownEscherRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  2195. <summary>
  2196. Adds the child record.
  2197. </summary>
  2198. <param name="childRecord">The child record.</param>
  2199. </member>
  2200. <member name="T:NPOI.HPSF.HPSFPropertiesOnlyDocument">
  2201. A version of {@link POIDocument} which allows access to the
  2202. HPSF Properties, but no other document contents.
  2203. Normally used when you want to read or alter the Document Properties,
  2204. without affecting the rest of the file
  2205. </member>
  2206. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write">
  2207. Write out to the currently open file the properties changes, but nothing else
  2208. </member>
  2209. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write(System.IO.FileInfo)">
  2210. Write out, with any properties changes, but nothing else
  2211. </member>
  2212. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write(System.IO.Stream)">
  2213. Write out, with any properties changes, but nothing else
  2214. </member>
  2215. <member name="M:NPOI.HPSF.UnicodeString.validLength(System.Int32,System.Byte[],System.Int32)">
  2216. Checks to see if the specified length seems valid,
  2217. given the amount of data available still to read,
  2218. and the requirement that the string be NULL-terminated
  2219. </member>
  2220. <member name="T:NPOI.HPSF.UnsupportedEncodingException">
  2221. The Character Encoding is not supported.
  2222. @author Asmus Freytag
  2223. @since JDK1.1
  2224. </member>
  2225. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor">
  2226. Constructs an UnsupportedEncodingException without a detail message.
  2227. </member>
  2228. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor(System.String)">
  2229. Constructs an UnsupportedEncodingException with a detail message.
  2230. @param s Describes the reason for the exception.
  2231. </member>
  2232. <member name="T:NPOI.HPSF.CustomProperties">
  2233. <summary>
  2234. Maintains the instances of {@link CustomProperty} that belong To a
  2235. {@link DocumentSummaryInformation}. The class maintains the names of the
  2236. custom properties in a dictionary. It implements the {@link Map} interface
  2237. and by this provides a simplified view on custom properties: A property's
  2238. name is the key that maps To a typed value. This implementation hides
  2239. property IDs from the developer and regards the property names as keys To
  2240. typed values.
  2241. While this class provides a simple API To custom properties, it ignores
  2242. the fact that not names, but IDs are the real keys To properties. Under the
  2243. hood this class maintains a 1:1 relationship between IDs and names. Therefore
  2244. you should not use this class To process property Sets with several IDs
  2245. mapping To the same name or with properties without a name: the result will
  2246. contain only a subSet of the original properties. If you really need To deal
  2247. such property Sets, use HPSF's low-level access methods.
  2248. An application can call the {@link #isPure} method To check whether a
  2249. property Set parsed by {@link CustomProperties} is still pure (i.e.
  2250. unmodified) or whether one or more properties have been dropped.
  2251. This class is not thRead-safe; concurrent access To instances of this
  2252. class must be syncronized.
  2253. @author Rainer Klute
  2254. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2255. @since 2006-02-09
  2256. </summary>
  2257. </member>
  2258. <member name="F:NPOI.HPSF.CustomProperties.dictionaryIDToName">
  2259. Maps property IDs To property names.
  2260. </member>
  2261. <member name="F:NPOI.HPSF.CustomProperties.dictionaryNameToID">
  2262. Maps property names To property IDs.
  2263. </member>
  2264. <member name="F:NPOI.HPSF.CustomProperties.isPure">
  2265. Tells whether this object is pure or not.
  2266. </member>
  2267. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,NPOI.HPSF.CustomProperty)">
  2268. <summary>
  2269. Puts a {@link CustomProperty} into this map. It is assumed that the
  2270. {@link CustomProperty} alReady has a valid ID. Otherwise use
  2271. {@link #Put(CustomProperty)}.
  2272. </summary>
  2273. <param name="name">The name.</param>
  2274. <param name="cp">The custom property.</param>
  2275. <returns></returns>
  2276. </member>
  2277. <member name="M:NPOI.HPSF.CustomProperties.KeySet">
  2278. Returns a set of all the names of our
  2279. custom properties. Equivalent to
  2280. {@link #nameSet()}
  2281. </member>
  2282. <member name="M:NPOI.HPSF.CustomProperties.NameSet">
  2283. Returns a set of all the names of our
  2284. custom properties
  2285. </member>
  2286. <member name="M:NPOI.HPSF.CustomProperties.IdSet">
  2287. Returns a set of all the IDs of our
  2288. custom properties
  2289. </member>
  2290. <member name="M:NPOI.HPSF.CustomProperties.Put(NPOI.HPSF.CustomProperty)">
  2291. <summary>
  2292. Puts a {@link CustomProperty} that has not yet a valid ID into this
  2293. map. The method will allocate a suitable ID for the custom property:
  2294. <ul>
  2295. <li>If there is alReady a property with the same name, take the ID
  2296. of that property.</li>
  2297. <li>Otherwise Find the highest ID and use its value plus one.</li>
  2298. </ul>
  2299. </summary>
  2300. <param name="customProperty">The custom property.</param>
  2301. <returns>If the was alReady a property with the same name, the</returns>
  2302. </member>
  2303. <member name="M:NPOI.HPSF.CustomProperties.Remove(System.String)">
  2304. <summary>
  2305. Removes a custom property.
  2306. </summary>
  2307. <param name="name">The name of the custom property To Remove</param>
  2308. <returns>The Removed property or
  2309. <c>null</c>
  2310. if the specified property was not found.</returns>
  2311. </member>
  2312. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.String)">
  2313. <summary>
  2314. Adds a named string property.
  2315. </summary>
  2316. <param name="name">The property's name.</param>
  2317. <param name="value">The property's value.</param>
  2318. <returns>the property that was stored under the specified name before, or
  2319. <c>null</c>
  2320. if there was no such property before.</returns>
  2321. </member>
  2322. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int64)">
  2323. <summary>
  2324. Adds a named long property
  2325. </summary>
  2326. <param name="name">The property's name.</param>
  2327. <param name="value">The property's value.</param>
  2328. <returns>the property that was stored under the specified name before, or
  2329. <c>null</c>
  2330. if there was no such property before.</returns>
  2331. </member>
  2332. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Double)">
  2333. <summary>
  2334. Adds a named double property.
  2335. </summary>
  2336. <param name="name">The property's name.</param>
  2337. <param name="value">The property's value.</param>
  2338. <returns>the property that was stored under the specified name before, or
  2339. <c>null</c>
  2340. if there was no such property before.</returns>
  2341. </member>
  2342. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int32)">
  2343. <summary>
  2344. Adds a named integer property.
  2345. </summary>
  2346. <param name="name">The property's name.</param>
  2347. <param name="value">The property's value.</param>
  2348. <returns>the property that was stored under the specified name before, or
  2349. <c>null</c>
  2350. if there was no such property before.</returns>
  2351. </member>
  2352. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Boolean)">
  2353. <summary>
  2354. Adds a named bool property.
  2355. </summary>
  2356. <param name="name">The property's name.</param>
  2357. <param name="value">The property's value.</param>
  2358. <returns>the property that was stored under the specified name before, or
  2359. <c>null</c>
  2360. if there was no such property before.</returns>
  2361. </member>
  2362. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.DateTime)">
  2363. <summary>
  2364. Adds a named date property.
  2365. </summary>
  2366. <param name="name">The property's name.</param>
  2367. <param name="value">The property's value.</param>
  2368. <returns>the property that was stored under the specified name before, or
  2369. <c>null</c>
  2370. if there was no such property before.</returns>
  2371. </member>
  2372. <member name="P:NPOI.HPSF.CustomProperties.Item(System.String)">
  2373. <summary>
  2374. Gets the <see cref="T:System.Object"/> with the specified name.
  2375. </summary>
  2376. <value>the value or
  2377. <c>null</c>
  2378. if a value with the specified
  2379. name is not found in the custom properties.</value>
  2380. </member>
  2381. <member name="M:NPOI.HPSF.CustomProperties.ContainsKey(System.Object)">
  2382. Checks against both String Name and Long ID
  2383. </member>
  2384. <member name="M:NPOI.HPSF.CustomProperties.ContainsValue(System.Object)">
  2385. Checks against both the property, and its values.
  2386. </member>
  2387. <member name="P:NPOI.HPSF.CustomProperties.Dictionary">
  2388. <summary>
  2389. Gets the dictionary which Contains IDs and names of the named custom
  2390. properties.
  2391. </summary>
  2392. <value>The dictionary.</value>
  2393. </member>
  2394. <member name="P:NPOI.HPSF.CustomProperties.Codepage">
  2395. <summary>
  2396. Gets or sets the codepage.
  2397. </summary>
  2398. <value>The codepage.</value>
  2399. </member>
  2400. <member name="P:NPOI.HPSF.CustomProperties.IsPure">
  2401. <summary>
  2402. Tells whether this {@link CustomProperties} instance is pure or one or
  2403. more properties of the underlying low-level property Set has been
  2404. dropped.
  2405. </summary>
  2406. <value><c>true</c> if this instance is pure; otherwise, <c>false</c>.</value>
  2407. </member>
  2408. <member name="T:NPOI.HPSF.CustomProperty">
  2409. <summary>
  2410. This class represents custum properties in the document summary
  2411. information stream. The difference To normal properties is that custom
  2412. properties have an optional name. If the name is not <c>null</c> it
  2413. will be maintained in the section's dictionary.
  2414. @author Rainer Klute
  2415. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2416. @since 2006-02-09
  2417. </summary>
  2418. </member>
  2419. <member name="M:NPOI.HPSF.CustomProperty.#ctor">
  2420. <summary>
  2421. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2422. </summary>
  2423. </member>
  2424. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property)">
  2425. <summary>
  2426. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2427. </summary>
  2428. <param name="property">the property To copy</param>
  2429. </member>
  2430. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property,System.String)">
  2431. <summary>
  2432. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2433. </summary>
  2434. <param name="property">This property's attributes are copied To the new custom
  2435. property.</param>
  2436. <param name="name">The new custom property's name.</param>
  2437. </member>
  2438. <member name="P:NPOI.HPSF.CustomProperty.Name">
  2439. <summary>
  2440. Gets or sets the property's name.
  2441. </summary>
  2442. <value>the property's name.</value>
  2443. </member>
  2444. <member name="M:NPOI.HPSF.CustomProperty.EqualsContents(System.Object)">
  2445. <summary>
  2446. Compares two custom properties for equality. The method returns
  2447. <c>true</c> if all attributes of the two custom properties are
  2448. equal.
  2449. </summary>
  2450. <param name="o">The custom property To Compare with.</param>
  2451. <returns><c>true</c>
  2452. if both custom properties are equal, else
  2453. <c>false</c></returns>
  2454. </member>
  2455. <member name="M:NPOI.HPSF.CustomProperty.GetHashCode">
  2456. <summary>
  2457. </summary>
  2458. <returns></returns>
  2459. @see Object#GetHashCode()
  2460. </member>
  2461. <member name="T:NPOI.HPSF.DocumentSummaryInformation">
  2462. <summary>
  2463. Convenience class representing a DocumentSummary Information stream in a
  2464. Microsoft Office document.
  2465. @author Rainer Klute
  2466. klute@rainer-klute.de
  2467. @author Drew Varner (Drew.Varner cloSeto sc.edu)
  2468. @author robert_flaherty@hyperion.com
  2469. @since 2002-02-09
  2470. </summary>
  2471. </member>
  2472. <member name="F:NPOI.HPSF.DocumentSummaryInformation.DEFAULT_STREAM_NAME">
  2473. The document name a document summary information stream
  2474. usually has in a POIFS filesystem.
  2475. </member>
  2476. <member name="M:NPOI.HPSF.DocumentSummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  2477. <summary>
  2478. Initializes a new instance of the <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> class.
  2479. </summary>
  2480. <param name="ps">A property Set which should be Created from a
  2481. document summary information stream.</param>
  2482. </member>
  2483. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Category">
  2484. <summary>
  2485. Gets or sets the category.
  2486. </summary>
  2487. <value>The category value</value>
  2488. </member>
  2489. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCategory">
  2490. <summary>
  2491. Removes the category.
  2492. </summary>
  2493. </member>
  2494. <member name="P:NPOI.HPSF.DocumentSummaryInformation.PresentationFormat">
  2495. <summary>
  2496. Gets or sets the presentation format (or null).
  2497. </summary>
  2498. <value>The presentation format value</value>
  2499. </member>
  2500. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemovePresentationFormat">
  2501. <summary>
  2502. Removes the presentation format.
  2503. </summary>
  2504. </member>
  2505. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ByteCount">
  2506. <summary>
  2507. Gets or sets the byte count or 0 if the {@link
  2508. DocumentSummaryInformation} does not contain a byte count.
  2509. </summary>
  2510. <value>The byteCount value</value>
  2511. </member>
  2512. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveByteCount">
  2513. <summary>
  2514. Removes the byte count.
  2515. </summary>
  2516. </member>
  2517. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LineCount">
  2518. <summary>
  2519. Gets or sets the line count or 0 if the {@link
  2520. DocumentSummaryInformation} does not contain a line count.
  2521. </summary>
  2522. <value>The line count value.</value>
  2523. </member>
  2524. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLineCount">
  2525. <summary>
  2526. Removes the line count.
  2527. </summary>
  2528. </member>
  2529. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ParCount">
  2530. <summary>
  2531. Gets or sets the par count or 0 if the {@link
  2532. DocumentSummaryInformation} does not contain a par count.
  2533. </summary>
  2534. <value>The par count value</value>
  2535. </member>
  2536. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveParCount">
  2537. <summary>
  2538. Removes the par count.
  2539. </summary>
  2540. </member>
  2541. <member name="P:NPOI.HPSF.DocumentSummaryInformation.SlideCount">
  2542. <summary>
  2543. Gets or sets the slide count or 0 if the {@link
  2544. DocumentSummaryInformation} does not contain a slide count.
  2545. </summary>
  2546. <value>The slide count value</value>
  2547. </member>
  2548. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveSlideCount">
  2549. <summary>
  2550. Removes the slide count.
  2551. </summary>
  2552. </member>
  2553. <member name="P:NPOI.HPSF.DocumentSummaryInformation.NoteCount">
  2554. <summary>
  2555. Gets or sets the note count or 0 if the {@link
  2556. DocumentSummaryInformation} does not contain a note count
  2557. </summary>
  2558. <value>The note count value</value>
  2559. </member>
  2560. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveNoteCount">
  2561. <summary>
  2562. Removes the note count.
  2563. </summary>
  2564. </member>
  2565. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HiddenCount">
  2566. <summary>
  2567. Gets or sets the hidden count or 0 if the {@link
  2568. DocumentSummaryInformation} does not contain a hidden
  2569. count.
  2570. </summary>
  2571. <value>The hidden count value.</value>
  2572. </member>
  2573. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHiddenCount">
  2574. <summary>
  2575. Removes the hidden count.
  2576. </summary>
  2577. </member>
  2578. <member name="P:NPOI.HPSF.DocumentSummaryInformation.MMClipCount">
  2579. <summary>
  2580. Returns the mmclip count or 0 if the {@link
  2581. DocumentSummaryInformation} does not contain a mmclip
  2582. count.
  2583. </summary>
  2584. <value>The mmclip count value.</value>
  2585. </member>
  2586. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveMMClipCount">
  2587. <summary>
  2588. Removes the MMClip count.
  2589. </summary>
  2590. </member>
  2591. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Scale">
  2592. <summary>
  2593. Gets or sets a value indicating whether this <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> is scale.
  2594. </summary>
  2595. <value><c>true</c> if cropping is desired; otherwise, <c>false</c>.</value>
  2596. </member>
  2597. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveScale">
  2598. <summary>
  2599. Removes the scale.
  2600. </summary>
  2601. </member>
  2602. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HeadingPair">
  2603. <summary>
  2604. Gets or sets the heading pair (or null)
  2605. </summary>
  2606. <value>The heading pair value.</value>
  2607. </member>
  2608. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHeadingPair">
  2609. <summary>
  2610. Removes the heading pair.
  2611. </summary>
  2612. </member>
  2613. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Docparts">
  2614. <summary>
  2615. Gets or sets the doc parts.
  2616. </summary>
  2617. <value>The doc parts value</value>
  2618. </member>
  2619. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocparts">
  2620. <summary>
  2621. Removes the doc parts.
  2622. </summary>
  2623. </member>
  2624. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Manager">
  2625. <summary>
  2626. Gets or sets the manager (or <c>null</c>).
  2627. </summary>
  2628. <value>The manager value</value>
  2629. </member>
  2630. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveManager">
  2631. <summary>
  2632. Removes the manager.
  2633. </summary>
  2634. </member>
  2635. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Company">
  2636. <summary>
  2637. Gets or sets the company (or <c>null</c>).
  2638. </summary>
  2639. <value>The company value</value>
  2640. </member>
  2641. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCompany">
  2642. <summary>
  2643. Removes the company.
  2644. </summary>
  2645. </member>
  2646. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LinksDirty">
  2647. <summary>
  2648. Gets or sets a value indicating whether [links dirty].
  2649. </summary>
  2650. <value><c>true</c> if the custom links are dirty.; otherwise, <c>false</c>.</value>
  2651. </member>
  2652. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLinksDirty">
  2653. <summary>
  2654. Removes the links dirty.
  2655. </summary>
  2656. </member>
  2657. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CharCountWithSpaces">
  2658. <p>Returns the character count including whitespace, or 0 if the
  2659. {@link DocumentSummaryInformation} does not contain this char count.</p>
  2660. This is the whitespace-including version of {@link SummaryInformation#getCharCount()}
  2661. @return The character count or <code>null</code>
  2662. </member>
  2663. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCharCountWithSpaces">
  2664. Removes the character count
  2665. </member>
  2666. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HyperlinksChanged">
  2667. <p>Get if the User Defined Property Set has been updated outside of the
  2668. Application.</p>
  2669. <p>If it has (true), the hyperlinks should be updated on document load.</p>
  2670. </member>
  2671. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHyperlinksChanged">
  2672. Removes the flag for if the User Defined Property Set has been updated
  2673. outside of the Application.
  2674. </member>
  2675. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ApplicationVersion">
  2676. <p>Gets the version of the Application which wrote the
  2677. Property set, stored with the two high order bytes having the major
  2678. version number, and the two low order bytes the minor version number.</p>
  2679. <p>This will be 0 if no version is set.</p>
  2680. </member>
  2681. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveApplicationVersion">
  2682. Removes the Application Version
  2683. </member>
  2684. <member name="P:NPOI.HPSF.DocumentSummaryInformation.VBADigitalSignature">
  2685. <p>Returns the VBA digital signature for the VBA project
  2686. embedded in the document (or <code>null</code>).</p>
  2687. </member>
  2688. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveVBADigitalSignature">
  2689. Removes the VBA Digital Signature
  2690. </member>
  2691. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ContentType">
  2692. <p>Gets the content type of the file (or <code>null</code>).</p>
  2693. </member>
  2694. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveContentType">
  2695. Removes the content type of the file
  2696. </member>
  2697. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ContentStatus">
  2698. <p>Gets the content status of the file (or <code>null</code>).</p>
  2699. </member>
  2700. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveContentStatus">
  2701. Removes the content status of the file
  2702. </member>
  2703. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Language">
  2704. <p>Gets the document language, which is normally unset and empty
  2705. (or <code>null</code>).</p>
  2706. </member>
  2707. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLanguage">
  2708. Removes the document language
  2709. </member>
  2710. <member name="P:NPOI.HPSF.DocumentSummaryInformation.DocumentVersion">
  2711. <p>Gets the document version as a string, which is normally unset and empty
  2712. (or <code>null</code>).</p>
  2713. </member>
  2714. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocumentVersion">
  2715. Removes the document version string
  2716. </member>
  2717. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CustomProperties">
  2718. <summary>
  2719. Gets or sets the custom properties.
  2720. </summary>
  2721. <value>The custom properties.</value>
  2722. </member>
  2723. <member name="M:NPOI.HPSF.DocumentSummaryInformation.EnsureSection2">
  2724. <summary>
  2725. Creates section 2 if it is not alReady present.
  2726. </summary>
  2727. </member>
  2728. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCustomProperties">
  2729. <summary>
  2730. Removes the custom properties.
  2731. </summary>
  2732. </member>
  2733. <member name="T:NPOI.HPSF.Extractor.HPSFPropertiesExtractor">
  2734. <summary>
  2735. Extracts all of the HPSF properties, both
  2736. build in and custom, returning them in
  2737. textual form.
  2738. </summary>
  2739. </member>
  2740. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.DocumentSummaryInformationText">
  2741. <summary>
  2742. Gets the document summary information text.
  2743. </summary>
  2744. <value>The document summary information text.</value>
  2745. </member>
  2746. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.SummaryInformationText">
  2747. <summary>
  2748. Gets the summary information text.
  2749. </summary>
  2750. <value>The summary information text.</value>
  2751. </member>
  2752. <member name="M:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.GetPropertiesText(NPOI.HPSF.SpecialPropertySet)">
  2753. <summary>
  2754. Gets the properties text.
  2755. </summary>
  2756. <param name="ps">The ps.</param>
  2757. <returns></returns>
  2758. </member>
  2759. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.Text">
  2760. <summary>
  2761. Return the text of all the properties defined in
  2762. the document.
  2763. </summary>
  2764. <value>All the text from the document.</value>
  2765. </member>
  2766. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.MetadataTextExtractor">
  2767. <summary>
  2768. Returns another text extractor, which is able to
  2769. output the textual content of the document
  2770. metadata / properties, such as author and title.
  2771. </summary>
  2772. <value>The metadata text extractor.</value>
  2773. </member>
  2774. <member name="T:NPOI.HPSF.HPSFException">
  2775. <summary>
  2776. This exception is the superclass of all other checked exceptions thrown
  2777. in this package. It supports a nested "reason" throwable, i.e. an exception
  2778. that caused this one To be thrown.
  2779. @author Rainer Klute
  2780. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2781. @since 2002-02-09
  2782. </summary>
  2783. </member>
  2784. <member name="M:NPOI.HPSF.HPSFException.#ctor">
  2785. <summary>
  2786. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2787. </summary>
  2788. </member>
  2789. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String)">
  2790. <summary>
  2791. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2792. </summary>
  2793. <param name="msg">The message string.</param>
  2794. </member>
  2795. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.Exception)">
  2796. <summary>
  2797. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2798. </summary>
  2799. <param name="reason">The reason, i.e. a throwable that indirectly
  2800. caused this exception.</param>
  2801. </member>
  2802. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String,System.Exception)">
  2803. <summary>
  2804. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  2805. </summary>
  2806. <param name="msg">The message string.</param>
  2807. <param name="reason">The reason, i.e. a throwable that indirectly
  2808. caused this exception.</param>
  2809. </member>
  2810. <member name="P:NPOI.HPSF.HPSFException.Reason">
  2811. <summary>
  2812. Returns the {@link Exception} that caused this exception To
  2813. be thrown or null if there was no such {@link
  2814. Exception}.
  2815. </summary>
  2816. <value>The reason.</value>
  2817. </member>
  2818. <member name="T:NPOI.HPSF.HPSFRuntimeException">
  2819. <summary>
  2820. This exception is the superclass of all other unchecked
  2821. exceptions thrown in this package. It supports a nested "reason"
  2822. throwable, i.e. an exception that caused this one To be thrown.
  2823. @author Rainer Klute
  2824. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2825. @since 2002-02-09
  2826. </summary>
  2827. </member>
  2828. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor">
  2829. <summary>
  2830. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2831. </summary>
  2832. </member>
  2833. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String)">
  2834. <summary>
  2835. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2836. </summary>
  2837. <param name="msg">The message string.</param>
  2838. </member>
  2839. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.Exception)">
  2840. <summary>
  2841. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2842. </summary>
  2843. <param name="reason">The reason, i.e. a throwable that indirectly
  2844. caused this exception.</param>
  2845. </member>
  2846. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String,System.Exception)">
  2847. <summary>
  2848. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  2849. </summary>
  2850. <param name="msg">The message string.</param>
  2851. <param name="reason">The reason, i.e. a throwable that indirectly
  2852. caused this exception.</param>
  2853. </member>
  2854. <member name="T:NPOI.HPSF.IllegalPropertySetDataException">
  2855. <summary>
  2856. This exception is thrown when there is an illegal value Set in a
  2857. {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must
  2858. have a value of <c>-1 (true)</c> or <c>0 (false)</c>.
  2859. Any other value would trigger this exception. It supports a nested
  2860. "reason" throwable, i.e. an exception that caused this one To be
  2861. thrown.
  2862. @author Drew Varner(Drew.Varner atDomain sc.edu)
  2863. @since 2002-05-26
  2864. </summary>
  2865. </member>
  2866. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor">
  2867. <summary>
  2868. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2869. </summary>
  2870. </member>
  2871. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String)">
  2872. <summary>
  2873. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2874. </summary>
  2875. <param name="msg">The exception's message string</param>
  2876. </member>
  2877. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.Exception)">
  2878. <summary>
  2879. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2880. </summary>
  2881. <param name="reason">This exception's underlying reason</param>
  2882. </member>
  2883. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String,System.Exception)">
  2884. <summary>
  2885. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  2886. </summary>
  2887. <param name="msg"> The exception's message string</param>
  2888. <param name="reason">This exception's underlying reason</param>
  2889. </member>
  2890. <member name="T:NPOI.HPSF.IllegalVariantTypeException">
  2891. <summary>
  2892. This exception is thrown if HPSF encounters a variant type that is illegal
  2893. in the current context.
  2894. @author Rainer Klute
  2895. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2896. @since 2004-06-21
  2897. </summary>
  2898. </member>
  2899. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  2900. <summary>
  2901. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  2902. </summary>
  2903. <param name="variantType">The unsupported variant type</param>
  2904. <param name="value">The value</param>
  2905. <param name="msg">A message string</param>
  2906. </member>
  2907. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object)">
  2908. <summary>
  2909. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  2910. </summary>
  2911. <param name="variantType">The unsupported variant type</param>
  2912. <param name="value">The value.</param>
  2913. </member>
  2914. <member name="T:NPOI.HPSF.MarkUnsupportedException">
  2915. <summary>
  2916. This exception is thrown if an {@link java.io.InputStream} does
  2917. not support the {@link java.io.InputStream#mark} operation.
  2918. @author Rainer Klute
  2919. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2920. @since 2002-02-09
  2921. </summary>
  2922. </member>
  2923. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor">
  2924. <summary>
  2925. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2926. </summary>
  2927. </member>
  2928. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String)">
  2929. <summary>
  2930. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2931. </summary>
  2932. <param name="msg">The exception's message string.</param>
  2933. </member>
  2934. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.Exception)">
  2935. <summary>
  2936. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2937. </summary>
  2938. <param name="reason">This exception's underlying reason.</param>
  2939. </member>
  2940. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String,System.Exception)">
  2941. <summary>
  2942. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  2943. </summary>
  2944. <param name="msg">The exception's message string</param>
  2945. <param name="reason">This exception's underlying reason</param>
  2946. </member>
  2947. <member name="T:NPOI.HPSF.MissingSectionException">
  2948. <summary>
  2949. This exception is thrown if one of the {@link PropertySet}'s
  2950. convenience methods does not Find a required {@link Section}.
  2951. The constructors of this class are analogous To those of its
  2952. superclass and documented there.
  2953. @author Rainer Klute
  2954. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2955. @since 2006-02-08
  2956. </summary>
  2957. </member>
  2958. <member name="M:NPOI.HPSF.MissingSectionException.#ctor">
  2959. <summary>
  2960. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2961. </summary>
  2962. </member>
  2963. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String)">
  2964. <summary>
  2965. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2966. </summary>
  2967. <param name="msg">The exception's message string</param>
  2968. </member>
  2969. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.Exception)">
  2970. <summary>
  2971. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2972. </summary>
  2973. <param name="reason">This exception's underlying reason.</param>
  2974. </member>
  2975. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String,System.Exception)">
  2976. <summary>
  2977. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  2978. </summary>
  2979. <param name="msg">The exception's message string</param>
  2980. <param name="reason">This exception's underlying reason</param>
  2981. </member>
  2982. <member name="T:NPOI.HPSF.MutableProperty">
  2983. <summary>
  2984. Adds writing capability To the {@link Property} class.
  2985. Please be aware that this class' functionality will be merged into the
  2986. {@link Property} class at a later time, so the API will Change.
  2987. @author Rainer Klute
  2988. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2989. @since 2003-08-03
  2990. </summary>
  2991. </member>
  2992. <member name="M:NPOI.HPSF.MutableProperty.#ctor">
  2993. <summary>
  2994. Creates an empty property. It must be Filled using the Set method To
  2995. be usable.
  2996. </summary>
  2997. </member>
  2998. <member name="M:NPOI.HPSF.MutableProperty.#ctor(NPOI.HPSF.Property)">
  2999. <summary>
  3000. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableProperty"/> class.
  3001. </summary>
  3002. <param name="p">The property To copy.</param>
  3003. </member>
  3004. <member name="M:NPOI.HPSF.MutableProperty.Write(System.IO.Stream,System.Int32)">
  3005. <summary>
  3006. Writes the property To an output stream.
  3007. </summary>
  3008. <param name="out1">The output stream To Write To.</param>
  3009. <param name="codepage">The codepage To use for writing non-wide strings</param>
  3010. <returns>the number of bytes written To the stream</returns>
  3011. </member>
  3012. <member name="T:NPOI.HPSF.MutablePropertySet">
  3013. <summary>
  3014. Adds writing support To the {@link PropertySet} class.
  3015. Please be aware that this class' functionality will be merged into the
  3016. {@link PropertySet} class at a later time, so the API will Change.
  3017. @author Rainer Klute
  3018. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3019. @since 2003-02-19
  3020. </summary>
  3021. </member>
  3022. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor">
  3023. <summary>
  3024. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  3025. Its primary task is To initialize the immutable field with their proper
  3026. values. It also Sets fields that might Change To reasonable defaults.
  3027. </summary>
  3028. </member>
  3029. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor(NPOI.HPSF.PropertySet)">
  3030. <summary>
  3031. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  3032. All nested elements, i.e.<c>Section</c>s and <c>Property</c> instances, will be their
  3033. mutable counterparts in the new <c>MutablePropertySet</c>.
  3034. </summary>
  3035. <param name="ps">The property Set To copy</param>
  3036. </member>
  3037. <member name="F:NPOI.HPSF.MutablePropertySet.OFFSET_HEADER">
  3038. The Length of the property Set stream header.
  3039. </member>
  3040. <member name="P:NPOI.HPSF.MutablePropertySet.ByteOrder">
  3041. <summary>
  3042. Gets or sets the "byteOrder" property.
  3043. </summary>
  3044. <value>the byteOrder value To Set</value>
  3045. </member>
  3046. <member name="P:NPOI.HPSF.MutablePropertySet.Format">
  3047. <summary>
  3048. Gets or sets the "format" property.
  3049. </summary>
  3050. <value>the format value To Set</value>
  3051. </member>
  3052. <member name="P:NPOI.HPSF.MutablePropertySet.OSVersion">
  3053. <summary>
  3054. Gets or sets the "osVersion" property
  3055. </summary>
  3056. <value>the osVersion value To Set.</value>
  3057. </member>
  3058. <member name="P:NPOI.HPSF.MutablePropertySet.ClassID">
  3059. <summary>
  3060. Gets or sets the property Set stream's low-level "class ID"
  3061. </summary>
  3062. <value>The property Set stream's low-level "class ID" field.</value>
  3063. </member>
  3064. <member name="M:NPOI.HPSF.MutablePropertySet.ClearSections">
  3065. <summary>
  3066. Removes all sections from this property Set.
  3067. </summary>
  3068. </member>
  3069. <member name="M:NPOI.HPSF.MutablePropertySet.AddSection(NPOI.HPSF.Section)">
  3070. <summary>
  3071. Adds a section To this property Set.
  3072. </summary>
  3073. <param name="section">section The {@link Section} To Add. It will be Appended
  3074. after any sections that are alReady present in the property Set
  3075. and thus become the last section.</param>
  3076. </member>
  3077. <member name="M:NPOI.HPSF.MutablePropertySet.Write(System.IO.Stream)">
  3078. <summary>
  3079. Writes the property Set To an output stream.
  3080. </summary>
  3081. <param name="out1">the output stream To Write the section To</param>
  3082. </member>
  3083. <member name="M:NPOI.HPSF.MutablePropertySet.ToInputStream">
  3084. <summary>
  3085. Returns the contents of this property set stream as an input stream.
  3086. The latter can be used for example to write the property set into a POIFS
  3087. document. The input stream represents a snapshot of the property set.
  3088. If the latter is modified while the input stream is still being
  3089. read, the modifications will not be reflected in the input stream but in
  3090. the {@link MutablePropertySet} only.
  3091. </summary>
  3092. <returns>the contents of this property set stream</returns>
  3093. </member>
  3094. <member name="M:NPOI.HPSF.MutablePropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  3095. <summary>
  3096. Writes a property Set To a document in a POI filesystem directory
  3097. </summary>
  3098. <param name="dir">The directory in the POI filesystem To Write the document To.</param>
  3099. <param name="name">The document's name. If there is alReady a document with the
  3100. same name in the directory the latter will be overwritten.</param>
  3101. </member>
  3102. <member name="T:NPOI.HPSF.MutableSection">
  3103. <summary>
  3104. Adds writing capability To the {@link Section} class.
  3105. Please be aware that this class' functionality will be merged into the
  3106. {@link Section} class at a later time, so the API will Change.
  3107. @since 2002-02-20
  3108. </summary>
  3109. </member>
  3110. <member name="F:NPOI.HPSF.MutableSection.dirty">
  3111. If the "dirty" flag is true, the section's size must be
  3112. (re-)calculated before the section is written.
  3113. </member>
  3114. <member name="F:NPOI.HPSF.MutableSection.preprops">
  3115. List To assemble the properties. Unfortunately a wrong
  3116. decision has been taken when specifying the "properties" field
  3117. as an Property[]. It should have been a {@link java.util.List}.
  3118. </member>
  3119. <member name="F:NPOI.HPSF.MutableSection.sectionBytes">
  3120. Contains the bytes making out the section. This byte array is
  3121. established when the section's size is calculated and can be reused
  3122. later. It is valid only if the "dirty" flag is false.
  3123. </member>
  3124. <member name="M:NPOI.HPSF.MutableSection.#ctor">
  3125. <summary>
  3126. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableSection"/> class.
  3127. </summary>
  3128. </member>
  3129. <member name="M:NPOI.HPSF.MutableSection.#ctor(NPOI.HPSF.Section)">
  3130. <summary>
  3131. Constructs a <c>MutableSection</c> by doing a deep copy of an
  3132. existing <c>Section</c>. All nested <c>Property</c>
  3133. instances, will be their mutable counterparts in the new
  3134. <c>MutableSection</c>.
  3135. </summary>
  3136. <param name="s">The section Set To copy</param>
  3137. </member>
  3138. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(NPOI.Util.ClassID)">
  3139. <summary>
  3140. Sets the section's format ID.
  3141. </summary>
  3142. <param name="formatID">The section's format ID</param>
  3143. </member>
  3144. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(System.Byte[])">
  3145. <summary>
  3146. Sets the section's format ID.
  3147. </summary>
  3148. <param name="formatID">The section's format ID as a byte array. It components
  3149. are in big-endian format.</param>
  3150. </member>
  3151. <member name="M:NPOI.HPSF.MutableSection.SetProperties(NPOI.HPSF.Property[])">
  3152. <summary>
  3153. Sets this section's properties. Any former values are overwritten.
  3154. </summary>
  3155. <param name="properties">This section's new properties.</param>
  3156. </member>
  3157. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.String)">
  3158. <summary>
  3159. Sets the string value of the property with the specified ID.
  3160. </summary>
  3161. <param name="id">The property's ID</param>
  3162. <param name="value">The property's value. It will be written as a Unicode
  3163. string.</param>
  3164. </member>
  3165. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int32)">
  3166. <summary>
  3167. Sets the int value of the property with the specified ID.
  3168. </summary>
  3169. <param name="id">The property's ID</param>
  3170. <param name="value">The property's value.</param>
  3171. </member>
  3172. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64)">
  3173. <summary>
  3174. Sets the long value of the property with the specified ID.
  3175. </summary>
  3176. <param name="id">The property's ID</param>
  3177. <param name="value">The property's value.</param>
  3178. </member>
  3179. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Boolean)">
  3180. <summary>
  3181. Sets the bool value of the property with the specified ID.
  3182. </summary>
  3183. <param name="id">The property's ID</param>
  3184. <param name="value">The property's value.</param>
  3185. </member>
  3186. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64,System.Object)">
  3187. <summary>
  3188. Sets the value and the variant type of the property with the
  3189. specified ID. If a property with this ID is not yet present in
  3190. the section, it will be Added. An alReady present property with
  3191. the specified ID will be overwritten. A default mapping will be
  3192. used To choose the property's type.
  3193. </summary>
  3194. <param name="id">The property's ID.</param>
  3195. <param name="variantType">The property's variant type.</param>
  3196. <param name="value">The property's value.</param>
  3197. </member>
  3198. <member name="M:NPOI.HPSF.MutableSection.SetProperty(NPOI.HPSF.Property)">
  3199. <summary>
  3200. Sets the property.
  3201. </summary>
  3202. <param name="p">The property To be Set.</param>
  3203. </member>
  3204. <member name="M:NPOI.HPSF.MutableSection.RemoveProperty(System.Int64)">
  3205. <summary>
  3206. Removes the property.
  3207. </summary>
  3208. <param name="id">The ID of the property To be Removed</param>
  3209. </member>
  3210. <member name="M:NPOI.HPSF.MutableSection.SetPropertyBooleanValue(System.Int32,System.Boolean)">
  3211. <summary>
  3212. Sets the value of the bool property with the specified
  3213. ID.
  3214. </summary>
  3215. <param name="id">The property's ID</param>
  3216. <param name="value">The property's value</param>
  3217. </member>
  3218. <member name="P:NPOI.HPSF.MutableSection.Size">
  3219. <summary>
  3220. Returns the section's size in bytes.
  3221. </summary>
  3222. <value>The section's size in bytes.</value>
  3223. </member>
  3224. <member name="M:NPOI.HPSF.MutableSection.CalcSize">
  3225. <summary>
  3226. Calculates the section's size. It is the sum of the Lengths of the
  3227. section's header (8), the properties list (16 times the number of
  3228. properties) and the properties themselves.
  3229. </summary>
  3230. <returns>the section's Length in bytes.</returns>
  3231. </member>
  3232. <member name="M:NPOI.HPSF.MutableSection.Write(System.IO.Stream)">
  3233. <summary>
  3234. Writes this section into an output stream.
  3235. Internally this is done by writing into three byte array output
  3236. streams: one for the properties, one for the property list and one for
  3237. the section as such. The two former are Appended To the latter when they
  3238. have received all their data.
  3239. </summary>
  3240. <param name="out1">The stream To Write into.</param>
  3241. <returns>The number of bytes written, i.e. the section's size.</returns>
  3242. </member>
  3243. <member name="M:NPOI.HPSF.MutableSection.WriteDictionary(System.IO.Stream,System.Collections.IDictionary,System.Int32)">
  3244. <summary>
  3245. Writes the section's dictionary
  3246. </summary>
  3247. <param name="out1">The output stream To Write To.</param>
  3248. <param name="dictionary">The dictionary.</param>
  3249. <param name="codepage">The codepage to be used to Write the dictionary items.</param>
  3250. <returns>The number of bytes written</returns>
  3251. <remarks>
  3252. see MSDN KB: http://msdn.microsoft.com/en-us/library/aa380065(VS.85).aspx
  3253. </remarks>
  3254. </member>
  3255. <member name="P:NPOI.HPSF.MutableSection.PropertyCount">
  3256. <summary>
  3257. OverWrites the base class' method To cope with a redundancy:
  3258. the property count is maintained in a separate member variable, but
  3259. shouldn't.
  3260. </summary>
  3261. <value>The number of properties in this section.</value>
  3262. </member>
  3263. <member name="P:NPOI.HPSF.MutableSection.Properties">
  3264. <summary>
  3265. Returns this section's properties.
  3266. </summary>
  3267. <value>This section's properties.</value>
  3268. </member>
  3269. <member name="M:NPOI.HPSF.MutableSection.EnsureProperties">
  3270. <summary>
  3271. Ensures the properties.
  3272. </summary>
  3273. </member>
  3274. <member name="M:NPOI.HPSF.MutableSection.GetProperty(System.Int64)">
  3275. <summary>
  3276. Gets a property.
  3277. </summary>
  3278. <param name="id">The ID of the property To Get</param>
  3279. <returns>The property or null if there is no such property</returns>
  3280. </member>
  3281. <member name="P:NPOI.HPSF.MutableSection.Dictionary">
  3282. <summary>
  3283. Sets the section's dictionary. All keys in the dictionary must be
  3284. {@link java.lang.long} instances, all values must be
  3285. {@link java.lang.String}s. This method overWrites the properties with IDs
  3286. 0 and 1 since they are reserved for the dictionary and the dictionary's
  3287. codepage. Setting these properties explicitly might have surprising
  3288. effects. An application should never do this but always use this
  3289. method.
  3290. </summary>
  3291. <value>
  3292. the dictionary
  3293. </value>
  3294. </member>
  3295. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Object)">
  3296. <summary>
  3297. Sets the property.
  3298. </summary>
  3299. <param name="id">The property ID.</param>
  3300. <param name="value">The property's value. The value's class must be one of those
  3301. supported by HPSF.</param>
  3302. </member>
  3303. <member name="M:NPOI.HPSF.MutableSection.Clear">
  3304. <summary>
  3305. Removes all properties from the section including 0 (dictionary) and
  3306. 1 (codepage).
  3307. </summary>
  3308. </member>
  3309. <member name="P:NPOI.HPSF.MutableSection.Codepage">
  3310. <summary>
  3311. Gets the section's codepage, if any.
  3312. </summary>
  3313. <value>The section's codepage if one is defined, else -1.</value>
  3314. </member>
  3315. <member name="T:NPOI.HPSF.NoFormatIDException">
  3316. <summary>
  3317. This exception is thrown if a {@link MutablePropertySet} is To be written
  3318. but does not have a formatID Set (see {@link
  3319. MutableSection#SetFormatID(ClassID)} or
  3320. {@link org.apache.poi.hpsf.MutableSection#SetFormatID(byte[])}.
  3321. @author Rainer Klute
  3322. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3323. @since 2002-09-03
  3324. </summary>
  3325. </member>
  3326. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor">
  3327. <summary>
  3328. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3329. </summary>
  3330. </member>
  3331. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String)">
  3332. <summary>
  3333. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3334. </summary>
  3335. <param name="msg">The exception's message string</param>
  3336. </member>
  3337. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.Exception)">
  3338. <summary>
  3339. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3340. </summary>
  3341. <param name="reason">This exception's underlying reason</param>
  3342. </member>
  3343. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String,System.Exception)">
  3344. <summary>
  3345. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3346. </summary>
  3347. <param name="msg">The exception's message string</param>
  3348. <param name="reason">This exception's underlying reason</param>
  3349. </member>
  3350. <member name="T:NPOI.HPSF.NoPropertySetStreamException">
  3351. <summary>
  3352. This exception is thrown if a format error in a property Set stream Is
  3353. detected or when the input data do not constitute a property Set stream.
  3354. The constructors of this class are analogous To those of its superclass
  3355. and are documented there.
  3356. @author Rainer Klute
  3357. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3358. @since 2002-02-09
  3359. </summary>
  3360. </member>
  3361. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor">
  3362. <summary>
  3363. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3364. </summary>
  3365. </member>
  3366. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String)">
  3367. <summary>
  3368. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3369. </summary>
  3370. <param name="msg">The exception's message string</param>
  3371. </member>
  3372. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.Exception)">
  3373. <summary>
  3374. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3375. </summary>
  3376. <param name="reason">This exception's underlying reason</param>
  3377. </member>
  3378. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String,System.Exception)">
  3379. <summary>
  3380. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3381. </summary>
  3382. <param name="msg">The exception's message string</param>
  3383. <param name="reason">This exception's underlying reason</param>
  3384. </member>
  3385. <member name="T:NPOI.HPSF.NoSingleSectionException">
  3386. <summary>
  3387. This exception is thrown if one of the {@link PropertySet}'s
  3388. convenience methods that require a single {@link Section} is called
  3389. and the {@link PropertySet} does not contain exactly one {@link
  3390. Section}.
  3391. The constructors of this class are analogous To those of its
  3392. superclass and documented there.
  3393. @author Rainer Klute
  3394. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3395. @since 2002-02-09
  3396. </summary>
  3397. </member>
  3398. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor">
  3399. <summary>
  3400. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3401. </summary>
  3402. </member>
  3403. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String)">
  3404. <summary>
  3405. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3406. </summary>
  3407. <param name="msg">The exception's message string</param>
  3408. </member>
  3409. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.Exception)">
  3410. <summary>
  3411. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3412. </summary>
  3413. <param name="reason">This exception's underlying reason</param>
  3414. </member>
  3415. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String,System.Exception)">
  3416. <summary>
  3417. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3418. </summary>
  3419. <param name="msg">The exception's message string</param>
  3420. <param name="reason">This exception's underlying reason</param>
  3421. </member>
  3422. <member name="T:NPOI.HPSF.Property">
  3423. <summary>
  3424. A property in a {@link Section} of a {@link PropertySet}.
  3425. The property's ID gives the property a meaning
  3426. in the context of its {@link Section}. Each {@link Section} spans
  3427. its own name space of property IDs.
  3428. The property's type determines how its
  3429. value is interpreted. For example, if the type Is
  3430. {@link Variant#VT_LPSTR} (byte string), the value consists of a
  3431. DWord telling how many bytes the string Contains. The bytes follow
  3432. immediately, including any null bytes that terminate the
  3433. string. The type {@link Variant#VT_I4} denotes a four-byte integer
  3434. value, {@link Variant#VT_FILETIME} some DateTime and time (of a
  3435. file).
  3436. Please note that not all {@link Variant} types yet. This might Change
  3437. over time but largely depends on your feedback so that the POI team knows
  3438. which variant types are really needed. So please feel free To submit error
  3439. reports or patches for the types you need.
  3440. Microsoft documentation:
  3441. <a href="http://msdn.microsoft.com/library/en-us/stg/stg/property_Set_display_name_dictionary.asp?frame=true">
  3442. Property Set Display Name Dictionary</a>
  3443. .
  3444. @author Rainer Klute
  3445. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3446. @author Drew Varner (Drew.Varner InAndAround sc.edu)
  3447. @see Section
  3448. @see Variant
  3449. @since 2002-02-09
  3450. </summary>
  3451. </member>
  3452. <member name="F:NPOI.HPSF.Property.id">
  3453. The property's ID.
  3454. </member>
  3455. <member name="P:NPOI.HPSF.Property.ID">
  3456. Returns the property's ID.
  3457. @return The ID value
  3458. </member>
  3459. <member name="F:NPOI.HPSF.Property.type">
  3460. The property's type.
  3461. </member>
  3462. <member name="P:NPOI.HPSF.Property.Type">
  3463. Returns the property's type.
  3464. @return The type value
  3465. </member>
  3466. <member name="F:NPOI.HPSF.Property.value">
  3467. The property's value.
  3468. </member>
  3469. <member name="P:NPOI.HPSF.Property.Value">
  3470. <summary>
  3471. Gets the property's value.
  3472. </summary>
  3473. <value>The property's value</value>
  3474. </member>
  3475. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Int64,System.Object)">
  3476. <summary>
  3477. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3478. </summary>
  3479. <param name="id">the property's ID.</param>
  3480. <param name="type">the property's type, see {@link Variant}.</param>
  3481. <param name="value">the property's value. Only certain types are allowed, see
  3482. {@link Variant}.</param>
  3483. </member>
  3484. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Byte[],System.Int64,System.Int32,System.Int32)">
  3485. <summary>
  3486. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3487. </summary>
  3488. <param name="id">The property's ID.</param>
  3489. <param name="src">The bytes the property Set stream consists of.</param>
  3490. <param name="offset">The property's type/value pair's offset in the
  3491. section.</param>
  3492. <param name="Length">The property's type/value pair's Length in bytes.</param>
  3493. <param name="codepage">The section's and thus the property's
  3494. codepage. It is needed only when Reading string values</param>
  3495. </member>
  3496. <member name="M:NPOI.HPSF.Property.#ctor">
  3497. <summary>
  3498. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3499. </summary>
  3500. </member>
  3501. <member name="M:NPOI.HPSF.Property.ReadDictionary(System.Byte[],System.Int64,System.Int32,System.Int32)">
  3502. <summary>
  3503. Reads the dictionary.
  3504. </summary>
  3505. <param name="src">The byte array containing the bytes making out the dictionary.</param>
  3506. <param name="offset">At this offset within src the dictionary starts.</param>
  3507. <param name="Length">The dictionary Contains at most this many bytes.</param>
  3508. <param name="codepage">The codepage of the string values.</param>
  3509. <returns>The dictonary</returns>
  3510. </member>
  3511. <member name="P:NPOI.HPSF.Property.Count">
  3512. <summary>
  3513. Gets the property's size in bytes. This is always a multiple of
  3514. 4.
  3515. </summary>
  3516. <value>the property's size in bytes</value>
  3517. </member>
  3518. <member name="M:NPOI.HPSF.Property.Equals(System.Object)">
  3519. <summary>
  3520. Compares two properties.
  3521. Please beware that a property with
  3522. ID == 0 is a special case: It does not have a type, and its value is the
  3523. section's dictionary. Another special case are strings: Two properties
  3524. may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;
  3525. </summary>
  3526. <param name="o">The o.</param>
  3527. <returns></returns>
  3528. </member>
  3529. <member name="M:NPOI.HPSF.Property.TypesAreEqual(System.Int64,System.Int64)">
  3530. <summary>
  3531. Typeses the are equal.
  3532. </summary>
  3533. <param name="t1">The t1.</param>
  3534. <param name="t2">The t2.</param>
  3535. <returns></returns>
  3536. </member>
  3537. <member name="M:NPOI.HPSF.Property.GetHashCode">
  3538. <summary>
  3539. Serves as a hash function for a particular type.
  3540. </summary>
  3541. <returns>
  3542. A hash code for the current <see cref="T:System.Object"/>.
  3543. </returns>
  3544. </member>
  3545. <member name="M:NPOI.HPSF.Property.ToString">
  3546. <summary>
  3547. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3548. </summary>
  3549. <returns>
  3550. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3551. </returns>
  3552. </member>
  3553. <member name="T:NPOI.HPSF.PropertySet">
  3554. <summary>
  3555. Represents a property Set in the Horrible Property Set Format
  3556. (HPSF). These are usually metadata of a Microsoft Office
  3557. document.
  3558. An application that wants To access these metadata should Create
  3559. an instance of this class or one of its subclasses by calling the
  3560. factory method {@link PropertySetFactory#Create} and then retrieve
  3561. the information its needs by calling appropriate methods.
  3562. {@link PropertySetFactory#Create} does its work by calling one
  3563. of the constructors {@link PropertySet#PropertySet(InputStream)} or
  3564. {@link PropertySet#PropertySet(byte[])}. If the constructor's
  3565. argument is not in the Horrible Property Set Format, i.e. not a
  3566. property Set stream, or if any other error occurs, an appropriate
  3567. exception is thrown.
  3568. A {@link PropertySet} has a list of {@link Section}s, and each
  3569. {@link Section} has a {@link Property} array. Use {@link
  3570. #GetSections} To retrieve the {@link Section}s, then call {@link
  3571. Section#GetProperties} for each {@link Section} To Get hold of the
  3572. {@link Property} arrays. Since the vast majority of {@link
  3573. PropertySet}s Contains only a single {@link Section}, the
  3574. convenience method {@link #GetProperties} returns the properties of
  3575. a {@link PropertySet}'s {@link Section} (throwing a {@link
  3576. NoSingleSectionException} if the {@link PropertySet} Contains more
  3577. (or less) than exactly one {@link Section}).
  3578. @author Rainer Klute
  3579. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3580. @author Drew Varner (Drew.Varner hanginIn sc.edu)
  3581. @since 2002-02-09
  3582. </summary>
  3583. </member>
  3584. <member name="F:NPOI.HPSF.PropertySet.BYTE_ORDER_ASSERTION">
  3585. The "byteOrder" field must equal this value.
  3586. </member>
  3587. <member name="F:NPOI.HPSF.PropertySet.byteOrder">
  3588. Specifies this {@link PropertySet}'s byte order. See the
  3589. HPFS documentation for details!
  3590. </member>
  3591. <member name="P:NPOI.HPSF.PropertySet.ByteOrder">
  3592. <summary>
  3593. Gets or sets the property Set stream's low-level "byte order"
  3594. field. It is always <c>0xFFFE</c>
  3595. </summary>
  3596. <value>The property Set stream's low-level "byte order" field..</value>
  3597. </member>
  3598. <member name="F:NPOI.HPSF.PropertySet.FORMAT_ASSERTION">
  3599. The "format" field must equal this value.
  3600. </member>
  3601. <member name="F:NPOI.HPSF.PropertySet.format">
  3602. Specifies this {@link PropertySet}'s format. See the HPFS
  3603. documentation for details!
  3604. </member>
  3605. <member name="P:NPOI.HPSF.PropertySet.Format">
  3606. <summary>
  3607. Gets or sets the property Set stream's low-level "format"
  3608. field. It is always <c>0x0000</c>
  3609. </summary>
  3610. <value>The property Set stream's low-level "format" field.</value>
  3611. </member>
  3612. <member name="F:NPOI.HPSF.PropertySet.osVersion">
  3613. Specifies the version of the operating system that Created
  3614. this {@link PropertySet}. See the HPFS documentation for
  3615. details!
  3616. </member>
  3617. <member name="F:NPOI.HPSF.PropertySet.OS_WIN16">
  3618. If the OS version field holds this value the property Set stream Was
  3619. Created on a 16-bit Windows system.
  3620. </member>
  3621. <member name="F:NPOI.HPSF.PropertySet.OS_MACINTOSH">
  3622. If the OS version field holds this value the property Set stream Was
  3623. Created on a Macintosh system.
  3624. </member>
  3625. <member name="F:NPOI.HPSF.PropertySet.OS_WIN32">
  3626. If the OS version field holds this value the property Set stream Was
  3627. Created on a 32-bit Windows system.
  3628. </member>
  3629. <member name="P:NPOI.HPSF.PropertySet.OSVersion">
  3630. <summary>
  3631. Returns the property Set stream's low-level "OS version"
  3632. field.
  3633. </summary>
  3634. <value>The property Set stream's low-level "OS version" field.</value>
  3635. </member>
  3636. <member name="F:NPOI.HPSF.PropertySet.classID">
  3637. Specifies this {@link PropertySet}'s "classID" field. See
  3638. the HPFS documentation for details!
  3639. </member>
  3640. <member name="P:NPOI.HPSF.PropertySet.ClassID">
  3641. <summary>
  3642. Gets or sets the property Set stream's low-level "class ID"
  3643. </summary>
  3644. <value>The property Set stream's low-level "class ID" field.</value>
  3645. </member>
  3646. <member name="P:NPOI.HPSF.PropertySet.SectionCount">
  3647. <summary>
  3648. Returns the number of {@link Section}s in the property
  3649. Set.
  3650. </summary>
  3651. <value>The number of {@link Section}s in the property Set.</value>
  3652. </member>
  3653. <member name="F:NPOI.HPSF.PropertySet.sections">
  3654. The sections in this {@link PropertySet}.
  3655. </member>
  3656. <member name="P:NPOI.HPSF.PropertySet.Sections">
  3657. <summary>
  3658. Returns the {@link Section}s in the property Set.
  3659. </summary>
  3660. <value>{@link Section}s in the property Set.</value>
  3661. </member>
  3662. <member name="M:NPOI.HPSF.PropertySet.#ctor">
  3663. <summary>
  3664. Creates an empty (uninitialized) {@link PropertySet}
  3665. Please note: For the time being this
  3666. constructor is protected since it is used for internal purposes
  3667. only, but expect it To become public once the property Set's
  3668. writing functionality is implemented.
  3669. </summary>
  3670. </member>
  3671. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.IO.Stream)">
  3672. <summary>
  3673. Creates a {@link PropertySet} instance from an {@link
  3674. InputStream} in the Horrible Property Set Format.
  3675. The constructor Reads the first few bytes from the stream
  3676. and determines whether it is really a property Set stream. If
  3677. it Is, it parses the rest of the stream. If it is not, it
  3678. Resets the stream To its beginning in order To let other
  3679. components mess around with the data and throws an
  3680. exception.
  3681. </summary>
  3682. <param name="stream">Holds the data making out the property Set
  3683. stream.</param>
  3684. </member>
  3685. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[],System.Int32,System.Int32)">
  3686. <summary>
  3687. Creates a {@link PropertySet} instance from a byte array
  3688. that represents a stream in the Horrible Property Set
  3689. Format.
  3690. </summary>
  3691. <param name="stream">The byte array holding the stream data.</param>
  3692. <param name="offset">The offset in stream where the stream data begin.
  3693. If the stream data begin with the first byte in the
  3694. array, the offset is 0.</param>
  3695. <param name="Length"> The Length of the stream data.</param>
  3696. </member>
  3697. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[])">
  3698. <summary>
  3699. Creates a {@link PropertySet} instance from a byte array
  3700. that represents a stream in the Horrible Property Set
  3701. Format.
  3702. </summary>
  3703. <param name="stream">The byte array holding the stream data. The
  3704. complete byte array contents is the stream data.</param>
  3705. </member>
  3706. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.IO.Stream)">
  3707. <summary>
  3708. Checks whether an {@link InputStream} is in the Horrible
  3709. Property Set Format.
  3710. </summary>
  3711. <param name="stream">The {@link InputStream} To check. In order To
  3712. perform the check, the method Reads the first bytes from the
  3713. stream. After Reading, the stream is Reset To the position it
  3714. had before Reading. The {@link InputStream} must support the
  3715. {@link InputStream#mark} method.</param>
  3716. <returns>
  3717. <c>true</c> if the stream is a property Set
  3718. stream; otherwise, <c>false</c>.
  3719. </returns>
  3720. </member>
  3721. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.Byte[],System.Int32,System.Int32)">
  3722. <summary>
  3723. Checks whether a byte array is in the Horrible Property Set
  3724. Format.
  3725. </summary>
  3726. <param name="src">The byte array To check.</param>
  3727. <param name="offset">The offset in the byte array.</param>
  3728. <param name="Length">The significant number of bytes in the byte
  3729. array. Only this number of bytes will be checked.</param>
  3730. <returns>
  3731. <c>true</c> if the byte array is a property Set
  3732. stream; otherwise, <c>false</c>.
  3733. </returns>
  3734. </member>
  3735. <member name="M:NPOI.HPSF.PropertySet.init(System.Byte[],System.Int32,System.Int32)">
  3736. <summary>
  3737. Initializes this {@link PropertySet} instance from a byte
  3738. array. The method assumes that it has been checked alReady that
  3739. the byte array indeed represents a property Set stream. It does
  3740. no more checks on its own.
  3741. </summary>
  3742. <param name="src">Byte array containing the property Set stream</param>
  3743. <param name="offset">The property Set stream starts at this offset</param>
  3744. <param name="Length">Length of the property Set stream.</param>
  3745. </member>
  3746. <member name="P:NPOI.HPSF.PropertySet.IsSummaryInformation">
  3747. <summary>
  3748. Checks whether this {@link PropertySet} represents a Summary
  3749. Information.
  3750. </summary>
  3751. <value>
  3752. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  3753. Information; otherwise, <c>false</c>.
  3754. </value>
  3755. </member>
  3756. <member name="P:NPOI.HPSF.PropertySet.IsDocumentSummaryInformation">
  3757. <summary>
  3758. Gets a value indicating whether this instance is document summary information.
  3759. </summary>
  3760. <value>
  3761. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  3762. </value>
  3763. Checks whether this {@link PropertySet} is a Document
  3764. Summary Information.
  3765. @return
  3766. <c>true</c>
  3767. if this {@link PropertySet}
  3768. represents a Document Summary Information, else
  3769. <c>false</c>
  3770. </member>
  3771. <member name="P:NPOI.HPSF.PropertySet.Properties">
  3772. <summary>
  3773. Convenience method returning the {@link Property} array
  3774. contained in this property Set. It is a shortcut for Getting
  3775. the {@link PropertySet}'s {@link Section}s list and then
  3776. Getting the {@link Property} array from the first {@link
  3777. Section}.
  3778. </summary>
  3779. <value>The properties of the only {@link Section} of this
  3780. {@link PropertySet}.</value>
  3781. </member>
  3782. <member name="M:NPOI.HPSF.PropertySet.GetProperty(System.Int32)">
  3783. <summary>
  3784. Convenience method returning the value of the property with
  3785. the specified ID. If the property is not available,
  3786. <c>null</c> is returned and a subsequent call To {@link
  3787. #WasNull} will return <c>true</c> .
  3788. </summary>
  3789. <param name="id">The property ID</param>
  3790. <returns>The property value</returns>
  3791. </member>
  3792. <member name="M:NPOI.HPSF.PropertySet.GetPropertyBooleanValue(System.Int32)">
  3793. <summary>
  3794. Convenience method returning the value of a bool property
  3795. with the specified ID. If the property is not available,
  3796. <c>false</c> is returned. A subsequent call To {@link
  3797. #WasNull} will return <c>true</c> To let the caller
  3798. distinguish that case from a real property value of
  3799. <c>false</c>.
  3800. </summary>
  3801. <param name="id">The property ID</param>
  3802. <returns>The property value</returns>
  3803. </member>
  3804. <member name="M:NPOI.HPSF.PropertySet.GetPropertyIntValue(System.Int32)">
  3805. <summary>
  3806. Convenience method returning the value of the numeric
  3807. property with the specified ID. If the property is not
  3808. available, 0 is returned. A subsequent call To {@link #WasNull}
  3809. will return <c>true</c> To let the caller distinguish
  3810. that case from a real property value of 0.
  3811. </summary>
  3812. <param name="id">The property ID</param>
  3813. <returns>The propertyIntValue value</returns>
  3814. </member>
  3815. <member name="P:NPOI.HPSF.PropertySet.WasNull">
  3816. <summary>
  3817. Checks whether the property which the last call To {@link
  3818. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  3819. Was available or not. This information might be important for
  3820. callers of {@link #GetPropertyIntValue} since the latter
  3821. returns 0 if the property does not exist. Using {@link
  3822. #WasNull}, the caller can distiguish this case from a
  3823. property's real value of 0.
  3824. </summary>
  3825. <value><c>true</c> if the last call To {@link
  3826. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  3827. property that Was not available; otherwise, <c>false</c>.</value>
  3828. </member>
  3829. <member name="P:NPOI.HPSF.PropertySet.FirstSection">
  3830. <summary>
  3831. Gets the first section.
  3832. </summary>
  3833. <value>The first section.</value>
  3834. </member>
  3835. <member name="P:NPOI.HPSF.PropertySet.SingleSection">
  3836. <summary>
  3837. If the {@link PropertySet} has only a single section this
  3838. method returns it.
  3839. </summary>
  3840. <value>The singleSection value</value>
  3841. </member>
  3842. <member name="M:NPOI.HPSF.PropertySet.Equals(System.Object)">
  3843. <summary>
  3844. Returns <c>true</c> if the <c>PropertySet</c> is equal
  3845. To the specified parameter, else <c>false</c>.
  3846. </summary>
  3847. <param name="o">the object To Compare this
  3848. <c>PropertySet</c>
  3849. with</param>
  3850. <returns><c>true</c>
  3851. if the objects are equal,
  3852. <c>false</c>
  3853. if not</returns>
  3854. </member>
  3855. <member name="M:NPOI.HPSF.PropertySet.GetHashCode">
  3856. <summary>
  3857. Serves as a hash function for a particular type.
  3858. </summary>
  3859. <returns>
  3860. A hash code for the current <see cref="T:System.Object"/>.
  3861. </returns>
  3862. </member>
  3863. <member name="M:NPOI.HPSF.PropertySet.ToString">
  3864. <summary>
  3865. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3866. </summary>
  3867. <returns>
  3868. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3869. </returns>
  3870. </member>
  3871. <member name="T:NPOI.HPSF.PropertySetFactory">
  3872. <summary>
  3873. Factory class To Create instances of {@link SummaryInformation},
  3874. {@link DocumentSummaryInformation} and {@link PropertySet}.
  3875. @author Rainer Klute
  3876. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3877. @since 2002-02-09
  3878. </summary>
  3879. </member>
  3880. <member name="M:NPOI.HPSF.PropertySetFactory.Create(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  3881. <p>Creates the most specific {@link PropertySet} from an entry
  3882. in the specified POIFS Directory. This is preferrably a {@link
  3883. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  3884. the specified entry does not contain a property Set stream, an
  3885. exception is thrown. If no entry is found with the given name,
  3886. an exception is thrown.</p>
  3887. @param dir The directory to find the PropertySet in
  3888. @param name The name of the entry Containing the PropertySet
  3889. @return The Created {@link PropertySet}.
  3890. @if there is no entry with that name
  3891. @if the stream does not
  3892. contain a property Set.
  3893. @if some I/O problem occurs.
  3894. @exception EncoderFallbackException if the specified codepage is not
  3895. supported.
  3896. </member>
  3897. <member name="M:NPOI.HPSF.PropertySetFactory.Create(System.IO.Stream)">
  3898. <summary>
  3899. Creates the most specific {@link PropertySet} from an {@link
  3900. InputStream}. This is preferrably a {@link
  3901. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  3902. the specified {@link InputStream} does not contain a property
  3903. Set stream, an exception is thrown and the {@link InputStream}
  3904. is repositioned at its beginning.
  3905. </summary>
  3906. <param name="stream">Contains the property set stream's data.</param>
  3907. <returns>The Created {@link PropertySet}.</returns>
  3908. </member>
  3909. <member name="M:NPOI.HPSF.PropertySetFactory.CreateSummaryInformation">
  3910. <summary>
  3911. Creates a new summary information
  3912. </summary>
  3913. <returns>the new summary information.</returns>
  3914. </member>
  3915. <member name="M:NPOI.HPSF.PropertySetFactory.CreateDocumentSummaryInformation">
  3916. <summary>
  3917. Creates a new document summary information.
  3918. </summary>
  3919. <returns>the new document summary information.</returns>
  3920. </member>
  3921. <member name="T:NPOI.HPSF.ReadingNotSupportedException">
  3922. <summary>
  3923. This exception is thrown when HPSF tries To Read a (yet) unsupported
  3924. variant type.
  3925. @see WritingNotSupportedException
  3926. @see UnsupportedVariantTypeException
  3927. @author Rainer Klute
  3928. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3929. @since 2003-08-08
  3930. </summary>
  3931. </member>
  3932. <member name="M:NPOI.HPSF.ReadingNotSupportedException.#ctor(System.Int64,System.Object)">
  3933. <summary>
  3934. Initializes a new instance of the <see cref="T:NPOI.HPSF.ReadingNotSupportedException"/> class.
  3935. </summary>
  3936. <param name="variantType">The unsupported variant type</param>
  3937. <param name="value">The value who's variant type is not yet supported</param>
  3938. </member>
  3939. <member name="T:NPOI.HPSF.Section">
  3940. <summary>
  3941. Represents a section in a {@link PropertySet}.
  3942. @author Rainer Klute
  3943. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3944. @author Drew Varner (Drew.Varner allUpIn sc.edu)
  3945. @since 2002-02-09
  3946. </summary>
  3947. </member>
  3948. <member name="F:NPOI.HPSF.Section.dictionary">
  3949. Maps property IDs To section-private PID strings. These
  3950. strings can be found in the property with ID 0.
  3951. </member>
  3952. <member name="F:NPOI.HPSF.Section.formatID">
  3953. The section's format ID, {@link #GetFormatID}.
  3954. </member>
  3955. <member name="P:NPOI.HPSF.Section.FormatID">
  3956. <summary>
  3957. Returns the format ID. The format ID is the "type" of the
  3958. section. For example, if the format ID of the first {@link
  3959. Section} Contains the bytes specified by
  3960. <c>org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID</c>
  3961. the section (and thus the property Set) is a SummaryInformation.
  3962. </summary>
  3963. <value>The format ID.</value>
  3964. </member>
  3965. <member name="P:NPOI.HPSF.Section.OffSet">
  3966. <summary>
  3967. Gets the offset of the section in the stream.
  3968. </summary>
  3969. <value>The offset of the section in the stream</value>
  3970. </member>
  3971. <member name="P:NPOI.HPSF.Section.Size">
  3972. <summary>
  3973. Returns the section's size in bytes.
  3974. </summary>
  3975. <value>The section's size in bytes.</value>
  3976. </member>
  3977. <member name="P:NPOI.HPSF.Section.PropertyCount">
  3978. <summary>
  3979. Returns the number of properties in this section.
  3980. </summary>
  3981. <value>The number of properties in this section.</value>
  3982. </member>
  3983. <member name="P:NPOI.HPSF.Section.Properties">
  3984. <summary>
  3985. Returns this section's properties.
  3986. </summary>
  3987. <value>This section's properties.</value>
  3988. </member>
  3989. <member name="M:NPOI.HPSF.Section.#ctor">
  3990. <summary>
  3991. Creates an empty and uninitialized {@link Section}.
  3992. </summary>
  3993. </member>
  3994. <member name="M:NPOI.HPSF.Section.#ctor(System.Byte[],System.Int32)">
  3995. <summary>
  3996. Creates a {@link Section} instance from a byte array.
  3997. </summary>
  3998. <param name="src">Contains the complete property Set stream.</param>
  3999. <param name="offset">The position in the stream that points To the
  4000. section's format ID.</param>
  4001. </member>
  4002. <member name="T:NPOI.HPSF.Section.PropertyListEntry">
  4003. Represents an entry in the property list and holds a property's ID and
  4004. its offset from the section's beginning.
  4005. </member>
  4006. <member name="M:NPOI.HPSF.Section.PropertyListEntry.CompareTo(System.Object)">
  4007. Compares this {@link PropertyListEntry} with another one by their
  4008. offsets. A {@link PropertyListEntry} is "smaller" than another one if
  4009. its offset from the section's begin is smaller.
  4010. @see Comparable#CompareTo(java.lang.Object)
  4011. </member>
  4012. <member name="M:NPOI.HPSF.Section.GetProperty(System.Int64)">
  4013. Returns the value of the property with the specified ID. If
  4014. the property is not available, <c>null</c> is returned
  4015. and a subsequent call To {@link #wasNull} will return
  4016. <c>true</c>.
  4017. @param id The property's ID
  4018. @return The property's value
  4019. </member>
  4020. <member name="M:NPOI.HPSF.Section.GetPropertyIntValue(System.Int64)">
  4021. Returns the value of the numeric property with the specified
  4022. ID. If the property is not available, 0 is returned. A
  4023. subsequent call To {@link #wasNull} will return
  4024. <c>true</c> To let the caller distinguish that case from
  4025. a real property value of 0.
  4026. @param id The property's ID
  4027. @return The property's value
  4028. </member>
  4029. <member name="M:NPOI.HPSF.Section.GetPropertyBooleanValue(System.Int32)">
  4030. Returns the value of the bool property with the specified
  4031. ID. If the property is not available, <c>false</c> Is
  4032. returned. A subsequent call To {@link #wasNull} will return
  4033. <c>true</c> To let the caller distinguish that case from
  4034. a real property value of <c>false</c>.
  4035. @param id The property's ID
  4036. @return The property's value
  4037. </member>
  4038. <member name="F:NPOI.HPSF.Section.wasNull">
  4039. This member is <c>true</c> if the last call To {@link
  4040. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4041. property that was not available, else <c>false</c>.
  4042. </member>
  4043. <member name="P:NPOI.HPSF.Section.WasNull">
  4044. <summary>
  4045. Checks whether the property which the last call To {@link
  4046. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4047. was available or not. This information might be important for
  4048. callers of {@link #GetPropertyIntValue} since the latter
  4049. returns 0 if the property does not exist. Using {@link
  4050. #wasNull} the caller can distiguish this case from a property's
  4051. real value of 0.
  4052. </summary>
  4053. <value><c>true</c> if the last call To {@link
  4054. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4055. property that was not available; otherwise, <c>false</c>.</value>
  4056. </member>
  4057. <member name="M:NPOI.HPSF.Section.GetPIDString(System.Int64)">
  4058. <summary>
  4059. Returns the PID string associated with a property ID. The ID
  4060. is first looked up in the {@link Section}'s private
  4061. dictionary. If it is not found there, the method calls {@link
  4062. SectionIDMap#GetPIDString}.
  4063. </summary>
  4064. <param name="pid">The property ID.</param>
  4065. <returns>The property ID's string value</returns>
  4066. </member>
  4067. <member name="M:NPOI.HPSF.Section.Equals(System.Object)">
  4068. Checks whether this section is equal To another object. The result Is
  4069. <c>false</c> if one of the the following conditions holds:
  4070. <ul>
  4071. <li>The other object is not a {@link Section}.</li>
  4072. <li>The format IDs of the two sections are not equal.</li>
  4073. <li>The sections have a different number of properties. However,
  4074. properties with ID 1 (codepage) are not counted.</li>
  4075. <li>The other object is not a {@link Section}.</li>
  4076. <li>The properties have different values. The order of the properties
  4077. is irrelevant.</li>
  4078. </ul>
  4079. @param o The object To Compare this section with
  4080. @return <c>true</c> if the objects are equal, <c>false</c> if
  4081. not
  4082. </member>
  4083. <member name="M:NPOI.HPSF.Section.Remove(NPOI.HPSF.Property[],System.Int32)">
  4084. <summary>
  4085. Removes a field from a property array. The resulting array Is
  4086. compactified and returned.
  4087. </summary>
  4088. <param name="pa">The property array.</param>
  4089. <param name="i">The index of the field To be Removed.</param>
  4090. <returns>the compactified array.</returns>
  4091. </member>
  4092. <member name="M:NPOI.HPSF.Section.GetHashCode">
  4093. <summary>
  4094. Serves as a hash function for a particular type.
  4095. </summary>
  4096. <returns>
  4097. A hash code for the current <see cref="T:System.Object"/>.
  4098. </returns>
  4099. </member>
  4100. <member name="M:NPOI.HPSF.Section.ToString">
  4101. <summary>
  4102. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4103. </summary>
  4104. <returns>
  4105. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4106. </returns>
  4107. </member>
  4108. <member name="P:NPOI.HPSF.Section.Dictionary">
  4109. <summary>
  4110. Gets the section's dictionary. A dictionary allows an application To
  4111. use human-Readable property names instead of numeric property IDs. It
  4112. Contains mappings from property IDs To their associated string
  4113. values. The dictionary is stored as the property with ID 0. The codepage
  4114. for the strings in the dictionary is defined by property with ID 1.
  4115. </summary>
  4116. <value>the dictionary or null
  4117. if the section does not have
  4118. a dictionary.</value>
  4119. </member>
  4120. <member name="P:NPOI.HPSF.Section.Codepage">
  4121. <summary>
  4122. Gets the section's codepage, if any.
  4123. </summary>
  4124. <value>The section's codepage if one is defined, else -1.</value>
  4125. </member>
  4126. <member name="T:NPOI.HPSF.SpecialPropertySet">
  4127. <summary>
  4128. Abstract superclass for the convenience classes {@link
  4129. SummaryInformation} and {@link DocumentSummaryInformation}.
  4130. The motivation behind this class is quite nasty if you look
  4131. behind the scenes, but it serves the application programmer well by
  4132. providing him with the easy-to-use {@link SummaryInformation} and
  4133. {@link DocumentSummaryInformation} classes. When parsing the data a
  4134. property Set stream consists of (possibly coming from an {@link
  4135. java.io.Stream}) we want To Read and process each byte only
  4136. once. Since we don't know in advance which kind of property Set we
  4137. have, we can expect only the most general {@link
  4138. PropertySet}. Creating a special subclass should be as easy as
  4139. calling the special subclass' constructor and pass the general
  4140. {@link PropertySet} in. To make things easy internally, the special
  4141. class just holds a reference To the general {@link PropertySet} and
  4142. delegates all method calls To it.
  4143. A cleaner implementation would have been like this: The {@link
  4144. PropertySetFactory} parses the stream data into some internal
  4145. object first. Then it Finds out whether the stream is a {@link
  4146. SummaryInformation}, a {@link DocumentSummaryInformation} or a
  4147. general {@link PropertySet}. However, the current implementation
  4148. went the other way round historically: the convenience classes came
  4149. only late To my mind.
  4150. @author Rainer Klute
  4151. klute@rainer-klute.de
  4152. @since 2002-02-09
  4153. </summary>
  4154. </member>
  4155. <member name="P:NPOI.HPSF.SpecialPropertySet.PropertySetIDMap">
  4156. The id to name mapping of the properties
  4157. in this set.
  4158. </member>
  4159. <member name="F:NPOI.HPSF.SpecialPropertySet.delegate1">
  4160. The "real" property Set <c>SpecialPropertySet</c>
  4161. delegates To.
  4162. </member>
  4163. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.PropertySet)">
  4164. <summary>
  4165. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  4166. </summary>
  4167. <param name="ps">The property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  4168. </member>
  4169. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.MutablePropertySet)">
  4170. <summary>
  4171. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  4172. </summary>
  4173. <param name="ps">The mutable property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  4174. </member>
  4175. <member name="P:NPOI.HPSF.SpecialPropertySet.ByteOrder">
  4176. <summary>
  4177. gets or sets the "byteOrder" property.
  4178. </summary>
  4179. <value>the byteOrder value To Set</value>
  4180. </member>
  4181. <member name="P:NPOI.HPSF.SpecialPropertySet.Format">
  4182. <summary>
  4183. gets or sets the "format" property
  4184. </summary>
  4185. <value>the format value To Set</value>
  4186. </member>
  4187. <member name="P:NPOI.HPSF.SpecialPropertySet.ClassID">
  4188. <summary>
  4189. gets or sets the property Set stream's low-level "class ID"
  4190. field.
  4191. </summary>
  4192. <value>The property Set stream's low-level "class ID" field</value>
  4193. </member>
  4194. <member name="P:NPOI.HPSF.SpecialPropertySet.SectionCount">
  4195. <summary>
  4196. Returns the number of {@link Section}s in the property
  4197. Set.
  4198. </summary>
  4199. <value>The number of {@link Section}s in the property Set.</value>
  4200. </member>
  4201. <member name="P:NPOI.HPSF.SpecialPropertySet.IsSummaryInformation">
  4202. <summary>
  4203. Checks whether this {@link PropertySet} represents a Summary
  4204. Information.
  4205. </summary>
  4206. <value>
  4207. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  4208. Information; otherwise, <c>false</c>.
  4209. </value>
  4210. </member>
  4211. <member name="P:NPOI.HPSF.SpecialPropertySet.IsDocumentSummaryInformation">
  4212. <summary>
  4213. Gets a value indicating whether this instance is document summary information.
  4214. </summary>
  4215. <value>
  4216. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  4217. </value>
  4218. Checks whether this {@link PropertySet} is a Document
  4219. Summary Information.
  4220. @return
  4221. <c>true</c>
  4222. if this {@link PropertySet}
  4223. represents a Document Summary Information, else
  4224. <c>false</c>
  4225. </member>
  4226. <member name="P:NPOI.HPSF.SpecialPropertySet.FirstSection">
  4227. <summary>
  4228. Gets the PropertySet's first section.
  4229. </summary>
  4230. <value>The {@link PropertySet}'s first section.</value>
  4231. </member>
  4232. <member name="M:NPOI.HPSF.SpecialPropertySet.AddSection(NPOI.HPSF.Section)">
  4233. <summary>
  4234. Adds a section To this property set.
  4235. </summary>
  4236. <param name="section">The {@link Section} To Add. It will be Appended
  4237. after any sections that are alReady present in the property Set
  4238. and thus become the last section.</param>
  4239. </member>
  4240. <member name="M:NPOI.HPSF.SpecialPropertySet.ClearSections">
  4241. <summary>
  4242. Removes all sections from this property Set.
  4243. </summary>
  4244. </member>
  4245. <member name="P:NPOI.HPSF.SpecialPropertySet.OSVersion">
  4246. <summary>
  4247. gets or sets the "osVersion" property
  4248. </summary>
  4249. <value> the osVersion value To Set</value>
  4250. </member>
  4251. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  4252. <summary>
  4253. Writes a property Set To a document in a POI filesystem directory.
  4254. </summary>
  4255. <param name="dir">The directory in the POI filesystem To Write the document To</param>
  4256. <param name="name">The document's name. If there is alReady a document with the
  4257. same name in the directory the latter will be overwritten.</param>
  4258. </member>
  4259. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(System.IO.Stream)">
  4260. <summary>
  4261. Writes the property Set To an output stream.
  4262. </summary>
  4263. <param name="out1">the output stream To Write the section To</param>
  4264. </member>
  4265. <member name="M:NPOI.HPSF.SpecialPropertySet.Equals(System.Object)">
  4266. <summary>
  4267. Returns <c>true</c> if the <c>PropertySet</c> is equal
  4268. To the specified parameter, else <c>false</c>.
  4269. </summary>
  4270. <param name="o">the object To Compare this
  4271. <c>PropertySet</c>
  4272. with</param>
  4273. <returns>
  4274. <c>true</c>
  4275. if the objects are equal,
  4276. <c>false</c>
  4277. if not
  4278. </returns>
  4279. </member>
  4280. <member name="P:NPOI.HPSF.SpecialPropertySet.Properties">
  4281. <summary>
  4282. Convenience method returning the {@link Property} array
  4283. contained in this property Set. It is a shortcut for Getting
  4284. the {@link PropertySet}'s {@link Section}s list and then
  4285. Getting the {@link Property} array from the first {@link
  4286. Section}.
  4287. </summary>
  4288. <value>
  4289. The properties of the only {@link Section} of this
  4290. {@link PropertySet}.
  4291. </value>
  4292. </member>
  4293. <member name="M:NPOI.HPSF.SpecialPropertySet.GetProperty(System.Int32)">
  4294. <summary>
  4295. Convenience method returning the value of the property with
  4296. the specified ID. If the property is not available,
  4297. <c>null</c> is returned and a subsequent call To {@link
  4298. #WasNull} will return <c>true</c> .
  4299. </summary>
  4300. <param name="id">The property ID</param>
  4301. <returns>The property value</returns>
  4302. </member>
  4303. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyBooleanValue(System.Int32)">
  4304. <summary>
  4305. Convenience method returning the value of a bool property
  4306. with the specified ID. If the property is not available,
  4307. <c>false</c> is returned. A subsequent call To {@link
  4308. #WasNull} will return <c>true</c> To let the caller
  4309. distinguish that case from a real property value of
  4310. <c>false</c>.
  4311. </summary>
  4312. <param name="id">The property ID</param>
  4313. <returns>The property value</returns>
  4314. </member>
  4315. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyIntValue(System.Int32)">
  4316. <summary>
  4317. Convenience method returning the value of the numeric
  4318. property with the specified ID. If the property is not
  4319. available, 0 is returned. A subsequent call To {@link #WasNull}
  4320. will return <c>true</c> To let the caller distinguish
  4321. that case from a real property value of 0.
  4322. </summary>
  4323. <param name="id">The property ID</param>
  4324. <returns>The propertyIntValue value</returns>
  4325. </member>
  4326. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyStringValue(System.Int32)">
  4327. Fetches the property with the given ID, then does its
  4328. best to return it as a String
  4329. @return The property as a String, or null if unavailable
  4330. </member>
  4331. <member name="M:NPOI.HPSF.SpecialPropertySet.GetHashCode">
  4332. <summary>
  4333. Serves as a hash function for a particular type.
  4334. </summary>
  4335. <returns>
  4336. A hash code for the current <see cref="T:System.Object"/>.
  4337. </returns>
  4338. </member>
  4339. <member name="M:NPOI.HPSF.SpecialPropertySet.ToString">
  4340. <summary>
  4341. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4342. </summary>
  4343. <returns>
  4344. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4345. </returns>
  4346. </member>
  4347. <member name="P:NPOI.HPSF.SpecialPropertySet.WasNull">
  4348. <summary>
  4349. Checks whether the property which the last call To {@link
  4350. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4351. Was available or not. This information might be important for
  4352. callers of {@link #GetPropertyIntValue} since the latter
  4353. returns 0 if the property does not exist. Using {@link
  4354. #WasNull}, the caller can distiguish this case from a
  4355. property's real value of 0.
  4356. </summary>
  4357. <value>
  4358. <c>true</c> if the last call To {@link
  4359. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4360. property that Was not available; otherwise, <c>false</c>.
  4361. </value>
  4362. </member>
  4363. <member name="T:NPOI.HPSF.SummaryInformation">
  4364. <summary>
  4365. Convenience class representing a Summary Information stream in a
  4366. Microsoft Office document.
  4367. @author Rainer Klute
  4368. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4369. @see DocumentSummaryInformation
  4370. @since 2002-02-09
  4371. </summary>
  4372. </member>
  4373. <member name="F:NPOI.HPSF.SummaryInformation.DEFAULT_STREAM_NAME">
  4374. The document name a summary information stream usually has in a POIFS
  4375. filesystem.
  4376. </member>
  4377. <member name="M:NPOI.HPSF.SummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  4378. <summary>
  4379. Initializes a new instance of the <see cref="T:NPOI.HPSF.SummaryInformation"/> class.
  4380. </summary>
  4381. <param name="ps">A property Set which should be Created from a summary
  4382. information stream.</param>
  4383. </member>
  4384. <member name="P:NPOI.HPSF.SummaryInformation.Title">
  4385. <summary>
  4386. Gets or sets the title.
  4387. </summary>
  4388. <value>The title.</value>
  4389. </member>
  4390. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTitle">
  4391. <summary>
  4392. Removes the title.
  4393. </summary>
  4394. </member>
  4395. <member name="P:NPOI.HPSF.SummaryInformation.Subject">
  4396. <summary>
  4397. Gets or sets the subject.
  4398. </summary>
  4399. <value>The subject.</value>
  4400. </member>
  4401. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSubject">
  4402. <summary>
  4403. Removes the subject.
  4404. </summary>
  4405. </member>
  4406. <member name="P:NPOI.HPSF.SummaryInformation.Author">
  4407. <summary>
  4408. Gets or sets the author.
  4409. </summary>
  4410. <value>The author.</value>
  4411. </member>
  4412. <member name="M:NPOI.HPSF.SummaryInformation.RemoveAuthor">
  4413. <summary>
  4414. Removes the author.
  4415. </summary>
  4416. </member>
  4417. <member name="P:NPOI.HPSF.SummaryInformation.Keywords">
  4418. <summary>
  4419. Gets or sets the keywords.
  4420. </summary>
  4421. <value>The keywords.</value>
  4422. </member>
  4423. <member name="M:NPOI.HPSF.SummaryInformation.RemoveKeywords">
  4424. <summary>
  4425. Removes the keywords.
  4426. </summary>
  4427. </member>
  4428. <member name="P:NPOI.HPSF.SummaryInformation.Comments">
  4429. <summary>
  4430. Gets or sets the comments.
  4431. </summary>
  4432. <value>The comments.</value>
  4433. </member>
  4434. <member name="M:NPOI.HPSF.SummaryInformation.RemoveComments">
  4435. <summary>
  4436. Removes the comments.
  4437. </summary>
  4438. </member>
  4439. <member name="P:NPOI.HPSF.SummaryInformation.Template">
  4440. <summary>
  4441. Gets or sets the template.
  4442. </summary>
  4443. <value>The template.</value>
  4444. </member>
  4445. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTemplate">
  4446. <summary>
  4447. Removes the template.
  4448. </summary>
  4449. </member>
  4450. <member name="P:NPOI.HPSF.SummaryInformation.LastAuthor">
  4451. <summary>
  4452. Gets or sets the last author.
  4453. </summary>
  4454. <value>The last author.</value>
  4455. </member>
  4456. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastAuthor">
  4457. <summary>
  4458. Removes the last author.
  4459. </summary>
  4460. </member>
  4461. <member name="P:NPOI.HPSF.SummaryInformation.RevNumber">
  4462. <summary>
  4463. Gets or sets the rev number.
  4464. </summary>
  4465. <value>The rev number.</value>
  4466. </member>
  4467. <member name="M:NPOI.HPSF.SummaryInformation.RemoveRevNumber">
  4468. <summary>
  4469. Removes the rev number.
  4470. </summary>
  4471. </member>
  4472. <member name="P:NPOI.HPSF.SummaryInformation.EditTime">
  4473. <summary>
  4474. Returns the Total time spent in editing the document (or 0).
  4475. </summary>
  4476. <value>The Total time spent in editing the document or 0 if the {@link
  4477. SummaryInformation} does not contain this information.</value>
  4478. </member>
  4479. <member name="M:NPOI.HPSF.SummaryInformation.RemoveEditTime">
  4480. <summary>
  4481. Removes the edit time.
  4482. </summary>
  4483. </member>
  4484. <member name="P:NPOI.HPSF.SummaryInformation.LastPrinted">
  4485. <summary>
  4486. Gets or sets the last printed time
  4487. </summary>
  4488. <value>The last printed time</value>
  4489. Returns the last printed time (or <c>null</c>).
  4490. </member>
  4491. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastPrinted">
  4492. <summary>
  4493. Removes the last printed.
  4494. </summary>
  4495. </member>
  4496. <member name="P:NPOI.HPSF.SummaryInformation.CreateDateTime">
  4497. <summary>
  4498. Gets or sets the create date time.
  4499. </summary>
  4500. <value>The create date time.</value>
  4501. </member>
  4502. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCreateDateTime">
  4503. <summary>
  4504. Removes the create date time.
  4505. </summary>
  4506. </member>
  4507. <member name="P:NPOI.HPSF.SummaryInformation.LastSaveDateTime">
  4508. <summary>
  4509. Gets or sets the last save date time.
  4510. </summary>
  4511. <value>The last save date time.</value>
  4512. </member>
  4513. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastSaveDateTime">
  4514. <summary>
  4515. Removes the last save date time.
  4516. </summary>
  4517. </member>
  4518. <member name="P:NPOI.HPSF.SummaryInformation.PageCount">
  4519. <summary>
  4520. Gets or sets the page count or 0 if the {@link SummaryInformation} does
  4521. not contain a page count.
  4522. </summary>
  4523. <value>The page count or 0 if the {@link SummaryInformation} does not
  4524. contain a page count.</value>
  4525. </member>
  4526. <member name="M:NPOI.HPSF.SummaryInformation.RemovePageCount">
  4527. <summary>
  4528. Removes the page count.
  4529. </summary>
  4530. </member>
  4531. <member name="P:NPOI.HPSF.SummaryInformation.WordCount">
  4532. <summary>
  4533. Gets or sets the word count or 0 if the {@link SummaryInformation} does
  4534. not contain a word count.
  4535. </summary>
  4536. <value>The word count.</value>
  4537. </member>
  4538. <member name="M:NPOI.HPSF.SummaryInformation.RemoveWordCount">
  4539. <summary>
  4540. Removes the word count.
  4541. </summary>
  4542. </member>
  4543. <member name="P:NPOI.HPSF.SummaryInformation.CharCount">
  4544. <summary>
  4545. Gets or sets the character count or 0 if the {@link SummaryInformation}
  4546. does not contain a char count.
  4547. </summary>
  4548. <value>The character count.</value>
  4549. </member>
  4550. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCharCount">
  4551. <summary>
  4552. Removes the char count.
  4553. </summary>
  4554. </member>
  4555. <member name="P:NPOI.HPSF.SummaryInformation.Thumbnail">
  4556. <summary>
  4557. Gets or sets the thumbnail (or <c>null</c>) <strong>when this
  4558. method is implemented. Please note that the return type is likely To
  4559. Change!</strong>
  4560. <p>To process this data, you may wish to make use of the
  4561. {@link Thumbnail} class. The raw data is generally
  4562. an image in WMF or Clipboard (BMP?) format</p>
  4563. </summary>
  4564. <value>The thumbnail.</value>
  4565. </member>
  4566. <member name="P:NPOI.HPSF.SummaryInformation.ThumbnailThumbnail">
  4567. <summary>
  4568. Returns the thumbnail or null, processed as an object
  4569. which is (largely) able to unpack the thumbnail image data.
  4570. </summary>
  4571. </member>
  4572. <member name="M:NPOI.HPSF.SummaryInformation.RemoveThumbnail">
  4573. <summary>
  4574. Removes the thumbnail.
  4575. </summary>
  4576. </member>
  4577. <member name="P:NPOI.HPSF.SummaryInformation.ApplicationName">
  4578. <summary>
  4579. Gets or sets the name of the application.
  4580. </summary>
  4581. <value>The name of the application.</value>
  4582. </member>
  4583. <member name="M:NPOI.HPSF.SummaryInformation.RemoveApplicationName">
  4584. <summary>
  4585. Removes the name of the application.
  4586. </summary>
  4587. </member>
  4588. <member name="P:NPOI.HPSF.SummaryInformation.Security">
  4589. <summary>
  4590. Gets or sets a security code which is one of the following values:
  4591. <ul>
  4592. <li>0 if the {@link SummaryInformation} does not contain a
  4593. security field or if there is no security on the document. Use
  4594. {@link PropertySet#wasNull()} To distinguish between the two
  4595. cases!</li>
  4596. <li>1 if the document is password protected</li>
  4597. <li>2 if the document is Read-only recommended</li>
  4598. <li>4 if the document is Read-only enforced</li>
  4599. <li>8 if the document is locked for annotations</li>
  4600. </ul>
  4601. </summary>
  4602. <value>The security code</value>
  4603. </member>
  4604. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSecurity">
  4605. <summary>
  4606. Removes the security code.
  4607. </summary>
  4608. </member>
  4609. <member name="T:NPOI.HPSF.Thumbnail">
  4610. <summary>
  4611. Class To manipulate data in the Clipboard Variant (Variant#VT_CF VT_CF) format.
  4612. @author Drew Varner (Drew.Varner inOrAround sc.edu)
  4613. @since 2002-04-29
  4614. </summary>
  4615. </member>
  4616. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CFTAG">
  4617. <summary>
  4618. OffSet in bytes where the Clipboard Format Tag starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4619. </summary>
  4620. </member>
  4621. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CF">
  4622. <summary>
  4623. OffSet in bytes where the Clipboard Format starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4624. </summary>
  4625. <remarks>This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS</remarks>
  4626. </member>
  4627. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_WMFDATA">
  4628. <summary>
  4629. OffSet in bytes where the Windows Metafile (WMF) image data starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4630. There is only WMF data at this point in the
  4631. <c>byte[]</c> if the Clipboard Format Tag is
  4632. CFTAG_WINDOWS and the Clipboard Format is
  4633. CF_METAFILEPICT.
  4634. </summary>
  4635. <remarks>Note: The <c>byte[]</c> that starts at
  4636. <c>OFFSet_WMFDATA</c> and ends at
  4637. <c>GetThumbnail().Length - 1</c> forms a complete WMF
  4638. image. It can be saved To disk with a <c>.wmf</c> file
  4639. type and Read using a WMF-capable image viewer.</remarks>
  4640. </member>
  4641. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_WINDOWS">
  4642. <summary>
  4643. Clipboard Format Tag - Windows clipboard format
  4644. </summary>
  4645. <remarks>A <c>DWORD</c> indicating a built-in Windows clipboard format value</remarks>
  4646. </member>
  4647. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_MACINTOSH">
  4648. <summary>
  4649. Clipboard Format Tag - Macintosh clipboard format
  4650. </summary>
  4651. <remarks>A <c>DWORD</c> indicating a Macintosh clipboard format value</remarks>
  4652. </member>
  4653. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_FMTID">
  4654. <summary>
  4655. Clipboard Format Tag - Format ID
  4656. </summary>
  4657. <remarks>A GUID containing a format identifier (FMTID). This is rarely used.</remarks>
  4658. </member>
  4659. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_NODATA">
  4660. <summary>
  4661. Clipboard Format Tag - No Data
  4662. </summary>
  4663. <remarks>A <c>DWORD</c> indicating No data. This is rarely used.</remarks>
  4664. </member>
  4665. <member name="F:NPOI.HPSF.Thumbnail.CF_METAFILEPICT">
  4666. <summary>
  4667. Clipboard Format - Windows metafile format. This is the recommended way To store thumbnails in Property Streams.
  4668. </summary>
  4669. <remarks>Note:This is not the same format used in
  4670. regular WMF images. The clipboard version of this format has an
  4671. extra clipboard-specific header.</remarks>
  4672. </member>
  4673. <member name="F:NPOI.HPSF.Thumbnail.CF_DIB">
  4674. <summary>
  4675. Clipboard Format - Device Independent Bitmap
  4676. </summary>
  4677. </member>
  4678. <member name="F:NPOI.HPSF.Thumbnail.CF_ENHMETAFILE">
  4679. <summary>
  4680. Clipboard Format - Enhanced Windows metafile format
  4681. </summary>
  4682. </member>
  4683. <member name="F:NPOI.HPSF.Thumbnail.CF_BITMAP">
  4684. <summary>
  4685. Clipboard Format - Bitmap
  4686. </summary>
  4687. <remarks>see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</remarks>
  4688. </member>
  4689. <member name="F:NPOI.HPSF.Thumbnail.thumbnailData">
  4690. A <c>byte[]</c> To hold a thumbnail image in (
  4691. Variant#VT_CF VT_CF) format.
  4692. </member>
  4693. <member name="M:NPOI.HPSF.Thumbnail.#ctor">
  4694. <summary>
  4695. Default Constructor. If you use it then one you'll have To Add
  4696. the thumbnail <c>byte[]</c> from {@link
  4697. SummaryInformation#GetThumbnail()} To do any useful
  4698. manipulations, otherwise you'll Get a
  4699. <c>NullPointerException</c>.
  4700. </summary>
  4701. </member>
  4702. <member name="M:NPOI.HPSF.Thumbnail.#ctor(System.Byte[])">
  4703. <summary>
  4704. Initializes a new instance of the <see cref="T:NPOI.HPSF.Thumbnail"/> class.
  4705. </summary>
  4706. <param name="thumbnailData">The thumbnail data.</param>
  4707. </member>
  4708. <member name="P:NPOI.HPSF.Thumbnail.ThumbnailData">
  4709. <summary>
  4710. Gets or sets the thumbnail as a <c>byte[]</c> in {@link
  4711. Variant#VT_CF VT_CF} format.
  4712. </summary>
  4713. <value>The thumbnail value</value>
  4714. </member>
  4715. <member name="P:NPOI.HPSF.Thumbnail.ClipboardFormatTag">
  4716. <summary>
  4717. Returns an <c>int</c> representing the Clipboard
  4718. Format Tag
  4719. Possible return values are:
  4720. <ul>
  4721. <li>{@link #CFTAG_WINDOWS CFTAG_WINDOWS}</li>
  4722. <li>{@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}</li>
  4723. <li>{@link #CFTAG_FMTID CFTAG_FMTID}</li>
  4724. <li>{@link #CFTAG_NODATA CFTAG_NODATA}</li>
  4725. </ul>
  4726. </summary>
  4727. <returns>A flag indicating the Clipboard Format Tag</returns>
  4728. </member>
  4729. <member name="M:NPOI.HPSF.Thumbnail.GetClipboardFormat">
  4730. <summary>
  4731. Returns an <c>int</c> representing the Clipboard
  4732. Format
  4733. Will throw an exception if the Thumbnail's Clipboard Format
  4734. Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}.
  4735. Possible return values are:
  4736. <ul>
  4737. <li>{@link #CF_METAFILEPICT CF_METAFILEPICT}</li>
  4738. <li>{@link #CF_DIB CF_DIB}</li>
  4739. <li>{@link #CF_ENHMETAFILE CF_ENHMETAFILE}</li>
  4740. <li>{@link #CF_BITMAP CF_BITMAP}</li>
  4741. </ul>
  4742. </summary>
  4743. <returns>a flag indicating the Clipboard Format</returns>
  4744. </member>
  4745. <member name="M:NPOI.HPSF.Thumbnail.GetThumbnailAsWMF">
  4746. <summary>
  4747. Returns the Thumbnail as a <c>byte[]</c> of WMF data
  4748. if the Thumbnail's Clipboard Format Tag is {@link
  4749. #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is
  4750. {@link #CF_METAFILEPICT CF_METAFILEPICT}
  4751. This
  4752. <c>byte[]</c> is in the traditional WMF file, not the
  4753. clipboard-specific version with special headers.
  4754. See <a href="http://www.wvware.com/caolan/ora-wmf.html" tarGet="_blank">http://www.wvware.com/caolan/ora-wmf.html</a>
  4755. for more information on the WMF image format.
  4756. @return A WMF image of the Thumbnail
  4757. @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and
  4758. CF_METAFILEPICT
  4759. </summary>
  4760. <returns></returns>
  4761. </member>
  4762. <member name="T:NPOI.HPSF.TypeWriter">
  4763. <summary>
  4764. Class for writing little-endian data and more.
  4765. @author Rainer Klute
  4766. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4767. @since 2003-02-20
  4768. </summary>
  4769. </member>
  4770. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int16)">
  4771. <summary>
  4772. Writes a two-byte value (short) To an output stream.
  4773. </summary>
  4774. <param name="out1">The stream To Write To..</param>
  4775. <param name="n">The number of bytes that have been written.</param>
  4776. <returns></returns>
  4777. </member>
  4778. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int32)">
  4779. Writes a four-byte value To an output stream.
  4780. @param out The stream To Write To.
  4781. @param n The value To Write.
  4782. @exception IOException if an I/O error occurs
  4783. @return The number of bytes written To the output stream.
  4784. </member>
  4785. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.UInt32)">
  4786. Writes a four-byte value To an output stream.
  4787. @param out The stream To Write To.
  4788. @param n The value To Write.
  4789. @exception IOException if an I/O error occurs
  4790. @return The number of bytes written To the output stream.
  4791. </member>
  4792. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int64)">
  4793. Writes a eight-byte value To an output stream.
  4794. @param out The stream To Write To.
  4795. @param n The value To Write.
  4796. @exception IOException if an I/O error occurs
  4797. @return The number of bytes written To the output stream.
  4798. </member>
  4799. <member name="M:NPOI.HPSF.TypeWriter.WriteUShortToStream(System.IO.Stream,System.Int32)">
  4800. Writes an unsigned two-byte value To an output stream.
  4801. @param out The stream To Write To
  4802. @param n The value To Write
  4803. @exception IOException if an I/O error occurs
  4804. </member>
  4805. <member name="M:NPOI.HPSF.TypeWriter.WriteUIntToStream(System.IO.Stream,System.UInt32)">
  4806. Writes an unsigned four-byte value To an output stream.
  4807. @param out The stream To Write To.
  4808. @param n The value To Write.
  4809. @return The number of bytes that have been written To the output stream.
  4810. @exception IOException if an I/O error occurs
  4811. </member>
  4812. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.Util.ClassID)">
  4813. Writes a 16-byte {@link ClassID} To an output stream.
  4814. @param out The stream To Write To
  4815. @param n The value To Write
  4816. @return The number of bytes written
  4817. @exception IOException if an I/O error occurs
  4818. </member>
  4819. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.HPSF.Property[],System.Int32)">
  4820. Writes an array of {@link Property} instances To an output stream
  4821. according To the Horrible Property Format.
  4822. @param out The stream To Write To
  4823. @param properties The array To Write To the stream
  4824. @param codepage The codepage number To use for writing strings
  4825. @exception IOException if an I/O error occurs
  4826. @throws UnsupportedVariantTypeException if HPSF does not support some
  4827. variant type.
  4828. </member>
  4829. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Double)">
  4830. Writes a double value value To an output stream.
  4831. @param out The stream To Write To.
  4832. @param n The value To Write.
  4833. @exception IOException if an I/O error occurs
  4834. @return The number of bytes written To the output stream.
  4835. </member>
  4836. <member name="T:NPOI.HPSF.UnexpectedPropertySetTypeException">
  4837. <summary>
  4838. This exception is thrown if a certain type of property Set Is
  4839. expected (e.g. a Document Summary Information) but the provided
  4840. property Set is not of that type.
  4841. The constructors of this class are analogous To those of its
  4842. superclass and documented there.
  4843. @author Rainer Klute
  4844. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4845. @since 2002-02-09
  4846. </summary>
  4847. </member>
  4848. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor">
  4849. <summary>
  4850. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4851. </summary>
  4852. </member>
  4853. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String)">
  4854. <summary>
  4855. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4856. </summary>
  4857. <param name="msg">The message string.</param>
  4858. </member>
  4859. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.Exception)">
  4860. <summary>
  4861. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4862. </summary>
  4863. <param name="reason">The reason, i.e. a throwable that indirectly
  4864. caused this exception.</param>
  4865. </member>
  4866. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String,System.Exception)">
  4867. <summary>
  4868. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  4869. </summary>
  4870. <param name="msg">The message string.</param>
  4871. <param name="reason">The reason, i.e. a throwable that indirectly
  4872. caused this exception.</param>
  4873. </member>
  4874. <member name="T:NPOI.HPSF.UnsupportedVariantTypeException">
  4875. <summary>
  4876. This exception is thrown if HPSF encounters a variant type that isn't
  4877. supported yet. Although a variant type is unsupported the value can still be
  4878. retrieved using the {@link VariantTypeException#GetValue} method.
  4879. Obviously this class should disappear some day.
  4880. @author Rainer Klute
  4881. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4882. @since 2003-08-05
  4883. </summary>
  4884. </member>
  4885. <member name="M:NPOI.HPSF.UnsupportedVariantTypeException.#ctor(System.Int64,System.Object)">
  4886. <summary>
  4887. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnsupportedVariantTypeException"/> class.
  4888. </summary>
  4889. <param name="variantType">The unsupported variant type</param>
  4890. <param name="value">The value who's variant type is not yet supported</param>
  4891. </member>
  4892. <member name="T:NPOI.HPSF.Util">
  4893. <summary>
  4894. Provides various static utility methods.
  4895. @author Rainer Klute (klute@rainer-klute.de)
  4896. @since 2002-02-09
  4897. </summary>
  4898. </member>
  4899. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  4900. <summary>
  4901. Copies a part of a byte array into another byte array.
  4902. </summary>
  4903. <param name="src">The source byte array.</param>
  4904. <param name="srcOffSet">OffSet in the source byte array.</param>
  4905. <param name="Length">The number of bytes To Copy.</param>
  4906. <param name="dst">The destination byte array.</param>
  4907. <param name="dstOffSet">OffSet in the destination byte array.</param>
  4908. </member>
  4909. <member name="M:NPOI.HPSF.Util.Cat(System.Byte[][])">
  4910. <summary>
  4911. Concatenates the contents of several byte arrays into a
  4912. single one.
  4913. </summary>
  4914. <param name="byteArrays">The byte arrays To be conCatened.</param>
  4915. <returns>A new byte array containing the conCatenated byte arrays.</returns>
  4916. </member>
  4917. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32)">
  4918. <summary>
  4919. Copies bytes from a source byte array into a new byte
  4920. array.
  4921. </summary>
  4922. <param name="src">Copy from this byte array.</param>
  4923. <param name="offset">Start Copying here.</param>
  4924. <param name="Length">Copy this many bytes.</param>
  4925. <returns>The new byte array. Its Length is number of copied bytes.</returns>
  4926. </member>
  4927. <member name="F:NPOI.HPSF.Util.EPOCH_DIFF">
  4928. The difference between the Windows epoch (1601-01-01
  4929. 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in
  4930. milliseconds: 11644473600000L. (Use your favorite spReadsheet
  4931. program To verify the correctness of this value. By the way,
  4932. did you notice that you can tell from the epochs which
  4933. operating system is the modern one? :-))
  4934. </member>
  4935. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int32,System.Int32)">
  4936. <summary>
  4937. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  4938. FILETIME structure holds a DateTime and time associated with a
  4939. file. The structure identifies a 64-bit integer specifying the
  4940. number of 100-nanosecond intervals which have passed since
  4941. January 1, 1601. This 64-bit value is split into the two double
  4942. words stored in the structure.
  4943. </summary>
  4944. <param name="high">The higher double word of the FILETIME structure.</param>
  4945. <param name="low">The lower double word of the FILETIME structure.</param>
  4946. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  4947. </member>
  4948. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int64)">
  4949. <summary>
  4950. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  4951. FILETIME structure holds a DateTime and time associated with a
  4952. file. The structure identifies a 64-bit integer specifying the
  4953. number of 100-nanosecond intervals which have passed since
  4954. January 1, 1601.
  4955. </summary>
  4956. <param name="filetime">The filetime To Convert.</param>
  4957. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  4958. </member>
  4959. <member name="M:NPOI.HPSF.Util.DateToFileTime(System.DateTime)">
  4960. <summary>
  4961. Converts a {@link DateTime} into a filetime.
  4962. </summary>
  4963. <param name="dateTime">The DateTime To be Converted</param>
  4964. <returns>The filetime</returns>
  4965. </member>
  4966. <member name="M:NPOI.HPSF.Util.AreEqual(System.Collections.IList,System.Collections.IList)">
  4967. <summary>
  4968. Compares To object arrays with regarding the objects' order. For
  4969. example, [1, 2, 3] and [2, 1, 3] are equal.
  4970. </summary>
  4971. <param name="c1">The first object array.</param>
  4972. <param name="c2">The second object array.</param>
  4973. <returns><c>true</c>
  4974. if the object arrays are equal,
  4975. <c>false</c>
  4976. if they are not.</returns>
  4977. </member>
  4978. <member name="M:NPOI.HPSF.Util.internalEquals(System.Collections.IList,System.Collections.IList)">
  4979. <summary>
  4980. Internals the equals.
  4981. </summary>
  4982. <param name="c1">The c1.</param>
  4983. <param name="c2">The c2.</param>
  4984. <returns></returns>
  4985. </member>
  4986. <member name="M:NPOI.HPSF.Util.Pad4(System.Byte[])">
  4987. <summary>
  4988. Pads a byte array with 0x00 bytes so that its Length is a multiple of
  4989. 4.
  4990. </summary>
  4991. <param name="ba">The byte array To pad.</param>
  4992. <returns>The padded byte array.</returns>
  4993. </member>
  4994. <member name="M:NPOI.HPSF.Util.Pad4(System.Char[])">
  4995. <summary>
  4996. Pads a character array with 0x0000 characters so that its Length is a
  4997. multiple of 4.
  4998. </summary>
  4999. <param name="ca">The character array To pad.</param>
  5000. <returns>The padded character array.</returns>
  5001. </member>
  5002. <member name="M:NPOI.HPSF.Util.Pad4(System.String)">
  5003. <summary>
  5004. Pads a string with 0x0000 characters so that its Length is a
  5005. multiple of 4.
  5006. </summary>
  5007. <param name="s">The string To pad.</param>
  5008. <returns> The padded string as a character array.</returns>
  5009. </member>
  5010. <member name="T:NPOI.HPSF.Variant">
  5011. <summary>
  5012. The <em>Variant</em> types as defined by Microsoft's COM. I
  5013. found this information in <a href="http://www.marin.clara.net/COM/variant_type_definitions.htm">
  5014. http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.
  5015. In the variant types descriptions the following shortcuts are
  5016. used: <strong> [V]</strong> - may appear in a VARIANT,
  5017. <strong>[T]</strong> - may appear in a TYPEDESC,
  5018. <strong>[P]</strong> - may appear in an OLE property Set,
  5019. <strong>[S]</strong> - may appear in a Safe Array.
  5020. @author Rainer Klute (klute@rainer-klute.de)
  5021. @since 2002-02-09
  5022. </summary>
  5023. </member>
  5024. <member name="F:NPOI.HPSF.Variant.VT_EMPTY">
  5025. [V][P] Nothing, i.e. not a single byte of data.
  5026. </member>
  5027. <member name="F:NPOI.HPSF.Variant.VT_NULL">
  5028. [V][P] SQL style Null.
  5029. </member>
  5030. <member name="F:NPOI.HPSF.Variant.VT_I2">
  5031. [V][T][P][S] 2 byte signed int.
  5032. </member>
  5033. <member name="F:NPOI.HPSF.Variant.VT_I4">
  5034. [V][T][P][S] 4 byte signed int.
  5035. </member>
  5036. <member name="F:NPOI.HPSF.Variant.VT_R4">
  5037. [V][T][P][S] 4 byte real.
  5038. </member>
  5039. <member name="F:NPOI.HPSF.Variant.VT_R8">
  5040. [V][T][P][S] 8 byte real.
  5041. </member>
  5042. <member name="F:NPOI.HPSF.Variant.VT_CY">
  5043. [V][T][P][S] currency. <span style="background-color:
  5044. #ffff00">How long is this? How is it To be
  5045. interpreted?</span>
  5046. </member>
  5047. <member name="F:NPOI.HPSF.Variant.VT_DATE">
  5048. [V][T][P][S] DateTime. <span style="background-color:
  5049. #ffff00">How long is this? How is it To be
  5050. interpreted?</span>
  5051. </member>
  5052. <member name="F:NPOI.HPSF.Variant.VT_BSTR">
  5053. [V][T][P][S] OLE Automation string. <span
  5054. style="background-color: #ffff00">How long is this? How is it
  5055. To be interpreted?</span>
  5056. </member>
  5057. <member name="F:NPOI.HPSF.Variant.VT_DISPATCH">
  5058. [V][T][P][S] IDispatch *. <span style="background-color:
  5059. #ffff00">How long is this? How is it To be
  5060. interpreted?</span>
  5061. </member>
  5062. <member name="F:NPOI.HPSF.Variant.VT_ERROR">
  5063. [V][T][S] SCODE. <span style="background-color: #ffff00">How
  5064. long is this? How is it To be interpreted?</span>
  5065. </member>
  5066. <member name="F:NPOI.HPSF.Variant.VT_BOOL">
  5067. [V][T][P][S] True=-1, False=0.
  5068. </member>
  5069. <member name="F:NPOI.HPSF.Variant.VT_VARIANT">
  5070. [V][T][P][S] VARIANT *. <span style="background-color:
  5071. #ffff00">How long is this? How is it To be
  5072. interpreted?</span>
  5073. </member>
  5074. <member name="F:NPOI.HPSF.Variant.VT_UNKNOWN">
  5075. [V][T][S] IUnknown *. <span style="background-color:
  5076. #ffff00">How long is this? How is it To be
  5077. interpreted?</span>
  5078. </member>
  5079. <member name="F:NPOI.HPSF.Variant.VT_DECIMAL">
  5080. [V][T][S] 16 byte fixed point.
  5081. </member>
  5082. <member name="F:NPOI.HPSF.Variant.VT_I1">
  5083. [T] signed char.
  5084. </member>
  5085. <member name="F:NPOI.HPSF.Variant.VT_UI1">
  5086. [V][T][P][S] unsigned char.
  5087. </member>
  5088. <member name="F:NPOI.HPSF.Variant.VT_UI2">
  5089. [T][P] unsigned short.
  5090. </member>
  5091. <member name="F:NPOI.HPSF.Variant.VT_UI4">
  5092. [T][P] unsigned int.
  5093. </member>
  5094. <member name="F:NPOI.HPSF.Variant.VT_I8">
  5095. [T][P] signed 64-bit int.
  5096. </member>
  5097. <member name="F:NPOI.HPSF.Variant.VT_UI8">
  5098. [T][P] unsigned 64-bit int.
  5099. </member>
  5100. <member name="F:NPOI.HPSF.Variant.VT_INT">
  5101. [T] signed machine int.
  5102. </member>
  5103. <member name="F:NPOI.HPSF.Variant.VT_UINT">
  5104. [T] unsigned machine int.
  5105. </member>
  5106. <member name="F:NPOI.HPSF.Variant.VT_VOID">
  5107. [T] C style void.
  5108. </member>
  5109. <member name="F:NPOI.HPSF.Variant.VT_HRESULT">
  5110. [T] Standard return type. <span style="background-color:
  5111. #ffff00">How long is this? How is it To be
  5112. interpreted?</span>
  5113. </member>
  5114. <member name="F:NPOI.HPSF.Variant.VT_PTR">
  5115. [T] pointer type. <span style="background-color:
  5116. #ffff00">How long is this? How is it To be
  5117. interpreted?</span>
  5118. </member>
  5119. <member name="F:NPOI.HPSF.Variant.VT_SAFEARRAY">
  5120. [T] (use VT_ARRAY in VARIANT).
  5121. </member>
  5122. <member name="F:NPOI.HPSF.Variant.VT_CARRAY">
  5123. [T] C style array. <span style="background-color:
  5124. #ffff00">How long is this? How is it To be
  5125. interpreted?</span>
  5126. </member>
  5127. <member name="F:NPOI.HPSF.Variant.VT_USERDEFINED">
  5128. [T] user defined type. <span style="background-color:
  5129. #ffff00">How long is this? How is it To be
  5130. interpreted?</span>
  5131. </member>
  5132. <member name="F:NPOI.HPSF.Variant.VT_LPSTR">
  5133. [T][P] null terminated string.
  5134. </member>
  5135. <member name="F:NPOI.HPSF.Variant.VT_LPWSTR">
  5136. [T][P] wide (Unicode) null terminated string.
  5137. </member>
  5138. <member name="F:NPOI.HPSF.Variant.VT_FILETIME">
  5139. [P] FILETIME. The FILETIME structure holds a DateTime and time
  5140. associated with a file. The structure identifies a 64-bit
  5141. integer specifying the number of 100-nanosecond intervals which
  5142. have passed since January 1, 1601. This 64-bit value is split
  5143. into the two dwords stored in the structure.
  5144. </member>
  5145. <member name="F:NPOI.HPSF.Variant.VT_BLOB">
  5146. [P] Length prefixed bytes.
  5147. </member>
  5148. <member name="F:NPOI.HPSF.Variant.VT_STREAM">
  5149. [P] Name of the stream follows.
  5150. </member>
  5151. <member name="F:NPOI.HPSF.Variant.VT_STORAGE">
  5152. [P] Name of the storage follows.
  5153. </member>
  5154. <member name="F:NPOI.HPSF.Variant.VT_STREAMED_OBJECT">
  5155. [P] Stream Contains an object. <span
  5156. style="background-color: #ffff00"> How long is this? How is it
  5157. To be interpreted?</span>
  5158. </member>
  5159. <member name="F:NPOI.HPSF.Variant.VT_STORED_OBJECT">
  5160. [P] Storage Contains an object. <span
  5161. style="background-color: #ffff00"> How long is this? How is it
  5162. To be interpreted?</span>
  5163. </member>
  5164. <member name="F:NPOI.HPSF.Variant.VT_BLOB_OBJECT">
  5165. [P] Blob Contains an object. <span style="background-color:
  5166. #ffff00">How long is this? How is it To be
  5167. interpreted?</span>
  5168. </member>
  5169. <member name="F:NPOI.HPSF.Variant.VT_CF">
  5170. [P] Clipboard format. <span style="background-color:
  5171. #ffff00">How long is this? How is it To be
  5172. interpreted?</span>
  5173. </member>
  5174. <member name="F:NPOI.HPSF.Variant.VT_CLSID">
  5175. [P] A Class ID.
  5176. It consists of a 32 bit unsigned integer indicating the size
  5177. of the structure, a 32 bit signed integer indicating (Clipboard
  5178. Format Tag) indicating the type of data that it Contains, and
  5179. then a byte array containing the data.
  5180. The valid Clipboard Format Tags are:
  5181. <ul>
  5182. <li>{@link Thumbnail#CFTAG_WINDOWS}</li>
  5183. <li>{@link Thumbnail#CFTAG_MACINTOSH}</li>
  5184. <li>{@link Thumbnail#CFTAG_NODATA}</li>
  5185. <li>{@link Thumbnail#CFTAG_FMTID}</li>
  5186. </ul>
  5187. <pre>typedef struct tagCLIPDATA {
  5188. // cbSize is the size of the buffer pointed To
  5189. // by pClipData, plus sizeof(ulClipFmt)
  5190. ULONG cbSize;
  5191. long ulClipFmt;
  5192. BYTE* pClipData;
  5193. } CLIPDATA;</pre>
  5194. See <a
  5195. href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp"
  5196. tarGet="_blank">
  5197. msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.
  5198. </member>
  5199. <member name="F:NPOI.HPSF.Variant.VT_VERSIONED_STREAM">
  5200. "MUST be a VersionedStream. The storage representing the (non-simple)
  5201. property set MUST have a stream element with the name in the StreamName
  5202. field." -- [MS-OLEPS] -- v20110920; Object Linking and Embedding (OLE)
  5203. Property Set Data Structures; page 24 / 63
  5204. </member>
  5205. <member name="F:NPOI.HPSF.Variant.VT_VECTOR">
  5206. [P] simple counted array. <span style="background-color:
  5207. #ffff00">How long is this? How is it To be
  5208. interpreted?</span>
  5209. </member>
  5210. <member name="F:NPOI.HPSF.Variant.VT_ARRAY">
  5211. [V] SAFEARRAY*. <span style="background-color: #ffff00">How
  5212. long is this? How is it To be interpreted?</span>
  5213. </member>
  5214. <member name="F:NPOI.HPSF.Variant.VT_BYREF">
  5215. [V] void* for local use. <span style="background-color:
  5216. #ffff00">How long is this? How is it To be
  5217. interpreted?</span>
  5218. </member>
  5219. <member name="F:NPOI.HPSF.Variant.VT_RESERVED">
  5220. FIXME (3): Document this!
  5221. </member>
  5222. <member name="F:NPOI.HPSF.Variant.VT_ILLEGAL">
  5223. FIXME (3): Document this!
  5224. </member>
  5225. <member name="F:NPOI.HPSF.Variant.VT_ILLEGALMASKED">
  5226. FIXME (3): Document this!
  5227. </member>
  5228. <member name="F:NPOI.HPSF.Variant.VT_TYPEMASK">
  5229. FIXME (3): Document this!
  5230. </member>
  5231. <member name="F:NPOI.HPSF.Variant.numberToName">
  5232. Maps the numbers denoting the variant types To their corresponding
  5233. variant type names.
  5234. </member>
  5235. <member name="F:NPOI.HPSF.Variant.Length_UNKNOWN">
  5236. Denotes a variant type with a Length that is unknown To HPSF yet.
  5237. </member>
  5238. <member name="F:NPOI.HPSF.Variant.Length_VARIABLE">
  5239. Denotes a variant type with a variable Length.
  5240. </member>
  5241. <member name="F:NPOI.HPSF.Variant.Length_0">
  5242. Denotes a variant type with a Length of 0 bytes.
  5243. </member>
  5244. <member name="F:NPOI.HPSF.Variant.Length_2">
  5245. Denotes a variant type with a Length of 2 bytes.
  5246. </member>
  5247. <member name="F:NPOI.HPSF.Variant.Length_4">
  5248. Denotes a variant type with a Length of 4 bytes.
  5249. </member>
  5250. <member name="F:NPOI.HPSF.Variant.Length_8">
  5251. Denotes a variant type with a Length of 8 bytes.
  5252. </member>
  5253. <member name="M:NPOI.HPSF.Variant.GetVariantName(System.Int64)">
  5254. <summary>
  5255. Returns the variant type name associated with a variant type
  5256. number.
  5257. </summary>
  5258. <param name="variantType">The variant type number.</param>
  5259. <returns>The variant type name or the string "unknown variant type"</returns>
  5260. </member>
  5261. <member name="M:NPOI.HPSF.Variant.GetVariantLength(System.Int64)">
  5262. <summary>
  5263. Returns a variant type's Length.
  5264. </summary>
  5265. <param name="variantType">The variant type number.</param>
  5266. <returns>The Length of the variant type's data in bytes. If the Length Is
  5267. variable, i.e. the Length of a string, -1 is returned. If HPSF does not
  5268. know the Length, -2 is returned. The latter usually indicates an
  5269. unsupported variant type.</returns>
  5270. </member>
  5271. <member name="T:NPOI.HPSF.VariantSupport">
  5272. <summary>
  5273. Supports Reading and writing of variant data.
  5274. <strong>FIXME (3):</strong>
  5275. Reading and writing should be made more
  5276. uniform than it is now. The following items should be resolved:
  5277. Reading requires a Length parameter that is 4 byte greater than the
  5278. actual data, because the variant type field is included.
  5279. Reading Reads from a byte array while writing Writes To an byte array
  5280. output stream.
  5281. @author Rainer Klute
  5282. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5283. @since 2003-08-08
  5284. </summary>
  5285. </member>
  5286. <member name="P:NPOI.HPSF.VariantSupport.IsLogUnsupportedTypes">
  5287. <summary>
  5288. Checks whether logging of unsupported variant types warning is turned
  5289. on or off.
  5290. </summary>
  5291. <value>
  5292. <c>true</c> if logging is turned on; otherwise, <c>false</c>.
  5293. </value>
  5294. </member>
  5295. <member name="F:NPOI.HPSF.VariantSupport.unsupportedMessage">
  5296. Keeps a list of the variant types an "unsupported" message has alReady
  5297. been issued for.
  5298. </member>
  5299. <member name="M:NPOI.HPSF.VariantSupport.WriteUnsupportedTypeMessage(NPOI.HPSF.UnsupportedVariantTypeException)">
  5300. <summary>
  5301. Writes a warning To System.err that a variant type Is
  5302. unsupported by HPSF. Such a warning is written only once for each variant
  5303. type. Log messages can be turned on or off by
  5304. </summary>
  5305. <param name="ex">The exception To log</param>
  5306. </member>
  5307. <member name="F:NPOI.HPSF.VariantSupport.SUPPORTED_TYPES">
  5308. HPSF is able To Read these {@link Variant} types.
  5309. </member>
  5310. <member name="M:NPOI.HPSF.VariantSupport.IsSupportedType(System.Int32)">
  5311. <summary>
  5312. Checks whether HPSF supports the specified variant type. Unsupported
  5313. types should be implemented included in the {@link #SUPPORTED_TYPES}
  5314. array.
  5315. </summary>
  5316. <param name="variantType">the variant type To check</param>
  5317. <returns>
  5318. <c>true</c> if HPFS supports this type,otherwise, <c>false</c>.
  5319. </returns>
  5320. </member>
  5321. <member name="M:NPOI.HPSF.VariantSupport.Read(System.Byte[],System.Int32,System.Int32,System.Int64,System.Int32)">
  5322. <summary>
  5323. Reads a variant type from a byte array
  5324. </summary>
  5325. <param name="src">The byte array</param>
  5326. <param name="offset">The offset in the byte array where the variant starts</param>
  5327. <param name="length">The Length of the variant including the variant type field</param>
  5328. <param name="type">The variant type To Read</param>
  5329. <param name="codepage">The codepage To use for non-wide strings</param>
  5330. <returns>A Java object that corresponds best To the variant field. For
  5331. example, a VT_I4 is returned as a {@link long}, a VT_LPSTR as a
  5332. {@link String}.</returns>
  5333. </member>
  5334. <member name="M:NPOI.HPSF.VariantSupport.CodepageToEncoding(System.Int32)">
  5335. <p>Turns a codepage number into the equivalent character encoding's
  5336. name.</p>
  5337. @param codepage The codepage number
  5338. @return The character encoding's name. If the codepage number is 65001,
  5339. the encoding name is "UTF-8". All other positive numbers are mapped to
  5340. "cp" followed by the number, e.g. if the codepage number is 1252 the
  5341. returned character encoding name will be "cp1252".
  5342. @exception UnsupportedEncodingException if the specified codepage is
  5343. less than zero.
  5344. </member>
  5345. <member name="M:NPOI.HPSF.VariantSupport.Write(System.IO.Stream,System.Int64,System.Object,System.Int32)">
  5346. <summary>
  5347. Writes a variant value To an output stream. This method ensures that
  5348. always a multiple of 4 bytes is written.
  5349. If the codepage is UTF-16, which is encouraged, strings
  5350. <strong>must</strong> always be written as {@link Variant#VT_LPWSTR}
  5351. strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this
  5352. by Converting strings appropriately, if needed.
  5353. </summary>
  5354. <param name="out1">The stream To Write the value To.</param>
  5355. <param name="type">The variant's type.</param>
  5356. <param name="value">The variant's value.</param>
  5357. <param name="codepage">The codepage To use To Write non-wide strings</param>
  5358. <returns>The number of entities that have been written. In many cases an
  5359. "entity" is a byte but this is not always the case.</returns>
  5360. </member>
  5361. <member name="T:NPOI.HPSF.VariantTypeException">
  5362. <summary>
  5363. This exception is thrown if HPSF encounters a problem with a variant type.
  5364. Concrete subclasses specifiy the problem further.
  5365. @author Rainer Klute
  5366. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5367. @since 2004-06-21
  5368. </summary>
  5369. </member>
  5370. <member name="M:NPOI.HPSF.VariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  5371. <summary>
  5372. Initializes a new instance of the <see cref="T:NPOI.HPSF.VariantTypeException"/> class.
  5373. </summary>
  5374. <param name="variantType">The variant type causing the problem</param>
  5375. <param name="value">The value who's variant type causes the problem</param>
  5376. <param name="msg">A message text describing the problem</param>
  5377. </member>
  5378. <member name="P:NPOI.HPSF.VariantTypeException.VariantType">
  5379. <summary>
  5380. Gets the offending variant type
  5381. </summary>
  5382. <value>the offending variant type.</value>
  5383. </member>
  5384. <member name="P:NPOI.HPSF.VariantTypeException.Value">
  5385. <summary>
  5386. Returns the value who's variant type caused the problem.
  5387. </summary>
  5388. <value>the value who's variant type caused the problem.</value>
  5389. </member>
  5390. <member name="T:NPOI.HPSF.Wellknown.PropertyIDMap">
  5391. <summary>
  5392. This is a dictionary which maps property ID values To property
  5393. ID strings.
  5394. The methods {@link #GetSummaryInformationProperties} and {@link
  5395. #GetDocumentSummaryInformationProperties} return singleton {@link
  5396. PropertyIDMap}s. An application that wants To extend these maps
  5397. should treat them as unmodifiable, copy them and modifiy the
  5398. copies.
  5399. @author Rainer Klute
  5400. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5401. @since 2002-02-09
  5402. </summary>
  5403. </member>
  5404. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TITLE">
  5405. ID of the property that denotes the document's title
  5406. </member>
  5407. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SUBJECT">
  5408. ID of the property that denotes the document's subject
  5409. </member>
  5410. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_AUTHOR">
  5411. ID of the property that denotes the document's author
  5412. </member>
  5413. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_KEYWORDS">
  5414. ID of the property that denotes the document's keywords
  5415. </member>
  5416. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMMENTS">
  5417. ID of the property that denotes the document's comments
  5418. </member>
  5419. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TEMPLATE">
  5420. ID of the property that denotes the document's template
  5421. </member>
  5422. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTAUTHOR">
  5423. ID of the property that denotes the document's last author
  5424. </member>
  5425. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_REVNUMBER">
  5426. ID of the property that denotes the document's revision number
  5427. </member>
  5428. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_EDITTIME">
  5429. ID of the property that denotes the document's edit time
  5430. </member>
  5431. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTPRINTED">
  5432. ID of the property that denotes the DateTime and time the document was
  5433. last printed
  5434. </member>
  5435. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_Create_DTM">
  5436. ID of the property that denotes the DateTime and time the document was
  5437. Created.
  5438. </member>
  5439. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTSAVE_DTM">
  5440. ID of the property that denotes the DateTime and time the document was
  5441. saved
  5442. </member>
  5443. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PAGECOUNT">
  5444. ID of the property that denotes the number of pages in the
  5445. document
  5446. </member>
  5447. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_WORDCOUNT">
  5448. ID of the property that denotes the number of words in the
  5449. document
  5450. </member>
  5451. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CHARCOUNT">
  5452. ID of the property that denotes the number of characters in the
  5453. document
  5454. </member>
  5455. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_THUMBNAIL">
  5456. ID of the property that denotes the document's thumbnail
  5457. </member>
  5458. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_APPNAME">
  5459. ID of the property that denotes the application that Created the
  5460. document
  5461. </member>
  5462. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SECURITY">
  5463. ID of the property that denotes whether Read/Write access To the
  5464. document is allowed or whether is should be opened as Read-only. It can
  5465. have the following values:
  5466. <table>
  5467. <tbody>
  5468. <tr>
  5469. <th>Value</th>
  5470. <th>Description</th>
  5471. </tr>
  5472. <tr>
  5473. <th>0</th>
  5474. <th>No restriction</th>
  5475. </tr>
  5476. <tr>
  5477. <th>2</th>
  5478. <th>Read-only recommended</th>
  5479. </tr>
  5480. <tr>
  5481. <th>4</th>
  5482. <th>Read-only enforced</th>
  5483. </tr>
  5484. </tbody>
  5485. </table>
  5486. </member>
  5487. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DICTIONARY">
  5488. The entry is a dictionary.
  5489. </member>
  5490. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CODEPAGE">
  5491. The entry denotes a code page.
  5492. </member>
  5493. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CATEGORY">
  5494. The entry is a string denoting the category the file belongs
  5495. To, e.g. review, memo, etc. This is useful To Find documents of
  5496. same type.
  5497. </member>
  5498. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PRESFORMAT">
  5499. TarGet format for power point presentation, e.g. 35mm,
  5500. printer, video etc.
  5501. </member>
  5502. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_BYTECOUNT">
  5503. Number of bytes.
  5504. </member>
  5505. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINECOUNT">
  5506. Number of lines.
  5507. </member>
  5508. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PARCOUNT">
  5509. Number of paragraphs.
  5510. </member>
  5511. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SLIDECOUNT">
  5512. Number of slides in a power point presentation.
  5513. </member>
  5514. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_NOTECOUNT">
  5515. Number of slides with notes.
  5516. </member>
  5517. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HIDDENCOUNT">
  5518. Number of hidden slides.
  5519. </member>
  5520. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MMCLIPCOUNT">
  5521. Number of multimedia clips, e.g. sound or video.
  5522. </member>
  5523. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SCALE">
  5524. This entry is Set To -1 when scaling of the thumbnail Is
  5525. desired. Otherwise the thumbnail should be cropped.
  5526. </member>
  5527. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HEADINGPAIR">
  5528. This entry denotes an internally used property. It is a
  5529. vector of variants consisting of pairs of a string (VT_LPSTR)
  5530. and a number (VT_I4). The string is a heading name, and the
  5531. number tells how many document parts are under that
  5532. heading.
  5533. </member>
  5534. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCPARTS">
  5535. This entry Contains the names of document parts (word: names
  5536. of the documents in the master document, excel: sheet names,
  5537. power point: slide titles, binder: document names).
  5538. </member>
  5539. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MANAGER">
  5540. This entry Contains the name of the project manager.
  5541. </member>
  5542. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMPANY">
  5543. This entry Contains the company name.
  5544. </member>
  5545. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINKSDIRTY">
  5546. If this entry is -1 the links are dirty and should be
  5547. re-evaluated.
  5548. </member>
  5549. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CCHWITHSPACES">
  5550. The entry specifies an estimate of the number of characters
  5551. in the document, including whitespace, as an integer
  5552. </member>
  5553. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HYPERLINKSCHANGED">
  5554. This entry contains a boolean which marks if the User Defined
  5555. Property Set has been updated outside of the Application, if so the
  5556. hyperlinks should be updated on document load.
  5557. </member>
  5558. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_VERSION">
  5559. This entry contains the version of the Application which wrote the
  5560. Property set, stored with the two high order bytes having the major
  5561. version number, and the two low order bytes the minor version number.
  5562. </member>
  5563. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DIGSIG">
  5564. This entry contains the VBA digital signature for the VBA project
  5565. embedded in the document.
  5566. </member>
  5567. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CONTENTTYPE">
  5568. This entry contains a string of the content type of the file.
  5569. </member>
  5570. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CONTENTSTATUS">
  5571. This entry contains a string of the document status.
  5572. </member>
  5573. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LANGUAGE">
  5574. This entry contains a string of the document language, but
  5575. normally should be empty.
  5576. </member>
  5577. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCVERSION">
  5578. This entry contains a string of the document version, but
  5579. normally should be empty
  5580. </member>
  5581. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MAX">
  5582. <p>The highest well-known property ID. Applications are free to use
  5583. higher values for custom purposes. (This value is based on Office 12,
  5584. earlier versions of Office had lower values)</p>
  5585. </member>
  5586. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.summaryInformationProperties">
  5587. Contains the summary information property ID values and
  5588. associated strings. See the overall HPSF documentation for
  5589. details!
  5590. </member>
  5591. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.documentSummaryInformationProperties">
  5592. Contains the summary information property ID values and
  5593. associated strings. See the overall HPSF documentation for
  5594. details!
  5595. </member>
  5596. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Int32,System.Single)">
  5597. <summary>
  5598. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5599. </summary>
  5600. <param name="initialCapacity">initialCapacity The initial capacity as defined for
  5601. {@link HashMap}</param>
  5602. <param name="loadFactor">The load factor as defined for {@link HashMap}</param>
  5603. </member>
  5604. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Collections.IDictionary)">
  5605. <summary>
  5606. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5607. </summary>
  5608. <param name="map">The instance To be Created is backed by this map.</param>
  5609. </member>
  5610. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Put(System.Int64,System.String)">
  5611. <summary>
  5612. Puts a ID string for an ID into the {@link
  5613. PropertyIDMap}.
  5614. </summary>
  5615. <param name="id">The ID string.</param>
  5616. <param name="idString">The id string.</param>
  5617. <returns>As specified by the {@link java.util.Map} interface, this method
  5618. returns the previous value associated with the specified id</returns>
  5619. </member>
  5620. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Get(System.Int64)">
  5621. <summary>
  5622. Gets the ID string for an ID from the {@link
  5623. PropertyIDMap}.
  5624. </summary>
  5625. <param name="id">The ID.</param>
  5626. <returns>The ID string associated with id</returns>
  5627. </member>
  5628. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.SummaryInformationProperties">
  5629. <summary>
  5630. Gets the Summary Information properties singleton
  5631. </summary>
  5632. <returns></returns>
  5633. </member>
  5634. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.DocumentSummaryInformationProperties">
  5635. <summary>
  5636. Gets the Document Summary Information properties
  5637. singleton.
  5638. </summary>
  5639. <returns>The Document Summary Information properties singleton.</returns>
  5640. </member>
  5641. <member name="T:NPOI.HPSF.Wellknown.SectionIDMap">
  5642. <summary>
  5643. Maps section format IDs To {@link PropertyIDMap}s. It Is
  5644. initialized with two well-known section format IDs: those of the
  5645. <c>\005SummaryInformation</c> stream and the
  5646. <c>\005DocumentSummaryInformation</c> stream.
  5647. If you have a section format ID you can use it as a key To query
  5648. this map. If you Get a {@link PropertyIDMap} returned your section
  5649. is well-known and you can query the {@link PropertyIDMap} for PID
  5650. strings. If you Get back <c>null</c> you are on your own.
  5651. This {@link java.util.Map} expects the byte arrays of section format IDs
  5652. as keys. A key maps To a {@link PropertyIDMap} describing the
  5653. property IDs in sections with the specified section format ID.
  5654. @author Rainer Klute (klute@rainer-klute.de)
  5655. @since 2002-02-09
  5656. </summary>
  5657. </member>
  5658. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.SUMMARY_INFORMATION_ID">
  5659. The SummaryInformation's section's format ID.
  5660. </member>
  5661. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID1">
  5662. The DocumentSummaryInformation's first and second sections' format
  5663. ID.
  5664. </member>
  5665. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.UNDEFINED">
  5666. A property without a known name is described by this string.
  5667. </member>
  5668. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.defaultMap">
  5669. The default section ID map. It maps section format IDs To
  5670. {@link PropertyIDMap}s.
  5671. </member>
  5672. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetInstance">
  5673. <summary>
  5674. Returns the singleton instance of the default {@link
  5675. SectionIDMap}.
  5676. </summary>
  5677. <returns>The instance value</returns>
  5678. </member>
  5679. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetPIDString(System.Byte[],System.Int64)">
  5680. <summary>
  5681. Returns the property ID string that is associated with a
  5682. given property ID in a section format ID's namespace.
  5683. </summary>
  5684. <param name="sectionFormatID">Each section format ID has its own name
  5685. space of property ID strings and thus must be specified.</param>
  5686. <param name="pid">The property ID</param>
  5687. <returns>The well-known property ID string associated with the
  5688. property ID pid in the name space spanned by sectionFormatID If the pid
  5689. sectionFormatID combination is not well-known, the
  5690. string "[undefined]" is returned.
  5691. </returns>
  5692. </member>
  5693. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Byte[])">
  5694. <summary>
  5695. Returns the {@link PropertyIDMap} for a given section format
  5696. ID.
  5697. </summary>
  5698. <param name="sectionFormatID">The section format ID.</param>
  5699. <returns>the property ID map</returns>
  5700. </member>
  5701. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Byte[],NPOI.HPSF.Wellknown.PropertyIDMap)">
  5702. <summary>
  5703. Associates a section format ID with a {@link
  5704. PropertyIDMap}.
  5705. </summary>
  5706. <param name="sectionFormatID">the section format ID</param>
  5707. <param name="propertyIDMap">The property ID map.</param>
  5708. <returns></returns>
  5709. </member>
  5710. <member name="T:NPOI.HPSF.WritingNotSupportedException">
  5711. <summary>
  5712. This exception is thrown when trying To Write a (yet) unsupported variant
  5713. type.
  5714. @see ReadingNotSupportedException
  5715. @see UnsupportedVariantTypeException
  5716. @author Rainer Klute
  5717. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5718. @since 2003-08-08
  5719. </summary>
  5720. </member>
  5721. <member name="M:NPOI.HPSF.WritingNotSupportedException.#ctor(System.Int64,System.Object)">
  5722. <summary>
  5723. Initializes a new instance of the <see cref="T:NPOI.HPSF.WritingNotSupportedException"/> class.
  5724. </summary>
  5725. <param name="variantType">The unsupported variant type.</param>
  5726. <param name="value">The value</param>
  5727. </member>
  5728. <member name="T:NPOI.HSSF.Extractor.OldExcelExtractor">
  5729. A text extractor for old Excel files, which are too old for
  5730. HSSFWorkbook to handle. This includes Excel 95, and very old
  5731. (pre-OLE2) Excel files, such as Excel 4 files.
  5732. <p>
  5733. Returns much (but not all) of the textual content of the file,
  5734. suitable for indexing by something like Apache Lucene, or used
  5735. by Apache Tika, but not really intended for display to the user.
  5736. </p>
  5737. </member>
  5738. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.BiffVersion">
  5739. The Biff version, largely corresponding to the Excel version
  5740. </member>
  5741. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.FileType">
  5742. The kind of the file, one of {@link BOFRecord#TYPE_WORKSHEET},
  5743. {@link BOFRecord#TYPE_CHART}, {@link BOFRecord#TYPE_EXCEL_4_MACRO}
  5744. or {@link BOFRecord#TYPE_WORKSPACE_FILE}
  5745. </member>
  5746. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.Text">
  5747. Retrieves the text contents of the file, as best we can
  5748. for these old file formats
  5749. </member>
  5750. <member name="T:NPOI.HSSF.Extractor.EventBasedExcelExtractor">
  5751. <summary>
  5752. A text extractor for Excel files, that is based
  5753. on the hssf eventusermodel api.
  5754. It will typically use less memory than
  5755. ExcelExtractor, but may not provide
  5756. the same richness of formatting.
  5757. Returns the textual content of the file, suitable for
  5758. indexing by something like Lucene, but not really
  5759. intended for display to the user.
  5760. </summary>
  5761. </member>
  5762. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.DocSummaryInformation">
  5763. <summary>
  5764. Would return the document information metadata for the document,
  5765. if we supported it
  5766. </summary>
  5767. <value>The doc summary information.</value>
  5768. </member>
  5769. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.SummaryInformation">
  5770. <summary>
  5771. Would return the summary information metadata for the document,
  5772. if we supported it
  5773. </summary>
  5774. <value>The summary information.</value>
  5775. </member>
  5776. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.IncludeSheetNames">
  5777. <summary>
  5778. Should sheet names be included? Default is true
  5779. </summary>
  5780. <value>if set to <c>true</c> [include sheet names].</value>
  5781. </member>
  5782. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.FormulasNotResults">
  5783. <summary>
  5784. Should we return the formula itself, and not
  5785. the result it produces? Default is false
  5786. </summary>
  5787. <value>if set to <c>true</c> [formulas not results].</value>
  5788. </member>
  5789. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.Text">
  5790. <summary>
  5791. Retreives the text contents of the file
  5792. </summary>
  5793. <value>All the text from the document.</value>
  5794. </member>
  5795. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TriggerExtraction">
  5796. <summary>
  5797. Triggers the extraction.
  5798. </summary>
  5799. <returns></returns>
  5800. </member>
  5801. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  5802. <summary>
  5803. Process an HSSF Record. Called when a record occurs in an HSSF file.
  5804. </summary>
  5805. <param name="record"></param>
  5806. </member>
  5807. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface,System.Double)">
  5808. <summary>
  5809. Formats a number or date cell, be that a real number, or the
  5810. answer to a formula
  5811. </summary>
  5812. <param name="cell">The cell.</param>
  5813. <param name="value">The value.</param>
  5814. <returns></returns>
  5815. </member>
  5816. <member name="T:NPOI.HSSF.Extractor.ExcelExtractor">
  5817. <summary>
  5818. A text extractor for Excel files.
  5819. Returns the textual content of the file, suitable for
  5820. indexing by something like Lucene, but not really
  5821. intended for display to the user.
  5822. </summary>
  5823. </member>
  5824. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  5825. <summary>
  5826. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  5827. </summary>
  5828. <param name="wb">The wb.</param>
  5829. </member>
  5830. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  5831. <summary>
  5832. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  5833. </summary>
  5834. <param name="fs">The fs.</param>
  5835. </member>
  5836. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeHeaderFooter">
  5837. <summary>
  5838. Should header and footer be included? Default is true
  5839. </summary>
  5840. </member>
  5841. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeSheetNames">
  5842. <summary>
  5843. Should sheet names be included? Default is true
  5844. </summary>
  5845. <value>if set to <c>true</c> [include sheet names].</value>
  5846. </member>
  5847. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.FormulasNotResults">
  5848. <summary>
  5849. Should we return the formula itself, and not
  5850. the result it produces? Default is false
  5851. </summary>
  5852. <value>if set to <c>true</c> [formulas not results].</value>
  5853. </member>
  5854. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeCellComments">
  5855. <summary>
  5856. Should cell comments be included? Default is false
  5857. </summary>
  5858. <value>if set to <c>true</c> [include cell comments].</value>
  5859. </member>
  5860. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeBlankCells">
  5861. <summary>
  5862. Should blank cells be output? Default is to only
  5863. output cells that are present in the file and are
  5864. non-blank.
  5865. </summary>
  5866. <value>if set to <c>true</c> [include blank cells].</value>
  5867. </member>
  5868. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.Text">
  5869. <summary>
  5870. Retreives the text contents of the file
  5871. </summary>
  5872. <value>All the text from the document.</value>
  5873. </member>
  5874. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.ExtractHeaderFooter(NPOI.SS.UserModel.IHeaderFooter)">
  5875. <summary>
  5876. Extracts the header footer.
  5877. </summary>
  5878. <param name="hf">The header or footer</param>
  5879. <returns></returns>
  5880. </member>
  5881. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AttachedLabelAggregate">
  5882. <summary>
  5883. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  5884. AI = BRAI [SeriesText]
  5885. </summary>
  5886. </member>
  5887. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxesAggregate">
  5888. <summary>
  5889. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  5890. </summary>
  5891. </member>
  5892. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxisParentAggregate">
  5893. <summary>
  5894. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  5895. </summary>
  5896. </member>
  5897. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXMAggregate">
  5898. <summary>
  5899. AXM = YMult StartObject ATTACHEDLABEL EndObject
  5900. </summary>
  5901. </member>
  5902. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXSAggregate">
  5903. <summary>
  5904. AXS = [IFmtRecord] [Tick] [FontX] *4(AxisLine LineFormat) [AreaFormat]
  5905. [GELFRAME] *4SHAPEPROPS [TextPropsStream *ContinueFrt12]
  5906. </summary>
  5907. </member>
  5908. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartFormatsAggregate">
  5909. <summary>
  5910. CHARTFOMATS = Chart Begin *2FONTLIST Scl PlotGrowth [FRAME] *SERIESFORMAT *SS ShtProps
  5911. *2DFTTEXT AxesUsed 1*2AXISPARENT [CrtLayout12A] [DAT] *ATTACHEDLABEL [CRTMLFRT]
  5912. *([DataLabExt StartObject] ATTACHEDLABEL [EndObject]) [TEXTPROPS] *2CRTMLFRT End
  5913. </summary>
  5914. </member>
  5915. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate">
  5916. <summary>
  5917. CHARTSHEET = BOF CHARTSHEETCONTENT
  5918. CHARTSHEETCONTENT = [WriteProtect] [SheetExt] [WebPub] *HFPicture PAGESETUP PrintSize
  5919. [HeaderFooter] [BACKGROUND] *Fbi *Fbi2 [ClrtClient] [PROTECTION] [Palette] [SXViewLink]
  5920. [PivotChartBits] [SBaseRef] [MsoDrawingGroup] OBJECTS Units CHARTFOMATS SERIESDATA
  5921. *WINDOW *CUSTOMVIEW [CodeName] [CRTMLFRT] EOF
  5922. </summary>
  5923. </member>
  5924. <member name="F:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate._recs">
  5925. All the records between BOF and EOF
  5926. </member>
  5927. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CRTAggregate">
  5928. <summary>
  5929. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar /
  5930. RadarArea / Surf) CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat)
  5931. *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  5932. </summary>
  5933. </member>
  5934. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CrtMlFrtAggregate">
  5935. <summary>
  5936. CRTMLFRT = CrtMlFrt *CrtMlFrtContinue
  5937. </summary>
  5938. </member>
  5939. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DatAggregate">
  5940. <summary>
  5941. DAT = Dat Begin LD End
  5942. </summary>
  5943. </member>
  5944. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DFTTextAggregate">
  5945. <summary>
  5946. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  5947. </summary>
  5948. </member>
  5949. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DropBarAggregate">
  5950. <summary>
  5951. DROPBAR = DropBar Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  5952. </summary>
  5953. </member>
  5954. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DVAxisAggregate">
  5955. <summary>
  5956. DVAXIS = Axis Begin [ValueRange] [AXM] AXS [CRTMLFRT] End
  5957. </summary>
  5958. </member>
  5959. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FontListAggregate">
  5960. <summary>
  5961. FONTLIST = FrtFontList StartObject *(Font [Fbi]) EndObject
  5962. </summary>
  5963. </member>
  5964. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FrameAggregate">
  5965. <summary>
  5966. FRAME = Frame Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  5967. </summary>
  5968. </member>
  5969. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.GelFrameAggregate">
  5970. <summary>
  5971. GELFRAME = 1*2GelFrame *Continue [PICF]
  5972. PICF = Begin PicF End
  5973. </summary>
  5974. </member>
  5975. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.IVAxisAggregate">
  5976. <summary>
  5977. IVAXIS = Axis Begin [CatSerRange] AxcExt [CatLab] AXS [CRTMLFRT] End
  5978. </summary>
  5979. </member>
  5980. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.LDAggregate">
  5981. <summary>
  5982. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  5983. </summary>
  5984. </member>
  5985. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesAxisAggregate">
  5986. <summary>
  5987. SERIESAXIS = Axis Begin [CatSerRange] AXS [CRTMLFRT] End
  5988. </summary>
  5989. </member>
  5990. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesDataAggregate">
  5991. <summary>
  5992. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  5993. </summary>
  5994. </member>
  5995. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate">
  5996. <summary>
  5997. SERIESFORMAT = Series Begin 4AI *SS (SerToCrt / (SerParent (SerAuxTrend / SerAuxErrBar)))
  5998. *(LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]) End
  5999. </summary>
  6000. </member>
  6001. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate.LegendExceptionAggregate">
  6002. <summary>
  6003. LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]
  6004. </summary>
  6005. </member>
  6006. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ShapePropsAggregate">
  6007. <summary>
  6008. SHAPEPROPS = ShapePropsStream *ContinueFrt12
  6009. </summary>
  6010. </member>
  6011. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SSAggregate">
  6012. <summary>
  6013. SS = DataFormat Begin [Chart3DBarShape] [LineFormat AreaFormat PieFormat] [SerFmt]
  6014. [GELFRAME] [MarkerFormat] [AttachedLabel] *2SHAPEPROPS [CRTMLFRT] End
  6015. </summary>
  6016. </member>
  6017. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.TextPropsAggregate">
  6018. <summary>
  6019. TEXTPROPS = (RichTextStream / TextPropsStream) *ContinueFrt12
  6020. </summary>
  6021. </member>
  6022. <member name="T:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate">
  6023. Manages the all the records associated with a chart sub-stream.<br/>
  6024. Includes the Initial {@link BOFRecord} and {@link EOFRecord}.
  6025. @author Josh Micich
  6026. </member>
  6027. <member name="F:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate._recs">
  6028. All the records between BOF and EOF
  6029. </member>
  6030. <member name="T:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock">
  6031. Groups the sheet protection records for a worksheet.
  6032. <p/>
  6033. See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook
  6034. (BIFF5-BIFF8)'
  6035. @author Josh Micich
  6036. </member>
  6037. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.#ctor">
  6038. Creates an empty WorksheetProtectionBlock
  6039. </member>
  6040. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.IsComponentRecord(System.Int32)">
  6041. @return <c>true</c> if the specified Record sid is one belonging to
  6042. the 'Page Settings Block'.
  6043. </member>
  6044. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.AddRecords(NPOI.HSSF.Model.RecordStream)">
  6045. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream
  6046. until the first non-WorksheetProtectionBlock record is encountered. As each record is Read,
  6047. it is incorporated into this WorksheetProtectionBlock.
  6048. <p/>
  6049. As per the OOO documentation, the protection block records can be expected to be written
  6050. toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009)
  6051. didn't do this. Workbooks with sheet protection Created by those earlier POI versions
  6052. seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files
  6053. with non continuous worksheet protection blocks.
  6054. <p/>
  6055. <b>Note</b> - when POI Writes out this WorksheetProtectionBlock, the records will always be
  6056. written in one consolidated block (in the standard ordering) regardless of how scattered the
  6057. records were when they were originally Read.
  6058. </member>
  6059. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Protect">
  6060. <summary>
  6061. the ProtectRecord. If one is not contained in the sheet, then one is created.
  6062. </summary>
  6063. </member>
  6064. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Password">
  6065. <summary>
  6066. the PasswordRecord. If one is not Contained in the sheet, then one is Created.
  6067. </summary>
  6068. </member>
  6069. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.ProtectSheet(System.String,System.Boolean,System.Boolean)">
  6070. <summary>
  6071. protect a spreadsheet with a password (not encrypted, just sets protect flags and the password.)
  6072. </summary>
  6073. <param name="password">password to set;Pass <code>null</code> to remove all protection</param>
  6074. <param name="shouldProtectObjects">shouldProtectObjects are protected</param>
  6075. <param name="shouldProtectScenarios">shouldProtectScenarios are protected</param>
  6076. </member>
  6077. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateObjectProtect">
  6078. <summary>
  6079. Creates an ObjectProtect record with protect set to false.
  6080. </summary>
  6081. <returns></returns>
  6082. </member>
  6083. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateScenarioProtect">
  6084. <summary>
  6085. Creates a ScenarioProtect record with protect set to false.
  6086. </summary>
  6087. <returns></returns>
  6088. </member>
  6089. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreatePassword">
  6090. <summary>
  6091. Creates a Password record with password set to 0x0000.
  6092. </summary>
  6093. <returns></returns>
  6094. </member>
  6095. <member name="T:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate">
  6096. <summary>
  6097. </summary>
  6098. CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord
  6099. and number of up to three CFRuleRecord records toGether to simplify
  6100. access to them.
  6101. @author Dmitriy Kumshayev
  6102. </member>
  6103. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.MAX_97_2003_CONDTIONAL_FORMAT_RULES">
  6104. Excel allows up to 3 conditional formating rules
  6105. </member>
  6106. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.rules">
  6107. List of CFRuleRecord objects
  6108. </member>
  6109. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(NPOI.HSSF.Model.RecordStream)">
  6110. <summary>
  6111. Create CFRecordsAggregate from a list of CF Records
  6112. </summary>
  6113. <param name="rs">list of Record objects</param>
  6114. </member>
  6115. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(System.Collections.IList,System.Int32)">
  6116. <summary>
  6117. Create CFRecordsAggregate from a list of CF Records
  6118. </summary>
  6119. <param name="recs">list of Record objects</param>
  6120. <param name="pOffset">position of CFHeaderRecord object in the list of Record objects</param>
  6121. </member>
  6122. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CloneCFAggregate">
  6123. <summary>
  6124. Create a deep Clone of the record
  6125. </summary>
  6126. </member>
  6127. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  6128. <summary>
  6129. called by the class that is responsible for writing this sucker.
  6130. Subclasses should implement this so that their data is passed back in a
  6131. byte array.
  6132. </summary>
  6133. <param name="offset">The offset to begin writing at</param>
  6134. <param name="data">The data byte array containing instance data</param>
  6135. <returns> number of bytes written</returns>
  6136. </member>
  6137. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  6138. @return <c>false</c> if this whole {@link CFHeaderRecord} / {@link CFRuleRecord}s should be deleted
  6139. </member>
  6140. <member name="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate">
  6141. <summary>
  6142. @author Glen Stampoultzis
  6143. </summary>
  6144. </member>
  6145. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor">
  6146. <summary>
  6147. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  6148. </summary>
  6149. </member>
  6150. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream)">
  6151. <summary>
  6152. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  6153. </summary>
  6154. <param name="rs">The rs.</param>
  6155. </member>
  6156. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Sid">
  6157. It's an aggregate... just made something up
  6158. </member>
  6159. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.NumColumns">
  6160. <summary>
  6161. Gets the num columns.
  6162. </summary>
  6163. <value>The num columns.</value>
  6164. </member>
  6165. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.RecordSize">
  6166. <summary>
  6167. Gets the size of the record.
  6168. </summary>
  6169. <value>The size of the record.</value>
  6170. </member>
  6171. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Clone">
  6172. Performs a deep Clone of the record
  6173. </member>
  6174. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(NPOI.HSSF.Record.ColumnInfoRecord)">
  6175. <summary>
  6176. Inserts a column into the aggregate (at the end of the list).
  6177. </summary>
  6178. <param name="col">The column.</param>
  6179. </member>
  6180. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(System.Int32,NPOI.HSSF.Record.ColumnInfoRecord)">
  6181. <summary>
  6182. Inserts a column into the aggregate (at the position specified
  6183. by index
  6184. </summary>
  6185. <param name="idx">The index.</param>
  6186. <param name="col">The columninfo.</param>
  6187. </member>
  6188. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  6189. <summary>
  6190. called by the class that is responsible for writing this sucker.
  6191. Subclasses should implement this so that their data is passed back in a
  6192. byte array.
  6193. </summary>
  6194. <param name="offset">offset to begin writing at</param>
  6195. <param name="data">byte array containing instance data</param>
  6196. <returns>number of bytes written</returns>
  6197. </member>
  6198. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  6199. <summary>
  6200. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  6201. that they should be written to file. Implementors may or may not return the actual
  6202. Records being used to manage POI's internal implementation. Callers should not
  6203. assume either way, and therefore only attempt to modify those Records after cloning
  6204. </summary>
  6205. <param name="rv"></param>
  6206. </member>
  6207. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindStartOfColumnOutlineGroup(System.Int32)">
  6208. <summary>
  6209. Finds the start of column outline group.
  6210. </summary>
  6211. <param name="idx">The idx.</param>
  6212. <returns></returns>
  6213. </member>
  6214. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindEndOfColumnOutlineGroup(System.Int32)">
  6215. <summary>
  6216. Finds the end of column outline group.
  6217. </summary>
  6218. <param name="idx">The idx.</param>
  6219. <returns></returns>
  6220. </member>
  6221. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GetColInfo(System.Int32)">
  6222. <summary>
  6223. Gets the col info.
  6224. </summary>
  6225. <param name="idx">The idx.</param>
  6226. <returns></returns>
  6227. </member>
  6228. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupCollapsed(System.Int32)">
  6229. <summary>
  6230. Determines whether [is column group collapsed] [the specified idx].
  6231. </summary>
  6232. <param name="idx">The idx.</param>
  6233. <returns>
  6234. <c>true</c> if [is column group collapsed] [the specified idx]; otherwise, <c>false</c>.
  6235. </returns>
  6236. </member>
  6237. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupHiddenByParent(System.Int32)">
  6238. <summary>
  6239. Determines whether [is column group hidden by parent] [the specified idx].
  6240. </summary>
  6241. <param name="idx">The idx.</param>
  6242. <returns>
  6243. <c>true</c> if [is column group hidden by parent] [the specified idx]; otherwise, <c>false</c>.
  6244. </returns>
  6245. </member>
  6246. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColumn(System.Int32)">
  6247. <summary>
  6248. Collapses the column.
  6249. </summary>
  6250. <param name="columnNumber">The column number.</param>
  6251. </member>
  6252. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.ExpandColumn(System.Int32)">
  6253. <summary>
  6254. Expands the column.
  6255. </summary>
  6256. <param name="columnNumber">The column number.</param>
  6257. </member>
  6258. <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})">
  6259. Sets all non null fields into the <c>ci</c> parameter.
  6260. </member>
  6261. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.AttemptMergeColInfoRecords(System.Int32)">
  6262. <summary>
  6263. Attempts to merge the col info record at the specified index
  6264. with either or both of its neighbours
  6265. </summary>
  6266. <param name="colInfoIx">The col info ix.</param>
  6267. </member>
  6268. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MergeColInfoRecords(NPOI.HSSF.Record.ColumnInfoRecord,NPOI.HSSF.Record.ColumnInfoRecord)">
  6269. merges two column info records (if they are adjacent and have the same formatting, etc)
  6270. @return <c>false</c> if the two column records could not be merged
  6271. </member>
  6272. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  6273. <summary>
  6274. Sets all adjacent columns of the same outline level to the specified hidden status.
  6275. </summary>
  6276. <param name="pIdx">the col info index of the start of the outline group.</param>
  6277. <param name="level">The level.</param>
  6278. <param name="hidden">The hidden.</param>
  6279. <returns>the column index of the last column in the outline group</returns>
  6280. </member>
  6281. <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})">
  6282. <summary>
  6283. Sets the column.
  6284. </summary>
  6285. <param name="targetColumnIx">The target column ix.</param>
  6286. <param name="xfIndex">Index of the xf.</param>
  6287. <param name="width">The width.</param>
  6288. <param name="level">The level.</param>
  6289. <param name="hidden">The hidden.</param>
  6290. <param name="collapsed">The collapsed.</param>
  6291. </member>
  6292. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Int16,System.Int16,System.Int32,System.Boolean,System.Boolean)">
  6293. Sets all non null fields into the <c>ci</c> parameter.
  6294. </member>
  6295. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColInfoRecords(System.Int32)">
  6296. <summary>
  6297. Collapses the col info records.
  6298. </summary>
  6299. <param name="columnIdx">The column index.</param>
  6300. </member>
  6301. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  6302. <summary>
  6303. Creates an outline Group for the specified columns.
  6304. </summary>
  6305. <param name="fromColumnIx">Group from this column (inclusive)</param>
  6306. <param name="toColumnIx">Group to this column (inclusive)</param>
  6307. <param name="indent">if true the Group will be indented by one level;if false indenting will be Removed by one level.</param>
  6308. </member>
  6309. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindColumnInfo(System.Int32)">
  6310. <summary>
  6311. Finds the ColumnInfoRecord
  6312. which contains the specified columnIndex
  6313. </summary>
  6314. <param name="columnIndex">index of the column (not the index of the ColumnInfoRecord)</param>
  6315. <returns> /// <c>null</c>
  6316. if no column info found for the specified column
  6317. </returns>
  6318. </member>
  6319. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MaxOutlineLevel">
  6320. <summary>
  6321. Gets the max outline level.
  6322. </summary>
  6323. <value>The max outline level.</value>
  6324. </member>
  6325. <member name="T:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable">
  6326. Holds all the conditional formatting for a workbook sheet.<p/>
  6327. See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'
  6328. @author Josh Micich
  6329. </member>
  6330. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.#ctor">
  6331. Creates an empty ConditionalFormattingTable
  6332. </member>
  6333. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.Add(NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  6334. @return index of the newly added CF header aggregate
  6335. </member>
  6336. <member name="T:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate">
  6337. Manages the all the records associated with a 'Custom View Settings' sub-stream.<br/>
  6338. Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB).
  6339. @author Josh Micich
  6340. </member>
  6341. <member name="F:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate._recs">
  6342. All the records between BOF and EOF
  6343. </member>
  6344. <member name="T:NPOI.HSSF.Record.Aggregates.DataValidityTable">
  6345. <summary>
  6346. Manages the DVALRecord and DVRecords for a single sheet
  6347. See OOO excelfileformat.pdf section 4.14
  6348. @author Josh Micich
  6349. </summary>
  6350. </member>
  6351. <member name="F:NPOI.HSSF.Record.Aggregates.DataValidityTable._validationList">
  6352. The list of data validations for the current sheet.
  6353. Note - this may be empty (contrary to OOO documentation)
  6354. </member>
  6355. <member name="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate">
  6356. <summary>
  6357. The formula record aggregate is used to join toGether the formula record and it's
  6358. (optional) string record and (optional) Shared Formula Record (template Reads, excel optimization).
  6359. @author Glen Stampoultzis (glens at apache.org)
  6360. </summary>
  6361. </member>
  6362. <member name="F:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate._stringRecord">
  6363. caches the calculated result of the formula
  6364. </member>
  6365. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.#ctor(NPOI.HSSF.Record.FormulaRecord,NPOI.HSSF.Record.StringRecord,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  6366. <summary>
  6367. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate"/> class.
  6368. </summary>
  6369. <param name="formulaRec">The formula rec.</param>
  6370. <param name="stringRec">The string rec.</param>
  6371. <param name="svm">The SVM.</param>
  6372. </member>
  6373. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.NotifyFormulaChanging">
  6374. Should be called by any code which is either deleting this formula cell, or changing
  6375. its type. This method gives the aggregate a chance to unlink any shared formula
  6376. that may be involved with this cell formula.
  6377. </member>
  6378. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Serialize(System.Int32,System.Byte[])">
  6379. <summary>
  6380. called by the class that is responsible for writing this sucker.
  6381. Subclasses should implement this so that their data is passed back in a
  6382. byte array.
  6383. </summary>
  6384. <param name="offset">offset to begin writing at</param>
  6385. <param name="data">byte array containing instance data.</param>
  6386. <returns>number of bytes written</returns>
  6387. </member>
  6388. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  6389. <summary>
  6390. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  6391. that they should be written to file. Implementors may or may not return the actual
  6392. {@link Record}s being used to manage POI's internal implementation. Callers should not
  6393. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  6394. </summary>
  6395. <param name="rv"></param>
  6396. </member>
  6397. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RecordSize">
  6398. <summary>
  6399. Get the current Serialized size of the record. Should include the sid and recLength (4 bytes).
  6400. </summary>
  6401. <value>The size of the record.</value>
  6402. </member>
  6403. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Sid">
  6404. <summary>
  6405. return the non static version of the id for this record.
  6406. </summary>
  6407. <value>The sid.</value>
  6408. </member>
  6409. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  6410. <summary>
  6411. Sometimes the shared formula flag "seems" to be erroneously set (because the corresponding
  6412. SharedFormulaRecord does not exist). Normally this would leave no way of determining
  6413. the Ptg tokens for the formula. However as it turns out in these
  6414. cases, Excel encodes the unshared Ptg tokens in the right place (inside the FormulaRecord).
  6415. So the the only thing that needs to be done is to ignore the erroneous
  6416. shared formula flag.
  6417. This method may also be used for setting breakpoints to help diagnose issues regarding the
  6418. abnormally-set 'shared formula' flags.
  6419. </summary>
  6420. <param name="formula">The formula.</param>
  6421. </member>
  6422. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.FormulaRecord">
  6423. <summary>
  6424. Gets or sets the formula record.
  6425. </summary>
  6426. <value>The formula record.</value>
  6427. </member>
  6428. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringRecord">
  6429. <summary>
  6430. Gets or sets the string record.
  6431. </summary>
  6432. <value>The string record.</value>
  6433. </member>
  6434. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Equals(System.Object)">
  6435. <summary>
  6436. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  6437. </summary>
  6438. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  6439. <returns>
  6440. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  6441. </returns>
  6442. <exception cref="T:System.NullReferenceException">
  6443. The <paramref name="obj"/> parameter is null.
  6444. </exception>
  6445. </member>
  6446. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.ToString">
  6447. <summary>
  6448. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6449. </summary>
  6450. <returns>
  6451. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  6452. </returns>
  6453. </member>
  6454. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringValue">
  6455. <summary>
  6456. Gets the string value.
  6457. </summary>
  6458. <value>The string value.</value>
  6459. </member>
  6460. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedStringResult(System.String)">
  6461. <summary>
  6462. Sets the cached string result.
  6463. </summary>
  6464. <param name="value">The value.</param>
  6465. </member>
  6466. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedBooleanResult(System.Boolean)">
  6467. <summary>
  6468. Sets the cached boolean result.
  6469. </summary>
  6470. <param name="value">if set to <c>true</c> [value].</param>
  6471. </member>
  6472. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedErrorResult(System.Int32)">
  6473. <summary>
  6474. Sets the cached error result.
  6475. </summary>
  6476. <param name="errorCode">The error code.</param>
  6477. </member>
  6478. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetParsedExpression(NPOI.SS.Formula.PTG.Ptg[])">
  6479. Also checks for a related shared formula and unlinks it if found
  6480. </member>
  6481. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RemoveArrayFormula(System.Int32,System.Int32)">
  6482. Removes an array formula
  6483. @return the range of the array formula containing the specified cell. Never <code>null</code>
  6484. </member>
  6485. <member name="T:NPOI.HSSF.Record.Aggregates.MergedCellsTable">
  6486. @author Josh Micich
  6487. </member>
  6488. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.#ctor">
  6489. <summary>
  6490. Creates an empty aggregate
  6491. </summary>
  6492. </member>
  6493. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.Read(NPOI.HSSF.Model.RecordStream)">
  6494. Reads zero or more consecutive {@link MergeCellsRecord}s
  6495. @param rs
  6496. </member>
  6497. <member name="T:NPOI.HSSF.Record.Aggregates.PageSettingsBlock">
  6498. Groups the page settings records for a worksheet.<p/>
  6499. See OOO excelfileformat.pdf sec 4.4 'Page Settings Block'
  6500. @author Josh Micich
  6501. </member>
  6502. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.#ctor">
  6503. Creates a PageSettingsBlock with default settings
  6504. </member>
  6505. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsComponentRecord(System.Int32)">
  6506. @return <c>true</c> if the specified Record sid is one belonging to the
  6507. 'Page Settings Block'.
  6508. </member>
  6509. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetColumnBreak(System.Int32,System.Int32,System.Int32)">
  6510. Sets a page break at the indicated column
  6511. </member>
  6512. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveColumnBreak(System.Int32)">
  6513. Removes a page break at the indicated column
  6514. </member>
  6515. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateHCenter">
  6516. Creates the HCenter Record and sets it to false (don't horizontally center)
  6517. </member>
  6518. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateVCenter">
  6519. Creates the VCenter Record and sets it to false (don't horizontally center)
  6520. </member>
  6521. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreatePrintSetup">
  6522. Creates the PrintSetup Record and sets it to defaults and marks it invalid
  6523. @see org.apache.poi.hssf.record.PrintSetupRecord
  6524. @see org.apache.poi.hssf.record.Record
  6525. @return record containing a PrintSetupRecord
  6526. </member>
  6527. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Header">
  6528. Returns the HeaderRecord.
  6529. @return HeaderRecord for the sheet.
  6530. </member>
  6531. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Footer">
  6532. Returns the FooterRecord.
  6533. @return FooterRecord for the sheet.
  6534. </member>
  6535. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.PrintSetup">
  6536. Returns the PrintSetupRecord.
  6537. @return PrintSetupRecord for the sheet.
  6538. </member>
  6539. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.GetMargin(NPOI.SS.UserModel.MarginType)">
  6540. Gets the size of the margin in inches.
  6541. @param margin which margin to Get
  6542. @return the size of the margin
  6543. </member>
  6544. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  6545. Sets the size of the margin in inches.
  6546. @param margin which margin to Get
  6547. @param size the size of the margin
  6548. </member>
  6549. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int32,System.Int32,System.Int32)">
  6550. Shifts all the page breaks in the range "count" number of rows/columns
  6551. @param breaks The page record to be shifted
  6552. @param start Starting "main" value to shift breaks
  6553. @param stop Ending "main" value to shift breaks
  6554. @param count number of units (rows/columns) to shift by
  6555. </member>
  6556. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetRowBreak(System.Int32,System.Int16,System.Int16)">
  6557. Sets a page break at the indicated row
  6558. @param row
  6559. </member>
  6560. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveRowBreak(System.Int32)">
  6561. Removes a page break at the indicated row
  6562. @param row
  6563. </member>
  6564. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsRowBroken(System.Int32)">
  6565. Queries if the specified row has a page break
  6566. @param row
  6567. @return true if the specified row has a page break
  6568. </member>
  6569. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsColumnBroken(System.Int32)">
  6570. Queries if the specified column has a page break
  6571. @return <c>true</c> if the specified column has a page break
  6572. </member>
  6573. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  6574. Shifts the horizontal page breaks for the indicated count
  6575. @param startingRow
  6576. @param endingRow
  6577. @param count
  6578. </member>
  6579. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  6580. Shifts the vertical page breaks for the indicated count
  6581. @param startingCol
  6582. @param endingCol
  6583. @param count
  6584. </member>
  6585. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RowBreaks">
  6586. @return all the horizontal page breaks, never <c>null</c>
  6587. </member>
  6588. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumRowBreaks">
  6589. @return the number of row page breaks
  6590. </member>
  6591. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ColumnBreaks">
  6592. @return all the column page breaks, never <c>null</c>
  6593. </member>
  6594. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumColumnBreaks">
  6595. @return the number of column page breaks
  6596. </member>
  6597. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateHeaderFooter(NPOI.HSSF.Record.HeaderFooterRecord)">
  6598. <summary>
  6599. HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after
  6600. the PageSettingsBlock where it belongs.
  6601. </summary>
  6602. <param name="rec"></param>
  6603. </member>
  6604. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateRecords(NPOI.HSSF.Model.RecordStream)">
  6605. <summary>
  6606. This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered.
  6607. As each record is read, it is incorporated into this PageSettingsBlock.
  6608. </summary>
  6609. <param name="rs"></param>
  6610. </member>
  6611. <member name="F:NPOI.HSSF.Record.Aggregates.PLSAggregate._plsContinues">
  6612. holds any continue records found after the PLS record.<br/>
  6613. This would not be required if PLS was properly interpreted.
  6614. Currently, PLS is an {@link UnknownRecord} and does not automatically
  6615. include any trailing {@link ContinueRecord}s.
  6616. </member>
  6617. <member name="M:NPOI.HSSF.Record.Aggregates.RecordVisitor.VisitRecord(NPOI.HSSF.Record.Record)">
  6618. Implementors may call non-mutating methods on Record r.
  6619. @param r must not be <c>null</c>
  6620. </member>
  6621. <member name="T:NPOI.HSSF.Record.Aggregates.RecordAggregate">
  6622. <c>RecordAggregate</c>s are groups of of BIFF <c>Record</c>s that are typically stored
  6623. together and/or updated together. Workbook / Sheet records are typically stored in a sequential
  6624. list, which does not provide much structure to coordinate updates.
  6625. @author Josh Micich
  6626. </member>
  6627. <member name="M:NPOI.HSSF.Record.Aggregates.RecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  6628. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  6629. that they should be written to file. Implementors may or may not return the actual
  6630. {@link Record}s being used to manage POI's internal implementation. Callers should not
  6631. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  6632. </member>
  6633. <member name="T:NPOI.HSSF.Record.Aggregates.PositionTrackingVisitor">
  6634. A wrapper for {@link RecordVisitor} which accumulates the sizes of all
  6635. records visited.
  6636. </member>
  6637. <member name="T:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate">
  6638. @author andy
  6639. @author Jason Height (jheight at chariot dot net dot au)
  6640. </member>
  6641. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor">
  6642. Creates a new instance of ValueRecordsAggregate
  6643. </member>
  6644. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  6645. @param rs record stream with all {@link SharedFormulaRecord}
  6646. {@link ArrayRecord}, {@link TableRecord} {@link MergeCellsRecord} Records removed
  6647. </member>
  6648. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.AddUnknownRecord(NPOI.HSSF.Record.Record)">
  6649. Handles UnknownRecords which appear within the row/cell records
  6650. </member>
  6651. <member name="P:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.RowBlockCount">
  6652. Returns the number of row blocks.
  6653. <p/>The row blocks are goupings of rows that contain the DBCell record
  6654. after them
  6655. </member>
  6656. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetRowCountForBlock(System.Int32)">
  6657. Returns the number of physical rows within a block
  6658. </member>
  6659. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetStartRowNumberForBlock(System.Int32)">
  6660. Returns the physical row number of the first row in a block
  6661. </member>
  6662. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetEndRowNumberForBlock(System.Int32)">
  6663. Returns the physical row number of the end row in a block
  6664. </member>
  6665. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.CreateRow(System.Int32)">
  6666. Create a row record.
  6667. @param row number
  6668. @return RowRecord Created for the passed in row number
  6669. @see org.apache.poi.hssf.record.RowRecord
  6670. </member>
  6671. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetCellValueEnumerator">
  6672. Returns an iterator for the cell values
  6673. </member>
  6674. <member name="T:NPOI.HSSF.Record.Aggregates.SharedValueManager">
  6675. <summary>
  6676. Manages various auxiliary records while constructing a RowRecordsAggregate
  6677. @author Josh Micich
  6678. </summary>
  6679. </member>
  6680. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup._firstCell">
  6681. Coordinates of the first cell having a formula that uses this shared formula.
  6682. This is often <i>but not always</i> the top left cell in the range covered by
  6683. {@link #_sfr}
  6684. </member>
  6685. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup.IsFirstCell(System.Int32,System.Int32)">
  6686. Note - the 'first cell' of a shared formula group is not always the top-left cell
  6687. of the enclosing range.
  6688. @return <c>true</c> if the specified coordinates correspond to the 'first cell'
  6689. of this shared formula group.
  6690. </member>
  6691. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager._groupsCache">
  6692. cached for optimization purposes
  6693. </member>
  6694. <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})">
  6695. @param firstCells
  6696. @param recs list of sheet records (possibly Contains records for other parts of the Excel file)
  6697. @param startIx index of first row/cell record for current sheet
  6698. @param endIx one past index of last row/cell record for current sheet. It is important
  6699. that this code does not inadvertently collect <c>SharedFormulaRecord</c>s from any other
  6700. sheet (which could happen if endIx is chosen poorly). (see bug 44449)
  6701. </member>
  6702. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.LinkSharedFormulaRecord(NPOI.SS.Util.CellReference,NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  6703. @param firstCell as extracted from the {@link ExpPtg} from the cell's formula.
  6704. @return never <code>null</code>
  6705. </member>
  6706. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetRecordForFirstCell(NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  6707. Gets the {@link SharedValueRecordBase} record if it should be encoded immediately after the
  6708. formula record Contained in the specified {@link FormulaRecordAggregate} agg. Note - the
  6709. shared value record always appears after the first formula record in the group. For arrays
  6710. and tables the first formula is always the in the top left cell. However, since shared
  6711. formula groups can be sparse and/or overlap, the first formula may not actually be in the
  6712. top left cell.
  6713. @return the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of
  6714. a table or array region. <code>null</code> if the formula cell is not shared/array/table,
  6715. or if the specified formula is not the the first in the group.
  6716. </member>
  6717. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Unlink(NPOI.HSSF.Record.SharedFormulaRecord)">
  6718. Converts all {@link FormulaRecord}s handled by <c>sharedFormulaRecord</c>
  6719. to plain unshared formulas
  6720. </member>
  6721. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.AddArrayRecord(NPOI.HSSF.Record.ArrayRecord)">
  6722. Add specified Array Record.
  6723. </member>
  6724. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.RemoveArrayFormula(System.Int32,System.Int32)">
  6725. Removes the {@link ArrayRecord} for the cell group containing the specified cell.
  6726. The caller should clear (set blank) all cells in the returned range.
  6727. @return the range of the array formula which was just removed. Never <code>null</code>.
  6728. </member>
  6729. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetArrayRecord(System.Int32,System.Int32)">
  6730. @return the shared ArrayRecord identified by (firstRow, firstColumn). never <code>null</code>.
  6731. </member>
  6732. <member name="T:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate">
  6733. Aggregate value records toGether. Things are easier to handle that way.
  6734. @author andy
  6735. @author Glen Stampoultzis (glens at apache.org)
  6736. @author Jason Height (jheight at chariot dot net dot au)
  6737. </member>
  6738. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.#ctor">
  6739. Creates a new instance of ValueRecordsAggregate
  6740. </member>
  6741. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  6742. Sometimes the shared formula flag "seems" to be erroneously Set, in which case there is no
  6743. call to <c>SharedFormulaRecord.ConvertSharedFormulaRecord</c> and hence the
  6744. <c>ParsedExpression</c> field of this <c>FormulaRecord</c> will not Get updated.<br/>
  6745. As it turns out, this is not a problem, because in these circumstances, the existing value
  6746. for <c>ParsedExpression</c> is perfectly OK.<p/>
  6747. This method may also be used for Setting breakpoints to help diagnose Issues regarding the
  6748. abnormally-Set 'shared formula' flags.
  6749. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).<p/>
  6750. The method currently does nothing but do not delete it without Finding a nice home for this
  6751. comment.
  6752. </member>
  6753. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.GetRowCellBlockSize(System.Int32,System.Int32)">
  6754. Tallies a count of the size of the cell records
  6755. that are attached to the rows in the range specified.
  6756. </member>
  6757. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.RowHasCells(System.Int32)">
  6758. Returns true if the row has cells attached to it
  6759. </member>
  6760. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.SerializeCellRow(System.Int32,System.Int32,System.Byte[])">
  6761. Serializes the cells that are allocated to a certain row range
  6762. </member>
  6763. <member name="T:NPOI.HSSF.Record.CFHeader12Record">
  6764. Conditional Formatting Header v12 record CFHEADER12 (0x0879),
  6765. for conditional formattings introduced in Excel 2007 and newer.
  6766. </member>
  6767. <member name="M:NPOI.HSSF.Record.CFHeader12Record.#ctor">
  6768. Creates new CFHeaderRecord
  6769. </member>
  6770. <member name="T:NPOI.HSSF.Record.CFHeaderBase">
  6771. Parent of Conditional Formatting Header records,
  6772. {@link CFHeaderRecord} and {@link CFHeader12Record}.
  6773. </member>
  6774. <member name="M:NPOI.HSSF.Record.CFHeaderBase.#ctor">
  6775. Creates new CFHeaderBase
  6776. </member>
  6777. <member name="P:NPOI.HSSF.Record.CFHeaderBase.CellRanges">
  6778. Set cell ranges list to a single cell range and
  6779. modify the enclosing cell range accordingly.
  6780. @param cellRanges - list of CellRange objects
  6781. </member>
  6782. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRule12Record" -->
  6783. <member name="M:NPOI.HSSF.Record.CFRule12Record.#ctor(System.Byte,System.Byte)">
  6784. Creates new CFRuleRecord
  6785. </member>
  6786. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.String)">
  6787. Creates a new comparison operation rule
  6788. </member>
  6789. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  6790. Creates a new comparison operation rule
  6791. </member>
  6792. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String,System.String)">
  6793. Creates a new comparison operation rule
  6794. </member>
  6795. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.Common.ExtendedColor)">
  6796. Creates a new Data Bar formatting
  6797. </member>
  6798. <member name="M:NPOI.HSSF.Record.CFRule12Record.Create(NPOI.HSSF.UserModel.HSSFSheet,NPOI.SS.UserModel.IconSet)">
  6799. Creates a new Icon Set / Multi-State formatting
  6800. </member>
  6801. <member name="M:NPOI.HSSF.Record.CFRule12Record.CreateColorScale(NPOI.HSSF.UserModel.HSSFSheet)">
  6802. Creates a new Color Scale / Color Gradient formatting
  6803. </member>
  6804. <member name="P:NPOI.HSSF.Record.CFRule12Record.ParsedExpressionScale">
  6805. Get the stack of the scale expression as a list
  6806. @return list of tokens (casts stack to a list and returns it!)
  6807. this method can return null is we are unable to create Ptgs from
  6808. existing excel file
  6809. callers should check for null!
  6810. </member>
  6811. <member name="M:NPOI.HSSF.Record.CFRule12Record.Serialize(NPOI.Util.ILittleEndianOutput)">
  6812. called by the class that is responsible for writing this sucker.
  6813. Subclasses should implement this so that their data is passed back in a
  6814. byte array.
  6815. @param out the stream to write to
  6816. </member>
  6817. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRuleBase" -->
  6818. <member name="M:NPOI.HSSF.Record.CFRuleBase.#ctor(System.Byte,System.Byte)">
  6819. Creates new CFRuleRecord
  6820. </member>
  6821. <member name="P:NPOI.HSSF.Record.CFRuleBase.Options">
  6822. Get the option flags
  6823. @return bit mask
  6824. </member>
  6825. <member name="P:NPOI.HSSF.Record.CFRuleBase.ParsedExpression1">
  6826. Get the stack of the 1st expression as a list
  6827. @return list of tokens (casts stack to a list and returns it!)
  6828. this method can return null is we are unable to create Ptgs from
  6829. existing excel file
  6830. callers should check for null!
  6831. </member>
  6832. <member name="P:NPOI.HSSF.Record.CFRuleBase.ParsedExpression2">
  6833. Get the stack of the 2nd expression as a list
  6834. @return array of {@link Ptg}s, possibly <code>null</code>
  6835. </member>
  6836. <member name="M:NPOI.HSSF.Record.CFRuleBase.GetFormulaSize(NPOI.SS.Formula.Formula)">
  6837. @param formula must not be <code>null</code>
  6838. @return encoded size of the formula tokens (does not include 2 bytes for ushort length)
  6839. </member>
  6840. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.Record.CFRuleBase.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFSheet)" -->
  6841. <member name="T:NPOI.HSSF.Record.CF.ColorGradientFormatting">
  6842. Color Gradient / Color Scale Conditional Formatting Rule Record.
  6843. (Called Color Gradient in the file format docs, but more commonly
  6844. Color Scale in the UI)
  6845. </member>
  6846. <member name="T:NPOI.HSSF.Record.CF.ColorGradientThreshold">
  6847. Color Gradient / Color Scale specific Threshold / value (CFVO),
  6848. for Changes in Conditional Formatting
  6849. </member>
  6850. <member name="M:NPOI.HSSF.Record.CF.ColorGradientThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  6851. Creates new Color Gradient Threshold
  6852. </member>
  6853. <member name="T:NPOI.HSSF.Record.CF.DataBarFormatting">
  6854. Data Bar Conditional Formatting Rule Record.
  6855. </member>
  6856. <member name="T:NPOI.HSSF.Record.CF.DataBarThreshold">
  6857. Data Bar specific Threshold / value (CFVO),
  6858. for Changes in Conditional Formatting
  6859. </member>
  6860. <member name="M:NPOI.HSSF.Record.CF.DataBarThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  6861. Creates new Data Bar Threshold
  6862. </member>
  6863. <member name="T:NPOI.HSSF.Record.CF.IconMultiStateFormatting">
  6864. Icon / Multi-State Conditional Formatting Rule Record.
  6865. </member>
  6866. <member name="T:NPOI.HSSF.Record.CF.IconMultiStateThreshold">
  6867. Icon / Multi-State specific Threshold / value (CFVO),
  6868. for Changes in Conditional Formatting
  6869. </member>
  6870. <member name="F:NPOI.HSSF.Record.CF.IconMultiStateThreshold.EQUALS_EXCLUDE">
  6871. Cell values that are equal to the threshold value do not pass the threshold
  6872. </member>
  6873. <member name="F:NPOI.HSSF.Record.CF.IconMultiStateThreshold.EQUALS_INCLUDE">
  6874. Cell values that are equal to the threshold value pass the threshold.
  6875. </member>
  6876. <member name="M:NPOI.HSSF.Record.CF.IconMultiStateThreshold.#ctor(NPOI.Util.ILittleEndianInput)">
  6877. Creates new Ico Multi-State Threshold
  6878. </member>
  6879. <member name="T:NPOI.HSSF.Record.CF.Threshold">
  6880. Threshold / value (CFVO) for Changes in Conditional Formatting
  6881. </member>
  6882. <member name="M:NPOI.HSSF.Record.CF.Threshold.#ctor(NPOI.Util.ILittleEndianInput)">
  6883. Creates new Threshold
  6884. </member>
  6885. <member name="T:NPOI.HSSF.Record.CF.BorderFormatting">
  6886. Border Formatting Block of the Conditional Formatting Rule Record.
  6887. @author Dmitriy Kumshayev
  6888. </member>
  6889. <member name="M:NPOI.HSSF.Record.CF.BorderFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  6890. Creates new FontFormatting
  6891. </member>
  6892. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderLeft">
  6893. <summary>
  6894. Get the type of border to use for the left border of the cell
  6895. </summary>
  6896. </member>
  6897. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderRight">
  6898. <summary>
  6899. Get the type of border to use for the right border of the cell
  6900. </summary>
  6901. </member>
  6902. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderTop">
  6903. <summary>
  6904. Get the type of border to use for the top border of the cell
  6905. </summary>
  6906. </member>
  6907. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderBottom">
  6908. <summary>
  6909. Get the type of border to use for the bottom border of the cell
  6910. </summary>
  6911. </member>
  6912. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderDiagonal">
  6913. <summary>
  6914. Get the type of border to use for the diagonal border of the cell
  6915. </summary>
  6916. </member>
  6917. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.LeftBorderColor">
  6918. <summary>
  6919. Get the color to use for the left border
  6920. </summary>
  6921. </member>
  6922. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.RightBorderColor">
  6923. <summary>
  6924. Get the color to use for the right border
  6925. </summary>
  6926. </member>
  6927. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.TopBorderColor">
  6928. <summary>
  6929. Get the color to use for the top border
  6930. </summary>
  6931. </member>
  6932. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BottomBorderColor">
  6933. <summary>
  6934. Get the color to use for the bottom border
  6935. </summary>
  6936. </member>
  6937. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.DiagonalBorderColor">
  6938. <summary>
  6939. Get the color to use for the diagonal border
  6940. </summary>
  6941. </member>
  6942. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsForwardDiagonalOn">
  6943. <summary>
  6944. true if forward diagonal is on
  6945. </summary>
  6946. </member>
  6947. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsBackwardDiagonalOn">
  6948. <summary>
  6949. true if backward diagonal Is on
  6950. </summary>
  6951. </member>
  6952. <member name="T:NPOI.HSSF.Record.CF.FontFormatting">
  6953. Font Formatting Block of the Conditional Formatting Rule Record.
  6954. @author Dmitriy Kumshayev
  6955. </member>
  6956. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_NORMAL">
  6957. Normal boldness (not bold)
  6958. </member>
  6959. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_BOLD">
  6960. Bold boldness (bold)
  6961. </member>
  6962. <member name="M:NPOI.HSSF.Record.CF.FontFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  6963. Creates new FontFormatting
  6964. </member>
  6965. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontHeight">
  6966. Gets the height of the font in 1/20th point Units
  6967. @return fontheight (in points/20); or -1 if not modified
  6968. </member>
  6969. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsItalic">
  6970. Get whether the font Is to be italics or not
  6971. @return italics - whether the font Is italics or not
  6972. @see #GetAttributes()
  6973. </member>
  6974. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsStruckout">
  6975. Get whether the font Is to be stricken out or not
  6976. @return strike - whether the font Is stricken out or not
  6977. @see #GetAttributes()
  6978. </member>
  6979. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontWeight">
  6980. <summary>
  6981. Get or set the font weight for this font (100-1000dec or 0x64-0x3e8).
  6982. Default Is 0x190 for normal and 0x2bc for bold
  6983. </summary>
  6984. </member>
  6985. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsBold">
  6986. <summary>
  6987. Get or set whether the font weight is set to bold or not
  6988. </summary>
  6989. </member>
  6990. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.EscapementType">
  6991. Get the type of base or subscript for the font
  6992. @return base or subscript option
  6993. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_NONE
  6994. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUPER
  6995. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUB
  6996. </member>
  6997. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.UnderlineType">
  6998. Get the type of Underlining for the font
  6999. @return font Underlining type
  7000. </member>
  7001. <member name="T:NPOI.HSSF.Record.CF.PatternFormatting">
  7002. Pattern Formatting Block of the Conditional Formatting Rule Record.
  7003. @author Dmitriy Kumshayev
  7004. </member>
  7005. <member name="M:NPOI.HSSF.Record.CF.PatternFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7006. Creates new FontFormatting
  7007. </member>
  7008. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillPattern">
  7009. Get the Fill pattern
  7010. @return Fill pattern
  7011. </member>
  7012. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillBackgroundColor">
  7013. Get the background Fill color
  7014. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  7015. @return Fill color
  7016. </member>
  7017. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillForegroundColor">
  7018. Get the foreground Fill color
  7019. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  7020. @return Fill color
  7021. </member>
  7022. <member name="T:NPOI.HSSF.Record.Chart.AlRunsRecord">
  7023. <summary>
  7024. The AlRuns record specifies Rich Text Formatting within chart
  7025. titles (section 2.2.3.3), trendline (section 2.2.3.12), and
  7026. data labels (section 2.2.3.11).
  7027. </summary>
  7028. </member>
  7029. <member name="T:NPOI.HSSF.Record.Chart.AttachedLabelRecord">
  7030. * The series label record defines the type of label associated with the data format record.
  7031. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  7032. * Remove the record in src/records/definitions.
  7033. * @author Glen Stampoultzis (glens at apache.org)
  7034. </member>
  7035. <member name="M:NPOI.HSSF.Record.Chart.AttachedLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7036. Constructs a SeriesLabels record and Sets its fields appropriately.
  7037. @param in the RecordInputstream to Read the record from
  7038. </member>
  7039. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.DataSize">
  7040. Size of record (exluding 4 byte header)
  7041. </member>
  7042. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.FormatFlags">
  7043. Get the format flags field for the SeriesLabels record.
  7044. </member>
  7045. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowActual">
  7046. show actual value of the data point
  7047. @return the show actual field value.
  7048. </member>
  7049. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowPercent">
  7050. show value as percentage of total (pie charts only)
  7051. @return the show percent field value.
  7052. </member>
  7053. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsLabelAsPercentage">
  7054. show category label/value as percentage (pie charts only)
  7055. @return the label as percentage field value.
  7056. </member>
  7057. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsSmoothedLine">
  7058. show smooth line
  7059. @return the smoothed line field value.
  7060. </member>
  7061. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowLabel">
  7062. Display category label
  7063. @return the show label field value.
  7064. </member>
  7065. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowBubbleSizes">
  7066. ??
  7067. @return the show bubble sizes field value.
  7068. </member>
  7069. <member name="T:NPOI.HSSF.Record.Chart.AxcExtRecord">
  7070. <summary>
  7071. The AxcExt record specifies additional extension properties of a date axis (section 2.2.3.6),
  7072. along with a CatSerRange record (section 2.4.39).
  7073. </summary>
  7074. </member>
  7075. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorInterval">
  7076. <summary>
  7077. specifies the interval at which the major tick marks are displayed on the axis (section 2.2.3.6),
  7078. in the unit defined by duMajor.
  7079. </summary>
  7080. </member>
  7081. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorUnit">
  7082. <summary>
  7083. 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).
  7084. If fDateAxis is set to 0, MUST be ignored.
  7085. </summary>
  7086. </member>
  7087. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MinorInterval">
  7088. <summary>
  7089. specifies the interval at which the minor tick marks are displayed on the axis (section 2.2.3.6),
  7090. in a unit defined by duMinor.
  7091. </summary>
  7092. </member>
  7093. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.BaseUnit">
  7094. <summary>
  7095. specifies the smallest unit of time used by the axis (section 2.2.3.6).
  7096. </summary>
  7097. </member>
  7098. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.CrossDate">
  7099. <summary>
  7100. specifies at which date, as a date in the date system specified by the Date1904 record (section 2.4.77),
  7101. in the units defined by duBase, the value axis (section 2.2.3.6) crosses this axis (section 2.2.3.6).
  7102. </summary>
  7103. </member>
  7104. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMin">
  7105. <summary>
  7106. specifies whether MinimumDate is calculated automatically.
  7107. </summary>
  7108. </member>
  7109. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMax">
  7110. <summary>
  7111. specifies whether MaximumDate is calculated automatically.
  7112. </summary>
  7113. </member>
  7114. <member name="T:NPOI.HSSF.Record.Chart.AxesUsedRecord">
  7115. * The number of axes used on a chart.
  7116. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  7117. * Remove the record in src/records/definitions.
  7118. * @author Glen Stampoultzis (glens at apache.org)
  7119. </member>
  7120. <member name="M:NPOI.HSSF.Record.Chart.AxesUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7121. Constructs a AxisUsed record and Sets its fields appropriately.
  7122. @param in the RecordInputstream to Read the record from
  7123. </member>
  7124. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.DataSize">
  7125. Size of record (exluding 4 byte header)
  7126. </member>
  7127. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.NumAxis">
  7128. Get the num axis field for the AxisUsed record.
  7129. </member>
  7130. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.AxisLine">
  7131. <summary>
  7132. The axis (section 2.2.3.6) line itself.
  7133. </summary>
  7134. </member>
  7135. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MajorGridLine">
  7136. <summary>
  7137. The major gridlines along the axis
  7138. </summary>
  7139. </member>
  7140. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MinorGridLine">
  7141. <summary>
  7142. The minor gridlines along the axis
  7143. </summary>
  7144. </member>
  7145. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.WallsOrFloorOf3D">
  7146. <summary>
  7147. The walls or floor of a 3-D chart
  7148. </summary>
  7149. </member>
  7150. <member name="T:NPOI.HSSF.Record.Chart.AxisLineFormatRecord">
  7151. <summary>
  7152. The AxisLine record specifies which part of the axis (section 2.2.3.6) is
  7153. specified by the LineFormat record (section 2.4.156) that follows.
  7154. Excel Binary File Format (.xls) Structure Specification
  7155. </summary>
  7156. </member>
  7157. <member name="M:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7158. Constructs a AxisLineFormat record and Sets its fields appropriately.
  7159. @param in the RecordInputstream to Read the record from
  7160. </member>
  7161. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.DataSize">
  7162. Size of record (exluding 4 byte header)
  7163. </member>
  7164. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.AxisType">
  7165. <summary>
  7166. </summary>
  7167. </member>
  7168. <member name="T:NPOI.HSSF.Record.Chart.AxisOptionsRecord">
  7169. The axis options record provides unit information and other various tidbits about the axis.<p/>
  7170. @author Andrew C. Oliver(acoliver at apache.org)
  7171. </member>
  7172. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinimumCategory">
  7173. Get the minimum category field for the AxisOptions record.
  7174. </member>
  7175. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MaximumCategory">
  7176. Get the maximum category field for the AxisOptions record.
  7177. </member>
  7178. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MajorUnitValue">
  7179. Get the major unit value field for the AxisOptions record.
  7180. </member>
  7181. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MajorUnit">
  7182. Get the major unit field for the AxisOptions record.
  7183. </member>
  7184. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinorUnitValue">
  7185. Get the minor unit value field for the AxisOptions record.
  7186. </member>
  7187. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.MinorUnit">
  7188. Get the minor unit field for the AxisOptions record.
  7189. </member>
  7190. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.BaseUnit">
  7191. Get the base unit field for the AxisOptions record.
  7192. </member>
  7193. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.CrossingPoint">
  7194. Get the crossing point field for the AxisOptions record.
  7195. </member>
  7196. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.Options">
  7197. Get the options field for the AxisOptions record.
  7198. </member>
  7199. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMinimum">
  7200. use the default minimum category
  7201. @return the default minimum field value.
  7202. </member>
  7203. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMaximum">
  7204. use the default maximum category
  7205. @return the default maximum field value.
  7206. </member>
  7207. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMajor">
  7208. use the default major unit
  7209. @return the default major field value.
  7210. </member>
  7211. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultMinorUnit">
  7212. use the default minor unit
  7213. @return the default minor unit field value.
  7214. </member>
  7215. <member name="M:NPOI.HSSF.Record.Chart.AxisOptionsRecord.SetIsDate(System.Boolean)">
  7216. Sets the isDate field value.
  7217. this is a date axis
  7218. </member>
  7219. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsIsDate">
  7220. this is a date axis
  7221. @return the isDate field value.
  7222. </member>
  7223. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultBase">
  7224. use the default base unit
  7225. @return the default base field value.
  7226. </member>
  7227. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultCross">
  7228. use the default crossing point
  7229. @return the default cross field value.
  7230. </member>
  7231. <member name="P:NPOI.HSSF.Record.Chart.AxisOptionsRecord.IsDefaultDateSettings">
  7232. use default date Setttings for this axis
  7233. @return the default date Settings field value.
  7234. </member>
  7235. <member name="T:NPOI.HSSF.Record.Chart.AxisUsedRecord">
  7236. * The number of axes used on a chart.
  7237. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  7238. * Remove the record in src/records/definitions.
  7239. * @author Glen Stampoultzis (glens at apache.org)
  7240. </member>
  7241. <member name="M:NPOI.HSSF.Record.Chart.AxisUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7242. Constructs a AxisUsed record and Sets its fields appropriately.
  7243. @param in the RecordInputstream to Read the record from
  7244. </member>
  7245. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.DataSize">
  7246. Size of record (exluding 4 byte header)
  7247. </member>
  7248. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.NumAxis">
  7249. Get the num axis field for the AxisUsed record.
  7250. </member>
  7251. <member name="T:NPOI.HSSF.Record.Chart.BopPopCustomRecord">
  7252. <summary>
  7253. The BopPopCustom record specifies which data points in the series are contained
  7254. in the secondary bar/pie instead of the primary pie. MUST follow a BopPop record
  7255. that has its split field set to Custom (0x0003).
  7256. </summary>
  7257. <remarks>
  7258. author: Antony liu (antony.apollo at gmail.com)
  7259. </remarks>
  7260. </member>
  7261. <member name="T:NPOI.HSSF.Record.Chart.BopPopRecord">
  7262. <summary>
  7263. The BopPop record specifies that the chart group is a bar of pie chart group or
  7264. a pie of pie chart group and specifies the chart group attributes.
  7265. </summary>
  7266. <remarks>
  7267. author: Antony liu (antony.apollo at gmail.com)
  7268. </remarks>
  7269. </member>
  7270. <member name="T:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord">
  7271. This record refers to a category or series axis and is used to specify label/tickmark frequency.<p/>
  7272. @author Glen Stampoultzis (glens at apache.org)
  7273. </member>
  7274. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.CrossingPoint">
  7275. Get the crossing point field for the CategorySeriesAxis record.
  7276. </member>
  7277. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.LabelFrequency">
  7278. Get the label frequency field for the CategorySeriesAxis record.
  7279. </member>
  7280. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.TickMarkFrequency">
  7281. Get the tick mark frequency field for the CategorySeriesAxis record.
  7282. </member>
  7283. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.Options">
  7284. Get the options field for the CategorySeriesAxis record.
  7285. </member>
  7286. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsValueAxisCrossing">
  7287. Set true to indicate axis crosses between categories and false to cross axis midway
  7288. @return the value axis crossing field value.
  7289. </member>
  7290. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsCrossesFarRight">
  7291. axis crosses at the far right
  7292. @return the crosses far right field value.
  7293. </member>
  7294. <member name="P:NPOI.HSSF.Record.Chart.CategorySeriesAxisRecord.IsReversed">
  7295. categories are displayed in reverse order
  7296. @return the reversed field value.
  7297. </member>
  7298. <member name="T:NPOI.HSSF.Record.Chart.CatSerRangeRecord">
  7299. <summary>
  7300. specifies the properties of a category (3) axis, a date axis, or a series axis.
  7301. </summary>
  7302. </member>
  7303. <member name="M:NPOI.HSSF.Record.Chart.CatSerRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7304. Constructs a CategorySeriesAxis record and Sets its fields appropriately.
  7305. @param in the RecordInputstream to Read the record from
  7306. </member>
  7307. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.DataSize">
  7308. Size of record (exluding 4 byte header)
  7309. </member>
  7310. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.CrossPoint">
  7311. <summary>
  7312. specifies where the value axis crosses this axis, based on the following table.
  7313. If fMaxCross is set to 1, the value this field MUST be ignored.
  7314. Category (3) axis This field specifies the category (3) at which the value axis crosses.
  7315. For example, if this field is 2, the value axis crosses this axis at the second category (3)
  7316. on this axis. MUST be greater than or equal to 1 and less than or equal to 31999.
  7317. Series axis MUST be 0.
  7318. Date axis catCross MUST be equal to the value given by the following formula:
  7319. catCross = catCrossDate – catMin + 1
  7320. Where catCrossDate is the catCrossDate field of the AxcExt record
  7321. and catMin is the catMin field of the AxcExt record.
  7322. </summary>
  7323. </member>
  7324. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.LabelInterval">
  7325. <summary>
  7326. specifies the interval between axis labels on this axis. MUST be greater than or equal to 1 and
  7327. less than or equal to 31999. MUST be ignored for a date axis.
  7328. </summary>
  7329. </member>
  7330. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.MarkInterval">
  7331. <summary>
  7332. specifies the interval at which major tick marks and minor tick marks are displayed on the axis.
  7333. Major tick marks and minor tick marks that would have been visible are hidden unless they are
  7334. located at a multiple of this field.
  7335. </summary>
  7336. </member>
  7337. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsBetween">
  7338. <summary>
  7339. specifies whether the value axis crosses this axis between major tick marks. MUST be a value from to following table:
  7340. 0 The value axis crosses this axis on a major tick mark.
  7341. 1 The value axis crosses this axis between major tick marks.
  7342. </summary>
  7343. </member>
  7344. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsMaxCross">
  7345. <summary>
  7346. specifies whether the value axis crosses this axis at the last category (3), the last series,
  7347. or the maximum date. MUST be a value from the following table:
  7348. 0 The value axis crosses this axis at the value specified by catCross.
  7349. 1 The value axis crosses this axis at the last category (3), the last series, or the maximum date.
  7350. </summary>
  7351. </member>
  7352. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsReverse">
  7353. <summary>
  7354. specifies whether the axis is displayed in reverse order. MUST be a value from the following table:
  7355. 0 The axis is displayed in order.
  7356. 1 The axis is display in reverse order.
  7357. </summary>
  7358. </member>
  7359. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Riser">
  7360. <summary>
  7361. the shape of the base of the data points in a bar or column chart group.
  7362. MUST be a value from the following table
  7363. 0x00 The base of the data point is a rectangle.
  7364. 0x01 The base of the data point is an ellipse.
  7365. </summary>
  7366. </member>
  7367. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Taper">
  7368. <summary>
  7369. how the data points in a bar or column chart group taper from base to tip.
  7370. MUST be a value from the following
  7371. 0x00 The data points of the bar or column chart group do not taper.
  7372. The shape at the maximum value of the data point is the same as the shape at the base.:
  7373. 0x01 The data points of the bar or column chart group taper to a point at the maximum value of each data point.
  7374. 0x02 The data points of the bar or column chart group taper towards a projected point at the position of
  7375. the maximum value of all of the data points in the chart group, but are clipped at the value of each data point.
  7376. </summary>
  7377. </member>
  7378. <member name="T:NPOI.HSSF.Record.Chart.CrtLineRecord">
  7379. <summary>
  7380. The CrtLine record specifies the presence of drop lines, high-low lines, series lines
  7381. or leader lines on the chart group. This record is followed by a LineFormat record
  7382. which specifies the format of the lines.
  7383. </summary>
  7384. <remarks>
  7385. author: Antony liu (antony.apollo at gmail.com)
  7386. </remarks>
  7387. </member>
  7388. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtContinueRecord">
  7389. <summary>
  7390. The CrtMlFrtContinue record specifies additional data for a CrtMlFrt record, as specified in the CrtMlFrt record.
  7391. </summary>
  7392. <remarks>
  7393. author: Antony liu (antony.apollo at gmail.com)
  7394. </remarks>
  7395. </member>
  7396. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtContentsRecord">
  7397. <summary>
  7398. The DataLabExtContents record specifies the contents of an extended data label.
  7399. </summary>
  7400. </member>
  7401. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtRecord">
  7402. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  7403. @author Patrick Cheng
  7404. </member>
  7405. <member name="T:NPOI.HSSF.Record.Chart.DefaultDataLabelTextPropertiesRecord">
  7406. The default data label text properties record identifies the text characteristics of the preceding text record.<p/>
  7407. @author Glen Stampoultzis (glens at apache.org)
  7408. </member>
  7409. <member name="P:NPOI.HSSF.Record.Chart.DefaultDataLabelTextPropertiesRecord.CategoryDataType">
  7410. Get the category data type field for the DefaultDataLabelTextProperties record.
  7411. @return One of
  7412. CATEGORY_DATA_TYPE_SHOW_LABELS_CHARACTERISTIC
  7413. CATEGORY_DATA_TYPE_VALUE_AND_PERCENTAGE_CHARACTERISTIC
  7414. CATEGORY_DATA_TYPE_ALL_TEXT_CHARACTERISTIC
  7415. </member>
  7416. <member name="T:NPOI.HSSF.Record.Chart.TextFormatInfo">
  7417. <summary>
  7418. specifies the text elements that are formatted using the position and appearance information
  7419. specified by the Text record immediately following this record.
  7420. </summary>
  7421. </member>
  7422. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueNotSet">
  7423. <summary>
  7424. Format all Text records in the chart group where fShowPercent is equal to 0 or fShowValue is equal to 0.
  7425. </summary>
  7426. </member>
  7427. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueSet">
  7428. <summary>
  7429. Format all Text records in the chart group where fShowPercent is equal to 1 or fShowValue is equal to 1.
  7430. </summary>
  7431. </member>
  7432. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleNotSet">
  7433. <summary>
  7434. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 0.
  7435. </summary>
  7436. </member>
  7437. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleSet">
  7438. <summary>
  7439. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 1.
  7440. </summary>
  7441. </member>
  7442. <member name="T:NPOI.HSSF.Record.Chart.DefaultTextRecord">
  7443. <summary>
  7444. specifies the text elements that are formatted using the information specified by
  7445. the Text record immediately following this record.
  7446. </summary>
  7447. </member>
  7448. <member name="M:NPOI.HSSF.Record.Chart.DefaultTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7449. Constructs a DefaultDataLabelTextProperties record and Sets its fields appropriately.
  7450. @param in the RecordInputstream to Read the record from
  7451. </member>
  7452. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.DataSize">
  7453. Size of record (exluding 4 byte header)
  7454. </member>
  7455. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.FormatType">
  7456. <summary>
  7457. specifies the text elements that are formatted using the position and appearance
  7458. information specified by the Text record immediately following this record.
  7459. </summary>
  7460. </member>
  7461. <member name="T:NPOI.HSSF.Record.Chart.DropBarRecord">
  7462. <summary>
  7463. The DropBar record specifies the attributes of the up bars or the down bars between multiple
  7464. series of a line chart group and specifies the beginning of a collection of records as
  7465. defined by the Chart Sheet Substream ABNF. The first of these collections in the line chart
  7466. group specifies the attributes of the up bars. The second specifies the attributes of the
  7467. down bars. If this record exists, then the chart group type MUST be line and the field cSer
  7468. in the record SeriesList MUST be greater than 1.
  7469. </summary>
  7470. <remarks>
  7471. author: Antony liu (antony.apollo at gmail.com)
  7472. </remarks>
  7473. </member>
  7474. <member name="T:NPOI.HSSF.Record.Chart.EndBlockRecord">
  7475. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  7476. @author Patrick Cheng
  7477. </member>
  7478. <member name="T:NPOI.HSSF.Record.Chart.Fbi2Record">
  7479. <summary>
  7480. The Fbi2 record specifies the font information at the time the scalable font is added to the chart.
  7481. </summary>
  7482. <remarks>
  7483. author: Antony liu (antony.apollo at gmail.com)
  7484. </remarks>
  7485. </member>
  7486. <member name="T:NPOI.HSSF.Record.Chart.FbiRecord">
  7487. <summary>
  7488. The Fbi record specifies the font information at the time the scalable font is added to the chart.
  7489. </summary>
  7490. </member>
  7491. <member name="M:NPOI.HSSF.Record.Chart.FbiRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7492. Constructs a FontBasis record and Sets its fields appropriately.
  7493. @param in the RecordInputstream to Read the record from
  7494. </member>
  7495. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.DataSize">
  7496. Size of record (exluding 4 byte header)
  7497. </member>
  7498. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.XBasis">
  7499. Get the x Basis field for the FontBasis record.
  7500. </member>
  7501. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.YBasis">
  7502. Get the y Basis field for the FontBasis record.
  7503. </member>
  7504. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.HeightBasis">
  7505. Get the height basis field for the FontBasis record.
  7506. </member>
  7507. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.Scale">
  7508. Get the scale field for the FontBasis record.
  7509. </member>
  7510. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.IndexToFontTable">
  7511. Get the index to font table field for the FontBasis record.
  7512. </member>
  7513. <member name="T:NPOI.HSSF.Record.Chart.FontIndexRecord">
  7514. <summary>
  7515. The FontX record specifies the font for a given text element.
  7516. The Font record referenced by iFont can exist in this chart sheet substream or the workbook.
  7517. </summary>
  7518. </member>
  7519. <member name="M:NPOI.HSSF.Record.Chart.FontIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7520. Constructs a FontIndex record and Sets its fields appropriately.
  7521. @param in the RecordInputstream to Read the record from
  7522. </member>
  7523. <member name="P:NPOI.HSSF.Record.Chart.FontIndexRecord.DataSize">
  7524. Size of record (exluding 4 byte header)
  7525. </member>
  7526. <member name="P:NPOI.HSSF.Record.Chart.FontIndexRecord.FontIndex">
  7527. <summary>
  7528. specifies the font to use for subsequent records.
  7529. This font can either be the default font of the chart, part of the collection of Font records following
  7530. the FrtFontList record, or part of the collection of Font records in the globals substream.
  7531. If iFont is 0x0000, this record specifies the default font of the chart.
  7532. If iFont is less than or equal to the number of Font records in the globals substream,
  7533. iFont is a one-based index to a Font record in the globals substream.
  7534. Otherwise iFont is a one-based index into the collection of Font records in this chart sheet substream
  7535. where the index is equal to iFont – n, where n is the number of Font records in the globals substream.
  7536. </summary>
  7537. </member>
  7538. <member name="T:NPOI.HSSF.Record.Chart.FrtFontListRecord">
  7539. <summary>
  7540. The FrtFontList record specifies font information used on the chart and specifies the
  7541. beginning of a collection of Font records as defined by the Chart Sheet Substream ABNF.
  7542. </summary>
  7543. <remarks>
  7544. author: Antony liu (antony.apollo at gmail.com)
  7545. </remarks>
  7546. </member>
  7547. <member name="T:NPOI.HSSF.Record.Chart.GelFrameRecord">
  7548. <summary>
  7549. specifies the properties of a fill pattern for parts of a chart.
  7550. </summary>
  7551. <remarks>
  7552. author: Antony liu (antony.apollo at gmail.com)
  7553. </remarks>
  7554. </member>
  7555. <member name="T:NPOI.HSSF.Record.Chart.IFmtRecordRecord">
  7556. <summary>
  7557. The IFmtRecord record specifies the number format to use for the text on an axis.
  7558. </summary>
  7559. </member>
  7560. <member name="M:NPOI.HSSF.Record.Chart.IFmtRecordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7561. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  7562. @param in the RecordInputstream to Read the record from
  7563. </member>
  7564. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.DataSize">
  7565. Size of record (exluding 4 byte header)
  7566. </member>
  7567. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.FormatIndex">
  7568. Get the format index field for the NumberFormatIndex record.
  7569. </member>
  7570. <member name="T:NPOI.HSSF.Record.Chart.LegendExceptionRecord">
  7571. <summary>
  7572. The LegendException record specifies information about a legend entry which was
  7573. changed from the default legend entry settings, and specifies the beginning of
  7574. a collection of records as defined by the Chart Sheet Substream ABNF.
  7575. The collection of records specifies legend entry formatting. On a chart where
  7576. the legend contains legend entries for the series and trendlines, as defined
  7577. in the legend overview, there MUST be zero instances or one instance of this
  7578. record in the sequence of records that conform to the SERIESFORMAT rule.
  7579. </summary>
  7580. <remarks>
  7581. author: Antony liu (antony.apollo at gmail.com)
  7582. </remarks>
  7583. </member>
  7584. <member name="T:NPOI.HSSF.Record.Chart.LinkedDataRecord">
  7585. Describes a linked data record. This record refers to the series data or text.<p/>
  7586. @author Glen Stampoultzis (glens at apache.org)
  7587. </member>
  7588. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.LinkType">
  7589. Get the link type field for the LinkedData record.
  7590. @return One of
  7591. LINK_TYPE_TITLE_OR_TEXT
  7592. LINK_TYPE_VALUES
  7593. LINK_TYPE_CATEGORIES
  7594. </member>
  7595. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.ReferenceType">
  7596. Get the reference type field for the LinkedData record.
  7597. @return One of
  7598. REFERENCE_TYPE_DEFAULT_CATEGORIES
  7599. REFERENCE_TYPE_DIRECT
  7600. REFERENCE_TYPE_WORKSHEET
  7601. REFERENCE_TYPE_NOT_USED
  7602. REFERENCE_TYPE_ERROR_REPORTED
  7603. </member>
  7604. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.Options">
  7605. Get the options field for the LinkedData record.
  7606. </member>
  7607. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.IndexNumberFmtRecord">
  7608. Get the index number fmt record field for the LinkedData record.
  7609. </member>
  7610. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.FormulaOfLink">
  7611. Get the formula of link field for the LinkedData record.
  7612. </member>
  7613. <member name="P:NPOI.HSSF.Record.Chart.LinkedDataRecord.IsCustomNumberFormat">
  7614. true if this object has a custom number format
  7615. @return the custom number format field value.
  7616. </member>
  7617. <member name="T:NPOI.HSSF.Record.Chart.PicFRecord">
  7618. <summary>
  7619. The PicF record specifies the layout of a picture that is attached to a picture-filled chart element.
  7620. </summary>
  7621. <remarks>
  7622. author: Antony liu (antony.apollo at gmail.com)
  7623. </remarks>
  7624. </member>
  7625. <member name="T:NPOI.HSSF.Record.Chart.RadarAreaRecord">
  7626. <summary>
  7627. The RadarArea record specifies that the chart group is a filled radar chart group and specifies the chart group attributes.
  7628. </summary>
  7629. <remarks>
  7630. author: Antony liu (antony.apollo at gmail.com)
  7631. </remarks>
  7632. </member>
  7633. <member name="T:NPOI.HSSF.Record.Chart.RadarRecord">
  7634. <summary>
  7635. The Radar record specifies that the chart group is a radar chart group and specifies the chart group attributes.
  7636. </summary>
  7637. <remarks>
  7638. author: Antony liu (antony.apollo at gmail.com)
  7639. </remarks>
  7640. </member>
  7641. <member name="T:NPOI.HSSF.Record.Chart.RichTextStreamRecord">
  7642. <summary>
  7643. The RichTextStream record specifies additional text properties for the text in
  7644. the entire chart, text in the current legend, text in the current legend entry,
  7645. or text in the attached label. These text properties are a superset of the
  7646. properties stored in the Text, Font, FontX, BRAI, and ObjectLink records based
  7647. on the following table, as specified by the Chart Sheet Substream ABNF. In each
  7648. case, the associated Font record is specified by the associated FontX record.
  7649. </summary>
  7650. <remarks>
  7651. author: Antony liu (antony.apollo at gmail.com)
  7652. </remarks>
  7653. </member>
  7654. <member name="T:NPOI.HSSF.Record.Chart.ScatterRecord">
  7655. <summary>
  7656. The Scatter record specifies that the chart group is a scatter chart group or
  7657. a bubble chart group, and specifies the chart group attributes.
  7658. </summary>
  7659. <remarks>
  7660. author: Antony liu (antony.apollo at gmail.com)
  7661. </remarks>
  7662. </member>
  7663. <member name="T:NPOI.HSSF.Record.Chart.SerAuxErrBarRecord">
  7664. <summary>
  7665. The SerAuxErrBar record specifies properties of an error bar.
  7666. </summary>
  7667. <remarks>
  7668. author: Antony liu (antony.apollo at gmail.com)
  7669. </remarks>
  7670. </member>
  7671. <member name="T:NPOI.HSSF.Record.Chart.SerAuxTrendRecord">
  7672. <summary>
  7673. The SerAuxTrend record specifies a trendline.
  7674. </summary>
  7675. <remarks>
  7676. author: Antony liu (antony.apollo at gmail.com)
  7677. </remarks>
  7678. </member>
  7679. <member name="T:NPOI.HSSF.Record.Chart.SerFmtRecord">
  7680. <summary>
  7681. The SerFmt record specifies properties of the associated data points, data markers,
  7682. or lines of the series. The associated data points, data markers, or lines of the
  7683. series are specified by the preceding DataFormat record. If this record is not
  7684. present in the sequence of records that conforms to the SS rule of the Chart Sheet
  7685. Substream ABNF, then the properties of the associated data points, data markers,
  7686. or lines of the series are specified by the default values of the fields of this record.
  7687. </summary>
  7688. <remarks>
  7689. author: Antony liu (antony.apollo at gmail.com)
  7690. </remarks>
  7691. </member>
  7692. <member name="T:NPOI.HSSF.Record.Chart.SerParentRecord">
  7693. <summary>
  7694. The SerParent record specifies the series to which the current trendline or error bar corresponds.
  7695. </summary>
  7696. <remarks>
  7697. author: Antony liu (antony.apollo at gmail.com)
  7698. </remarks>
  7699. </member>
  7700. <member name="T:NPOI.HSSF.Record.Chart.SerToCrtRecord">
  7701. <summary>
  7702. The SerToCrt record specifies the chart group for the current series.
  7703. </summary>
  7704. </member>
  7705. <member name="M:NPOI.HSSF.Record.Chart.SerToCrtRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7706. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  7707. @param in the RecordInputstream to Read the record from
  7708. </member>
  7709. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.DataSize">
  7710. Size of record (exluding 4 byte header)
  7711. </member>
  7712. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.ChartGroupIndex">
  7713. Get the chart Group index field for the SeriesChartGroupIndex record.
  7714. </member>
  7715. <member name="T:NPOI.HSSF.Record.Chart.ShapePropsStreamRecord">
  7716. <summary>
  7717. The ShapePropsStream record specifies the shape formatting properties for chart elements.
  7718. These shape formatting properties are a superset of the properties stored in the LineFormat,
  7719. AreaFormat, MarkerFormat, and GelFrame records. They are stored in the rgb field, which is an
  7720. XML stream (section 2.1.7.22), as defined in [ECMA-376] Part 4, section 5.7.2.198.
  7721. </summary>
  7722. <remarks>
  7723. author: Antony liu (antony.apollo at gmail.com)
  7724. </remarks>
  7725. </member>
  7726. <member name="T:NPOI.HSSF.Record.Chart.ShtPropsRecord">
  7727. * Describes a chart sheet properties record.
  7728. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  7729. * Remove the record in src/records/definitions.
  7730. * @author Glen Stampoultzis (glens at apache.org)
  7731. <summary>
  7732. specifies properties of a chart as defined by the Chart Sheet Substream ABNF
  7733. </summary>
  7734. </member>
  7735. <member name="M:NPOI.HSSF.Record.Chart.ShtPropsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  7736. Constructs a SheetProperties record and Sets its fields appropriately.
  7737. @param in the RecordInputstream to Read the record from
  7738. </member>
  7739. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.DataSize">
  7740. Size of record (exluding 4 byte header)
  7741. </member>
  7742. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Flags">
  7743. Get the flags field for the SheetProperties record.
  7744. </member>
  7745. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Blank">
  7746. Get the empty field for the SheetProperties record.
  7747. @return One of
  7748. EMPTY_NOT_PLOTTED
  7749. EMPTY_ZERO
  7750. EMPTY_INTERPOLATED
  7751. <summary>
  7752. specifies how the empty cells are plotted be a value from the following table:
  7753. 0x00 Empty cells are not plotted.
  7754. 0x01 Empty cells are plotted as zero.
  7755. 0x02 Empty cells are plotted as interpolated.
  7756. </summary>
  7757. </member>
  7758. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManSerAlloc">
  7759. <summary>
  7760. whether series are automatically allocated for the chart.
  7761. </summary>
  7762. </member>
  7763. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsPlotVisibleOnly">
  7764. <summary>
  7765. whether to plot visible cells only.
  7766. </summary>
  7767. </member>
  7768. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsNotSizeWithWindow">
  7769. <summary>
  7770. whether to size the chart with the window.
  7771. </summary>
  7772. </member>
  7773. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManPlotArea">
  7774. <summary>
  7775. If fAlwaysAutoPlotArea is 1, then this field MUST be 1.
  7776. If fAlwaysAutoPlotArea is 0, then this field MUST be ignored.
  7777. </summary>
  7778. </member>
  7779. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsAlwaysAutoPlotArea">
  7780. <summary>
  7781. specifies whether the default plot area dimension (2) is used.
  7782. 0 Use the default plot area dimension (2) regardless of the Pos record information.
  7783. 1 Use the plot area dimension (2) of the Pos record; and fManPlotArea MUST be 1.
  7784. </summary>
  7785. </member>
  7786. <member name="T:NPOI.HSSF.Record.Chart.StartBlockRecord">
  7787. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  7788. @author Patrick Cheng
  7789. </member>
  7790. <member name="T:NPOI.HSSF.Record.Chart.SurfRecord">
  7791. <summary>
  7792. The Surf record specifies that the chart group is a surface chart group and specifies the chart group attributes.
  7793. </summary>
  7794. <remarks>
  7795. author: Antony liu (antony.apollo at gmail.com)
  7796. </remarks>
  7797. </member>
  7798. <member name="T:NPOI.HSSF.Record.Chart.TextPropsStreamRecord">
  7799. <summary>
  7800. The RichTextStream record specifies additional text properties for the text
  7801. in the entire chart, text in the current legend, text in the current legend
  7802. entry, or text in the attached label. These text properties are a superset
  7803. of the properties stored in the Text, Font, FontX, BRAI, and ObjectLink records
  7804. based on the following table, as specified by the Chart Sheet Substream ABNF.
  7805. In each case, the associated Font record is specified by the associated FontX record.
  7806. </summary>
  7807. <remarks>
  7808. author: Antony liu (antony.apollo at gmail.com)
  7809. </remarks>
  7810. </member>
  7811. <member name="T:NPOI.HSSF.Record.Chart.YMultRecord">
  7812. <summary>
  7813. The YMult record specifies properties of the value multiplier for a value axis and
  7814. that specifies the beginning of a collection of records as defined by the Chart Sheet
  7815. substream ABNF. The collection of records specifies a display units label.
  7816. </summary>
  7817. <remarks>
  7818. author: Antony liu (antony.apollo at gmail.com)
  7819. </remarks>
  7820. </member>
  7821. <member name="T:NPOI.HSSF.Record.Chart.Chart3dRecord">
  7822. <summary>
  7823. The Chart3d record specifies that the plot area of the chart group is rendered in a 3-D scene
  7824. and also specifies the attributes of the 3-D plot area. The preceding chart group type MUST be
  7825. of type bar, pie, line, area, or surface.
  7826. </summary>
  7827. <remarks>
  7828. author: Antony liu (antony.apollo at gmail.com)
  7829. </remarks>
  7830. </member>
  7831. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Rotation">
  7832. <summary>
  7833. A signed integer that specifies the clockwise rotation, in degrees, of the 3-D plot area
  7834. around a vertical line through the center of the 3-D plot area. MUST be greater than or
  7835. equal to 0 and MUST be less than or equal to 360.
  7836. </summary>
  7837. </member>
  7838. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Elev">
  7839. <summary>
  7840. A signed integer that specifies the rotation, in degrees, of the 3-D plot area around
  7841. a horizontal line through the center of the 3-D plot area.MUST be greater than or equal
  7842. to -90 and MUST be less than or equal to 90.
  7843. </summary>
  7844. </member>
  7845. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Dist">
  7846. <summary>
  7847. A signed integer that specifies the field of view angle for the 3-D plot area.
  7848. MUST be greater than or equal to zero and less than 200.
  7849. </summary>
  7850. </member>
  7851. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Height">
  7852. <summary>
  7853. If fNotPieChart is 0, then this is an unsigned integer that specifies the thickness of the pie for a pie chart group.
  7854. 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.
  7855. </summary>
  7856. </member>
  7857. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Depth">
  7858. <summary>
  7859. A signed integer that specifies the depth of the 3-D plot area as a percentage of its width.
  7860. MUST be greater than or equal to 1 and less than or equal to 2000.
  7861. </summary>
  7862. </member>
  7863. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Gap">
  7864. <summary>
  7865. An unsigned integer that specifies the width of the gap between the series and the front and
  7866. back edges of the 3-D plot area as a percentage of the data point depth divided by 2.
  7867. If fCluster is not 1 and chart group type is not a bar then pcGap also specifies distance
  7868. between adjacent series as a percentage of the data point depth. MUST be less than or equal to 500.
  7869. </summary>
  7870. </member>
  7871. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsPerspective">
  7872. <summary>
  7873. A bit that specifies whether the 3-D plot area is rendered with a vanishing point.
  7874. If fNotPieChart is 0 the value MUST be 0. If fNotPieChart is 1 then the value
  7875. MUST be a value from the following
  7876. true Perspective vanishing point applied based on value of pcDist.
  7877. false No vanishing point applied.
  7878. </summary>
  7879. </member>
  7880. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsCluster">
  7881. <summary>
  7882. specifies whether data points are clustered together in a bar chart group.
  7883. If chart group type is not bar or pie, value MUST be ignored. If chart group type is pie,
  7884. value MUST be 0. If chart group type is bar, then the value MUST be a value from the following
  7885. true Data points are clustered.
  7886. false Data points are not clustered.
  7887. </summary>
  7888. </member>
  7889. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Is3DScaling">
  7890. <summary>
  7891. A bit that specifies whether the height of the 3-D plot area is automatically determined.
  7892. If fNotPieChart is 0 then this MUST be 0. If fNotPieChart is 1 then the value MUST be a value from the following table:
  7893. false The value of pcHeight is used to determine the height of the 3-D plot area
  7894. true The height of the 3-D plot area is automatically determined
  7895. </summary>
  7896. </member>
  7897. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsNotPieChart">
  7898. <summary>
  7899. A bit that specifies whether the chart group type is pie. MUST be a value from the following :
  7900. false Chart group type MUST be pie.
  7901. true Chart group type MUST not be pie.
  7902. </summary>
  7903. </member>
  7904. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsWalls2D">
  7905. <summary>
  7906. Whether the walls are rendered in 2-D. If fPerspective is 1 then this MUST be ignored.
  7907. If the chart group type is not bar, area or pie this MUST be ignored.
  7908. If the chart group is of type bar and fCluster is 0, then this MUST be ignored.
  7909. If the chart group type is pie this MUST be 0 and MUST be ignored.
  7910. If the chart group type is bar or area, then the value MUST be a value from the following
  7911. false Chart walls and floor are rendered in 3D.
  7912. true Chart walls are rendered in 2D and the chart floor is not rendered.
  7913. </summary>
  7914. </member>
  7915. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12ARecord">
  7916. <summary>
  7917. The CrtLayout12A record specifies layout information for a plot area.
  7918. </summary>
  7919. <remarks>
  7920. author: Antony liu (antony.apollo at gmail.com)
  7921. </remarks>
  7922. </member>
  7923. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.IsLayoutTargetInner">
  7924. <summary>
  7925. specifies the type of plot area for the layout target.
  7926. false Outer plot area - The bounding rectangle that includes the axis labels, axis titles, data table (2) and plot area of the chart.
  7927. true Inner plot area – The rectangle bounded by the chart axes.
  7928. </summary>
  7929. </member>
  7930. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.CheckSum">
  7931. <summary>
  7932. specifies the checksum
  7933. </summary>
  7934. </member>
  7935. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XTL">
  7936. <summary>
  7937. specifies the horizontal offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  7938. </summary>
  7939. </member>
  7940. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YTL">
  7941. <summary>
  7942. specifies the vertical offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  7943. </summary>
  7944. </member>
  7945. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XBR">
  7946. <summary>
  7947. specifies the width of the plot area
  7948. </summary>
  7949. </member>
  7950. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YBR">
  7951. <summary>
  7952. specifies the height of the plot area
  7953. </summary>
  7954. </member>
  7955. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XMode">
  7956. <summary>
  7957. A CrtLayout12Mode structure that specifies the meaning of x.
  7958. </summary>
  7959. </member>
  7960. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YMode">
  7961. <summary>
  7962. A CrtLayout12Mode structure that specifies the meaning of y.
  7963. </summary>
  7964. </member>
  7965. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.WidthMode">
  7966. <summary>
  7967. A CrtLayout12Mode structure that specifies the meaning of dx.
  7968. </summary>
  7969. </member>
  7970. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.HeightMode">
  7971. <summary>
  7972. A CrtLayout12Mode structure that specifies the meaning of dy.
  7973. </summary>
  7974. </member>
  7975. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.X">
  7976. <summary>
  7977. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  7978. </summary>
  7979. </member>
  7980. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.Y">
  7981. <summary>
  7982. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  7983. </summary>
  7984. </member>
  7985. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DX">
  7986. <summary>
  7987. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  7988. </summary>
  7989. </member>
  7990. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DY">
  7991. <summary>
  7992. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  7993. </summary>
  7994. </member>
  7995. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Mode">
  7996. <summary>
  7997. The CrtLayout12Mode specifies a layout mode. Each layout mode specifies a different
  7998. meaning of the x, y, dx, and dy fields of CrtLayout12 and CrtLayout12A.
  7999. </summary>
  8000. </member>
  8001. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MAUTO">
  8002. <summary>
  8003. Position and dimension (2) are determined by the application. x, y, dx and dy MUST be ignored.
  8004. </summary>
  8005. </member>
  8006. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MFACTOR">
  8007. <summary>
  8008. x and y specify the offset of the top left corner, relative to its default position,
  8009. as a fraction of the chart area. MUST be greater than or equal to -1.0 and MUST be
  8010. less than or equal to 1.0. dx and dy specify the width and height, as a fraction of
  8011. the chart area, MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  8012. </summary>
  8013. </member>
  8014. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MEDGE">
  8015. <summary>
  8016. x and y specify the offset of the upper-left corner; dx and dy specify the offset of the bottom-right corner.
  8017. x, y, dx and dy are specified relative to the upper-left corner of the chart area as a fraction of the chart area.
  8018. x, y, dx and dy MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  8019. </summary>
  8020. </member>
  8021. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Record">
  8022. <summary>
  8023. The CrtLayout12 record specifies the layout information for attached label, when contained
  8024. in the sequence of records that conforms to the ATTACHEDLABEL rule,
  8025. or legend, when contained in the sequence of records that conforms to the LD rule.
  8026. </summary>
  8027. </member>
  8028. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.AutoLayoutType">
  8029. <summary>
  8030. automatic layout type of the legend.
  8031. MUST be ignored when this record is in the sequence of records that conforms to the ATTACHEDLABEL rule.
  8032. MUST be a value from the following table:
  8033. 0x0 Align to the bottom
  8034. 0x1 Align to top right corner
  8035. 0x2 Align to the top
  8036. 0x3 Align to the right
  8037. 0x4 Align to the left
  8038. </summary>
  8039. </member>
  8040. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.CheckSum">
  8041. <summary>
  8042. specifies the checksum of the values in the order as follows,
  8043. </summary>
  8044. </member>
  8045. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.XMode">
  8046. <summary>
  8047. A CrtLayout12Mode structure that specifies the meaning of x.
  8048. </summary>
  8049. </member>
  8050. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.YMode">
  8051. <summary>
  8052. A CrtLayout12Mode structure that specifies the meaning of y.
  8053. </summary>
  8054. </member>
  8055. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.WidthMode">
  8056. <summary>
  8057. A CrtLayout12Mode structure that specifies the meaning of dx.
  8058. </summary>
  8059. </member>
  8060. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.HeightMode">
  8061. <summary>
  8062. A CrtLayout12Mode structure that specifies the meaning of dy.
  8063. </summary>
  8064. </member>
  8065. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.X">
  8066. <summary>
  8067. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  8068. </summary>
  8069. </member>
  8070. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.Y">
  8071. <summary>
  8072. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  8073. </summary>
  8074. </member>
  8075. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DX">
  8076. <summary>
  8077. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  8078. </summary>
  8079. </member>
  8080. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DY">
  8081. <summary>
  8082. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  8083. </summary>
  8084. </member>
  8085. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtRecord">
  8086. <summary>
  8087. The CrtMlFrt record specifies additional properties for chart elements, as specified by
  8088. the Chart Sheet Substream ABNF. These properties complement the record to which they
  8089. correspond, and are stored as a structure chain defined in XmlTkChain. An application
  8090. can ignore this record without loss of functionality, except for the additional properties.
  8091. If this record is longer than 8224 bytes, it MUST be split into several records. The first
  8092. section of the data appears in this record and subsequent sections appear in one or more
  8093. CrtMlFrtContinue records that follow this record.
  8094. </summary>
  8095. <remarks>
  8096. author: Antony liu (antony.apollo at gmail.com)
  8097. </remarks>
  8098. </member>
  8099. <member name="T:NPOI.HSSF.Record.Chart.MarkerFormatRecord">
  8100. <summary>
  8101. specifies the color, size, and shape of the associated data markers that appear on line, radar,
  8102. and scatter chart groups. The associated data markers are specified by the preceding DataFormat record.
  8103. </summary>
  8104. <remarks>
  8105. author: Antony liu (antony.apollo at gmail.com)
  8106. </remarks>
  8107. </member>
  8108. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBFore">
  8109. <summary>
  8110. the border color of the data marker.
  8111. </summary>
  8112. </member>
  8113. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBBack">
  8114. <summary>
  8115. the interior color of the data marker.
  8116. </summary>
  8117. </member>
  8118. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.DataMarkerType">
  8119. <summary>
  8120. the type of data marker.
  8121. </summary>
  8122. </member>
  8123. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Auto">
  8124. <summary>
  8125. whether the data marker is automatically generated.
  8126. false The data marker is not automatically generated.
  8127. true The data marker type, size, and color are automatically generated and the values are set accordingly in this record.
  8128. </summary>
  8129. </member>
  8130. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowInt">
  8131. <summary>
  8132. whether to show the data marker interior.
  8133. false The data marker interior is shown.
  8134. true The data marker interior is not shown.
  8135. </summary>
  8136. </member>
  8137. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowBorder">
  8138. <summary>
  8139. whether to show the data marker border.
  8140. false The data marker border is shown.
  8141. true The data marker border is not shown.
  8142. </summary>
  8143. </member>
  8144. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvFore">
  8145. <summary>
  8146. the border color of the data marker.
  8147. </summary>
  8148. </member>
  8149. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvBack">
  8150. <summary>
  8151. the interior color of the data marker.
  8152. </summary>
  8153. </member>
  8154. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Size">
  8155. <summary>
  8156. specifies the size in twips of the data marker.
  8157. </summary>
  8158. </member>
  8159. <member name="T:NPOI.HSSF.Record.Chart.PieFormatRecord">
  8160. <summary>
  8161. The PieFormat record specifies the distance of a data point or data points in a series from the center of one of the following:
  8162. The plot area for a doughnut or pie chart group.
  8163. The primary pie in a pie of pie or bar of pie chart group.
  8164. The secondary bar/pie of a pie of pie chart group.
  8165. </summary>
  8166. <remarks>
  8167. author: Antony liu (antony.apollo at gmail.com)
  8168. </remarks>
  8169. </member>
  8170. <member name="P:NPOI.HSSF.Record.Chart.PieFormatRecord.Explode">
  8171. <summary>
  8172. 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:
  8173. The plot area for a doughnut or pie chart group.
  8174. The primary pie in a pie of pie or bar of pie chart group.
  8175. The secondary bar/pie of a pie of pie chart group.
  8176. </summary>
  8177. </member>
  8178. <member name="T:NPOI.HSSF.Record.Chart.PieRecord">
  8179. <summary>
  8180. The Pie record specifies that the chart group is a pie chart group or
  8181. a doughnut chart group, and specifies the chart group attributes.
  8182. </summary>
  8183. <remarks>
  8184. author: Antony liu (antony.apollo at gmail.com)
  8185. </remarks>
  8186. </member>
  8187. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Start">
  8188. <summary>
  8189. An unsigned integer that specifies the starting angle of the first data point,
  8190. clockwise from the top of the circle. MUST be less than or equal to 360.
  8191. </summary>
  8192. </member>
  8193. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Dount">
  8194. <summary>
  8195. An unsigned integer that specifies the size of the center hole in a doughnut chart group
  8196. as a percentage of the plot area size. MUST be a value from the following table:
  8197. 0 Pie chart group.
  8198. 10 to 90 Doughnut chart group.
  8199. </summary>
  8200. </member>
  8201. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.HasShadow">
  8202. <summary>
  8203. A bit that specifies whether one data point or more data points in the chart group have shadows.
  8204. </summary>
  8205. </member>
  8206. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.ShowLdrLines">
  8207. <summary>
  8208. A bit that specifies whether the leader lines to the data labels are shown.
  8209. </summary>
  8210. </member>
  8211. <member name="T:NPOI.HSSF.Record.Chart.AreaFormatRecord">
  8212. * The area format record is used to define the colours and patterns for an area.
  8213. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8214. * Remove the record in src/records/definitions.
  8215. * @author Glen Stampoultzis (glens at apache.org)
  8216. </member>
  8217. <member name="M:NPOI.HSSF.Record.Chart.AreaFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8218. Constructs a AreaFormat record and s its fields appropriately.
  8219. @param in the RecordInputstream to Read the record from
  8220. </member>
  8221. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.DataSize">
  8222. Size of record (exluding 4 byte header)
  8223. </member>
  8224. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForegroundColor">
  8225. the foreground color field for the AreaFormat record.
  8226. </member>
  8227. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackgroundColor">
  8228. the background color field for the AreaFormat record.
  8229. </member>
  8230. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.Pattern">
  8231. the pattern field for the AreaFormat record.
  8232. </member>
  8233. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.FormatFlags">
  8234. the format flags field for the AreaFormat record.
  8235. </member>
  8236. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForecolorIndex">
  8237. the forecolor index field for the AreaFormat record.
  8238. </member>
  8239. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackcolorIndex">
  8240. the backcolor index field for the AreaFormat record.
  8241. </member>
  8242. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsAutomatic">
  8243. automatic formatting
  8244. @return the automatic field value.
  8245. </member>
  8246. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsInvert">
  8247. swap foreground and background colours when data is negative
  8248. @return the invert field value.
  8249. </member>
  8250. <member name="T:NPOI.HSSF.Record.Chart.AreaRecord">
  8251. * The area record is used to define a area chart.
  8252. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8253. * Remove the record in src/records/definitions.
  8254. * @author Glen Stampoultzis (glens at apache.org)
  8255. </member>
  8256. <member name="M:NPOI.HSSF.Record.Chart.AreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8257. Constructs a Area record and s its fields appropriately.
  8258. @param in the RecordInputstream to Read the record from
  8259. </member>
  8260. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.DataSize">
  8261. Size of record (exluding 4 byte header)
  8262. </member>
  8263. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.FormatFlags">
  8264. the format flags field for the Area record.
  8265. </member>
  8266. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsStacked">
  8267. series is stacked
  8268. @return the stacked field value.
  8269. </member>
  8270. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsDisplayAsPercentage">
  8271. results Displayed as percentages
  8272. @return the Display as percentage field value.
  8273. </member>
  8274. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsShadow">
  8275. Display a shadow for the chart
  8276. @return the shadow field value.
  8277. </member>
  8278. <member name="T:NPOI.HSSF.Record.Chart.AxisParentRecord">
  8279. * The axis size and location
  8280. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8281. * Remove the record in src/records/definitions.
  8282. * @author Glen Stampoultzis (glens at apache.org)
  8283. </member>
  8284. <member name="M:NPOI.HSSF.Record.Chart.AxisParentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8285. Constructs a AxisParent record and s its fields appropriately.
  8286. @param in the RecordInputstream to Read the record from
  8287. </member>
  8288. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.DataSize">
  8289. Size of record (exluding 4 byte header)
  8290. </member>
  8291. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.AxisType">
  8292. the axis type field for the AxisParent record.
  8293. @return One of
  8294. AXIS_TYPE_MAIN
  8295. AXIS_TYPE_SECONDARY
  8296. </member>
  8297. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.X">
  8298. the x field for the AxisParent record.
  8299. </member>
  8300. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Y">
  8301. the y field for the AxisParent record.
  8302. </member>
  8303. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Width">
  8304. the width field for the AxisParent record.
  8305. </member>
  8306. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Height">
  8307. the height field for the AxisParent record.
  8308. </member>
  8309. <member name="T:NPOI.HSSF.Record.Chart.AxisRecord">
  8310. * The axis record defines the type of an axis.
  8311. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8312. * Remove the record in src/records/definitions.
  8313. * @author Glen Stampoultzis (glens at apache.org)
  8314. </member>
  8315. <member name="M:NPOI.HSSF.Record.Chart.AxisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8316. Constructs a Axis record and Sets its fields appropriately.
  8317. @param in the RecordInputstream to Read the record from
  8318. </member>
  8319. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.DataSize">
  8320. Size of record (exluding 4 byte header)
  8321. </member>
  8322. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.AxisType">
  8323. Get the axis type field for the Axis record.
  8324. @return One of
  8325. AXIS_TYPE_CATEGORY_OR_X_AXIS
  8326. AXIS_TYPE_VALUE_AXIS
  8327. AXIS_TYPE_SERIES_AXIS
  8328. </member>
  8329. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved1">
  8330. Get the reserved1 field for the Axis record.
  8331. </member>
  8332. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved2">
  8333. Get the reserved2 field for the Axis record.
  8334. </member>
  8335. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved3">
  8336. Get the reserved3 field for the Axis record.
  8337. </member>
  8338. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved4">
  8339. Get the reserved4 field for the Axis record.
  8340. </member>
  8341. <member name="T:NPOI.HSSF.Record.Chart.BarRecord">
  8342. * The bar record is used to define a bar chart.
  8343. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8344. * Remove the record in src/records/definitions.
  8345. * @author Glen Stampoultzis (glens at apache.org)
  8346. </member>
  8347. <member name="M:NPOI.HSSF.Record.Chart.BarRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8348. Constructs a Bar record and s its fields appropriately.
  8349. @param in the RecordInputstream to Read the record from
  8350. </member>
  8351. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.DataSize">
  8352. Size of record (exluding 4 byte header)
  8353. </member>
  8354. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.BarSpace">
  8355. the bar space field for the Bar record.
  8356. </member>
  8357. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.CategorySpace">
  8358. the category space field for the Bar record.
  8359. </member>
  8360. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.FormatFlags">
  8361. the format flags field for the Bar record.
  8362. </member>
  8363. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsHorizontal">
  8364. true to Display horizontal bar charts, false for vertical
  8365. @return the horizontal field value.
  8366. </member>
  8367. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsStacked">
  8368. stack Displayed values
  8369. @return the stacked field value.
  8370. </member>
  8371. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsDisplayAsPercentage">
  8372. Display chart values as a percentage
  8373. @return the Display as percentage field value.
  8374. </member>
  8375. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsShadow">
  8376. Display a shadow for the chart
  8377. @return the shadow field value.
  8378. </member>
  8379. <member name="T:NPOI.HSSF.Record.Chart.BeginRecord">
  8380. The begin record defines the start of a block of records for a (grpahing
  8381. data object. This record is matched with a corresponding EndRecord.
  8382. @see EndRecord
  8383. @author Glen Stampoultzis (glens at apache.org)
  8384. </member>
  8385. <member name="M:NPOI.HSSF.Record.Chart.BeginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8386. Constructs a BeginRecord record and Sets its fields appropriately.
  8387. @param in the RecordInputstream to Read the record from
  8388. </member>
  8389. <member name="T:NPOI.HSSF.Record.Chart.CatLabRecord">
  8390. CATLAB - Category Labels (0x0856)<br/>
  8391. @author Patrick Cheng
  8392. </member>
  8393. <member name="T:NPOI.HSSF.Record.Chart.ChartEndBlockRecord">
  8394. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  8395. @author Patrick Cheng
  8396. </member>
  8397. <member name="T:NPOI.HSSF.Record.Chart.ChartEndObjectRecord">
  8398. ENDOBJECT - Chart Future Record Type End Object (0x0855)<br/>
  8399. @author Patrick Cheng
  8400. </member>
  8401. <member name="T:NPOI.HSSF.Record.Chart.ChartFRTInfoRecord">
  8402. <summary>
  8403. The ChartFrtInfo record specifies the versions of the application that originally created and last saved the file.
  8404. </summary>
  8405. </member>
  8406. <member name="T:NPOI.HSSF.Record.Chart.ChartRecord">
  8407. * The chart record is used to define the location and size of a chart.
  8408. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8409. * Remove the record in src/records/definitions.
  8410. * @author Glen Stampoultzis (glens at apache.org)
  8411. </member>
  8412. <member name="M:NPOI.HSSF.Record.Chart.ChartRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8413. Constructs a Chart record and Sets its fields appropriately.
  8414. @param in the RecordInputstream to Read the record from
  8415. </member>
  8416. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.DataSize">
  8417. Size of record (exluding 4 byte header)
  8418. </member>
  8419. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.X">
  8420. Get the x field for the Chart record.
  8421. </member>
  8422. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Y">
  8423. Get the y field for the Chart record.
  8424. </member>
  8425. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Width">
  8426. Get the width field for the Chart record.
  8427. </member>
  8428. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Height">
  8429. Get the height field for the Chart record.
  8430. </member>
  8431. <member name="T:NPOI.HSSF.Record.Chart.ChartStartBlockRecord">
  8432. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  8433. @author Patrick Cheng
  8434. </member>
  8435. <member name="T:NPOI.HSSF.Record.Chart.ChartStartObjectRecord">
  8436. STARTOBJECT - Chart Future Record Type Start Object (0x0854)<br/>
  8437. @author Patrick Cheng
  8438. </member>
  8439. <member name="T:NPOI.HSSF.Record.Chart.CrtLinkRecord">
  8440. <summary>
  8441. The CrtLink record is written but unused.
  8442. </summary>
  8443. </member>
  8444. <member name="T:NPOI.HSSF.Record.Chart.DataFormatRecord">
  8445. * The data format record is used to index into a series.
  8446. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8447. * Remove the record in src/records/definitions.
  8448. * @author Glen Stampoultzis (glens at apache.org)
  8449. </member>
  8450. <member name="M:NPOI.HSSF.Record.Chart.DataFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8451. Constructs a DataFormat record and Sets its fields appropriately.
  8452. @param in the RecordInputstream to Read the record from
  8453. </member>
  8454. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.DataSize">
  8455. Size of record (exluding 4 byte header)
  8456. </member>
  8457. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.PointNumber">
  8458. Get the point number field for the DataFormat record.
  8459. </member>
  8460. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesIndex">
  8461. Get the series index field for the DataFormat record.
  8462. </member>
  8463. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesNumber">
  8464. Get the series number field for the DataFormat record.
  8465. </member>
  8466. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.FormatFlags">
  8467. Get the format flags field for the DataFormat record.
  8468. </member>
  8469. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.UseExcel4Colors">
  8470. Set true to use excel 4 colors.
  8471. @return the use excel 4 colors field value.
  8472. </member>
  8473. <member name="T:NPOI.HSSF.Record.Chart.DataLabelExtensionRecord">
  8474. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  8475. @author Patrick Cheng
  8476. </member>
  8477. <member name="T:NPOI.HSSF.Record.Chart.DatRecord">
  8478. * The dat record is used to store options for the chart.
  8479. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8480. * Remove the record in src/records/definitions.
  8481. * @author Glen Stampoultzis (glens at apache.org)
  8482. </member>
  8483. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8484. Constructs a Dat record and Sets its fields appropriately.
  8485. @param in the RecordInputstream to Read the record from
  8486. </member>
  8487. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.DataSize">
  8488. Size of record (exluding 4 byte header)
  8489. </member>
  8490. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.Options">
  8491. Get the options field for the Dat record.
  8492. </member>
  8493. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetHorizontalBorder(System.Boolean)">
  8494. Sets the horizontal border field value.
  8495. has a horizontal border
  8496. </member>
  8497. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsHorizontalBorder">
  8498. has a horizontal border
  8499. @return the horizontal border field value.
  8500. </member>
  8501. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetVerticalBorder(System.Boolean)">
  8502. Sets the vertical border field value.
  8503. has vertical border
  8504. </member>
  8505. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsVerticalBorder">
  8506. has vertical border
  8507. @return the vertical border field value.
  8508. </member>
  8509. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetBorder(System.Boolean)">
  8510. Sets the border field value.
  8511. data table has a border
  8512. </member>
  8513. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsBorder">
  8514. data table has a border
  8515. @return the border field value.
  8516. </member>
  8517. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetShowSeriesKey(System.Boolean)">
  8518. Sets the show series key field value.
  8519. shows the series key
  8520. </member>
  8521. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsShowSeriesKey">
  8522. shows the series key
  8523. @return the show series key field value.
  8524. </member>
  8525. <member name="T:NPOI.HSSF.Record.Chart.EndRecord">
  8526. The end record defines the end of a block of records for a (Graphing)
  8527. data object. This record is matched with a corresponding BeginRecord.
  8528. @see BeginRecord
  8529. @author Glen Stampoultzis (glens at apache.org)
  8530. </member>
  8531. <member name="M:NPOI.HSSF.Record.Chart.EndRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8532. Constructs a EndRecord record and Sets its fields appropriately.
  8533. @param in the RecordInputstream to Read the record from
  8534. </member>
  8535. <member name="T:NPOI.HSSF.Record.Chart.FontBasisRecord">
  8536. * The font basis record stores various font metrics.
  8537. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8538. * Remove the record in src/records/definitions.
  8539. * @author Glen Stampoultzis (glens at apache.org)
  8540. </member>
  8541. <member name="M:NPOI.HSSF.Record.Chart.FontBasisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8542. Constructs a FontBasis record and Sets its fields appropriately.
  8543. @param in the RecordInputstream to Read the record from
  8544. </member>
  8545. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.DataSize">
  8546. Size of record (exluding 4 byte header)
  8547. </member>
  8548. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.XBasis">
  8549. Get the x Basis field for the FontBasis record.
  8550. </member>
  8551. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.YBasis">
  8552. Get the y Basis field for the FontBasis record.
  8553. </member>
  8554. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.HeightBasis">
  8555. Get the height basis field for the FontBasis record.
  8556. </member>
  8557. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.Scale">
  8558. Get the scale field for the FontBasis record.
  8559. </member>
  8560. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.IndexToFontTable">
  8561. Get the index to font table field for the FontBasis record.
  8562. </member>
  8563. <member name="T:NPOI.HSSF.Record.Chart.FrameRecord">
  8564. * The frame record indicates whether there is a border around the Displayed text of a chart.
  8565. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8566. * Remove the record in src/records/definitions.
  8567. * @author Glen Stampoultzis (glens at apache.org)
  8568. </member>
  8569. <member name="M:NPOI.HSSF.Record.Chart.FrameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8570. Constructs a Frame record and Sets its fields appropriately.
  8571. @param in the RecordInputstream to Read the record from
  8572. </member>
  8573. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.DataSize">
  8574. Size of record (exluding 4 byte header)
  8575. </member>
  8576. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.BorderType">
  8577. Get the border type field for the Frame record.
  8578. @return One of
  8579. BORDER_TYPE_REGULAR
  8580. BORDER_TYPE_SHADOW
  8581. </member>
  8582. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.Options">
  8583. Get the options field for the Frame record.
  8584. </member>
  8585. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoSize">
  8586. excel calculates the size automatically if true
  8587. @return the auto size field value.
  8588. </member>
  8589. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoPosition">
  8590. excel calculates the position automatically
  8591. @return the auto position field value.
  8592. </member>
  8593. <member name="T:NPOI.HSSF.Record.Chart.LegendRecord">
  8594. * Defines a legend for a chart.
  8595. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8596. * Remove the record in src/records/definitions.
  8597. * @author Andrew C. Oliver (acoliver at apache.org)
  8598. </member>
  8599. <member name="M:NPOI.HSSF.Record.Chart.LegendRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8600. Constructs a Legend record and Sets its fields appropriately.
  8601. @param in the RecordInputstream to Read the record from
  8602. </member>
  8603. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.DataSize">
  8604. Size of record (exluding 4 byte header)
  8605. </member>
  8606. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XAxisUpperLeft">
  8607. Get the x axis upper left field for the Legend record.
  8608. </member>
  8609. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YAxisUpperLeft">
  8610. Get the y axis upper left field for the Legend record.
  8611. </member>
  8612. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XSize">
  8613. Get the x size field for the Legend record.
  8614. </member>
  8615. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YSize">
  8616. Get the y size field for the Legend record.
  8617. </member>
  8618. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Type">
  8619. Get the type field for the Legend record.
  8620. @return One of
  8621. TYPE_BOTTOM
  8622. TYPE_CORNER
  8623. TYPE_TOP
  8624. TYPE_RIGHT
  8625. TYPE_LEFT
  8626. TYPE_UNDOCKED
  8627. </member>
  8628. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Spacing">
  8629. Get the spacing field for the Legend record.
  8630. @return One of
  8631. SPACING_CLOSE
  8632. SPACING_MEDIUM
  8633. SPACING_OPEN
  8634. </member>
  8635. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Options">
  8636. Get the options field for the Legend record.
  8637. </member>
  8638. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoPosition">
  8639. automatic positioning (1=docked)
  8640. @return the auto position field value.
  8641. </member>
  8642. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoSeries">
  8643. excel 5 only (true)
  8644. @return the auto series field value.
  8645. </member>
  8646. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoXPositioning">
  8647. position of legend on the x axis is automatic
  8648. @return the auto x positioning field value.
  8649. </member>
  8650. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoYPositioning">
  8651. position of legend on the y axis is automatic
  8652. @return the auto y positioning field value.
  8653. </member>
  8654. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsVertical">
  8655. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.
  8656. @return the vertical field value.
  8657. </member>
  8658. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsDataTable">
  8659. 1 if chart Contains data table
  8660. @return the data table field value.
  8661. </member>
  8662. <member name="T:NPOI.HSSF.Record.Chart.LineFormatRecord">
  8663. * Describes a line format record. The line format record controls how a line on a chart appears.
  8664. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8665. * Remove the record in src/records/definitions.
  8666. * @author Glen Stampoultzis (glens at apache.org)
  8667. </member>
  8668. <member name="M:NPOI.HSSF.Record.Chart.LineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8669. Constructs a LineFormat record and Sets its fields appropriately.
  8670. @param in the RecordInputstream to Read the record from
  8671. </member>
  8672. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.DataSize">
  8673. Size of record (exluding 4 byte header)
  8674. </member>
  8675. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LineColor">
  8676. Get the line color field for the LineFormat record.
  8677. </member>
  8678. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LinePattern">
  8679. Get the line pattern field for the LineFormat record.
  8680. @return One of
  8681. LINE_PATTERN_SOLID
  8682. LINE_PATTERN_DASH
  8683. LINE_PATTERN_DOT
  8684. LINE_PATTERN_DASH_DOT
  8685. LINE_PATTERN_DASH_DOT_DOT
  8686. LINE_PATTERN_NONE
  8687. LINE_PATTERN_DARK_GRAY_PATTERN
  8688. LINE_PATTERN_MEDIUM_GRAY_PATTERN
  8689. LINE_PATTERN_LIGHT_GRAY_PATTERN
  8690. </member>
  8691. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Weight">
  8692. Get the weight field for the LineFormat record.
  8693. specifies the thickness of the line.
  8694. @return One of
  8695. WEIGHT_HAIRLINE
  8696. WEIGHT_NARROW
  8697. WEIGHT_MEDIUM
  8698. WEIGHT_WIDE
  8699. </member>
  8700. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Format">
  8701. Get the format field for the LineFormat record.
  8702. </member>
  8703. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.ColourPaletteIndex">
  8704. Get the colour palette index field for the LineFormat record.
  8705. </member>
  8706. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsAuto">
  8707. automatic format
  8708. @return the auto field value.
  8709. </member>
  8710. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsDrawTicks">
  8711. draw tick marks
  8712. @return the draw ticks field value.
  8713. </member>
  8714. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsUnknown">
  8715. book marks this as reserved = 0 but it seems to do something
  8716. @return the Unknown field value.
  8717. </member>
  8718. <member name="T:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord">
  8719. * The number format index record indexes format table. This applies to an axis.
  8720. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8721. * Remove the record in src/records/definitions.
  8722. * @author Glen Stampoultzis (glens at apache.org)
  8723. </member>
  8724. <member name="M:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8725. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  8726. @param in the RecordInputstream to Read the record from
  8727. </member>
  8728. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.DataSize">
  8729. Size of record (exluding 4 byte header)
  8730. </member>
  8731. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.FormatIndex">
  8732. Get the format index field for the NumberFormatIndex record.
  8733. </member>
  8734. <member name="T:NPOI.HSSF.Record.Chart.ObjectLinkRecord">
  8735. * Links text to an object on the chart or identifies it as the title.
  8736. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8737. * Remove the record in src/records/definitions.
  8738. * @author Andrew C. Oliver (acoliver at apache.org)
  8739. </member>
  8740. <member name="M:NPOI.HSSF.Record.Chart.ObjectLinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8741. Constructs a ObjectLink record and Sets its fields appropriately.
  8742. @param in the RecordInputstream to Read the record from
  8743. </member>
  8744. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.DataSize">
  8745. Size of record (exluding 4 byte header)
  8746. </member>
  8747. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.AnchorId">
  8748. Get the anchor id field for the ObjectLink record.
  8749. @return One of
  8750. ANCHOR_ID_CHART_TITLE
  8751. ANCHOR_ID_Y_AXIS
  8752. ANCHOR_ID_X_AXIS
  8753. ANCHOR_ID_SERIES_OR_POINT
  8754. ANCHOR_ID_Z_AXIS
  8755. </member>
  8756. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link1">
  8757. Get the link 1 field for the ObjectLink record.
  8758. </member>
  8759. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link2">
  8760. Get the link 2 field for the ObjectLink record.
  8761. </member>
  8762. <member name="T:NPOI.HSSF.Record.Chart.PlotAreaRecord">
  8763. * preceeds and identifies a frame as belonging to the plot area.
  8764. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8765. * Remove the record in src/records/definitions.
  8766. * @author Andrew C. Oliver (acoliver at apache.org)
  8767. </member>
  8768. <member name="M:NPOI.HSSF.Record.Chart.PlotAreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8769. Constructs a PlotArea record and Sets its fields appropriately.
  8770. @param in the RecordInputstream to Read the record from
  8771. </member>
  8772. <member name="P:NPOI.HSSF.Record.Chart.PlotAreaRecord.DataSize">
  8773. Size of record (exluding 4 byte header)
  8774. </member>
  8775. <member name="T:NPOI.HSSF.Record.Chart.PlotGrowthRecord">
  8776. * The plot growth record specifies the scaling factors used when a font is scaled.
  8777. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8778. * Remove the record in src/records/definitions.
  8779. * @author Glen Stampoultzis (glens at apache.org)
  8780. </member>
  8781. <member name="M:NPOI.HSSF.Record.Chart.PlotGrowthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8782. Constructs a PlotGrowth record and Sets its fields appropriately.
  8783. @param in the RecordInputstream to Read the record from
  8784. </member>
  8785. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.DataSize">
  8786. Size of record (exluding 4 byte header)
  8787. </member>
  8788. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.HorizontalScale">
  8789. Get the horizontalScale field for the PlotGrowth record.
  8790. </member>
  8791. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.VerticalScale">
  8792. Get the verticalScale field for the PlotGrowth record.
  8793. </member>
  8794. <member name="T:NPOI.HSSF.Record.Chart.PositionMode">
  8795. <summary>
  8796. pecifies positioning mode for position information saved in a Pos record.
  8797. </summary>
  8798. </member>
  8799. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDFX">
  8800. <summary>
  8801. Relative position to the chart, in points.
  8802. </summary>
  8803. </member>
  8804. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDABS">
  8805. <summary>
  8806. Absolute width and height in points. It can only be applied to the mdBotRt field of Pos.
  8807. </summary>
  8808. </member>
  8809. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDPARENT">
  8810. <summary>
  8811. Owner of Pos determines how to interpret the position data.
  8812. </summary>
  8813. </member>
  8814. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDKTH">
  8815. <summary>
  8816. Offset to default position, in 1/1000th of the plot area size.
  8817. </summary>
  8818. </member>
  8819. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDCHART">
  8820. <summary>
  8821. Relative position to the chart, in SPRC.
  8822. </summary>
  8823. </member>
  8824. <member name="T:NPOI.HSSF.Record.Chart.PosRecord">
  8825. <summary>
  8826. specifies the size and position for a legend, an attached label, or the plot area, as specified by the primary axis group.
  8827. </summary>
  8828. </member>
  8829. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MDTopLt">
  8830. <summary>
  8831. specifies the positioning mode for the upper-left corner of a legend, an attached label, or the plot area.
  8832. </summary>
  8833. </member>
  8834. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MdBotRt">
  8835. <summary>
  8836. specifies the positioning mode for the lower-right corner of a legend, an attached label, or the plot area
  8837. </summary>
  8838. </member>
  8839. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X1">
  8840. <summary>
  8841. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  8842. </summary>
  8843. </member>
  8844. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X2">
  8845. <summary>
  8846. specifies a width. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  8847. </summary>
  8848. </member>
  8849. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y1">
  8850. <summary>
  8851. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  8852. </summary>
  8853. </member>
  8854. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y2">
  8855. <summary>
  8856. specifies a height. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  8857. </summary>
  8858. </member>
  8859. <member name="T:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord">
  8860. * The series chart Group index record stores the index to the CHARTFORMAT record (0 based).
  8861. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8862. * Remove the record in src/records/definitions.
  8863. * @author Glen Stampoultzis (glens at apache.org)
  8864. </member>
  8865. <member name="M:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8866. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  8867. @param in the RecordInputstream to Read the record from
  8868. </member>
  8869. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.DataSize">
  8870. Size of record (exluding 4 byte header)
  8871. </member>
  8872. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.ChartGroupIndex">
  8873. Get the chart Group index field for the SeriesChartGroupIndex record.
  8874. </member>
  8875. <member name="T:NPOI.HSSF.Record.Chart.SeriesIndexRecord">
  8876. * links a series to its position in the series list.
  8877. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8878. * Remove the record in src/records/definitions.
  8879. * @author Andrew C. Oliver (acoliver at apache.org)
  8880. </member>
  8881. <member name="M:NPOI.HSSF.Record.Chart.SeriesIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8882. Constructs a SeriesIndex record and Sets its fields appropriately.
  8883. @param in the RecordInputstream to Read the record from
  8884. </member>
  8885. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.DataSize">
  8886. Size of record (exluding 4 byte header)
  8887. </member>
  8888. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.Index">
  8889. Get the index field for the SeriesIndex record.
  8890. </member>
  8891. <member name="T:NPOI.HSSF.Record.Chart.SeriesLabelsRecord">
  8892. * The series label record defines the type of label associated with the data format record.
  8893. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8894. * Remove the record in src/records/definitions.
  8895. * @author Glen Stampoultzis (glens at apache.org)
  8896. </member>
  8897. <member name="M:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8898. Constructs a SeriesLabels record and Sets its fields appropriately.
  8899. @param in the RecordInputstream to Read the record from
  8900. </member>
  8901. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.DataSize">
  8902. Size of record (exluding 4 byte header)
  8903. </member>
  8904. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.FormatFlags">
  8905. Get the format flags field for the SeriesLabels record.
  8906. </member>
  8907. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowActual">
  8908. show actual value of the data point
  8909. @return the show actual field value.
  8910. </member>
  8911. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowPercent">
  8912. show value as percentage of total (pie charts only)
  8913. @return the show percent field value.
  8914. </member>
  8915. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsLabelAsPercentage">
  8916. show category label/value as percentage (pie charts only)
  8917. @return the label as percentage field value.
  8918. </member>
  8919. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsSmoothedLine">
  8920. show smooth line
  8921. @return the smoothed line field value.
  8922. </member>
  8923. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowLabel">
  8924. Display category label
  8925. @return the show label field value.
  8926. </member>
  8927. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowBubbleSizes">
  8928. ??
  8929. @return the show bubble sizes field value.
  8930. </member>
  8931. <member name="T:NPOI.HSSF.Record.Chart.SeriesListRecord">
  8932. * The series list record defines the series Displayed as an overlay to the main chart record.
  8933. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8934. * Remove the record in src/records/definitions.
  8935. * @author Glen Stampoultzis (glens at apache.org)
  8936. </member>
  8937. <member name="M:NPOI.HSSF.Record.Chart.SeriesListRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8938. Constructs a SeriesList record and Sets its fields appropriately.
  8939. @param in the RecordInputstream to Read the record from
  8940. </member>
  8941. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.DataSize">
  8942. Size of record (exluding 4 byte header)
  8943. </member>
  8944. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.SeriesNumbers">
  8945. Get the series numbers field for the SeriesList record.
  8946. </member>
  8947. <member name="T:NPOI.HSSF.Record.Chart.SeriesRecord">
  8948. * The series record describes the overall data for a series.
  8949. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8950. * Remove the record in src/records/definitions.
  8951. * @author Glen Stampoultzis (glens at apache.org)
  8952. </member>
  8953. <member name="M:NPOI.HSSF.Record.Chart.SeriesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8954. Constructs a Series record and Sets its fields appropriately.
  8955. @param in the RecordInputstream to Read the record from
  8956. </member>
  8957. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.DataSize">
  8958. Size of record (exluding 4 byte header)
  8959. </member>
  8960. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.CategoryDataType">
  8961. Get the category data type field for the Series record.
  8962. @return One of
  8963. CATEGORY_DATA_TYPE_DATES
  8964. CATEGORY_DATA_TYPE_NUMERIC
  8965. CATEGORY_DATA_TYPE_SEQUENCE
  8966. CATEGORY_DATA_TYPE_TEXT
  8967. </member>
  8968. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.ValuesDataType">
  8969. Get the values data type field for the Series record.
  8970. @return One of
  8971. VALUES_DATA_TYPE_DATES
  8972. VALUES_DATA_TYPE_NUMERIC
  8973. VALUES_DATA_TYPE_SEQUENCE
  8974. VALUES_DATA_TYPE_TEXT
  8975. </member>
  8976. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumCategories">
  8977. Get the num categories field for the Series record.
  8978. </member>
  8979. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumValues">
  8980. Get the num values field for the Series record.
  8981. </member>
  8982. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.BubbleSeriesType">
  8983. Get the bubble series type field for the Series record.
  8984. @return One of
  8985. BUBBLE_SERIES_TYPE_DATES
  8986. BUBBLE_SERIES_TYPE_NUMERIC
  8987. BUBBLE_SERIES_TYPE_SEQUENCE
  8988. BUBBLE_SERIES_TYPE_TEXT
  8989. </member>
  8990. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumBubbleValues">
  8991. Get the num bubble values field for the Series record.
  8992. </member>
  8993. <member name="T:NPOI.HSSF.Record.Chart.SeriesTextRecord">
  8994. * Defines a series name
  8995. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  8996. * Remove the record in src/records/definitions.
  8997. * @author Andrew C. Oliver (acoliver at apache.org)
  8998. </member>
  8999. <member name="F:NPOI.HSSF.Record.Chart.SeriesTextRecord.MAX_LEN">
  9000. the actual text cannot be longer than 255 characters
  9001. </member>
  9002. <member name="M:NPOI.HSSF.Record.Chart.SeriesTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9003. Constructs a SeriesText record and Sets its fields appropriately.
  9004. @param in the RecordInputstream to Read the record from
  9005. </member>
  9006. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.DataSize">
  9007. Size of record (exluding 4 byte header)
  9008. </member>
  9009. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Id">
  9010. Get the id field for the SeriesText record.
  9011. </member>
  9012. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Text">
  9013. Get the text field for the SeriesText record.
  9014. </member>
  9015. <member name="T:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord">
  9016. * 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)
  9017. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9018. * Remove the record in src/records/definitions.
  9019. * @author Andrew C. Oliver (acoliver at apache.org)
  9020. </member>
  9021. <member name="M:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9022. Constructs a SeriesToChartGroup record and Sets its fields appropriately.
  9023. @param in the RecordInputstream to Read the record from
  9024. </member>
  9025. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.DataSize">
  9026. Size of record (exluding 4 byte header)
  9027. </member>
  9028. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.ChartGroupIndex">
  9029. Get the chart Group index field for the SeriesToChartGroup record.
  9030. </member>
  9031. <member name="T:NPOI.HSSF.Record.Chart.ValueRangeRecord">
  9032. * The value range record defines the range of the value axis.
  9033. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  9034. * Remove the record in src/records/definitions.
  9035. * @author Glen Stampoultzis (glens at apache.org)
  9036. </member>
  9037. <member name="M:NPOI.HSSF.Record.Chart.ValueRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9038. Constructs a ValueRange record and Sets its fields appropriately.
  9039. @param in the RecordInputstream to Read the record from
  9040. </member>
  9041. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.DataSize">
  9042. Size of record (exluding 4 byte header)
  9043. </member>
  9044. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinimumAxisValue">
  9045. Get the minimum axis value field for the ValueRange record.
  9046. </member>
  9047. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MaximumAxisValue">
  9048. Get the maximum axis value field for the ValueRange record.
  9049. </member>
  9050. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MajorIncrement">
  9051. Get the major increment field for the ValueRange record.
  9052. </member>
  9053. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinorIncrement">
  9054. Get the minor increment field for the ValueRange record.
  9055. </member>
  9056. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.CategoryAxisCross">
  9057. Get the category axis cross field for the ValueRange record.
  9058. </member>
  9059. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.Options">
  9060. Get the options field for the ValueRange record.
  9061. </member>
  9062. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinimum">
  9063. automatic minimum value selected
  9064. @return the automatic minimum field value.
  9065. </member>
  9066. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMaximum">
  9067. automatic maximum value selected
  9068. @return the automatic maximum field value.
  9069. </member>
  9070. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMajor">
  9071. automatic major Unit selected
  9072. @return the automatic major field value.
  9073. </member>
  9074. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinor">
  9075. automatic minor Unit selected
  9076. @return the automatic minor field value.
  9077. </member>
  9078. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticCategoryCrossing">
  9079. category crossing point is automatically selected
  9080. @return the automatic category crossing field value.
  9081. </member>
  9082. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsLogarithmicScale">
  9083. use logarithmic scale
  9084. @return the logarithmic scale field value.
  9085. </member>
  9086. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsValuesInReverse">
  9087. values are reverses in graph
  9088. @return the values in reverse field value.
  9089. </member>
  9090. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsCrossCategoryAxisAtMaximum">
  9091. category axis to cross at maximum value
  9092. @return the cross category axis at maximum field value.
  9093. </member>
  9094. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsReserved">
  9095. reserved, must equal 1 (excel dev. guide says otherwise)
  9096. @return the reserved field value.
  9097. </member>
  9098. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.Common.ExtendedColor" -->
  9099. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.ColorIndex">
  9100. @return Palette color index, if type is {@link #TYPE_INDEXED}
  9101. </member>
  9102. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.RGBA">
  9103. @return Red Green Blue Alpha, if type is {@link #TYPE_RGB}
  9104. </member>
  9105. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.ThemeIndex">
  9106. @return Theme color type index, eg {@link #THEME_DARK_1}, if type is {@link #TYPE_THEMED}
  9107. </member>
  9108. <member name="P:NPOI.HSSF.Record.Common.ExtendedColor.Tint">
  9109. @return Tint and Shade value, between -1 and +1
  9110. </member>
  9111. <member name="T:NPOI.HSSF.Record.Common.IFutureRecord">
  9112. Title: Future Record, a newer (largely Excel 2007+) record
  9113. which Contains a Future Record Header ({@link FtrHeader})
  9114. </member>
  9115. <member name="T:NPOI.HSSF.Record.Common.FeatFormulaErr2">
  9116. FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part
  9117. This record part specifies Formula Evaluation &amp; Error Ignoring data
  9118. for a sheet, stored as part of a Shared Feature. It can be found in
  9119. records such as {@link FeatRecord}.
  9120. For the full meanings of the flags, see pages 669 and 670
  9121. of the Excel binary file format documentation.
  9122. </member>
  9123. <member name="F:NPOI.HSSF.Record.Common.FeatFormulaErr2.errorCheck">
  9124. What errors we should ignore
  9125. </member>
  9126. <member name="T:NPOI.HSSF.Record.Common.FeatProtection">
  9127. Title: FeatProtection (Protection Shared Feature) common record part
  9128. This record part specifies Protection data for a sheet, stored
  9129. as part of a Shared Feature. It can be found in records such
  9130. as {@link FeatRecord}
  9131. </member>
  9132. <member name="F:NPOI.HSSF.Record.Common.FeatProtection.passwordVerifier">
  9133. 0 means no password. Otherwise indicates the
  9134. password verifier algorithm (same kind as
  9135. {@link PasswordRecord} and
  9136. {@link PasswordRev4Record})
  9137. </member>
  9138. <member name="T:NPOI.HSSF.Record.Common.FeatSmartTag">
  9139. Title: FeatSmartTag (Smart Tag Shared Feature) common record part
  9140. This record part specifies Smart Tag data for a sheet, stored as part
  9141. of a Shared Feature. It can be found in records such as {@link FeatRecord}.
  9142. It is made up of a hash, and a Set of Factoid Data that Makes up
  9143. the smart tags.
  9144. For more details, see page 669 of the Excel binary file
  9145. format documentation.
  9146. </member>
  9147. <member name="T:NPOI.HSSF.Record.Common.FtrHeader">
  9148. Title: FtrHeader (Future Record Header) common record part
  9149. This record part specifies a header for a Ftr (Future)
  9150. style record, which includes extra attributes above and
  9151. beyond those of a traditional record.
  9152. </member>
  9153. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.recordType">
  9154. This MUST match the type on the Containing record
  9155. </member>
  9156. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.grbitFrt">
  9157. This is a FrtFlags
  9158. </member>
  9159. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.associatedRange">
  9160. The range of cells the parent record applies to, or 0 if N/A
  9161. </member>
  9162. <member name="T:NPOI.HSSF.Record.Common.SharedFeature">
  9163. Common Interface for all Shared Features
  9164. </member>
  9165. <member name="T:NPOI.HSSF.Record.ContinueFrt12Record">
  9166. <summary>
  9167. The ContinueFrt12 record specifies a continuation of the data in a preceding Future Record
  9168. Type record that has data longer than 8,224 bytes. Such records are split into several records.
  9169. The first section of the data appears in the base record and subsequent sections appear in
  9170. one or more ContinueFrt12 records that appear after the base record. The preceding base record
  9171. MUST contain a FrtRefHeader or a FrtHeader field.
  9172. </summary>
  9173. <remarks>
  9174. author: Antony liu (antony.apollo at gmail.com)
  9175. </remarks>
  9176. </member>
  9177. <member name="T:NPOI.HSSF.Record.DConRefRecord">
  9178. DConRef records specify a range in a workbook (internal or external) that serves as a data source
  9179. for pivot tables or data consolidation.
  9180. Represents a <code>DConRef</code> Structure
  9181. <a href="http://msdn.microsoft.com/en-us/library/dd923854(office.12).aspx">[MS-XLS s.
  9182. 2.4.86]</a>, and the contained <code>DConFile</code> structure
  9183. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  9184. [MS-XLS s. 2.5.69]</a>. This in turn contains a <code>XLUnicodeStringNoCch</code>
  9185. <a href="http://msdn.microsoft.com/en-us/library/dd910585(office.12).aspx">
  9186. [MS-XLS s. 2.5.296]</a>.
  9187. <pre>
  9188. _______________________________
  9189. | DConRef |
  9190. (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  9191. | ref |cch| stFile | un|
  9192. +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  9193. |
  9194. _________|_____________________
  9195. |DConFile / XLUnicodeStringNoCch|
  9196. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  9197. (bits) |h| reserved | rgb |
  9198. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  9199. </pre>
  9200. Where
  9201. <ul>
  9202. <li><code>DConFile.h = 0x00</code> if the characters in<code>rgb</code> are single byte, and
  9203. <code>DConFile.h = 0x01</code> if they are double byte. <br/>
  9204. If they are double byte, then<br/>
  9205. <ul>
  9206. <li> If it exists, the length of <code>DConRef.un = 2</code>. Otherwise it is 1.</li>
  9207. <li> The length of <code>DConFile.rgb = (2 * DConRef.cch)</code>. Otherwise it is equal to
  9208. <code>DConRef.cch</code></li>.
  9209. </ul>
  9210. </li>
  9211. <li><code>DConRef.rgb</code> starts with <code>0x01</code> if it is an external reference,
  9212. and with <code>0x02</code> if it is a self-reference.</li>
  9213. </ul>
  9214. At the moment this class is read-only.
  9215. @author Niklas Rehfeld
  9216. </member>
  9217. <member name="F:NPOI.HSSF.Record.DConRefRecord.sid">
  9218. The id of the record type,
  9219. <code>sid = {@value}</code>
  9220. </member>
  9221. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstRow">
  9222. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  9223. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  9224. [MS XLS s.2.5.211]</a>
  9225. </member>
  9226. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastRow">
  9227. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  9228. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  9229. [MS XLS s.2.5.211]</a>
  9230. </member>
  9231. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstCol">
  9232. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  9233. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  9234. [MS XLS s.2.5.211]</a>
  9235. </member>
  9236. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastCol">
  9237. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  9238. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  9239. [MS XLS s.2.5.211]</a>
  9240. </member>
  9241. <member name="F:NPOI.HSSF.Record.DConRefRecord.charCount">
  9242. the number of chars in the link
  9243. </member>
  9244. <member name="F:NPOI.HSSF.Record.DConRefRecord.charType">
  9245. the type of characters (single or double byte)
  9246. </member>
  9247. <member name="F:NPOI.HSSF.Record.DConRefRecord.path">
  9248. The link's path string. This is the <code>rgb</code> field of a
  9249. <code>XLUnicodeStringNoCch</code>. Therefore it will contain at least one leading special
  9250. character (0x01 or 0x02) and probably other ones.<p/>
  9251. @see <a href="http://msdn.microsoft.com/en-us/library/dd923491(office.12).aspx">
  9252. DConFile [MS-XLS s. 2.5.77]</a> and
  9253. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  9254. VirtualPath [MS-XLS s. 2.5.69]</a>
  9255. <p/>
  9256. </member>
  9257. <member name="F:NPOI.HSSF.Record.DConRefRecord._unused">
  9258. unused bits at the end, must be set to 0.
  9259. </member>
  9260. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(System.Byte[])">
  9261. Read constructor.
  9262. @param data byte array containing a DConRef Record, including the header.
  9263. </member>
  9264. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9265. Read Constructor.
  9266. @param inStream RecordInputStream containing a DConRefRecord structure.
  9267. </member>
  9268. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstColumn">
  9269. @return The first column of the range.
  9270. </member>
  9271. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstRow">
  9272. @return The first row of the range.
  9273. </member>
  9274. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastColumn">
  9275. @return The last column of the range.
  9276. </member>
  9277. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastRow">
  9278. @return The last row of the range.
  9279. </member>
  9280. <member name="M:NPOI.HSSF.Record.DConRefRecord.GetPath">
  9281. @return raw path byte array.
  9282. </member>
  9283. <member name="P:NPOI.HSSF.Record.DConRefRecord.ReadablePath">
  9284. @return the link's path, with the special characters stripped/replaced. May be null.
  9285. See MS-XLS 2.5.277 (VirtualPath)
  9286. </member>
  9287. <member name="P:NPOI.HSSF.Record.DConRefRecord.IsExternalRef">
  9288. Checks if the data source in this reference record is external to this sheet or internal.
  9289. @return true iff this is an external reference.
  9290. </member>
  9291. <member name="T:NPOI.HSSF.Record.FtCfSubRecord">
  9292. The FtCf structure specifies the clipboard format of the picture-type Obj record Containing this FtCf.
  9293. </member>
  9294. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.METAFILE_BIT">
  9295. Specifies the format of the picture is an enhanced metafile.
  9296. </member>
  9297. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.BITMAP_BIT">
  9298. Specifies the format of the picture is a bitmap.
  9299. </member>
  9300. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.UNSPECIFIED_BIT">
  9301. Specifies the picture is in an unspecified format that is
  9302. neither and enhanced metafile nor a bitmap.
  9303. </member>
  9304. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.#ctor">
  9305. Construct a new <code>FtPioGrbitSubRecord</code> and
  9306. fill its data with the default values
  9307. </member>
  9308. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.ToString">
  9309. Convert this record to string.
  9310. Used by BiffViewer and other utilities.
  9311. </member>
  9312. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9313. Serialize the record data into the supplied array of bytes
  9314. @param out the stream to serialize into
  9315. </member>
  9316. <member name="P:NPOI.HSSF.Record.FtCfSubRecord.Sid">
  9317. @return id of this record.
  9318. </member>
  9319. <member name="T:NPOI.HSSF.Record.FtPioGrbitSubRecord">
  9320. This structure appears as part of an Obj record that represents image display properties.
  9321. </member>
  9322. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_PICT_BIT">
  9323. A bit that specifies whether the picture's aspect ratio is preserved when rendered in
  9324. different views (Normal view, Page Break Preview view, Page Layout view and printing).
  9325. </member>
  9326. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DDE_BIT">
  9327. A bit that specifies whether the pictFmla field of the Obj record that Contains
  9328. this FtPioGrbit specifies a DDE reference.
  9329. </member>
  9330. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRINT_CALC_BIT">
  9331. A bit that specifies whether this object is expected to be updated on print to
  9332. reflect the values in the cell associated with the object.
  9333. </member>
  9334. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.ICON_BIT">
  9335. A bit that specifies whether the picture is displayed as an icon.
  9336. </member>
  9337. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CTL_BIT">
  9338. A bit that specifies whether this object is an ActiveX control.
  9339. It MUST NOT be the case that both fCtl and fDde are equal to 1.
  9340. </member>
  9341. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRSTM_BIT">
  9342. A bit that specifies whether the object data are stored in an
  9343. embedding storage (= 0) or in the controls stream (ctls) (= 1).
  9344. </member>
  9345. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CAMERA_BIT">
  9346. A bit that specifies whether this is a camera picture.
  9347. </member>
  9348. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DEFAULT_SIZE_BIT">
  9349. A bit that specifies whether this picture's size has been explicitly Set.
  9350. 0 = picture size has been explicitly Set, 1 = has not been Set
  9351. </member>
  9352. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_LOAD_BIT">
  9353. A bit that specifies whether the OLE server for the object is called
  9354. to load the object's data automatically when the parent workbook is opened.
  9355. </member>
  9356. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.#ctor">
  9357. Construct a new <code>FtPioGrbitSubRecord</code> and
  9358. fill its data with the default values
  9359. </member>
  9360. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.SetFlagByBit(System.Int32,System.Boolean)">
  9361. Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT
  9362. @param bitmask
  9363. @param enabled
  9364. </member>
  9365. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.ToString">
  9366. Convert this record to string.
  9367. Used by BiffViewer and other utilities.
  9368. </member>
  9369. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9370. Serialize the record data into the supplied array of bytes
  9371. @param out the stream to serialize into
  9372. </member>
  9373. <member name="P:NPOI.HSSF.Record.FtPioGrbitSubRecord.Sid">
  9374. @return id of this record.
  9375. </member>
  9376. <member name="T:NPOI.HSSF.Record.OldCellRecord">
  9377. Base class for all old (Biff 2 - Biff 4) cell value records
  9378. (implementors of {@link CellValueRecordInterface}).
  9379. Subclasses are expected to manage the cell data values (of various types).
  9380. </member>
  9381. <member name="P:NPOI.HSSF.Record.OldCellRecord.XFIndex">
  9382. Get the index to the ExtendedFormat, for non-Biff2
  9383. @see NPOI.HSSF.Record.ExtendedFormatRecord
  9384. @return index to the XF record
  9385. </member>
  9386. <member name="P:NPOI.HSSF.Record.OldCellRecord.IsBiff2">
  9387. Is this a Biff2 record, or newer?
  9388. </member>
  9389. <member name="M:NPOI.HSSF.Record.OldCellRecord.AppendValueText(System.Text.StringBuilder)">
  9390. Append specific debug info (used by {@link #ToString()} for the value
  9391. Contained in this record. Trailing new-line should not be Appended
  9392. (superclass does that).
  9393. </member>
  9394. <member name="P:NPOI.HSSF.Record.OldCellRecord.RecordName">
  9395. Gets the debug info BIFF record type name (used by {@link #ToString()}.
  9396. </member>
  9397. <member name="T:NPOI.HSSF.Record.OldFormulaRecord">
  9398. Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in
  9399. encoded form, along with the value if a number
  9400. </member>
  9401. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Value">
  9402. Get the calculated value of the formula
  9403. @return calculated value
  9404. </member>
  9405. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Options">
  9406. Get the option flags
  9407. @return bitmask
  9408. </member>
  9409. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.ParsedExpression">
  9410. @return the formula tokens. never <code>null</code>
  9411. </member>
  9412. <member name="T:NPOI.HSSF.Record.OldLabelRecord">
  9413. Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for
  9414. strings stored directly in the cell, from the older file formats that
  9415. didn't use {@link LabelSSTRecord}
  9416. </member>
  9417. <member name="M:NPOI.HSSF.Record.OldLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9418. @param in the RecordInputstream to read the record from
  9419. </member>
  9420. <member name="P:NPOI.HSSF.Record.OldLabelRecord.StringLength">
  9421. Get the number of characters this string Contains
  9422. @return number of characters
  9423. </member>
  9424. <member name="P:NPOI.HSSF.Record.OldLabelRecord.Value">
  9425. Get the String of the cell
  9426. </member>
  9427. <member name="M:NPOI.HSSF.Record.OldLabelRecord.Serialize(System.Int32,System.Byte[])">
  9428. Not supported
  9429. </member>
  9430. <member name="T:NPOI.HSSF.Record.OldSheetRecord">
  9431. Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5<br/>
  9432. Description: Defines a sheet within a workbook. Basically stores the sheet name
  9433. and tells where the Beginning of file record is within the HSSF
  9434. file.
  9435. </member>
  9436. <member name="P:NPOI.HSSF.Record.OldSheetRecord.PositionOfBof">
  9437. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  9438. @return offset in bytes
  9439. </member>
  9440. <member name="P:NPOI.HSSF.Record.OldSheetRecord.Sheetname">
  9441. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  9442. @return sheetname the name of the sheet
  9443. </member>
  9444. <member name="T:NPOI.HSSF.Record.OldStringRecord">
  9445. Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for
  9446. formula string results.
  9447. </member>
  9448. <member name="M:NPOI.HSSF.Record.OldStringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9449. @param in the RecordInputstream to read the record from
  9450. </member>
  9451. <member name="M:NPOI.HSSF.Record.OldStringRecord.GetString">
  9452. @return The string represented by this record.
  9453. </member>
  9454. <member name="T:NPOI.HSSF.Record.RowDataRecord">
  9455. <summary>
  9456. this record only used for record that has name and not implemented.
  9457. </summary>
  9458. </member>
  9459. <member name="T:NPOI.HSSF.Record.AutoFilter.DOPERRecord">
  9460. <summary>
  9461. DOPER Structure for AutoFilter record
  9462. </summary>
  9463. <remarks>author: Tony Qu</remarks>
  9464. </member>
  9465. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.RK">
  9466. <summary>
  9467. get or set the RK record
  9468. </summary>
  9469. </member>
  9470. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.LengthOfString">
  9471. <summary>
  9472. Gets or sets Length of the string (the string is stored in the rgch field that follows the DOPER structures)
  9473. </summary>
  9474. </member>
  9475. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsBooleanValue">
  9476. <summary>
  9477. Whether the bBoolErr field contains a Boolean value
  9478. </summary>
  9479. </member>
  9480. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsErrorValue">
  9481. <summary>
  9482. Whether the bBoolErr field contains a Error value
  9483. </summary>
  9484. </member>
  9485. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.BooleanValue">
  9486. <summary>
  9487. Get or sets the boolean value
  9488. </summary>
  9489. </member>
  9490. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.ErrorValue">
  9491. <summary>
  9492. Get or sets the boolean value
  9493. </summary>
  9494. </member>
  9495. <member name="T:NPOI.HSSF.Record.UnicodeString">
  9496. Title: Unicode String<p/>
  9497. Description: Unicode String - just standard fields that are in several records.
  9498. It is considered more desirable then repeating it in all of them.<p/>
  9499. This is often called a XLUnicodeRichExtendedString in MS documentation.<p/>
  9500. REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  9501. REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214
  9502. </member>
  9503. <member name="P:NPOI.HSSF.Record.UnicodeString.ExtRst.DataSize">
  9504. Returns our size, excluding our
  9505. 4 byte header
  9506. </member>
  9507. <member name="M:NPOI.HSSF.Record.UnicodeString.Equals(System.Object)">
  9508. Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand
  9509. rich text fields yet it's difficult to make a sound comparison.
  9510. @param o The object to Compare.
  9511. @return true if the object is actually Equal.
  9512. </member>
  9513. <member name="M:NPOI.HSSF.Record.UnicodeString.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9514. construct a unicode string record and fill its fields, ID is ignored
  9515. @param in the RecordInputstream to read the record from
  9516. </member>
  9517. <member name="P:NPOI.HSSF.Record.UnicodeString.CharCount">
  9518. get the number of characters in the string,
  9519. as an un-wrapped int
  9520. @return number of characters
  9521. </member>
  9522. <member name="P:NPOI.HSSF.Record.UnicodeString.OptionFlags">
  9523. Get the option flags which among other things return if this is a 16-bit or
  9524. 8 bit string
  9525. @return optionflags bitmask
  9526. </member>
  9527. <member name="P:NPOI.HSSF.Record.UnicodeString.String">
  9528. @return the actual string this Contains as a java String object
  9529. </member>
  9530. <member name="M:NPOI.HSSF.Record.UnicodeString.AddFormatRun(NPOI.HSSF.Record.UnicodeString.FormatRun)">
  9531. Adds a font run to the formatted string.
  9532. If a font run exists at the current charcter location, then it is
  9533. Replaced with the font run to be Added.
  9534. </member>
  9535. <member name="M:NPOI.HSSF.Record.UnicodeString.SwapFontUse(System.Int16,System.Int16)">
  9536. Swaps all use in the string of one font index
  9537. for use of a different font index.
  9538. Normally only called when fonts have been
  9539. Removed / re-ordered
  9540. </member>
  9541. <member name="M:NPOI.HSSF.Record.UnicodeString.ToString">
  9542. unlike the real records we return the same as "getString()" rather than debug info
  9543. @see #getDebugInfo()
  9544. @return String value of the record
  9545. </member>
  9546. <member name="M:NPOI.HSSF.Record.UnicodeString.GetDebugInfo">
  9547. return a character representation of the fields of this record
  9548. @return String of output for biffviewer etc.
  9549. </member>
  9550. <member name="M:NPOI.HSSF.Record.UnicodeString.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  9551. Serialises out the String. There are special rules
  9552. about where we can and can't split onto
  9553. Continue records.
  9554. </member>
  9555. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordInput">
  9556. A decorated {@link RecordInputStream} that can read primitive data types
  9557. (short, int, long, etc.) spanned across a {@link ContinueRecord } boundary.
  9558. <p>
  9559. Most records construct themselves from {@link RecordInputStream}.
  9560. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary,
  9561. however, it is not always so.
  9562. </p>
  9563. Two attachments to <a href="https://issues.apache.org/bugzilla/Show_bug.cgi?id=50779">Bugzilla 50779</a>
  9564. demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character
  9565. or between two bytes of a <code>short</code>. The problematic portion of the data is
  9566. in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
  9567. <p>
  9568. {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
  9569. "Not enough data (1) to read requested (2) bytes" exception. The <code>ContinuableRecordInput</code>
  9570. class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
  9571. </p>
  9572. <p>
  9573. YK: For now (March 2011) this class is only used to read
  9574. @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.
  9575. </p>
  9576. @author Yegor Kozlov
  9577. </member>
  9578. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecord">
  9579. Common superclass of all records that can produce {@link ContinueRecord}s while being Serialized.
  9580. @author Josh Micich
  9581. </member>
  9582. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  9583. Serializes this record's content to the supplied data output.<br/>
  9584. The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so
  9585. only BIFF data should be written by this method. Simple data types can be written with the
  9586. standard {@link LittleEndianOutput} methods. Methods from {@link ContinuableRecordOutput}
  9587. can be used to Serialize strings (with {@link ContinueRecord}s being written as required).
  9588. If necessary, implementors can explicitly start {@link ContinueRecord}s (regardless of the
  9589. amount of remaining space).
  9590. @param out a data output stream
  9591. </member>
  9592. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecord.RecordSize">
  9593. @return the total Length of the encoded record(s)
  9594. (Note - if any {@link ContinueRecord} is required, this result includes the
  9595. size of those too)
  9596. </member>
  9597. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordOutput">
  9598. An augmented {@link LittleEndianOutput} used for serialization of {@link ContinuableRecord}s.
  9599. This class keeps track of how much remaining space is available in the current BIFF record and
  9600. can start new {@link ContinueRecord}s as required.
  9601. @author Josh Micich
  9602. </member>
  9603. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.TotalSize">
  9604. @return total number of bytes written so far (including all BIFF headers)
  9605. </member>
  9606. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.Terminate">
  9607. Terminates the last record (also updates its 'ushort size' field)
  9608. </member>
  9609. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.AvailableSpace">
  9610. @return number of remaining bytes of space in current record
  9611. </member>
  9612. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteContinue">
  9613. Terminates the current record and starts a new {@link ContinueRecord} (regardless
  9614. of how much space is still available in the current record).
  9615. </member>
  9616. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteStringData(System.String)">
  9617. Writes the 'optionFlags' byte and encoded character data of a unicode string. This includes:
  9618. <ul>
  9619. <li>byte optionFlags</li>
  9620. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  9621. </ul>
  9622. Notes:
  9623. <ul>
  9624. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  9625. of <c>text</c></li>
  9626. <li>The string options flag is never separated (by a {@link ContinueRecord}) from the
  9627. first chunk of character data it refers to.</li>
  9628. <li>The 'ushort Length' field is assumed to have been explicitly written earlier. Hence,
  9629. there may be an intervening {@link ContinueRecord}</li>
  9630. </ul>
  9631. </member>
  9632. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteString(System.String,System.Int32,System.Int32)">
  9633. Writes a unicode string complete with header and character data. This includes:
  9634. <ul>
  9635. <li>ushort Length</li>
  9636. <li>byte optionFlags</li>
  9637. <li>ushort numberOfRichTextRuns (optional)</li>
  9638. <li>ushort extendedDataSize (optional)</li>
  9639. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  9640. </ul>
  9641. The following bits of the 'optionFlags' byte will be set as appropriate:
  9642. <table border='1'>
  9643. <tr><th>Mask</th><th>Description</th></tr>
  9644. <tr><td>0x01</td><td>is16bitEncoded</td></tr>
  9645. <tr><td>0x04</td><td>hasExtendedData</td></tr>
  9646. <tr><td>0x08</td><td>isRichText</td></tr>
  9647. </table>
  9648. Notes:
  9649. <ul>
  9650. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  9651. of <c>text</c></li>
  9652. <li>The string header fields are never separated (by a {@link ContinueRecord}) from the
  9653. first chunk of character data (i.e. the first character is always encoded in the same
  9654. record as the string header).</li>
  9655. </ul>
  9656. </member>
  9657. <member name="F:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.NOPOutput">
  9658. **
  9659. </member>
  9660. <member name="T:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput">
  9661. Allows the writing of BIFF records when the 'ushort size' header field is not known in advance.
  9662. When the client is finished writing data, it calls {@link #terminate()}, at which point this
  9663. class updates the 'ushort size' with its value.
  9664. @author Josh Micich
  9665. </member>
  9666. <member name="F:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput._dataSizeOutput">
  9667. for writing the 'ushort size' field once its value is known
  9668. </member>
  9669. <member name="P:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.TotalSize">
  9670. includes 4 byte header
  9671. </member>
  9672. <member name="M:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.Terminate">
  9673. Finishes writing the current record and updates 'ushort size' field.<br/>
  9674. After this method is called, only {@link #getTotalSize()} may be called.
  9675. </member>
  9676. <member name="T:NPOI.HSSF.Record.FeatHdrRecord">
  9677. Title: FeatHdr (Feature Header) Record
  9678. This record specifies common information for Shared Features, and
  9679. specifies the beginning of a collection of records to define them.
  9680. The collection of data (Globals Substream ABNF, macro sheet substream
  9681. ABNF or worksheet substream ABNF) specifies Shared Feature data.
  9682. </member>
  9683. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFPROTECTION">
  9684. Specifies the enhanced protection type. Used to protect a
  9685. shared workbook by restricting access to some areas of it
  9686. </member>
  9687. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFEC2">
  9688. Specifies that formula errors should be ignored
  9689. </member>
  9690. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFACTOID">
  9691. Specifies the smart tag type. Recognises certain
  9692. types of entries (proper names, dates/times etc) and
  9693. flags them for action
  9694. </member>
  9695. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFLIST">
  9696. Specifies the shared list type. Used for a table
  9697. within a sheet
  9698. </member>
  9699. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.cbHdrData">
  9700. 0x00000000 = rgbHdrData not present
  9701. 0xffffffff = rgbHdrData present
  9702. </member>
  9703. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.rgbHdrData">
  9704. We need a BOFRecord to make sense of this...
  9705. </member>
  9706. <member name="T:NPOI.HSSF.Record.FeatRecord">
  9707. Title: Feat (Feature) Record
  9708. This record specifies Shared Features data. It is normally paired
  9709. up with a {@link FeatHdrRecord}.
  9710. </member>
  9711. <member name="F:NPOI.HSSF.Record.FeatRecord.isf_sharedFeatureType">
  9712. See SHAREDFEATURES_* on {@link FeatHdrRecord}
  9713. </member>
  9714. <member name="F:NPOI.HSSF.Record.FeatRecord.cbFeatData">
  9715. Only matters if type is ISFFEC2
  9716. </member>
  9717. <member name="F:NPOI.HSSF.Record.FeatRecord.sharedFeature">
  9718. Contents depends on isf_sharedFeatureType :
  9719. ISFPROTECTION -> FeatProtection
  9720. ISFFEC2 -> FeatFormulaErr2
  9721. ISFFACTOID -> FeatSmartTag
  9722. </member>
  9723. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.#ctor">
  9724. Construct a new <code>FtCblsSubRecord</code> and
  9725. fill its data with the default values
  9726. </member>
  9727. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.ToString">
  9728. Convert this record to string.
  9729. Used by BiffViewer and other utilities.
  9730. </member>
  9731. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9732. Serialize the record data into the supplied array of bytes
  9733. @param out the stream to serialize into
  9734. </member>
  9735. <member name="P:NPOI.HSSF.Record.FtCblsSubRecord.Sid">
  9736. @return id of this record.
  9737. </member>
  9738. <member name="T:NPOI.HSSF.Record.SheetExtRecord">
  9739. <summary>
  9740. </summary>
  9741. </member>
  9742. <member name="T:NPOI.HSSF.Record.AbstractEscherHolderRecord">
  9743. The escher container record is used to hold escher records. It is abstract and
  9744. must be subclassed for maximum benefit.
  9745. @author Glen Stampoultzis (glens at apache.org)
  9746. @author Michael Zalewski (zalewski at optonline.net)
  9747. </member>
  9748. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9749. Constructs a Bar record and Sets its fields appropriately.
  9750. @param in the RecordInputstream to Read the record from
  9751. </member>
  9752. <member name="P:NPOI.HSSF.Record.AbstractEscherHolderRecord.RecordSize">
  9753. Size of record (including 4 byte header)
  9754. </member>
  9755. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.AddEscherRecord(System.Int32,NPOI.DDF.EscherRecord)">
  9756. Clone the current record, via a call to serialise
  9757. it, and another to Create a new record from the
  9758. bytes.
  9759. May only be used for classes which don't have
  9760. internal counts / ids in them. For those which
  9761. do, a full record-aware serialise is needed, which
  9762. allocates new ids / counts as needed.
  9763. </member>
  9764. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.GetEscherContainer">
  9765. If we have a EscherContainerRecord as one of our
  9766. children (and most top level escher holders do),
  9767. then return that.
  9768. </member>
  9769. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.FindFirstWithId(System.Int16)">
  9770. Descends into all our children, returning the
  9771. first EscherRecord with the given id, or null
  9772. if none found
  9773. </member>
  9774. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Join(NPOI.HSSF.Record.AbstractEscherHolderRecord)">
  9775. Big drawing Group records are split but it's easier to deal with them
  9776. as a whole Group so we need to join them toGether.
  9777. </member>
  9778. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Decode">
  9779. Convert raw data to escher records.
  9780. </member>
  9781. <member name="T:NPOI.HSSF.Record.ArrayRecord">
  9782. ARRAY (0x0221)<p/>
  9783. Treated in a similar way to SharedFormulaRecord
  9784. @author Josh Micich
  9785. </member>
  9786. <member name="T:NPOI.HSSF.Record.BackupRecord">
  9787. Title: Backup Record
  9788. Description: bool specifying whether
  9789. the GUI should store a backup of the file.
  9790. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9791. @author Andrew C. Oliver (acoliver at apache dot org)
  9792. @version 2.0-pre
  9793. </member>
  9794. <member name="M:NPOI.HSSF.Record.BackupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9795. Constructs a BackupRecord and Sets its fields appropriately
  9796. @param in the RecordInputstream to Read the record from
  9797. </member>
  9798. <member name="P:NPOI.HSSF.Record.BackupRecord.Backup">
  9799. Get the backup flag
  9800. @return short 0/1 (off/on)
  9801. </member>
  9802. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadRecordSID">
  9803. Read an unsigned short from the stream without decrypting
  9804. </member>
  9805. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadDataSize">
  9806. Read an unsigned short from the stream without decrypting
  9807. </member>
  9808. <member name="T:NPOI.HSSF.Record.BlankRecord">
  9809. Title: Blank cell record
  9810. Description: Represents a column in a row with no value but with styling.
  9811. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9812. @author Andrew C. Oliver (acoliver at apache dot org)
  9813. @author Jason Height (jheight at chariot dot net dot au)
  9814. @version 2.0-pre
  9815. </member>
  9816. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor">
  9817. Creates a new instance of BlankRecord
  9818. </member>
  9819. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9820. Constructs a BlankRecord and Sets its fields appropriately
  9821. @param in the RecordInputstream to Read the record from
  9822. </member>
  9823. <member name="P:NPOI.HSSF.Record.BlankRecord.Row">
  9824. Get the row this cell occurs on
  9825. @return the row
  9826. </member>
  9827. <member name="P:NPOI.HSSF.Record.BlankRecord.Column">
  9828. Get the column this cell defines within the row
  9829. @return the column
  9830. </member>
  9831. <member name="P:NPOI.HSSF.Record.BlankRecord.XFIndex">
  9832. Set the index of the extended format record to style this cell with
  9833. @param xf - the 0-based index of the extended format
  9834. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  9835. </member>
  9836. <member name="P:NPOI.HSSF.Record.BlankRecord.Sid">
  9837. return the non static version of the id for this record.
  9838. </member>
  9839. <member name="M:NPOI.HSSF.Record.BlankRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9840. called by the class that is responsible for writing this sucker.
  9841. Subclasses should implement this so that their data is passed back in a
  9842. byte array.
  9843. @return byte array containing instance data
  9844. </member>
  9845. <member name="T:NPOI.HSSF.Record.BOFRecord">
  9846. Title: Beginning Of File
  9847. Description: Somewhat of a misnomer, its used for the beginning of a Set of
  9848. records that have a particular pupose or subject.
  9849. Used in sheets and workbooks.
  9850. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9851. @author Andrew C. Oliver
  9852. @author Jason Height (jheight at chariot dot net dot au)
  9853. @version 2.0-pre
  9854. </member>
  9855. <member name="F:NPOI.HSSF.Record.BOFRecord.sid">
  9856. for BIFF8 files the BOF is 0x809. For earlier versions see
  9857. {@link #biff2_sid} {@link #biff3_sid} {@link #biff4_sid}
  9858. {@link #biff5_sid}
  9859. </member>
  9860. <member name="F:NPOI.HSSF.Record.BOFRecord.VERSION">
  9861. suggested default (0x06 - BIFF8)
  9862. </member>
  9863. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD">
  9864. suggested default 0x10d3
  9865. </member>
  9866. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD_YEAR">
  9867. suggested default 0x07CC (1996)
  9868. </member>
  9869. <member name="F:NPOI.HSSF.Record.BOFRecord.HISTORY_MASK">
  9870. suggested default for a normal sheet (0x41)
  9871. </member>
  9872. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor">
  9873. Constructs an empty BOFRecord with no fields Set.
  9874. </member>
  9875. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9876. Constructs a BOFRecord and Sets its fields appropriately
  9877. @param in the RecordInputstream to Read the record from
  9878. </member>
  9879. <member name="P:NPOI.HSSF.Record.BOFRecord.Version">
  9880. Version number - for BIFF8 should be 0x06
  9881. @see #VERSION
  9882. @param version version to be Set
  9883. </member>
  9884. <member name="P:NPOI.HSSF.Record.BOFRecord.HistoryBitMask">
  9885. Set the history bit mask (not very useful)
  9886. @see #HISTORY_MASK
  9887. @param bitmask bitmask to Set for the history
  9888. </member>
  9889. <member name="P:NPOI.HSSF.Record.BOFRecord.RequiredVersion">
  9890. Set the minimum version required to Read this file
  9891. @see #VERSION
  9892. @param version version to Set
  9893. </member>
  9894. <member name="P:NPOI.HSSF.Record.BOFRecord.Type">
  9895. type of object this marks
  9896. @see #TYPE_WORKBOOK
  9897. @see #TYPE_VB_MODULE
  9898. @see #TYPE_WORKSHEET
  9899. @see #TYPE_CHART
  9900. @see #TYPE_EXCEL_4_MACRO
  9901. @see #TYPE_WORKSPACE_FILE
  9902. @return short type of object
  9903. </member>
  9904. <member name="P:NPOI.HSSF.Record.BOFRecord.Build">
  9905. Get the build that wrote this file
  9906. @see #BUILD
  9907. @return short build number of the generator of this file
  9908. </member>
  9909. <member name="P:NPOI.HSSF.Record.BOFRecord.BuildYear">
  9910. Year of the build that wrote this file
  9911. @see #BUILD_YEAR
  9912. @return short build year of the generator of this file
  9913. </member>
  9914. <member name="T:NPOI.HSSF.Record.BookBoolRecord">
  9915. Title: Save External Links record (BookBool)
  9916. Description: Contains a flag specifying whether the Gui should save externally
  9917. linked values from other workbooks.
  9918. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9919. @author Andrew C. Oliver (acoliver at apache dot org)
  9920. @version 2.0-pre
  9921. </member>
  9922. <member name="M:NPOI.HSSF.Record.BookBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9923. Constructs a BookBoolRecord and Sets its fields appropriately
  9924. @param in the RecordInputstream to Read the record from
  9925. </member>
  9926. <member name="P:NPOI.HSSF.Record.BookBoolRecord.SaveLinkValues">
  9927. Get the save ext links flag
  9928. @return short 0/1 (off/on)
  9929. </member>
  9930. <member name="T:NPOI.HSSF.Record.BoolErrRecord">
  9931. Creates new BoolErrRecord.
  9932. REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9933. @author Michael P. Harhen
  9934. @author Jason Height (jheight at chariot dot net dot au)
  9935. @version 2.0-pre
  9936. </member>
  9937. <member name="F:NPOI.HSSF.Record.BoolErrRecord._isError">
  9938. If <code>true</code>, this record represents an error cell value, otherwise this record represents a boolean cell value
  9939. </member>
  9940. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor">
  9941. Creates new BoolErrRecord
  9942. </member>
  9943. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9944. Constructs a BoolErr record and Sets its fields appropriately.
  9945. @param in the RecordInputstream to Read the record from
  9946. </member>
  9947. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Boolean)">
  9948. Set the bool value for the cell
  9949. @param value representing the bool value
  9950. </member>
  9951. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Byte)">
  9952. set the error value for the cell. See {@link FormulaError} for valid codes.
  9953. @param value error representing the error value
  9954. this value can only be 0,7,15,23,29,36 or 42
  9955. see bugzilla bug 16560 for an explanation
  9956. </member>
  9957. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(NPOI.SS.UserModel.FormulaError)">
  9958. Set the error value for the cell
  9959. @param value error representing the error value
  9960. this value can only be 0,7,15,23,29,36 or 42
  9961. see bugzilla bug 16560 for an explanation
  9962. </member>
  9963. <member name="P:NPOI.HSSF.Record.BoolErrRecord.BooleanValue">
  9964. Get the value for the cell
  9965. @return bool representing the bool value
  9966. </member>
  9967. <member name="P:NPOI.HSSF.Record.BoolErrRecord.ErrorValue">
  9968. Get the error value for the cell
  9969. @return byte representing the error value
  9970. </member>
  9971. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsBoolean">
  9972. Indicates whether the call holds a boolean value
  9973. @return boolean true if the cell holds a boolean value
  9974. </member>
  9975. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsError">
  9976. Indicates whether the call holds an error value
  9977. @return bool true if the cell holds an error value
  9978. </member>
  9979. <member name="T:NPOI.HSSF.Record.BottomMarginRecord">
  9980. Record for the bottom margin.
  9981. NOTE: This source was automatically generated.
  9982. @author Shawn Laubach (slaubach at apache dot org)
  9983. </member>
  9984. <member name="M:NPOI.HSSF.Record.BottomMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9985. Constructs a BottomMargin record and Sets its fields appropriately.
  9986. @param in the RecordInputstream to Read the record from
  9987. </member>
  9988. <member name="P:NPOI.HSSF.Record.BottomMarginRecord.Margin">
  9989. Get the margin field for the BottomMargin record.
  9990. </member>
  9991. <member name="T:NPOI.HSSF.Record.BoundSheetRecord">
  9992. Title: Bound Sheet Record (aka BundleSheet)
  9993. Description: Defines a sheet within a workbook. Basically stores the sheetname
  9994. and tells where the Beginning of file record Is within the HSSF
  9995. file.
  9996. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9997. @author Andrew C. Oliver (acoliver at apache dot org)
  9998. @author Sergei Kozello (sergeikozello at mail.ru)
  9999. </member>
  10000. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10001. Constructs a BoundSheetRecord and Sets its fields appropriately
  10002. @param in the RecordInputstream to Read the record from
  10003. </member>
  10004. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.PositionOfBof">
  10005. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  10006. @return offset in bytes
  10007. </member>
  10008. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.IsVeryHidden">
  10009. Is the sheet very hidden? Different from (normal) hidden
  10010. </member>
  10011. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.Sheetname">
  10012. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  10013. @return sheetname the name of the sheet
  10014. </member>
  10015. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.OrderByBofPosition(System.Collections.Generic.List{NPOI.HSSF.Record.BoundSheetRecord})">
  10016. Converts a List of {@link BoundSheetRecord}s to an array and sorts by the position of their
  10017. BOFs.
  10018. </member>
  10019. <member name="T:NPOI.HSSF.Record.CalcCountRecord">
  10020. Title: Calc Count Record
  10021. Description: Specifies the maximum times the gui should perform a formula
  10022. recalculation. For instance: in the case a formula includes
  10023. cells that are themselves a result of a formula and a value
  10024. Changes. This Is essentially a failsafe against an infinate
  10025. loop in the event the formulas are not independant.
  10026. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10027. @author Andrew C. Oliver (acoliver at apache dot org)
  10028. @author Jason Height (jheight at chariot dot net dot au)
  10029. @version 2.0-pre
  10030. @see org.apache.poi.hssf.record.CalcModeRecord
  10031. </member>
  10032. <member name="M:NPOI.HSSF.Record.CalcCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10033. Constructs a CalcCountRecord and Sets its fields appropriately
  10034. @param in the RecordInputstream to Read the record from
  10035. </member>
  10036. <member name="P:NPOI.HSSF.Record.CalcCountRecord.Iterations">
  10037. Get the number of iterations to perform
  10038. @return iterations
  10039. </member>
  10040. <member name="T:NPOI.HSSF.Record.CalcModeRecord">
  10041. Title: Calc Mode Record
  10042. Description: Tells the gui whether to calculate formulas
  10043. automatically, manually or automatically
  10044. except for tables.
  10045. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10046. @author Andrew C. Oliver (acoliver at apache dot org)
  10047. @author Jason Height (jheight at chariot dot net dot au)
  10048. @version 2.0-pre
  10049. @see org.apache.poi.hssf.record.CalcCountRecord
  10050. </member>
  10051. <member name="F:NPOI.HSSF.Record.CalcModeRecord.MANUAL">
  10052. manually calculate formulas (0)
  10053. </member>
  10054. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC">
  10055. automatically calculate formulas (1)
  10056. </member>
  10057. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC_EXCEPT_TABLES">
  10058. automatically calculate formulas except for tables (-1)
  10059. </member>
  10060. <member name="M:NPOI.HSSF.Record.CalcModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10061. Constructs a CalcModeRecord and Sets its fields appropriately
  10062. @param in the RecordInputstream to Read the record from
  10063. </member>
  10064. <member name="M:NPOI.HSSF.Record.CalcModeRecord.SetCalcMode(System.Int16)">
  10065. Set the calc mode flag for formulas
  10066. @see #MANUAL
  10067. @see #AUTOMATIC
  10068. @see #AUTOMATIC_EXCEPT_TABLES
  10069. @param calcmode one of the three flags above
  10070. </member>
  10071. <member name="M:NPOI.HSSF.Record.CalcModeRecord.GetCalcMode">
  10072. Get the calc mode flag for formulas
  10073. @see #MANUAL
  10074. @see #AUTOMATIC
  10075. @see #AUTOMATIC_EXCEPT_TABLES
  10076. @return calcmode one of the three flags above
  10077. </member>
  10078. <member name="P:NPOI.HSSF.Record.CellRecord.XFIndex">
  10079. get the index to the ExtendedFormat
  10080. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  10081. @return index to the XF record
  10082. </member>
  10083. <member name="M:NPOI.HSSF.Record.CellRecord.AppendValueText(System.Text.StringBuilder)">
  10084. Append specific debug info (used by {@link #toString()} for the value
  10085. contained in this record. Trailing new-line should not be Appended
  10086. (superclass does that).
  10087. </member>
  10088. <member name="P:NPOI.HSSF.Record.CellRecord.RecordName">
  10089. Gets the debug info BIFF record type name (used by {@link #toString()}.
  10090. </member>
  10091. <member name="M:NPOI.HSSF.Record.CellRecord.SerializeValue(NPOI.Util.ILittleEndianOutput)">
  10092. writes out the value data for this cell record
  10093. </member>
  10094. <member name="P:NPOI.HSSF.Record.CellRecord.ValueDataSize">
  10095. @return the size (in bytes) of the value data for this cell record
  10096. </member>
  10097. <member name="T:NPOI.HSSF.Record.CellValueRecordInterface">
  10098. The cell value record interface Is implemented by all classes of type Record that
  10099. contain cell values. It allows the containing sheet to move through them and Compare
  10100. them.
  10101. @author Andrew C. Oliver (acoliver at apache dot org)
  10102. @author Jason Height (jheight at chariot dot net dot au)
  10103. @see org.apache.poi.hssf.model.Sheet
  10104. @see org.apache.poi.hssf.record.Record
  10105. @see org.apache.poi.hssf.record.RecordFactory
  10106. </member>
  10107. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Row">
  10108. Get the row this cell occurs on
  10109. @return the row
  10110. </member>
  10111. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Column">
  10112. Get the column this cell defines within the row
  10113. @return the column
  10114. </member>
  10115. <member name="T:NPOI.HSSF.Record.CFHeaderRecord">
  10116. Conditional Formatting Header record CFHEADER (0x01B0).
  10117. Used to describe a {@link CFRuleRecord}.
  10118. @see CFHeader12Record
  10119. </member>
  10120. <member name="M:NPOI.HSSF.Record.CFHeaderRecord.#ctor">
  10121. Creates new CFHeaderRecord
  10122. </member>
  10123. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.CFRuleRecord" -->
  10124. <member name="M:NPOI.HSSF.Record.CFRuleRecord.#ctor(System.Byte,System.Byte)">
  10125. Creates new CFRuleRecord
  10126. </member>
  10127. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.String)">
  10128. Creates a new comparison operation rule
  10129. </member>
  10130. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  10131. Creates a new comparison operation rule
  10132. </member>
  10133. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  10134. called by the class that is responsible for writing this sucker.
  10135. Subclasses should implement this so that their data is passed back in a
  10136. byte array.
  10137. @param out the stream to write to
  10138. </member>
  10139. <member name="T:NPOI.HSSF.Record.ChartFormatRecord">
  10140. Class ChartFormatRecord
  10141. @author Glen Stampoultzis (glens at apache.org)
  10142. @version %I%, %G%
  10143. </member>
  10144. <member name="M:NPOI.HSSF.Record.ChartFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10145. Constructs a ChartFormatRecord record and Sets its fields appropriately.
  10146. @param in the RecordInputstream to Read the record from
  10147. </member>
  10148. <member name="T:NPOI.HSSF.Record.TextRecord">
  10149. <summary>
  10150. Section [2.4.324]. The Text record specifies the properties of an attached label and specifies the beginning of
  10151. a collection of records as defined by the chart sheet substream ABNF. This collection of records specifies an attached label.
  10152. </summary>
  10153. </member>
  10154. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_LEFT">
  10155. <summary>
  10156. Left-alignment if iReadingOrder specifies left-to-right reading order; otherwise, right-alignment
  10157. </summary>
  10158. </member>
  10159. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_CENTER">
  10160. <summary>
  10161. Center-alignment
  10162. </summary>
  10163. </member>
  10164. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_BOTTOM">
  10165. <summary>
  10166. Right-alignment if iReadingOrder specifies left-to-right reading order; otherwise, left-alignment
  10167. </summary>
  10168. </member>
  10169. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_JUSTIFY">
  10170. <summary>
  10171. Justify-alignment
  10172. </summary>
  10173. </member>
  10174. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_DISTRIBUTED">
  10175. <summary>
  10176. distributed alignment
  10177. </summary>
  10178. </member>
  10179. <member name="F:NPOI.HSSF.Record.TextRecord.VERTICAL_ALIGNMENT_DISTRIBUTED">
  10180. <summary>
  10181. distributed alignment
  10182. </summary>
  10183. </member>
  10184. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_TRANSPARENT">
  10185. <summary>
  10186. Transparent background
  10187. </summary>
  10188. </member>
  10189. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_OPAQUE">
  10190. <summary>
  10191. Opaque background
  10192. </summary>
  10193. </member>
  10194. <member name="M:NPOI.HSSF.Record.TextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10195. Constructs a Text record and Sets its fields appropriately.
  10196. @param in the RecordInputstream to Read the record from
  10197. </member>
  10198. <member name="P:NPOI.HSSF.Record.TextRecord.DataSize">
  10199. Size of record (exluding 4 byte header)
  10200. </member>
  10201. <member name="P:NPOI.HSSF.Record.TextRecord.HorizontalAlignment">
  10202. Get the horizontal alignment field for the Text record.
  10203. @return One of
  10204. HORIZONTAL_ALIGNMENT_LEFT
  10205. HORIZONTAL_ALIGNMENT_CENTER
  10206. HORIZONTAL_ALIGNMENT_BOTTOM
  10207. HORIZONTAL_ALIGNMENT_JUSTIFY
  10208. </member>
  10209. <member name="P:NPOI.HSSF.Record.TextRecord.VerticalAlignment">
  10210. Get the vertical alignment field for the Text record.
  10211. @return One of
  10212. VERTICAL_ALIGNMENT_TOP
  10213. VERTICAL_ALIGNMENT_CENTER
  10214. VERTICAL_ALIGNMENT_BOTTOM
  10215. VERTICAL_ALIGNMENT_JUSTIFY
  10216. </member>
  10217. <member name="P:NPOI.HSSF.Record.TextRecord.DisplayMode">
  10218. Get the Display mode field for the Text record.
  10219. @return One of
  10220. DISPLAY_MODE_TRANSPARENT
  10221. DISPLAY_MODE_OPAQUE
  10222. </member>
  10223. <member name="P:NPOI.HSSF.Record.TextRecord.RgbColor">
  10224. Get the rgbColor field for the Text record.
  10225. </member>
  10226. <member name="P:NPOI.HSSF.Record.TextRecord.X">
  10227. Get the x field for the Text record.
  10228. </member>
  10229. <member name="P:NPOI.HSSF.Record.TextRecord.Y">
  10230. Get the y field for the Text record.
  10231. </member>
  10232. <member name="P:NPOI.HSSF.Record.TextRecord.Width">
  10233. Set the width field for the Text record.
  10234. </member>
  10235. <member name="P:NPOI.HSSF.Record.TextRecord.Height">
  10236. Get the height field for the Text record.
  10237. </member>
  10238. <member name="P:NPOI.HSSF.Record.TextRecord.Options1">
  10239. Get the options1 field for the Text record.
  10240. </member>
  10241. <member name="P:NPOI.HSSF.Record.TextRecord.IndexOfColorValue">
  10242. Get the index of color value field for the Text record.
  10243. </member>
  10244. <member name="P:NPOI.HSSF.Record.TextRecord.Options2">
  10245. Get the options2 field for the Text record.
  10246. </member>
  10247. <member name="P:NPOI.HSSF.Record.TextRecord.TextRotation">
  10248. Get the text rotation field for the Text record.
  10249. </member>
  10250. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoColor">
  10251. true = automaticly selected colour, false = user-selected
  10252. @return the auto color field value.
  10253. </member>
  10254. <member name="P:NPOI.HSSF.Record.TextRecord.ShowKey">
  10255. true = draw legend
  10256. @return the show key field value.
  10257. </member>
  10258. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValue">
  10259. false = text is category label
  10260. @return the show value field value.
  10261. </member>
  10262. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoGeneratedText">
  10263. @return the auto generated text field value.
  10264. </member>
  10265. <member name="P:NPOI.HSSF.Record.TextRecord.IsGenerated">
  10266. @return the generated field value.
  10267. </member>
  10268. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoLabelDeleted">
  10269. @return the auto label deleted field value.
  10270. </member>
  10271. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoBackground">
  10272. @return the auto background field value.
  10273. </member>
  10274. <member name="P:NPOI.HSSF.Record.TextRecord.ShowCategoryLabelAsPercentage">
  10275. @return the show category label as percentage field value.
  10276. </member>
  10277. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValueAsPercentage">
  10278. @return the show value as percentage field value.
  10279. </member>
  10280. <member name="P:NPOI.HSSF.Record.TextRecord.ShowBubbleSizes">
  10281. @return the show bubble sizes field value.
  10282. </member>
  10283. <member name="P:NPOI.HSSF.Record.TextRecord.ShowLabel">
  10284. @return the show label field value.
  10285. </member>
  10286. <member name="P:NPOI.HSSF.Record.TextRecord.DataLabelPlacement">
  10287. @return the data label placement field value.
  10288. </member>
  10289. <member name="T:NPOI.HSSF.Record.TickRecord">
  10290. * The Tick record defines how tick marks and label positioning/formatting
  10291. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10292. * Remove the record in src/records/definitions.
  10293. * @author Andrew C. Oliver(acoliver at apache.org)
  10294. </member>
  10295. <member name="M:NPOI.HSSF.Record.TickRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10296. Constructs a Tick record and Sets its fields appropriately.
  10297. @param in the RecordInputstream to Read the record from
  10298. </member>
  10299. <member name="P:NPOI.HSSF.Record.TickRecord.DataSize">
  10300. Size of record (exluding 4 byte header)
  10301. </member>
  10302. <member name="P:NPOI.HSSF.Record.TickRecord.MajorTickType">
  10303. Get the major tick type field for the Tick record.
  10304. </member>
  10305. <member name="P:NPOI.HSSF.Record.TickRecord.MinorTickType">
  10306. Get the minor tick type field for the Tick record.
  10307. </member>
  10308. <member name="P:NPOI.HSSF.Record.TickRecord.LabelPosition">
  10309. Get the label position field for the Tick record.
  10310. </member>
  10311. <member name="P:NPOI.HSSF.Record.TickRecord.Background">
  10312. Get the background field for the Tick record.
  10313. </member>
  10314. <member name="P:NPOI.HSSF.Record.TickRecord.LabelColorRgb">
  10315. Get the label color rgb field for the Tick record.
  10316. </member>
  10317. <member name="P:NPOI.HSSF.Record.TickRecord.Zero1">
  10318. Get the zero 1 field for the Tick record.
  10319. </member>
  10320. <member name="P:NPOI.HSSF.Record.TickRecord.Zero2">
  10321. Get the zero 2 field for the Tick record.
  10322. </member>
  10323. <member name="P:NPOI.HSSF.Record.TickRecord.Options">
  10324. Get the options field for the Tick record.
  10325. </member>
  10326. <member name="P:NPOI.HSSF.Record.TickRecord.TickColor">
  10327. Get the tick color field for the Tick record.
  10328. </member>
  10329. <member name="P:NPOI.HSSF.Record.TickRecord.Zero3">
  10330. Get the zero 3 field for the Tick record.
  10331. </member>
  10332. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextColor">
  10333. use the quote Unquote automatic color for text
  10334. @return the auto text color field value.
  10335. </member>
  10336. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextBackground">
  10337. use the quote Unquote automatic color for text background
  10338. @return the auto text background field value.
  10339. </member>
  10340. <member name="P:NPOI.HSSF.Record.TickRecord.Rotation">
  10341. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)
  10342. @return the rotation field value.
  10343. </member>
  10344. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutorotate">
  10345. automatically rotate the text
  10346. @return the autorotate field value.
  10347. </member>
  10348. <member name="T:NPOI.HSSF.Record.UnitsRecord">
  10349. * The Units record describes Units.
  10350. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10351. * Remove the record in src/records/definitions.
  10352. * @author Glen Stampoultzis (glens at apache.org)
  10353. </member>
  10354. <member name="M:NPOI.HSSF.Record.UnitsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10355. Constructs a Units record and Sets its fields appropriately.
  10356. @param in the RecordInputstream to Read the record from
  10357. </member>
  10358. <member name="P:NPOI.HSSF.Record.UnitsRecord.DataSize">
  10359. Size of record (exluding 4 byte header)
  10360. </member>
  10361. <member name="P:NPOI.HSSF.Record.UnitsRecord.Units">
  10362. Get the Units field for the Units record.
  10363. </member>
  10364. <member name="T:NPOI.HSSF.Record.CodepageRecord">
  10365. Title: Codepage Record
  10366. <p>Description: the default characterset. for the workbook</p>
  10367. <p>REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)</p>
  10368. <p>Use {@link CodePageUtil} to turn these values into Java code pages
  10369. to encode/decode strings.</p>
  10370. @version 2.0-pre
  10371. </member>
  10372. <member name="F:NPOI.HSSF.Record.CodepageRecord.CODEPAGE">
  10373. Excel 97+ (Biff 8) should always store strings as UTF-16LE or
  10374. compressed versions of that. As such, this should always be
  10375. 0x4b0 = UTF_16, except for files coming from older versions.
  10376. </member>
  10377. <member name="M:NPOI.HSSF.Record.CodepageRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10378. Constructs a CodepageRecord and Sets its fields appropriately
  10379. @param in the RecordInputstream to Read the record from
  10380. </member>
  10381. <member name="P:NPOI.HSSF.Record.CodepageRecord.Codepage">
  10382. Get the codepage for this workbook
  10383. @see #CODEPAGE
  10384. @return codepage - the codepage to Set
  10385. </member>
  10386. <member name="T:NPOI.HSSF.Record.ColumnInfoRecord">
  10387. Title: COLINFO Record<p/>
  10388. Description: Defines with width and formatting for a range of columns<p/>
  10389. REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  10390. @author Andrew C. Oliver (acoliver at apache dot org)
  10391. @version 2.0-pre
  10392. </member>
  10393. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10394. Constructs a ColumnInfo record and Sets its fields appropriately
  10395. @param in the RecordInputstream to Read the record from
  10396. </member>
  10397. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.FormatMatches(NPOI.HSSF.Record.ColumnInfoRecord)">
  10398. @return true if the format, options and column width match
  10399. </member>
  10400. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.FirstColumn">
  10401. Get the first column this record defines formatting info for
  10402. @return the first column index (0-based)
  10403. </member>
  10404. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.LastColumn">
  10405. Get the last column this record defines formatting info for
  10406. @return the last column index (0-based)
  10407. </member>
  10408. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.ColumnWidth">
  10409. Get the columns' width in 1/256 of a Char width
  10410. @return column width
  10411. </member>
  10412. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.XFIndex">
  10413. Get the columns' default format info
  10414. @return the extended format index
  10415. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  10416. </member>
  10417. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.Options">
  10418. Get the options bitfield - use the bitSetters instead
  10419. @return the bitfield raw value
  10420. </member>
  10421. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsHidden">
  10422. Get whether or not these cells are hidden
  10423. @return whether the cells are hidden.
  10424. @see #SetOptions(short)
  10425. </member>
  10426. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.OutlineLevel">
  10427. Get the outline level for the cells
  10428. @see #SetOptions(short)
  10429. @return outline level for the cells
  10430. </member>
  10431. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsCollapsed">
  10432. Get whether the cells are collapsed
  10433. @return wether the cells are collapsed
  10434. @see #SetOptions(short)
  10435. </member>
  10436. <member name="T:NPOI.HSSF.Record.ContinueRecord">
  10437. Title: Continue Record - Helper class used primarily for SST Records
  10438. Description: handles overflow for prior record in the input
  10439. stream; content Is tailored to that prior record
  10440. @author Marc Johnson (mjohnson at apache dot org)
  10441. @author Andrew C. Oliver (acoliver at apache dot org)
  10442. @author Csaba Nagy (ncsaba at yahoo dot com)
  10443. @version 2.0-pre
  10444. </member>
  10445. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor">
  10446. default constructor
  10447. </member>
  10448. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10449. Main constructor -- kinda dummy because we don't validate or fill fields
  10450. @param in the RecordInputstream to Read the record from
  10451. </member>
  10452. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[])">
  10453. Writes the full encoding of a Continue record without making an instance
  10454. </member>
  10455. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[],System.Int32,System.Int32)">
  10456. @param initialDataByte (optional - often used for unicode flag).
  10457. If supplied, this will be written before srcData
  10458. @return the total number of bytes written
  10459. </member>
  10460. <member name="P:NPOI.HSSF.Record.ContinueRecord.Data">
  10461. Get the data for continuation
  10462. @return byte array containing all of the continued data
  10463. </member>
  10464. <member name="M:NPOI.HSSF.Record.ContinueRecord.ToString">
  10465. Debugging toString
  10466. @return string representation
  10467. </member>
  10468. <member name="M:NPOI.HSSF.Record.ContinueRecord.Clone">
  10469. Clone this record.
  10470. </member>
  10471. <member name="T:NPOI.HSSF.Record.CountryRecord">
  10472. Title: Country Record (aka WIN.INI country)
  10473. Description: used for localization. Currently HSSF always Sets this to 1
  10474. and it seems to work fine even in Germany. (es geht's auch fuer Deutschland)
  10475. REFERENCE: PG 298 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10476. @author Andrew C. Oliver (acoliver at apache dot org)
  10477. @version 2.0-pre
  10478. </member>
  10479. <member name="M:NPOI.HSSF.Record.CountryRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10480. Constructs a CountryRecord and Sets its fields appropriately
  10481. @param in the RecordInputstream to Read the record from
  10482. </member>
  10483. <member name="P:NPOI.HSSF.Record.CountryRecord.DefaultCountry">
  10484. Gets the default country
  10485. @return country ID (1 = US)
  10486. </member>
  10487. <member name="P:NPOI.HSSF.Record.CountryRecord.CurrentCountry">
  10488. Gets the current country
  10489. @return country ID (1 = US)
  10490. </member>
  10491. <member name="T:NPOI.HSSF.Record.CRNCountRecord">
  10492. XCT ?CRN Count
  10493. REFERENCE: 5.114
  10494. @author Josh Micich
  10495. </member>
  10496. <member name="P:NPOI.HSSF.Record.CRNCountRecord.Sid">
  10497. return the non static version of the id for this record.
  10498. </member>
  10499. <member name="T:NPOI.HSSF.Record.CRNRecord">
  10500. Title: CRN
  10501. Description: This record stores the contents of an external cell or cell range
  10502. REFERENCE: 5.23
  10503. @author josh micich
  10504. </member>
  10505. <member name="P:NPOI.HSSF.Record.CRNRecord.Sid">
  10506. return the non static version of the id for this record.
  10507. </member>
  10508. <member name="T:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream">
  10509. @author Josh Micich
  10510. </member>
  10511. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadRecordSID">
  10512. Reads an unsigned short value without decrypting
  10513. </member>
  10514. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadDataSize">
  10515. Reads an unsigned short value without decrypting
  10516. </member>
  10517. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Create(System.Byte[])">
  10518. Create using the default password and a specified docId
  10519. @param docId 16 bytes
  10520. </member>
  10521. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Validate(System.Byte[],System.Byte[])">
  10522. @return <c>true</c> if the keyDigest is compatible with the specified saltData and saltHash
  10523. </member>
  10524. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CreateRC4(System.Int32)">
  10525. The {@link RC4} instance needs to be Changed every 1024 bytes.
  10526. @param keyBlockNo used to seed the newly Created {@link RC4}
  10527. </member>
  10528. <member name="F:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey._userPasswordTLS">
  10529. Stores the BIFF8 encryption/decryption password for the current thread. This has been done
  10530. using a {@link ThreadLocal} in order to avoid further overloading the various public APIs
  10531. (e.g. {@link HSSFWorkbook}) that need this functionality.
  10532. </member>
  10533. <member name="P:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CurrentUserPassword">
  10534. @return the BIFF8 encryption/decryption password for the current thread.
  10535. <code>null</code> if it is currently unSet.
  10536. </member>
  10537. <member name="T:NPOI.HSSF.Record.Crypto.Biff8RC4">
  10538. Used for both encrypting and decrypting BIFF8 streams. The internal
  10539. {@link RC4} instance is renewed (re-keyed) every 1024 bytes.
  10540. @author Josh Micich
  10541. </member>
  10542. <member name="F:NPOI.HSSF.Record.Crypto.Biff8RC4._streamPos">
  10543. This field is used to keep track of when to change the {@link RC4}
  10544. instance. The change occurs every 1024 bytes. Every byte passed over is
  10545. counted.
  10546. </member>
  10547. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.IsNeverEncryptedRecord(System.Int32)">
  10548. TODO: Additionally, the lbPlyPos (position_of_BOF) field of the BoundSheet8 record MUST NOT be encrypted.
  10549. @return <c>true</c> if record type specified by <c>sid</c> is never encrypted
  10550. </member>
  10551. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.SkipTwoBytes">
  10552. Used when BIFF header fields (sid, size) are being Read. The internal
  10553. {@link RC4} instance must step even when unencrypted bytes are read
  10554. </member>
  10555. <member name="T:NPOI.HSSF.Record.Crypto.RC4">
  10556. Simple implementation of the alleged RC4 algorithm.
  10557. Inspired by <A HREF="http://en.wikipedia.org/wiki/RC4">wikipedia's RC4 article</A>
  10558. @author Josh Micich
  10559. </member>
  10560. <member name="P:NPOI.HSSF.Record.CustomField.Size">
  10561. @return The size of this field in bytes. This operation Is not valid
  10562. Until after the call to <c>FillField()</c>
  10563. </member>
  10564. <member name="M:NPOI.HSSF.Record.CustomField.FillField(NPOI.HSSF.Record.RecordInputStream)">
  10565. Populates this fields data from the byte array passed in1.
  10566. @param in the RecordInputstream to Read the record from
  10567. </member>
  10568. <member name="M:NPOI.HSSF.Record.CustomField.ToString(System.Text.StringBuilder)">
  10569. Appends the string representation of this field to the supplied
  10570. StringBuilder.
  10571. @param str The string buffer to Append to.
  10572. </member>
  10573. <member name="M:NPOI.HSSF.Record.CustomField.SerializeField(System.Int32,System.Byte[])">
  10574. Converts this field to it's byte array form.
  10575. @param offset The offset into the byte array to start writing to.
  10576. @param data The data array to Write to.
  10577. @return The number of bytes written.
  10578. </member>
  10579. <member name="T:NPOI.HSSF.Record.DateWindow1904Record">
  10580. Title: Date Window 1904 Flag record
  10581. Description: Flag specifying whether 1904 date windowing Is used.
  10582. (tick toc tick toc...BOOM!)
  10583. REFERENCE: PG 280 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10584. @author Andrew C. Oliver (acoliver at apache dot org)
  10585. @version 2.0-pre
  10586. </member>
  10587. <member name="M:NPOI.HSSF.Record.DateWindow1904Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10588. Constructs a DateWindow1904 record and Sets its fields appropriately.
  10589. @param in the RecordInputstream to Read the record from
  10590. </member>
  10591. <member name="P:NPOI.HSSF.Record.DateWindow1904Record.Windowing">
  10592. Gets whether or not to use 1904 date windowing (which means you'll be screwed in 2004)
  10593. @return window flag - 0/1 (false,true)
  10594. </member>
  10595. <member name="T:NPOI.HSSF.Record.DBCellRecord">
  10596. Title: DBCell Record
  10597. Description: Used by Excel and other MS apps to quickly Find rows in the sheets.
  10598. REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10599. @author Andrew C. Oliver (acoliver at apache dot org)
  10600. @author Jason Height
  10601. @version 2.0-pre
  10602. </member>
  10603. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10604. Constructs a DBCellRecord and Sets its fields appropriately
  10605. @param in the RecordInputstream to Read the record from
  10606. </member>
  10607. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(System.Int32,System.Int16[])">
  10608. offset from the start of this DBCellRecord to the start of the first cell in
  10609. the next DBCell block.
  10610. </member>
  10611. <member name="P:NPOI.HSSF.Record.DBCellRecord.RowOffset">
  10612. Gets offset from the start of this DBCellRecord to the start of the first cell in
  10613. the next DBCell block.
  10614. @return rowoffset to the start of the first cell in the next DBCell block
  10615. </member>
  10616. <member name="M:NPOI.HSSF.Record.DBCellRecord.GetCellOffsetAt(System.Int32)">
  10617. return the cell offset in the array
  10618. @param index of the cell offset to retrieve
  10619. @return celloffset from the celloffset array
  10620. </member>
  10621. <member name="P:NPOI.HSSF.Record.DBCellRecord.NumCellOffsets">
  10622. Get the number of cell offsets in the celloffset array
  10623. @return number of cell offsets
  10624. </member>
  10625. <member name="M:NPOI.HSSF.Record.DBCellRecord.CalculateSizeOfRecords(System.Int32,System.Int32)">
  10626. @returns the size of the Group of <c>DBCellRecord</c>s needed to encode
  10627. the specified number of blocks and rows
  10628. </member>
  10629. <member name="T:NPOI.HSSF.Record.DefaultColWidthRecord">
  10630. Title: Default Column Width Record
  10631. Description: Specifies the default width for columns that have no specific
  10632. width Set.
  10633. REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10634. @author Andrew C. Oliver (acoliver at apache dot org)
  10635. @author Jason Height (jheight at chariot dot net dot au)
  10636. @version 2.0-pre
  10637. </member>
  10638. <member name="F:NPOI.HSSF.Record.DefaultColWidthRecord.DEFAULT_COLUMN_WIDTH">
  10639. The default column width is 8 characters
  10640. </member>
  10641. <member name="M:NPOI.HSSF.Record.DefaultColWidthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10642. Constructs a DefaultColumnWidth record and Sets its fields appropriately.
  10643. @param in the RecordInputstream to Read the record from
  10644. </member>
  10645. <member name="P:NPOI.HSSF.Record.DefaultColWidthRecord.ColWidth">
  10646. Get the default column width
  10647. @return defaultwidth for columns
  10648. </member>
  10649. <member name="T:NPOI.HSSF.Record.DefaultRowHeightRecord">
  10650. Title: Default Row Height Record
  10651. Description: Row height for rows with Undefined or not explicitly defined
  10652. heights.
  10653. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10654. @author Andrew C. Oliver (acoliver at apache dot org)
  10655. @author Jason Height (jheight at chariot dot net dot au)
  10656. @version 2.0-pre
  10657. </member>
  10658. <member name="F:NPOI.HSSF.Record.DefaultRowHeightRecord.DEFAULT_ROW_HEIGHT">
  10659. The default row height for empty rows is 255 twips (255 / 20 == 12.75 points)
  10660. </member>
  10661. <member name="M:NPOI.HSSF.Record.DefaultRowHeightRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10662. <summary>
  10663. Constructs a DefaultRowHeight record and Sets its fields appropriately.
  10664. </summary>
  10665. <param name="in1">the RecordInputstream to Read the record from</param>
  10666. </member>
  10667. <member name="P:NPOI.HSSF.Record.DefaultRowHeightRecord.RowHeight">
  10668. <summary>
  10669. Get the default row height
  10670. </summary>
  10671. </member>
  10672. <member name="T:NPOI.HSSF.Record.DeltaRecord">
  10673. Title: Delta Record
  10674. Description: controls the accuracy of the calculations
  10675. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10676. @author Andrew C. Oliver (acoliver at apache dot org)
  10677. @author Jason Height (jheight at chariot dot net dot au)
  10678. @version 2.0-pre
  10679. </member>
  10680. <member name="M:NPOI.HSSF.Record.DeltaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10681. Constructs a Delta record and Sets its fields appropriately.
  10682. @param in the RecordInputstream to Read the record from
  10683. </member>
  10684. <member name="P:NPOI.HSSF.Record.DeltaRecord.MaxChange">
  10685. Get the maximum Change
  10686. @return maxChange - maximum rounding error
  10687. </member>
  10688. <member name="T:NPOI.HSSF.Record.DimensionsRecord">
  10689. Title: Dimensions Record
  10690. Description: provides the minumum and maximum bounds
  10691. of a sheet.
  10692. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10693. @author Andrew C. Oliver (acoliver at apache dot org)
  10694. @author Jason Height (jheight at chariot dot net dot au)
  10695. @version 2.0-pre
  10696. </member>
  10697. <member name="M:NPOI.HSSF.Record.DimensionsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10698. Constructs a Dimensions record and Sets its fields appropriately.
  10699. @param in the RecordInputstream to Read the record from
  10700. </member>
  10701. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstRow">
  10702. Get the first row number for the sheet
  10703. @return row - first row on the sheet
  10704. </member>
  10705. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastRow">
  10706. Get the last row number for the sheet
  10707. @return row - last row on the sheet
  10708. </member>
  10709. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstCol">
  10710. Get the first column number for the sheet
  10711. @return column - first column on the sheet
  10712. </member>
  10713. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastCol">
  10714. Get the last col number for the sheet
  10715. @return column - last column on the sheet
  10716. </member>
  10717. <member name="M:NPOI.HSSF.Record.DrawingGroupRecord.ProcessChildRecords">
  10718. Process the bytes into escher records.
  10719. (Not done by default in case we break things,
  10720. Unless you Set the "poi.deSerialize.escher"
  10721. system property)
  10722. </member>
  10723. <member name="P:NPOI.HSSF.Record.DrawingGroupRecord.RecordSize">
  10724. Size of record (including 4 byte headers for all sections)
  10725. </member>
  10726. <member name="T:NPOI.HSSF.Record.DrawingRecord">
  10727. DrawingRecord (0x00EC)<p/>
  10728. </member>
  10729. <member name="M:NPOI.HSSF.Record.DrawingRecord.Clone">
  10730. Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed
  10731. @return cloned drawing records
  10732. </member>
  10733. <member name="T:NPOI.HSSF.Record.DrawingRecordForBiffViewer">
  10734. This Is purely for the biff viewer. During normal operations we don't want
  10735. to be seeing this.
  10736. </member>
  10737. <member name="T:NPOI.HSSF.Record.DSFRecord">
  10738. Title: double Stream Flag Record
  10739. Description: tells if this Is a double stream file. (always no for HSSF generated files)
  10740. double Stream files contain both BIFF8 and BIFF7 workbooks.
  10741. REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10742. @author Andrew C. Oliver (acoliver at apache dot org)
  10743. @version 2.0-pre
  10744. </member>
  10745. <member name="M:NPOI.HSSF.Record.DSFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10746. Constructs a DBCellRecord and Sets its fields appropriately.
  10747. @param in the RecordInputstream to Read the record from
  10748. </member>
  10749. <member name="T:NPOI.HSSF.Record.DVALRecord">
  10750. Title: DATAVALIDATIONS Record
  10751. Description: used in data validation ;
  10752. This record Is the list header of all data validation records (0x01BE) in the current sheet.
  10753. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  10754. </member>
  10755. <member name="F:NPOI.HSSF.Record.DVALRecord.field_1_options">
  10756. Options of the DVAL
  10757. </member>
  10758. <member name="F:NPOI.HSSF.Record.DVALRecord.field_2_horiz_pos">
  10759. Horizontal position of the dialog
  10760. </member>
  10761. <member name="F:NPOI.HSSF.Record.DVALRecord.field_3_vert_pos">
  10762. Vertical position of the dialog
  10763. </member>
  10764. <member name="F:NPOI.HSSF.Record.DVALRecord.field_cbo_id">
  10765. Object ID of the drop down arrow object for list boxes ;
  10766. in our case this will be always FFFF , Until
  10767. MSODrawingGroup and MSODrawing records are implemented
  10768. </member>
  10769. <member name="F:NPOI.HSSF.Record.DVALRecord.field_5_dv_no">
  10770. Number of following DV Records
  10771. </member>
  10772. <member name="M:NPOI.HSSF.Record.DVALRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10773. Constructs a DVAL record and Sets its fields appropriately.
  10774. @param in the RecordInputstream to Read the record from
  10775. </member>
  10776. <member name="P:NPOI.HSSF.Record.DVALRecord.Options">
  10777. @return the field_1_options
  10778. </member>
  10779. <member name="P:NPOI.HSSF.Record.DVALRecord.HorizontalPos">
  10780. @return the Horizontal position of the dialog
  10781. </member>
  10782. <member name="P:NPOI.HSSF.Record.DVALRecord.VerticalPos">
  10783. @return the the Vertical position of the dialog
  10784. </member>
  10785. <member name="P:NPOI.HSSF.Record.DVALRecord.ObjectID">
  10786. Get Object ID of the drop down arrow object for list boxes
  10787. </member>
  10788. <member name="P:NPOI.HSSF.Record.DVALRecord.DVRecNo">
  10789. Get number of following DV records
  10790. </member>
  10791. <member name="T:NPOI.HSSF.Record.DVRecord">
  10792. Title: DATAVALIDATION Record (0x01BE)<p/>
  10793. Description: This record stores data validation Settings and a list of cell ranges
  10794. which contain these Settings. The data validation Settings of a sheet
  10795. are stored in a sequential list of DV records. This list Is followed by
  10796. DVAL record(s)
  10797. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  10798. @version 2.0-pre
  10799. </member>
  10800. <member name="F:NPOI.HSSF.Record.DVRecord._option_flags">
  10801. Option flags
  10802. </member>
  10803. <member name="F:NPOI.HSSF.Record.DVRecord._promptTitle">
  10804. Title of the prompt box
  10805. </member>
  10806. <member name="F:NPOI.HSSF.Record.DVRecord._errorTitle">
  10807. Title of the error box
  10808. </member>
  10809. <member name="F:NPOI.HSSF.Record.DVRecord._promptText">
  10810. Text of the prompt box
  10811. </member>
  10812. <member name="F:NPOI.HSSF.Record.DVRecord._errorText">
  10813. Text of the error box
  10814. </member>
  10815. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_1">
  10816. Not used - Excel seems to always write 0x3FE0
  10817. </member>
  10818. <member name="F:NPOI.HSSF.Record.DVRecord._formula1">
  10819. Formula data for first condition (RPN token array without size field)
  10820. </member>
  10821. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_2">
  10822. Not used - Excel seems to always write 0x0000
  10823. </member>
  10824. <member name="F:NPOI.HSSF.Record.DVRecord._formula2">
  10825. Formula data for second condition (RPN token array without size field)
  10826. </member>
  10827. <member name="F:NPOI.HSSF.Record.DVRecord._regions">
  10828. Cell range address list with all affected ranges
  10829. </member>
  10830. <member name="F:NPOI.HSSF.Record.DVRecord.opt_data_type">
  10831. Option flags field
  10832. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10833. </member>
  10834. <member name="M:NPOI.HSSF.Record.DVRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10835. Constructs a DV record and Sets its fields appropriately.
  10836. @param in the RecordInputstream to Read the record from
  10837. </member>
  10838. <member name="M:NPOI.HSSF.Record.DVRecord.ResolveTitleText(System.String)">
  10839. When entered via the UI, Excel translates empty string into "\0"
  10840. While it is possible to encode the title/text as empty string (Excel doesn't exactly crash),
  10841. the resulting tool-tip text / message box looks wrong. It is best to do the same as the
  10842. Excel UI and encode 'not present' as "\0".
  10843. </member>
  10844. <member name="P:NPOI.HSSF.Record.DVRecord.DataType">
  10845. Get the condition data type
  10846. @return the condition data type
  10847. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10848. </member>
  10849. <member name="P:NPOI.HSSF.Record.DVRecord.ErrorStyle">
  10850. Get the condition error style
  10851. @return the condition error style
  10852. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10853. </member>
  10854. <member name="P:NPOI.HSSF.Record.DVRecord.ListExplicitFormula">
  10855. return true if in list validations the string list Is explicitly given in the formula, false otherwise
  10856. @return true if in list validations the string list Is explicitly given in the formula, false otherwise
  10857. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10858. </member>
  10859. <member name="P:NPOI.HSSF.Record.DVRecord.EmptyCellAllowed">
  10860. return true if empty values are allowed in cells, false otherwise
  10861. @return if empty values are allowed in cells, false otherwise
  10862. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10863. </member>
  10864. <member name="P:NPOI.HSSF.Record.DVRecord.SuppressDropdownArrow">
  10865. @return <code>true</code> if drop down arrow should be suppressed when list validation is
  10866. used, <code>false</code> otherwise
  10867. </member>
  10868. <member name="P:NPOI.HSSF.Record.DVRecord.ShowPromptOnCellSelected">
  10869. return true if a prompt window should appear when cell Is selected, false otherwise
  10870. @return if a prompt window should appear when cell Is selected, false otherwise
  10871. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10872. </member>
  10873. <member name="P:NPOI.HSSF.Record.DVRecord.ShowErrorOnInvalidValue">
  10874. return true if an error window should appear when an invalid value Is entered in the cell, false otherwise
  10875. @return if an error window should appear when an invalid value Is entered in the cell, false otherwise
  10876. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10877. </member>
  10878. <member name="P:NPOI.HSSF.Record.DVRecord.ConditionOperator">
  10879. Get the condition operator
  10880. @return the condition operator
  10881. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  10882. </member>
  10883. <member name="P:NPOI.HSSF.Record.DVRecord.OptionFlags">
  10884. Gets the option flags field.
  10885. @return options - the option flags field
  10886. </member>
  10887. <member name="M:NPOI.HSSF.Record.DVRecord.Clone">
  10888. Clones the object. Uses serialisation, as the
  10889. contents are somewhat complex
  10890. </member>
  10891. <member name="T:NPOI.HSSF.Record.EOFRecord">
  10892. End Of File record.
  10893. Description: Marks the end of records belonging to a particular object in the
  10894. HSSF File
  10895. REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  10896. @author Andrew C. Oliver (acoliver at apache dot org)
  10897. @author Jason Height (jheight at chariot dot net dot au)
  10898. @version 2.0-pre
  10899. </member>
  10900. <member name="M:NPOI.HSSF.Record.EOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10901. Constructs a EOFRecord record and Sets its fields appropriately.
  10902. @param in the RecordInputstream to Read the record from
  10903. </member>
  10904. <member name="T:NPOI.HSSF.Record.EscherAggregate">
  10905. This class Is used to aggregate the MSODRAWING and OBJ record
  10906. combinations. This Is necessary due to the bizare way in which
  10907. these records are Serialized. What happens Is that you Get a
  10908. combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records
  10909. but the escher records are Serialized _across_ the MSODRAWING
  10910. records.
  10911. It Gets even worse when you start looking at TXO records.
  10912. So what we do with this class Is aggregate lazily. That Is
  10913. we don't aggregate the MSODRAWING -> OBJ records Unless we
  10914. need to modify them.
  10915. At first document contains 4 types of records which belong to drawing layer.
  10916. There are can be such sequence of record:
  10917. <p/>
  10918. DrawingRecord
  10919. ContinueRecord
  10920. ...
  10921. ContinueRecord
  10922. ObjRecord | TextObjectRecord
  10923. .....
  10924. ContinueRecord
  10925. ...
  10926. ContinueRecord
  10927. ObjRecord | TextObjectRecord
  10928. NoteRecord
  10929. ...
  10930. NoteRecord
  10931. <p/>
  10932. To work with shapes we have to read data from Drawing and Continue records into single array of bytes and
  10933. build escher(office art) records tree from this array.
  10934. Each shape in drawing layer matches corresponding ObjRecord
  10935. Each textbox matches corresponding TextObjectRecord
  10936. <p/>
  10937. ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)
  10938. <p/>
  10939. EscherAggrefate contains also NoteRecords
  10940. NoteRecords must be serial
  10941. @author Glen Stampoultzis (glens at apache.org)
  10942. </member>
  10943. <member name="F:NPOI.HSSF.Record.EscherAggregate.shapeToObj">
  10944. Maps shape container objects to their OBJ records
  10945. </member>
  10946. <member name="F:NPOI.HSSF.Record.EscherAggregate.tailRec">
  10947. list of "tail" records that need to be Serialized after all drawing Group records
  10948. </member>
  10949. <member name="P:NPOI.HSSF.Record.EscherAggregate.Sid">
  10950. @return Returns the current sid.
  10951. </member>
  10952. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToString">
  10953. Calculates the string representation of this record. This Is
  10954. simply a dump of all the records.
  10955. </member>
  10956. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToXml(System.String)">
  10957. Calculates the xml representation of this record. This is
  10958. simply a dump of all the records.
  10959. @param tab - string which must be added before each line (used by default '\t')
  10960. @return xml representation of the all aggregated records
  10961. </member>
  10962. <member name="M:NPOI.HSSF.Record.EscherAggregate.IsDrawingLayerRecord(System.Int16)">
  10963. @param sid - record sid we want to check if it belongs to drawing layer
  10964. @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord
  10965. </member>
  10966. <member name="M:NPOI.HSSF.Record.EscherAggregate.CreateAggregate(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  10967. Collapses the drawing records into an aggregate.
  10968. read Drawing, Obj, TxtObj, Note and Continue records into single byte array,
  10969. create Escher tree from byte array, create map &lt;EscherRecord, Record&gt;
  10970. @param records - list of all records inside sheet
  10971. @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet
  10972. @return new EscherAggregate create from all aggregated records which belong to drawing layer
  10973. </member>
  10974. <member name="M:NPOI.HSSF.Record.EscherAggregate.Serialize(System.Int32,System.Byte[])">
  10975. Serializes this aggregate to a byte array. Since this Is an aggregate
  10976. record it will effectively Serialize the aggregated records.
  10977. @param offset The offset into the start of the array.
  10978. @param data The byte array to Serialize to.
  10979. @return The number of bytes Serialized.
  10980. </member>
  10981. <member name="M:NPOI.HSSF.Record.EscherAggregate.WriteDataIntoDrawingRecord(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  10982. @param drawingData - escher records saved into single byte array
  10983. @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create
  10984. drawing or continue record)
  10985. @param pos current position of data array
  10986. @param data - array of bytes where drawing records must be serialized
  10987. @param i - number of shape, saved into data array
  10988. @return offset of data array after serialization
  10989. </member>
  10990. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherRecordSize(System.Collections.Generic.List{NPOI.DDF.EscherRecord})">
  10991. How many bytes do the raw escher records contain.
  10992. @param records List of escher records
  10993. @return the number of bytes
  10994. </member>
  10995. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetSid(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  10996. @param records list of records to look into
  10997. @param loc - location of the record which sid must be returned
  10998. @return sid of the record with selected location
  10999. </member>
  11000. <member name="P:NPOI.HSSF.Record.EscherAggregate.RecordSize">
  11001. @return record size, including header size of obj, text, note, drawing, continue records
  11002. </member>
  11003. <member name="M:NPOI.HSSF.Record.EscherAggregate.BuildBaseTree">
  11004. create base tree with such structure:
  11005. EscherDgContainer
  11006. -EscherSpgrContainer
  11007. --EscherSpContainer
  11008. ---EscherSpRecord
  11009. ---EscherSpgrRecord
  11010. ---EscherSpRecord
  11011. -EscherDgRecord
  11012. id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch
  11013. </member>
  11014. <member name="M:NPOI.HSSF.Record.EscherAggregate.Children(System.Byte[],System.Int16,System.Int32)">
  11015. Unused since this Is an aggregate record. Use CreateAggregate().
  11016. @see #CreateAggregate
  11017. </member>
  11018. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherChild(NPOI.DDF.EscherContainerRecord,System.Int32)">
  11019. Converts the Records into UserModel
  11020. objects on the bound HSSFPatriarch
  11021. </member>
  11022. <member name="M:NPOI.HSSF.Record.EscherAggregate.AssociateShapeToObjRecord(NPOI.DDF.EscherRecord,NPOI.HSSF.Record.Record)">
  11023. <summary>
  11024. Associates an escher record to an OBJ record or a TXO record.
  11025. </summary>
  11026. <param name="r">ClientData or Textbox record</param>
  11027. <param name="objRecord">Obj or TextObj record</param>
  11028. </member>
  11029. <member name="M:NPOI.HSSF.Record.EscherAggregate.RemoveShapeToObjRecord(NPOI.DDF.EscherRecord)">
  11030. <summary>
  11031. Remove echerRecord and associated to it Obj or TextObj record
  11032. </summary>
  11033. <param name="rec">clientData or textbox record to be removed</param>
  11034. </member>
  11035. <member name="P:NPOI.HSSF.Record.EscherAggregate.TailRecords">
  11036. @return unmodifiable copy of tail records. We need to access them when building shapes.
  11037. Every HSSFComment shape has a link to a NoteRecord from the tailRec collection.
  11038. </member>
  11039. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetNoteRecordByObj(NPOI.HSSF.Record.ObjRecord)">
  11040. @param obj - ObjRecord with id == NoteRecord.id
  11041. @return null if note record is not found else returns note record with id == obj.id
  11042. </member>
  11043. <member name="T:NPOI.HSSF.Record.ExtendedFormatRecord">
  11044. Title: Extended Format Record
  11045. Description: Probably one of the more complex records. There are two breeds:
  11046. Style and Cell.
  11047. It should be noted that fields in the extended format record are
  11048. somewhat arbitrary. Almost all of the fields are bit-level, but
  11049. we name them as best as possible by functional Group. In some
  11050. places this Is better than others.
  11051. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11052. @author Andrew C. Oliver (acoliver at apache dot org)
  11053. @version 2.0-pre
  11054. </member>
  11055. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor">
  11056. Constructor ExtendedFormatRecord
  11057. </member>
  11058. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11059. Constructs an ExtendedFormat record and Sets its fields appropriately.
  11060. @param in the RecordInputstream to Read the record from
  11061. </member>
  11062. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.CloneStyleFrom(NPOI.HSSF.Record.ExtendedFormatRecord)">
  11063. Clones all the style information from another
  11064. ExtendedFormatRecord, onto this one. This
  11065. will then hold all the same style options.
  11066. If The source ExtendedFormatRecord comes from
  11067. a different Workbook, you will need to sort
  11068. out the font and format indicies yourself!
  11069. </member>
  11070. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FontIndex">
  11071. <summary>
  11072. Get the index to the FONT record (which font to use 0 based)
  11073. </summary>
  11074. </member>
  11075. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FormatIndex">
  11076. <summary>
  11077. Get the index to the Format record (which FORMAT to use 0-based)
  11078. </summary>
  11079. </member>
  11080. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.CellOptions">
  11081. <summary>
  11082. Gets the options bitmask - you can also use corresponding option bit Getters
  11083. (see other methods that reference this one)
  11084. </summary>
  11085. </member>
  11086. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsLocked">
  11087. <summary>
  11088. Get whether the cell Is locked or not
  11089. </summary>
  11090. </member>
  11091. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsHidden">
  11092. <summary>
  11093. Get whether the cell Is hidden or not
  11094. </summary>
  11095. </member>
  11096. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.XFType">
  11097. <summary>
  11098. Get whether the cell Is a cell or style XFRecord
  11099. </summary>
  11100. </member>
  11101. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord._123Prefix">
  11102. <summary>
  11103. Get some old holdover from lotus 123. Who cares, its all over for Lotus.
  11104. RIP Lotus.
  11105. </summary>
  11106. </member>
  11107. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ParentIndex">
  11108. <summary>
  11109. for cell XF types this Is the parent style (usually 0/normal). For
  11110. style this should be NULL.
  11111. </summary>
  11112. </member>
  11113. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AlignmentOptions">
  11114. <summary>
  11115. Get the alignment options bitmask. See corresponding bitGetter methods
  11116. that reference this one.
  11117. </summary>
  11118. </member>
  11119. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Alignment">
  11120. <summary>
  11121. Get the horizontal alignment of the cell.
  11122. </summary>
  11123. </member>
  11124. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.WrapText">
  11125. <summary>
  11126. Get whether to wrap the text in the cell
  11127. </summary>
  11128. </member>
  11129. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.VerticalAlignment">
  11130. <summary>
  11131. Get the vertical alignment of text in the cell
  11132. </summary>
  11133. </member>
  11134. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.JustifyLast">
  11135. <summary>
  11136. Docs just say this Is for far east versions.. (I'm guessing it
  11137. justifies for right-to-left Read languages)
  11138. </summary>
  11139. </member>
  11140. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Rotation">
  11141. <summary>
  11142. Get the degree of rotation. (I've not actually seen this used anywhere)
  11143. </summary>
  11144. </member>
  11145. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IndentionOptions">
  11146. <summary>
  11147. Get the indent options bitmask (see corresponding bit Getters that reference
  11148. this field)
  11149. </summary>
  11150. </member>
  11151. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Indent">
  11152. <summary>
  11153. Get indention (not sure of the Units, think its spaces)
  11154. </summary>
  11155. </member>
  11156. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ShrinkToFit">
  11157. <summary>
  11158. Get whether to shrink the text to fit
  11159. </summary>
  11160. </member>
  11161. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.MergeCells">
  11162. <summary>
  11163. Get whether to merge cells
  11164. </summary>
  11165. </member>
  11166. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ReadingOrder">
  11167. <summary>
  11168. Get the Reading order for far east versions (0 - Context, 1 - Left to right,
  11169. 2 - right to left) - We could use some help with support for the far east.
  11170. </summary>
  11171. </member>
  11172. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFormat">
  11173. <summary>
  11174. Get whether or not to use the format in this XF instead of the parent XF.
  11175. </summary>
  11176. </member>
  11177. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFont">
  11178. <summary>
  11179. Get whether or not to use the font in this XF instead of the parent XF.
  11180. </summary>
  11181. </member>
  11182. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentAlignment">
  11183. <summary>
  11184. Get whether or not to use the alignment in this XF instead of the parent XF.
  11185. </summary>
  11186. </member>
  11187. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentBorder">
  11188. <summary>
  11189. Get whether or not to use the border in this XF instead of the parent XF.
  11190. </summary>
  11191. </member>
  11192. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentPattern">
  11193. <summary>
  11194. Get whether or not to use the pattern in this XF instead of the parent XF.
  11195. (foregrount/background)
  11196. </summary>
  11197. </member>
  11198. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentCellOptions">
  11199. <summary>
  11200. Get whether or not to use the locking/hidden in this XF instead of the parent XF.
  11201. </summary>
  11202. </member>
  11203. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderOptions">
  11204. <summary>
  11205. Get the border options bitmask (see the corresponding bit Getter methods
  11206. that reference back to this one)
  11207. </summary>
  11208. </member>
  11209. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderLeft">
  11210. <summary>
  11211. Get the borderline style for the left border
  11212. </summary>
  11213. </member>
  11214. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderRight">
  11215. <summary>
  11216. Get the borderline style for the right border
  11217. </summary>
  11218. </member>
  11219. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderTop">
  11220. <summary>
  11221. Get the borderline style for the top border
  11222. </summary>
  11223. </member>
  11224. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderBottom">
  11225. <summary>
  11226. Get the borderline style for the bottom border
  11227. </summary>
  11228. </member>
  11229. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.PaletteOptions">
  11230. <summary>
  11231. Get the palette options bitmask (see the individual bit Getter methods that
  11232. reference this one)
  11233. </summary>
  11234. </member>
  11235. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.LeftBorderPaletteIdx">
  11236. <summary>
  11237. Get the palette index for the left border color
  11238. </summary>
  11239. </member>
  11240. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.RightBorderPaletteIdx">
  11241. <summary>
  11242. Get the palette index for the right border color
  11243. </summary>
  11244. </member>
  11245. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlPaletteOptions">
  11246. <summary>
  11247. Get the Additional palette options bitmask (see individual bit Getter methods
  11248. that reference this method)
  11249. </summary>
  11250. </member>
  11251. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.TopBorderPaletteIdx">
  11252. <summary>
  11253. Get the palette index for the top border
  11254. </summary>
  11255. </member>
  11256. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BottomBorderPaletteIdx">
  11257. <summary>
  11258. Get the palette index for the bottom border
  11259. </summary>
  11260. </member>
  11261. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagBorderPaletteIdx">
  11262. <summary>
  11263. Get for diagonal borders
  11264. </summary>
  11265. </member>
  11266. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagLineStyle">
  11267. <summary>
  11268. Get the diagonal border line style
  11269. </summary>
  11270. </member>
  11271. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Diagonal">
  11272. <summary>
  11273. Not sure what this Is for (maybe Fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
  11274. </summary>
  11275. </member>
  11276. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlFillPattern">
  11277. <summary>
  11278. Get the Additional Fill pattern
  11279. </summary>
  11280. </member>
  11281. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillPaletteOptions">
  11282. <summary>
  11283. Get the Fill palette options bitmask (see indivdual bit Getters that
  11284. reference this method)
  11285. </summary>
  11286. </member>
  11287. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillForeground">
  11288. <summary>
  11289. Get the foreground palette color index
  11290. </summary>
  11291. </member>
  11292. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillBackground">
  11293. <summary>
  11294. Get the background palette color index
  11295. </summary>
  11296. </member>
  11297. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.Equals(System.Object)">
  11298. Will consider two different records with the same
  11299. contents as Equals, as the various indexes
  11300. that matter are embedded in the records
  11301. </member>
  11302. <member name="T:NPOI.HSSF.Record.ExternalNameRecord">
  11303. EXTERNALNAME<p/>
  11304. @author Josh Micich
  11305. </member>
  11306. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._ddeValues">
  11307. 'rgoper' / 'Last received results of the DDE link'
  11308. (seems to be only applicable to DDE links)<br/>
  11309. Logically this is a 2-D array, which has been flattened into 1-D array here.
  11310. </member>
  11311. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nColumns">
  11312. (logical) number of columns in the {@link #_ddeValues} array
  11313. </member>
  11314. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nRows">
  11315. (logical) number of rows in the {@link #_ddeValues} array
  11316. </member>
  11317. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsBuiltInName">
  11318. Convenience Function to determine if the name Is a built-in name
  11319. </member>
  11320. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsAutomaticLink">
  11321. For OLE and DDE, links can be either 'automatic' or 'manual'
  11322. </member>
  11323. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsPicureLink">
  11324. only for OLE and DDE
  11325. </member>
  11326. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsStdDocumentNameIdentifier">
  11327. DDE links only. If <c>true</c>, this denotes the 'StdDocumentName'
  11328. </member>
  11329. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.Text">
  11330. @return the standard String representation of this name
  11331. </member>
  11332. <member name="F:NPOI.HSSF.Record.RefSubRecord._extBookIndex">
  11333. index to External Book Block (which starts with a EXTERNALBOOK record)
  11334. </member>
  11335. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(System.Int32,System.Int32,System.Int32)">
  11336. a Constructor for making new sub record
  11337. </member>
  11338. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11339. @param in the RecordInputstream to Read the record from
  11340. </member>
  11341. <member name="M:NPOI.HSSF.Record.RefSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  11342. called by the class that is responsible for writing this sucker.
  11343. Subclasses should implement this so that their data is passed back in a
  11344. byte array.
  11345. @param offset to begin writing at
  11346. @param data byte array containing instance data
  11347. @return number of bytes written
  11348. </member>
  11349. <member name="T:NPOI.HSSF.Record.ExternSheetRecord">
  11350. Title: Extern Sheet
  11351. Description: A List of Inndexes to SupBook
  11352. REFERENCE:
  11353. @author Libin Roman (Vista Portal LDT. Developer)
  11354. @version 1.0-pre
  11355. </member>
  11356. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11357. Constructs a Extern Sheet record and Sets its fields appropriately.
  11358. @param in the RecordInputstream to Read the record from
  11359. </member>
  11360. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddRef(System.Int32,System.Int32,System.Int32)">
  11361. Add a zero-based reference to a {@link org.apache.poi.hssf.record.SupBookRecord}.
  11362. <p>
  11363. If the type of the SupBook record is same-sheet referencing, Add-In referencing,
  11364. DDE data source referencing, or OLE data source referencing,
  11365. then no scope is specified and this value <em>MUST</em> be -2. Otherwise,
  11366. the scope must be set as follows:
  11367. <ol>
  11368. <li><code>-2</code> Workbook-level reference that applies to the entire workbook.</li>
  11369. <li><code>-1</code> Sheet-level reference. </li>
  11370. <li><code>&gt;=0</code> Sheet-level reference. This specifies the first sheet in the reference.
  11371. <p>
  11372. If the SupBook type is unused or external workbook referencing,
  11373. then this value specifies the zero-based index of an external sheet name,
  11374. see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}.
  11375. This referenced string specifies the name of the first sheet within the external workbook that is in scope.
  11376. This sheet MUST be a worksheet or macro sheet.
  11377. </p>
  11378. <p>
  11379. If the supporting link type is self-referencing, then this value specifies the zero-based index of a
  11380. {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies
  11381. the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.
  11382. </p>
  11383. </li>
  11384. </ol></p>
  11385. @param firstSheetIndex the scope, must be -2 for add-in references
  11386. @param lastSheetIndex the scope, must be -2 for add-in references
  11387. @return index of newly added ref
  11388. </member>
  11389. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfREFRecords">
  11390. returns the number of REF Records, which is in model
  11391. @return number of REF records
  11392. </member>
  11393. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfRefs">
  11394. @return number of REF structures
  11395. </member>
  11396. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddREFRecord(NPOI.HSSF.Record.RefSubRecord)">
  11397. Adds REF struct (ExternSheetSubRecord)
  11398. @param rec REF struct
  11399. </member>
  11400. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetExtbookIndexFromRefIndex(System.Int32)">
  11401. Returns the index of the SupBookRecord for this index
  11402. </member>
  11403. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.FindRefIndexFromExtBookIndex(System.Int32)">
  11404. @return -1 if not found
  11405. </member>
  11406. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetFirstSheetIndexFromRefIndex(System.Int32)">
  11407. Returns the first sheet that the reference applies to, or
  11408. -1 if the referenced sheet can't be found, or -2 if the
  11409. reference is workbook scoped.
  11410. </member>
  11411. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetLastSheetIndexFromRefIndex(System.Int32)">
  11412. Returns the last sheet that the reference applies to, or
  11413. -1 if the referenced sheet can't be found, or -2 if the
  11414. reference is workbook scoped.
  11415. For a single sheet reference, the first and last should be
  11416. the same.
  11417. </member>
  11418. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  11419. called by the class that Is responsible for writing this sucker.
  11420. Subclasses should implement this so that their data Is passed back in a
  11421. byte array.
  11422. @param offset to begin writing at
  11423. @param data byte array containing instance data
  11424. @return number of bytes written
  11425. </member>
  11426. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.Sid">
  11427. return the non static version of the id for this record.
  11428. </member>
  11429. <member name="T:NPOI.HSSF.Record.ExternSheetSubRecord">
  11430. Title: A sub Record for Extern Sheet
  11431. Description: Defines a named range within a workbook.
  11432. REFERENCE:
  11433. @author Libin Roman (Vista Portal LDT. Developer)
  11434. @version 1.0-pre
  11435. </member>
  11436. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor">
  11437. a Constractor for making new sub record
  11438. </member>
  11439. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11440. Constructs a Extern Sheet Sub Record record and Sets its fields appropriately.
  11441. @param in the RecordInputstream to Read the record from
  11442. </member>
  11443. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToSupBook(System.Int16)">
  11444. Sets the Index to the sup book
  11445. @param index sup book index
  11446. </member>
  11447. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToSupBook">
  11448. Gets the index to sup book
  11449. @return sup book index
  11450. </member>
  11451. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToFirstSupBook(System.Int16)">
  11452. Sets the index to first sheet in supbook
  11453. @param index index to first sheet
  11454. </member>
  11455. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToFirstSupBook">
  11456. Gets the index to first sheet from supbook
  11457. @return index to first supbook
  11458. </member>
  11459. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToLastSupBook(System.Int16)">
  11460. Sets the index to last sheet in supbook
  11461. @param index index to last sheet
  11462. </member>
  11463. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToLastSupBook">
  11464. Gets the index to last sheet in supbook
  11465. @return index to last supbook
  11466. </member>
  11467. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.Serialize(System.Int32,System.Byte[])">
  11468. called by the class that Is responsible for writing this sucker.
  11469. Subclasses should implement this so that their data Is passed back in a
  11470. byte array.
  11471. @param offset to begin writing at
  11472. @param data byte array containing instance data
  11473. @return number of bytes written
  11474. </member>
  11475. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.RecordSize">
  11476. returns the record size
  11477. </member>
  11478. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.Sid">
  11479. return the non static version of the id for this record.
  11480. </member>
  11481. <member name="T:NPOI.HSSF.Record.InfoSubRecord">
  11482. Extended SST table info subrecord
  11483. Contains the elements of "info" in the SST's array field
  11484. @author Andrew C. Oliver (acoliver at apache dot org)
  11485. @version 2.0-pre
  11486. @see org.apache.poi.hssf.record.ExtSSTRecord
  11487. </member>
  11488. <member name="M:NPOI.HSSF.Record.InfoSubRecord.#ctor(System.Int32,System.Int32)">
  11489. Creates new ExtSSTInfoSubRecord
  11490. </member>
  11491. <member name="T:NPOI.HSSF.Record.ExtSSTRecord">
  11492. Title: Extended Static String Table
  11493. Description: This record Is used for a quick Lookup into the SST record. This
  11494. record breaks the SST table into a Set of buckets. The offsets
  11495. to these buckets within the SST record are kept as well as the
  11496. position relative to the start of the SST record.
  11497. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11498. @author Andrew C. Oliver (acoliver at apache dot org)
  11499. @author Jason Height (jheight at apache dot org)
  11500. @version 2.0-pre
  11501. @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord
  11502. </member>
  11503. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11504. Constructs a EOFRecord record and Sets its fields appropriately.
  11505. @param in the RecordInputstream to Read the record from
  11506. </member>
  11507. <member name="P:NPOI.HSSF.Record.ExtSSTRecord.DataSize">
  11508. Returns the size of this record
  11509. </member>
  11510. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.GetRecordSizeForStrings(System.Int32)">
  11511. Given a number of strings (in the sst), returns the size of the extsst record
  11512. </member>
  11513. <!-- Badly formed XML comment ignored for member "T:NPOI.HSSF.Record.FilePassRecord" -->
  11514. <member name="M:NPOI.HSSF.Record.FilePassRecord.Rc4KeyData.Clone">
  11515. <summary>
  11516. </summary>
  11517. <returns>Rc4KeyData</returns>
  11518. </member>
  11519. <member name="F:NPOI.HSSF.Record.FilePassRecord.XorKeyData._key">
  11520. key (2 bytes): An unsigned integer that specifies the obfuscation key.
  11521. See [MS-OFFCRYPTO], 2.3.6.2 section, the first step of Initializing XOR
  11522. array where it describes the generation of 16-bit XorKey value.
  11523. </member>
  11524. <member name="F:NPOI.HSSF.Record.FilePassRecord.XorKeyData._verifier">
  11525. verificationBytes (2 bytes): An unsigned integer that specifies
  11526. the password verification identifier.
  11527. </member>
  11528. <member name="M:NPOI.HSSF.Record.FilePassRecord.XorKeyData.Clone">
  11529. <summary>
  11530. </summary>
  11531. <returns>XorKeyData</returns>
  11532. </member>
  11533. <member name="M:NPOI.HSSF.Record.FilePassRecord.Clone">
  11534. <summary>
  11535. </summary>
  11536. <returns>FilePassRecord</returns>
  11537. </member>
  11538. <member name="T:NPOI.HSSF.Record.FileSharingRecord">
  11539. Title: FILESHARING
  11540. Description: stores the encrypted Readonly for a workbook (Write protect)
  11541. This functionality Is accessed from the options dialog box available when performing 'Save As'.<p/>
  11542. REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  11543. @author Andrew C. Oliver (acoliver at apache dot org)
  11544. </member>
  11545. <member name="M:NPOI.HSSF.Record.FileSharingRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11546. Constructs a FileSharing record and Sets its fields appropriately.
  11547. @param in the RecordInputstream to Read the record from
  11548. </member>
  11549. <member name="P:NPOI.HSSF.Record.FileSharingRecord.ReadOnly">
  11550. Get the Readonly
  11551. @return short representing if this Is Read only (1 = true)
  11552. </member>
  11553. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Password">
  11554. @returns password hashed with hashPassword() (very lame)
  11555. </member>
  11556. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Username">
  11557. @returns username of the user that Created the file
  11558. </member>
  11559. <member name="M:NPOI.HSSF.Record.FileSharingRecord.Clone">
  11560. Clone this record.
  11561. </member>
  11562. <member name="T:NPOI.HSSF.Record.FnGroupCountRecord">
  11563. Title: Function Group Count Record
  11564. Description: Number of built in function Groups in the current version of the
  11565. SpReadsheet (probably only used on Windoze)
  11566. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11567. @author Andrew C. Oliver (acoliver at apache dot org)
  11568. @version 2.0-pre
  11569. </member>
  11570. <member name="F:NPOI.HSSF.Record.FnGroupCountRecord.COUNT">
  11571. suggested default (14 dec)
  11572. </member>
  11573. <member name="M:NPOI.HSSF.Record.FnGroupCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11574. Constructs a FnGroupCount record and Sets its fields appropriately.
  11575. @param in the RecordInputstream to Read the record from
  11576. </member>
  11577. <member name="P:NPOI.HSSF.Record.FnGroupCountRecord.Count">
  11578. Get the number of built-in functions
  11579. @return number of built-in functions
  11580. </member>
  11581. <member name="T:NPOI.HSSF.Record.FontRecord">
  11582. Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
  11583. Description: An element in the Font Table
  11584. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11585. @author Andrew C. Oliver (acoliver at apache dot org)
  11586. @version 2.0-pre
  11587. </member>
  11588. <member name="M:NPOI.HSSF.Record.FontRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11589. Constructs a Font record and Sets its fields appropriately.
  11590. @param in the RecordInputstream to Read the record from
  11591. </member>
  11592. <member name="M:NPOI.HSSF.Record.FontRecord.CloneStyleFrom(NPOI.HSSF.Record.FontRecord)">
  11593. Clones all the font style information from another
  11594. FontRecord, onto this one. This
  11595. will then hold all the same font style options.
  11596. </member>
  11597. <member name="P:NPOI.HSSF.Record.FontRecord.IsItalic">
  11598. Set the font to be italics or not
  11599. @param italics - whether the font Is italics or not
  11600. @see #SetAttributes(short)
  11601. </member>
  11602. <member name="P:NPOI.HSSF.Record.FontRecord.IsStrikeout">
  11603. Set the font to be stricken out or not
  11604. @param strike - whether the font Is stricken out or not
  11605. @see #SetAttributes(short)
  11606. </member>
  11607. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacoutlined">
  11608. whether to use the mac outline font style thing (mac only) - Some mac person
  11609. should comment this instead of me doing it (since I have no idea)
  11610. @param mac - whether to do that mac font outline thing or not
  11611. @see #SetAttributes(short)
  11612. </member>
  11613. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacshadowed">
  11614. whether to use the mac shado font style thing (mac only) - Some mac person
  11615. should comment this instead of me doing it (since I have no idea)
  11616. @param mac - whether to do that mac font shadow thing or not
  11617. @see #SetAttributes(short)
  11618. </member>
  11619. <member name="P:NPOI.HSSF.Record.FontRecord.Underline">
  11620. Set the type of Underlining for the font
  11621. </member>
  11622. <member name="P:NPOI.HSSF.Record.FontRecord.Family">
  11623. Set the font family (TODO)
  11624. @param f family
  11625. </member>
  11626. <member name="P:NPOI.HSSF.Record.FontRecord.Charset">
  11627. Set the Char Set
  11628. @param charSet - CharSet
  11629. </member>
  11630. <member name="P:NPOI.HSSF.Record.FontRecord.FontName">
  11631. Set the name of the font
  11632. @param fn - name of the font (i.e. "Arial")
  11633. </member>
  11634. <member name="P:NPOI.HSSF.Record.FontRecord.FontHeight">
  11635. Gets the height of the font in 1/20th point Units
  11636. @return fontheight (in points/20)
  11637. </member>
  11638. <member name="P:NPOI.HSSF.Record.FontRecord.Attributes">
  11639. Get the font attributes (see individual bit Getters that reference this method)
  11640. @return attribute - the bitmask
  11641. </member>
  11642. <member name="P:NPOI.HSSF.Record.FontRecord.ColorPaletteIndex">
  11643. Get the font's color palette index
  11644. @return cpi - font color index
  11645. </member>
  11646. <member name="P:NPOI.HSSF.Record.FontRecord.BoldWeight">
  11647. Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  11648. 0x190 for normal and 0x2bc for bold
  11649. @return bw - a number between 100-1000 for the fonts "boldness"
  11650. </member>
  11651. <member name="P:NPOI.HSSF.Record.FontRecord.SuperSubScript">
  11652. Get the type of base or subscript for the font
  11653. @return base or subscript option
  11654. </member>
  11655. <member name="M:NPOI.HSSF.Record.FontRecord.SameProperties(NPOI.HSSF.Record.FontRecord)">
  11656. Does this FontRecord have all the same font
  11657. properties as the supplied FontRecord?
  11658. Note that {@link #equals(Object)} will check
  11659. for exact objects, while this will check
  11660. for exact contents, because normally the
  11661. font record's position makes a big
  11662. difference too.
  11663. </member>
  11664. <member name="M:NPOI.HSSF.Record.FontRecord.Equals(System.Object)">
  11665. Only returns two for the same exact object -
  11666. creating a second FontRecord with the same
  11667. properties won't be considered equal, as
  11668. the record's position in the record stream
  11669. matters.
  11670. </member>
  11671. <member name="T:NPOI.HSSF.Record.FooterRecord">
  11672. Title: Footer Record
  11673. Description: Specifies the footer for a sheet
  11674. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11675. @author Andrew C. Oliver (acoliver at apache dot org)
  11676. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  11677. @author Jason Height (jheight at chariot dot net dot au)
  11678. @version 2.0-pre
  11679. </member>
  11680. <member name="M:NPOI.HSSF.Record.FooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11681. <summary>
  11682. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.FooterRecord"/> class.
  11683. </summary>
  11684. <param name="in1">the RecordInputstream to Read the record from</param>
  11685. </member>
  11686. <member name="M:NPOI.HSSF.Record.FooterRecord.ToString">
  11687. <summary>
  11688. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  11689. </summary>
  11690. <returns>
  11691. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  11692. </returns>
  11693. </member>
  11694. <member name="P:NPOI.HSSF.Record.FooterRecord.Sid">
  11695. <summary>
  11696. </summary>
  11697. <value></value>
  11698. return the non static version of the id for this record.
  11699. </member>
  11700. <member name="T:NPOI.HSSF.Record.FormatRecord">
  11701. Title: Format Record
  11702. Description: describes a number format -- those goofy strings like $(#,###)
  11703. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11704. @author Andrew C. Oliver (acoliver at apache dot org)
  11705. @author Shawn M. Laubach (slaubach at apache dot org)
  11706. @version 2.0-pre
  11707. </member>
  11708. <member name="M:NPOI.HSSF.Record.FormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11709. Constructs a Format record and Sets its fields appropriately.
  11710. @param in the RecordInputstream to Read the record from
  11711. </member>
  11712. <member name="P:NPOI.HSSF.Record.FormatRecord.IndexCode">
  11713. Get the format index code (for built in formats)
  11714. @return the format index code
  11715. @see org.apache.poi.hssf.model.Workbook
  11716. </member>
  11717. <member name="P:NPOI.HSSF.Record.FormatRecord.FormatString">
  11718. Get the format string
  11719. @return the format string
  11720. </member>
  11721. <member name="T:NPOI.HSSF.Record.SpecialCachedValue">
  11722. Manages the cached formula result values of other types besides numeric.
  11723. Excel encodes the same 8 bytes that would be field_4_value with various NaN
  11724. values that are decoded/encoded by this class.
  11725. </member>
  11726. <member name="F:NPOI.HSSF.Record.SpecialCachedValue.BIT_MARKER">
  11727. deliberately chosen by Excel in order to encode other values within Double NaNs
  11728. </member>
  11729. <member name="M:NPOI.HSSF.Record.SpecialCachedValue.Create(System.Int64)">
  11730. @return <c>null</c> if the double value encoded by <c>valueLongBits</c>
  11731. is a normal (non NaN) double value.
  11732. </member>
  11733. <member name="T:NPOI.HSSF.Record.FormulaRecord">
  11734. Formula Record.
  11735. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11736. @author Andrew C. Oliver (acoliver at apache dot org)
  11737. @author Jason Height (jheight at chariot dot net dot au)
  11738. @version 2.0-pre
  11739. </member>
  11740. <member name="F:NPOI.HSSF.Record.FormulaRecord.specialCachedValue">
  11741. Since the NaN support seems sketchy (different constants) we'll store and spit it out directly
  11742. </member>
  11743. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor">
  11744. Creates new FormulaRecord
  11745. </member>
  11746. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11747. Constructs a Formula record and Sets its fields appropriately.
  11748. Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an
  11749. "explanation of this bug in the documentation) or an exception
  11750. will be throw upon validation
  11751. @param in the RecordInputstream to Read the record from
  11752. </member>
  11753. <member name="P:NPOI.HSSF.Record.FormulaRecord.HasCachedResultString">
  11754. @return <c>true</c> if this {@link FormulaRecord} is followed by a
  11755. {@link StringRecord} representing the cached text result of the formula
  11756. evaluation.
  11757. </member>
  11758. <member name="P:NPOI.HSSF.Record.FormulaRecord.Value">
  11759. Get the calculated value of the formula
  11760. @return calculated value
  11761. </member>
  11762. <member name="P:NPOI.HSSF.Record.FormulaRecord.Options">
  11763. Get the option flags
  11764. @return bitmask
  11765. </member>
  11766. <member name="P:NPOI.HSSF.Record.FormulaRecord.ParsedExpression">
  11767. Get the stack as a list
  11768. @return list of tokens (casts stack to a list and returns it!)
  11769. this method can return null Is we are Unable to Create Ptgs from
  11770. existing excel file
  11771. callers should Check for null!
  11772. </member>
  11773. <member name="T:NPOI.HSSF.Record.GridsetRecord">
  11774. Title: GridSet Record.
  11775. Description: flag denoting whether the user specified that gridlines are used when
  11776. printing.
  11777. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11778. @author Andrew C. Oliver (acoliver at apache dot org)
  11779. @author Glen Stampoultzis (glens at apache.org)
  11780. @author Jason Height (jheight at chariot dot net dot au)
  11781. @version 2.0-pre
  11782. </member>
  11783. <member name="M:NPOI.HSSF.Record.GridsetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11784. Constructs a GridSet record and Sets its fields appropriately.
  11785. @param in the RecordInputstream to Read the record from
  11786. </member>
  11787. <member name="P:NPOI.HSSF.Record.GridsetRecord.Gridset">
  11788. Get whether the gridlines are shown during printing.
  11789. @return gridSet - true if gridlines are NOT printed, false if they are.
  11790. </member>
  11791. <member name="T:NPOI.HSSF.Record.GutsRecord">
  11792. Title: Guts Record
  11793. Description: Row/column gutter sizes
  11794. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11795. @author Andrew C. Oliver (acoliver at apache dot org)
  11796. @author Jason Height (jheight at chariot dot net dot au)
  11797. @version 2.0-pre
  11798. </member>
  11799. <member name="M:NPOI.HSSF.Record.GutsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11800. Constructs a Guts record and Sets its fields appropriately.
  11801. @param in the RecordInputstream to Read the record from
  11802. </member>
  11803. <member name="P:NPOI.HSSF.Record.GutsRecord.LeftRowGutter">
  11804. Get the size of the gutter that appears at the left of the rows
  11805. @return gutter size in screen Units
  11806. </member>
  11807. <member name="P:NPOI.HSSF.Record.GutsRecord.TopColGutter">
  11808. Get the size of the gutter that appears at the above the columns
  11809. @return gutter size in screen Units
  11810. </member>
  11811. <member name="P:NPOI.HSSF.Record.GutsRecord.RowLevelMax">
  11812. Get the maximum outline level for the row gutter.
  11813. @return maximum outline level
  11814. </member>
  11815. <member name="P:NPOI.HSSF.Record.GutsRecord.ColLevelMax">
  11816. Get the maximum outline level for the col gutter.
  11817. @return maximum outline level
  11818. </member>
  11819. <member name="T:NPOI.HSSF.Record.HCenterRecord">
  11820. Title: HCenter record
  11821. Description: whether to center between horizontal margins
  11822. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11823. @author Andrew C. Oliver (acoliver at apache dot org)
  11824. @author Jason Height (jheight at chariot dot net dot au)
  11825. @version 2.0-pre
  11826. </member>
  11827. <member name="M:NPOI.HSSF.Record.HCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11828. Constructs an HCenter record and Sets its fields appropriately.
  11829. @param in the RecordInputstream to Read the record from
  11830. </member>
  11831. <member name="P:NPOI.HSSF.Record.HCenterRecord.HCenter">
  11832. Get whether or not to horizonatally center this sheet.
  11833. @return center - t/f
  11834. </member>
  11835. <member name="T:NPOI.HSSF.Record.HeaderFooterBase">
  11836. Common header/footer base class
  11837. @author Josh Micich
  11838. </member>
  11839. <member name="P:NPOI.HSSF.Record.HeaderFooterBase.TextLength">
  11840. get the length of the footer string
  11841. @return length of the footer string
  11842. </member>
  11843. <member name="T:NPOI.HSSF.Record.HeaderFooterRecord">
  11844. The HEADERFOOTER record stores information Added in Office Excel 2007 for headers/footers.
  11845. @author Yegor Kozlov
  11846. </member>
  11847. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11848. construct a HeaderFooterRecord record. No fields are interpreted and the record will
  11849. be Serialized in its original form more or less
  11850. @param in the RecordInputstream to read the record from
  11851. </member>
  11852. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  11853. spit the record out AS IS. no interpretation or identification
  11854. </member>
  11855. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.Guid">
  11856. If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
  11857. If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field
  11858. of the preceding {@link UserSViewBegin} record.
  11859. @return the sheet view's GUID
  11860. </member>
  11861. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.IsCurrentSheet">
  11862. @return whether this record belongs to the current sheet
  11863. </member>
  11864. <member name="T:NPOI.HSSF.Record.HeaderRecord">
  11865. Title: Header Record
  11866. Description: Specifies a header for a sheet
  11867. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11868. @author Andrew C. Oliver (acoliver at apache dot org)
  11869. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  11870. @author Jason Height (jheight at chariot dot net dot au)
  11871. @version 2.0-pre
  11872. </member>
  11873. <member name="M:NPOI.HSSF.Record.HeaderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11874. Constructs an Header record and Sets its fields appropriately.
  11875. @param in the RecordInputstream to Read the record from
  11876. </member>
  11877. <member name="T:NPOI.HSSF.Record.HideObjRecord">
  11878. Title: Hide Object Record
  11879. Description: flag defines whether to hide placeholders and object
  11880. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  11881. @author Andrew C. Oliver (acoliver at apache dot org)
  11882. @version 2.0-pre
  11883. </member>
  11884. <member name="M:NPOI.HSSF.Record.HideObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11885. Constructs an HideObj record and Sets its fields appropriately.
  11886. @param in the RecordInputstream to Read the record from
  11887. </member>
  11888. <member name="M:NPOI.HSSF.Record.HideObjRecord.SetHideObj(System.Int16)">
  11889. Set hide object options
  11890. @param hide options
  11891. @see #HIDE_ALL
  11892. @see #SHOW_PLACEHOLDERS
  11893. @see #SHOW_ALL
  11894. </member>
  11895. <member name="M:NPOI.HSSF.Record.HideObjRecord.GetHideObj">
  11896. Get hide object options
  11897. @return hide options
  11898. @see #HIDE_ALL
  11899. @see #SHOW_PLACEHOLDERS
  11900. @see #SHOW_ALL
  11901. </member>
  11902. <member name="T:NPOI.HSSF.Record.HorizontalPageBreakRecord">
  11903. HorizontalPageBreak record that stores page breaks at rows
  11904. This class Is just used so that SID Compares work properly in the RecordFactory
  11905. @see PageBreakRecord
  11906. @author Danny Mui (dmui at apache dot org)
  11907. </member>
  11908. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor">
  11909. </member>
  11910. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11911. @param in the RecordInputstream to Read the record from
  11912. </member>
  11913. <member name="T:NPOI.HSSF.Record.HyperlinkRecord">
  11914. The <c>HyperlinkRecord</c> wraps an HLINK-record
  11915. from the Excel-97 format.
  11916. Supports only external links for now (eg http://)
  11917. @author Mark Hissink Muller <a href="mailto:mark@hissinkmuller.nl">mark@hissinkmuller.nl</a>
  11918. @author Yegor Kozlov (yegor at apache dot org)
  11919. </member>
  11920. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.HLINK_URL">
  11921. Link flags
  11922. </member>
  11923. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.URL_uninterpretedTail">
  11924. Tail of a URL link
  11925. </member>
  11926. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.FILE_uninterpretedTail">
  11927. Tail of a file link
  11928. </member>
  11929. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._range">
  11930. cell range of this hyperlink
  11931. </member>
  11932. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._guid">
  11933. 16-byte GUID
  11934. </member>
  11935. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._fileOpts">
  11936. Some sort of options for file links.
  11937. </member>
  11938. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._linkOpts">
  11939. Link options. Can include any of HLINK_* flags.
  11940. </member>
  11941. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._label">
  11942. Test label
  11943. </member>
  11944. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._moniker">
  11945. Moniker. Makes sense only for URL and file links
  11946. </member>
  11947. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._shortFilename">
  11948. in 8:3 DOS format No Unicode string header,
  11949. always 8-bit characters, zero-terminated
  11950. </member>
  11951. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._address">
  11952. Link
  11953. </member>
  11954. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._textMark">
  11955. Text describing a place in document. In Excel UI, this is appended to the
  11956. address, (after a '#' delimiter).<br/>
  11957. This field is optional. If present, the {@link #HLINK_PLACE} must be set.
  11958. </member>
  11959. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._uninterpretedTail">
  11960. Remaining bytes
  11961. </member>
  11962. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor">
  11963. Create a new hyperlink
  11964. </member>
  11965. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11966. Read hyperlink from input stream
  11967. @param in the stream to Read from
  11968. </member>
  11969. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstColumn">
  11970. Return the column of the first cell that Contains the hyperlink
  11971. @return the 0-based column of the first cell that Contains the hyperlink
  11972. </member>
  11973. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastColumn">
  11974. Set the column of the last cell that Contains the hyperlink
  11975. @return the 0-based column of the last cell that Contains the hyperlink
  11976. </member>
  11977. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstRow">
  11978. Return the row of the first cell that Contains the hyperlink
  11979. @return the 0-based row of the first cell that Contains the hyperlink
  11980. </member>
  11981. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastRow">
  11982. Return the row of the last cell that Contains the hyperlink
  11983. @return the 0-based row of the last cell that Contains the hyperlink
  11984. </member>
  11985. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Guid">
  11986. Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER}
  11987. @return 16-byte guid identifier
  11988. </member>
  11989. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Moniker">
  11990. Returns a 16-byte moniker.
  11991. @return 16-byte moniker
  11992. </member>
  11993. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Label">
  11994. Return text label for this hyperlink
  11995. @return text to Display
  11996. </member>
  11997. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Address">
  11998. Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  11999. @return the Address of this hyperlink
  12000. </member>
  12001. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LinkOptions">
  12002. Link options. Must be a combination of HLINK_* constants.
  12003. </member>
  12004. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LabelOptions">
  12005. Label options
  12006. </member>
  12007. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FileOptions">
  12008. Options for a file link
  12009. </member>
  12010. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsUrlLink">
  12011. Based on the link options, is this a url?
  12012. </member>
  12013. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsFileLink">
  12014. Based on the link options, is this a file?
  12015. </member>
  12016. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.IsDocumentLink">
  12017. Based on the link options, is this a document?
  12018. </member>
  12019. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateUrlLink">
  12020. <summary>
  12021. Initialize a new url link
  12022. </summary>
  12023. </member>
  12024. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateFileLink">
  12025. <summary>
  12026. Initialize a new file link
  12027. </summary>
  12028. </member>
  12029. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateDocumentLink">
  12030. <summary>
  12031. Initialize a new document link
  12032. </summary>
  12033. </member>
  12034. <member name="T:NPOI.HSSF.Record.IndexRecord">
  12035. Title: Index Record
  12036. Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet
  12037. Important for locating cells
  12038. NOT USED IN THIS RELEASE
  12039. REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12040. @author Andrew C. Oliver (acoliver at apache dot org)
  12041. @author Jason Height (jheight at chariot dot net dot au)
  12042. @version 2.0-pre
  12043. </member>
  12044. <member name="M:NPOI.HSSF.Record.IndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12045. Constructs an Index record and Sets its fields appropriately.
  12046. @param in the RecordInputstream to Read the record from
  12047. </member>
  12048. <member name="M:NPOI.HSSF.Record.IndexRecord.GetRecordSizeForBlockCount(System.Int32)">
  12049. Returns the size of an INdexRecord when it needs to index the specified number of blocks
  12050. </member>
  12051. <member name="T:NPOI.HSSF.Record.InterfaceEndRecord">
  12052. Title: Interface End Record
  12053. Description: Shows where the Interface Records end (MMS)
  12054. (has no fields)
  12055. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12056. @author Andrew C. Oliver (acoliver at apache dot org)
  12057. @version 2.0-pre
  12058. </member>
  12059. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.Create(NPOI.HSSF.Record.RecordInputStream)">
  12060. Constructs an InterfaceEnd record and Sets its fields appropriately.
  12061. @param in the RecordInputstream to Read the record from
  12062. </member>
  12063. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.GetDataSize">
  12064. <summary>
  12065. for test TestInterfaceEndRecord.TestCreate()
  12066. </summary>
  12067. <returns></returns>
  12068. </member>
  12069. <member name="T:NPOI.HSSF.Record.InterfaceHdrRecord">
  12070. Title: Interface Header Record
  12071. Description: Defines the beginning of Interface records (MMS)
  12072. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12073. @author Andrew C. Oliver (acoliver at apache dot org)
  12074. @version 2.0-pre
  12075. </member>
  12076. <member name="F:NPOI.HSSF.Record.InterfaceHdrRecord.CODEPAGE">
  12077. suggested (and probably correct) default
  12078. </member>
  12079. <member name="M:NPOI.HSSF.Record.InterfaceHdrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12080. Constructs an Codepage record and Sets its fields appropriately.
  12081. @param in the RecordInputstream to Read the record from
  12082. </member>
  12083. <member name="T:NPOI.HSSF.Record.IterationRecord">
  12084. Title: Iteration Record
  12085. Description: Tells whether to iterate over forumla calculations or not
  12086. (if a formula Is dependant upon another formula's result)
  12087. (odd feature for something that can only have 32 elements in
  12088. a formula!)
  12089. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12090. @author Andrew C. Oliver (acoliver at apache dot org)
  12091. @author Jason Height (jheight at chariot dot net dot au)
  12092. @version 2.0-pre
  12093. </member>
  12094. <member name="M:NPOI.HSSF.Record.IterationRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12095. Constructs an Iteration record and Sets its fields appropriately.
  12096. @param in the RecordInputstream to Read the record from
  12097. </member>
  12098. <member name="P:NPOI.HSSF.Record.IterationRecord.Iteration">
  12099. Get whether or not to iterate for calculations
  12100. @return whether iterative calculations are turned off or on
  12101. </member>
  12102. <member name="T:NPOI.HSSF.Record.LabelRecord">
  12103. Label Record - Read only support for strings stored directly in the cell.. Don't
  12104. use this (except to Read), use LabelSST instead
  12105. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12106. @see org.apache.poi.hssf.record.LabelSSTRecord
  12107. </member>
  12108. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor">
  12109. Creates new LabelRecord
  12110. </member>
  12111. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12112. Constructs an Label record and Sets its fields appropriately.
  12113. @param in the RecordInputstream to Read the record from
  12114. </member>
  12115. <member name="P:NPOI.HSSF.Record.LabelRecord.StringLength">
  12116. Get the number of Chars this string Contains
  12117. @return number of Chars
  12118. </member>
  12119. <member name="P:NPOI.HSSF.Record.LabelRecord.IsUncompressedUnicode">
  12120. Is this Uncompressed Unicode (16bit)? Or just 8-bit compressed?
  12121. @return IsUnicode - True for 16bit- false for 8bit
  12122. </member>
  12123. <member name="P:NPOI.HSSF.Record.LabelRecord.Value">
  12124. Get the value
  12125. @return the text string
  12126. @see #GetStringLength
  12127. </member>
  12128. <member name="M:NPOI.HSSF.Record.LabelRecord.Serialize(System.Int32,System.Byte[])">
  12129. THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
  12130. </member>
  12131. <member name="T:NPOI.HSSF.Record.LabelSSTRecord">
  12132. Title: Label SST Record
  12133. Description: Refers to a string in the shared string table and Is a column
  12134. value.
  12135. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12136. @author Andrew C. Oliver (acoliver at apache dot org)
  12137. @author Jason Height (jheight at chariot dot net dot au)
  12138. @version 2.0-pre
  12139. </member>
  12140. <member name="M:NPOI.HSSF.Record.LabelSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12141. Constructs an LabelSST record and Sets its fields appropriately.
  12142. @param in the RecordInputstream to Read the record from
  12143. </member>
  12144. <member name="P:NPOI.HSSF.Record.LabelSSTRecord.SSTIndex">
  12145. Get the index to the string in the SSTRecord
  12146. @return index of string in the SST Table
  12147. @see org.apache.poi.hssf.record.SSTRecord
  12148. </member>
  12149. <member name="T:NPOI.HSSF.Record.LeftMarginRecord">
  12150. Record for the left margin.
  12151. NOTE: This source was automatically generated.
  12152. @author Shawn Laubach (slaubach at apache dot org)
  12153. </member>
  12154. <member name="M:NPOI.HSSF.Record.LeftMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12155. Constructs a LeftMargin record and Sets its fields appropriately.
  12156. @param in the RecordInputstream to Read the record from
  12157. </member>
  12158. <member name="P:NPOI.HSSF.Record.LeftMarginRecord.Margin">
  12159. Get the margin field for the LeftMargin record.
  12160. </member>
  12161. <member name="T:NPOI.HSSF.Record.LinkedDataFormulaField">
  12162. Not implemented yet. May commit it anyway just so people can see
  12163. where I'm heading.
  12164. @author Glen Stampoultzis (glens at apache.org)
  12165. </member>
  12166. <member name="T:NPOI.HSSF.Record.IMargin">
  12167. The margin interface Is a parent used to define left, right, top and bottom margins.
  12168. This allows much of the code to be generic when it comes to handling margins.
  12169. NOTE: This source wass automatically generated.
  12170. @author Shawn Laubach (slaubach at apache dot org)
  12171. </member>
  12172. <member name="P:NPOI.HSSF.Record.IMargin.Margin">
  12173. Get the margin field for the Margin.
  12174. </member>
  12175. <member name="T:NPOI.HSSF.Record.MergeCellsRecord">
  12176. Title: Merged Cells Record
  12177. Description: Optional record defining a square area of cells to "merged" into
  12178. one cell.
  12179. REFERENCE: NONE (UNDOCUMENTED PRESENTLY)
  12180. @author Andrew C. Oliver (acoliver at apache dot org)
  12181. @version 2.0-pre
  12182. </member>
  12183. <member name="F:NPOI.HSSF.Record.MergeCellsRecord._regions">
  12184. sometimes the regions array is shared with other MergedCellsRecords
  12185. </member>
  12186. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12187. Constructs a MergedCellsRecord and Sets its fields appropriately
  12188. @param in the RecordInputstream to Read the record from
  12189. </member>
  12190. <member name="P:NPOI.HSSF.Record.MergeCellsRecord.NumAreas">
  12191. Get the number of merged areas. If this drops down to 0 you should just go
  12192. ahead and delete the record.
  12193. @return number of areas
  12194. </member>
  12195. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.GetAreaAt(System.Int32)">
  12196. @return MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
  12197. </member>
  12198. <member name="T:NPOI.HSSF.Record.MMSRecord">
  12199. Title: MMS Record
  12200. Description: defines how many Add menu and del menu options are stored
  12201. in the file. Should always be Set to 0 for HSSF workbooks
  12202. REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12203. @author Andrew C. Oliver (acoliver at apache dot org)
  12204. @version 2.0-pre
  12205. </member>
  12206. <member name="M:NPOI.HSSF.Record.MMSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12207. Constructs a MMS record and Sets its fields appropriately.
  12208. @param in the RecordInputstream to Read the record from
  12209. </member>
  12210. <member name="P:NPOI.HSSF.Record.MMSRecord.AddMenuCount">
  12211. Set number of Add menu options (Set to 0)
  12212. @param am number of Add menu options
  12213. </member>
  12214. <member name="P:NPOI.HSSF.Record.MMSRecord.DelMenuCount">
  12215. Set number of del menu options (Set to 0)
  12216. @param dm number of del menu options
  12217. </member>
  12218. <member name="T:NPOI.HSSF.Record.MulBlankRecord">
  12219. Title: Mulitple Blank cell record
  12220. Description: Represents a Set of columns in a row with no value but with styling.
  12221. In this release we have Read-only support for this record type.
  12222. The RecordFactory Converts this to a Set of BlankRecord objects.
  12223. REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12224. @author Andrew C. Oliver (acoliver at apache dot org)
  12225. @author Glen Stampoultzis (glens at apache.org)
  12226. @version 2.0-pre
  12227. @see org.apache.poi.hssf.record.BlankRecord
  12228. </member>
  12229. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor">
  12230. Creates new MulBlankRecord
  12231. </member>
  12232. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12233. Constructs a MulBlank record and Sets its fields appropriately.
  12234. @param in the RecordInputstream to Read the record from
  12235. </member>
  12236. <member name="P:NPOI.HSSF.Record.MulBlankRecord.Row">
  12237. Get the row number of the cells this represents
  12238. @return row number
  12239. </member>
  12240. <member name="P:NPOI.HSSF.Record.MulBlankRecord.FirstColumn">
  12241. starting column (first cell this holds in the row)
  12242. @return first column number
  12243. </member>
  12244. <member name="P:NPOI.HSSF.Record.MulBlankRecord.LastColumn">
  12245. ending column (last cell this holds in the row)
  12246. @return first column number
  12247. </member>
  12248. <member name="P:NPOI.HSSF.Record.MulBlankRecord.NumColumns">
  12249. Get the number of columns this Contains (last-first +1)
  12250. @return number of columns (last - first +1)
  12251. </member>
  12252. <member name="M:NPOI.HSSF.Record.MulBlankRecord.GetXFAt(System.Int32)">
  12253. returns the xf index for column (coffset = column - field_2_first_col)
  12254. @param coffset the column (coffset = column - field_2_first_col)
  12255. @return the XF index for the column
  12256. </member>
  12257. <member name="T:NPOI.HSSF.Record.MulRKRecord">
  12258. Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
  12259. HSSF just Converts this into multiple NUMBER records. Read-ONLY SUPPORT!
  12260. REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12261. @author Andrew C. Oliver (acoliver at apache dot org)
  12262. @version 2.0-pre
  12263. </member>
  12264. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor">
  12265. Creates new MulRKRecord
  12266. </member>
  12267. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12268. Constructs a MulRK record and Sets its fields appropriately.
  12269. @param in the RecordInputstream to Read the record from
  12270. </member>
  12271. <member name="P:NPOI.HSSF.Record.MulRKRecord.FirstColumn">
  12272. starting column (first cell this holds in the row)
  12273. @return first column number
  12274. </member>
  12275. <member name="P:NPOI.HSSF.Record.MulRKRecord.LastColumn">
  12276. ending column (last cell this holds in the row)
  12277. @return first column number
  12278. </member>
  12279. <member name="P:NPOI.HSSF.Record.MulRKRecord.NumColumns">
  12280. Get the number of columns this Contains (last-first +1)
  12281. @return number of columns (last - first +1)
  12282. </member>
  12283. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetXFAt(System.Int32)">
  12284. returns the xf index for column (coffset = column - field_2_first_col)
  12285. @return the XF index for the column
  12286. </member>
  12287. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetRKNumberAt(System.Int32)">
  12288. returns the rk number for column (coffset = column - field_2_first_col)
  12289. @return the value (decoded into a double)
  12290. </member>
  12291. <member name="T:NPOI.HSSF.Record.NameCommentRecord">
  12292. Title: NAMECMT Record (0x0894)
  12293. Description: Defines a comment associated with a specified name.
  12294. REFERENCE:
  12295. @author Andrew Shirley (aks at corefiling.co.uk)
  12296. </member>
  12297. <member name="M:NPOI.HSSF.Record.NameCommentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12298. @param ris the RecordInputstream to read the record from
  12299. </member>
  12300. <member name="P:NPOI.HSSF.Record.NameCommentRecord.Sid">
  12301. return the non static version of the id for this record.
  12302. </member>
  12303. <member name="P:NPOI.HSSF.Record.NameCommentRecord.NameText">
  12304. @return the name of the NameRecord to which this comment applies.
  12305. </member>
  12306. <member name="P:NPOI.HSSF.Record.NameCommentRecord.CommentText">
  12307. @return the text of the comment.
  12308. </member>
  12309. <member name="T:NPOI.HSSF.Record.NameRecord">
  12310. Title: Name Record (aka Named Range)
  12311. Description: Defines a named range within a workbook.
  12312. REFERENCE:
  12313. @author Libin Roman (Vista Portal LDT. Developer)
  12314. @author Sergei Kozello (sergeikozello at mail.ru)
  12315. @author Glen Stampoultzis (glens at apache.org)
  12316. @version 1.0-pre
  12317. </member>
  12318. <member name="F:NPOI.HSSF.Record.NameRecord.sid">
  12319. </member>
  12320. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CONSOLIDATE_AREA">
  12321. Included for completeness sake, not implemented
  12322. </member>
  12323. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_OPEN">
  12324. Included for completeness sake, not implemented
  12325. </member>
  12326. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_CLOSE">
  12327. Included for completeness sake, not implemented
  12328. </member>
  12329. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATABASE">
  12330. Included for completeness sake, not implemented
  12331. </member>
  12332. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CRITERIA">
  12333. Included for completeness sake, not implemented
  12334. </member>
  12335. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_RECORDER">
  12336. Included for completeness sake, not implemented
  12337. </member>
  12338. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATA_FORM">
  12339. Included for completeness sake, not implemented
  12340. </member>
  12341. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_ACTIVATE">
  12342. Included for completeness sake, not implemented
  12343. </member>
  12344. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_DEACTIVATE">
  12345. Included for completeness sake, not implemented
  12346. </member>
  12347. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_SHEET_TITLE">
  12348. Included for completeness sake, not implemented
  12349. </member>
  12350. <member name="F:NPOI.HSSF.Record.NameRecord.field_5_externSheetIndex_plus1">
  12351. One-based extern index of sheet (resolved via LinkTable). Zero if this is a global name
  12352. </member>
  12353. <member name="F:NPOI.HSSF.Record.NameRecord.field_6_sheetNumber">
  12354. the one based sheet number.
  12355. </member>
  12356. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor">
  12357. Creates new NameRecord
  12358. </member>
  12359. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12360. Constructs a Name record and Sets its fields appropriately.
  12361. @param in the RecordInputstream to Read the record from
  12362. </member>
  12363. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(System.Byte,System.Int32)">
  12364. Constructor to Create a built-in named region
  12365. @param builtin Built-in byte representation for the name record, use the public constants
  12366. @param index
  12367. </member>
  12368. <member name="P:NPOI.HSSF.Record.NameRecord.FnGroup">
  12369. @return function Group
  12370. @see FnGroupCountRecord
  12371. </member>
  12372. <member name="P:NPOI.HSSF.Record.NameRecord.OptionFlag">
  12373. Gets the option flag
  12374. @return option flag
  12375. </member>
  12376. <member name="P:NPOI.HSSF.Record.NameRecord.KeyboardShortcut">
  12377. returns the keyboard shortcut
  12378. @return keyboard shortcut
  12379. </member>
  12380. <member name="P:NPOI.HSSF.Record.NameRecord.NameTextLength">
  12381. **
  12382. </member>
  12383. <member name="M:NPOI.HSSF.Record.NameRecord.SetFunction(System.Boolean)">
  12384. Indicates that the defined name refers to a user-defined function.
  12385. This attribute is used when there is an add-in or other code project associated with the file.
  12386. @param function <c>true</c> indicates the name refers to a function.
  12387. </member>
  12388. <member name="P:NPOI.HSSF.Record.NameRecord.HasFormula">
  12389. @return <c>true</c> if name has a formula (named range or defined value)
  12390. </member>
  12391. <member name="P:NPOI.HSSF.Record.NameRecord.IsHiddenName">
  12392. @return true if name Is hidden
  12393. </member>
  12394. <member name="P:NPOI.HSSF.Record.NameRecord.IsFunctionName">
  12395. @return true if name Is a function
  12396. </member>
  12397. <member name="P:NPOI.HSSF.Record.NameRecord.IsCommandName">
  12398. @return true if name Is a command
  12399. </member>
  12400. <member name="P:NPOI.HSSF.Record.NameRecord.IsMacro">
  12401. @return true if function macro or command macro
  12402. </member>
  12403. <member name="P:NPOI.HSSF.Record.NameRecord.IsComplexFunction">
  12404. @return true if array formula or user defined
  12405. </member>
  12406. <member name="P:NPOI.HSSF.Record.NameRecord.IsBuiltInName">
  12407. Convenience Function to determine if the name Is a built-in name
  12408. </member>
  12409. <member name="P:NPOI.HSSF.Record.NameRecord.NameText">
  12410. Gets the name
  12411. @return name
  12412. </member>
  12413. <member name="P:NPOI.HSSF.Record.NameRecord.BuiltInName">
  12414. Gets the Built In Name
  12415. @return the built in Name
  12416. </member>
  12417. <member name="P:NPOI.HSSF.Record.NameRecord.NameDefinition">
  12418. Gets the definition, reference (Formula)
  12419. @return definition -- can be null if we cant Parse ptgs
  12420. </member>
  12421. <member name="P:NPOI.HSSF.Record.NameRecord.CustomMenuText">
  12422. Get the custom menu text
  12423. @return custom menu text
  12424. </member>
  12425. <member name="P:NPOI.HSSF.Record.NameRecord.DescriptionText">
  12426. Gets the description text
  12427. @return description text
  12428. </member>
  12429. <member name="P:NPOI.HSSF.Record.NameRecord.HelpTopicText">
  12430. Get the help topic text
  12431. @return gelp topic text
  12432. </member>
  12433. <member name="P:NPOI.HSSF.Record.NameRecord.StatusBarText">
  12434. Gets the status bar text
  12435. @return status bar text
  12436. </member>
  12437. <member name="P:NPOI.HSSF.Record.NameRecord.SheetNumber">
  12438. For named ranges, and built-in names
  12439. @return the 1-based sheet number.
  12440. </member>
  12441. <member name="M:NPOI.HSSF.Record.NameRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  12442. called by the class that Is responsible for writing this sucker.
  12443. Subclasses should implement this so that their data Is passed back in a
  12444. @param offset to begin writing at
  12445. @param data byte array containing instance data
  12446. @return number of bytes written
  12447. </member>
  12448. <member name="P:NPOI.HSSF.Record.NameRecord.ExternSheetNumber">
  12449. Gets the extern sheet number
  12450. @return extern sheet index
  12451. </member>
  12452. <member name="P:NPOI.HSSF.Record.NameRecord.Sid">
  12453. return the non static version of the id for this record.
  12454. </member>
  12455. <member name="M:NPOI.HSSF.Record.NameRecord.ToString">
  12456. @see Object#ToString()
  12457. </member>
  12458. <member name="M:NPOI.HSSF.Record.NameRecord.TranslateBuiltInName(System.Byte)">
  12459. Creates a human Readable name for built in types
  12460. @return Unknown if the built-in name cannot be translated
  12461. </member>
  12462. <member name="T:NPOI.HSSF.Record.NoteRecord">
  12463. NOTE: Comment Associated with a Cell (1Ch)
  12464. @author Yegor Kozlov
  12465. </member>
  12466. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_HIDDEN">
  12467. Flag indicating that the comment Is hidden (default)
  12468. </member>
  12469. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_VISIBLE">
  12470. Flag indicating that the comment Is visible
  12471. </member>
  12472. <member name="F:NPOI.HSSF.Record.NoteRecord.field_7_padding">
  12473. Saves padding byte value to reduce delta during round-trip serialization.<br/>
  12474. The documentation is not clear about how padding should work. In any case
  12475. Excel(2007) does something different.
  12476. </member>
  12477. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor">
  12478. Construct a new <c>NoteRecord</c> and
  12479. Fill its data with the default values
  12480. </member>
  12481. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12482. Constructs a <c>NoteRecord</c> and Fills its fields
  12483. from the supplied <c>RecordInputStream</c>.
  12484. @param in the stream to Read from
  12485. </member>
  12486. <member name="P:NPOI.HSSF.Record.NoteRecord.Sid">
  12487. @return id of this record.
  12488. </member>
  12489. <member name="M:NPOI.HSSF.Record.NoteRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  12490. Serialize the record data into the supplied array of bytes
  12491. @param offset offset in the <c>data</c>
  12492. @param data the data to Serialize into
  12493. @return size of the record
  12494. </member>
  12495. <member name="P:NPOI.HSSF.Record.NoteRecord.DataSize">
  12496. Size of record
  12497. </member>
  12498. <member name="M:NPOI.HSSF.Record.NoteRecord.ToString">
  12499. Convert this record to string.
  12500. Used by BiffViewer and other utulities.
  12501. </member>
  12502. <member name="P:NPOI.HSSF.Record.NoteRecord.Row">
  12503. Return the row that Contains the comment
  12504. @return the row that Contains the comment
  12505. </member>
  12506. <member name="P:NPOI.HSSF.Record.NoteRecord.Column">
  12507. Return the column that Contains the comment
  12508. @return the column that Contains the comment
  12509. </member>
  12510. <member name="P:NPOI.HSSF.Record.NoteRecord.Flags">
  12511. Options flags.
  12512. @return the options flag
  12513. @see #NOTE_VISIBLE
  12514. @see #NOTE_HIDDEN
  12515. </member>
  12516. <member name="P:NPOI.HSSF.Record.NoteRecord.ShapeId">
  12517. Object id for OBJ record that Contains the comment
  12518. </member>
  12519. <member name="P:NPOI.HSSF.Record.NoteRecord.Author">
  12520. Name of the original comment author
  12521. @return the name of the original author of the comment
  12522. </member>
  12523. <member name="P:NPOI.HSSF.Record.NoteRecord.AuthorIsMultibyte">
  12524. For unit testing only!
  12525. </member>
  12526. <member name="T:NPOI.HSSF.Record.NumberRecord">
  12527. Contains a numeric cell value.
  12528. REFERENCE: PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12529. @author Andrew C. Oliver (acoliver at apache dot org)
  12530. @author Jason Height (jheight at chariot dot net dot au)
  12531. @version 2.0-pre
  12532. </member>
  12533. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor">
  12534. Creates new NumberRecord
  12535. </member>
  12536. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12537. Constructs a Number record and Sets its fields appropriately.
  12538. @param in the RecordInputstream to Read the record from
  12539. </member>
  12540. <member name="P:NPOI.HSSF.Record.NumberRecord.Value">
  12541. Get the value for the cell
  12542. @return double representing the value
  12543. </member>
  12544. <member name="T:NPOI.HSSF.Record.ObjectProtectRecord">
  12545. Title: Object Protect Record
  12546. Description: Protect embedded object with the lamest "security" ever invented.
  12547. This record tells "I want to protect my objects" with lame security. It
  12548. appears in conjunction with the PASSWORD and PROTECT records as well as its
  12549. scenario protect cousin.
  12550. REFERENCE: PG 368 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12551. @author Andrew C. Oliver (acoliver at apache dot org)
  12552. </member>
  12553. <member name="M:NPOI.HSSF.Record.ObjectProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12554. Constructs a Protect record and Sets its fields appropriately.
  12555. @param in the RecordInputstream to Read the record from
  12556. </member>
  12557. <member name="P:NPOI.HSSF.Record.ObjectProtectRecord.Protect">
  12558. Get whether the sheet Is protected or not
  12559. @return whether to protect the sheet or not
  12560. </member>
  12561. <member name="T:NPOI.HSSF.Record.ObjRecord">
  12562. The obj record is used to hold various graphic objects and controls.
  12563. @author Glen Stampoultzis (glens at apache.org)
  12564. </member>
  12565. <member name="F:NPOI.HSSF.Record.ObjRecord._uninterpretedData">
  12566. used when POI has no idea what is going on
  12567. </member>
  12568. <member name="F:NPOI.HSSF.Record.ObjRecord._isPaddedToQuadByteMultiple">
  12569. Excel seems to tolerate padding to quad or double byte length
  12570. </member>
  12571. <member name="M:NPOI.HSSF.Record.ObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12572. Constructs a OBJ record and Sets its fields appropriately.
  12573. @param in the RecordInputstream to Read the record from
  12574. </member>
  12575. <member name="M:NPOI.HSSF.Record.ObjRecord.CanPaddingBeDiscarded(System.Byte[],System.Int32)">
  12576. Some XLS files have ObjRecords with nearly 8Kb of excessive padding. These were probably
  12577. written by a version of POI (around 3.1) which incorrectly interpreted the second short of
  12578. the ftLbs subrecord (0x1FEE) as a length, and read that many bytes as padding (other bugs
  12579. helped allow this to occur).
  12580. Excel reads files with this excessive padding OK, truncating the over-sized ObjRecord back
  12581. to the its proper size. POI does the same.
  12582. </member>
  12583. <member name="P:NPOI.HSSF.Record.ObjRecord.RecordSize">
  12584. Size of record (excluding 4 byte header)
  12585. </member>
  12586. <member name="T:NPOI.HSSF.Record.PageBreakRecord">
  12587. Record that Contains the functionality page _breaks (horizontal and vertical)
  12588. The other two classes just specifically Set the SIDS for record creation.
  12589. REFERENCE: Microsoft Excel SDK page 322 and 420
  12590. @see HorizontalPageBreakRecord
  12591. @see VerticalPageBreakRecord
  12592. @author Danny Mui (dmui at apache dot org)
  12593. </member>
  12594. <member name="T:NPOI.HSSF.Record.PageBreakRecord.Break">
  12595. Since both records store 2byte integers (short), no point in
  12596. differentiating it in the records.
  12597. The subs (rows or columns, don't seem to be able to Set but excel Sets
  12598. them automatically)
  12599. </member>
  12600. <member name="M:NPOI.HSSF.Record.PageBreakRecord.AddBreak(System.Int32,System.Int32,System.Int32)">
  12601. Adds the page break at the specified parameters
  12602. @param main Depending on sid, will determine row or column to put page break (zero-based)
  12603. @param subFrom No user-interface to Set (defaults to minumum, 0)
  12604. @param subTo No user-interface to Set
  12605. </member>
  12606. <member name="M:NPOI.HSSF.Record.PageBreakRecord.RemoveBreak(System.Int32)">
  12607. Removes the break indicated by the parameter
  12608. @param main (zero-based)
  12609. </member>
  12610. <member name="M:NPOI.HSSF.Record.PageBreakRecord.GetBreak(System.Int32)">
  12611. Retrieves the region at the row/column indicated
  12612. @param main FIXME: Document this!
  12613. @return The Break or null if no break exists at the row/col specified.
  12614. </member>
  12615. <member name="T:NPOI.HSSF.Record.PaletteRecord">
  12616. PaletteRecord - Supports custom palettes.
  12617. @author Andrew C. Oliver (acoliver at apache dot org)
  12618. @author Brian Sanders (bsanders at risklabs dot com) - custom palette editing
  12619. @version 2.0-pre
  12620. </member>
  12621. <member name="F:NPOI.HSSF.Record.PaletteRecord.STANDARD_PALETTE_SIZE">
  12622. The standard size of an XLS palette
  12623. </member>
  12624. <member name="F:NPOI.HSSF.Record.PaletteRecord.FIRST_COLOR_INDEX">
  12625. The byte index of the first color
  12626. </member>
  12627. <member name="M:NPOI.HSSF.Record.PaletteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12628. Constructs a PaletteRecord record and Sets its fields appropriately.
  12629. @param in the RecordInputstream to Read the record from
  12630. </member>
  12631. <member name="M:NPOI.HSSF.Record.PaletteRecord.ClearColors">
  12632. <summary>
  12633. Dangerous! Only call this if you intend to replace the colors!
  12634. </summary>
  12635. </member>
  12636. <member name="M:NPOI.HSSF.Record.PaletteRecord.GetColor(System.Int16)">
  12637. Returns the color value at a given index
  12638. @return the RGB triplet for the color, or null if the specified index
  12639. does not exist
  12640. </member>
  12641. <member name="M:NPOI.HSSF.Record.PaletteRecord.SetColor(System.Int16,System.Byte,System.Byte,System.Byte)">
  12642. Sets the color value at a given index
  12643. If the given index Is greater than the current last color index,
  12644. then black Is Inserted at every index required to make the palette continuous.
  12645. @param byteIndex the index to Set; if this index Is less than 0x8 or greater than
  12646. 0x40, then no modification Is made
  12647. </member>
  12648. <member name="M:NPOI.HSSF.Record.PaletteRecord.CreateDefaultPalette">
  12649. Creates the default palette as PaletteRecord binary data
  12650. @see org.apache.poi.hssf.model.Workbook#createPalette
  12651. </member>
  12652. <member name="T:NPOI.HSSF.Record.PColor">
  12653. PColor - element in the list of colors - consider it a "struct"
  12654. </member>
  12655. <member name="T:NPOI.HSSF.Record.PaneRecord">
  12656. * Describes the frozen and Unfozen panes.
  12657. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or
  12658. * Remove the record in src/records/definitions.
  12659. * @author Glen Stampoultzis (glens at apache.org)
  12660. </member>
  12661. <member name="M:NPOI.HSSF.Record.PaneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12662. Constructs a Pane record and Sets its fields appropriately.
  12663. @param in the RecordInputstream to Read the record from
  12664. </member>
  12665. <member name="P:NPOI.HSSF.Record.PaneRecord.X">
  12666. Get the x field for the Pane record.
  12667. </member>
  12668. <member name="P:NPOI.HSSF.Record.PaneRecord.Y">
  12669. Get the y field for the Pane record.
  12670. </member>
  12671. <member name="P:NPOI.HSSF.Record.PaneRecord.TopRow">
  12672. Get the top row field for the Pane record.
  12673. </member>
  12674. <member name="P:NPOI.HSSF.Record.PaneRecord.LeftColumn">
  12675. Get the left column field for the Pane record.
  12676. </member>
  12677. <member name="P:NPOI.HSSF.Record.PaneRecord.ActivePane">
  12678. Get the active pane field for the Pane record.
  12679. @return One of
  12680. ACTIVE_PANE_LOWER_RIGHT
  12681. ACTIVE_PANE_UPPER_RIGHT
  12682. ACTIVE_PANE_LOWER_LEFT
  12683. ACTIVE_PANE_UPPER_LEFT
  12684. </member>
  12685. <member name="T:NPOI.HSSF.Record.PasswordRecord">
  12686. Title: Password Record
  12687. Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
  12688. REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12689. @author Andrew C. Oliver (acoliver at apache dot org)
  12690. @version 2.0-pre
  12691. </member>
  12692. <member name="M:NPOI.HSSF.Record.PasswordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12693. Constructs a Password record and Sets its fields appropriately.
  12694. @param in the RecordInputstream to Read the record from
  12695. </member>
  12696. <member name="P:NPOI.HSSF.Record.PasswordRecord.Password">
  12697. Get the password
  12698. @return short representing the password
  12699. </member>
  12700. <member name="M:NPOI.HSSF.Record.PasswordRecord.Clone">
  12701. Clone this record.
  12702. </member>
  12703. <member name="T:NPOI.HSSF.Record.PasswordRev4Record">
  12704. Title: Protection Revision 4 password Record
  12705. Description: Stores the (2 byte??!!) encrypted password for a shared
  12706. workbook
  12707. REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12708. @author Andrew C. Oliver (acoliver at apache dot org)
  12709. @version 2.0-pre
  12710. </member>
  12711. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12712. Constructs a PasswordRev4 (PROT4REVPASS) record and Sets its fields appropriately.
  12713. @param in the RecordInputstream to Read the record from
  12714. </member>
  12715. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.SetPassword(System.Int16)">
  12716. set the password
  12717. @param pw representing the password
  12718. </member>
  12719. <member name="T:NPOI.HSSF.Record.PivotTable.DataItemRecord">
  12720. SXDI - Data Item (0x00C5)<br/>
  12721. @author Patrick Cheng
  12722. </member>
  12723. <member name="T:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord">
  12724. SXVDEX - Extended PivotTable View Fields (0x0100)<br/>
  12725. @author Patrick Cheng
  12726. </member>
  12727. <member name="F:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  12728. the value of the <c>cchSubName</c> field when the subName is not present
  12729. </member>
  12730. <member name="T:NPOI.HSSF.Record.PivotTable.PageItemRecord">
  12731. SXPI - Page Item (0x00B6)<br/>
  12732. @author Patrick Cheng
  12733. </member>
  12734. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvi">
  12735. Index to the View Item SXVI(0x00B2) record
  12736. </member>
  12737. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvd">
  12738. Index to the {@link ViewFieldsRecord} SXVD(0x00B1) record
  12739. </member>
  12740. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._idObj">
  12741. Object ID for the drop-down arrow
  12742. </member>
  12743. <member name="T:NPOI.HSSF.Record.PivotTable.StreamIDRecord">
  12744. SXIDSTM - Stream ID (0x00D5)<br/>
  12745. @author Patrick Cheng
  12746. </member>
  12747. <member name="T:NPOI.HSSF.Record.PivotTable.ViewDefinitionRecord">
  12748. SXVIEW - View Definition (0x00B0)<br/>
  12749. @author Patrick Cheng
  12750. </member>
  12751. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord">
  12752. SXVD - View Fields (0x00B1)<br/>
  12753. @author Patrick Cheng
  12754. </member>
  12755. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.Axis">
  12756. values for the {@link ViewFieldsRecord#sxaxis} field
  12757. </member>
  12758. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  12759. the value of the <c>cchName</c> field when the name is not present
  12760. </member>
  12761. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.BASE_SIZE">
  12762. 5 shorts
  12763. </member>
  12764. <member name="T:NPOI.HSSF.Record.PivotTable.ViewSourceRecord">
  12765. SXVS - View Source (0x00E3)<br/>
  12766. @author Patrick Cheng
  12767. </member>
  12768. <member name="T:NPOI.HSSF.Record.PrecisionRecord">
  12769. Title: Precision Record
  12770. Description: defines whether to store with full precision or what's Displayed by the gui
  12771. (meaning have really screwed up and skewed figures or only think you do!)
  12772. REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12773. @author Andrew C. Oliver (acoliver at apache dot org)
  12774. @version 2.0-pre
  12775. </member>
  12776. <member name="M:NPOI.HSSF.Record.PrecisionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12777. Constructs a Precision record and Sets its fields appropriately.
  12778. @param in the RecordInputstream to Read the record from
  12779. </member>
  12780. <member name="P:NPOI.HSSF.Record.PrecisionRecord.FullPrecision">
  12781. Get whether to use full precision or just skew all you figures all to hell.
  12782. @return fullprecision - or not
  12783. </member>
  12784. <member name="T:NPOI.HSSF.Record.PrintGridlinesRecord">
  12785. Title: Print Gridlines Record
  12786. Description: whether to print the gridlines when you enjoy you spReadsheet on paper.
  12787. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12788. @author Andrew C. Oliver (acoliver at apache dot org)
  12789. @author Jason Height (jheight at chariot dot net dot au)
  12790. @version 2.0-pre
  12791. </member>
  12792. <member name="M:NPOI.HSSF.Record.PrintGridlinesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12793. Constructs a PrintGridlines record and Sets its fields appropriately.
  12794. @param in the RecordInputstream to Read the record from
  12795. </member>
  12796. <member name="P:NPOI.HSSF.Record.PrintGridlinesRecord.PrintGridlines">
  12797. Get whether or not to print the gridlines (and make your spReadsheet ugly)
  12798. @return make spReadsheet ugly - Y/N
  12799. </member>
  12800. <member name="T:NPOI.HSSF.Record.PrintHeadersRecord">
  12801. Title: Print Headers Record
  12802. Description: Whether or not to print the row/column headers when you
  12803. enjoy your spReadsheet in the physical form.
  12804. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12805. @author Andrew C. Oliver (acoliver at apache dot org)
  12806. @author Jason Height (jheight at chariot dot net dot au)
  12807. @version 2.0-pre
  12808. </member>
  12809. <member name="M:NPOI.HSSF.Record.PrintHeadersRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12810. Constructs a PrintHeaders record and Sets its fields appropriately.
  12811. @param in the RecordInputstream to Read the record from
  12812. </member>
  12813. <member name="P:NPOI.HSSF.Record.PrintHeadersRecord.PrintHeaders">
  12814. <summary>
  12815. Get whether to print the headers - y/n
  12816. </summary>
  12817. <value><c>true</c> if [print headers]; otherwise, <c>false</c>.</value>
  12818. </member>
  12819. <member name="T:NPOI.HSSF.Record.PrintSetupRecord">
  12820. Title: Print Setup Record
  12821. Description: Stores print Setup options -- bogus for HSSF (and marked as such)
  12822. REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12823. @author Andrew C. Oliver (acoliver at apache dot org)
  12824. @author Jason Height (jheight at chariot dot net dot au)
  12825. @version 2.0-pre
  12826. </member>
  12827. <member name="M:NPOI.HSSF.Record.PrintSetupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12828. Constructs a PrintSetup (SetUP) record and Sets its fields appropriately.
  12829. @param in the RecordInputstream to Read the record from
  12830. </member>
  12831. <member name="T:NPOI.HSSF.Record.ProtectionRev4Record">
  12832. Title: Protection Revision 4 Record
  12833. Description: describes whether this is a protected shared/tracked workbook
  12834. ( HSSF does not support encryption because we don't feel like going to jail )
  12835. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12836. @author Andrew C. Oliver (acoliver at apache dot org)
  12837. @version 2.0-pre
  12838. </member>
  12839. <member name="M:NPOI.HSSF.Record.ProtectionRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12840. Constructs a ProtectionRev4 record and Sets its fields appropriately.
  12841. @param in the RecordInputstream to Read the record from
  12842. </member>
  12843. <member name="P:NPOI.HSSF.Record.ProtectionRev4Record.Protect">
  12844. Get whether the this is protected shared/tracked workbook or not
  12845. @return whether to protect the workbook or not
  12846. </member>
  12847. <member name="T:NPOI.HSSF.Record.ProtectRecord">
  12848. Title: Protect Record
  12849. Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
  12850. (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)
  12851. (after all terrorists will all use US-legal encrypton right??)
  12852. HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
  12853. ignore the password record entirely).
  12854. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12855. @author Andrew C. Oliver (acoliver at apache dot org)
  12856. </member>
  12857. <member name="M:NPOI.HSSF.Record.ProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12858. Constructs a Protect record and Sets its fields appropriately.
  12859. @param in the RecordInputstream to Read the record from
  12860. </member>
  12861. <member name="P:NPOI.HSSF.Record.ProtectRecord.Protect">
  12862. Get whether the sheet is protected or not
  12863. @return whether to protect the sheet or not
  12864. </member>
  12865. <member name="T:NPOI.HSSF.Record.RecalcIdRecord">
  12866. Title: Recalc Id Record
  12867. Description: This record Contains an ID that marks when a worksheet was last
  12868. recalculated. It's an optimization Excel uses to determine if it
  12869. needs to recalculate the spReadsheet when it's opened. So far, only
  12870. the two values <c>0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00</c>
  12871. (do not recalculate) and <c>0xC1 0x01 0x00 0x00 0x60 0x69 0x01
  12872. 0x00</c> have been seen. If the field <c>isNeeded</c> Is
  12873. Set to false (default), then this record Is swallowed during the
  12874. serialization Process
  12875. REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
  12876. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  12877. @version 2.0-pre
  12878. @see org.apache.poi.hssf.model.Workbook
  12879. </member>
  12880. <member name="F:NPOI.HSSF.Record.RecalcIdRecord._engineId">
  12881. An unsigned integer that specifies the recalculation engine identifier
  12882. of the recalculation engine that performed the last recalculation.
  12883. If the value is less than the recalculation engine identifier associated with the application,
  12884. the application will recalculate the results of all formulas on
  12885. this workbook immediately after loading the file
  12886. </member>
  12887. <member name="M:NPOI.HSSF.Record.RecalcIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12888. Constructs a RECALCID record and Sets its fields appropriately.
  12889. @param in the RecordInputstream to Read the record from
  12890. </member>
  12891. <member name="T:NPOI.HSSF.Record.Record">
  12892. Title: Record
  12893. Description: All HSSF Records inherit from this class. It
  12894. populates the fields common to all records (id, size and data).
  12895. Subclasses should be sure to validate the id,
  12896. Company:
  12897. @author Andrew C. Oliver
  12898. @author Marc Johnson (mjohnson at apache dot org)
  12899. @author Jason Height (jheight at chariot dot net dot au)
  12900. @version 2.0-pre
  12901. </member>
  12902. <member name="M:NPOI.HSSF.Record.Record.#ctor">
  12903. instantiates a blank record strictly for ID matching
  12904. </member>
  12905. <member name="M:NPOI.HSSF.Record.Record.Serialize">
  12906. called by the class that is responsible for writing this sucker.
  12907. Subclasses should implement this so that their data is passed back in a
  12908. byte array.
  12909. @return byte array containing instance data
  12910. </member>
  12911. <member name="P:NPOI.HSSF.Record.Record.Sid">
  12912. return the non static version of the id for this record.
  12913. </member>
  12914. <member name="T:NPOI.HSSF.Record.RecordBase">
  12915. Common base class of {@link Record} and {@link RecordAggregate}
  12916. @author Josh Micich
  12917. </member>
  12918. <member name="M:NPOI.HSSF.Record.RecordBase.Serialize(System.Int32,System.Byte[])">
  12919. called by the class that is responsible for writing this sucker.
  12920. Subclasses should implement this so that their data is passed back in a
  12921. byte array.
  12922. @param offset to begin writing at
  12923. @param data byte array containing instance data
  12924. @return number of bytes written
  12925. </member>
  12926. <member name="P:NPOI.HSSF.Record.RecordBase.RecordSize">
  12927. gives the current serialized size of the record. Should include the sid
  12928. and reclength (4 bytes).
  12929. </member>
  12930. <member name="T:NPOI.HSSF.Record.RecordFactory">
  12931. Title: Record Factory
  12932. Description: Takes a stream and outputs an array of Record objects.
  12933. @deprecated use {@link org.apache.poi.hssf.eventmodel.EventRecordFactory} instead
  12934. @see org.apache.poi.hssf.eventmodel.EventRecordFactory
  12935. @author Andrew C. Oliver (acoliver at apache dot org)
  12936. @author Marc Johnson (mjohnson at apache dot org)
  12937. @author Glen Stampoultzis (glens at apache.org)
  12938. @author Csaba Nagy (ncsaba at yahoo dot com)
  12939. </member>
  12940. <member name="T:NPOI.HSSF.Record.RecordFactory.ReflectionMethodRecordCreator">
  12941. A "create" method is used instead of the usual constructor if the created record might
  12942. be of a different class to the declaring class.
  12943. </member>
  12944. <member name="F:NPOI.HSSF.Record.RecordFactory._recordCreatorsById">
  12945. cache of the recordsToMap();
  12946. </member>
  12947. <member name="M:NPOI.HSSF.Record.RecordFactory.GetRecordClass(System.Int32)">
  12948. Debug / diagnosis method<br/>
  12949. Gets the POI implementation class for a given <tt>sid</tt>. Only a subset of the any BIFF
  12950. records are actually interpreted by POI. A few others are known but not interpreted
  12951. (see {@link UnknownRecord#getBiffName(int)}).
  12952. @return the POI implementation class for the specified record <tt>sid</tt>.
  12953. <code>null</code> if the specified record is not interpreted by POI.
  12954. </member>
  12955. <member name="M:NPOI.HSSF.Record.RecordFactory.SetCapacity(System.Int32)">
  12956. Changes the default capacity (10000) to handle larger files
  12957. </member>
  12958. <member name="M:NPOI.HSSF.Record.RecordFactory.CreateRecords(System.IO.Stream)">
  12959. Create an array of records from an input stream
  12960. @param in the InputStream from which the records will be
  12961. obtained
  12962. @return an array of Records Created from the InputStream
  12963. @exception RecordFormatException on error Processing the
  12964. InputStream
  12965. </member>
  12966. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertBlankRecords(NPOI.HSSF.Record.MulBlankRecord)">
  12967. Converts a {@link MulBlankRecord} into an equivalent array of {@link BlankRecord}s
  12968. </member>
  12969. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertToNumberRecord(NPOI.HSSF.Record.RKRecord)">
  12970. <summary>
  12971. RK record is a slightly smaller alternative to NumberRecord
  12972. POI likes NumberRecord better
  12973. </summary>
  12974. <param name="rk">The rk.</param>
  12975. <returns></returns>
  12976. </member>
  12977. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertRKRecords(NPOI.HSSF.Record.MulRKRecord)">
  12978. <summary>
  12979. Converts a MulRKRecord into an equivalent array of NumberRecords
  12980. </summary>
  12981. <param name="mrk">The MRK.</param>
  12982. <returns></returns>
  12983. </member>
  12984. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream">
  12985. A stream based way to get at complete records, with
  12986. as low a memory footprint as possible.
  12987. This handles Reading from a RecordInputStream, turning
  12988. the data into full records, processing continue records
  12989. etc.
  12990. Most users should use {@link HSSFEventFactory} /
  12991. {@link HSSFListener} and have new records pushed to
  12992. them, but this does allow for a "pull" style of coding.
  12993. </member>
  12994. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo">
  12995. Keeps track of the sizes of the Initial records up to and including {@link FilePassRecord}
  12996. Needed for protected files because each byte is encrypted with respect to its absolute
  12997. position from the start of the stream.
  12998. </member>
  12999. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.LastRecord">
  13000. @return last record scanned while looking for encryption info.
  13001. This will typically be the first or second record Read. Possibly <code>null</code>
  13002. if stream was empty
  13003. </member>
  13004. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.HasBOFRecord">
  13005. <c>false</c> in some test cases
  13006. </member>
  13007. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordBuffer">
  13008. Temporarily stores a group of {@link Record}s, for future return by {@link #nextRecord()}.
  13009. This is used at the start of the workbook stream, and also when the most recently read
  13010. underlying record is a {@link MulRKRecord}
  13011. </member>
  13012. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordIndex">
  13013. used to help iterating over the unread records
  13014. </member>
  13015. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastRecord">
  13016. The most recent record that we gave to the user
  13017. </member>
  13018. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastDrawingRecord">
  13019. The most recent DrawingRecord seen
  13020. </member>
  13021. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.#ctor(System.IO.Stream,System.Boolean)">
  13022. @param shouldIncludeContinueRecords caller can pass <c>false</c> if loose
  13023. {@link ContinueRecord}s should be skipped (this is sometimes useful in event based
  13024. processing).
  13025. </member>
  13026. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.NextRecord">
  13027. Returns the next (complete) record from the
  13028. stream, or null if there are no more.
  13029. </member>
  13030. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.GetNextUnreadRecord">
  13031. @return the next {@link Record} from the multiple record group as expanded from
  13032. a recently read {@link MulRKRecord}. <code>null</code> if not present.
  13033. </member>
  13034. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.ReadNextRecord">
  13035. @return the next available record, or <code>null</code> if
  13036. this pass didn't return a record that's
  13037. suitable for returning (eg was a continue record).
  13038. </member>
  13039. <member name="T:NPOI.HSSF.Record.RecordInputStream">
  13040. Title: Record Input Stream
  13041. Description: Wraps a stream and provides helper methods for the construction of records.
  13042. @author Jason Height (jheight @ apache dot org)
  13043. </member>
  13044. <member name="F:NPOI.HSSF.Record.RecordInputStream.MAX_RECORD_DATA_SIZE">
  13045. Maximum size of a single record (minus the 4 byte header) without a continue
  13046. </member>
  13047. <member name="F:NPOI.HSSF.Record.RecordInputStream._bhi">
  13048. Header {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  13049. </member>
  13050. <member name="F:NPOI.HSSF.Record.RecordInputStream._dataInput">
  13051. Data {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  13052. </member>
  13053. <member name="M:NPOI.HSSF.Record.RecordInputStream.#ctor(System.IO.Stream)">
  13054. the record identifier of the BIFF record currently being read
  13055. </member>
  13056. <member name="M:NPOI.HSSF.Record.RecordInputStream.Read">
  13057. This method will Read a byte from the current record
  13058. </member>
  13059. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadNextSid">
  13060. @return the sid of the next record or {@link #INVALID_SID_VALUE} if at end of stream
  13061. </member>
  13062. <member name="M:NPOI.HSSF.Record.RecordInputStream.NextRecord">
  13063. Moves to the next record in the stream.
  13064. <i>Note: The auto continue flag is Reset to true</i>
  13065. </member>
  13066. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadByte">
  13067. Reads an 8 bit, signed value
  13068. </member>
  13069. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadShort">
  13070. Reads a 16 bit, signed value
  13071. </member>
  13072. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUByte">
  13073. Reads an 8 bit, Unsigned value
  13074. </member>
  13075. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUShort">
  13076. Reads a 16 bit,un- signed value.
  13077. @return
  13078. </member>
  13079. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUnicodeLEString(System.Int32)">
  13080. given a byte array of 16-bit Unicode Chars, compress to 8-bit and
  13081. return a string
  13082. { 0x16, 0x00 } -0x16
  13083. @param Length the Length of the string
  13084. @return the Converted string
  13085. @exception ArgumentException if len is too large (i.e.,
  13086. there is not enough data in string to Create a String of that
  13087. Length)
  13088. </member>
  13089. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadRemainder">
  13090. Returns the remaining bytes for the current record.
  13091. @return The remaining bytes of the current record.
  13092. </member>
  13093. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadAllContinuedRemainder">
  13094. Reads all byte data for the current record, including any
  13095. that overlaps into any following continue records.
  13096. @deprecated Best to write a input stream that wraps this one where there Is
  13097. special sub record that may overlap continue records.
  13098. </member>
  13099. <member name="P:NPOI.HSSF.Record.RecordInputStream.Remaining">
  13100. The remaining number of bytes in the <i>current</i> record.
  13101. @return The number of bytes remaining in the current record
  13102. </member>
  13103. <member name="P:NPOI.HSSF.Record.RecordInputStream.IsContinueNext">
  13104. Returns true iif a Continue record is next in the excel stream _currentDataOffset
  13105. @return True when a ContinueRecord is next.
  13106. </member>
  13107. <member name="M:NPOI.HSSF.Record.RecordInputStream.GetNextSid">
  13108. @return sid of next record. Can be called after hasNextRecord()
  13109. </member>
  13110. <member name="T:NPOI.HSSF.Record.RefModeRecord">
  13111. Title: RefMode Record
  13112. Description: Describes which reference mode to use
  13113. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13114. @author Andrew C. Oliver (acoliver at apache dot org)
  13115. @author Jason Height (jheight at chariot dot net dot au)
  13116. @version 2.0-pre
  13117. </member>
  13118. <member name="M:NPOI.HSSF.Record.RefModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13119. Constructs a RefMode record and Sets its fields appropriately.
  13120. @param in the RecordInputstream to Read the record from
  13121. </member>
  13122. <member name="P:NPOI.HSSF.Record.RefModeRecord.Mode">
  13123. Get the reference mode to use (HSSF uses/assumes A1)
  13124. @return mode to use
  13125. @see #USE_A1_MODE
  13126. @see #USE_R1C1_MODE
  13127. </member>
  13128. <member name="T:NPOI.HSSF.Record.RefreshAllRecord">
  13129. Title: Refresh All Record
  13130. Description: Flag whether to refresh all external data when loading a sheet.
  13131. (which hssf doesn't support anyhow so who really cares?)
  13132. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13133. @author Andrew C. Oliver (acoliver at apache dot org)
  13134. @version 2.0-pre
  13135. </member>
  13136. <member name="M:NPOI.HSSF.Record.RefreshAllRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13137. Constructs a RefreshAll record and Sets its fields appropriately.
  13138. @param in the RecordInputstream to Read the record from
  13139. </member>
  13140. <member name="P:NPOI.HSSF.Record.RefreshAllRecord.RefreshAll">
  13141. Get whether to refresh all external data when loading a sheet
  13142. @return refreshall or not
  13143. </member>
  13144. <member name="T:NPOI.HSSF.Record.RightMarginRecord">
  13145. Record for the right margin. * NOTE: This source was automatically generated. * @author Shawn Laubach (slaubach at apache dot org)
  13146. </member>
  13147. <member name="M:NPOI.HSSF.Record.RightMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13148. 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)
  13149. </member>
  13150. <member name="P:NPOI.HSSF.Record.RightMarginRecord.Margin">
  13151. Get the margin field for the RightMargin record.
  13152. </member>
  13153. <member name="T:NPOI.HSSF.Record.RKRecord">
  13154. Title: RK Record
  13155. Description: An internal 32 bit number with the two most significant bits
  13156. storing the type. This is part of a bizarre scheme to save disk
  13157. space and memory (gee look at all the other whole records that
  13158. are in the file just "cause"..,far better to waste Processor
  13159. cycles on this then leave on of those "valuable" records out).
  13160. We support this in Read-ONLY mode. HSSF Converts these to NUMBER records
  13161. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13162. @author Andrew C. Oliver (acoliver at apache dot org)
  13163. @author Jason Height (jheight at chariot dot net dot au)
  13164. @version 2.0-pre
  13165. @see org.apache.poi.hssf.record.NumberRecord
  13166. </member>
  13167. <member name="M:NPOI.HSSF.Record.RKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13168. Constructs a RK record and Sets its fields appropriately.
  13169. @param in the RecordInputstream to Read the record from
  13170. </member>
  13171. <member name="P:NPOI.HSSF.Record.RKRecord.RKType">
  13172. Get the type of the number
  13173. @return one of these values:
  13174. <OL START="0">
  13175. <LI>RK_IEEE_NUMBER</LI>
  13176. <LI>RK_IEEE_NUMBER_TIMES_100</LI>
  13177. <LI>RK_INTEGER</LI>
  13178. <LI>RK_INTEGER_TIMES_100</LI>
  13179. </OL>
  13180. </member>
  13181. <member name="P:NPOI.HSSF.Record.RKRecord.RKNumber">
  13182. Extract the value of the number
  13183. The mechanism for determining the value is dependent on the two
  13184. low order bits of the raw number. If bit 1 is Set, the number
  13185. is an integer and can be cast directly as a double, otherwise,
  13186. it's apparently the exponent and mantissa of a double (and the
  13187. remaining low-order bits of the double's mantissa are 0's).
  13188. If bit 0 is Set, the result of the conversion to a double Is
  13189. divided by 100; otherwise, the value is left alone.
  13190. [Insert picture of Screwy Squirrel in full Napoleonic regalia]
  13191. @return the value as a proper double (hey, it <B>could</B>
  13192. happen)
  13193. </member>
  13194. <member name="T:NPOI.HSSF.Record.RowRecord">
  13195. Title: Row Record
  13196. Description: stores the row information for the sheet.
  13197. REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13198. @author Andrew C. Oliver (acoliver at apache dot org)
  13199. @author Jason Height (jheight at chariot dot net dot au)
  13200. @version 2.0-pre
  13201. </member>
  13202. <member name="F:NPOI.HSSF.Record.RowRecord.MAX_ROW_NUMBER">
  13203. The maximum row number that excel can handle (zero based) ie 65536 rows Is
  13204. max number of rows.
  13205. </member>
  13206. <member name="F:NPOI.HSSF.Record.RowRecord.field_7_option_flags">
  13207. 16 bit options flags
  13208. </member>
  13209. <member name="M:NPOI.HSSF.Record.RowRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13210. Constructs a Row record and Sets its fields appropriately.
  13211. @param in the RecordInputstream to Read the record from
  13212. </member>
  13213. <member name="P:NPOI.HSSF.Record.RowRecord.IsEmpty">
  13214. Get the logical row number for this row (0 based index)
  13215. @return row - the row number
  13216. </member>
  13217. <member name="P:NPOI.HSSF.Record.RowRecord.FirstCol">
  13218. Get the logical col number for the first cell this row (0 based index)
  13219. @return col - the col number
  13220. </member>
  13221. <member name="P:NPOI.HSSF.Record.RowRecord.LastCol">
  13222. Get the logical col number for the last cell this row plus one (0 based index)
  13223. @return col - the last col number + 1
  13224. </member>
  13225. <member name="P:NPOI.HSSF.Record.RowRecord.Height">
  13226. Get the height of the row
  13227. @return height of the row
  13228. </member>
  13229. <member name="P:NPOI.HSSF.Record.RowRecord.Optimize">
  13230. Get whether to optimize or not (Set to 0)
  13231. @return optimize (Set to 0)
  13232. </member>
  13233. <member name="P:NPOI.HSSF.Record.RowRecord.OptionFlags">
  13234. Gets the option bitmask. (use the individual bit Setters that refer to this
  13235. method)
  13236. @return options - the bitmask
  13237. </member>
  13238. <member name="P:NPOI.HSSF.Record.RowRecord.OutlineLevel">
  13239. Get the outline level of this row
  13240. @return ol - the outline level
  13241. @see #GetOptionFlags()
  13242. </member>
  13243. <member name="P:NPOI.HSSF.Record.RowRecord.Colapsed">
  13244. Get whether or not to colapse this row
  13245. @return c - colapse or not
  13246. @see #GetOptionFlags()
  13247. </member>
  13248. <member name="P:NPOI.HSSF.Record.RowRecord.ZeroHeight">
  13249. Get whether or not to Display this row with 0 height
  13250. @return - z height is zero or not.
  13251. @see #GetOptionFlags()
  13252. </member>
  13253. <member name="P:NPOI.HSSF.Record.RowRecord.BadFontHeight">
  13254. Get whether the font and row height are not compatible
  13255. @return - f -true if they aren't compatible (damn not logic)
  13256. @see #GetOptionFlags()
  13257. </member>
  13258. <member name="P:NPOI.HSSF.Record.RowRecord.Formatted">
  13259. Get whether the row has been formatted (even if its got all blank cells)
  13260. @return formatted or not
  13261. @see #GetOptionFlags()
  13262. </member>
  13263. <member name="P:NPOI.HSSF.Record.RowRecord.XFIndex">
  13264. if the row is formatted then this is the index to the extended format record
  13265. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  13266. @return index to the XF record or bogus value (undefined) if Isn't formatted
  13267. </member>
  13268. <member name="P:NPOI.HSSF.Record.RowRecord.TopBorder">
  13269. bit that specifies whether any cell in the row has a thick top border, or any
  13270. cell in the row directly above the current row has a thick bottom border.
  13271. @param f has thick top border
  13272. </member>
  13273. <member name="P:NPOI.HSSF.Record.RowRecord.BottomBorder">
  13274. A bit that specifies whether any cell in the row has a medium or thick
  13275. bottom border, or any cell in the row directly below the current row has
  13276. a medium or thick top border.
  13277. @param f has thick bottom border
  13278. </member>
  13279. <member name="P:NPOI.HSSF.Record.RowRecord.PhoeneticGuide">
  13280. A bit that specifies whether the phonetic guide feature is enabled for
  13281. any cell in this row.
  13282. @param f use phoenetic guide
  13283. </member>
  13284. <member name="T:NPOI.HSSF.Record.SaveRecalcRecord">
  13285. Title: Save Recalc Record
  13286. Description: defines whether to recalculate before saving (Set to true)
  13287. REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13288. @author Andrew C. Oliver (acoliver at apache dot org)
  13289. @author Jason Height (jheight at chariot dot net dot au)
  13290. @version 2.0-pre
  13291. </member>
  13292. <member name="M:NPOI.HSSF.Record.SaveRecalcRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13293. Constructs an SaveRecalc record and Sets its fields appropriately.
  13294. @param in the RecordInputstream to Read the record from
  13295. </member>
  13296. <member name="P:NPOI.HSSF.Record.SaveRecalcRecord.Recalc">
  13297. Get whether to recalculate formulas/etc before saving or not
  13298. @return recalc - whether to recalculate or not
  13299. </member>
  13300. <member name="T:NPOI.HSSF.Record.ScenarioProtectRecord">
  13301. Title: Scenario Protect Record
  13302. Description: I have no idea what a Scenario is or why on would want to
  13303. protect it with the lamest "security" ever invented. However this record tells
  13304. excel "I want to protect my scenarios" (0xAF) with lame security. It appears
  13305. in conjunction with the PASSWORD and PROTECT records as well as its object
  13306. protect cousin.
  13307. REFERENCE: PG 383 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13308. @author Andrew C. Oliver (acoliver at apache dot org)
  13309. </member>
  13310. <member name="M:NPOI.HSSF.Record.ScenarioProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13311. Constructs a Protect record and Sets its fields appropriately.
  13312. @param in the RecordInputstream to Read the record from
  13313. </member>
  13314. <member name="P:NPOI.HSSF.Record.ScenarioProtectRecord.Protect">
  13315. Get whether the sheet is protected or not
  13316. @return whether to protect the sheet or not
  13317. </member>
  13318. <member name="T:NPOI.HSSF.Record.SCLRecord">
  13319. * Specifies the window's zoom magnification. If this record Isn't present then the windows zoom is 100%. see p384 Excel Dev Kit
  13320. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  13321. * Remove the record in src/records/definitions.
  13322. * @author Andrew C. Oliver (acoliver at apache.org)
  13323. </member>
  13324. <member name="M:NPOI.HSSF.Record.SCLRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13325. Constructs a SCL record and Sets its fields appropriately.
  13326. @param in the RecordInputstream to Read the record from
  13327. </member>
  13328. <member name="P:NPOI.HSSF.Record.SCLRecord.DataSize">
  13329. Size of record (exluding 4 byte header)
  13330. </member>
  13331. <member name="P:NPOI.HSSF.Record.SCLRecord.Numerator">
  13332. Get the numerator field for the SCL record.
  13333. </member>
  13334. <member name="P:NPOI.HSSF.Record.SCLRecord.Denominator">
  13335. Get the denominator field for the SCL record.
  13336. </member>
  13337. <member name="T:NPOI.HSSF.Record.SelectionRecord">
  13338. Title: Selection Record
  13339. Description: shows the user's selection on the sheet
  13340. for Write Set num refs to 0
  13341. TODO : Fully implement reference subrecords.
  13342. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13343. @author Andrew C. Oliver (acoliver at apache dot org)
  13344. @author Jason Height (jheight at chariot dot net dot au)
  13345. @author Glen Stampoultzis (glens at apache.org)
  13346. </member>
  13347. <member name="M:NPOI.HSSF.Record.SelectionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13348. <summary>
  13349. Constructs a Selection record and Sets its fields appropriately.
  13350. </summary>
  13351. <param name="in1">the RecordInputstream to Read the record from</param>
  13352. </member>
  13353. <member name="P:NPOI.HSSF.Record.SelectionRecord.Pane">
  13354. <summary>
  13355. Gets or sets the pane this is for.
  13356. </summary>
  13357. <value>The pane.</value>
  13358. </member>
  13359. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRow">
  13360. <summary>
  13361. Gets or sets the active cell row.
  13362. </summary>
  13363. <value>row number of active cell</value>
  13364. </member>
  13365. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellCol">
  13366. <summary>
  13367. Gets or sets the active cell's col
  13368. </summary>
  13369. <value>number of active cell</value>
  13370. </member>
  13371. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRef">
  13372. <summary>
  13373. Gets or sets the active cell's reference number
  13374. </summary>
  13375. <value>ref number of active cell</value>
  13376. </member>
  13377. <member name="T:NPOI.HSSF.Record.SharedFormulaRecord">
  13378. Title: SharedFormulaRecord
  13379. Description: Primarily used as an excel optimization so that multiple similar formulas
  13380. are not written out too many times. We should recognize this record and
  13381. Serialize as Is since this Is used when Reading templates.
  13382. Note: the documentation says that the SID Is BC where biffviewer reports 4BC. The hex dump shows
  13383. that the two byte sid representation to be 'BC 04' that Is consistent with the other high byte
  13384. record types.
  13385. @author Danny Mui at apache dot org
  13386. </member>
  13387. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13388. @param in the RecordInputstream to Read the record from
  13389. </member>
  13390. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.ToString">
  13391. print a sort of string representation ([SHARED FORMULA RECORD] id = x [/SHARED FORMULA RECORD])
  13392. </member>
  13393. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.GetFormulaTokens(NPOI.HSSF.Record.FormulaRecord)">
  13394. @return the equivalent {@link Ptg} array that the formula would have, were it not shared.
  13395. </member>
  13396. <member name="T:NPOI.HSSF.Record.SharedValueRecordBase">
  13397. Common base class for {@link SharedFormulaRecord}, {@link ArrayRecord} and
  13398. {@link TableRecord} which are have similarities.
  13399. @author Josh Micich
  13400. </member>
  13401. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13402. reads only the range (1 {@link CellRangeAddress8Bit}) from the stream
  13403. </member>
  13404. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsInRange(System.Int32,System.Int32)">
  13405. @return <c>true</c> if (rowIx, colIx) is within the range ({@link #Range})
  13406. of this shared value object.
  13407. </member>
  13408. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsFirstCell(System.Int32,System.Int32)">
  13409. @return <c>true</c> if (rowIx, colIx) describes the first cell in this shared value
  13410. object's range ({@link #Range})
  13411. </member>
  13412. <member name="T:NPOI.HSSF.Record.SSTDeserializer">
  13413. Handles the task of deserializing a SST string. The two main entry points are
  13414. @author Glen Stampoultzis (glens at apache.org)
  13415. @author Jason Height (jheight at apache.org)
  13416. </member>
  13417. <member name="M:NPOI.HSSF.Record.SSTDeserializer.ManufactureStrings(System.Int32,NPOI.HSSF.Record.RecordInputStream)">
  13418. This Is the starting point where strings are constructed. Note that
  13419. strings may span across multiple continuations. Read the SST record
  13420. carefully before beginning to hack.
  13421. </member>
  13422. <member name="T:NPOI.HSSF.Record.SSTRecord">
  13423. Title: Static String Table Record
  13424. Description: This holds all the strings for LabelSSTRecords.
  13425. REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN:
  13426. 1-57231-498-2)
  13427. @author Andrew C. Oliver (acoliver at apache dot org)
  13428. @author Marc Johnson (mjohnson at apache dot org)
  13429. @author Glen Stampoultzis (glens at apache.org)
  13430. @see org.apache.poi.hssf.record.LabelSSTRecord
  13431. @see org.apache.poi.hssf.record.ContinueRecord
  13432. </member>
  13433. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_RECORD_SIZE">
  13434. how big can an SST record be? As big as any record can be: 8228 bytes
  13435. </member>
  13436. <member name="F:NPOI.HSSF.Record.SSTRecord.STD_RECORD_OVERHEAD">
  13437. standard record overhead: two shorts (record id plus data space size)
  13438. </member>
  13439. <member name="F:NPOI.HSSF.Record.SSTRecord.SST_RECORD_OVERHEAD">
  13440. SST overhead: the standard record overhead, plus the number of strings and the number of Unique strings -- two ints
  13441. </member>
  13442. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_DATA_SPACE">
  13443. how much data can we stuff into an SST record? That would be _max minus the standard SST record overhead
  13444. </member>
  13445. <member name="F:NPOI.HSSF.Record.SSTRecord.field_1_num_strings">
  13446. Union of strings in the SST and EXTSST
  13447. </member>
  13448. <member name="F:NPOI.HSSF.Record.SSTRecord.field_2_num_unique_strings">
  13449. according to docs ONLY SST
  13450. </member>
  13451. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketAbsoluteOffsets">
  13452. Offsets from the beginning of the SST record (even across continuations)
  13453. </member>
  13454. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketRelativeOffsets">
  13455. Offsets relative the start of the current SST or continue record
  13456. </member>
  13457. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor">
  13458. default constructor
  13459. </member>
  13460. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13461. Constructs an SST record and Sets its fields appropriately.
  13462. @param in the RecordInputstream to Read the record from
  13463. </member>
  13464. <member name="M:NPOI.HSSF.Record.SSTRecord.AddString(NPOI.HSSF.Record.UnicodeString)">
  13465. Add a string.
  13466. @param string string to be Added
  13467. @return the index of that string in the table
  13468. </member>
  13469. <member name="P:NPOI.HSSF.Record.SSTRecord.NumStrings">
  13470. @return number of strings
  13471. </member>
  13472. <member name="P:NPOI.HSSF.Record.SSTRecord.NumUniqueStrings">
  13473. @return number of Unique strings
  13474. </member>
  13475. <member name="M:NPOI.HSSF.Record.SSTRecord.GetString(System.Int32)">
  13476. Get a particular string by its index
  13477. @param id index into the array of strings
  13478. @return the desired string
  13479. </member>
  13480. <member name="M:NPOI.HSSF.Record.SSTRecord.ToString">
  13481. Return a debugging string representation
  13482. @return string representation
  13483. </member>
  13484. <member name="P:NPOI.HSSF.Record.SSTRecord.Sid">
  13485. @return sid
  13486. </member>
  13487. <member name="M:NPOI.HSSF.Record.SSTRecord.GetHashCode">
  13488. @return hashcode
  13489. </member>
  13490. <member name="M:NPOI.HSSF.Record.SSTRecord.GetStrings">
  13491. @return an iterator of the strings we hold. All instances are
  13492. UnicodeStrings
  13493. </member>
  13494. <member name="P:NPOI.HSSF.Record.SSTRecord.CountStrings">
  13495. @return count of the strings we hold.
  13496. </member>
  13497. <member name="M:NPOI.HSSF.Record.SSTRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  13498. called by the class that Is responsible for writing this sucker.
  13499. Subclasses should implement this so that their data Is passed back in a
  13500. byte array.
  13501. @return size
  13502. </member>
  13503. <member name="M:NPOI.HSSF.Record.SSTRecord.CreateExtSSTRecord(System.Int32)">
  13504. Creates an extended string record based on the current contents of
  13505. the current SST record. The offset within the stream to the SST record
  13506. Is required because the extended string record points directly to the
  13507. strings in the SST record.
  13508. NOTE: THIS FUNCTION MUST ONLY BE CALLED AFTER THE SST RECORD HAS BEEN
  13509. SERIALIZED.
  13510. @param sstOffset The offset in the stream to the start of the
  13511. SST record.
  13512. @return The new SST record.
  13513. </member>
  13514. <member name="M:NPOI.HSSF.Record.SSTRecord.CalcExtSSTRecordSize">
  13515. Calculates the size in bytes of the EXTSST record as it would be if the
  13516. record was Serialized.
  13517. @return The size of the ExtSST record in bytes.
  13518. </member>
  13519. <member name="T:NPOI.HSSF.Record.SSTSerializer">
  13520. This class handles serialization of SST records. It utilizes the record processor
  13521. class write individual records. This has been refactored from the SSTRecord class.
  13522. @author Glen Stampoultzis (glens at apache.org)
  13523. </member>
  13524. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketAbsoluteOffsets">
  13525. OffSets from the beginning of the SST record (even across continuations)
  13526. </member>
  13527. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketRelativeOffsets">
  13528. OffSets relative the start of the current SST or continue record
  13529. </member>
  13530. <member name="T:NPOI.HSSF.Record.StandardRecord">
  13531. Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for
  13532. some simplification of serialization logic
  13533. @author Josh Micich
  13534. </member>
  13535. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(System.Int32,System.Byte[])">
  13536. <summary>
  13537. Write the data content of this BIFF record including the sid and record length.
  13538. The subclass must write the exact number of bytes as reported by Record#getRecordSize()
  13539. </summary>
  13540. <param name="offset">offset</param>
  13541. <param name="data">data</param>
  13542. <returns></returns>
  13543. </member>
  13544. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13545. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
  13546. have already been written by the superclass.<br/>
  13547. The number of bytes written must equal the record size reported by
  13548. {@link Record#getDataSize()} minus four
  13549. ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
  13550. by thye superclass).
  13551. </member>
  13552. <member name="T:NPOI.HSSF.Record.StringRecord">
  13553. Supports the STRING record structure.
  13554. @author Glen Stampoultzis (glens at apache.org)
  13555. </member>
  13556. <member name="M:NPOI.HSSF.Record.StringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13557. Constructs a String record and Sets its fields appropriately.
  13558. @param in the RecordInputstream to Read the record from
  13559. </member>
  13560. <member name="M:NPOI.HSSF.Record.StringRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  13561. called by the class that Is responsible for writing this sucker.
  13562. Subclasses should implement this so that their data Is passed back in a
  13563. byte array.
  13564. @param offset to begin writing at
  13565. @param data byte array containing instance data
  13566. @return number of bytes written
  13567. </member>
  13568. <member name="P:NPOI.HSSF.Record.StringRecord.Sid">
  13569. return the non static version of the id for this record.
  13570. </member>
  13571. <member name="P:NPOI.HSSF.Record.StringRecord.String">
  13572. @return The string represented by this record.
  13573. </member>
  13574. <member name="T:NPOI.HSSF.Record.StyleRecord">
  13575. Title: Style Record
  13576. Description: Describes a builtin to the gui or user defined style
  13577. REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13578. @author Andrew C. Oliver (acoliver at apache dot org)
  13579. @author aviks : string fixes for UserDefined Style
  13580. @version 2.0-pre
  13581. </member>
  13582. <member name="M:NPOI.HSSF.Record.StyleRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13583. Constructs a Style record and Sets its fields appropriately.
  13584. @param in the RecordInputstream to Read the record from
  13585. </member>
  13586. <member name="M:NPOI.HSSF.Record.StyleRecord.SetBuiltinStyle(System.Int32)">
  13587. if this is a builtin style set the number of the built in style
  13588. @param builtinStyleId style number (0-7)
  13589. </member>
  13590. <member name="P:NPOI.HSSF.Record.StyleRecord.XFIndex">
  13591. Get the actual index of the style extended format record
  13592. @see #Index
  13593. @return index of the xf record
  13594. </member>
  13595. <member name="P:NPOI.HSSF.Record.StyleRecord.Name">
  13596. Get the style's name
  13597. @return name of the style
  13598. @see #NameLength
  13599. </member>
  13600. <member name="P:NPOI.HSSF.Record.StyleRecord.OutlineStyleLevel">
  13601. Get the row or column level of the style (if builtin 1||2)
  13602. </member>
  13603. <member name="T:NPOI.HSSF.Record.CommonObjectType">
  13604. * The common object data record is used to store all common preferences for an excel object.
  13605. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  13606. * Remove the record in src/records/definitions.
  13607. * @author Glen Stampoultzis (glens at apache.org)
  13608. </member>
  13609. <member name="M:NPOI.HSSF.Record.CommonObjectDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13610. Constructs a CommonObjectData record and Sets its fields appropriately.
  13611. @param in the RecordInputstream to Read the record from
  13612. </member>
  13613. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.DataSize">
  13614. Size of record (exluding 4 byte header)
  13615. </member>
  13616. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectType">
  13617. Get the object type field for the CommonObjectData record.
  13618. </member>
  13619. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectId">
  13620. Get the object id field for the CommonObjectData record.
  13621. </member>
  13622. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Option">
  13623. Get the option field for the CommonObjectData record.
  13624. </member>
  13625. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved1">
  13626. Get the reserved1 field for the CommonObjectData record.
  13627. </member>
  13628. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved2">
  13629. Get the reserved2 field for the CommonObjectData record.
  13630. </member>
  13631. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved3">
  13632. Get the reserved3 field for the CommonObjectData record.
  13633. </member>
  13634. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsLocked">
  13635. true if object is locked when sheet has been protected
  13636. @return the locked field value.
  13637. </member>
  13638. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsPrintable">
  13639. object appears when printed
  13640. @return the printable field value.
  13641. </member>
  13642. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoFill">
  13643. whether object uses an automatic Fill style
  13644. @return the autoFill field value.
  13645. </member>
  13646. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoline">
  13647. whether object uses an automatic line style
  13648. @return the autoline field value.
  13649. </member>
  13650. <member name="T:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord">
  13651. A sub-record within the OBJ record which stores a reference to an object
  13652. stored in a Separate entry within the OLE2 compound file.
  13653. @author Daniel Noll
  13654. </member>
  13655. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_2_refPtg">
  13656. either an area or a cell ref
  13657. </member>
  13658. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_4_unknownByte">
  13659. Formulas often have a single non-zero trailing byte.
  13660. This is in a similar position to he pre-streamId padding
  13661. It is unknown if the value is important (it seems to mirror a value a few bytes earlier)
  13662. </member>
  13663. <member name="M:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13664. Constructs an EmbeddedObjectRef record and Sets its fields appropriately.
  13665. @param in the record input stream.
  13666. </member>
  13667. <member name="P:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.StreamId">
  13668. Gets the stream ID containing the actual data. The data itself
  13669. can be found under a top-level directory entry in the OLE2 filesystem
  13670. under the name "MBD<var>xxxxxxxx</var>" where <var>xxxxxxxx</var> is
  13671. this ID converted into hex (in big endian order, funnily enough.)
  13672. @return the data stream ID. Possibly <c>null</c>
  13673. </member>
  13674. <member name="T:NPOI.HSSF.Record.EndSubRecord">
  13675. * The end data record is used to denote the end of the subrecords.
  13676. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  13677. * Remove the record in src/records/definitions.
  13678. * @author Glen Stampoultzis (glens at apache.org)
  13679. </member>
  13680. <member name="M:NPOI.HSSF.Record.EndSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13681. Constructs a End record and Sets its fields appropriately.
  13682. @param in the RecordInputstream to Read the record from
  13683. </member>
  13684. <member name="P:NPOI.HSSF.Record.EndSubRecord.DataSize">
  13685. Size of record (exluding 4 byte header)
  13686. </member>
  13687. <member name="T:NPOI.HSSF.Record.GroupMarkerSubRecord">
  13688. * The Group marker record is used as a position holder for Groups.
  13689. * @author Glen Stampoultzis (glens at apache.org)
  13690. </member>
  13691. <member name="M:NPOI.HSSF.Record.GroupMarkerSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13692. Constructs a Group marker record and Sets its fields appropriately.
  13693. @param in the RecordInputstream to Read the record from
  13694. </member>
  13695. <member name="P:NPOI.HSSF.Record.GroupMarkerSubRecord.DataSize">
  13696. Size of record (exluding 4 byte header)
  13697. </member>
  13698. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cbFContinued">
  13699. From [MS-XLS].pdf 2.5.147 FtLbsData:
  13700. An unsigned integer that indirectly specifies whether
  13701. some of the data in this structure appear in a subsequent Continue record.
  13702. If _cbFContinued is 0x00, all of the fields in this structure except sid and _cbFContinued
  13703. MUST NOT exist. If this entire structure is Contained within the same record,
  13704. then _cbFContinued MUST be greater than or equal to the size, in bytes,
  13705. of this structure, not including the four bytes for the ft and _cbFContinued fields
  13706. </member>
  13707. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._unknownPreFormulaInt">
  13708. a formula that specifies the range of cell values that are the items in this list.
  13709. </member>
  13710. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cLines">
  13711. An unsigned integer that specifies the number of items in the list.
  13712. </member>
  13713. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._iSel">
  13714. An unsigned integer that specifies the one-based index of the first selected item in this list.
  13715. A value of 0x00 specifies there is no currently selected item.
  13716. </member>
  13717. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._flags">
  13718. flags that tell what data follows
  13719. </member>
  13720. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._idEdit">
  13721. An ObjId that specifies the edit box associated with this list.
  13722. A value of 0x00 specifies that there is no edit box associated with this list.
  13723. </member>
  13724. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._dropData">
  13725. An optional LbsDropData that specifies properties for this dropdown control.
  13726. This field MUST exist if and only if the Containing Obj?s cmo.ot is equal to 0x14.
  13727. </member>
  13728. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._rgLines">
  13729. An optional array of strings where each string specifies an item in the list.
  13730. The number of elements in this array, if it exists, MUST be {@link #_cLines}
  13731. </member>
  13732. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._bsels">
  13733. An optional array of bools that specifies
  13734. which items in the list are part of a multiple selection
  13735. </member>
  13736. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32,System.Int32)">
  13737. @param in the stream to read data from
  13738. @param cbFContinued the seconf short in the record header
  13739. @param cmoOt the Containing Obj's {@link CommonObjectDataSubRecord#field_1_objectType}
  13740. </member>
  13741. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.Formula">
  13742. @return the formula that specifies the range of cell values that are the items in this list.
  13743. </member>
  13744. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.NumberOfItems">
  13745. @return the number of items in the list
  13746. </member>
  13747. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.CreateAutoFilterInstance">
  13748. @return a new instance of LbsDataSubRecord to construct auto-filters
  13749. @see org.apache.poi.hssf.model.ComboboxShape#createObjRecord(org.apache.poi.hssf.usermodel.HSSFSimpleShape, int)
  13750. </member>
  13751. <member name="T:NPOI.HSSF.Record.LbsDropData">
  13752. This structure specifies properties of the dropdown list control
  13753. </member>
  13754. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_DROPDOWN">
  13755. Combo dropdown control
  13756. </member>
  13757. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_EDIT_DROPDOWN">
  13758. Combo Edit dropdown control
  13759. </member>
  13760. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_SIMPLE_DROPDOWN">
  13761. Simple dropdown control (just the dropdown button)
  13762. </member>
  13763. <member name="F:NPOI.HSSF.Record.LbsDropData._wStyle">
  13764. An unsigned integer that specifies the style of this dropdown.
  13765. </member>
  13766. <member name="F:NPOI.HSSF.Record.LbsDropData._cLine">
  13767. An unsigned integer that specifies the number of lines to be displayed in the dropdown.
  13768. </member>
  13769. <member name="F:NPOI.HSSF.Record.LbsDropData._dxMin">
  13770. An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window
  13771. </member>
  13772. <member name="F:NPOI.HSSF.Record.LbsDropData._str">
  13773. a string that specifies the current string value in the dropdown
  13774. </member>
  13775. <member name="F:NPOI.HSSF.Record.LbsDropData._unused">
  13776. Optional, undefined and MUST be ignored.
  13777. This field MUST exist if and only if the size of str in bytes is an odd number
  13778. </member>
  13779. <member name="T:NPOI.HSSF.Record.NoteStructureSubRecord">
  13780. Represents a NoteStructure (0xD) sub record.
  13781. The docs say nothing about it. The Length of this record is always 26 bytes.
  13782. @author Yegor Kozlov
  13783. </member>
  13784. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor">
  13785. Construct a new <c>NoteStructureSubRecord</c> and
  13786. Fill its data with the default values
  13787. </member>
  13788. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  13789. Constructs a NoteStructureSubRecord and Sets its fields appropriately.
  13790. </member>
  13791. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.ToString">
  13792. Convert this record to string.
  13793. Used by BiffViewer and other utulities.
  13794. </member>
  13795. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13796. Serialize the record data into the supplied array of bytes
  13797. @param offset offset in the <c>data</c>
  13798. @param data the data to Serialize into
  13799. @return size of the record
  13800. </member>
  13801. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.DataSize">
  13802. Size of record
  13803. </member>
  13804. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.Sid">
  13805. @return id of this record.
  13806. </member>
  13807. <member name="T:NPOI.HSSF.Record.ScrollableObjectSubRecord">
  13808. <summary>
  13809. FtSbs structure
  13810. </summary>
  13811. </member>
  13812. <member name="T:NPOI.HSSF.Record.SubRecord">
  13813. Subrecords are part of the OBJ class.
  13814. </member>
  13815. <member name="P:NPOI.HSSF.Record.SubRecord.IsTerminating">
  13816. Wether this record terminates the sub-record stream.
  13817. There are two cases when this method must be overridden and return <c>true</c>
  13818. - EndSubRecord (sid = 0x00)
  13819. - LbsDataSubRecord (sid = 0x12)
  13820. @return whether this record is the last in the sub-record stream
  13821. </member>
  13822. <member name="T:NPOI.HSSF.Record.SupBookRecord">
  13823. Title: Sup Book (EXTERNALBOOK)
  13824. Description: A External Workbook Description (Suplemental Book)
  13825. Its only a dummy record for making new ExternSheet Record
  13826. REFERENCE: 5.38
  13827. @author Libin Roman (Vista Portal LDT. Developer)
  13828. @author Andrew C. Oliver (acoliver@apache.org)
  13829. </member>
  13830. <member name="M:NPOI.HSSF.Record.SupBookRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13831. Constructs a Extern Sheet record and Sets its fields appropriately.
  13832. @param id id must be 0x16 or an exception will be throw upon validation
  13833. @param size the size of the data area of the record
  13834. @param data data of the record (should not contain sid/len)
  13835. </member>
  13836. <member name="T:NPOI.HSSF.Record.TabIdRecord">
  13837. Title: Sheet Tab Index Array Record
  13838. Description: Contains an array of sheet id's. Sheets always keep their ID
  13839. regardless of what their name Is.
  13840. REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13841. @author Andrew C. Oliver (acoliver at apache dot org)
  13842. @version 2.0-pre
  13843. </member>
  13844. <member name="M:NPOI.HSSF.Record.TabIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13845. Constructs a TabID record and Sets its fields appropriately.
  13846. @param in the RecordInputstream to Read the record from
  13847. </member>
  13848. <member name="M:NPOI.HSSF.Record.TabIdRecord.SetTabIdArray(System.Int16[])">
  13849. Set the tab array. (0,1,2).
  13850. @param array of tab id's {0,1,2}
  13851. </member>
  13852. <member name="M:NPOI.HSSF.Record.TabIdRecord.ToString">
  13853. Get the tab array. (0,1,2).
  13854. @return array of tab id's {0,1,2}
  13855. </member>
  13856. <member name="T:NPOI.HSSF.Record.TableRecord">
  13857. DATATABLE (0x0236)<p/>
  13858. TableRecord - The record specifies a data table.
  13859. This record Is preceded by a single Formula record that
  13860. defines the first cell in the data table, which should
  13861. only contain a single Ptg, {@link TblPtg}.
  13862. See p536 of the June 08 binary docs
  13863. </member>
  13864. <member name="T:NPOI.HSSF.Record.TableStylesRecord">
  13865. TABLESTYLES (0x088E)<br/>
  13866. @author Patrick Cheng
  13867. </member>
  13868. <member name="F:NPOI.HSSF.Record.TextObjectRecord._linkRefPtg">
  13869. expect tRef, tRef3D, tArea, tArea3D or tName
  13870. </member>
  13871. <member name="F:NPOI.HSSF.Record.TextObjectRecord._unknownPostFormulaByte">
  13872. Not clear if needed . Excel seems to be OK if this byte is not present.
  13873. Value is often the same as the earlier firstColumn byte.
  13874. </member>
  13875. <member name="P:NPOI.HSSF.Record.TextObjectRecord.TextOrientation">
  13876. Get the text orientation field for the TextObjectBase record.
  13877. @return a TextOrientation
  13878. </member>
  13879. <member name="P:NPOI.HSSF.Record.TextObjectRecord.HorizontalTextAlignment">
  13880. @return the Horizontal text alignment field value.
  13881. </member>
  13882. <member name="P:NPOI.HSSF.Record.TextObjectRecord.VerticalTextAlignment">
  13883. @return the Vertical text alignment field value.
  13884. </member>
  13885. <member name="P:NPOI.HSSF.Record.TextObjectRecord.IsTextLocked">
  13886. Text has been locked
  13887. @return the text locked field value.
  13888. </member>
  13889. <member name="T:NPOI.HSSF.Record.TopMarginRecord">
  13890. Record for the top margin.
  13891. NOTE: This source was automatically generated.
  13892. @author Shawn Laubach (slaubach at apache dot org)
  13893. </member>
  13894. <member name="M:NPOI.HSSF.Record.TopMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13895. Constructs a TopMargin record and Sets its fields appropriately.
  13896. @param in the RecordInputstream to Read the record from
  13897. </member>
  13898. <member name="P:NPOI.HSSF.Record.TopMarginRecord.Margin">
  13899. Get the margin field for the TopMargin record.
  13900. </member>
  13901. <member name="T:NPOI.HSSF.Record.UncalcedRecord">
  13902. Title: Uncalced Record
  13903. If this record occurs in the Worksheet Substream, it indicates that the formulas have not
  13904. been recalculated before the document was saved.
  13905. @author Olivier Leprince
  13906. </member>
  13907. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor">
  13908. Default constructor
  13909. </member>
  13910. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13911. Read constructor
  13912. </member>
  13913. <member name="T:NPOI.HSSF.Record.UnknownRecord">
  13914. Title: Unknown Record (for debugging)
  13915. Description: Unknown record just tells you the sid so you can figure out
  13916. what records you are missing. Also helps us Read/modify sheets we
  13917. don't know all the records to. (HSSF leaves these alone!)
  13918. Company: SuperLink Software, Inc.
  13919. @author Andrew C. Oliver (acoliver at apache dot org)
  13920. @author Jason Height (jheight at chariot dot net dot au)
  13921. @author Glen Stampoultzis (glens at apache.org)
  13922. </member>
  13923. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(System.Int32,System.Byte[])">
  13924. @param id id of the record -not Validated, just stored for serialization
  13925. @param data the data
  13926. </member>
  13927. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13928. construct an Unknown record. No fields are interperated and the record will
  13929. be Serialized in its original form more or less
  13930. @param in the RecordInputstream to Read the record from
  13931. </member>
  13932. <member name="M:NPOI.HSSF.Record.UnknownRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13933. spit the record out AS IS. no interpretation or identification
  13934. </member>
  13935. <member name="M:NPOI.HSSF.Record.UnknownRecord.ToString">
  13936. print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
  13937. </member>
  13938. <member name="M:NPOI.HSSF.Record.UnknownRecord.GetBiffName(System.Int32)">
  13939. These BIFF record types are known but still uninterpreted by POI
  13940. @return the documented name of this BIFF record type, <code>null</code> if unknown to POI
  13941. </member>
  13942. <member name="M:NPOI.HSSF.Record.UnknownRecord.IsObservedButUnknown(System.Int32)">
  13943. @return <c>true</c> if the unknown record id has been observed in POI unit tests
  13944. </member>
  13945. <member name="M:NPOI.HSSF.Record.UnknownRecord.Clone">
  13946. Unlike the other Record.Clone methods this Is a shallow Clone
  13947. </member>
  13948. <member name="T:NPOI.HSSF.Record.UserSViewBegin">
  13949. The UserSViewBegin record specifies Settings for a custom view associated with the sheet.
  13950. This record also marks the start of custom view records, which save custom view Settings.
  13951. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view,
  13952. not Settings for the sheet itself.
  13953. @author Yegor Kozlov
  13954. </member>
  13955. <member name="M:NPOI.HSSF.Record.UserSViewBegin.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13956. construct an UserSViewBegin record. No fields are interpreted and the record will
  13957. be Serialized in its original form more or less
  13958. @param in the RecordInputstream to read the record from
  13959. </member>
  13960. <member name="M:NPOI.HSSF.Record.UserSViewBegin.Serialize(NPOI.Util.ILittleEndianOutput)">
  13961. spit the record out AS IS. no interpretation or identification
  13962. </member>
  13963. <member name="P:NPOI.HSSF.Record.UserSViewBegin.Guid">
  13964. @return Globally unique identifier for the custom view
  13965. </member>
  13966. <member name="T:NPOI.HSSF.Record.UserSViewEnd">
  13967. The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet
  13968. @author Yegor Kozlov
  13969. </member>
  13970. <member name="M:NPOI.HSSF.Record.UserSViewEnd.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13971. construct an UserSViewEnd record. No fields are interpreted and the record will
  13972. be Serialized in its original form more or less
  13973. @param in the RecordInputstream to read the record from
  13974. </member>
  13975. <member name="M:NPOI.HSSF.Record.UserSViewEnd.Serialize(NPOI.Util.ILittleEndianOutput)">
  13976. spit the record out AS IS. no interpretation or identification
  13977. </member>
  13978. <member name="T:NPOI.HSSF.Record.UseSelFSRecord">
  13979. Title: Use Natural Language Formulas Flag
  13980. Description: Tells the GUI if this was written by something that can use
  13981. "natural language" formulas. HSSF can't.
  13982. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13983. @author Andrew C. Oliver (acoliver at apache dot org)
  13984. @version 2.0-pre
  13985. </member>
  13986. <member name="M:NPOI.HSSF.Record.UseSelFSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13987. Constructs a UseSelFS record and Sets its fields appropriately.
  13988. @param in the RecordInputstream to Read the record from
  13989. </member>
  13990. <member name="T:NPOI.HSSF.Record.VCenterRecord">
  13991. Title: VCenter record
  13992. Description: tells whether to center the sheet between vertical margins
  13993. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13994. @author Andrew C. Oliver (acoliver at apache dot org)
  13995. @author Jason Height (jheight at chariot dot net dot au)
  13996. @version 2.0-pre
  13997. </member>
  13998. <member name="M:NPOI.HSSF.Record.VCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13999. Constructs a VCENTER record and Sets its fields appropriately.
  14000. @param in the RecordInputstream to Read the record from
  14001. </member>
  14002. <member name="P:NPOI.HSSF.Record.VCenterRecord.VCenter">
  14003. Get whether to center vertically or not
  14004. @return vcenter or not
  14005. </member>
  14006. <member name="T:NPOI.HSSF.Record.VerticalPageBreakRecord">
  14007. VerticalPageBreak record that stores page breaks at columns
  14008. This class Is just used so that SID Compares work properly in the RecordFactory
  14009. @see PageBreakRecord
  14010. @author Danny Mui (dmui at apache dot org)
  14011. </member>
  14012. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor">
  14013. </member>
  14014. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14015. @param in the RecordInputstream to Read the record from
  14016. </member>
  14017. <member name="T:NPOI.HSSF.Record.WindowOneRecord">
  14018. Title: Window1 Record
  14019. Description: Stores the attributes of the workbook window. This Is basically
  14020. so the gui knows how big to make the window holding the spReadsheet
  14021. document.
  14022. REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14023. @author Andrew C. Oliver (acoliver at apache dot org)
  14024. @version 2.0-pre
  14025. </member>
  14026. <member name="M:NPOI.HSSF.Record.WindowOneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14027. Constructs a WindowOne record and Sets its fields appropriately.
  14028. @param in the RecordInputstream to Read the record from
  14029. </member>
  14030. <member name="P:NPOI.HSSF.Record.WindowOneRecord.HorizontalHold">
  14031. Get the horizontal position of the window (in 1/20ths of a point)
  14032. @return h - horizontal location
  14033. </member>
  14034. <member name="P:NPOI.HSSF.Record.WindowOneRecord.VerticalHold">
  14035. Get the vertical position of the window (in 1/20ths of a point)
  14036. @return v - vertical location
  14037. </member>
  14038. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Width">
  14039. Get the width of the window
  14040. @return width
  14041. </member>
  14042. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Height">
  14043. Get the height of the window
  14044. @return height
  14045. </member>
  14046. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Options">
  14047. Get the options bitmask (see bit Setters)
  14048. @return o - the bitmask
  14049. </member>
  14050. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Hidden">
  14051. Get whether the window Is hidden or not
  14052. @return Ishidden or not
  14053. </member>
  14054. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Iconic">
  14055. Get whether the window has been iconized or not
  14056. @return iconize or not
  14057. </member>
  14058. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayHorizontalScrollbar">
  14059. Get whether to Display the horizontal scrollbar or not
  14060. @return Display or not
  14061. </member>
  14062. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayVerticalScrollbar">
  14063. Get whether to Display the vertical scrollbar or not
  14064. @return Display or not
  14065. </member>
  14066. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayTabs">
  14067. Get whether to Display the tabs or not
  14068. @return Display or not
  14069. </member>
  14070. <member name="P:NPOI.HSSF.Record.WindowOneRecord.ActiveSheetIndex">
  14071. @return the index of the currently Displayed sheet
  14072. </member>
  14073. <member name="P:NPOI.HSSF.Record.WindowOneRecord.FirstVisibleTab">
  14074. @return the first visible sheet in the worksheet tab-bar.
  14075. I.E. the scroll position of the tab-bar.
  14076. </member>
  14077. <member name="P:NPOI.HSSF.Record.WindowOneRecord.NumSelectedTabs">
  14078. Get the number of selected tabs
  14079. @return number of tabs
  14080. </member>
  14081. <member name="P:NPOI.HSSF.Record.WindowOneRecord.TabWidthRatio">
  14082. ratio of the width of the tabs to the horizontal scrollbar
  14083. @return ratio
  14084. </member>
  14085. <member name="T:NPOI.HSSF.Record.WindowProtectRecord">
  14086. Title: Window Protect Record
  14087. Description: flags whether workbook windows are protected
  14088. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14089. @author Andrew C. Oliver (acoliver at apache dot org)
  14090. @version 2.0-pre
  14091. </member>
  14092. <member name="M:NPOI.HSSF.Record.WindowProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14093. Constructs a WindowProtect record and Sets its fields appropriately.
  14094. @param in the RecordInputstream to Read the record from
  14095. </member>
  14096. <member name="P:NPOI.HSSF.Record.WindowProtectRecord.Protect">
  14097. Is this window protected or not
  14098. @return protected or not
  14099. </member>
  14100. <member name="T:NPOI.HSSF.Record.WindowTwoRecord">
  14101. Title: Window Two Record
  14102. Description: sheet window Settings
  14103. REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14104. @author Andrew C. Oliver (acoliver at apache dot org)
  14105. @author Jason Height (jheight at chariot dot net dot au)
  14106. @version 2.0-pre
  14107. </member>
  14108. <member name="M:NPOI.HSSF.Record.WindowTwoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14109. Constructs a WindowTwo record and Sets its fields appropriately.
  14110. @param in the RecordInputstream to Read the record from
  14111. </member>
  14112. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Options">
  14113. Get the options bitmask or just use the bit Setters.
  14114. @return options
  14115. </member>
  14116. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayFormulas">
  14117. Get whether the window should Display formulas
  14118. @return formulas or not
  14119. </member>
  14120. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGridlines">
  14121. Get whether the window should Display gridlines
  14122. @return gridlines or not
  14123. </member>
  14124. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayRowColHeadings">
  14125. Get whether the window should Display row and column headings
  14126. @return headings or not
  14127. </member>
  14128. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanes">
  14129. Get whether the window should freeze panes
  14130. @return freeze panes or not
  14131. </member>
  14132. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayZeros">
  14133. Get whether the window should Display zero values
  14134. @return zeros or not
  14135. </member>
  14136. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DefaultHeader">
  14137. Get whether the window should Display a default header
  14138. @return header or not
  14139. </member>
  14140. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Arabic">
  14141. Is this arabic?
  14142. @return arabic or not
  14143. </member>
  14144. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGuts">
  14145. Get whether the outline symbols are displaed
  14146. @return symbols or not
  14147. </member>
  14148. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanesNoSplit">
  14149. freeze Unsplit panes or not
  14150. @return freeze or not
  14151. </member>
  14152. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsSelected">
  14153. sheet tab Is selected
  14154. @return selected or not
  14155. </member>
  14156. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsActive">
  14157. Is the sheet currently Displayed in the window
  14158. @return Displayed or not
  14159. </member>
  14160. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.SavedInPageBreakPreview">
  14161. was the sheet saved in page break view
  14162. @return pagebreaksaved or not
  14163. </member>
  14164. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.TopRow">
  14165. Get the top row visible in the window
  14166. @return toprow
  14167. </member>
  14168. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.LeftCol">
  14169. Get the leftmost column Displayed in the window
  14170. @return leftmost
  14171. </member>
  14172. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.HeaderColor">
  14173. Get the palette index for the header color
  14174. @return color
  14175. </member>
  14176. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.PageBreakZoom">
  14177. zoom magification in page break view
  14178. @return zoom
  14179. </member>
  14180. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.NormalZoom">
  14181. Get the zoom magnification in normal view
  14182. @return zoom
  14183. </member>
  14184. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Reserved">
  14185. Get the reserved bits - why would you do this?
  14186. @return reserved stuff -probably garbage
  14187. </member>
  14188. <member name="T:NPOI.HSSF.Record.WriteAccessRecord">
  14189. Title: Write Access Record
  14190. Description: Stores the username of that who owns the spReadsheet generator
  14191. (on Unix the user's login, on Windoze its the name you typed when
  14192. you installed the thing)
  14193. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14194. @author Andrew C. Oliver (acoliver at apache dot org)
  14195. @version 2.0-pre
  14196. </member>
  14197. <member name="F:NPOI.HSSF.Record.WriteAccessRecord.PADDING">
  14198. this record is always padded to a constant length
  14199. </member>
  14200. <member name="M:NPOI.HSSF.Record.WriteAccessRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14201. Constructs a WriteAccess record and Sets its fields appropriately.
  14202. @param in the RecordInputstream to Read the record from
  14203. </member>
  14204. <member name="P:NPOI.HSSF.Record.WriteAccessRecord.Username">
  14205. Get the username for the user that Created the report. HSSF uses the logged in user. On
  14206. natively Created M$ Excel sheet this would be the name you typed in when you installed it
  14207. in most cases.
  14208. @return username of the user who Is logged in (probably "tomcat" or "apache")
  14209. </member>
  14210. <member name="T:NPOI.HSSF.Record.WriteProtectRecord">
  14211. Title: Write Protect Record
  14212. Description: Indicated that the sheet/workbook Is Write protected.
  14213. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14214. @version 3.0-pre
  14215. </member>
  14216. <member name="M:NPOI.HSSF.Record.WriteProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14217. Constructs a WriteAccess record and Sets its fields appropriately.
  14218. @param in the RecordInputstream to Read the record from
  14219. </member>
  14220. <member name="T:NPOI.HSSF.Record.WSBoolRecord">
  14221. Title: WSBool Record.
  14222. Description: stores workbook Settings (aka its a big "everything we didn't
  14223. put somewhere else")
  14224. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14225. @author Andrew C. Oliver (acoliver at apache dot org)
  14226. @author Glen Stampoultzis (gstamp@iprimus.com.au)
  14227. @author Jason Height (jheight at chariot dot net dot au)
  14228. @version 2.0-pre
  14229. </member>
  14230. <member name="M:NPOI.HSSF.Record.WSBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14231. Constructs a WSBool record and Sets its fields appropriately.
  14232. @param in the RecordInputstream to Read the record from
  14233. </member>
  14234. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool1">
  14235. Get first byte (see bit Getters)
  14236. </member>
  14237. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Autobreaks">
  14238. <summary>
  14239. Whether to show automatic page breaks or not
  14240. </summary>
  14241. </member>
  14242. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Dialog">
  14243. <summary>
  14244. Whether sheet is a dialog sheet or not
  14245. </summary>
  14246. </member>
  14247. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsBelow">
  14248. <summary>
  14249. Get if row summaries appear below detail in the outline
  14250. </summary>
  14251. </member>
  14252. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsRight">
  14253. <summary>
  14254. Get if col summaries appear right of the detail in the outline
  14255. </summary>
  14256. </member>
  14257. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool2">
  14258. <summary>
  14259. Get the second byte (see bit Getters)
  14260. </summary>
  14261. </member>
  14262. <member name="P:NPOI.HSSF.Record.WSBoolRecord.FitToPage">
  14263. <summary>
  14264. fit to page option is on
  14265. </summary>
  14266. </member>
  14267. <member name="P:NPOI.HSSF.Record.WSBoolRecord.DisplayGuts">
  14268. <summary>
  14269. Whether to display the guts or not
  14270. </summary>
  14271. </member>
  14272. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateExpression">
  14273. <summary>
  14274. whether alternate expression evaluation is on
  14275. </summary>
  14276. </member>
  14277. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateFormula">
  14278. <summary>
  14279. whether alternative formula entry is on
  14280. </summary>
  14281. </member>
  14282. <member name="T:NPOI.HSSF.UserModel.helpers.HSSFRowShifter">
  14283. Helper for Shifting rows up or down
  14284. When possible, code should be implemented in the RowShifter abstract class to avoid duplication with {@link NPOI.XSSF.UserModel.helpers.XSSFRowShifter}
  14285. </member>
  14286. <member name="T:NPOI.HSSF.UserModel.HSSFColorScaleFormatting">
  14287. High level representation for Color Scale / Color Gradient
  14288. Formatting component of Conditional Formatting Settings
  14289. </member>
  14290. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingThreshold">
  14291. High level representation for Icon / Multi-State / Databar /
  14292. Colour Scale change thresholds
  14293. </member>
  14294. <member name="T:NPOI.HSSF.UserModel.HSSFDataBarFormatting">
  14295. High level representation for DataBar / Data-Bar Formatting
  14296. component of Conditional Formatting Settings
  14297. </member>
  14298. <member name="T:NPOI.HSSF.UserModel.HSSFExtendedColor">
  14299. The HSSF file format normally stores Color information in the
  14300. Palette (see PaletteRecord), but for a few cases (eg Conditional
  14301. Formatting, Sheet Extensions), this XSSF-style color record
  14302. can be used.
  14303. </member>
  14304. <member name="T:NPOI.HSSF.UserModel.HSSFIconMultiStateFormatting">
  14305. High level representation for Icon / Multi-State Formatting
  14306. component of Conditional Formatting Settings
  14307. </member>
  14308. <member name="T:NPOI.HSSF.UserModel.HSSFShapeFactory">
  14309. @author Evgeniy Berlog
  14310. date: 05.06.12
  14311. </member>
  14312. <member name="M:NPOI.HSSF.UserModel.HSSFShapeFactory.CreateShapeTree(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.EscherAggregate,NPOI.HSSF.UserModel.HSSFShapeContainer,NPOI.POIFS.FileSystem.DirectoryNode)">
  14313. build shape tree from escher container
  14314. @param container root escher container from which escher records must be taken
  14315. @param agg - EscherAggregate
  14316. @param out - shape container to which shapes must be added
  14317. @param root - node to create HSSFObjectData shapes
  14318. </member>
  14319. <member name="T:NPOI.HSSF.UserModel.DVConstraint">
  14320. @author Josh Micich
  14321. </member>
  14322. <member name="M:NPOI.HSSF.UserModel.DVConstraint.#ctor(System.String,System.String[])">
  14323. Creates a list constraint
  14324. </member>
  14325. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateNumericConstraint(System.Int32,System.Int32,System.String,System.String)">
  14326. Creates a number based data validation constraint. The text values entered for expr1 and expr2
  14327. can be either standard Excel formulas or formatted number values. If the expression starts
  14328. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted number.
  14329. @param validationType one of {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#ANY},
  14330. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#DECIMAL},
  14331. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#INTEGER},
  14332. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#TEXT_LENGTH}
  14333. @param comparisonOperator any constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  14334. @param expr1 date formula (when first char is '=') or formatted number value
  14335. @param expr2 date formula (when first char is '=') or formatted number value
  14336. </member>
  14337. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateTimeConstraint(System.Int32,System.String,System.String)">
  14338. Creates a time based data validation constraint. The text values entered for expr1 and expr2
  14339. can be either standard Excel formulas or formatted time values. If the expression starts
  14340. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted time. To parse
  14341. formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to
  14342. Excel which uses the default time format from the OS.
  14343. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  14344. @param expr1 date formula (when first char is '=') or formatted time value
  14345. @param expr2 date formula (when first char is '=') or formatted time value
  14346. </member>
  14347. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateDateConstraint(System.Int32,System.String,System.String,System.String)">
  14348. Creates a date based data validation constraint. The text values entered for expr1 and expr2
  14349. can be either standard Excel formulas or formatted date values. If the expression starts
  14350. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted date (Excel uses
  14351. the same convention). To parse formatted dates, a date format needs to be specified. This
  14352. is contrary to Excel which uses the default short date format from the OS.
  14353. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  14354. @param expr1 date formula (when first char is '=') or formatted date value
  14355. @param expr2 date formula (when first char is '=') or formatted date value
  14356. @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD"
  14357. otherwise any other valid argument for <c>SimpleDateFormat</c> can be used
  14358. @see <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/text/DateFormat.html'>SimpleDateFormat</a>
  14359. </member>
  14360. <member name="M:NPOI.HSSF.UserModel.DVConstraint.GetFormulaFromTextExpression(System.String)">
  14361. Distinguishes formula expressions from simple value expressions. This logic is only
  14362. required by a few factory methods in this class that create data validation constraints
  14363. from more or less the same parameters that would have been entered in the Excel UI. The
  14364. data validation dialog box uses the convention that formulas begin with '='. Other methods
  14365. in this class follow the POI convention (formulas and values are distinct), so the '='
  14366. convention is not used there.
  14367. @param textExpr a formula or value expression
  14368. @return all text After '=' if textExpr begins with '='. Otherwise <code>null</code> if textExpr does not begin with '='
  14369. </member>
  14370. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertNumber(System.String)">
  14371. @return <code>null</code> if numberStr is <code>null</code>
  14372. </member>
  14373. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertTime(System.String)">
  14374. @return <code>null</code> if timeStr is <code>null</code>
  14375. </member>
  14376. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDate(System.String,NPOI.SS.Util.SimpleDateFormat)">
  14377. @param dateFormat pass <code>null</code> for default YYYYMMDD
  14378. @return <code>null</code> if timeStr is <code>null</code>
  14379. </member>
  14380. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsListValidationType">
  14381. Convenience method
  14382. @return <c>true</c> if this constraint is a 'list' validation
  14383. </member>
  14384. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsExplicitList">
  14385. Convenience method
  14386. @return <c>true</c> if this constraint is a 'list' validation with explicit values
  14387. </member>
  14388. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value1">
  14389. @return the numeric value for expression 1. May be <c>null</c>
  14390. </member>
  14391. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value2">
  14392. @return the numeric value for expression 2. May be <c>null</c>
  14393. </member>
  14394. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateFormulas(NPOI.HSSF.UserModel.HSSFSheet)">
  14395. @return both Parsed formulas (for expression 1 and 2).
  14396. </member>
  14397. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDoubleFormula(System.String,System.Double,NPOI.HSSF.UserModel.HSSFSheet)">
  14398. @return The Parsed token array representing the formula or value specified.
  14399. Empty array if both formula and value are <code>null</code>
  14400. </member>
  14401. <member name="T:NPOI.HSSF.UserModel.HSSFDataFormatter">
  14402. HSSFDataFormatter contains methods for formatting the value stored in an
  14403. HSSFCell. This can be useful for reports and GUI presentations when you
  14404. need to display data exactly as it appears in Excel. Supported formats
  14405. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  14406. codes, etc.
  14407. Internally, formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  14408. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  14409. formats used by this class must obey the same pattern rules as these Format
  14410. subclasses. This means that only legal number pattern characters ("0", "#",
  14411. ".", "," etc.) may appear in number formats. Other characters can be
  14412. inserted <em>before</em> or <em>after</em> the number pattern to form a
  14413. prefix or suffix.
  14414. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  14415. </c> will be correctly formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  14416. However the pattern <c>"00-00-00"</c> is incorrectly formatted by
  14417. DecimalFormat as "000000--". For Excel formats that are not compatible with
  14418. DecimalFormat, you can provide your own custom {@link Format} implementation
  14419. via <c>HSSFDataFormatter.AddFormat(String,Format)</c>. The following
  14420. custom formats are already provided by this class:
  14421. <pre>
  14422. <ul><li>SSN "000-00-0000"</li>
  14423. <li>Phone Number "(###) ###-####"</li>
  14424. <li>Zip plus 4 "00000-0000"</li>
  14425. </ul>
  14426. </pre>
  14427. If the Excel format pattern cannot be parsed successfully, then a default
  14428. format will be used. The default number format will mimic the Excel General
  14429. format: "#" for whole numbers and "#.##########" for decimal numbers. You
  14430. can override the default format pattern with <c>
  14431. HSSFDataFormatter.DefaultNumberFormat=(Format)</c>. <b>Note:</b> the
  14432. default format will only be used when a Format cannot be created from the
  14433. cell's data format string.
  14434. @author James May (james dot may at fmr dot com)
  14435. </member>
  14436. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor(System.Globalization.CultureInfo)">
  14437. Creates a formatter using the given locale.
  14438. </member>
  14439. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor">
  14440. Creates a formatter using the {@link Locale#getDefault() default locale}.
  14441. </member>
  14442. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidation">
  14443. Utility class for creating data validation cells
  14444. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  14445. </member>
  14446. <member name="M:NPOI.HSSF.UserModel.HSSFDataValidation.#ctor(NPOI.SS.Util.CellRangeAddressList,NPOI.SS.UserModel.IDataValidationConstraint)">
  14447. Constructor which Initializes the cell range on which this object will be
  14448. applied
  14449. @param constraint
  14450. </member>
  14451. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidationHelper">
  14452. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  14453. </member>
  14454. <member name="T:NPOI.HSSF.UserModel.HSSFDateUtil">
  14455. Contains methods for dealing with Excel dates.
  14456. @author Michael Harhen
  14457. @author Glen Stampoultzis (glens at apache.org)
  14458. @author Dan Sherman (dsherman at isisph.com)
  14459. @author Hack Kampbjorn (hak at 2mba.dk)
  14460. @author Alex Jacoby (ajacoby at gmail.com)
  14461. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  14462. </member>
  14463. <member name="T:NPOI.HSSF.UserModel.HSSFChart">
  14464. Has methods for construction of a chart object.
  14465. @author Glen Stampoultzis (glens at apache.org)
  14466. </member>
  14467. <member name="M:NPOI.HSSF.UserModel.HSSFChart.CreateBarChart(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet)">
  14468. Creates a bar chart. API needs some work. :)
  14469. NOTE: Does not yet work... checking it in just so others
  14470. can take a look.
  14471. </member>
  14472. <member name="M:NPOI.HSSF.UserModel.HSSFChart.GetSheetCharts(NPOI.HSSF.UserModel.HSSFSheet)">
  14473. Returns all the charts for the given sheet.
  14474. NOTE: You won't be able to do very much with
  14475. these charts yet, as this is very limited support
  14476. </member>
  14477. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartX">
  14478. Get the X offset of the chart
  14479. </member>
  14480. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartY">
  14481. Get the Y offset of the chart
  14482. </member>
  14483. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartWidth">
  14484. Get the width of the chart. {@link ChartRecord}
  14485. </member>
  14486. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartHeight">
  14487. Get the height of the chart. {@link ChartRecord}
  14488. </member>
  14489. <member name="P:NPOI.HSSF.UserModel.HSSFChart.Series">
  14490. Returns the series of the chart
  14491. </member>
  14492. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartTitle">
  14493. Returns the chart's title, if there is one,
  14494. or null if not
  14495. </member>
  14496. <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})">
  14497. Set value range (basic Axis Options)
  14498. @param axisIndex 0 - primary axis, 1 - secondary axis
  14499. @param minimum minimum value; Double.NaN - automatic; null - no change
  14500. @param maximum maximum value; Double.NaN - automatic; null - no change
  14501. @param majorUnit major unit value; Double.NaN - automatic; null - no change
  14502. @param minorUnit minor unit value; Double.NaN - automatic; null - no change
  14503. </member>
  14504. <member name="T:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries">
  14505. A series in a chart
  14506. </member>
  14507. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.ValueType">
  14508. See {@link SeriesRecord}
  14509. </member>
  14510. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.SeriesTitle">
  14511. Returns the series' title, if there is one,
  14512. or null if not
  14513. </member>
  14514. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataName">
  14515. @return record with data names
  14516. </member>
  14517. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataValues">
  14518. @return record with data values
  14519. </member>
  14520. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataCategoryLabels">
  14521. @return record with data category labels
  14522. </member>
  14523. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataSecondaryCategoryLabels">
  14524. @return record with data secondary category labels
  14525. </member>
  14526. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetSeries">
  14527. @return record with series
  14528. </member>
  14529. <member name="T:NPOI.HSSF.UserModel.EscherGraphics">
  14530. Translates Graphics calls into escher calls. The translation Is lossy so
  14531. many features are not supported and some just aren't implemented yet. If
  14532. in doubt test the specific calls you wish to make. Graphics calls are
  14533. always performed into an EscherGroup so one will need to be Created.
  14534. <b>Important:</b>
  14535. <blockquote>
  14536. One important concept worth considering Is that of font size. One of the
  14537. difficulties in Converting Graphics calls into escher Drawing calls Is that
  14538. Excel does not have the concept of absolute pixel positions. It measures
  14539. it's cell widths in 'Chars' and the cell heights in points.
  14540. Unfortunately it's not defined exactly what a type of Char it's
  14541. measuring. Presumably this Is due to the fact that the Excel will be
  14542. using different fonts on different platforms or even within the same
  14543. platform.
  14544. Because of this constraint we've had to calculate the
  14545. verticalPointsPerPixel. This the amount the font should be scaled by when
  14546. you Issue commands such as DrawString(). A good way to calculate this
  14547. Is to use the follow formula:
  14548. <pre>
  14549. multipler = GroupHeightInPoints / heightOfGroup
  14550. </pre>
  14551. The height of the Group Is calculated fairly simply by calculating the
  14552. difference between the y coordinates of the bounding box of the shape. The
  14553. height of the Group can be calculated by using a convenience called
  14554. <c>HSSFClientAnchor.GetAnchorHeightInPoints()</c>.
  14555. </blockquote>
  14556. @author Glen Stampoultzis (glens at apache.org)
  14557. </member>
  14558. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Single)">
  14559. Construct an escher graphics object.
  14560. @param escherGroup The escher Group to Write the graphics calls into.
  14561. @param workbook The workbook we are using.
  14562. @param forecolor The foreground color to use as default.
  14563. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  14564. </member>
  14565. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Drawing.Font,System.Single)">
  14566. Constructs an escher graphics object.
  14567. @param escherGroup The escher Group to Write the graphics calls into.
  14568. @param workbook The workbook we are using.
  14569. @param foreground The foreground color to use as default.
  14570. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  14571. @param font The font to use.
  14572. </member>
  14573. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.FillPolygon(System.Int32[],System.Int32[],System.Int32)">
  14574. Fills a (closed) polygon, as defined by a pair of arrays, which
  14575. hold the <i>x</i> and <i>y</i> coordinates.
  14576. This Draws the polygon, with <c>nPoint</c> line segments.
  14577. The first <c>nPoint - 1</c> line segments are
  14578. Drawn between sequential points
  14579. (<c>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</c>).
  14580. The line segment Is a closing one, from the last point to
  14581. the first (assuming they are different).
  14582. The area inside of the polygon Is defined by using an
  14583. even-odd Fill rule (also known as the alternating rule), and
  14584. the area inside of it Is Filled.
  14585. @param xPoints array of the <c>x</c> coordinates.
  14586. @param yPoints array of the <c>y</c> coordinates.
  14587. @param nPoints the total number of points in the polygon.
  14588. @see java.awt.Graphics#DrawPolygon(int[], int[], int)
  14589. </member>
  14590. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector">
  14591. Instances of this class keep track of multiple dependent cell evaluations due
  14592. to recursive calls to <c>HSSFFormulaEvaluator.internalEvaluate()</c>.
  14593. The main purpose of this class Is to detect an attempt to evaluate a cell
  14594. that Is alReady being evaluated. In other words, it detects circular
  14595. references in spReadsheet formulas.
  14596. @author Josh Micich
  14597. </member>
  14598. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame">
  14599. Stores the parameters that identify the evaluation of one cell.<br/>
  14600. </member>
  14601. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame.FormatAsString">
  14602. @return human Readable string for debug purposes
  14603. </member>
  14604. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.StartEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  14605. Notifies this evaluation tracker that evaluation of the specified cell Is
  14606. about to start.<br/>
  14607. In the case of a <c>true</c> return code, the caller should
  14608. continue evaluation of the specified cell, and also be sure to call
  14609. <c>endEvaluate()</c> when complete.<br/>
  14610. In the case of a <c>false</c> return code, the caller should
  14611. return an evaluation result of
  14612. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  14613. <br/>
  14614. @return <c>true</c> if the specified cell has not been visited yet in the current
  14615. evaluation. <c>false</c> if the specified cell Is alReady being evaluated.
  14616. </member>
  14617. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.EndEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  14618. Notifies this evaluation tracker that the evaluation of the specified
  14619. cell Is complete. <p/>
  14620. Every successful call to <c>startEvaluate</c> must be followed by a
  14621. call to <c>endEvaluate</c> (recommended in a finally block) to enable
  14622. proper tracking of which cells are being evaluated at any point in time.<p/>
  14623. Assuming a well behaved client, parameters to this method would not be
  14624. required. However, they have been included to assert correct behaviour,
  14625. and form more meaningful error messages.
  14626. </member>
  14627. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager">
  14628. This class makes an <c>EvaluationCycleDetector</c> instance available to
  14629. each thRead via a <c>ThReadLocal</c> in order to avoid Adding a parameter
  14630. to a few protected methods within <c>HSSFFormulaEvaluator</c>.
  14631. @author Josh Micich
  14632. </member>
  14633. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager.GetTracker">
  14634. @return
  14635. </member>
  14636. <member name="T:NPOI.HSSF.UserModel.FontDetails">
  14637. <summary>
  14638. Stores width and height details about a font.
  14639. @author Glen Stampoultzis (glens at apache.org)
  14640. </summary>
  14641. </member>
  14642. <member name="M:NPOI.HSSF.UserModel.FontDetails.#ctor(System.String,System.Int32)">
  14643. <summary>
  14644. Construct the font details with the given name and height.
  14645. </summary>
  14646. <param name="fontName">The font name.</param>
  14647. <param name="height">The height of the font.</param>
  14648. </member>
  14649. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetFontName">
  14650. <summary>
  14651. Gets the name of the font.
  14652. </summary>
  14653. <returns></returns>
  14654. </member>
  14655. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetHeight">
  14656. <summary>
  14657. Gets the height.
  14658. </summary>
  14659. <returns></returns>
  14660. </member>
  14661. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChar(System.Char,System.Int32)">
  14662. <summary>
  14663. Adds the char.
  14664. </summary>
  14665. <param name="c">The c.</param>
  14666. <param name="width">The width.</param>
  14667. </member>
  14668. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetCharWidth(System.Char)">
  14669. <summary>
  14670. Retrieves the width of the specified Char. If the metrics for
  14671. a particular Char are not available it defaults to returning the
  14672. width for the 'W' Char.
  14673. </summary>
  14674. <param name="c">The character.</param>
  14675. <returns></returns>
  14676. </member>
  14677. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChars(System.Char[],System.Int32[])">
  14678. <summary>
  14679. Adds the chars.
  14680. </summary>
  14681. <param name="Chars">The chars.</param>
  14682. <param name="widths">The widths.</param>
  14683. </member>
  14684. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontHeightProperty(System.String)">
  14685. <summary>
  14686. Builds the font height property.
  14687. </summary>
  14688. <param name="fontName">Name of the font.</param>
  14689. <returns></returns>
  14690. </member>
  14691. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontWidthsProperty(System.String)">
  14692. <summary>
  14693. Builds the font widths property.
  14694. </summary>
  14695. <param name="fontName">Name of the font.</param>
  14696. <returns></returns>
  14697. </member>
  14698. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontCharsProperty(System.String)">
  14699. <summary>
  14700. Builds the font chars property.
  14701. </summary>
  14702. <param name="fontName">Name of the font.</param>
  14703. <returns></returns>
  14704. </member>
  14705. <member name="M:NPOI.HSSF.UserModel.FontDetails.Create(System.String,NPOI.Util.Collections.Properties)">
  14706. <summary>
  14707. Create an instance of
  14708. <c>FontDetails</c>
  14709. by loading them from the
  14710. provided property object.
  14711. </summary>
  14712. <param name="fontName">the font name.</param>
  14713. <param name="fontMetricsProps">the property object holding the details of this
  14714. particular font.</param>
  14715. <returns>a new FontDetails instance.</returns>
  14716. </member>
  14717. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetStringWidth(System.String)">
  14718. <summary>
  14719. Gets the width of all Chars in a string.
  14720. </summary>
  14721. <param name="str">The string to measure.</param>
  14722. <returns>The width of the string for a 10 point font.</returns>
  14723. </member>
  14724. <member name="M:NPOI.HSSF.UserModel.FontDetails.Split(System.String,System.String,System.Int32)">
  14725. <summary>
  14726. Split the given string into an array of strings using the given
  14727. delimiter.
  14728. </summary>
  14729. <param name="text">The text.</param>
  14730. <param name="separator">The separator.</param>
  14731. <param name="max">The max.</param>
  14732. <returns></returns>
  14733. </member>
  14734. <member name="T:NPOI.HSSF.UserModel.HeaderFooter">
  14735. <summary>
  14736. Common class for HSSFHeader and HSSFFooter
  14737. </summary>
  14738. </member>
  14739. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.RawText">
  14740. @return the internal text representation (combining center, left and right parts).
  14741. Possibly empty string if no header or footer is set. Never <c>null</c>.
  14742. </member>
  14743. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.UpdateHeaderFooterText(System.String[])">
  14744. <summary>
  14745. Creates the complete footer string based on the left, center, and middle
  14746. strings.
  14747. </summary>
  14748. <param name="parts">The parts.</param>
  14749. </member>
  14750. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.SetHeaderFooterText(System.String)">
  14751. <summary>
  14752. Sets the header footer text.
  14753. </summary>
  14754. <param name="text">the new header footer text (contains mark-up tags). Possibly
  14755. empty string never </param>
  14756. </member>
  14757. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Left">
  14758. <summary>
  14759. Get the left side of the header or footer.
  14760. </summary>
  14761. <value>The string representing the left side.</value>
  14762. </member>
  14763. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Center">
  14764. <summary>
  14765. Get the center of the header or footer.
  14766. </summary>
  14767. <value>The string representing the center.</value>
  14768. </member>
  14769. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Right">
  14770. <summary>
  14771. Get the right side of the header or footer.
  14772. </summary>
  14773. <value>The string representing the right side..</value>
  14774. </member>
  14775. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.FontSize(System.Int16)">
  14776. <summary>
  14777. Returns the string that represents the change in font size.
  14778. </summary>
  14779. <param name="size">the new font size.</param>
  14780. <returns>The special string to represent a new font size</returns>
  14781. </member>
  14782. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Font(System.String,System.String)">
  14783. <summary>
  14784. Returns the string that represents the change in font.
  14785. </summary>
  14786. <param name="font">the new font.</param>
  14787. <param name="style">the fonts style, one of regular, italic, bold, italic bold or bold italic.</param>
  14788. <returns>The special string to represent a new font size</returns>
  14789. </member>
  14790. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Page">
  14791. <summary>
  14792. Returns the string representing the current page number
  14793. </summary>
  14794. <value>The special string for page number.</value>
  14795. </member>
  14796. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.NumPages">
  14797. <summary>
  14798. Returns the string representing the number of pages.
  14799. </summary>
  14800. <value>The special string for the number of pages.</value>
  14801. </member>
  14802. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Date">
  14803. <summary>
  14804. Returns the string representing the current date
  14805. </summary>
  14806. <value>The special string for the date</value>
  14807. </member>
  14808. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Time">
  14809. <summary>
  14810. Gets the time.
  14811. </summary>
  14812. <value>The time.</value>
  14813. Returns the string representing the current time
  14814. @return The special string for the time
  14815. </member>
  14816. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.File">
  14817. <summary>
  14818. Returns the string representing the current file name
  14819. </summary>
  14820. <value>The special string for the file name.</value>
  14821. </member>
  14822. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Tab">
  14823. <summary>
  14824. Returns the string representing the current tab (sheet) name
  14825. </summary>
  14826. <value>The special string for tab name.</value>
  14827. </member>
  14828. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartBold">
  14829. <summary>
  14830. Returns the string representing the start bold
  14831. </summary>
  14832. <returns>The special string for start bold</returns>
  14833. </member>
  14834. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndBold">
  14835. <summary>
  14836. Returns the string representing the end bold
  14837. </summary>
  14838. <value>The special string for end bold.</value>
  14839. </member>
  14840. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartUnderline">
  14841. <summary>
  14842. Returns the string representing the start underline
  14843. </summary>
  14844. <value>The special string for start underline.</value>
  14845. </member>
  14846. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndUnderline">
  14847. <summary>
  14848. Returns the string representing the end underline
  14849. </summary>
  14850. <value>The special string for end underline.</value>
  14851. </member>
  14852. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartDoubleUnderline">
  14853. <summary>
  14854. Returns the string representing the start double underline
  14855. </summary>
  14856. <value>The special string for start double underline.</value>
  14857. </member>
  14858. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndDoubleUnderline">
  14859. <summary>
  14860. Returns the string representing the end double underline
  14861. </summary>
  14862. <value>The special string for end double underline.</value>
  14863. </member>
  14864. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.StripFields(System.String)">
  14865. <summary>
  14866. Removes any fields (eg macros, page markers etc)
  14867. from the string.
  14868. Normally used to make some text suitable for showing
  14869. to humans, and the resultant text should not normally
  14870. be saved back into the document!
  14871. </summary>
  14872. <param name="text">The text.</param>
  14873. <returns></returns>
  14874. </member>
  14875. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.AreFieldsStripped">
  14876. <summary>
  14877. Are fields currently being Stripped from
  14878. the text that this {@link HeaderStories} returns?
  14879. Default is false, but can be changed
  14880. </summary>
  14881. <value><c>true</c> if [are fields stripped]; otherwise, <c>false</c>.</value>
  14882. </member>
  14883. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.Field">
  14884. <summary>
  14885. Represents a special field in a header or footer,
  14886. eg the page number
  14887. </summary>
  14888. </member>
  14889. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Field.sequence">
  14890. The character sequence that marks this field
  14891. </member>
  14892. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.PairField">
  14893. <summary>
  14894. A special field that normally comes in a pair, eg
  14895. turn on underline / turn off underline
  14896. </summary>
  14897. </member>
  14898. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Fields.instance">
  14899. <summary>
  14900. Instance to this class.
  14901. </summary>
  14902. </member>
  14903. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#cctor">
  14904. <summary>
  14905. Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
  14906. </summary>
  14907. </member>
  14908. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#ctor">
  14909. <summary>
  14910. Initialize AllFields.
  14911. </summary>
  14912. </member>
  14913. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Fields.Instance">
  14914. <summary>
  14915. Accessing the initialized instance.
  14916. </summary>
  14917. </member>
  14918. <member name="T:NPOI.HSSF.UserModel.HSSFAnchor">
  14919. <summary>
  14920. An anchor Is what specifics the position of a shape within a client object
  14921. or within another containing shape.
  14922. @author Glen Stampoultzis (glens at apache.org)
  14923. </summary>
  14924. </member>
  14925. <member name="M:NPOI.HSSF.UserModel.HSSFAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  14926. <summary>
  14927. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFAnchor"/> class.
  14928. </summary>
  14929. <param name="dx1">The DX1.</param>
  14930. <param name="dy1">The dy1.</param>
  14931. <param name="dx2">The DX2.</param>
  14932. <param name="dy2">The dy2.</param>
  14933. </member>
  14934. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx1">
  14935. <summary>
  14936. Gets or sets the DX1.
  14937. </summary>
  14938. <value>The DX1.</value>
  14939. </member>
  14940. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy1">
  14941. <summary>
  14942. Gets or sets the dy1.
  14943. </summary>
  14944. <value>The dy1.</value>
  14945. </member>
  14946. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy2">
  14947. <summary>
  14948. Gets or sets the dy2.
  14949. </summary>
  14950. <value>The dy2.</value>
  14951. </member>
  14952. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx2">
  14953. <summary>
  14954. Gets or sets the DX2.
  14955. </summary>
  14956. <value>The DX2.</value>
  14957. </member>
  14958. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsHorizontallyFlipped">
  14959. <summary>
  14960. Gets a value indicating whether this instance is horizontally flipped.
  14961. </summary>
  14962. <value>
  14963. <c>true</c> if this instance is horizontally flipped; otherwise, <c>false</c>.
  14964. </value>
  14965. </member>
  14966. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsVerticallyFlipped">
  14967. <summary>
  14968. Gets a value indicating whether this instance is vertically flipped.
  14969. </summary>
  14970. <value>
  14971. <c>true</c> if this instance is vertically flipped; otherwise, <c>false</c>.
  14972. </value>
  14973. </member>
  14974. <member name="T:NPOI.HSSF.UserModel.HSSFBorderFormatting">
  14975. High level representation for Border Formatting component
  14976. of Conditional Formatting Settings
  14977. @author Dmitriy Kumshayev
  14978. </member>
  14979. <member name="T:NPOI.HSSF.UserModel.HSSFCell">
  14980. <summary>
  14981. High level representation of a cell in a row of a spReadsheet.
  14982. Cells can be numeric, formula-based or string-based (text). The cell type
  14983. specifies this. String cells cannot conatin numbers and numeric cells cannot
  14984. contain strings (at least according to our model). Client apps should do the
  14985. conversions themselves. Formula cells have the formula string, as well as
  14986. the formula result, which can be numeric or string.
  14987. Cells should have their number (0 based) before being Added to a row. Only
  14988. cells that have values should be Added.
  14989. </summary>
  14990. <remarks>
  14991. @author Andrew C. Oliver (acoliver at apache dot org)
  14992. @author Dan Sherman (dsherman at Isisph.com)
  14993. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  14994. @author Yegor Kozlov cell comments support
  14995. </remarks>
  14996. </member>
  14997. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16)">
  14998. <summary>
  14999. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  15000. from scratch.
  15001. When the cell is initially Created it is Set to CellType.Blank. Cell types
  15002. can be Changed/overwritten by calling SetCellValue with the appropriate
  15003. type as a parameter although conversions from one type to another may be
  15004. prohibited.
  15005. </summary>
  15006. <param name="book">Workbook record of the workbook containing this cell</param>
  15007. <param name="sheet">Sheet record of the sheet containing this cell</param>
  15008. <param name="row">the row of this cell</param>
  15009. <param name="col">the column for this cell</param>
  15010. </member>
  15011. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16,NPOI.SS.UserModel.CellType)">
  15012. <summary>
  15013. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  15014. from scratch.
  15015. </summary>
  15016. <param name="book">Workbook record of the workbook containing this cell</param>
  15017. <param name="sheet">Sheet record of the sheet containing this cell</param>
  15018. <param name="row">the row of this cell</param>
  15019. <param name="col">the column for this cell</param>
  15020. <param name="type">CellType.Numeric, CellType.String, CellType.Formula, CellType.Blank,
  15021. CellType.Boolean, CellType.Error</param>
  15022. </member>
  15023. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.CellValueRecordInterface)">
  15024. <summary>
  15025. Creates an Cell from a CellValueRecordInterface. HSSFSheet uses this when
  15026. reading in cells from an existing sheet.
  15027. </summary>
  15028. <param name="book">Workbook record of the workbook containing this cell</param>
  15029. <param name="sheet">Sheet record of the sheet containing this cell</param>
  15030. <param name="cval">the Cell Value Record we wish to represent</param>
  15031. </member>
  15032. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor">
  15033. private constructor to prevent blank construction
  15034. </member>
  15035. <member name="M:NPOI.HSSF.UserModel.HSSFCell.DetermineType(NPOI.HSSF.Record.CellValueRecordInterface)">
  15036. used internally -- given a cell value record, figure out its type
  15037. </member>
  15038. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BoundWorkbook">
  15039. <summary>
  15040. the Workbook that this Cell is bound to
  15041. </summary>
  15042. </member>
  15043. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Row">
  15044. <summary>
  15045. the HSSFRow this cell belongs to
  15046. </summary>
  15047. </member>
  15048. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  15049. <summary>
  15050. Set the cells type (numeric, formula or string)
  15051. </summary>
  15052. <param name="cellType">Type of the cell.</param>
  15053. </member>
  15054. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType,System.Boolean,System.Int32,System.Int32,System.Int16)">
  15055. <summary>
  15056. Sets the cell type. The SetValue flag indicates whether to bother about
  15057. trying to preserve the current value in the new record if one is Created.
  15058. The SetCellValue method will call this method with false in SetValue
  15059. since it will overWrite the cell value later
  15060. </summary>
  15061. <param name="cellType">Type of the cell.</param>
  15062. <param name="setValue">if set to <c>true</c> [set value].</param>
  15063. <param name="row">The row.</param>
  15064. <param name="col">The col.</param>
  15065. <param name="styleIndex">Index of the style.</param>
  15066. </member>
  15067. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellType">
  15068. <summary>
  15069. Get the cells type (numeric, formula or string)
  15070. </summary>
  15071. <value>The type of the cell.</value>
  15072. </member>
  15073. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Double)">
  15074. <summary>
  15075. Set a numeric value for the cell
  15076. </summary>
  15077. <param name="value">the numeric value to Set this cell to. For formulas we'll Set the
  15078. precalculated value, for numerics we'll Set its value. For other types we
  15079. will Change the cell to a numeric cell and Set its value.</param>
  15080. </member>
  15081. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.DateTime)">
  15082. <summary>
  15083. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
  15084. a date.
  15085. </summary>
  15086. <param name="value">the date value to Set this cell to. For formulas we'll Set the
  15087. precalculated value, for numerics we'll Set its value. For other types we
  15088. will Change the cell to a numeric cell and Set its value.</param>
  15089. </member>
  15090. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.String)">
  15091. <summary>
  15092. Set a string value for the cell. Please note that if you are using
  15093. full 16 bit Unicode you should call SetEncoding() first.
  15094. </summary>
  15095. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  15096. string, for String cells we'll Set its value. For other types we will
  15097. Change the cell to a string cell and Set its value.
  15098. If value is null then we will Change the cell to a Blank cell.</param>
  15099. </member>
  15100. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(System.Byte)">
  15101. set a error value for the cell
  15102. @param errorCode the error value to set this cell to. For formulas we'll set the
  15103. precalculated value , for errors we'll set
  15104. its value. For other types we will change the cell to an error
  15105. cell and set its value.
  15106. </member>
  15107. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(NPOI.SS.UserModel.FormulaError)">
  15108. set a error value for the cell
  15109. @param error the error value to set this cell to. For formulas we'll set the
  15110. precalculated value , for errors we'll set
  15111. its value. For other types we will change the cell to an error
  15112. cell and set its value.
  15113. </member>
  15114. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  15115. <summary>
  15116. Set a string value for the cell. Please note that if you are using
  15117. full 16 bit Unicode you should call SetEncoding() first.
  15118. </summary>
  15119. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  15120. string, for String cells we'll Set its value. For other types we will
  15121. Change the cell to a string cell and Set its value.
  15122. If value is null then we will Change the cell to a Blank cell.</param>
  15123. </member>
  15124. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyFormulaChanging">
  15125. Should be called any time that a formula could potentially be deleted.
  15126. Does nothing if this cell currently does not hold a formula
  15127. </member>
  15128. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellFormula">
  15129. <summary>
  15130. Gets or sets the cell formula.
  15131. </summary>
  15132. <value>The cell formula.</value>
  15133. </member>
  15134. <member name="P:NPOI.HSSF.UserModel.HSSFCell.NumericCellValue">
  15135. <summary>
  15136. Get the value of the cell as a number. For strings we throw an exception.
  15137. For blank cells we return a 0.
  15138. </summary>
  15139. <value>The numeric cell value.</value>
  15140. </member>
  15141. <member name="M:NPOI.HSSF.UserModel.HSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  15142. <summary>
  15143. Used to help format error messages
  15144. </summary>
  15145. <param name="cellTypeCode">The cell type code.</param>
  15146. <returns></returns>
  15147. </member>
  15148. <member name="M:NPOI.HSSF.UserModel.HSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  15149. <summary>
  15150. Types the mismatch.
  15151. </summary>
  15152. <param name="expectedTypeCode">The expected type code.</param>
  15153. <param name="actualTypeCode">The actual type code.</param>
  15154. <param name="isFormulaCell">if set to <c>true</c> [is formula cell].</param>
  15155. <returns></returns>
  15156. </member>
  15157. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckFormulaCachedValueType(NPOI.SS.UserModel.CellType,NPOI.HSSF.Record.FormulaRecord)">
  15158. <summary>
  15159. Checks the type of the formula cached value.
  15160. </summary>
  15161. <param name="expectedTypeCode">The expected type code.</param>
  15162. <param name="fr">The fr.</param>
  15163. </member>
  15164. <member name="P:NPOI.HSSF.UserModel.HSSFCell.DateCellValue">
  15165. <summary>
  15166. Get the value of the cell as a date. For strings we throw an exception.
  15167. For blank cells we return a null.
  15168. </summary>
  15169. <value>The date cell value.</value>
  15170. </member>
  15171. <member name="P:NPOI.HSSF.UserModel.HSSFCell.StringCellValue">
  15172. <summary>
  15173. Get the value of the cell as a string - for numeric cells we throw an exception.
  15174. For blank cells we return an empty string.
  15175. For formulaCells that are not string Formulas, we return empty String
  15176. </summary>
  15177. <value>The string cell value.</value>
  15178. </member>
  15179. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RichStringCellValue">
  15180. <summary>
  15181. Get the value of the cell as a string - for numeric cells we throw an exception.
  15182. For blank cells we return an empty string.
  15183. For formulaCells that are not string Formulas, we return empty String
  15184. </summary>
  15185. <value>The rich string cell value.</value>
  15186. </member>
  15187. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Boolean)">
  15188. <summary>
  15189. Set a bool value for the cell
  15190. </summary>
  15191. <param name="value">the bool value to Set this cell to. For formulas we'll Set the
  15192. precalculated value, for bools we'll Set its value. For other types we
  15193. will Change the cell to a bool cell and Set its value.</param>
  15194. </member>
  15195. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ConvertCellValueToBoolean">
  15196. <summary>
  15197. Chooses a new bool value for the cell when its type is changing.
  15198. Usually the caller is calling SetCellType() with the intention of calling
  15199. SetCellValue(bool) straight afterwards. This method only exists to give
  15200. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  15201. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  15202. </summary>
  15203. <returns></returns>
  15204. </member>
  15205. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BooleanCellValue">
  15206. <summary>
  15207. Get the value of the cell as a bool. For strings, numbers, and errors, we throw an exception.
  15208. For blank cells we return a false.
  15209. </summary>
  15210. <value><c>true</c> if [boolean cell value]; otherwise, <c>false</c>.</value>
  15211. </member>
  15212. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ErrorCellValue">
  15213. <summary>
  15214. Get the value of the cell as an error code. For strings, numbers, and bools, we throw an exception.
  15215. For blank cells we return a 0.
  15216. </summary>
  15217. <value>The error cell value.</value>
  15218. </member>
  15219. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellStyle">
  15220. <summary>
  15221. Get the style for the cell. This is a reference to a cell style contained in the workbook
  15222. object.
  15223. </summary>
  15224. <value>The cell style.</value>
  15225. </member>
  15226. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ApplyUserCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle)">
  15227. Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but
  15228. instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent.
  15229. The proceudre to apply a UDS is as follows:
  15230. 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex()
  15231. and xfType == ExtendedFormatRecord.XF_CELL.
  15232. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style
  15233. and set the parentIndex to be style.getIndex()
  15234. 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record
  15235. @param style the user style to apply
  15236. @return the index of a ExtendedFormatRecord record that will be referenced by the cell
  15237. </member>
  15238. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellValueRecord">
  15239. <summary>
  15240. Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record
  15241. </summary>
  15242. <value>the cell via the low level api.</value>
  15243. </member>
  15244. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckBounds(System.Int32)">
  15245. <summary>
  15246. Checks the bounds.
  15247. </summary>
  15248. <param name="cellIndex">The cell num.</param>
  15249. <exception cref="T:System.Exception">if the bounds are exceeded.</exception>
  15250. </member>
  15251. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetAsActiveCell">
  15252. <summary>
  15253. Sets this cell as the active cell for the worksheet
  15254. </summary>
  15255. </member>
  15256. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ToString">
  15257. <summary>
  15258. Returns a string representation of the cell
  15259. This method returns a simple representation,
  15260. anthing more complex should be in user code, with
  15261. knowledge of the semantics of the sheet being Processed.
  15262. Formula cells return the formula string,
  15263. rather than the formula result.
  15264. Dates are Displayed in dd-MMM-yyyy format
  15265. Errors are Displayed as #ERR&lt;errIdx&gt;
  15266. </summary>
  15267. </member>
  15268. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellComment">
  15269. <summary>
  15270. Returns comment associated with this cell
  15271. </summary>
  15272. <value>The cell comment associated with this cell.</value>
  15273. </member>
  15274. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveCellComment">
  15275. <summary>
  15276. Removes the comment for this cell, if
  15277. there is one.
  15278. </summary>
  15279. <remarks>WARNING - some versions of excel will loose
  15280. all comments after performing this action!</remarks>
  15281. </member>
  15282. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ColumnIndex">
  15283. <summary>
  15284. Gets the index of the column.
  15285. </summary>
  15286. <value>The index of the column.</value>
  15287. </member>
  15288. <member name="M:NPOI.HSSF.UserModel.HSSFCell.UpdateCellNum(System.Int32)">
  15289. Updates the cell record's idea of what
  15290. column it belongs in (0 based)
  15291. @param num the new cell number
  15292. </member>
  15293. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RowIndex">
  15294. <summary>
  15295. Gets the (zero based) index of the row containing this cell
  15296. </summary>
  15297. <value>The index of the row.</value>
  15298. </member>
  15299. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Hyperlink">
  15300. <summary>
  15301. Get or set hyperlink associated with this cell
  15302. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  15303. </summary>
  15304. <value>The hyperlink associated with this cell or null if not found</value>
  15305. </member>
  15306. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveHyperlink">
  15307. <summary>
  15308. Removes the hyperlink for this cell, if there is one.
  15309. </summary>
  15310. </member>
  15311. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CachedFormulaResultType">
  15312. <summary>
  15313. Only valid for formula cells
  15314. </summary>
  15315. <value>one of (CellType.Numeric,CellType.String, CellType.Boolean, CellType.Error) depending
  15316. on the cached value of the formula</value>
  15317. </member>
  15318. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging(System.String)">
  15319. <summary>
  15320. The purpose of this method is to validate the cell state prior to modification
  15321. </summary>
  15322. <param name="msg"></param>
  15323. </member>
  15324. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging">
  15325. <summary>
  15326. Called when this cell is modified.
  15327. The purpose of this method is to validate the cell state prior to modification.
  15328. </summary>
  15329. </member>
  15330. <member name="T:NPOI.HSSF.UserModel.HSSFCellStyle">
  15331. <summary>
  15332. High level representation of the style of a cell in a sheet of a workbook.
  15333. @author Andrew C. Oliver (acoliver at apache dot org)
  15334. @author Jason Height (jheight at chariot dot net dot au)
  15335. </summary>
  15336. </member>
  15337. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.UserModel.HSSFWorkbook)">
  15338. <summary>
  15339. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  15340. </summary>
  15341. <param name="index">The index.</param>
  15342. <param name="rec">The record.</param>
  15343. <param name="workbook">The workbook.</param>
  15344. </member>
  15345. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.Model.InternalWorkbook)">
  15346. <summary>
  15347. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  15348. </summary>
  15349. <param name="index">The index.</param>
  15350. <param name="rec">The record.</param>
  15351. <param name="workbook">The workbook.</param>
  15352. </member>
  15353. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Index">
  15354. <summary>
  15355. Get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects)
  15356. </summary>
  15357. <value>Unique index number of the Underlying record this style represents (probably you don't care
  15358. Unless you're comparing which one is which)</value>
  15359. </member>
  15360. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ParentStyle">
  15361. <summary>
  15362. Gets the parent style.
  15363. </summary>
  15364. <value>the parent style for this cell style.
  15365. In most cases this will be null, but in a few
  15366. cases there'll be a fully defined parent.</value>
  15367. </member>
  15368. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.DataFormat">
  15369. <summary>
  15370. Get the index of the format
  15371. </summary>
  15372. <value>The data format.</value>
  15373. </member>
  15374. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString">
  15375. <summary>
  15376. Get the contents of the format string, by looking up
  15377. the DataFormat against the bound workbook
  15378. </summary>
  15379. <returns></returns>
  15380. </member>
  15381. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.SS.UserModel.IWorkbook)">
  15382. <summary>
  15383. Get the contents of the format string, by looking up the DataFormat against the supplied workbook
  15384. </summary>
  15385. <param name="workbook">The workbook</param>
  15386. <returns>the format string or "General" if not found</returns>
  15387. </member>
  15388. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.HSSF.Model.InternalWorkbook)">
  15389. <summary>
  15390. Get the contents of the format string, by looking up
  15391. the DataFormat against the supplied workbook
  15392. </summary>
  15393. <param name="workbook">The internal workbook.</param>
  15394. <returns></returns>
  15395. </member>
  15396. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  15397. <summary>
  15398. Set the font for this style
  15399. </summary>
  15400. <param name="font">a font object Created or retreived from the HSSFWorkbook object</param>
  15401. </member>
  15402. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FontIndex">
  15403. <summary>
  15404. Gets the index of the font for this style.
  15405. </summary>
  15406. <value>The index of the font.</value>
  15407. </member>
  15408. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetFont(NPOI.SS.UserModel.IWorkbook)">
  15409. <summary>
  15410. Gets the font for this style
  15411. </summary>
  15412. <param name="parentWorkbook">The parent workbook that this style belongs to.</param>
  15413. <returns></returns>
  15414. </member>
  15415. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsHidden">
  15416. <summary>
  15417. Get whether the cell's using this style are to be hidden
  15418. </summary>
  15419. <value>whether the cell using this style should be hidden</value>
  15420. </member>
  15421. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsLocked">
  15422. <summary>
  15423. Get whether the cell's using this style are to be locked
  15424. </summary>
  15425. <value>whether the cell using this style should be locked</value>
  15426. </member>
  15427. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Alignment">
  15428. <summary>
  15429. Get the type of horizontal alignment for the cell
  15430. </summary>
  15431. <value> the type of alignment</value>
  15432. </member>
  15433. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.WrapText">
  15434. <summary>
  15435. Gets or sets a value indicating whether the text should be wrapped
  15436. </summary>
  15437. <value><c>true</c> if [wrap text]; otherwise, <c>false</c>.</value>
  15438. </member>
  15439. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.VerticalAlignment">
  15440. <summary>
  15441. Gets or sets the vertical alignment for the cell.
  15442. </summary>
  15443. <value>the type of alignment</value>
  15444. </member>
  15445. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Rotation">
  15446. <summary>
  15447. Gets or sets the degree of rotation for the text in the cell
  15448. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  15449. uses values from 0 to 180 degrees.The implementations of this method will map between these two value-ranges
  15450. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  15451. of Excel file-format that this CellStyle is applied to.
  15452. </summary>
  15453. <value>The rotation degrees (between -90 and 90 degrees).</value>
  15454. </member>
  15455. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.VerifyBelongsToWorkbook(NPOI.HSSF.UserModel.HSSFWorkbook)">
  15456. <summary>
  15457. Verifies that this style belongs to the supplied Workbook.
  15458. Will throw an exception if it belongs to a different one.
  15459. This is normally called when trying to assign a style to a
  15460. cell, to ensure the cell and the style are from the same
  15461. workbook (if they're not, it won't work)
  15462. </summary>
  15463. <param name="wb">The workbook.</param>
  15464. </member>
  15465. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Indention">
  15466. <summary>
  15467. Gets or sets the number of spaces to indent the text in the cell
  15468. </summary>
  15469. <value>number of spaces</value>
  15470. </member>
  15471. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderLeft">
  15472. <summary>
  15473. Gets or sets the type of border to use for the left border of the cell
  15474. </summary>
  15475. <value>The border type.</value>
  15476. </member>
  15477. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderRight">
  15478. <summary>
  15479. Gets or sets the type of border to use for the right border of the cell
  15480. </summary>
  15481. <value>The border type.</value>
  15482. </member>
  15483. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderTop">
  15484. <summary>
  15485. Gets or sets the type of border to use for the top border of the cell
  15486. </summary>
  15487. <value>The border type.</value>
  15488. </member>
  15489. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderBottom">
  15490. <summary>
  15491. Gets or sets the type of border to use for the bottom border of the cell
  15492. </summary>
  15493. <value>The border type.</value>
  15494. </member>
  15495. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.LeftBorderColor">
  15496. <summary>
  15497. Gets or sets the color to use for the left border
  15498. </summary>
  15499. <value>The index of the color definition</value>
  15500. </member>
  15501. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.RightBorderColor">
  15502. <summary>
  15503. Gets or sets the color to use for the left border.
  15504. </summary>
  15505. <value>The index of the color definition</value>
  15506. </member>
  15507. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.TopBorderColor">
  15508. <summary>
  15509. Gets or sets the color to use for the top border
  15510. </summary>
  15511. <value>The index of the color definition.</value>
  15512. </member>
  15513. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BottomBorderColor">
  15514. <summary>
  15515. Gets or sets the color to use for the left border
  15516. </summary>
  15517. <value>The index of the color definition.</value>
  15518. </member>
  15519. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalColor">
  15520. <summary>
  15521. Gets or sets the color to use for the diagional border
  15522. </summary>
  15523. <value>The index of the color definition.</value>
  15524. </member>
  15525. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalLineStyle">
  15526. <summary>
  15527. Gets or sets the line type to use for the diagional border
  15528. </summary>
  15529. <value>The line type.</value>
  15530. </member>
  15531. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonal">
  15532. <summary>
  15533. Gets or sets the type of diagional border
  15534. </summary>.
  15535. <value>The border diagional type.</value>
  15536. </member>
  15537. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ShrinkToFit">
  15538. <summary>
  15539. Gets or sets whether the cell is shrink-to-fit
  15540. </summary>
  15541. </member>
  15542. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ReadingOrder">
  15543. Get or set the reading order, for RTL/LTR ordering of
  15544. the text.
  15545. <p>0 means Context (Default), 1 means Left To Right,
  15546. and 2 means Right to Left</p>
  15547. @return order - the reading order (0,1,2)
  15548. </member>
  15549. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillPattern">
  15550. <summary>
  15551. Gets or sets the fill pattern. - Set to 1 to Fill with foreground color
  15552. </summary>
  15553. <value>The fill pattern.</value>
  15554. </member>
  15555. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CheckDefaultBackgroundFills">
  15556. <summary>
  15557. Checks if the background and foreground Fills are Set correctly when one
  15558. or the other is Set to the default color.
  15559. Works like the logic table below:
  15560. BACKGROUND FOREGROUND
  15561. NONE AUTOMATIC
  15562. 0x41 0x40
  15563. NONE RED/ANYTHING
  15564. 0x40 0xSOMETHING
  15565. </summary>
  15566. </member>
  15567. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  15568. Clones all the style information from another
  15569. HSSFCellStyle, onto this one. This
  15570. HSSFCellStyle will then have all the same
  15571. properties as the source, but the two may
  15572. be edited independently.
  15573. Any stylings on this HSSFCellStyle will be lost!
  15574. The source HSSFCellStyle could be from another
  15575. HSSFWorkbook if you like. This allows you to
  15576. copy styles from one HSSFWorkbook to another.
  15577. </member>
  15578. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.HSSF.UserModel.HSSFCellStyle)">
  15579. <summary>
  15580. Clones all the style information from another
  15581. HSSFCellStyle, onto this one. This
  15582. HSSFCellStyle will then have all the same
  15583. properties as the source, but the two may
  15584. be edited independently.
  15585. Any stylings on this HSSFCellStyle will be lost!
  15586. The source HSSFCellStyle could be from another
  15587. HSSFWorkbook if you like. This allows you to
  15588. copy styles from one HSSFWorkbook to another.
  15589. </summary>
  15590. <param name="source">The source.</param>
  15591. </member>
  15592. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillBackgroundColor">
  15593. <summary>
  15594. Gets or sets the color of the fill background.
  15595. </summary>
  15596. <value>The color of the fill background.</value>
  15597. Set the background Fill color.
  15598. <example>
  15599. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  15600. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  15601. optionally a Foreground and background Fill can be applied:
  15602. Note: Ensure Foreground color is Set prior to background
  15603. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  15604. cs.SetFillForegroundColor(new HSSFColor.BLUE().Index);
  15605. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  15606. or, for the special case of SOLID_Fill:
  15607. cs.SetFillPattern(HSSFCellStyle.SOLID_FOREGROUND );
  15608. cs.SetFillForegroundColor(new HSSFColor.RED().Index);
  15609. It is necessary to Set the Fill style in order
  15610. for the color to be shown in the cell.
  15611. </example>
  15612. </member>
  15613. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillForegroundColor">
  15614. <summary>
  15615. Gets or sets the foreground Fill color
  15616. </summary>
  15617. <value>Fill color.</value>
  15618. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  15619. </member>
  15620. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.UserStyleName">
  15621. Gets the name of the user defined style.
  15622. Returns null for built in styles, and
  15623. styles where no name has been defined
  15624. </member>
  15625. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetHashCode">
  15626. <summary>
  15627. Serves as a hash function for a particular type.
  15628. </summary>
  15629. <returns>
  15630. A hash code for the current <see cref="T:System.Object"/>.
  15631. </returns>
  15632. </member>
  15633. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.Equals(System.Object)">
  15634. <summary>
  15635. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  15636. </summary>
  15637. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  15638. <returns>
  15639. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  15640. </returns>
  15641. <exception cref="T:System.NullReferenceException">
  15642. The <paramref name="obj"/> parameter is null.
  15643. </exception>
  15644. </member>
  15645. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(NPOI.DDF.EscherChildAnchorRecord)">
  15646. create anchor from existing file
  15647. @param escherChildAnchorRecord
  15648. </member>
  15649. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  15650. create anchor from scratch
  15651. @param dx1 x coordinate of the left up corner
  15652. @param dy1 y coordinate of the left up corner
  15653. @param dx2 x coordinate of the right down corner
  15654. @param dy2 y coordinate of the right down corner
  15655. </member>
  15656. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.SetAnchor(System.Int32,System.Int32,System.Int32,System.Int32)">
  15657. @param dx1 x coordinate of the left up corner
  15658. @param dy1 y coordinate of the left up corner
  15659. @param dx2 x coordinate of the right down corner
  15660. @param dy2 y coordinate of the right down corner
  15661. </member>
  15662. <member name="T:NPOI.HSSF.UserModel.HSSFClientAnchor">
  15663. <summary>
  15664. A client anchor Is attached to an excel worksheet. It anchors against a
  15665. top-left and buttom-right cell.
  15666. @author Glen Stampoultzis (glens at apache.org)
  15667. </summary>
  15668. </member>
  15669. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor">
  15670. <summary>
  15671. Creates a new client anchor and defaults all the anchor positions to 0.
  15672. </summary>
  15673. </member>
  15674. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  15675. <summary>
  15676. Creates a new client anchor and Sets the top-left and bottom-right
  15677. coordinates of the anchor.
  15678. Note: Microsoft Excel seems to sometimes disallow
  15679. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  15680. reverse them and draw shapes vertically or horizontally flipped!
  15681. </summary>
  15682. <param name="dx1">the x coordinate within the first cell.</param>
  15683. <param name="dy1">the y coordinate within the first cell.</param>
  15684. <param name="dx2">the x coordinate within the second cell.</param>
  15685. <param name="dy2">the y coordinate within the second cell.</param>
  15686. <param name="col1">the column (0 based) of the first cell.</param>
  15687. <param name="row1">the row (0 based) of the first cell.</param>
  15688. <param name="col2">the column (0 based) of the second cell.</param>
  15689. <param name="row2">the row (0 based) of the second cell.</param>
  15690. </member>
  15691. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetAnchorHeightInPoints(NPOI.SS.UserModel.ISheet)">
  15692. <summary>
  15693. Calculates the height of a client anchor in points.
  15694. </summary>
  15695. <param name="sheet">the sheet the anchor will be attached to</param>
  15696. <returns>the shape height.</returns>
  15697. </member>
  15698. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetRowHeightInPoints(NPOI.SS.UserModel.ISheet,System.Int32)">
  15699. <summary>
  15700. Gets the row height in points.
  15701. </summary>
  15702. <param name="sheet">The sheet.</param>
  15703. <param name="rowNum">The row num.</param>
  15704. <returns></returns>
  15705. </member>
  15706. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col1">
  15707. <summary>
  15708. Gets or sets the col1.
  15709. </summary>
  15710. <value>The col1.</value>
  15711. </member>
  15712. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col2">
  15713. <summary>
  15714. Gets or sets the col2.
  15715. </summary>
  15716. <value>The col2.</value>
  15717. </member>
  15718. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row1">
  15719. <summary>
  15720. Gets or sets the row1.
  15721. </summary>
  15722. <value>The row1.</value>
  15723. </member>
  15724. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row2">
  15725. <summary>
  15726. Gets or sets the row2.
  15727. </summary>
  15728. <value>The row2.</value>
  15729. </member>
  15730. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.SetAnchor(System.Int16,System.Int32,System.Int32,System.Int32,System.Int16,System.Int32,System.Int32,System.Int32)">
  15731. <summary>
  15732. Sets the top-left and bottom-right
  15733. coordinates of the anchor
  15734. Note: Microsoft Excel seems to sometimes disallow
  15735. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  15736. reverse them and draw shapes vertically or horizontally flipped!
  15737. </summary>
  15738. <param name="col1">the column (0 based) of the first cell.</param>
  15739. <param name="row1"> the row (0 based) of the first cell.</param>
  15740. <param name="x1">the x coordinate within the first cell.</param>
  15741. <param name="y1">the y coordinate within the first cell.</param>
  15742. <param name="col2">the column (0 based) of the second cell.</param>
  15743. <param name="row2">the row (0 based) of the second cell.</param>
  15744. <param name="x2">the x coordinate within the second cell.</param>
  15745. <param name="y2">the y coordinate within the second cell.</param>
  15746. </member>
  15747. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsHorizontallyFlipped">
  15748. <summary>
  15749. Gets a value indicating whether this instance is horizontally flipped.
  15750. </summary>
  15751. <value>
  15752. <c>true</c> if the anchor goes from right to left; otherwise, <c>false</c>.
  15753. </value>
  15754. </member>
  15755. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsVerticallyFlipped">
  15756. <summary>
  15757. Gets a value indicating whether this instance is vertically flipped.
  15758. </summary>
  15759. <value>
  15760. <c>true</c> if the anchor goes from bottom to top.; otherwise, <c>false</c>.
  15761. </value>
  15762. </member>
  15763. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.AnchorType">
  15764. <summary>
  15765. Gets the anchor type
  15766. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  15767. </summary>
  15768. <value>The type of the anchor.</value>
  15769. </member>
  15770. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.CheckRange(System.Int32,System.Int32,System.Int32,System.String)">
  15771. <summary>
  15772. Checks the range.
  15773. </summary>
  15774. <param name="value">The value.</param>
  15775. <param name="minRange">The min range.</param>
  15776. <param name="maxRange">The max range.</param>
  15777. <param name="varName">Name of the variable.</param>
  15778. </member>
  15779. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.unsignedValue(System.Int16)">
  15780. Given a 16-bit unsigned integer stored in a short, return the unsigned value.
  15781. @param s A 16-bit value intended to be interpreted as an unsigned integer.
  15782. @return The value represented by <code>s</code>.
  15783. </member>
  15784. <member name="T:NPOI.HSSF.UserModel.HSSFComment">
  15785. <summary>
  15786. Represents a cell comment - a sticky note associated with a cell.
  15787. @author Yegor Kozlov
  15788. </summary>
  15789. </member>
  15790. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  15791. <summary>
  15792. Construct a new comment with the given parent and anchor.
  15793. </summary>
  15794. <param name="parent"></param>
  15795. <param name="anchor">defines position of this anchor in the sheet</param>
  15796. </member>
  15797. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.Record.NoteRecord,NPOI.HSSF.Record.TextObjectRecord)">
  15798. <summary>
  15799. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> class.
  15800. </summary>
  15801. <param name="note">The note.</param>
  15802. <param name="txo">The txo.</param>
  15803. </member>
  15804. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Visible">
  15805. <summary>
  15806. Gets or sets a value indicating whether this <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> is visible.
  15807. </summary>
  15808. <value><c>true</c> if visible; otherwise, <c>false</c>.</value>
  15809. Sets whether this comment Is visible.
  15810. @return
  15811. <c>true</c>
  15812. if the comment Is visible,
  15813. <c>false</c>
  15814. otherwise
  15815. </member>
  15816. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Row">
  15817. <summary>
  15818. Gets or sets the row of the cell that Contains the comment
  15819. </summary>
  15820. <value>the 0-based row of the cell that Contains the comment</value>
  15821. </member>
  15822. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Column">
  15823. <summary>
  15824. Gets or sets the column of the cell that Contains the comment
  15825. </summary>
  15826. <value>the 0-based column of the cell that Contains the comment</value>
  15827. </member>
  15828. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Author">
  15829. <summary>
  15830. Gets or sets the name of the original comment author
  15831. </summary>
  15832. <value>the name of the original author of the comment</value>
  15833. </member>
  15834. <member name="P:NPOI.HSSF.UserModel.HSSFComment.NoteRecord">
  15835. <summary>
  15836. Gets the note record.
  15837. </summary>
  15838. <value>the underlying Note record.</value>
  15839. </member>
  15840. <member name="P:NPOI.HSSF.UserModel.HSSFComment.HasPosition">
  15841. Do we know which cell this comment belongs to?
  15842. </member>
  15843. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting">
  15844. <summary>
  15845. HSSFConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  15846. The class can be used to make a copy HSSFConditionalFormatting Settings
  15847. </summary>
  15848. <example>
  15849. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  15850. newSheet.AddConditionalFormatting(cf);
  15851. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  15852. Use {@link HSSFSheet#GetConditionalFormattingAt(int)} to Get access to an instance of this class.
  15853. To Create a new Conditional Formatting Set use the following approach:
  15854. // Define a Conditional Formatting rule, which triggers formatting
  15855. // when cell's value Is greater or equal than 100.0 and
  15856. // applies patternFormatting defined below.
  15857. HSSFConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  15858. ComparisonOperator.GE,
  15859. "100.0", // 1st formula
  15860. null // 2nd formula Is not used for comparison operator GE
  15861. );
  15862. // Create pattern with red background
  15863. HSSFPatternFormatting patternFmt = rule.cretePatternFormatting();
  15864. patternFormatting.SetFillBackgroundColor(HSSFColor.RED.index);
  15865. // Define a region containing first column
  15866. Region [] regions =
  15867. {
  15868. new Region(1,(short)1,-1,(short)1)
  15869. };
  15870. // Apply Conditional Formatting rule defined above to the regions
  15871. sheet.AddConditionalFormatting(regions, rule);
  15872. </example>
  15873. <remarks>@author Dmitriy Kumshayev</remarks>
  15874. </member>
  15875. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  15876. <summary>
  15877. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting"/> class.
  15878. </summary>
  15879. <param name="workbook">The workbook.</param>
  15880. <param name="cfAggregate">The cf aggregate.</param>
  15881. </member>
  15882. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.CFRecordsAggregate">
  15883. <summary>
  15884. Gets the CF records aggregate.
  15885. </summary>
  15886. <returns></returns>
  15887. </member>
  15888. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRanges">
  15889. <summary>
  15890. Gets array of CellRangeAddresses
  15891. </summary>
  15892. <returns></returns>
  15893. </member>
  15894. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.SetRule(System.Int32,NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  15895. <summary>
  15896. Replaces an existing Conditional Formatting rule at position idx.
  15897. Excel allows to Create up to 3 Conditional Formatting rules.
  15898. This method can be useful to modify existing Conditional Formatting rules.
  15899. </summary>
  15900. <param name="idx">position of the rule. Should be between 0 and 2.</param>
  15901. <param name="cfRule">Conditional Formatting rule</param>
  15902. </member>
  15903. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.AddRule(NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  15904. <summary>
  15905. Add a Conditional Formatting rule.
  15906. Excel allows to Create up to 3 Conditional Formatting rules.
  15907. </summary>
  15908. <param name="cfRule">Conditional Formatting rule</param>
  15909. </member>
  15910. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetRule(System.Int32)">
  15911. <summary>
  15912. Gets the Conditional Formatting rule at position idx
  15913. </summary>
  15914. <param name="idx">The index.</param>
  15915. <returns></returns>
  15916. </member>
  15917. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.NumberOfRules">
  15918. <summary>
  15919. Gets the number of Conditional Formatting rules.
  15920. </summary>
  15921. <value>The number of rules.</value>
  15922. </member>
  15923. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.ToString">
  15924. <summary>
  15925. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  15926. </summary>
  15927. <returns>
  15928. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  15929. </returns>
  15930. </member>
  15931. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule">
  15932. High level representation of Conditional Formatting Rule.
  15933. It allows to specify formula based conditions for the Conditional Formatting
  15934. and the formatting Settings such as font, border and pattern.
  15935. @author Dmitriy Kumshayev
  15936. </member>
  15937. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.FontFormatting">
  15938. @return - font formatting object if defined, <c>null</c> otherwise
  15939. </member>
  15940. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateFontFormatting">
  15941. Create a new font formatting structure if it does not exist,
  15942. otherwise just return existing object.
  15943. @return - font formatting object, never returns <c>null</c>.
  15944. </member>
  15945. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.BorderFormatting">
  15946. @return - border formatting object if defined, <c>null</c> otherwise
  15947. </member>
  15948. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateBorderFormatting">
  15949. Create a new border formatting structure if it does not exist,
  15950. otherwise just return existing object.
  15951. @return - border formatting object, never returns <c>null</c>.
  15952. </member>
  15953. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.PatternFormatting">
  15954. @return - pattern formatting object if defined, <c>null</c> otherwise
  15955. </member>
  15956. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreatePatternFormatting">
  15957. Create a new pattern formatting structure if it does not exist,
  15958. otherwise just return existing object.
  15959. @return - pattern formatting object, never returns <c>null</c>.
  15960. </member>
  15961. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.DataBarFormatting">
  15962. @return databar / data-bar formatting object if defined, <code>null</code> otherwise
  15963. </member>
  15964. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateDataBarFormatting">
  15965. create a new databar / data-bar formatting object if it does not exist,
  15966. otherwise just return the existing object.
  15967. </member>
  15968. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.MultiStateFormatting">
  15969. @return icon / multi-state formatting object if defined, <code>null</code> otherwise
  15970. </member>
  15971. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateMultiStateFormatting">
  15972. create a new icon / multi-state formatting object if it does not exist,
  15973. otherwise just return the existing object.
  15974. </member>
  15975. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ColorScaleFormatting">
  15976. @return color scale / gradient formatting object if defined, <code>null</code> otherwise
  15977. </member>
  15978. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateColorScaleFormatting">
  15979. create a new color scale / gradient formatting object if it does not exist,
  15980. otherwise just return the existing object.
  15981. </member>
  15982. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ConditionType">
  15983. @return - the conditiontype for the cfrule
  15984. </member>
  15985. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ComparisonOperation">
  15986. @return - the comparisionoperatation for the cfrule
  15987. </member>
  15988. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateFormulaEvaluator">
  15989. Creates a HSSFFormulaEvaluator, the object that Evaluates formula cells.
  15990. @return a HSSFFormulaEvaluator instance
  15991. </member>
  15992. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateClientAnchor">
  15993. Creates a HSSFClientAnchor. Use this object to position drawing object in a sheet
  15994. @return a HSSFClientAnchor instance
  15995. @see NPOI.SS.usermodel.Drawing
  15996. </member>
  15997. <member name="F:NPOI.HSSF.UserModel.HSSFDataFormat.FIRST_USER_DEFINED_FORMAT_INDEX">
  15998. The first user-defined format starts at 164.
  15999. </member>
  16000. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.#ctor(NPOI.HSSF.Model.InternalWorkbook)">
  16001. <summary>
  16002. Construncts a new data formatter. It takes a workbook to have
  16003. access to the workbooks format records.
  16004. </summary>
  16005. <param name="workbook">the workbook the formats are tied to.</param>
  16006. </member>
  16007. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.String)">
  16008. <summary>
  16009. Get the format index that matches the given format string
  16010. Automatically Converts "text" to excel's format string to represent text.
  16011. </summary>
  16012. <param name="format">The format string matching a built in format.</param>
  16013. <returns>index of format or -1 if Undefined.</returns>
  16014. </member>
  16015. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.String)">
  16016. <summary>
  16017. Get the format index that matches the given format
  16018. string, creating a new format entry if required.
  16019. Aliases text to the proper format as required.
  16020. </summary>
  16021. <param name="pFormat">The format string matching a built in format.</param>
  16022. <returns>index of format.</returns>
  16023. </member>
  16024. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.Int16)">
  16025. <summary>
  16026. Get the format string that matches the given format index
  16027. </summary>
  16028. <param name="index">The index of a format.</param>
  16029. <returns>string represented at index of format or null if there Is not a format at that index</returns>
  16030. </member>
  16031. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.Int16)">
  16032. <summary>
  16033. Get the format string that matches the given format index
  16034. </summary>
  16035. <param name="index">The index of a built in format.</param>
  16036. <returns>string represented at index of format or null if there Is not a builtin format at that index</returns>
  16037. </member>
  16038. <member name="P:NPOI.HSSF.UserModel.HSSFDataFormat.NumberOfBuiltinBuiltinFormats">
  16039. <summary>
  16040. Get the number of builtin and reserved builtinFormats
  16041. </summary>
  16042. <returns>number of builtin and reserved builtinFormats</returns>
  16043. </member>
  16044. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.EnsureFormatsSize(System.Int32)">
  16045. Ensures that the formats list can hold entries
  16046. up to and including the entry with this index
  16047. </member>
  16048. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationCell">
  16049. <summary>
  16050. HSSF wrapper for a cell under evaluation
  16051. @author Josh Micich
  16052. </summary>
  16053. </member>
  16054. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationSheet">
  16055. HSSF wrapper for a sheet under evaluation
  16056. @author Josh Micich
  16057. </member>
  16058. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook">
  16059. Internal POI use only
  16060. @author Josh Micich
  16061. </member>
  16062. <member name="M:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  16063. <summary>
  16064. Return an external name (named range, function, user-defined function) Ptg
  16065. </summary>
  16066. <param name="name"></param>
  16067. <param name="sheet"></param>
  16068. <returns></returns>
  16069. </member>
  16070. <member name="T:NPOI.HSSF.UserModel.HSSFFont">
  16071. <summary>
  16072. Represents a Font used in a workbook.
  16073. @version 1.0-pre
  16074. @author Andrew C. Oliver
  16075. </summary>
  16076. </member>
  16077. <member name="M:NPOI.HSSF.UserModel.HSSFFont.#ctor(System.Int16,NPOI.HSSF.Record.FontRecord)">
  16078. <summary>
  16079. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFont"/> class.
  16080. </summary>
  16081. <param name="index">The index.</param>
  16082. <param name="rec">The record.</param>
  16083. </member>
  16084. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontName">
  16085. <summary>
  16086. Get the name for the font (i.e. Arial)
  16087. </summary>
  16088. <value>the name of the font to use</value>
  16089. </member>
  16090. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Index">
  16091. <summary>
  16092. Get the index within the HSSFWorkbook (sequence within the collection of Font objects)
  16093. </summary>
  16094. <value>Unique index number of the Underlying record this Font represents (probably you don't care
  16095. Unless you're comparing which one is which)</value>
  16096. </member>
  16097. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeight">
  16098. <summary>
  16099. Get or sets the font height in Unit's of 1/20th of a point. Maybe you might want to
  16100. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  16101. </summary>
  16102. <value>height in 1/20ths of a point.</value>
  16103. </member>
  16104. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeightInPoints">
  16105. <summary>
  16106. Gets or sets the font height in points.
  16107. </summary>
  16108. <value>height in the familiar Unit of measure - points.</value>
  16109. </member>
  16110. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsItalic">
  16111. <summary>
  16112. Gets or sets whether to use italics or not
  16113. </summary>
  16114. <value><c>true</c> if this instance is italic; otherwise, <c>false</c>.</value>
  16115. </member>
  16116. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsStrikeout">
  16117. <summary>
  16118. Get whether to use a strikeout horizontal line through the text or not
  16119. </summary>
  16120. <value>
  16121. strikeout or not
  16122. </value>
  16123. </member>
  16124. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Color">
  16125. <summary>
  16126. Gets or sets the color for the font.
  16127. </summary>
  16128. <value>The color to use.</value>
  16129. </member>
  16130. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHSSFColor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  16131. <summary>
  16132. get the color value for the font
  16133. </summary>
  16134. <param name="wb">HSSFWorkbook</param>
  16135. <returns></returns>
  16136. </member>
  16137. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Boldweight">
  16138. <summary>
  16139. Gets or sets the boldness to use
  16140. </summary>
  16141. <value>The boldweight.</value>
  16142. </member>
  16143. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsBold">
  16144. get or set if the font bold style
  16145. </member>
  16146. <member name="P:NPOI.HSSF.UserModel.HSSFFont.TypeOffset">
  16147. <summary>
  16148. Gets or sets normal,base or subscript.
  16149. </summary>
  16150. <value>offset type to use (none,base,sub)</value>
  16151. </member>
  16152. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Underline">
  16153. <summary>
  16154. Gets or sets the type of text Underlining to use
  16155. </summary>
  16156. <value>The Underlining type.</value>
  16157. </member>
  16158. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Charset">
  16159. <summary>
  16160. Gets or sets the char set to use.
  16161. </summary>
  16162. <value>The char set.</value>
  16163. </member>
  16164. <member name="M:NPOI.HSSF.UserModel.HSSFFont.ToString">
  16165. <summary>
  16166. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16167. </summary>
  16168. <returns>
  16169. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16170. </returns>
  16171. </member>
  16172. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHashCode">
  16173. <summary>
  16174. Serves as a hash function for a particular type.
  16175. </summary>
  16176. <returns>
  16177. A hash code for the current <see cref="T:System.Object"/>.
  16178. </returns>
  16179. </member>
  16180. <member name="M:NPOI.HSSF.UserModel.HSSFFont.Equals(System.Object)">
  16181. <summary>
  16182. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  16183. </summary>
  16184. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  16185. <returns>
  16186. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  16187. </returns>
  16188. <exception cref="T:System.NullReferenceException">
  16189. The <paramref name="obj"/> parameter is null.
  16190. </exception>
  16191. </member>
  16192. <member name="T:NPOI.HSSF.UserModel.HSSFFontFormatting">
  16193. High level representation for Font Formatting component
  16194. of Conditional Formatting Settings
  16195. @author Dmitriy Kumshayev
  16196. </member>
  16197. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.EscapementType">
  16198. Get the type of base or subscript for the font
  16199. @return base or subscript option
  16200. </member>
  16201. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontColorIndex">
  16202. @return font color index
  16203. </member>
  16204. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontHeight">
  16205. Gets the height of the font in 1/20th point Units
  16206. @return fontheight (in points/20); or -1 if not modified
  16207. </member>
  16208. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontWeight">
  16209. Get the font weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  16210. 0x190 for normal and 0x2bc for bold
  16211. @return bw - a number between 100-1000 for the fonts "boldness"
  16212. </member>
  16213. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.GetRawRecord">
  16214. @return
  16215. @see org.apache.poi.hssf.record.cf.FontFormatting#GetRawRecord()
  16216. </member>
  16217. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.UnderlineType">
  16218. Get the type of Underlining for the font
  16219. @return font Underlining type
  16220. @see #U_NONE
  16221. @see #U_SINGLE
  16222. @see #U_DOUBLE
  16223. @see #U_SINGLE_ACCOUNTING
  16224. @see #U_DOUBLE_ACCOUNTING
  16225. </member>
  16226. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsBold">
  16227. Get whether the font weight Is Set to bold or not
  16228. @return bold - whether the font Is bold or not
  16229. </member>
  16230. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsEscapementTypeModified">
  16231. @return true if escapement type was modified from default
  16232. </member>
  16233. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontCancellationModified">
  16234. @return true if font cancellation was modified from default
  16235. </member>
  16236. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontOutlineModified">
  16237. @return true if font outline type was modified from default
  16238. </member>
  16239. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontShadowModified">
  16240. @return true if font shadow type was modified from default
  16241. </member>
  16242. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontStyleModified">
  16243. @return true if font style was modified from default
  16244. </member>
  16245. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsItalic">
  16246. @return true if font style was Set to <i>italic</i>
  16247. </member>
  16248. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsOutlineOn">
  16249. @return true if font outline Is on
  16250. </member>
  16251. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsShadowOn">
  16252. @return true if font shadow Is on
  16253. </member>
  16254. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsStrikeout">
  16255. @return true if font strikeout Is on
  16256. </member>
  16257. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsUnderlineTypeModified">
  16258. @return true if font Underline type was modified from default
  16259. </member>
  16260. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontWeightModified">
  16261. @return true if font weight was modified from default
  16262. </member>
  16263. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  16264. Set font style options.
  16265. @param italic - if true, Set posture style to italic, otherwise to normal
  16266. @param bold- if true, Set font weight to bold, otherwise to normal
  16267. </member>
  16268. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.ResetFontStyle">
  16269. Set font style options to default values (non-italic, non-bold)
  16270. </member>
  16271. <member name="T:NPOI.HSSF.UserModel.HSSFFooter">
  16272. <summary>
  16273. Class to Read and manipulate the footer.
  16274. The footer works by having a left, center, and right side. The total cannot
  16275. be more that 255 bytes long. One uses this class by Getting the HSSFFooter
  16276. from HSSFSheet and then Getting or Setting the left, center, and right side.
  16277. For special things (such as page numbers and date), one can use a the methods
  16278. that return the Chars used to represent these. One can also Change the
  16279. fonts by using similar methods.
  16280. @author Shawn Laubach (slaubach at apache dot org)
  16281. </summary>
  16282. </member>
  16283. <member name="M:NPOI.HSSF.UserModel.HSSFFooter.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  16284. <summary>
  16285. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  16286. </summary>
  16287. <param name="psb">Footer record to create the footer with</param>
  16288. </member>
  16289. <member name="P:NPOI.HSSF.UserModel.HSSFFooter.RawText">
  16290. <summary>
  16291. Gets the raw footer.
  16292. </summary>
  16293. <value>The raw footer.</value>
  16294. </member>
  16295. <member name="T:NPOI.HSSF.UserModel.HSSFFormulaEvaluator">
  16296. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  16297. </member>
  16298. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  16299. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  16300. for the (conservative) assumption that any cell may have its definition changed after
  16301. evaluation begins.
  16302. </member>
  16303. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  16304. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  16305. </member>
  16306. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  16307. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  16308. for the (conservative) assumption that any cell may have its definition changed after
  16309. evaluation begins.
  16310. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  16311. </member>
  16312. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.SetupEnvironment(System.String[],NPOI.HSSF.UserModel.HSSFFormulaEvaluator[])">
  16313. Coordinates several formula evaluators together so that formulas that involve external
  16314. references can be evaluated.
  16315. @param workbookNames the simple file names used to identify the workbooks in formulas
  16316. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  16317. @param evaluators all evaluators for the full set of workbooks required by the formulas.
  16318. </member>
  16319. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  16320. Should be called to tell the cell value cache that the specified (value or formula) cell
  16321. has changed.
  16322. Failure to call this method after changing cell values will cause incorrect behaviour
  16323. of the evaluate~ methods of this class
  16324. </member>
  16325. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  16326. Should be called to tell the cell value cache that the specified cell has just been
  16327. deleted.
  16328. Failure to call this method after changing cell values will cause incorrect behaviour
  16329. of the evaluate~ methods of this class
  16330. </member>
  16331. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  16332. Should be called to tell the cell value cache that the specified (value or formula) cell
  16333. has changed.
  16334. Failure to call this method after changing cell values will cause incorrect behaviour
  16335. of the evaluate~ methods of this class
  16336. </member>
  16337. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  16338. Returns a CellValue wrapper around the supplied ValueEval instance.
  16339. @param cell
  16340. </member>
  16341. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  16342. If cell Contains formula, it Evaluates the formula, and
  16343. puts the formula result back into the cell, in place
  16344. of the old formula.
  16345. Else if cell does not contain formula, this method leaves
  16346. the cell UnChanged.
  16347. Note that the same instance of Cell is returned to
  16348. allow chained calls like:
  16349. <pre>
  16350. int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
  16351. </pre>
  16352. Be aware that your cell value will be Changed to hold the
  16353. result of the formula. If you simply want the formula
  16354. value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)}
  16355. @param cell
  16356. </member>
  16357. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.HSSF.UserModel.HSSFWorkbook)">
  16358. Loops over all cells in all sheets of the supplied
  16359. workbook.
  16360. For cells that contain formulas, their formulas are
  16361. Evaluated, and the results are saved. These cells
  16362. remain as formula cells.
  16363. For cells that do not contain formulas, no Changes
  16364. are made.
  16365. This is a helpful wrapper around looping over all
  16366. cells, and calling EvaluateFormulaCell on each one.
  16367. </member>
  16368. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  16369. Loops over all cells in all sheets of the supplied
  16370. workbook.
  16371. For cells that contain formulas, their formulas are
  16372. evaluated, and the results are saved. These cells
  16373. remain as formula cells.
  16374. For cells that do not contain formulas, no changes
  16375. are made.
  16376. This is a helpful wrapper around looping over all
  16377. cells, and calling evaluateFormulaCell on each one.
  16378. </member>
  16379. <member name="T:NPOI.HSSF.UserModel.HSSFHeader">
  16380. <summary>
  16381. Class to Read and manipulate the header.
  16382. The header works by having a left, center, and right side. The total cannot
  16383. be more that 255 bytes long. One uses this class by Getting the HSSFHeader
  16384. from HSSFSheet and then Getting or Setting the left, center, and right side.
  16385. For special things (such as page numbers and date), one can use a the methods
  16386. that return the Chars used to represent these. One can also Change the
  16387. fonts by using similar methods.
  16388. @author Shawn Laubach (slaubach at apache dot org)
  16389. </summary>
  16390. </member>
  16391. <member name="M:NPOI.HSSF.UserModel.HSSFHeader.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  16392. <summary>
  16393. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  16394. </summary>
  16395. <param name="psb">Footer record to Create the footer with</param>
  16396. </member>
  16397. <member name="P:NPOI.HSSF.UserModel.HSSFHeader.RawText">
  16398. <summary>
  16399. Gets the raw footer.
  16400. </summary>
  16401. <value>The raw footer.</value>
  16402. </member>
  16403. <member name="T:NPOI.HSSF.UserModel.HSSFHyperlink">
  16404. <summary>
  16405. Represents an Excel hyperlink.
  16406. </summary>
  16407. <remarks>@author Yegor Kozlov (yegor at apache dot org)</remarks>
  16408. </member>
  16409. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.record">
  16410. Low-level record object that stores the actual hyperlink data
  16411. </member>
  16412. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.link_type">
  16413. If we Create a new hypelrink remember its type
  16414. </member>
  16415. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  16416. <summary>
  16417. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  16418. </summary>
  16419. <param name="type">The type of hyperlink to Create.</param>
  16420. </member>
  16421. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.HSSF.Record.HyperlinkRecord)">
  16422. <summary>
  16423. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  16424. </summary>
  16425. <param name="record">The record.</param>
  16426. </member>
  16427. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstRow">
  16428. <summary>
  16429. Gets or sets the row of the first cell that Contains the hyperlink
  16430. </summary>
  16431. <value>the 0-based row of the cell that Contains the hyperlink.</value>
  16432. </member>
  16433. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastRow">
  16434. <summary>
  16435. Gets or sets the row of the last cell that Contains the hyperlink
  16436. </summary>
  16437. <value>the 0-based row of the last cell that Contains the hyperlink</value>
  16438. </member>
  16439. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstColumn">
  16440. <summary>
  16441. Gets or sets the column of the first cell that Contains the hyperlink
  16442. </summary>
  16443. <value>the 0-based column of the first cell that Contains the hyperlink</value>
  16444. </member>
  16445. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastColumn">
  16446. <summary>
  16447. Gets or sets the column of the last cell that Contains the hyperlink
  16448. </summary>
  16449. <value>the 0-based column of the last cell that Contains the hyperlink</value>
  16450. </member>
  16451. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Address">
  16452. <summary>
  16453. Gets or sets Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  16454. </summary>
  16455. <value>the Address of this hyperlink</value>
  16456. </member>
  16457. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.TextMark">
  16458. <summary>
  16459. Gets or sets the text mark.
  16460. </summary>
  16461. <value>The text mark.</value>
  16462. </member>
  16463. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.ShortFilename">
  16464. <summary>
  16465. Gets or sets the short filename.
  16466. </summary>
  16467. <value>The short filename.</value>
  16468. </member>
  16469. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Label">
  16470. <summary>
  16471. Gets or sets the text label for this hyperlink
  16472. </summary>
  16473. <value>text to Display</value>
  16474. </member>
  16475. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Type">
  16476. <summary>
  16477. Gets the type of this hyperlink
  16478. </summary>
  16479. <value>the type of this hyperlink</value>
  16480. </member>
  16481. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.Equals(System.Object)">
  16482. @return whether the objects have the same HyperlinkRecord
  16483. </member>
  16484. <member name="T:NPOI.HSSF.UserModel.HSSFName">
  16485. <summary>
  16486. High Level Represantion of Named Range
  16487. </summary>
  16488. <remarks>@author Libin Roman (Vista Portal LDT. Developer)</remarks>
  16489. </member>
  16490. <member name="M:NPOI.HSSF.UserModel.HSSFName.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.NameRecord,NPOI.HSSF.Record.NameCommentRecord)">
  16491. <summary>
  16492. Creates new HSSFName - called by HSSFWorkbook to Create a sheet from
  16493. scratch.
  16494. </summary>
  16495. <param name="book">lowlevel Workbook object associated with the sheet.</param>
  16496. <param name="name">the Name Record</param>
  16497. <param name="comment"></param>
  16498. </member>
  16499. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetName">
  16500. <summary>
  16501. Gets or sets the sheets name which this named range is referenced to
  16502. </summary>
  16503. <value>sheet name, which this named range refered to</value>
  16504. </member>
  16505. <member name="P:NPOI.HSSF.UserModel.HSSFName.NameName">
  16506. <summary>
  16507. Gets or sets the name of the named range
  16508. </summary>
  16509. <value>named range name</value>
  16510. </member>
  16511. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetIndex">
  16512. Returns the sheet index this name applies to.
  16513. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  16514. </member>
  16515. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetNameDefinition(NPOI.SS.Formula.PTG.Ptg[])">
  16516. <summary>
  16517. Sets the NameParsedFormula structure that specifies the formula for the defined name.
  16518. </summary>
  16519. <param name="ptgs">the sequence of {@link Ptg}s for the formula.</param>
  16520. </member>
  16521. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsDeleted">
  16522. <summary>
  16523. Tests if this name points to a cell that no longer exists
  16524. </summary>
  16525. <value>
  16526. <c>true</c> if the name refers to a deleted cell; otherwise, <c>false</c>.
  16527. </value>
  16528. </member>
  16529. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsFunctionName">
  16530. <summary>
  16531. Gets a value indicating whether this instance is function name.
  16532. </summary>
  16533. <value>
  16534. <c>true</c> if this instance is function name; otherwise, <c>false</c>.
  16535. </value>
  16536. </member>
  16537. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetFunction(System.Boolean)">
  16538. Indicates that the defined name refers to a user-defined function.
  16539. This attribute is used when there is an add-in or other code project associated with the file.
  16540. @param value <c>true</c> indicates the name refers to a function.
  16541. </member>
  16542. <member name="M:NPOI.HSSF.UserModel.HSSFName.ToString">
  16543. <summary>
  16544. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16545. </summary>
  16546. <returns>
  16547. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  16548. </returns>
  16549. </member>
  16550. <member name="T:NPOI.HSSF.UserModel.HSSFObjectData">
  16551. Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...
  16552. @author Daniel Noll
  16553. </member>
  16554. <member name="F:NPOI.HSSF.UserModel.HSSFObjectData._root">
  16555. Reference to the filesystem root, required for retrieving the object data.
  16556. </member>
  16557. <member name="P:NPOI.HSSF.UserModel.HSSFObjectData.OLE2ClassName">
  16558. Returns the OLE2 Class Name of the object
  16559. </member>
  16560. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetDirectory">
  16561. Gets the object data. Only call for ones that have
  16562. data though. See {@link #hasDirectoryEntry()}
  16563. @return the object data as an OLE2 directory.
  16564. @ if there was an error Reading the data.
  16565. </member>
  16566. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetObjectData">
  16567. Returns the data portion, for an ObjectData
  16568. that doesn't have an associated POIFS Directory
  16569. Entry
  16570. </member>
  16571. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.HasDirectoryEntry">
  16572. Does this ObjectData have an associated POIFS
  16573. Directory Entry?
  16574. (Not all do, those that don't have a data portion)
  16575. </member>
  16576. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.FindObjectRecord">
  16577. Finds the EmbeddedObjectRefSubRecord, or throws an
  16578. Exception if there wasn't one
  16579. </member>
  16580. <member name="T:NPOI.HSSF.UserModel.HSSFOptimiser">
  16581. <summary>
  16582. Excel can Get cranky if you give it files containing too
  16583. many (especially duplicate) objects, and this class can
  16584. help to avoid those.
  16585. In general, it's much better to make sure you don't
  16586. duplicate the objects in your code, as this is likely
  16587. to be much faster than creating lots and lots of
  16588. excel objects+records, only to optimise them down to
  16589. many fewer at a later stage.
  16590. However, sometimes this is too hard / tricky to do, which
  16591. is where the use of this class comes in.
  16592. </summary>
  16593. </member>
  16594. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseFonts(NPOI.HSSF.UserModel.HSSFWorkbook)">
  16595. <summary>
  16596. Goes through the Workbook, optimising the fonts by
  16597. removing duplicate ones.
  16598. For now, only works on fonts used in HSSFCellStyle
  16599. and HSSFRichTextString. Any other font uses
  16600. (eg charts, pictures) may well end up broken!
  16601. This can be a slow operation, especially if you have
  16602. lots of cells, cell styles or rich text strings
  16603. </summary>
  16604. <param name="workbook">The workbook in which to optimise the fonts</param>
  16605. </member>
  16606. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseCellStyles(NPOI.HSSF.UserModel.HSSFWorkbook)">
  16607. <summary>
  16608. Goes through the Wokrbook, optimising the cell styles
  16609. by removing duplicate ones and ones that aren't used.
  16610. For best results, optimise the fonts via a call to
  16611. OptimiseFonts(HSSFWorkbook) first
  16612. </summary>
  16613. <param name="workbook">The workbook in which to optimise the cell styles</param>
  16614. </member>
  16615. <member name="T:NPOI.HSSF.UserModel.HSSFPalette">
  16616. <summary>
  16617. Represents a workbook color palette.
  16618. Internally, the XLS format refers to colors using an offset into the palette
  16619. record. Thus, the first color in the palette has the index 0x8, the second
  16620. has the index 0x9, etc. through 0x40
  16621. @author Brian Sanders (bsanders at risklabs dot com)
  16622. </summary>
  16623. </member>
  16624. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.GetColor(System.Int16)">
  16625. <summary>
  16626. Retrieves the color at a given index
  16627. </summary>
  16628. <param name="index">the palette index, between 0x8 to 0x40 inclusive.</param>
  16629. <returns>the color, or null if the index Is not populated</returns>
  16630. </member>
  16631. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindColor(System.Byte,System.Byte,System.Byte)">
  16632. <summary>
  16633. Finds the first occurance of a given color
  16634. </summary>
  16635. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  16636. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  16637. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  16638. <returns>the color, or null if the color does not exist in this palette</returns>
  16639. </member>
  16640. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindSimilarColor(System.Byte,System.Byte,System.Byte)">
  16641. <summary>
  16642. Finds the closest matching color in the custom palette. The
  16643. method for Finding the distance between the colors Is fairly
  16644. primative.
  16645. </summary>
  16646. <param name="red">The red component of the color to match.</param>
  16647. <param name="green">The green component of the color to match.</param>
  16648. <param name="blue">The blue component of the color to match.</param>
  16649. <returns>The closest color or null if there are no custom
  16650. colors currently defined.</returns>
  16651. </member>
  16652. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.SetColorAtIndex(System.Int16,System.Byte,System.Byte,System.Byte)">
  16653. <summary>
  16654. Sets the color at the given offset
  16655. </summary>
  16656. <param name="index">the palette index, between 0x8 to 0x40 inclusive</param>
  16657. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  16658. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  16659. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  16660. </member>
  16661. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.AddColor(System.Byte,System.Byte,System.Byte)">
  16662. <summary>
  16663. Adds a new color into an empty color slot.
  16664. </summary>
  16665. <param name="red">The red component</param>
  16666. <param name="green">The green component</param>
  16667. <param name="blue">The blue component</param>
  16668. <returns>The new custom color.</returns>
  16669. </member>
  16670. <member name="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor">
  16671. <summary>
  16672. user custom color
  16673. </summary>
  16674. </member>
  16675. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte[])">
  16676. <summary>
  16677. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  16678. </summary>
  16679. <param name="byteOffset">The byte offset.</param>
  16680. <param name="colors">The colors.</param>
  16681. </member>
  16682. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte,System.Byte,System.Byte)">
  16683. <summary>
  16684. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  16685. </summary>
  16686. <param name="byteOffset">The byte offset.</param>
  16687. <param name="red">The red.</param>
  16688. <param name="green">The green.</param>
  16689. <param name="blue">The blue.</param>
  16690. </member>
  16691. <member name="P:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.Indexed">
  16692. <summary>
  16693. Gets index to the standard palette
  16694. </summary>
  16695. <value></value>
  16696. </member>
  16697. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetTriplet">
  16698. <summary>
  16699. Gets triplet representation like that in Excel
  16700. </summary>
  16701. <value></value>
  16702. </member>
  16703. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetHexString">
  16704. <summary>
  16705. Gets a hex string exactly like a gnumeric triplet
  16706. </summary>
  16707. <value></value>
  16708. </member>
  16709. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetGnumericPart(System.Byte)">
  16710. <summary>
  16711. Gets the gnumeric part.
  16712. </summary>
  16713. <param name="color">The color.</param>
  16714. <returns></returns>
  16715. </member>
  16716. <member name="T:NPOI.HSSF.UserModel.HSSFPatriarch">
  16717. <summary>
  16718. The patriarch is the toplevel container for shapes in a sheet. It does
  16719. little other than act as a container for other shapes and Groups.
  16720. @author Glen Stampoultzis (glens at apache.org)
  16721. </summary>
  16722. </member>
  16723. <member name="F:NPOI.HSSF.UserModel.HSSFPatriarch._boundAggregate">
  16724. The EscherAggregate we have been bound to.
  16725. (This will handle writing us out into records,
  16726. and building up our shapes from the records)
  16727. </member>
  16728. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.EscherAggregate)">
  16729. <summary>
  16730. Creates the patriarch.
  16731. </summary>
  16732. <param name="sheet">the sheet this patriarch is stored in.</param>
  16733. <param name="boundAggregate">The bound aggregate.</param>
  16734. </member>
  16735. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.PreSerialize">
  16736. check if any shapes contain wrong data
  16737. At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
  16738. </member>
  16739. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  16740. @param shape to be removed
  16741. @return true of shape is removed
  16742. </member>
  16743. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateGroup(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  16744. <summary>
  16745. Creates a new Group record stored Under this patriarch.
  16746. </summary>
  16747. <param name="anchor">the client anchor describes how this Group is attached
  16748. to the sheet.</param>
  16749. <returns>the newly created Group.</returns>
  16750. </member>
  16751. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateSimpleShape(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  16752. <summary>
  16753. Creates a simple shape. This includes such shapes as lines, rectangles,
  16754. and ovals.
  16755. Note: Microsoft Excel seems to sometimes disallow
  16756. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  16757. reverse them and draw shapes vertically or horizontally flipped!
  16758. </summary>
  16759. <param name="anchor">the client anchor describes how this Group is attached
  16760. to the sheet.</param>
  16761. <returns>the newly created shape.</returns>
  16762. </member>
  16763. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32)">
  16764. <summary>
  16765. Creates a picture.
  16766. </summary>
  16767. <param name="anchor">the client anchor describes how this Group is attached
  16768. to the sheet.</param>
  16769. <param name="pictureIndex">Index of the picture.</param>
  16770. <returns>the newly created shape.</returns>
  16771. </member>
  16772. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  16773. <summary>
  16774. CreatePicture
  16775. </summary>
  16776. <param name="anchor">the client anchor describes how this picture is attached to the sheet.</param>
  16777. <param name="pictureIndex">the index of the picture in the workbook collection of pictures.</param>
  16778. <returns>return newly created shape</returns>
  16779. </member>
  16780. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateObjectData(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32,System.Int32)">
  16781. Adds a new OLE Package Shape
  16782. @param anchor the client anchor describes how this picture is
  16783. attached to the sheet.
  16784. @param storageId the storageId returned by {@Link HSSFWorkbook.AddOlePackage}
  16785. @param pictureIndex the index of the picture (used as preview image) in the
  16786. workbook collection of pictures.
  16787. @return newly Created shape
  16788. </member>
  16789. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePolygon(NPOI.SS.UserModel.IClientAnchor)">
  16790. <summary>
  16791. Creates a polygon
  16792. </summary>
  16793. <param name="anchor">the client anchor describes how this Group is attached
  16794. to the sheet.</param>
  16795. <returns>the newly Created shape.</returns>
  16796. </member>
  16797. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  16798. <summary>
  16799. Constructs a textbox Under the patriarch.
  16800. </summary>
  16801. <param name="anchor">the client anchor describes how this Group is attached
  16802. to the sheet.</param>
  16803. <returns>the newly Created textbox.</returns>
  16804. </member>
  16805. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComment(NPOI.HSSF.UserModel.HSSFAnchor)">
  16806. Constructs a cell comment.
  16807. @param anchor the client anchor describes how this comment is attached
  16808. to the sheet.
  16809. @return the newly created comment.
  16810. </member>
  16811. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComboBox(NPOI.HSSF.UserModel.HSSFAnchor)">
  16812. YK: used to create autofilters
  16813. @see org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(int, int, int, int)
  16814. </member>
  16815. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  16816. <summary>
  16817. Constructs a cell comment.
  16818. </summary>
  16819. <param name="anchor">the client anchor describes how this comment is attached
  16820. to the sheet.</param>
  16821. <returns>the newly created comment.</returns>
  16822. </member>
  16823. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Children">
  16824. <summary>
  16825. Returns a list of all shapes contained by the patriarch.
  16826. </summary>
  16827. <value>The children.</value>
  16828. </member>
  16829. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  16830. add a shape to this drawing
  16831. </member>
  16832. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.CountOfAllChildren">
  16833. <summary>
  16834. Total count of all children and their children's children.
  16835. </summary>
  16836. <value>The count of all children.</value>
  16837. </member>
  16838. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  16839. <summary>
  16840. Sets the coordinate space of this Group. All children are contrained
  16841. to these coordinates.
  16842. </summary>
  16843. <param name="x1">The x1.</param>
  16844. <param name="y1">The y1.</param>
  16845. <param name="x2">The x2.</param>
  16846. <param name="y2">The y2.</param>
  16847. </member>
  16848. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.ContainsChart">
  16849. <summary>
  16850. Does this HSSFPatriarch contain a chart?
  16851. (Technically a reference to a chart, since they
  16852. Get stored in a different block of records)
  16853. FIXME - detect chart in all cases (only seems
  16854. to work on some charts so far)
  16855. </summary>
  16856. <returns>
  16857. <c>true</c> if this instance contains chart; otherwise, <c>false</c>.
  16858. </returns>
  16859. </member>
  16860. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X1">
  16861. <summary>
  16862. The top left x coordinate of this Group.
  16863. </summary>
  16864. <value>The x1.</value>
  16865. </member>
  16866. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y1">
  16867. <summary>
  16868. The top left y coordinate of this Group.
  16869. </summary>
  16870. <value>The y1.</value>
  16871. </member>
  16872. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X2">
  16873. <summary>
  16874. The bottom right x coordinate of this Group.
  16875. </summary>
  16876. <value>The x2.</value>
  16877. </member>
  16878. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y2">
  16879. <summary>
  16880. The bottom right y coordinate of this Group.
  16881. </summary>
  16882. <value>The y2.</value>
  16883. </member>
  16884. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.GetBoundAggregate">
  16885. <summary>
  16886. Returns the aggregate escher record we're bound to
  16887. </summary>
  16888. <returns></returns>
  16889. </member>
  16890. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  16891. Creates a new client anchor and sets the top-left and bottom-right
  16892. coordinates of the anchor.
  16893. @param dx1 the x coordinate in EMU within the first cell.
  16894. @param dy1 the y coordinate in EMU within the first cell.
  16895. @param dx2 the x coordinate in EMU within the second cell.
  16896. @param dy2 the y coordinate in EMU within the second cell.
  16897. @param col1 the column (0 based) of the first cell.
  16898. @param row1 the row (0 based) of the first cell.
  16899. @param col2 the column (0 based) of the second cell.
  16900. @param row2 the row (0 based) of the second cell.
  16901. @return the newly created client anchor
  16902. </member>
  16903. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.BuildShapeTree">
  16904. create shape tree from existing escher records tree
  16905. </member>
  16906. <member name="T:NPOI.HSSF.UserModel.HSSFPatternFormatting">
  16907. <summary>
  16908. High level representation for Conditional Formatting Settings
  16909. @author Dmitriy Kumshayev
  16910. </summary>
  16911. </member>
  16912. <member name="M:NPOI.HSSF.UserModel.HSSFPatternFormatting.#ctor(NPOI.HSSF.Record.CFRuleBase,NPOI.HSSF.UserModel.HSSFWorkbook)">
  16913. <summary>
  16914. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPatternFormatting"/> class.
  16915. </summary>
  16916. <param name="cfRuleRecord">The cf rule record.</param>
  16917. </member>
  16918. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.PatternFormattingBlock">
  16919. <summary>
  16920. Gets the pattern formatting block.
  16921. </summary>
  16922. <value>The pattern formatting block.</value>
  16923. </member>
  16924. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillBackgroundColor">
  16925. <summary>
  16926. Gets or sets the color of the fill background.
  16927. </summary>
  16928. <value>The color of the fill background.</value>
  16929. </member>
  16930. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillForegroundColor">
  16931. <summary>
  16932. Gets or sets the color of the fill foreground.
  16933. </summary>
  16934. <value>The color of the fill foreground.</value>
  16935. </member>
  16936. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillPattern">
  16937. <summary>
  16938. Gets or sets the fill pattern.
  16939. </summary>
  16940. <value>The fill pattern.</value>
  16941. </member>
  16942. <member name="T:NPOI.HSSF.UserModel.HSSFPicture">
  16943. <summary>
  16944. Represents a escher picture. Eg. A GIF, JPEG etc...
  16945. @author Glen Stampoultzis
  16946. @author Yegor Kozlov (yegor at apache.org)
  16947. </summary>
  16948. </member>
  16949. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  16950. <summary>
  16951. Constructs a picture object.
  16952. </summary>
  16953. <param name="parent">The parent.</param>
  16954. <param name="anchor">The anchor.</param>
  16955. </member>
  16956. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize">
  16957. <summary>
  16958. Reset the image to the dimension of the embedded image
  16959. </summary>
  16960. <remarks>
  16961. Please note, that this method works correctly only for workbooks
  16962. with default font size (Arial 10pt for .xls).
  16963. If the default font is changed the resized image can be streched vertically or horizontally.
  16964. </remarks>
  16965. </member>
  16966. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double)">
  16967. <summary>
  16968. Resize the image proportionally.
  16969. </summary>
  16970. <param name="scale">scale</param>
  16971. <seealso cref="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)"/>
  16972. </member>
  16973. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)">
  16974. Resize the image
  16975. <p>
  16976. Please note, that this method works correctly only for workbooks
  16977. with default font size (Arial 10pt for .xls).
  16978. If the default font is changed the resized image can be streched vertically or horizontally.
  16979. </p>
  16980. <p>
  16981. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  16982. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  16983. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  16984. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  16985. </p>
  16986. @param scaleX the amount by which the image width is multiplied relative to the original width.
  16987. @param scaleY the amount by which the image height is multiplied relative to the original height.
  16988. </member>
  16989. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureIndex">
  16990. <summary>
  16991. Gets or sets the index of the picture.
  16992. </summary>
  16993. <value>The index of the picture.</value>
  16994. </member>
  16995. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double)">
  16996. Calculate the preferred size for this picture.
  16997. @param scale the amount by which image dimensions are multiplied relative to the original size.
  16998. @return HSSFClientAnchor with the preferred size for this image
  16999. @since POI 3.0.2
  17000. </member>
  17001. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double,System.Double)">
  17002. <summary>
  17003. Calculate the preferred size for this picture.
  17004. </summary>
  17005. <param name="scaleX">the amount by which image width is multiplied relative to the original width.</param>
  17006. <param name="scaleY">the amount by which image height is multiplied relative to the original height.</param>
  17007. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  17008. </member>
  17009. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize">
  17010. <summary>
  17011. Calculate the preferred size for this picture.
  17012. </summary>
  17013. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  17014. </member>
  17015. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetResolution(System.Drawing.Image)">
  17016. <summary>
  17017. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  17018. Return the the "effective" dpi calculated as
  17019. <c>25.4/HorizontalPixelSize</c>
  17020. and
  17021. <c>25.4/VerticalPixelSize</c>
  17022. . Where 25.4 is the number of mm in inch.
  17023. </summary>
  17024. <param name="r">The image.</param>
  17025. <returns>the resolution</returns>
  17026. </member>
  17027. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetImageDimension">
  17028. <summary>
  17029. Return the dimension of the embedded image in pixel
  17030. </summary>
  17031. <returns>image dimension</returns>
  17032. </member>
  17033. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureData">
  17034. Return picture data for this shape
  17035. @return picture data for this shape
  17036. </member>
  17037. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.FileName">
  17038. The color applied to the lines of this shape.
  17039. </member>
  17040. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.ClientAnchor">
  17041. @return the anchor that is used by this picture.
  17042. </member>
  17043. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.Sheet">
  17044. @return the sheet which contains the picture shape
  17045. </member>
  17046. <member name="T:NPOI.HSSF.UserModel.HSSFPictureData">
  17047. <summary>
  17048. Represents binary data stored in the file. Eg. A GIF, JPEG etc...
  17049. @author Daniel Noll
  17050. </summary>
  17051. </member>
  17052. <member name="F:NPOI.HSSF.UserModel.HSSFPictureData.blip">
  17053. Underlying escher blip record containing the bitmap data.
  17054. </member>
  17055. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.#ctor(NPOI.DDF.EscherBlipRecord)">
  17056. <summary>
  17057. Constructs a picture object.
  17058. </summary>
  17059. <param name="blip">the underlying blip record containing the bitmap data.</param>
  17060. </member>
  17061. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Data">
  17062. <summary>
  17063. Gets the picture data.
  17064. </summary>
  17065. <value>the picture data.</value>
  17066. </member>
  17067. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Format">
  17068. <summary>
  17069. gets format of the picture.
  17070. </summary>
  17071. <value>The format.</value>
  17072. </member>
  17073. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.SuggestFileExtension">
  17074. <summary>
  17075. Suggests a file extension for this image.
  17076. </summary>
  17077. <returns>the file extension.</returns>
  17078. </member>
  17079. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.MimeType">
  17080. Returns the mime type for the image
  17081. </member>
  17082. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.PictureType">
  17083. @return the POI internal image type, -1 if not unknown image type
  17084. @see Workbook#PICTURE_TYPE_DIB
  17085. @see Workbook#PICTURE_TYPE_EMF
  17086. @see Workbook#PICTURE_TYPE_JPEG
  17087. @see Workbook#PICTURE_TYPE_PICT
  17088. @see Workbook#PICTURE_TYPE_PNG
  17089. @see Workbook#PICTURE_TYPE_WMF
  17090. </member>
  17091. <member name="T:NPOI.HSSF.UserModel.HSSFPolygon">
  17092. <summary>
  17093. @author Glen Stampoultzis (glens at baselinksoftware.com)
  17094. </summary>
  17095. </member>
  17096. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateSpContainer">
  17097. Generates the shape records for this shape.
  17098. </member>
  17099. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateObjRecord">
  17100. Creates the low level OBJ record for this shape.
  17101. </member>
  17102. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.XPoints">
  17103. @return array of x coordinates
  17104. </member>
  17105. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.YPoints">
  17106. @return array of y coordinates
  17107. </member>
  17108. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPoints(System.Int32[],System.Int32[])">
  17109. @param xPoints - array of x coordinates
  17110. @param yPoints - array of y coordinates
  17111. </member>
  17112. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPolygonDrawArea(System.Int32,System.Int32)">
  17113. Defines the width and height of the points in the polygon
  17114. @param width
  17115. @param height
  17116. </member>
  17117. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaWidth">
  17118. @return shape width
  17119. </member>
  17120. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaHeight">
  17121. @return shape height
  17122. </member>
  17123. <member name="T:NPOI.HSSF.UserModel.HSSFPrintSetup">
  17124. <summary>
  17125. Used to modify the print Setup.
  17126. @author Shawn Laubach (slaubach at apache dot org)
  17127. </summary>
  17128. </member>
  17129. <member name="M:NPOI.HSSF.UserModel.HSSFPrintSetup.#ctor(NPOI.HSSF.Record.PrintSetupRecord)">
  17130. <summary>
  17131. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPrintSetup"/> class.
  17132. </summary>
  17133. <param name="printSetupRecord">Takes the low level print Setup record.</param>
  17134. </member>
  17135. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PaperSize">
  17136. <summary>
  17137. Gets or sets the size of the paper.
  17138. </summary>
  17139. <value>The size of the paper.</value>
  17140. </member>
  17141. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Scale">
  17142. <summary>
  17143. Gets or sets the scale.
  17144. </summary>
  17145. <value>The scale.</value>
  17146. </member>
  17147. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PageStart">
  17148. <summary>
  17149. Gets or sets the page start.
  17150. </summary>
  17151. <value>The page start.</value>
  17152. </member>
  17153. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitWidth">
  17154. <summary>
  17155. Gets or sets the number of pages wide to fit sheet in.
  17156. </summary>
  17157. <value>the number of pages wide to fit sheet in</value>
  17158. </member>
  17159. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitHeight">
  17160. <summary>
  17161. Gets or sets number of pages high to fit the sheet in
  17162. </summary>
  17163. <value>number of pages high to fit the sheet in.</value>
  17164. </member>
  17165. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Options">
  17166. <summary>
  17167. Gets or sets the bit flags for the options.
  17168. </summary>
  17169. <value>the bit flags for the options.</value>
  17170. </member>
  17171. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.LeftToRight">
  17172. <summary>
  17173. Gets or sets the left to right print order.
  17174. </summary>
  17175. <value>the left to right print order.</value>
  17176. </member>
  17177. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Landscape">
  17178. <summary>
  17179. Gets or sets the landscape mode.
  17180. </summary>
  17181. <value>the landscape mode.</value>
  17182. </member>
  17183. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.ValidSettings">
  17184. <summary>
  17185. Gets or sets the valid Settings.
  17186. </summary>
  17187. <value>the valid Settings.</value>
  17188. </member>
  17189. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoColor">
  17190. <summary>
  17191. Gets or sets the black and white Setting.
  17192. </summary>
  17193. <value>black and white Setting</value>
  17194. </member>
  17195. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Draft">
  17196. <summary>
  17197. Gets or sets the draft mode.
  17198. </summary>
  17199. <value>the draft mode.</value>
  17200. </member>
  17201. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Notes">
  17202. <summary>
  17203. Gets or sets the print notes.
  17204. </summary>
  17205. <value>the print notes.</value>
  17206. </member>
  17207. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoOrientation">
  17208. <summary>
  17209. Gets or sets a value indicating whether [no orientation].
  17210. </summary>
  17211. <value><c>true</c> if [no orientation]; otherwise, <c>false</c>.</value>
  17212. </member>
  17213. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.UsePage">
  17214. <summary>
  17215. Gets or sets the use page numbers.
  17216. </summary>
  17217. <value>use page numbers. </value>
  17218. </member>
  17219. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HResolution">
  17220. <summary>
  17221. Gets or sets the horizontal resolution.
  17222. </summary>
  17223. <value>the horizontal resolution.</value>
  17224. </member>
  17225. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.VResolution">
  17226. <summary>
  17227. Gets or sets the vertical resolution.
  17228. </summary>
  17229. <value>the vertical resolution.</value>
  17230. </member>
  17231. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HeaderMargin">
  17232. <summary>
  17233. Gets or sets the header margin.
  17234. </summary>
  17235. <value>The header margin.</value>
  17236. </member>
  17237. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FooterMargin">
  17238. <summary>
  17239. Gets or sets the footer margin.
  17240. </summary>
  17241. <value>The footer margin.</value>
  17242. </member>
  17243. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Copies">
  17244. <summary>
  17245. Gets or sets the number of copies.
  17246. </summary>
  17247. <value>the number of copies.</value>
  17248. </member>
  17249. <member name="T:NPOI.HSSF.UserModel.HSSFRichTextString">
  17250. <summary>
  17251. Rich text Unicode string. These strings can have fonts applied to
  17252. arbitary parts of the string.
  17253. @author Glen Stampoultzis (glens at apache.org)
  17254. @author Jason Height (jheight at apache.org)
  17255. </summary>
  17256. </member>
  17257. <member name="F:NPOI.HSSF.UserModel.HSSFRichTextString.NO_FONT">
  17258. Place holder for indicating that NO_FONT has been applied here
  17259. </member>
  17260. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor">
  17261. <summary>
  17262. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  17263. </summary>
  17264. </member>
  17265. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(System.String)">
  17266. <summary>
  17267. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  17268. </summary>
  17269. <param name="str">The string.</param>
  17270. </member>
  17271. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  17272. <summary>
  17273. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  17274. </summary>
  17275. <param name="book">The workbook.</param>
  17276. <param name="record">The record.</param>
  17277. </member>
  17278. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.SetWorkbookReferences(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  17279. <summary>
  17280. This must be called to Setup the internal work book references whenever
  17281. a RichTextString Is Added to a cell
  17282. </summary>
  17283. <param name="book">The workbook.</param>
  17284. <param name="record">The record.</param>
  17285. </member>
  17286. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CloneStringIfRequired">
  17287. <summary>
  17288. Called whenever the Unicode string Is modified. When it Is modified
  17289. we need to Create a new SST index, so that other LabelSSTRecords will not
  17290. be affected by Changes tat we make to this string.
  17291. </summary>
  17292. <returns></returns>
  17293. </member>
  17294. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.AddToSSTIfRequired">
  17295. <summary>
  17296. Adds to SST if required.
  17297. </summary>
  17298. </member>
  17299. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  17300. <summary>
  17301. Applies a font to the specified Chars of a string.
  17302. </summary>
  17303. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  17304. <param name="endIndex">The end index to apply the font to (exclusive).</param>
  17305. <param name="fontIndex">The font to use.</param>
  17306. </member>
  17307. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  17308. <summary>
  17309. Applies a font to the specified Chars of a string.
  17310. </summary>
  17311. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  17312. <param name="endIndex"> The end index to apply to font to (exclusive).</param>
  17313. <param name="font">The index of the font to use.</param>
  17314. </member>
  17315. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  17316. <summary>
  17317. Sets the font of the entire string.
  17318. </summary>
  17319. <param name="font">The font to use.</param>
  17320. </member>
  17321. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ClearFormatting">
  17322. <summary>
  17323. Removes any formatting that may have been applied to the string.
  17324. </summary>
  17325. </member>
  17326. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.String">
  17327. <summary>
  17328. Returns the plain string representation.
  17329. </summary>
  17330. <value>The string.</value>
  17331. </member>
  17332. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.RawUnicodeString">
  17333. <summary>
  17334. Returns the raw, probably shared Unicode String.
  17335. Used when tweaking the styles, eg updating font
  17336. positions.
  17337. Changes to this string may well effect
  17338. other RichTextStrings too!
  17339. </summary>
  17340. <value>The raw unicode string.</value>
  17341. </member>
  17342. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.UnicodeString">
  17343. <summary>
  17344. Gets or sets the unicode string.
  17345. </summary>
  17346. <value>The unicode string.</value>
  17347. </member>
  17348. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.Length">
  17349. <summary>
  17350. Gets the number of Chars in the font..
  17351. </summary>
  17352. <value>The length.</value>
  17353. </member>
  17354. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontAtIndex(System.Int32)">
  17355. <summary>
  17356. Returns the font in use at a particular index.
  17357. </summary>
  17358. <param name="index">The index.</param>
  17359. <returns>The font that's currently being applied at that
  17360. index or null if no font Is being applied or the
  17361. index Is out of range.</returns>
  17362. </member>
  17363. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.NumFormattingRuns">
  17364. <summary>
  17365. Gets the number of formatting runs used. There will always be at
  17366. least one of font NO_FONT.
  17367. </summary>
  17368. <value>The num formatting runs.</value>
  17369. </member>
  17370. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  17371. <summary>
  17372. The index within the string to which the specified formatting run applies.
  17373. </summary>
  17374. <param name="index">the index of the formatting run</param>
  17375. <returns>the index within the string.</returns>
  17376. </member>
  17377. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  17378. <summary>
  17379. Gets the font used in a particular formatting run.
  17380. </summary>
  17381. <param name="index">the index of the formatting run.</param>
  17382. <returns>the font number used.</returns>
  17383. </member>
  17384. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CompareTo(NPOI.HSSF.UserModel.HSSFRichTextString)">
  17385. <summary>
  17386. Compares one rich text string to another.
  17387. </summary>
  17388. <param name="other">The other rich text string.</param>
  17389. <returns></returns>
  17390. </member>
  17391. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.Equals(System.Object)">
  17392. <summary>
  17393. Equalses the specified o.
  17394. </summary>
  17395. <param name="o">The o.</param>
  17396. <returns></returns>
  17397. </member>
  17398. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ToString">
  17399. <summary>
  17400. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  17401. </summary>
  17402. <returns>
  17403. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  17404. </returns>
  17405. </member>
  17406. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int16)">
  17407. <summary>
  17408. Applies the specified font to the entire string.
  17409. </summary>
  17410. <param name="fontIndex">Index of the font to apply.</param>
  17411. </member>
  17412. <member name="T:NPOI.HSSF.UserModel.HSSFRow">
  17413. <summary>
  17414. High level representation of a row of a spReadsheet.
  17415. Only rows that have cells should be Added to a Sheet.
  17416. @author Andrew C. Oliver (acoliver at apache dot org)
  17417. @author Glen Stampoultzis (glens at apache.org)
  17418. </summary>
  17419. </member>
  17420. <member name="F:NPOI.HSSF.UserModel.HSSFRow.INITIAL_CAPACITY">
  17421. <summary>
  17422. used for collections
  17423. </summary>
  17424. </member>
  17425. <member name="F:NPOI.HSSF.UserModel.HSSFRow.row">
  17426. reference to low level representation
  17427. </member>
  17428. <member name="F:NPOI.HSSF.UserModel.HSSFRow.book">
  17429. reference to containing low level Workbook
  17430. </member>
  17431. <member name="F:NPOI.HSSF.UserModel.HSSFRow.sheet">
  17432. reference to containing Sheet
  17433. </member>
  17434. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32)">
  17435. <summary>
  17436. Creates new HSSFRow from scratch. Only HSSFSheet should do this.
  17437. </summary>
  17438. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  17439. <param name="sheet">low-level Sheet object that Contains this Row</param>
  17440. <param name="rowNum">the row number of this row (0 based)</param>
  17441. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  17442. </member>
  17443. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.RowRecord)">
  17444. <summary>
  17445. Creates an HSSFRow from a low level RowRecord object. Only HSSFSheet should do
  17446. this. HSSFSheet uses this when an existing file is Read in.
  17447. </summary>
  17448. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  17449. <param name="sheet"> low-level Sheet object that Contains this Row</param>
  17450. <param name="record">the low level api object this row should represent</param>
  17451. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  17452. </member>
  17453. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32)">
  17454. <summary>
  17455. Use this to create new cells within the row and return it.
  17456. 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"/>).
  17457. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  17458. </summary>
  17459. <param name="column">the column number this cell represents</param>
  17460. <returns>a high level representation of the created cell.</returns>
  17461. </member>
  17462. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  17463. <summary>
  17464. Use this to create new cells within the row and return it.
  17465. The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
  17466. either through calling setCellValue or setCellType.
  17467. </summary>
  17468. <param name="columnIndex">the column number this cell represents</param>
  17469. <param name="type">a high level representation of the created cell.</param>
  17470. <returns></returns>
  17471. </member>
  17472. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  17473. <summary>
  17474. Remove the Cell from this row.
  17475. </summary>
  17476. <param name="cell">The cell to Remove.</param>
  17477. </member>
  17478. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell,System.Boolean)">
  17479. <summary>
  17480. Removes the cell.
  17481. </summary>
  17482. <param name="cell">The cell.</param>
  17483. <param name="alsoRemoveRecords">if set to <c>true</c> [also remove records].</param>
  17484. </member>
  17485. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewLastCellPlusOne(System.Int32)">
  17486. used internally to refresh the "last cell plus one" when the last cell is removed.
  17487. @return 0 when row contains no cells
  17488. </member>
  17489. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewFirstCell(System.Int32)">
  17490. used internally to refresh the "first cell" when the first cell is removed.
  17491. @return 0 when row contains no cells (also when first cell is occupied)
  17492. </member>
  17493. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCellFromRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  17494. <summary>
  17495. Create a high level Cell object from an existing low level record. Should
  17496. only be called from HSSFSheet or HSSFRow itself.
  17497. </summary>
  17498. <param name="cell">The low level cell to Create the high level representation from</param>
  17499. <returns> the low level record passed in</returns>
  17500. </member>
  17501. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsHidden">
  17502. <summary>
  17503. true, when the row is invisible. This is the case when the height is zero.
  17504. </summary>
  17505. </member>
  17506. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveAllCells">
  17507. <summary>
  17508. Removes all the cells from the row, and their
  17509. records too.
  17510. </summary>
  17511. </member>
  17512. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowNum">
  17513. <summary>
  17514. Get row number this row represents
  17515. </summary>
  17516. <value>the row number (0 based)</value>
  17517. </member>
  17518. <member name="P:NPOI.HSSF.UserModel.HSSFRow.OutlineLevel">
  17519. <summary>
  17520. Returns the rows outline level. Increased as you
  17521. put it into more Groups (outlines), reduced as
  17522. you take it out of them.
  17523. </summary>
  17524. <value>The outline level.</value>
  17525. </member>
  17526. <member name="M:NPOI.HSSF.UserModel.HSSFRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  17527. <summary>
  17528. Moves the supplied cell to a new column, which
  17529. must not already have a cell there!
  17530. </summary>
  17531. <param name="cell">The cell to move</param>
  17532. <param name="newColumn">The new column number (0 based)</param>
  17533. </member>
  17534. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Sheet">
  17535. Returns the HSSFSheet this row belongs to
  17536. @return the HSSFSheet that owns this row
  17537. </member>
  17538. <member name="M:NPOI.HSSF.UserModel.HSSFRow.AddCell(NPOI.SS.UserModel.ICell)">
  17539. <summary>
  17540. used internally to Add a cell.
  17541. </summary>
  17542. <param name="cell">The cell.</param>
  17543. </member>
  17544. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RetrieveCell(System.Int32)">
  17545. <summary>
  17546. Get the hssfcell representing a given column (logical cell)
  17547. 0-based. If you ask for a cell that is not defined, then
  17548. you Get a null.
  17549. This is the basic call, with no policies applied
  17550. </summary>
  17551. <param name="cellnum">0 based column number</param>
  17552. <returns>Cell representing that column or null if Undefined.</returns>
  17553. </member>
  17554. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32)">
  17555. <summary>
  17556. Get the hssfcell representing a given column (logical cell)
  17557. 0-based. If you ask for a cell that is not defined then
  17558. you get a null, unless you have set a different
  17559. MissingCellPolicy on the base workbook.
  17560. </summary>
  17561. <param name="cellnum">0 based column number</param>
  17562. <returns>Cell representing that column or null if undefined.</returns>
  17563. </member>
  17564. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  17565. <summary>
  17566. Get the hssfcell representing a given column (logical cell)
  17567. 0-based. If you ask for a cell that is not defined, then
  17568. your supplied policy says what to do
  17569. </summary>
  17570. <param name="cellnum">0 based column number</param>
  17571. <param name="policy">Policy on blank / missing cells</param>
  17572. <returns>that column or null if Undefined + policy allows.</returns>
  17573. </member>
  17574. <member name="P:NPOI.HSSF.UserModel.HSSFRow.FirstCellNum">
  17575. <summary>
  17576. Get the number of the first cell contained in this row.
  17577. </summary>
  17578. <value>the first logical cell in the row, or -1 if the row does not contain any cells.</value>
  17579. </member>
  17580. <member name="P:NPOI.HSSF.UserModel.HSSFRow.LastCellNum">
  17581. <summary>
  17582. Gets the index of the last cell contained in this row PLUS ONE
  17583. . The result also happens to be the 1-based column number of the last cell. This value can be used as a
  17584. standard upper bound when iterating over cells:
  17585. </summary>
  17586. <value>
  17587. short representing the last logical cell in the row PLUS ONE, or -1 if the
  17588. row does not contain any cells.
  17589. </value>
  17590. <example>
  17591. short minColIx = row.GetFirstCellNum();
  17592. short maxColIx = row.GetLastCellNum();
  17593. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  17594. Cell cell = row.GetCell(colIx);
  17595. if(cell == null) {
  17596. continue;
  17597. }
  17598. //... do something with cell
  17599. }
  17600. </example>
  17601. </member>
  17602. <member name="P:NPOI.HSSF.UserModel.HSSFRow.PhysicalNumberOfCells">
  17603. <summary>
  17604. Gets the number of defined cells (NOT number of cells in the actual row!).
  17605. That is to say if only columns 0,4,5 have values then there would be 3.
  17606. </summary>
  17607. <value>the number of defined cells in the row.</value>
  17608. </member>
  17609. <member name="P:NPOI.HSSF.UserModel.HSSFRow.ZeroHeight">
  17610. <summary>
  17611. Gets or sets whether or not to Display this row with 0 height
  17612. </summary>
  17613. <value>height is zero or not.</value>
  17614. </member>
  17615. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Height">
  17616. <summary>
  17617. Get or sets the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
  17618. </summary>
  17619. <value>rowheight or 0xff for Undefined (use sheet default)</value>
  17620. </member>
  17621. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsFormatted">
  17622. <summary>
  17623. is this row formatted? Most aren't, but some rows
  17624. do have whole-row styles. For those that do, you
  17625. can get the formatting from {@link #getRowStyle()}
  17626. </summary>
  17627. <value>
  17628. <c>true</c> if this instance is formatted; otherwise, <c>false</c>.
  17629. </value>
  17630. </member>
  17631. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowStyle">
  17632. <summary>
  17633. Returns the whole-row cell styles. Most rows won't
  17634. have one of these, so will return null. Call IsFormmated to check first
  17635. </summary>
  17636. <value>The row style.</value>
  17637. </member>
  17638. <member name="P:NPOI.HSSF.UserModel.HSSFRow.HeightInPoints">
  17639. <summary>
  17640. Get the row's height or ff (-1) for Undefined/default-height in points (20*Height)
  17641. </summary>
  17642. <value>row height or 0xff for Undefined (use sheet default).</value>
  17643. </member>
  17644. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowRecord">
  17645. <summary>
  17646. Get the lowlevel RowRecord represented by this object - should only be called
  17647. by other parts of the high level API
  17648. </summary>
  17649. <value>RowRecord this row represents</value>
  17650. </member>
  17651. <member name="M:NPOI.HSSF.UserModel.HSSFRow.FindFirstCell(System.Int32)">
  17652. <summary>
  17653. used internally to refresh the "first cell" when the first cell is Removed.
  17654. </summary>
  17655. <param name="firstcell">The first cell index.</param>
  17656. <returns></returns>
  17657. </member>
  17658. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Cells">
  17659. <summary>
  17660. Get cells in the row (existing cells only, no blanks)
  17661. </summary>
  17662. </member>
  17663. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetEnumerator">
  17664. <summary>
  17665. Gets the cell enumerator of the physically defined cells.
  17666. </summary>
  17667. <remarks>
  17668. Note that the 4th element might well not be cell 4, as the iterator
  17669. will not return Un-defined (null) cells.
  17670. Call CellNum on the returned cells to know which cell they are.
  17671. </remarks>
  17672. </member>
  17673. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CompareTo(NPOI.HSSF.UserModel.HSSFRow)">
  17674. <summary>
  17675. 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.
  17676. </summary>
  17677. <param name="other">An object to compare with this instance.</param>
  17678. <returns>
  17679. A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
  17680. Value
  17681. Meaning
  17682. Less than zero
  17683. This instance is less than <paramref name="other"/>.
  17684. Zero
  17685. This instance is equal to <paramref name="other"/>.
  17686. Greater than zero
  17687. This instance is greater than <paramref name="other"/>.
  17688. </returns>
  17689. <exception cref="T:System.ArgumentException">
  17690. <paramref name="other"/> is not the same type as this instance.
  17691. </exception>
  17692. </member>
  17693. <member name="M:NPOI.HSSF.UserModel.HSSFRow.Equals(System.Object)">
  17694. <summary>
  17695. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  17696. </summary>
  17697. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  17698. <returns>
  17699. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  17700. </returns>
  17701. <exception cref="T:System.NullReferenceException">
  17702. The <paramref name="obj"/> parameter is null.
  17703. </exception>
  17704. </member>
  17705. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetHashCode">
  17706. <summary>
  17707. Returns a hash code. In this case it is the number of the row.
  17708. </summary>
  17709. </member>
  17710. <member name="T:NPOI.HSSF.UserModel.HSSFShape">
  17711. <summary>
  17712. An abstract shape.
  17713. Note: Microsoft Excel seems to sometimes disallow
  17714. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  17715. reverse them and draw shapes vertically or horizontally flipped!
  17716. </summary>
  17717. </member>
  17718. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.ObjRecord)">
  17719. creates shapes from existing file
  17720. @param spContainer
  17721. @param objRecord
  17722. </member>
  17723. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  17724. <summary>
  17725. Create a new shape with the specified parent and anchor.
  17726. </summary>
  17727. <param name="parent">The parent.</param>
  17728. <param name="anchor">The anchor.</param>
  17729. </member>
  17730. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Parent">
  17731. <summary>
  17732. Gets the parent shape.
  17733. </summary>
  17734. <value>The parent.</value>
  17735. </member>
  17736. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Anchor">
  17737. <summary>
  17738. Gets or sets the anchor that is used by this shape.
  17739. </summary>
  17740. <value>The anchor.</value>
  17741. </member>
  17742. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyleColor">
  17743. <summary>
  17744. The color applied to the lines of this shape.
  17745. </summary>
  17746. <value>The color of the line style.</value>
  17747. </member>
  17748. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  17749. <summary>
  17750. Sets the color applied to the lines of this shape
  17751. </summary>
  17752. <param name="red">The red.</param>
  17753. <param name="green">The green.</param>
  17754. <param name="blue">The blue.</param>
  17755. </member>
  17756. <member name="P:NPOI.HSSF.UserModel.HSSFShape.FillColor">
  17757. <summary>
  17758. Gets or sets the color used to fill this shape.
  17759. </summary>
  17760. <value>The color of the fill.</value>
  17761. </member>
  17762. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  17763. <summary>
  17764. Sets the color used to fill this shape.
  17765. </summary>
  17766. <param name="red">The red.</param>
  17767. <param name="green">The green.</param>
  17768. <param name="blue">The blue.</param>
  17769. </member>
  17770. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineWidth">
  17771. <summary>
  17772. Gets or sets with width of the line in EMUs. 12700 = 1 pt.
  17773. </summary>
  17774. <value>The width of the line.</value>
  17775. </member>
  17776. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyle">
  17777. <summary>
  17778. Gets or sets One of the constants in LINESTYLE_*
  17779. </summary>
  17780. <value>The line style.</value>
  17781. </member>
  17782. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsNoFill">
  17783. <summary>
  17784. Gets or sets a value indicating whether this instance is no fill.
  17785. </summary>
  17786. <value>
  17787. <c>true</c> if this shape Is not filled with a color; otherwise, <c>false</c>.
  17788. </value>
  17789. </member>
  17790. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipVertical">
  17791. <summary>
  17792. whether this shape is vertically flipped.
  17793. </summary>
  17794. </member>
  17795. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipHorizontal">
  17796. <summary>
  17797. whether this shape is horizontally flipped.
  17798. </summary>
  17799. </member>
  17800. <member name="P:NPOI.HSSF.UserModel.HSSFShape.RotationDegree">
  17801. <summary>
  17802. get or set the rotation, in degrees, that is applied to a shape.
  17803. Negative values specify rotation in the counterclockwise direction.
  17804. Rotation occurs around the center of the shape.
  17805. The default value for this property is 0x00000000
  17806. </summary>
  17807. </member>
  17808. <member name="P:NPOI.HSSF.UserModel.HSSFShape.CountOfAllChildren">
  17809. <summary>
  17810. Count of all children and their childrens children.
  17811. </summary>
  17812. <value>The count of all children.</value>
  17813. </member>
  17814. <member name="T:NPOI.HSSF.UserModel.HSSFShapeContainer">
  17815. <summary>
  17816. An interface that indicates whether a class can contain children.
  17817. @author Glen Stampoultzis (glens at apache.org)
  17818. </summary>
  17819. </member>
  17820. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Children">
  17821. <summary>
  17822. Gets Any children contained by this shape.
  17823. </summary>
  17824. <value>The children.</value>
  17825. </member>
  17826. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  17827. <summary>
  17828. dd shape to the list of child records
  17829. </summary>
  17830. <param name="shape">shape</param>
  17831. </member>
  17832. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  17833. <summary>
  17834. set coordinates of this group relative to the parent
  17835. </summary>
  17836. <param name="x1">x1</param>
  17837. <param name="y1">y1</param>
  17838. <param name="x2">x2</param>
  17839. <param name="y2">y2</param>
  17840. </member>
  17841. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X1">
  17842. <summary>
  17843. Get the top left x coordinate of this group.
  17844. </summary>
  17845. </member>
  17846. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y1">
  17847. <summary>
  17848. Get the top left y coordinate of this group.
  17849. </summary>
  17850. </member>
  17851. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X2">
  17852. <summary>
  17853. Get the bottom right x coordinate of this group.
  17854. </summary>
  17855. </member>
  17856. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y2">
  17857. <summary>
  17858. Get the bottom right y coordinate of this group.
  17859. </summary>
  17860. </member>
  17861. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  17862. remove first level shapes
  17863. @param shape to be removed
  17864. @return true if shape is removed else return false
  17865. </member>
  17866. <member name="T:NPOI.HSSF.UserModel.HSSFShapeGroup">
  17867. <summary>
  17868. A shape Group may contain other shapes. It was no actual form on the
  17869. sheet.
  17870. @author Glen Stampoultzis (glens at apache.org)
  17871. </summary>
  17872. </member>
  17873. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateGroup(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  17874. <summary>
  17875. Create another Group Under this Group.
  17876. </summary>
  17877. <param name="anchor">the position of the new Group.</param>
  17878. <returns>the Group</returns>
  17879. </member>
  17880. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateShape(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  17881. <summary>
  17882. Create a new simple shape Under this Group.
  17883. </summary>
  17884. <param name="anchor">the position of the shape.</param>
  17885. <returns>the shape</returns>
  17886. </member>
  17887. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateTextbox(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  17888. <summary>
  17889. Create a new textbox Under this Group.
  17890. </summary>
  17891. <param name="anchor">the position of the shape.</param>
  17892. <returns>the textbox</returns>
  17893. </member>
  17894. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePolygon(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  17895. <summary>
  17896. Creates a polygon
  17897. </summary>
  17898. <param name="anchor">the client anchor describes how this Group Is attached
  17899. to the sheet.</param>
  17900. <returns>the newly Created shape.</returns>
  17901. </member>
  17902. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePicture(NPOI.HSSF.UserModel.HSSFChildAnchor,System.Int32)">
  17903. <summary>
  17904. Creates a picture.
  17905. </summary>
  17906. <param name="anchor">the client anchor describes how this Group Is attached
  17907. to the sheet.</param>
  17908. <param name="pictureIndex">Index of the picture.</param>
  17909. <returns>the newly Created shape.</returns>
  17910. </member>
  17911. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Children">
  17912. <summary>
  17913. Return all children contained by this shape.
  17914. </summary>
  17915. <value></value>
  17916. </member>
  17917. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  17918. <summary>
  17919. Sets the coordinate space of this Group. All children are constrained
  17920. to these coordinates.
  17921. </summary>
  17922. <param name="x1">The x1.</param>
  17923. <param name="y1">The y1.</param>
  17924. <param name="x2">The x2.</param>
  17925. <param name="y2">The y2.</param>
  17926. </member>
  17927. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X1">
  17928. <summary>
  17929. Gets The top left x coordinate of this Group.
  17930. </summary>
  17931. <value>The x1.</value>
  17932. </member>
  17933. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y1">
  17934. <summary>
  17935. Gets The top left y coordinate of this Group.
  17936. </summary>
  17937. <value>The y1.</value>
  17938. </member>
  17939. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X2">
  17940. <summary>
  17941. Gets The bottom right x coordinate of this Group.
  17942. </summary>
  17943. <value>The x2.</value>
  17944. </member>
  17945. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y2">
  17946. <summary>
  17947. Gets the bottom right y coordinate of this Group.
  17948. </summary>
  17949. <value>The y2.</value>
  17950. </member>
  17951. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.CountOfAllChildren">
  17952. <summary>
  17953. Count of all children and their childrens children.
  17954. </summary>
  17955. <value></value>
  17956. </member>
  17957. <member name="T:NPOI.HSSF.UserModel.HSSFSheet">
  17958. <summary>
  17959. High level representation of a worksheet.
  17960. </summary>
  17961. <remarks>
  17962. @author Andrew C. Oliver (acoliver at apache dot org)
  17963. @author Glen Stampoultzis (glens at apache.org)
  17964. @author Libin Roman (romal at vistaportal.com)
  17965. @author Shawn Laubach (slaubach at apache dot org) (Just a little)
  17966. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little, too)
  17967. @author Yegor Kozlov (yegor at apache.org) (Autosizing columns)
  17968. </remarks>
  17969. </member>
  17970. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_DEFAULT">
  17971. width of 1px in columns with default width in units of 1/256 of a character width
  17972. </member>
  17973. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_MODIFIED">
  17974. width of 1px in columns with overridden width in units of 1/256 of a character width
  17975. </member>
  17976. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.INITIAL_CAPACITY">
  17977. Used for compile-time optimization. This is the initial size for the collection of
  17978. rows. It is currently Set to 20. If you generate larger sheets you may benefit
  17979. by Setting this to a higher number and recompiling a custom edition of HSSFSheet.
  17980. </member>
  17981. <member name="F:NPOI.HSSF.UserModel.HSSFSheet._sheet">
  17982. reference to the low level Sheet object
  17983. </member>
  17984. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  17985. <summary>
  17986. Creates new HSSFSheet - called by HSSFWorkbook to create a _sheet from
  17987. scratch. You should not be calling this from application code (its protected anyhow).
  17988. </summary>
  17989. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  17990. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet"/>
  17991. </member>
  17992. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Model.InternalSheet)">
  17993. <summary>
  17994. Creates an HSSFSheet representing the given Sheet object. Should only be
  17995. called by HSSFWorkbook when reading in an exisiting file.
  17996. </summary>
  17997. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  17998. <param name="sheet">lowlevel Sheet object this _sheet will represent</param>
  17999. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)"/>
  18000. </member>
  18001. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CloneSheet(NPOI.HSSF.UserModel.HSSFWorkbook)">
  18002. <summary>
  18003. Clones the _sheet.
  18004. </summary>
  18005. <param name="workbook">The _workbook.</param>
  18006. <returns>the cloned sheet</returns>
  18007. </member>
  18008. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CopyRow(System.Int32,System.Int32)">
  18009. <summary>
  18010. Copy one row to the target row
  18011. </summary>
  18012. <param name="sourceIndex">index of the source row</param>
  18013. <param name="targetIndex">index of the target row</param>
  18014. </member>
  18015. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetPropertiesFromSheet(NPOI.HSSF.Model.InternalSheet)">
  18016. <summary>
  18017. used internally to Set the properties given a Sheet object
  18018. </summary>
  18019. <param name="sheet">The _sheet.</param>
  18020. </member>
  18021. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayZeros">
  18022. Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
  18023. When false, cells with zero value appear blank instead of showing the number zero.
  18024. In Excel 2003 this option can be changed in the Options dialog on the View tab.
  18025. @return whether all zero values on the worksheet are displayed
  18026. </member>
  18027. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)">
  18028. <summary>
  18029. Create a new row within the _sheet and return the high level representation
  18030. </summary>
  18031. <param name="rownum">The row number.</param>
  18032. <returns></returns>
  18033. @see org.apache.poi.hssf.usermodel.HSSFRow
  18034. @see #RemoveRow(HSSFRow)
  18035. </member>
  18036. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRowFromRecord(NPOI.HSSF.Record.RowRecord)">
  18037. <summary>
  18038. Used internally to Create a high level Row object from a low level row object.
  18039. USed when Reading an existing file
  18040. </summary>
  18041. <param name="row">low level record to represent as a high level Row and Add to _sheet.</param>
  18042. <returns>HSSFRow high level representation</returns>
  18043. </member>
  18044. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  18045. <summary>
  18046. Remove a row from this _sheet. All cells contained in the row are Removed as well
  18047. </summary>
  18048. <param name="row">the row to Remove.</param>
  18049. </member>
  18050. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindLastRow(System.Int32)">
  18051. <summary>
  18052. used internally to refresh the "last row" when the last row is Removed.
  18053. </summary>
  18054. <param name="lastrow">The last row.</param>
  18055. <returns></returns>
  18056. </member>
  18057. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindFirstRow(System.Int32)">
  18058. <summary>
  18059. used internally to refresh the "first row" when the first row is Removed.
  18060. </summary>
  18061. <param name="firstrow">The first row.</param>
  18062. <returns></returns>
  18063. </member>
  18064. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddRow(NPOI.HSSF.UserModel.HSSFRow,System.Boolean)">
  18065. Add a row to the _sheet
  18066. @param AddLow whether to Add the row to the low level model - false if its already there
  18067. </member>
  18068. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnStyle(System.Int32)">
  18069. <summary>
  18070. Returns the HSSFCellStyle that applies to the given
  18071. (0 based) column, or null if no style has been
  18072. set for that column
  18073. </summary>
  18074. <param name="column">The column.</param>
  18075. <returns></returns>
  18076. </member>
  18077. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRow(System.Int32)">
  18078. <summary>
  18079. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  18080. defined you get a null. This is to say row 4 represents the fifth row on a _sheet.
  18081. </summary>
  18082. <param name="rowIndex">Index of the row to get.</param>
  18083. <returns>the row number or null if its not defined on the _sheet</returns>
  18084. </member>
  18085. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PhysicalNumberOfRows">
  18086. <summary>
  18087. Returns the number of phsyically defined rows (NOT the number of rows in the _sheet)
  18088. </summary>
  18089. <value>The physical number of rows.</value>
  18090. </member>
  18091. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FirstRowNum">
  18092. <summary>
  18093. Gets the first row on the _sheet
  18094. </summary>
  18095. <value>the number of the first logical row on the _sheet</value>
  18096. </member>
  18097. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LastRowNum">
  18098. <summary>
  18099. Gets the last row on the _sheet
  18100. </summary>
  18101. <value>last row contained n this _sheet.</value>
  18102. </member>
  18103. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  18104. <summary>
  18105. Creates a data validation object
  18106. </summary>
  18107. <param name="dataValidation">The data validation object settings</param>
  18108. </member>
  18109. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  18110. <summary>
  18111. Get the visibility state for a given column.F:\Gloria\�о�\�ļ���ʽ\NPOI\src\NPOI\HSSF\Util\HSSFDataValidation.cs
  18112. </summary>
  18113. <param name="column">the column to Get (0-based).</param>
  18114. <param name="hidden">the visiblity state of the column.</param>
  18115. </member>
  18116. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnHidden(System.Int32)">
  18117. <summary>
  18118. Get the hidden state for a given column.
  18119. </summary>
  18120. <param name="column">the column to Set (0-based)</param>
  18121. <returns>the visiblity state of the column;
  18122. </returns>
  18123. </member>
  18124. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  18125. <summary>
  18126. Set the width (in Units of 1/256th of a Char width)
  18127. </summary>
  18128. <param name="column">the column to Set (0-based)</param>
  18129. <param name="width">the width in Units of 1/256th of a Char width</param>
  18130. </member>
  18131. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnWidth(System.Int32)">
  18132. <summary>
  18133. Get the width (in Units of 1/256th of a Char width )
  18134. </summary>
  18135. <param name="column">the column to Set (0-based)</param>
  18136. <returns>the width in Units of 1/256th of a Char width</returns>
  18137. </member>
  18138. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultColumnWidth">
  18139. <summary>
  18140. Gets or sets the default width of the column.
  18141. </summary>
  18142. <value>The default width of the column.</value>
  18143. </member>
  18144. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeight">
  18145. <summary>
  18146. Get the default row height for the _sheet (if the rows do not define their own height) in
  18147. twips (1/20 of a point)
  18148. </summary>
  18149. <value>The default height of the row.</value>
  18150. </member>
  18151. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeightInPoints">
  18152. <summary>
  18153. Get the default row height for the _sheet (if the rows do not define their own height) in
  18154. points.
  18155. </summary>
  18156. <value>The default row height in points.</value>
  18157. </member>
  18158. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsGridsPrinted">
  18159. <summary>
  18160. Get whether gridlines are printed.
  18161. </summary>
  18162. <value>
  18163. <c>true</c> if printed; otherwise, <c>false</c>.
  18164. </value>
  18165. </member>
  18166. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  18167. <summary>
  18168. Adds a merged region of cells on a sheet.
  18169. </summary>
  18170. <param name="region">region to merge</param>
  18171. <returns>index of this region</returns>
  18172. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  18173. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  18174. or multi-cell array formula on this sheet</exception>
  18175. </member>
  18176. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  18177. <summary>
  18178. Adds a merged region of cells (hence those cells form one).
  18179. Skips validation. It is possible to create overlapping merged regions
  18180. or create a merged region that intersects a multi-cell array formula
  18181. with this formula, which may result in a corrupt workbook.
  18182. To check for merged regions overlapping array formulas or other merged regions
  18183. after addMergedRegionUnsafe has been called, call {@link #validateMergedRegions()}, which runs in O(n^2) time.
  18184. </summary>
  18185. <param name="region">region to merge</param>
  18186. <returns>index of this region</returns>
  18187. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  18188. </member>
  18189. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateMergedRegions">
  18190. <summary>
  18191. Verify that merged regions do not intersect multi-cell array formulas and
  18192. no merged regions intersect another merged region in this sheet.
  18193. </summary>
  18194. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  18195. or multi-cell array formula on this sheet</exception>
  18196. </member>
  18197. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress,System.Boolean)">
  18198. <summary>
  18199. adds a merged region of cells (hence those cells form one)
  18200. </summary>
  18201. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  18202. <param name="validate">whether to validate merged region</param>
  18203. <returns>index of this region</returns>
  18204. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  18205. <exception cref="T:System.InvalidOperationException">if region intersects with an existing merged region
  18206. or multi-cell array formula on this sheet</exception>
  18207. </member>
  18208. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CheckForMergedRegionsIntersectingArrayFormulas">
  18209. <summary>
  18210. Verify that none of the merged regions intersect a multi-cell array formula in this sheet
  18211. </summary>
  18212. <exception cref="!:NPOI.Util.InvalidOperationException">if candidate region intersects an existing array formula in this sheet</exception>
  18213. </member>
  18214. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CheckForIntersectingMergedRegions">
  18215. <summary>
  18216. Verify that no merged regions intersect another merged region in this sheet.
  18217. </summary>
  18218. <exception cref="T:System.InvalidOperationException">if at least one region intersects with another merged region in this sheet</exception>
  18219. </member>
  18220. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ForceFormulaRecalculation">
  18221. <summary>
  18222. Whether a record must be Inserted or not at generation to indicate that
  18223. formula must be recalculated when _workbook is opened.
  18224. </summary>
  18225. <value>
  18226. <c>true</c> if [force formula recalculation]; otherwise, <c>false</c>.
  18227. </value>
  18228. @return true if an Uncalced record must be Inserted or not at generation
  18229. </member>
  18230. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.VerticallyCenter">
  18231. <summary>
  18232. Determine whether printed output for this _sheet will be vertically centered.
  18233. </summary>
  18234. <value><c>true</c> if [vertically center]; otherwise, <c>false</c>.</value>
  18235. </member>
  18236. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.HorizontallyCenter">
  18237. <summary>
  18238. Determine whether printed output for this _sheet will be horizontally centered.
  18239. </summary>
  18240. <value><c>true</c> if [horizontally center]; otherwise, <c>false</c>.</value>
  18241. </member>
  18242. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegion(System.Int32)">
  18243. <summary>
  18244. Removes a merged region of cells (hence letting them free)
  18245. </summary>
  18246. <param name="index">index of the region to Unmerge</param>
  18247. </member>
  18248. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  18249. <summary>
  18250. Removes a number of merged regions of cells (hence letting them free)
  18251. </summary>
  18252. <param name="indices">A set of the regions to unmerge</param>
  18253. </member>
  18254. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.NumMergedRegions">
  18255. <summary>
  18256. returns the number of merged regions
  18257. </summary>
  18258. <value>The number of merged regions</value>
  18259. </member>
  18260. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRowEnumerator">
  18261. <summary>
  18262. Gets the row enumerator.
  18263. </summary>
  18264. <returns>
  18265. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  18266. be the third row if say for instance the second row is undefined.
  18267. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  18268. if you care which one it is.
  18269. </returns>
  18270. </member>
  18271. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetEnumerator">
  18272. <summary>
  18273. Alias for GetRowEnumerator() to allow <c>foreach</c> loops.
  18274. </summary>
  18275. <returns>
  18276. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  18277. be the third row if say for instance the second row is undefined.
  18278. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  18279. if you care which one it is.
  18280. </returns>
  18281. </member>
  18282. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Sheet">
  18283. <summary>
  18284. used internally in the API to Get the low level Sheet record represented by this
  18285. Object.
  18286. </summary>
  18287. <value>low level representation of this HSSFSheet.</value>
  18288. </member>
  18289. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCell(System.Int32,System.Int32)">
  18290. <summary>
  18291. Sets the active cell.
  18292. </summary>
  18293. <param name="row">The row.</param>
  18294. <param name="column">The column.</param>
  18295. </member>
  18296. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  18297. <summary>
  18298. Sets the active cell range.
  18299. </summary>
  18300. <param name="firstRow">The first row.</param>
  18301. <param name="lastRow">The last row.</param>
  18302. <param name="firstColumn">The first column.</param>
  18303. <param name="lastColumn">The last column.</param>
  18304. </member>
  18305. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  18306. <summary>
  18307. Sets the active cell range.
  18308. </summary>
  18309. <param name="cellranges">The cellranges.</param>
  18310. <param name="activeRange">The index of the active range.</param>
  18311. <param name="activeRow">The active row in the active range</param>
  18312. <param name="activeColumn">The active column in the active range</param>
  18313. </member>
  18314. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeExpression">
  18315. <summary>
  18316. Gets or sets whether alternate expression evaluation is on
  18317. </summary>
  18318. <value>
  18319. <c>true</c> if [alternative expression]; otherwise, <c>false</c>.
  18320. </value>
  18321. </member>
  18322. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeFormula">
  18323. <summary>
  18324. whether alternative formula entry is on
  18325. </summary>
  18326. <value><c>true</c> alternative formulas or not; otherwise, <c>false</c>.</value>
  18327. </member>
  18328. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Autobreaks">
  18329. <summary>
  18330. show automatic page breaks or not
  18331. </summary>
  18332. <value>whether to show auto page breaks</value>
  18333. </member>
  18334. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Dialog">
  18335. <summary>
  18336. Gets or sets a value indicating whether _sheet is a dialog _sheet
  18337. </summary>
  18338. <value><c>true</c> if is dialog; otherwise, <c>false</c>.</value>
  18339. </member>
  18340. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGuts">
  18341. <summary>
  18342. Gets or sets a value indicating whether to Display the guts or not.
  18343. </summary>
  18344. <value><c>true</c> if guts or no guts (or glory); otherwise, <c>false</c>.</value>
  18345. </member>
  18346. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FitToPage">
  18347. <summary>
  18348. Gets or sets a value indicating whether fit to page option is on
  18349. </summary>
  18350. <value><c>true</c> if [fit to page]; otherwise, <c>false</c>.</value>
  18351. </member>
  18352. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsBelow">
  18353. <summary>
  18354. Get if row summaries appear below detail in the outline
  18355. </summary>
  18356. <value><c>true</c> if below or not; otherwise, <c>false</c>.</value>
  18357. </member>
  18358. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsRight">
  18359. <summary>
  18360. Get if col summaries appear right of the detail in the outline
  18361. </summary>
  18362. <value><c>true</c> right or not; otherwise, <c>false</c>.</value>
  18363. </member>
  18364. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintGridlines">
  18365. <summary>
  18366. Gets or sets whether gridlines are printed.
  18367. </summary>
  18368. <value>
  18369. <c>true</c> Gridlines are printed; otherwise, <c>false</c>.
  18370. </value>
  18371. </member>
  18372. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintRowAndColumnHeadings">
  18373. <summary>
  18374. get or set whether row and column headings are printed.
  18375. </summary>
  18376. <value>row and column headings are printed</value>
  18377. </member>
  18378. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PrintSetup">
  18379. <summary>
  18380. Gets the print setup object.
  18381. </summary>
  18382. <value>The user model for the print setup object.</value>
  18383. </member>
  18384. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Header">
  18385. <summary>
  18386. Gets the user model for the document header.
  18387. </summary>
  18388. <value>The Document header.</value>
  18389. </member>
  18390. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Footer">
  18391. <summary>
  18392. Gets the user model for the document footer.
  18393. </summary>
  18394. <value>The Document footer.</value>
  18395. </member>
  18396. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsRightToLeft">
  18397. <summary>
  18398. Gets or sets whether the worksheet is displayed from right to left instead of from left to right.
  18399. </summary>
  18400. <value>true for right to left, false otherwise</value>
  18401. <remarks>poi bug 47970</remarks>
  18402. </member>
  18403. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsSelected">
  18404. <summary>
  18405. Note - this is not the same as whether the _sheet is focused (isActive)
  18406. </summary>
  18407. <value>
  18408. <c>true</c> if this _sheet is currently selected; otherwise, <c>false</c>.
  18409. </value>
  18410. </member>
  18411. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsActive">
  18412. <summary>
  18413. Gets or sets a value indicating if this _sheet is currently focused.
  18414. </summary>
  18415. <value><c>true</c> if this _sheet is currently focused; otherwise, <c>false</c>.</value>
  18416. </member>
  18417. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActive(System.Boolean)">
  18418. <summary>
  18419. Sets whether sheet is selected.
  18420. </summary>
  18421. <param name="sel">Whether to select the sheet or deselect the sheet.</param>
  18422. </member>
  18423. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Protect">
  18424. <summary>
  18425. Answer whether protection is enabled or disabled
  18426. </summary>
  18427. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  18428. </member>
  18429. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Password">
  18430. <summary>
  18431. Gets the hashed password
  18432. </summary>
  18433. <value>The password.</value>
  18434. </member>
  18435. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ObjectProtect">
  18436. <summary>
  18437. Answer whether object protection is enabled or disabled
  18438. </summary>
  18439. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  18440. </member>
  18441. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ScenarioProtect">
  18442. <summary>
  18443. Answer whether scenario protection is enabled or disabled
  18444. </summary>
  18445. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  18446. </member>
  18447. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ProtectSheet(System.String)">
  18448. <summary>
  18449. Sets the protection enabled as well as the password
  18450. </summary>
  18451. <param name="password">password to set for protection, pass <code>null</code> to remove protection</param>
  18452. </member>
  18453. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32,System.Int32)">
  18454. <summary>
  18455. Sets the zoom magnication for the _sheet. The zoom is expressed as a
  18456. fraction. For example to express a zoom of 75% use 3 for the numerator
  18457. and 4 for the denominator.
  18458. </summary>
  18459. <param name="numerator">The numerator for the zoom magnification.</param>
  18460. <param name="denominator">The denominator for the zoom magnification.</param>
  18461. </member>
  18462. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32)">
  18463. Window zoom magnification for current view representing percent values.
  18464. Valid values range from 10 to 400. Horizontal &amp; Vertical scale together.
  18465. For example:
  18466. <pre>
  18467. 10 - 10%
  18468. 20 - 20%
  18469. ...
  18470. 100 - 100%
  18471. ...
  18472. 400 - 400%
  18473. </pre>
  18474. @param scale window zoom magnification
  18475. @throws IllegalArgumentException if scale is invalid
  18476. </member>
  18477. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetEnclosedBorderOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  18478. <summary>
  18479. Sets the enclosed border of region.
  18480. </summary>
  18481. <param name="region">The region.</param>
  18482. <param name="borderType">Type of the border.</param>
  18483. <param name="color">The color.</param>
  18484. </member>
  18485. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderRightOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  18486. <summary>
  18487. Sets the right border of region.
  18488. </summary>
  18489. <param name="region">The region.</param>
  18490. <param name="borderType">Type of the border.</param>
  18491. <param name="color">The color.</param>
  18492. </member>
  18493. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderLeftOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  18494. <summary>
  18495. Sets the left border of region.
  18496. </summary>
  18497. <param name="region">The region.</param>
  18498. <param name="borderType">Type of the border.</param>
  18499. <param name="color">The color.</param>
  18500. </member>
  18501. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderTopOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  18502. <summary>
  18503. Sets the top border of region.
  18504. </summary>
  18505. <param name="region">The region.</param>
  18506. <param name="borderType">Type of the border.</param>
  18507. <param name="color">The color.</param>
  18508. </member>
  18509. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderBottomOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  18510. <summary>
  18511. Sets the bottom border of region.
  18512. </summary>
  18513. <param name="region">The region.</param>
  18514. <param name="borderType">Type of the border.</param>
  18515. <param name="color">The color.</param>
  18516. </member>
  18517. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TopRow">
  18518. <summary>
  18519. The top row in the visible view when the _sheet is
  18520. first viewed after opening it in a viewer
  18521. </summary>
  18522. <value>the rownum (0 based) of the top row</value>
  18523. </member>
  18524. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LeftCol">
  18525. <summary>
  18526. The left col in the visible view when the _sheet Is
  18527. first viewed after opening it in a viewer
  18528. </summary>
  18529. <value>the rownum (0 based) of the top row</value>
  18530. </member>
  18531. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int32,System.Int32)">
  18532. Sets desktop window pane display area, when the
  18533. file is first opened in a viewer.
  18534. @param toprow the top row to show in desktop window pane
  18535. @param leftcol the left column to show in desktop window pane
  18536. </member>
  18537. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int16,System.Int16)">
  18538. <summary>
  18539. Sets desktop window pane display area, when the
  18540. file is first opened in a viewer.
  18541. </summary>
  18542. <param name="toprow">the top row to show in desktop window pane</param>
  18543. <param name="leftcol">the left column to show in desktop window pane</param>
  18544. </member>
  18545. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftMerged(System.Int32,System.Int32,System.Int32,System.Boolean)">
  18546. <summary>
  18547. Shifts the merged regions left or right depending on mode
  18548. TODO: MODE , this is only row specific
  18549. </summary>
  18550. <param name="startRow">The start row.</param>
  18551. <param name="endRow">The end row.</param>
  18552. <param name="n">The n.</param>
  18553. <param name="IsRow">if set to <c>true</c> [is row].</param>
  18554. </member>
  18555. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  18556. <summary>
  18557. Shifts rows between startRow and endRow n number of rows.
  18558. If you use a negative number, it will Shift rows up.
  18559. Code Ensures that rows don't wrap around.
  18560. Calls ShiftRows(startRow, endRow, n, false, false);
  18561. Additionally Shifts merged regions that are completely defined in these
  18562. rows (ie. merged 2 cells on a row to be Shifted).
  18563. </summary>
  18564. <param name="startRow">the row to start Shifting</param>
  18565. <param name="endRow">the row to end Shifting</param>
  18566. <param name="n">the number of rows to Shift</param>
  18567. </member>
  18568. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  18569. <summary>
  18570. Shifts rows between startRow and endRow n number of rows.
  18571. If you use a negative number, it will shift rows up.
  18572. Code ensures that rows don't wrap around
  18573. Additionally shifts merged regions that are completely defined in these
  18574. rows (ie. merged 2 cells on a row to be shifted).
  18575. TODO Might want to add bounds checking here
  18576. </summary>
  18577. <param name="startRow">the row to start shifting</param>
  18578. <param name="endRow">the row to end shifting</param>
  18579. <param name="n">the number of rows to shift</param>
  18580. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  18581. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  18582. </member>
  18583. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  18584. <summary>
  18585. Shifts rows between startRow and endRow n number of rows.
  18586. If you use a negative number, it will Shift rows up.
  18587. Code Ensures that rows don't wrap around
  18588. Additionally Shifts merged regions that are completely defined in these
  18589. rows (ie. merged 2 cells on a row to be Shifted).
  18590. TODO Might want to Add bounds Checking here
  18591. </summary>
  18592. <param name="startRow">the row to start Shifting</param>
  18593. <param name="endRow">the row to end Shifting</param>
  18594. <param name="n">the number of rows to Shift</param>
  18595. <param name="copyRowHeight">whether to copy the row height during the Shift</param>
  18596. <param name="resetOriginalRowHeight">whether to Set the original row's height to the default</param>
  18597. <param name="moveComments">if set to <c>true</c> [move comments].</param>
  18598. </member>
  18599. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.InsertChartRecords(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  18600. <summary>
  18601. Inserts the chart records.
  18602. </summary>
  18603. <param name="records">The records.</param>
  18604. </member>
  18605. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  18606. <summary>
  18607. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  18608. </summary>
  18609. <param name="colSplit">Horizonatal position of split.</param>
  18610. <param name="rowSplit">Vertical position of split.</param>
  18611. <param name="leftmostColumn">Top row visible in bottom pane</param>
  18612. <param name="topRow">Left column visible in right pane.</param>
  18613. </member>
  18614. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  18615. <summary>
  18616. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  18617. </summary>
  18618. <param name="colSplit">Horizonatal position of split.</param>
  18619. <param name="rowSplit">Vertical position of split.</param>
  18620. </member>
  18621. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  18622. <summary>
  18623. Creates a split pane. Any existing freezepane or split pane is overwritten.
  18624. </summary>
  18625. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point).</param>
  18626. <param name="ySplitPos">Vertical position of split (in 1/20th of a point).</param>
  18627. <param name="leftmostColumn">Left column visible in right pane.</param>
  18628. <param name="topRow">Top row visible in bottom pane.</param>
  18629. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT,PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  18630. </member>
  18631. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PaneInformation">
  18632. <summary>
  18633. Returns the information regarding the currently configured pane (split or freeze).
  18634. </summary>
  18635. <value>null if no pane configured, or the pane information.</value>
  18636. </member>
  18637. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGridlines">
  18638. <summary>
  18639. Gets or sets if gridlines are Displayed.
  18640. </summary>
  18641. <value>whether gridlines are Displayed</value>
  18642. </member>
  18643. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayFormulas">
  18644. <summary>
  18645. Gets or sets a value indicating whether formulas are displayed.
  18646. </summary>
  18647. <value>whether formulas are Displayed</value>
  18648. </member>
  18649. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayRowColHeadings">
  18650. <summary>
  18651. Gets or sets a value indicating whether RowColHeadings are displayed.
  18652. </summary>
  18653. <value>
  18654. whether RowColHeadings are displayed
  18655. </value>
  18656. </member>
  18657. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  18658. <summary>
  18659. Gets the size of the margin in inches.
  18660. </summary>
  18661. <param name="margin">which margin to get.</param>
  18662. <returns>the size of the margin</returns>
  18663. </member>
  18664. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  18665. <summary>
  18666. Sets the size of the margin in inches.
  18667. </summary>
  18668. <param name="margin">which margin to get.</param>
  18669. <param name="size">the size of the margin</param>
  18670. </member>
  18671. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowBreak(System.Int32)">
  18672. <summary>
  18673. Sets a page break at the indicated row
  18674. </summary>
  18675. <param name="row">The row.</param>
  18676. </member>
  18677. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsRowBroken(System.Int32)">
  18678. <summary>
  18679. Determines if there is a page break at the indicated row
  18680. </summary>
  18681. <param name="row">The row.</param>
  18682. <returns>
  18683. <c>true</c> if [is row broken] [the specified row]; otherwise, <c>false</c>.
  18684. </returns>
  18685. </member>
  18686. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRowBreak(System.Int32)">
  18687. <summary>
  18688. Removes the page break at the indicated row
  18689. </summary>
  18690. <param name="row">The row.</param>
  18691. </member>
  18692. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowBreaks">
  18693. <summary>
  18694. Retrieves all the horizontal page breaks
  18695. </summary>
  18696. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  18697. </member>
  18698. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ColumnBreaks">
  18699. <summary>
  18700. Retrieves all the vertical page breaks
  18701. </summary>
  18702. <value>all the vertical page breaks, or null if there are no column page breaks</value>
  18703. </member>
  18704. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnBreak(System.Int32)">
  18705. <summary>
  18706. Sets a page break at the indicated column
  18707. </summary>
  18708. <param name="column">The column.</param>
  18709. </member>
  18710. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnBroken(System.Int32)">
  18711. <summary>
  18712. Determines if there is a page break at the indicated column
  18713. </summary>
  18714. <param name="column">The column.</param>
  18715. <returns>
  18716. <c>true</c> if [is column broken] [the specified column]; otherwise, <c>false</c>.
  18717. </returns>
  18718. </member>
  18719. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveColumnBreak(System.Int32)">
  18720. <summary>
  18721. Removes a page break at the indicated column
  18722. </summary>
  18723. <param name="column">The column.</param>
  18724. </member>
  18725. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateRow(System.Int32)">
  18726. <summary>
  18727. Runs a bounds Check for row numbers
  18728. </summary>
  18729. <param name="row">The row.</param>
  18730. </member>
  18731. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateColumn(System.Int32)">
  18732. <summary>
  18733. Runs a bounds Check for column numbers
  18734. </summary>
  18735. <param name="column">The column.</param>
  18736. </member>
  18737. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.DumpDrawingRecords(System.Boolean)">
  18738. <summary>
  18739. Aggregates the drawing records and dumps the escher record hierarchy
  18740. to the standard output.
  18741. </summary>
  18742. <param name="fat">if set to <c>true</c> [fat].</param>
  18743. </member>
  18744. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingEscherAggregate">
  18745. <summary>
  18746. Returns the agregate escher records for this _sheet,
  18747. it there is one.
  18748. WARNING - calling this will trigger a parsing of the
  18749. associated escher records. Any that aren't supported
  18750. (such as charts and complex drawing types) will almost
  18751. certainly be lost or corrupted when written out.
  18752. </summary>
  18753. <value>The drawing escher aggregate.</value>
  18754. </member>
  18755. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingPatriarch">
  18756. This will hold any graphics or charts for the sheet.
  18757. @return the top-level drawing patriarch, if there is one, else returns null
  18758. </member>
  18759. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateDrawingPatriarch">
  18760. Creates the top-level drawing patriarch. This will have
  18761. the effect of removing any existing drawings on this
  18762. sheet.
  18763. This may then be used to add graphics or charts
  18764. @return The new patriarch.
  18765. </member>
  18766. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TabColorIndex">
  18767. <summary>
  18768. Gets or sets the tab color of the _sheet
  18769. </summary>
  18770. </member>
  18771. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsAutoTabColor">
  18772. <summary>
  18773. Gets or sets whether the tab color of _sheet is automatic
  18774. </summary>
  18775. </member>
  18776. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  18777. <summary>
  18778. Expands or collapses a column Group.
  18779. </summary>
  18780. <param name="columnNumber">One of the columns in the Group.</param>
  18781. <param name="collapsed">true = collapse Group, false = expand Group.</param>
  18782. </member>
  18783. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupColumn(System.Int32,System.Int32)">
  18784. <summary>
  18785. Create an outline for the provided column range.
  18786. </summary>
  18787. <param name="fromColumn">beginning of the column range.</param>
  18788. <param name="toColumn">end of the column range.</param>
  18789. </member>
  18790. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupColumn(System.Int32,System.Int32)">
  18791. <summary>
  18792. Ungroups the column.
  18793. </summary>
  18794. <param name="fromColumn">From column.</param>
  18795. <param name="toColumn">To column.</param>
  18796. </member>
  18797. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupRow(System.Int32,System.Int32)">
  18798. <summary>
  18799. Groups the row.
  18800. </summary>
  18801. <param name="fromRow">From row.</param>
  18802. <param name="toRow">To row.</param>
  18803. </member>
  18804. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  18805. <summary>
  18806. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  18807. </summary>
  18808. <param name="cell">any cell within Array Formula range</param>
  18809. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  18810. </member>
  18811. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  18812. <summary>
  18813. Also creates cells if they don't exist.
  18814. </summary>
  18815. </member>
  18816. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  18817. <summary>
  18818. Sets array formula to specified region for result.
  18819. </summary>
  18820. <param name="formula">text representation of the formula</param>
  18821. <param name="range">Region of array formula for result</param>
  18822. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  18823. </member>
  18824. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupRow(System.Int32,System.Int32)">
  18825. <summary>
  18826. Ungroups the row.
  18827. </summary>
  18828. <param name="fromRow">From row.</param>
  18829. <param name="toRow">To row.</param>
  18830. </member>
  18831. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  18832. <summary>
  18833. Sets the row group collapsed.
  18834. </summary>
  18835. <param name="row">The row.</param>
  18836. <param name="collapse">if set to <c>true</c> [collapse].</param>
  18837. </member>
  18838. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  18839. <summary>
  18840. Sets the default column style for a given column. POI will only apply this style to new cells Added to the _sheet.
  18841. </summary>
  18842. <param name="column">the column index</param>
  18843. <param name="style">the style to set</param>
  18844. </member>
  18845. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32)">
  18846. <summary>
  18847. Adjusts the column width to fit the contents.
  18848. This Process can be relatively slow on large sheets, so this should
  18849. normally only be called once per column, at the end of your
  18850. Processing.
  18851. </summary>
  18852. <param name="column">the column index.</param>
  18853. </member>
  18854. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  18855. <summary>
  18856. Adjusts the column width to fit the contents.
  18857. This Process can be relatively slow on large sheets, so this should
  18858. normally only be called once per column, at the end of your
  18859. Processing.
  18860. You can specify whether the content of merged cells should be considered or ignored.
  18861. Default is to ignore merged cells.
  18862. </summary>
  18863. <param name="column">the column index</param>
  18864. <param name="useMergedCells">whether to use the contents of merged cells when calculating the width of the column</param>
  18865. </member>
  18866. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  18867. <summary>
  18868. Checks if the provided region is part of the merged regions.
  18869. </summary>
  18870. <param name="mergedRegion">Region searched in the merged regions</param>
  18871. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  18872. </member>
  18873. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMergedRegion(System.Int32)">
  18874. <summary>
  18875. Gets the merged region at the specified index
  18876. </summary>
  18877. <param name="index">The index.</param>
  18878. <returns></returns>
  18879. </member>
  18880. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.MergedRegions">
  18881. <summary>
  18882. get the list of merged regions
  18883. </summary>
  18884. <returns>return the list of merged regions</returns>
  18885. </member>
  18886. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.HSSFFont2Font(NPOI.HSSF.UserModel.HSSFFont)">
  18887. <summary>
  18888. Convert HSSFFont to Font.
  18889. </summary>
  18890. <param name="font1">The font.</param>
  18891. <returns></returns>
  18892. </member>
  18893. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(System.Int32,System.Int32)">
  18894. <summary>
  18895. Returns cell comment for the specified row and column
  18896. </summary>
  18897. <param name="row">The row.</param>
  18898. <param name="column">The column.</param>
  18899. <returns>cell comment or null if not found</returns>
  18900. </member>
  18901. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  18902. <summary>
  18903. Returns cell comment for the specified row and column
  18904. </summary>
  18905. <param name="ref1">cell location</param>
  18906. <returns>return cell comment or null if not found</returns>
  18907. </member>
  18908. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlink(System.Int32,System.Int32)">
  18909. <summary>
  18910. Get a Hyperlink in this sheet anchored at row, column
  18911. </summary>
  18912. <param name="row">The index of the row of the hyperlink, zero-based</param>
  18913. <param name="column">the index of the column of the hyperlink, zero-based</param>
  18914. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  18915. </member>
  18916. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  18917. <summary>
  18918. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  18919. </summary>
  18920. <param name="addr">The address of the cell containing the hyperlink</param>
  18921. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  18922. </member>
  18923. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetHyperlinkList">
  18924. Get a list of Hyperlinks in this sheet
  18925. @return Hyperlinks for the sheet
  18926. </member>
  18927. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveHyperlink(NPOI.HSSF.UserModel.HSSFHyperlink)">
  18928. Remove the underlying HyperlinkRecord from this sheet.
  18929. If multiple HSSFHyperlinks refer to the same HyperlinkRecord, all HSSFHyperlinks will be removed.
  18930. @param link the HSSFHyperlink wrapper around the HyperlinkRecord to remove
  18931. </member>
  18932. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveHyperlink(NPOI.HSSF.Record.HyperlinkRecord)">
  18933. Remove the underlying HyperlinkRecord from this sheet
  18934. @param link the underlying HyperlinkRecord to remove from this sheet
  18935. </member>
  18936. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetConditionalFormatting">
  18937. <summary>
  18938. Gets the sheet conditional formatting.
  18939. </summary>
  18940. <value>The sheet conditional formatting.</value>
  18941. </member>
  18942. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DVRecords">
  18943. <summary>
  18944. Get the DVRecords objects that are associated to this _sheet
  18945. </summary>
  18946. <value>a list of DVRecord instances</value>
  18947. </member>
  18948. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Workbook">
  18949. <summary>
  18950. Provide a reference to the parent workbook.
  18951. </summary>
  18952. </member>
  18953. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetName">
  18954. <summary>
  18955. Returns the name of this _sheet
  18956. </summary>
  18957. </member>
  18958. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetDataValidationHelper">
  18959. <summary>
  18960. Create an instance of a DataValidationHelper.
  18961. </summary>
  18962. <returns>Instance of a DataValidationHelper</returns>
  18963. </member>
  18964. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  18965. <summary>
  18966. Enable filtering for a range of cells
  18967. </summary>
  18968. <param name="range">the range of cells to filter</param>
  18969. </member>
  18970. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComments">
  18971. <summary>
  18972. Returns all cell comments on this sheet.
  18973. </summary>
  18974. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  18975. </member>
  18976. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindCellCommentLocations(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.Dictionary{NPOI.SS.Util.CellAddress,NPOI.SS.UserModel.IComment})">
  18977. Finds all cell comments in this sheet and adds them to the specified locations map
  18978. @param container a container that may contain HSSFComments
  18979. @param locations the map to store the HSSFComments in
  18980. </member>
  18981. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnOutlineLevel(System.Int32)">
  18982. <summary>
  18983. Returns the column outline level. Increased as you
  18984. put it into more groups (outlines), reduced as
  18985. you take it out of them.
  18986. </summary>
  18987. <param name="columnIndex"></param>
  18988. <returns></returns>
  18989. </member>
  18990. <member name="T:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting">
  18991. <summary>
  18992. The Conditional Formatting facet of HSSFSheet
  18993. @author Dmitriy Kumshayev
  18994. </summary>
  18995. </member>
  18996. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  18997. <summary>
  18998. A factory method allowing to Create a conditional formatting rule
  18999. with a cell comparison operator
  19000. TODO - formulas containing cell references are currently not Parsed properly
  19001. </summary>
  19002. <param name="comparisonOperation">a constant value from HSSFConditionalFormattingRule.ComparisonOperator</param>
  19003. <param name="formula1">formula for the valued, Compared with the cell</param>
  19004. <param name="formula2">second formula (only used with HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN
  19005. and HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN operations)</param>
  19006. <returns></returns>
  19007. </member>
  19008. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  19009. <summary>
  19010. A factory method allowing to Create a conditional formatting rule with a formula.
  19011. The formatting rules are applied by Excel when the value of the formula not equal to 0.
  19012. TODO - formulas containing cell references are currently not Parsed properly
  19013. </summary>
  19014. <param name="formula">formula for the valued, Compared with the cell</param>
  19015. <returns></returns>
  19016. </member>
  19017. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)">
  19018. A factory method allowing the creation of conditional formatting
  19019. rules using an Icon Set / Multi-State formatting.
  19020. The thresholds for it will be created, but will be empty
  19021. and require configuring with
  19022. {@link HSSFConditionalFormattingRule#getMultiStateFormatting()}
  19023. then
  19024. {@link HSSFIconMultiStateFormatting#getThresholds()}
  19025. </member>
  19026. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.HSSF.UserModel.HSSFExtendedColor)" -->
  19027. <!-- Badly formed XML comment ignored for member "M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  19028. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.HSSF.UserModel.HSSFConditionalFormatting)">
  19029. <summary>
  19030. Adds a copy of HSSFConditionalFormatting object to the sheet
  19031. This method could be used to copy HSSFConditionalFormatting object
  19032. from one sheet to another.
  19033. </summary>
  19034. <param name="cf">HSSFConditionalFormatting object</param>
  19035. <returns>index of the new Conditional Formatting object</returns>
  19036. <example>
  19037. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  19038. newSheet.AddConditionalFormatting(cf);
  19039. </example>
  19040. </member>
  19041. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  19042. <summary>
  19043. Allows to Add a new Conditional Formatting Set to the sheet.
  19044. </summary>
  19045. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  19046. <param name="cfRules">Set of up to three conditional formatting rules</param>
  19047. <returns>index of the newly Created Conditional Formatting object</returns>
  19048. </member>
  19049. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  19050. <summary>
  19051. Adds the conditional formatting.
  19052. </summary>
  19053. <param name="regions">The regions.</param>
  19054. <param name="rule1">The rule1.</param>
  19055. <returns></returns>
  19056. </member>
  19057. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  19058. <summary>
  19059. Adds the conditional formatting.
  19060. </summary>
  19061. <param name="regions">The regions.</param>
  19062. <param name="rule1">The rule1.</param>
  19063. <param name="rule2">The rule2.</param>
  19064. <returns></returns>
  19065. </member>
  19066. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  19067. <summary>
  19068. Gets Conditional Formatting object at a particular index
  19069. @param index
  19070. of the Conditional Formatting object to fetch
  19071. </summary>
  19072. <param name="index">Conditional Formatting object</param>
  19073. <returns></returns>
  19074. </member>
  19075. <member name="P:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.NumConditionalFormattings">
  19076. <summary>
  19077. the number of Conditional Formatting objects of the sheet
  19078. </summary>
  19079. <value>The num conditional formattings.</value>
  19080. </member>
  19081. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  19082. <summary>
  19083. Removes a Conditional Formatting object by index
  19084. </summary>
  19085. <param name="index">index of a Conditional Formatting object to Remove</param>
  19086. </member>
  19087. <member name="T:NPOI.HSSF.UserModel.HSSFSimpleShape">
  19088. <summary>
  19089. Represents a simple shape such as a line, rectangle or oval.
  19090. @author Glen Stampoultzis (glens at apache.org)
  19091. </summary>
  19092. </member>
  19093. <member name="M:NPOI.HSSF.UserModel.HSSFSimpleShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  19094. <summary>
  19095. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFSimpleShape"/> class.
  19096. </summary>
  19097. <param name="parent">The parent.</param>
  19098. <param name="anchor">The anchor.</param>
  19099. </member>
  19100. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.ShapeType">
  19101. <summary>
  19102. Gets the shape type.
  19103. </summary>
  19104. <value>One of the OBJECT_TYPE_* constants.</value>
  19105. @see #OBJECT_TYPE_LINE
  19106. @see #OBJECT_TYPE_OVAL
  19107. @see #OBJECT_TYPE_RECTANGLE
  19108. @see #OBJECT_TYPE_PICTURE
  19109. @see #OBJECT_TYPE_COMMENT
  19110. </member>
  19111. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.String">
  19112. <summary>
  19113. Get or set the rich text string used by this object.
  19114. </summary>
  19115. </member>
  19116. <member name="T:NPOI.HSSF.UserModel.HSSFTextbox">
  19117. <summary>
  19118. A textbox Is a shape that may hold a rich text string.
  19119. @author Glen Stampoultzis (glens at apache.org)
  19120. </summary>
  19121. </member>
  19122. <member name="M:NPOI.HSSF.UserModel.HSSFTextbox.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  19123. <summary>
  19124. Construct a new textbox with the given parent and anchor.
  19125. </summary>
  19126. <param name="parent">The parent.</param>
  19127. <param name="anchor">One of HSSFClientAnchor or HSSFChildAnchor</param>
  19128. </member>
  19129. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginLeft">
  19130. <summary>
  19131. Gets or sets the left margin within the textbox.
  19132. </summary>
  19133. <value>The margin left.</value>
  19134. </member>
  19135. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginRight">
  19136. <summary>
  19137. Gets or sets the right margin within the textbox.
  19138. </summary>
  19139. <value>The margin right.</value>
  19140. </member>
  19141. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginTop">
  19142. <summary>
  19143. Gets or sets the top margin within the textbox
  19144. </summary>
  19145. <value>The top margin.</value>
  19146. </member>
  19147. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginBottom">
  19148. <summary>
  19149. Gets or sets the bottom margin within the textbox.
  19150. </summary>
  19151. <value>The margin bottom.</value>
  19152. </member>
  19153. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.HorizontalAlignment">
  19154. <summary>
  19155. Gets or sets the horizontal alignment.
  19156. </summary>
  19157. <value>The horizontal alignment.</value>
  19158. </member>
  19159. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.VerticalAlignment">
  19160. <summary>
  19161. Gets or sets the vertical alignment.
  19162. </summary>
  19163. <value>The vertical alignment.</value>
  19164. </member>
  19165. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook">
  19166. <summary>
  19167. High level representation of a workbook. This is the first object most users
  19168. will construct whether they are reading or writing a workbook. It is also the
  19169. top level object for creating new sheets/etc.
  19170. </summary>
  19171. @author Andrew C. Oliver (acoliver at apache dot org)
  19172. @author Glen Stampoultzis (glens at apache.org)
  19173. @author Shawn Laubach (slaubach at apache dot org)
  19174. </member>
  19175. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.MAX_STYLES">
  19176. The maximum number of cell styles in a .xls workbook.
  19177. The 'official' limit is 4,000, but POI allows a slightly larger number.
  19178. This extra delta takes into account built-in styles that are automatically
  19179. created for new workbooks
  19180. See http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx
  19181. </member>
  19182. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.INITIAL_CAPACITY">
  19183. used for compile-time performance/memory optimization. This determines the
  19184. initial capacity for the sheet collection. Its currently Set to 3.
  19185. Changing it in this release will decrease performance
  19186. since you're never allowed to have more or less than three sheets!
  19187. </member>
  19188. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.workbook">
  19189. this Is the reference to the low level Workbook object
  19190. </member>
  19191. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._sheets">
  19192. this holds the HSSFSheet objects attached to this workbook
  19193. </member>
  19194. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.names">
  19195. this holds the HSSFName objects attached to this workbook
  19196. </member>
  19197. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.preserveNodes">
  19198. holds whether or not to preserve other nodes in the POIFS. Used
  19199. for macros and embedded objects.
  19200. </member>
  19201. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.formatter">
  19202. Used to keep track of the data formatter so that all
  19203. CreateDataFormatter calls return the same one for a given
  19204. book. This Ensures that updates from one places Is visible
  19205. someplace else.
  19206. </member>
  19207. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.fonts">
  19208. this holds the HSSFFont objects attached to this workbook.
  19209. We only create these from the low level records as required.
  19210. </member>
  19211. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook.SheetRecordCollector">
  19212. <summary>
  19213. Totals the sizes of all sheet records and eventually serializes them
  19214. </summary>
  19215. </member>
  19216. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor">
  19217. <summary>
  19218. Creates new HSSFWorkbook from scratch (start here!)
  19219. </summary>
  19220. </member>
  19221. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  19222. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the
  19223. POI filesystem around your inputstream, including all nodes.
  19224. This calls {@link #HSSFWorkbook(InputStream, boolean)} with
  19225. preserve nodes set to true.
  19226. @see #HSSFWorkbook(InputStream, boolean)
  19227. @see #HSSFWorkbook(POIFSFileSystem)
  19228. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  19229. @exception IOException if the stream cannot be read
  19230. </member>
  19231. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  19232. Given a POI POIFSFileSystem object, read in its Workbook along
  19233. with all related nodes, and populate the high and low level models.
  19234. This calls {@link #HSSFWorkbook(POIFSFileSystem, boolean)} with
  19235. preserve nodes set to true.
  19236. @see #HSSFWorkbook(POIFSFileSystem, boolean)
  19237. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  19238. @exception IOException if the stream cannot be read
  19239. </member>
  19240. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  19241. <summary>
  19242. given a POI POIFSFileSystem object, Read in its Workbook and populate the high and
  19243. low level models. If you're Reading in a workbook...start here.
  19244. </summary>
  19245. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  19246. <param name="preserveNodes">whether to preseve other nodes, such as
  19247. macros. This takes more memory, so only say yes if you
  19248. need to. If Set, will store all of the POIFSFileSystem
  19249. in memory</param>
  19250. </member>
  19251. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  19252. <summary>
  19253. given a POI POIFSFileSystem object, and a specific directory
  19254. within it, Read in its Workbook and populate the high and
  19255. low level models. If you're Reading in a workbook...start here.
  19256. </summary>
  19257. <param name="directory">the POI filesystem directory to Process from</param>
  19258. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  19259. <param name="preserveNodes">whether to preseve other nodes, such as
  19260. macros. This takes more memory, so only say yes if you
  19261. need to. If Set, will store all of the POIFSFileSystem
  19262. in memory</param>
  19263. </member>
  19264. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)">
  19265. given a POI POIFSFileSystem object, and a specific directory
  19266. within it, read in its Workbook and populate the high and
  19267. low level models. If you're reading in a workbook...start here.
  19268. @param directory the POI filesystem directory to process from
  19269. @param preserveNodes whether to preseve other nodes, such as
  19270. macros. This takes more memory, so only say yes if you
  19271. need to. If set, will store all of the POIFSFileSystem
  19272. in memory
  19273. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  19274. @exception IOException if the stream cannot be read
  19275. </member>
  19276. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(System.IO.Stream,System.Boolean)">
  19277. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your
  19278. inputstream.
  19279. @param s the POI filesystem that Contains the Workbook stream.
  19280. @param preserveNodes whether to preseve other nodes, such as
  19281. macros. This takes more memory, so only say yes if you
  19282. need to.
  19283. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  19284. @see #HSSFWorkbook(POIFSFileSystem)
  19285. @exception IOException if the stream cannot be Read
  19286. </member>
  19287. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPropertiesFromWorkbook(NPOI.HSSF.Model.InternalWorkbook)">
  19288. used internally to Set the workbook properties.
  19289. </member>
  19290. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ConvertLabelRecords(System.Collections.IList,System.Int32)">
  19291. <summary>
  19292. This is basically a kludge to deal with the now obsolete Label records. If
  19293. you have to read in a sheet that contains Label records, be aware that the rest
  19294. of the API doesn't deal with them, the low level structure only provides Read-only
  19295. semi-immutable structures (the Sets are there for interface conformance with NO
  19296. impelmentation). In short, you need to call this function passing it a reference
  19297. to the Workbook object. All labels will be converted to LabelSST records and their
  19298. contained strings will be written to the Shared String tabel (SSTRecord) within
  19299. the Workbook.
  19300. </summary>
  19301. <param name="records">The records.</param>
  19302. <param name="offset">The offset.</param>
  19303. </member>
  19304. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.MissingCellPolicy">
  19305. <summary>
  19306. Retrieves the current policy on what to do when
  19307. getting missing or blank cells from a row.
  19308. The default is to return blank and null cells.
  19309. </summary>
  19310. <value>The missing cell policy.</value>
  19311. </member>
  19312. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  19313. <summary>
  19314. Sets the order of appearance for a given sheet.
  19315. </summary>
  19316. <param name="sheetname">the name of the sheet to reorder</param>
  19317. <param name="pos">the position that we want to Insert the sheet into (0 based)</param>
  19318. </member>
  19319. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ValidateSheetIndex(System.Int32)">
  19320. <summary>
  19321. Validates the index of the sheet.
  19322. </summary>
  19323. <param name="index">The index.</param>
  19324. </member>
  19325. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.InsertChartRecord">
  19326. Test only. Do not use
  19327. </member>
  19328. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTab(System.Int32)">
  19329. <summary>
  19330. Selects a single sheet. This may be different to
  19331. the 'active' sheet (which Is the sheet with focus).
  19332. </summary>
  19333. <param name="index">The index.</param>
  19334. </member>
  19335. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Int32[])">
  19336. <summary>
  19337. Sets the selected tabs.
  19338. </summary>
  19339. <param name="indexes">The indexes.</param>
  19340. </member>
  19341. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Collections.Generic.IList{System.Int32})">
  19342. Selects multiple sheets as a group. This is distinct from
  19343. the 'active' sheet (which is the sheet with focus).
  19344. Unselects sheets that are not in <code>indexes</code>.
  19345. @param indexes
  19346. </member>
  19347. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSelectedTabs">
  19348. Gets the selected sheets (if more than one, Excel calls these a [Group]).
  19349. @return indices of selected sheets
  19350. </member>
  19351. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ActiveSheetIndex">
  19352. <summary>
  19353. Gets the tab whose data is actually seen when the sheet is opened.
  19354. This may be different from the "selected sheet" since excel seems to
  19355. allow you to show the data of one sheet when another Is seen "selected"
  19356. in the tabs (at the bottom).
  19357. </summary>
  19358. </member>
  19359. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetActiveSheet(System.Int32)">
  19360. <summary>
  19361. Sets the tab whose data is actually seen when the sheet is opened.
  19362. This may be different from the "selected sheet" since excel seems to
  19363. allow you to show the data of one sheet when another Is seen "selected"
  19364. in the tabs (at the bottom).
  19365. <param name="index">The sheet number(0 based).</param>
  19366. </summary>
  19367. </member>
  19368. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.FirstVisibleTab">
  19369. <summary>
  19370. Gets or sets the first tab that is displayed in the list of tabs
  19371. in excel. This method does <b>not</b> hide, select or focus sheets.
  19372. It just sets the scroll position in the tab-bar.
  19373. @param index the sheet index of the tab that will become the first in the tab-bar
  19374. </summary>
  19375. </member>
  19376. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_COMPRESSED_UNICODE">
  19377. @deprecated POI will now properly handle Unicode strings without
  19378. forceing an encoding
  19379. </member>
  19380. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_UTF_16">
  19381. @deprecated POI will now properly handle Unicode strings without
  19382. forceing an encoding
  19383. </member>
  19384. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetName(System.Int32,System.String)">
  19385. <summary>
  19386. Set the sheet name.
  19387. </summary>
  19388. <param name="sheetIx">The sheet number(0 based).</param>
  19389. <param name="name">The name.</param>
  19390. </member>
  19391. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetName(System.Int32)">
  19392. <summary>
  19393. Get the sheet name
  19394. </summary>
  19395. <param name="sheetIx">The sheet index.</param>
  19396. <returns>Sheet name</returns>
  19397. </member>
  19398. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetHidden(System.Int32)">
  19399. <summary>
  19400. Check whether a sheet is hidden
  19401. </summary>
  19402. <param name="sheetIx">The sheet index.</param>
  19403. <returns>
  19404. <c>true</c> if sheet is hidden; otherwise, <c>false</c>.
  19405. </returns>
  19406. </member>
  19407. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  19408. <summary>
  19409. Check whether a sheet is very hidden.
  19410. This is different from the normal
  19411. hidden status
  19412. </summary>
  19413. <param name="sheetIx">The sheet index.</param>
  19414. <returns>
  19415. <c>true</c> if sheet is very hidden; otherwise, <c>false</c>.
  19416. </returns>
  19417. </member>
  19418. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  19419. <summary>
  19420. Hide or Unhide a sheet
  19421. </summary>
  19422. <param name="sheetIx">The sheet index</param>
  19423. <param name="hidden">True to mark the sheet as hidden, false otherwise</param>
  19424. </member>
  19425. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  19426. <summary>
  19427. Hide or unhide a sheet.
  19428. </summary>
  19429. <param name="sheetIx">The sheet number</param>
  19430. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  19431. </member>
  19432. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(System.String)">
  19433. <summary>
  19434. Returns the index of the sheet by his name
  19435. </summary>
  19436. <param name="name">the sheet name</param>
  19437. <returns>index of the sheet (0 based)</returns>
  19438. </member>
  19439. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  19440. <summary>
  19441. Returns the index of the given sheet
  19442. </summary>
  19443. <param name="sheet">the sheet to look up</param>
  19444. <returns>index of the sheet (0 based).-1
  19445. if not found </returns>
  19446. </member>
  19447. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet">
  19448. <summary>
  19449. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and returns
  19450. the high level representation. Use this to Create new sheets.
  19451. </summary>
  19452. <returns>HSSFSheet representing the new sheet.</returns>
  19453. </member>
  19454. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CloneSheet(System.Int32)">
  19455. <summary>
  19456. Create an HSSFSheet from an existing sheet in the HSSFWorkbook.
  19457. </summary>
  19458. <param name="sheetIndex">the sheet index</param>
  19459. <returns>HSSFSheet representing the Cloned sheet.</returns>
  19460. </member>
  19461. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetUniqueSheetName(System.String)">
  19462. <summary>
  19463. Gets the name of the unique sheet.
  19464. </summary>
  19465. <param name="srcName">Name of the SRC.</param>
  19466. <returns></returns>
  19467. </member>
  19468. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet(System.String)">
  19469. <summary>
  19470. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and
  19471. returns the high level representation. Use this to Create new sheets.
  19472. </summary>
  19473. <param name="sheetname">sheetname to set for the sheet.</param>
  19474. <returns>HSSFSheet representing the new sheet.</returns>
  19475. </member>
  19476. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfSheets">
  19477. <summary>
  19478. Get the number of spreadsheets in the workbook (this will be three after serialization)
  19479. </summary>
  19480. <value>The number of sheets.</value>
  19481. </member>
  19482. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheets">
  19483. <summary>
  19484. Gets the sheets.
  19485. </summary>
  19486. <returns></returns>
  19487. </member>
  19488. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetAt(System.Int32)">
  19489. <summary>
  19490. Get the HSSFSheet object at the given index.
  19491. </summary>
  19492. <param name="index">index of the sheet number (0-based)</param>
  19493. <returns>HSSFSheet at the provided index</returns>
  19494. </member>
  19495. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheet(System.String)">
  19496. <summary>
  19497. Get sheet with the given name (case insensitive match)
  19498. </summary>
  19499. <param name="name">name of the sheet</param>
  19500. <returns>HSSFSheet with the name provided or null if it does not exist</returns>
  19501. </member>
  19502. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveSheetAt(System.Int32)">
  19503. <summary>
  19504. Removes sheet at the given index.
  19505. </summary>
  19506. <param name="index">index of the sheet (0-based)</param>
  19507. <remarks>
  19508. Care must be taken if the Removed sheet Is the currently active or only selected sheet in
  19509. the workbook. There are a few situations when Excel must have a selection and/or active
  19510. sheet. (For example when printing - see Bug 40414).
  19511. This method makes sure that if the Removed sheet was active, another sheet will become
  19512. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  19513. sheet will become selected. The newly active/selected sheet will have the same index, or
  19514. one less if the Removed sheet was the last in the workbook.
  19515. </remarks>
  19516. </member>
  19517. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.BackupFlag">
  19518. <summary>
  19519. determine whether the Excel GUI will backup the workbook when saving.
  19520. </summary>
  19521. <value>the current Setting for backups.</value>
  19522. </member>
  19523. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateFont">
  19524. <summary>
  19525. Create a new Font and Add it to the workbook's font table
  19526. </summary>
  19527. <returns>new font object</returns>
  19528. </member>
  19529. <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)">
  19530. <summary>
  19531. Finds a font that matches the one with the supplied attributes
  19532. </summary>
  19533. <param name="boldWeight">The bold weight.</param>
  19534. <param name="color">The color.</param>
  19535. <param name="fontHeight">Height of the font.</param>
  19536. <param name="name">The name.</param>
  19537. <param name="italic">if set to <c>true</c> [italic].</param>
  19538. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  19539. <param name="typeOffset">The type offset.</param>
  19540. <param name="underline">The underline.</param>
  19541. <returns></returns>
  19542. </member>
  19543. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  19544. <summary>
  19545. Finds a font that matches the one with the supplied attributes
  19546. </summary>
  19547. <param name="bold">The bold weight.</param>
  19548. <param name="color">The color.</param>
  19549. <param name="fontHeight">Height of the font.</param>
  19550. <param name="name">The name.</param>
  19551. <param name="italic">if set to <c>true</c> [italic].</param>
  19552. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  19553. <param name="typeOffset">The type offset.</param>
  19554. <param name="underline">The underline.</param>
  19555. <returns></returns>
  19556. </member>
  19557. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfFonts">
  19558. <summary>
  19559. Get the number of fonts in the font table
  19560. </summary>
  19561. <value>The number of fonts.</value>
  19562. </member>
  19563. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetFontAt(System.Int16)">
  19564. <summary>
  19565. Get the font at the given index number
  19566. </summary>
  19567. <param name="idx">The index number</param>
  19568. <returns>HSSFFont at the index</returns>
  19569. </member>
  19570. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResetFontCache">
  19571. <summary>
  19572. Reset the fonts cache, causing all new calls
  19573. to getFontAt() to create new objects.
  19574. Should only be called after deleting fonts,
  19575. and that's not something you should normally do
  19576. </summary>
  19577. </member>
  19578. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateCellStyle">
  19579. <summary>
  19580. Create a new Cell style and Add it to the workbook's style table
  19581. </summary>
  19582. <returns>the new Cell Style object</returns>
  19583. </member>
  19584. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumCellStyles">
  19585. <summary>
  19586. Get the number of styles the workbook Contains
  19587. </summary>
  19588. <value>count of cell styles</value>
  19589. </member>
  19590. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetCellStyleAt(System.Int32)">
  19591. <summary>
  19592. Get the cell style object at the given index
  19593. </summary>
  19594. <param name="idx">index within the Set of styles</param>
  19595. <returns>HSSFCellStyle object at the index</returns>
  19596. </member>
  19597. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Close">
  19598. Closes the underlying {@link NPOIFSFileSystem} from which
  19599. the Workbook was read, if any. Has no effect on Workbooks
  19600. opened from an InputStream, or newly created ones.
  19601. Once {@link #close()} has been called, no further
  19602. operations, updates or reads should be performed on the
  19603. Workbook.
  19604. </member>
  19605. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write">
  19606. Write out this workbook to the currently open {@link File} via the
  19607. writeable {@link POIFSFileSystem} it was opened as.
  19608. This will fail (with an {@link InvalidOperationException} if the
  19609. Workbook was opened read-only, opened from an {@link InputStream}
  19610. instead of a File, or if this is not the root document. For those cases,
  19611. you must use {@link #write(OutputStream)} or {@link #write(File)} to
  19612. write to a brand new document.
  19613. </member>
  19614. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.FileInfo)">
  19615. Method write - write out this workbook to a new {@link File}. Constructs
  19616. a new POI POIFSFileSystem, passes in the workbook binary representation and
  19617. writes it out. If the file exists, it will be replaced, otherwise a new one
  19618. will be created.
  19619. Note that you cannot write to the currently open File using this method.
  19620. If you opened your Workbook from a File, you <i>must</i> use the {@link #write()}
  19621. method instead!
  19622. @param newFile - the new File you wish to write the XLS to
  19623. @exception IOException if anything can't be written.
  19624. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  19625. </member>
  19626. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.Stream)">
  19627. <summary>
  19628. Write out this workbook to an Outputstream. Constructs
  19629. a new POI POIFSFileSystem, passes in the workbook binary representation and
  19630. Writes it out.
  19631. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  19632. or has a high cost/latency associated with each written byte,
  19633. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  19634. to improve write performance.
  19635. </summary>
  19636. <param name="stream">the java OutputStream you wish to Write the XLS to</param>
  19637. </member>
  19638. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  19639. Writes the workbook out to a brand new, empty POIFS
  19640. </member>
  19641. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetBytes">
  19642. <summary>
  19643. Get the bytes of just the HSSF portions of the XLS file.
  19644. Use this to construct a POI POIFSFileSystem yourself.
  19645. </summary>
  19646. <returns>byte[] array containing the binary representation of this workbook and all contained
  19647. sheets, rows, cells, etc.</returns>
  19648. </member>
  19649. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._udfFinder">
  19650. The locator of user-defined functions.
  19651. By default includes functions from the Excel Analysis Toolpack
  19652. </member>
  19653. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  19654. Register a new toolpack in this workbook.
  19655. @param toopack the toolpack to register
  19656. </member>
  19657. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.Workbook">
  19658. <summary>
  19659. Gets the workbook.
  19660. </summary>
  19661. <value>The workbook.</value>
  19662. </member>
  19663. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfNames">
  19664. <summary>
  19665. Gets the total number of named ranges in the workboko
  19666. </summary>
  19667. <value>The number of named ranges</value>
  19668. </member>
  19669. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameAt(System.Int32)">
  19670. <summary>
  19671. Gets the Named range
  19672. </summary>
  19673. <param name="nameIndex">position of the named range</param>
  19674. <returns>named range high level</returns>
  19675. </member>
  19676. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameName(System.Int32)">
  19677. <summary>
  19678. Gets the named range name
  19679. </summary>
  19680. <param name="index">the named range index (0 based)</param>
  19681. <returns>named range name</returns>
  19682. </member>
  19683. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.String)">
  19684. <summary>
  19685. Sets the printarea for the sheet provided
  19686. i.e. Reference = $A$1:$B$2
  19687. </summary>
  19688. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  19689. <param name="reference">Valid name Reference for the Print Area</param>
  19690. </member>
  19691. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  19692. <summary>
  19693. Sets the print area.
  19694. </summary>
  19695. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  19696. <param name="startColumn">Column to begin printarea</param>
  19697. <param name="endColumn">Column to end the printarea</param>
  19698. <param name="startRow">Row to begin the printarea</param>
  19699. <param name="endRow">Row to end the printarea</param>
  19700. </member>
  19701. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetPrintArea(System.Int32)">
  19702. <summary>
  19703. Retrieves the reference for the printarea of the specified sheet, the sheet name Is Appended to the reference even if it was not specified.
  19704. </summary>
  19705. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  19706. <returns>String Null if no print area has been defined</returns>
  19707. </member>
  19708. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemovePrintArea(System.Int32)">
  19709. <summary>
  19710. Delete the printarea for the sheet specified
  19711. </summary>
  19712. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  19713. </member>
  19714. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateName">
  19715. <summary>
  19716. Creates a new named range and Add it to the model
  19717. </summary>
  19718. <returns>named range high level</returns>
  19719. </member>
  19720. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(System.String)">
  19721. <summary>
  19722. Gets the named range index by his name
  19723. Note:
  19724. Excel named ranges are case-insensitive and
  19725. this method performs a case-insensitive search.
  19726. </summary>
  19727. <param name="name">named range name</param>
  19728. <returns>named range index</returns>
  19729. </member>
  19730. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(NPOI.HSSF.UserModel.HSSFName)">
  19731. <summary>
  19732. As GetNameIndex(String) is not necessarily unique
  19733. (name + sheet index is unique), this method is more accurate.
  19734. </summary>
  19735. <param name="name">the name whose index in the list of names of this workbook should be looked up.</param>
  19736. <returns>an index value >= 0 if the name was found; -1, if the name was not found</returns>
  19737. </member>
  19738. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.Int32)">
  19739. <summary>
  19740. Remove the named range by his index
  19741. </summary>
  19742. <param name="index">The named range index (0 based)</param>
  19743. </member>
  19744. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateDataFormat">
  19745. <summary>
  19746. Creates the instance of HSSFDataFormat for this workbook.
  19747. </summary>
  19748. <returns>the HSSFDataFormat object</returns>
  19749. </member>
  19750. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.String)">
  19751. <summary>
  19752. Remove the named range by his name
  19753. </summary>
  19754. <param name="name">named range name</param>
  19755. </member>
  19756. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  19757. <summary>
  19758. As #removeName(String) is not necessarily unique (name + sheet index is unique),
  19759. this method is more accurate.
  19760. </summary>
  19761. <param name="name">the name to remove.</param>
  19762. </member>
  19763. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.DumpDrawingGroupRecords(System.Boolean)">
  19764. <summary>
  19765. Spits out a list of all the drawing records in the workbook.
  19766. </summary>
  19767. <param name="fat">if set to <c>true</c> [fat].</param>
  19768. </member>
  19769. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  19770. <summary>
  19771. Adds a picture to the workbook.
  19772. </summary>
  19773. <param name="pictureData">The bytes of the picture</param>
  19774. <param name="format">The format of the picture. One of
  19775. PictureType.</param>
  19776. <returns>the index to this picture (1 based).</returns>
  19777. </member>
  19778. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllPictures">
  19779. <summary>
  19780. Gets all pictures from the Workbook.
  19781. </summary>
  19782. <returns>the list of pictures (a list of HSSFPictureData objects.)</returns>
  19783. </member>
  19784. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SearchForPictures(System.Collections.IList,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFPictureData})">
  19785. <summary>
  19786. Performs a recursive search for pictures in the given list of escher records.
  19787. </summary>
  19788. <param name="escherRecords">the escher records.</param>
  19789. <param name="pictures">the list to populate with the pictures.</param>
  19790. </member>
  19791. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  19792. <summary>
  19793. Adds the LinkTable records required to allow formulas referencing
  19794. the specified external workbook to be added to this one. Allows
  19795. formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the
  19796. file, for workbooks not already referenced.
  19797. </summary>
  19798. <param name="name">The name the workbook will be referenced as in formulas</param>
  19799. <param name="workbook">The open workbook to fetch the link required information from</param>
  19800. <returns></returns>
  19801. </member>
  19802. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.IsWriteProtected">
  19803. <summary>
  19804. Is the workbook protected with a password (not encrypted)?
  19805. </summary>
  19806. <value>
  19807. <c>true</c> if this instance is write protected; otherwise, <c>false</c>.
  19808. </value>
  19809. </member>
  19810. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.WriteProtectWorkbook(System.String,System.String)">
  19811. <summary>
  19812. protect a workbook with a password (not encypted, just Sets Writeprotect
  19813. flags and the password.
  19814. </summary>
  19815. <param name="password">password to set</param>
  19816. <param name="username">The username.</param>
  19817. </member>
  19818. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.UnwriteProtectWorkbook">
  19819. <summary>
  19820. Removes the Write protect flag
  19821. </summary>
  19822. </member>
  19823. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects">
  19824. <summary>
  19825. Gets all embedded OLE2 objects from the Workbook.
  19826. </summary>
  19827. <returns>the list of embedded objects (a list of HSSFObjectData objects.)</returns>
  19828. </member>
  19829. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFSheet,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  19830. <summary>
  19831. Gets all embedded OLE2 objects from the Workbook.
  19832. </summary>
  19833. <param name="sheet">the list of records to search.</param>
  19834. <param name="objects">the list of embedded objects to populate.</param>
  19835. </member>
  19836. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  19837. <summary>
  19838. Recursively iterates a shape container to get all embedded objects.
  19839. </summary>
  19840. <param name="parent">the parent.</param>
  19841. <param name="objects">the list of embedded objects to populate.</param>
  19842. </member>
  19843. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NewUID">
  19844. <summary>
  19845. Gets the new UID.
  19846. </summary>
  19847. <value>The new UID.</value>
  19848. </member>
  19849. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetEnumerator">
  19850. <summary>
  19851. Support foreach ISheet, e.g.
  19852. HSSFWorkbook workbook = new HSSFWorkbook();
  19853. foreach(ISheet sheet in workbook) ...
  19854. </summary>
  19855. <returns>Enumeration of all the sheets of this workbook</returns>
  19856. </member>
  19857. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ForceFormulaRecalculation">
  19858. <summary>
  19859. Whether the application shall perform a full recalculation when the workbook is opened.
  19860. Typically you want to force formula recalculation when you modify cell formulas or values
  19861. of a workbook previously created by Excel. When set to true, this flag will tell Excel
  19862. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  19863. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  19864. Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
  19865. on close.
  19866. Value is true if the application will perform a full recalculation of
  19867. workbook values when the workbook is opened.
  19868. since 3.8
  19869. </summary>
  19870. </member>
  19871. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.SpreadsheetVersion">
  19872. <summary>
  19873. Returns the spreadsheet version (EXCLE97) of this workbook
  19874. </summary>
  19875. </member>
  19876. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ChangeExternalReference(System.String,System.String)">
  19877. Changes an external referenced file to another file.
  19878. A formular in Excel which refers a cell in another file is saved in two parts:
  19879. The referenced file is stored in an reference table. the row/cell information is saved separate.
  19880. This method invokation will only change the reference in the lookup-table itself.
  19881. @param oldUrl The old URL to search for and which is to be replaced
  19882. @param newUrl The URL replacement
  19883. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  19884. </member>
  19885. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsDate1904">
  19886. <summary>
  19887. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  19888. The default value is false, meaning that the workbook uses the 1900 date system,
  19889. where 1/1/1900 is the first day in the system.
  19890. </summary>
  19891. <returns>True if the date systems used in the workbook starts in 1904</returns>
  19892. </member>
  19893. <member name="T:NPOI.HSSF.UserModel.OperationEvaluatorFactory">
  19894. This class Creates <c>OperationEval</c> instances to help evaluate <c>OperationPtg</c>
  19895. formula tokens.
  19896. @author Josh Micich
  19897. </member>
  19898. <member name="M:NPOI.HSSF.UserModel.OperationEvaluatorFactory.Create(NPOI.SS.Formula.PTG.OperationPtg)">
  19899. returns the OperationEval concrete impl instance corresponding
  19900. to the supplied operationPtg
  19901. </member>
  19902. <member name="T:NPOI.HSSF.UserModel.StaticFontMetrics">
  19903. Allows the user to lookup the font metrics for a particular font without
  19904. actually having the font on the system. The font details are Loaded
  19905. as a resource from the POI jar file (or classpath) and should be contained
  19906. in path "/font_metrics.properties". The font widths are for a 10 point
  19907. version of the font. Use a multiplier for other sizes.
  19908. @author Glen Stampoultzis (glens at apache.org)
  19909. </member>
  19910. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontMetricsProps">
  19911. The font metrics property file we're using
  19912. </member>
  19913. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontDetailsMap">
  19914. Our cache of font details we've alReady looked up
  19915. </member>
  19916. <member name="M:NPOI.HSSF.UserModel.StaticFontMetrics.GetFontDetails(System.Drawing.Font)">
  19917. Retrieves the fake font details for a given font.
  19918. @param font the font to lookup.
  19919. @return the fake font.
  19920. </member>
  19921. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.DummyRecordBase">
  19922. </member>
  19923. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord">
  19924. A dummy record to indicate that we've now had the last
  19925. cell record for this row.
  19926. </member>
  19927. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.Row">
  19928. Returns the (0 based) number of the row we are
  19929. currently working on.
  19930. </member>
  19931. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.LastColumnNumber">
  19932. Returns the (0 based) number of the last column
  19933. seen for this row. You should have alReady been
  19934. called with that record.
  19935. This Is -1 in the case of there being no columns
  19936. for the row.
  19937. </member>
  19938. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingCellDummyRecord">
  19939. A dummy record for when we're missing a cell in a row,
  19940. but still want to trigger something
  19941. </member>
  19942. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingRowDummyRecord">
  19943. A dummy record for when we're missing a row, but still
  19944. want to trigger something
  19945. </member>
  19946. <member name="T:NPOI.HSSF.EventUserModel.AbortableHSSFListener">
  19947. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  19948. a listener supporting this interface and register it with the HSSFRequest (associating
  19949. it with Record SID's).
  19950. @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
  19951. @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  19952. @see org.apache.poi.hssf.eventusermodel.HSSFUserException
  19953. @author Carey Sublette (careysub@earthling.net)
  19954. </member>
  19955. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  19956. This method, inherited from HSSFListener Is implemented as a stub.
  19957. It Is never called by HSSFEventFActory or HSSFRequest.
  19958. </member>
  19959. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.AbortableProcessRecord(NPOI.HSSF.Record.Record)">
  19960. Process an HSSF Record. Called when a record occurs in an HSSF file.
  19961. Provides two options for halting the Processing of the HSSF file.
  19962. The return value provides a means of non-error termination with a
  19963. user-defined result code. A value of zero must be returned to
  19964. continue Processing, any other value will halt Processing by
  19965. <c>HSSFEventFactory</c> with the code being passed back by
  19966. its abortable Process events methods.
  19967. Error termination can be done by throwing the HSSFUserException.
  19968. Note that HSSFEventFactory will not call the inherited Process
  19969. @return result code of zero for continued Processing.
  19970. @throws HSSFUserException User code can throw this to abort
  19971. file Processing by HSSFEventFactory and return diagnostic information.
  19972. </member>
  19973. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder">
  19974. <summary>
  19975. When working with the EventUserModel, if you want to
  19976. Process formulas, you need an instance of
  19977. Workbook to pass to a HSSFWorkbook,
  19978. to finally give to HSSFFormulaParser,
  19979. and this will build you stub ones.
  19980. Since you're working with the EventUserModel, you
  19981. wouldn't want to Get a full Workbook and
  19982. HSSFWorkbook, as they would eat too much memory.
  19983. Instead, you should collect a few key records as they
  19984. go past, then call this once you have them to build a
  19985. stub Workbook, and from that a stub
  19986. HSSFWorkbook, to use with the HSSFFormulaParser.
  19987. The records you should collect are:
  19988. ExternSheetRecord
  19989. BoundSheetRecord
  19990. You should probably also collect SSTRecord,
  19991. but it's not required to pass this in.
  19992. To help, this class includes a HSSFListener wrapper
  19993. that will do the collecting for you.
  19994. </summary>
  19995. </member>
  19996. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[],NPOI.HSSF.Record.SSTRecord)">
  19997. <summary>
  19998. Creates a stub Workbook from the supplied records,
  19999. suitable for use with the {@link HSSFFormulaParser}
  20000. </summary>
  20001. <param name="externs">The ExternSheetRecords in your file</param>
  20002. <param name="bounds">The BoundSheetRecords in your file</param>
  20003. <param name="sst">TThe SSTRecord in your file.</param>
  20004. <returns>A stub Workbook suitable for use with HSSFFormulaParser</returns>
  20005. </member>
  20006. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[])">
  20007. <summary>
  20008. Creates a stub workbook from the supplied records,
  20009. suitable for use with the HSSFFormulaParser
  20010. </summary>
  20011. <param name="externs">The ExternSheetRecords in your file</param>
  20012. <param name="bounds">A stub Workbook suitable for use with HSSFFormulaParser</param>
  20013. <returns>A stub Workbook suitable for use with {@link HSSFFormulaParser}</returns>
  20014. </member>
  20015. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener">
  20016. <summary>
  20017. A wrapping HSSFListener which will collect
  20018. BoundSheetRecords and {@link ExternSheetRecord}s as
  20019. they go past, so you can Create a Stub {@link Workbook} from
  20020. them once required.
  20021. </summary>
  20022. </member>
  20023. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  20024. <summary>
  20025. Initializes a new instance of the <see cref="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener"/> class.
  20026. </summary>
  20027. <param name="childListener">The child listener.</param>
  20028. </member>
  20029. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetBoundSheetRecords">
  20030. <summary>
  20031. Gets the bound sheet records.
  20032. </summary>
  20033. <returns></returns>
  20034. </member>
  20035. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetExternSheetRecords">
  20036. <summary>
  20037. Gets the extern sheet records.
  20038. </summary>
  20039. <returns></returns>
  20040. </member>
  20041. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetSSTRecord">
  20042. <summary>
  20043. Gets the SST record.
  20044. </summary>
  20045. <returns></returns>
  20046. </member>
  20047. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubHSSFWorkbook">
  20048. <summary>
  20049. Gets the stub HSSF workbook.
  20050. </summary>
  20051. <returns></returns>
  20052. </member>
  20053. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubWorkbook">
  20054. <summary>
  20055. Gets the stub workbook.
  20056. </summary>
  20057. <returns></returns>
  20058. </member>
  20059. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  20060. <summary>
  20061. Process this record ourselves, and then
  20062. pass it on to our child listener
  20063. </summary>
  20064. <param name="record">The record.</param>
  20065. </member>
  20066. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  20067. <summary>
  20068. Process the record ourselves, but do not
  20069. pass it on to the child Listener.
  20070. </summary>
  20071. <param name="record">The record.</param>
  20072. </member>
  20073. <member name="T:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener">
  20074. A proxy HSSFListener that keeps track of the document
  20075. formatting records, and provides an easy way to look
  20076. up the format strings used by cells from their ids.
  20077. </member>
  20078. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  20079. Process this record ourselves, and then
  20080. pass it on to our child listener
  20081. </member>
  20082. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  20083. Process the record ourselves, but do not
  20084. pass it on to the child Listener.
  20085. @param record
  20086. </member>
  20087. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface)">
  20088. Formats the given numeric of date Cell's contents
  20089. as a String, in as close as we can to the way
  20090. that Excel would do so.
  20091. Uses the various format records to manage this.
  20092. TODO - move this to a central class in such a
  20093. way that hssf.usermodel can make use of it too
  20094. </member>
  20095. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(System.Int32)">
  20096. Returns the format string, eg $##.##, for the
  20097. given number format index.
  20098. </member>
  20099. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(NPOI.HSSF.Record.CellValueRecordInterface)">
  20100. Returns the format string, eg $##.##, used
  20101. by your cell
  20102. </member>
  20103. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatIndex(NPOI.HSSF.Record.CellValueRecordInterface)">
  20104. Returns the index of the format string, used by your cell,
  20105. or -1 if none found
  20106. </member>
  20107. <member name="T:NPOI.HSSF.EventUserModel.HSSFEventFactory">
  20108. <summary>
  20109. Low level event based HSSF Reader. Pass either a DocumentInputStream to
  20110. Process events along with a request object or pass a POIFS POIFSFileSystem to
  20111. ProcessWorkbookEvents along with a request.
  20112. This will cause your file to be Processed a record at a time. Each record with
  20113. a static id matching one that you have registed in your HSSFRequest will be passed
  20114. to your associated HSSFListener.
  20115. @author Andrew C. Oliver (acoliver at apache dot org)
  20116. @author Carey Sublette (careysub@earthling.net)
  20117. </summary>
  20118. </member>
  20119. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.#ctor">
  20120. <summary>
  20121. Creates a new instance of HSSFEventFactory
  20122. </summary>
  20123. </member>
  20124. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  20125. <summary>
  20126. Processes a file into essentially record events.
  20127. </summary>
  20128. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  20129. <param name="fs">a POIFS filesystem containing your workbook</param>
  20130. </member>
  20131. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  20132. <summary>
  20133. Processes a file into essentially record events.
  20134. </summary>
  20135. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  20136. <param name="fs">a POIFS filesystem containing your workbook</param>
  20137. <returns>numeric user-specified result code.</returns>
  20138. </member>
  20139. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  20140. <summary>
  20141. Processes a DocumentInputStream into essentially Record events.
  20142. If an
  20143. <c>AbortableHSSFListener</c>
  20144. causes a halt to Processing during this call
  20145. the method will return just as with
  20146. <c>abortableProcessEvents</c>
  20147. , but no
  20148. user code or
  20149. <c>HSSFUserException</c>
  20150. will be passed back.
  20151. </summary>
  20152. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  20153. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  20154. </member>
  20155. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  20156. <summary>
  20157. Processes a DocumentInputStream into essentially Record events.
  20158. </summary>
  20159. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  20160. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  20161. <returns>numeric user-specified result code.</returns>
  20162. </member>
  20163. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.GenericProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.HSSF.Record.RecordInputStream)">
  20164. <summary>
  20165. Processes a DocumentInputStream into essentially Record events.
  20166. </summary>
  20167. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  20168. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  20169. <returns>numeric user-specified result code.</returns>
  20170. </member>
  20171. <member name="T:NPOI.HSSF.EventUserModel.IHSSFListener">
  20172. <summary>
  20173. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  20174. a listener supporting this interface and register it with the HSSFRequest (associating
  20175. it with Record SID's).
  20176. @author acoliver@apache.org
  20177. </summary>
  20178. </member>
  20179. <member name="M:NPOI.HSSF.EventUserModel.IHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  20180. <summary>
  20181. Process an HSSF Record. Called when a record occurs in an HSSF file.
  20182. </summary>
  20183. <param name="record">The record.</param>
  20184. </member>
  20185. <member name="T:NPOI.HSSF.EventUserModel.HSSFRecordStream">
  20186. <summary>
  20187. A stream based way to Get at complete records, with
  20188. as low a memory footprint as possible.
  20189. This handles Reading from a RecordInputStream, turning
  20190. the data into full records, Processing continue records
  20191. etc.
  20192. Most users should use HSSFEventFactory
  20193. HSSFListener and have new records pushed to
  20194. them, but this does allow for a "pull" style of coding.
  20195. </summary>
  20196. </member>
  20197. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.hitEOS">
  20198. Have we run out of records on the stream?
  20199. </member>
  20200. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.complete">
  20201. Have we returned all the records there are?
  20202. </member>
  20203. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.bonusRecords">
  20204. Sometimes we end up with a bunch of
  20205. records. When we do, these should
  20206. be returned before the next normal
  20207. record Processing occurs (i.e. before
  20208. we Check for continue records and
  20209. return rec)
  20210. </member>
  20211. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.rec">
  20212. The next record to return, which may need to have its
  20213. continue records passed to it before we do
  20214. </member>
  20215. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastRec">
  20216. The most recent record that we gave to the user
  20217. </member>
  20218. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastDrawingRecord">
  20219. The most recent DrawingRecord seen
  20220. </member>
  20221. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.NextRecord">
  20222. <summary>
  20223. Returns the next (complete) record from the
  20224. stream, or null if there are no more.
  20225. </summary>
  20226. <returns></returns>
  20227. </member>
  20228. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetBonusRecord">
  20229. <summary>
  20230. If there are any "bonus" records, that should
  20231. be returned before Processing new ones,
  20232. grabs the next and returns it.
  20233. If not, returns null;
  20234. </summary>
  20235. <returns></returns>
  20236. </member>
  20237. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetNextRecord">
  20238. <summary>
  20239. Returns the next available record, or null if
  20240. this pass didn't return a record that's
  20241. suitable for returning (eg was a continue record).
  20242. </summary>
  20243. <returns></returns>
  20244. </member>
  20245. <member name="T:NPOI.HSSF.EventUserModel.HSSFRequest">
  20246. <summary>
  20247. An HSSFRequest object should be constructed registering an instance or multiple
  20248. instances of HSSFListener with each Record.sid you wish to listen for.
  20249. @author Andrew C. Oliver (acoliver at apache dot org)
  20250. @author Carey Sublette (careysub@earthling.net)
  20251. </summary>
  20252. </member>
  20253. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.#ctor">
  20254. <summary>
  20255. Creates a new instance of HSSFRequest
  20256. </summary>
  20257. </member>
  20258. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListener(NPOI.HSSF.EventUserModel.IHSSFListener,System.Int16)">
  20259. <summary>
  20260. Add an event listener for a particular record type. The trick Is you have to know
  20261. what the records are for or just start with our examples and build on them. Alternatively,
  20262. you CAN call AddListenerForAllRecords and you'll recieve ALL record events in one listener,
  20263. but if you like to squeeze every last byte of efficiency out of life you my not like this.
  20264. (its sure as heck what I plan to do)
  20265. </summary>
  20266. <param name="lsnr">for the event</param>
  20267. <param name="sid">identifier for the record type this Is the .sid static member on the individual records</param>
  20268. </member>
  20269. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListenerForAllRecords(NPOI.HSSF.EventUserModel.IHSSFListener)">
  20270. <summary>
  20271. This Is the equivilent of calling AddListener(myListener, sid) for EVERY
  20272. record in the org.apache.poi.hssf.record package. This Is for lazy
  20273. people like me. You can call this more than once with more than one listener, but
  20274. that seems like a bad thing to do from a practice-perspective Unless you have a
  20275. compelling reason to do so (like maybe you send the event two places or log it or
  20276. something?).
  20277. </summary>
  20278. <param name="lsnr">a single listener to associate with ALL records</param>
  20279. </member>
  20280. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.ProcessRecord(NPOI.HSSF.Record.Record)">
  20281. <summary>
  20282. Called by HSSFEventFactory, passes the Record to each listener associated with
  20283. a record.sid.
  20284. Exception and return value Added 2002-04-19 by Carey Sublette
  20285. </summary>
  20286. <param name="rec">The record.</param>
  20287. <returns>numeric user-specified result code. If zero continue Processing.</returns>
  20288. </member>
  20289. <member name="T:NPOI.HSSF.EventUserModel.HSSFUserException">
  20290. <summary>
  20291. This exception Is provided as a way for API users to throw
  20292. exceptions from their event handling code. By doing so they
  20293. abort file Processing by the HSSFEventFactory and by
  20294. catching it from outside the HSSFEventFactory.ProcessEvents
  20295. method they can diagnose the cause for the abort.
  20296. The HSSFUserException supports a nested "reason"
  20297. throwable, i.e. an exception that caused this one to be thrown.
  20298. The HSSF package does not itself throw any of these
  20299. exceptions.
  20300. </summary>
  20301. <remarks>
  20302. @author Rainer Klute (klute@rainer-klute.de)
  20303. @author Carey Sublette (careysub@earthling.net)
  20304. </remarks>
  20305. </member>
  20306. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor">
  20307. <summary>
  20308. Creates a new HSSFUserException
  20309. </summary>
  20310. </member>
  20311. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String)">
  20312. <summary>
  20313. Creates a new HSSFUserException with a message
  20314. string.
  20315. </summary>
  20316. <param name="msg">The MSG.</param>
  20317. </member>
  20318. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.Exception)">
  20319. <summary>
  20320. Creates a new HSSFUserException with a reason.
  20321. </summary>
  20322. <param name="reason">The reason.</param>
  20323. </member>
  20324. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String,System.Exception)">
  20325. <summary>
  20326. Creates a new HSSFUserException with a message string
  20327. and a reason.
  20328. </summary>
  20329. <param name="msg">The MSG.</param>
  20330. <param name="reason">The reason.</param>
  20331. </member>
  20332. <member name="T:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener">
  20333. <summary>
  20334. A HSSFListener which tracks rows and columns, and will
  20335. trigger your HSSFListener for all rows and cells,
  20336. even the ones that aren't actually stored in the file.
  20337. This allows your code to have a more "Excel" like
  20338. view of the data in the file, and not have to worry
  20339. (as much) about if a particular row/cell Is in the
  20340. file, or was skipped from being written as it was
  20341. blank.
  20342. </summary>
  20343. </member>
  20344. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  20345. <summary>
  20346. Constructs a new MissingRecordAwareHSSFListener, which
  20347. will fire ProcessRecord on the supplied child
  20348. HSSFListener for all Records, and missing records.
  20349. </summary>
  20350. <param name="listener">The HSSFListener to pass records on to</param>
  20351. </member>
  20352. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  20353. <summary>
  20354. Process an HSSF Record. Called when a record occurs in an HSSF file.
  20355. </summary>
  20356. <param name="record"></param>
  20357. </member>
  20358. <member name="F:NPOI.HSSF.XmlTkBlob.xtHeader">
  20359. <summary>
  20360. The xtHeader.drType field MUST be equal to 0x07.
  20361. </summary>
  20362. </member>
  20363. <member name="F:NPOI.HSSF.XmlTkBool.xtHeader">
  20364. <summary>
  20365. The xtHeader.drType field MUST be equal to 0x02.
  20366. </summary>
  20367. </member>
  20368. <member name="F:NPOI.HSSF.XmlTkDouble.xtHeader">
  20369. <summary>
  20370. The xtHeader.drType field MUST be equal to 0x03.
  20371. </summary>
  20372. </member>
  20373. <member name="F:NPOI.HSSF.XmlTkDWord.xtHeader">
  20374. <summary>
  20375. The xtHeader.drType field MUST be equal to 0x04.
  20376. </summary>
  20377. </member>
  20378. <member name="F:NPOI.HSSF.XmlTkEnd.xtHeader">
  20379. <summary>
  20380. The xtHeader.drType field MUST be equal to 0x01.
  20381. </summary>
  20382. </member>
  20383. <member name="F:NPOI.HSSF.XmlTkString.xtHeader">
  20384. <summary>
  20385. The xtHeader.drType field MUST be equal to 0x05.
  20386. </summary>
  20387. </member>
  20388. <member name="F:NPOI.HSSF.XmlTkString.rgbValue">
  20389. <summary>
  20390. An array of Unicode characters. The size of the array, in characters, is specified
  20391. by the cchValue field. The size of the field, in bytes, MUST equal the result of
  20392. the following formula:cchValue * 2.
  20393. </summary>
  20394. </member>
  20395. <member name="F:NPOI.HSSF.XmlTkStyle.chartStyle">
  20396. <summary>
  20397. The chartStyle.xtHeader.xmlTkTag MUST be equal to 0x0003.
  20398. </summary>
  20399. </member>
  20400. <member name="F:NPOI.HSSF.XmlTkTickMarkSkipFrt.nInterval">
  20401. <summary>
  20402. The nInterval.xtHeader.xmlTkTag field MUST be equal to 0x0052.
  20403. </summary>
  20404. </member>
  20405. <member name="T:NPOI.HSSF.Util.LazilyConcatenatedByteArray">
  20406. Utility for delaying the concatenation of multiple byte arrays. Doing this up-front
  20407. causes significantly more copying, which for a large number of byte arrays can cost
  20408. a large amount of time.
  20409. </member>
  20410. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Clear">
  20411. Clears the array (sets the concatenated length back to zero.
  20412. </member>
  20413. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Concatenate(System.Byte[])">
  20414. Concatenates an array onto the end of our array.
  20415. This is a relatively fast operation.
  20416. @param array the array to concatenate.
  20417. @throws ArgumentException if {@code array} is {@code null}.
  20418. </member>
  20419. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.ToArray">
  20420. Gets the concatenated contents as a single byte array.
  20421. This is a slower operation, but the concatenated array is stored off as a single
  20422. array again so that subsequent calls will not perform Additional copying.
  20423. @return the byte array. Returns {@code null} if no data has been placed into it.
  20424. </member>
  20425. <member name="T:NPOI.HSSF.Util.HSSFCellUtil">
  20426. <summary>
  20427. Various utility functions that make working with a cells and rows easier. The various
  20428. methods that deal with style's allow you to Create your HSSFCellStyles as you need them.
  20429. When you apply a style change to a cell, the code will attempt to see if a style already
  20430. exists that meets your needs. If not, then it will Create a new style. This is to prevent
  20431. creating too many styles. there is an upper limit in Excel on the number of styles that
  20432. can be supported.
  20433. @author Eric Pugh epugh@upstate.com
  20434. </summary>
  20435. </member>
  20436. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetRow(System.Int32,NPOI.HSSF.UserModel.HSSFSheet)">
  20437. <summary>
  20438. Get a row from the spreadsheet, and Create it if it doesn't exist.
  20439. </summary>
  20440. <param name="rowCounter">The 0 based row number</param>
  20441. <param name="sheet">The sheet that the row is part of.</param>
  20442. <returns>The row indicated by the rowCounter</returns>
  20443. </member>
  20444. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  20445. <summary>
  20446. Get a specific cell from a row. If the cell doesn't exist,
  20447. </summary>
  20448. <param name="row">The row that the cell is part of</param>
  20449. <param name="column">The column index that the cell is in.</param>
  20450. <returns>The cell indicated by the column.</returns>
  20451. </member>
  20452. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.HSSF.UserModel.HSSFCellStyle)">
  20453. <summary>
  20454. Creates a cell, gives it a value, and applies a style if provided
  20455. </summary>
  20456. <param name="row">the row to Create the cell in</param>
  20457. <param name="column">the column index to Create the cell in</param>
  20458. <param name="value">The value of the cell</param>
  20459. <param name="style">If the style is not null, then Set</param>
  20460. <returns>A new HSSFCell</returns>
  20461. </member>
  20462. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  20463. <summary>
  20464. Create a cell, and give it a value.
  20465. </summary>
  20466. <param name="row">the row to Create the cell in</param>
  20467. <param name="column">the column index to Create the cell in</param>
  20468. <param name="value">The value of the cell</param>
  20469. <returns>A new HSSFCell.</returns>
  20470. </member>
  20471. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.Int16)">
  20472. <summary>
  20473. Take a cell, and align it.
  20474. </summary>
  20475. <param name="cell">the cell to Set the alignment for</param>
  20476. <param name="workbook">The workbook that is being worked with.</param>
  20477. <param name="align">the column alignment to use.</param>
  20478. </member>
  20479. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFFont)">
  20480. <summary>
  20481. Take a cell, and apply a font to it
  20482. </summary>
  20483. <param name="cell">the cell to Set the alignment for</param>
  20484. <param name="workbook">The workbook that is being worked with.</param>
  20485. <param name="font">The HSSFFont that you want to Set...</param>
  20486. </member>
  20487. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.String,System.Object)">
  20488. This method attempt to find an already existing HSSFCellStyle that matches
  20489. what you want the style to be. If it does not find the style, then it
  20490. Creates a new one. If it does Create a new one, then it applies the
  20491. propertyName and propertyValue to the style. This is necessary because
  20492. Excel has an upper limit on the number of Styles that it supports.
  20493. @param workbook The workbook that is being worked with.
  20494. @param propertyName The name of the property that is to be
  20495. changed.
  20496. @param propertyValue The value of the property that is to be
  20497. changed.
  20498. @param cell The cell that needs it's style changes
  20499. @exception NestableException Thrown if an error happens.
  20500. </member>
  20501. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  20502. <summary>
  20503. Looks for text in the cell that should be unicode, like alpha; and provides the
  20504. unicode version of it.
  20505. </summary>
  20506. <param name="cell">The cell to check for unicode values</param>
  20507. <returns>transalted to unicode</returns>
  20508. </member>
  20509. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.RemapCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle,System.Collections.Generic.Dictionary{System.Int16,System.Int16})">
  20510. <summary>
  20511. Translate color palette entries from the source to the destination sheet
  20512. </summary>
  20513. </member>
  20514. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil">
  20515. <summary>
  20516. Various utility functions that make working with a region of cells easier.
  20517. @author Eric Pugh epugh@upstate.com
  20518. </summary>
  20519. </member>
  20520. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil.CellPropertySetter">
  20521. <summary>
  20522. For setting the same property on many cells to the same value
  20523. </summary>
  20524. </member>
  20525. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderLeft(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20526. <summary>
  20527. Sets the left border for a region of cells by manipulating the cell style
  20528. of the individual cells on the left
  20529. </summary>
  20530. <param name="border">The new border</param>
  20531. <param name="region">The region that should have the border</param>
  20532. <param name="sheet">The sheet that the region is on.</param>
  20533. <param name="workbook">The workbook that the region is on.</param>
  20534. </member>
  20535. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20536. <summary>
  20537. Sets the leftBorderColor attribute of the HSSFRegionUtil object
  20538. </summary>
  20539. <param name="color">The color of the border</param>
  20540. <param name="region">The region that should have the border</param>
  20541. <param name="sheet">The sheet that the region is on.</param>
  20542. <param name="workbook">The workbook that the region is on.</param>
  20543. </member>
  20544. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderRight(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20545. <summary>
  20546. Sets the borderRight attribute of the HSSFRegionUtil object
  20547. </summary>
  20548. <param name="border">The new border</param>
  20549. <param name="region">The region that should have the border</param>
  20550. <param name="sheet">The sheet that the region is on.</param>
  20551. <param name="workbook">The workbook that the region is on.</param>
  20552. </member>
  20553. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20554. <summary>
  20555. Sets the rightBorderColor attribute of the HSSFRegionUtil object
  20556. </summary>
  20557. <param name="color">The color of the border</param>
  20558. <param name="region">The region that should have the border</param>
  20559. <param name="sheet">The workbook that the region is on.</param>
  20560. <param name="workbook">The sheet that the region is on.</param>
  20561. </member>
  20562. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderBottom(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20563. <summary>
  20564. Sets the borderBottom attribute of the HSSFRegionUtil object
  20565. </summary>
  20566. <param name="border">The new border</param>
  20567. <param name="region">The region that should have the border</param>
  20568. <param name="sheet">The sheet that the region is on.</param>
  20569. <param name="workbook">The workbook that the region is on.</param>
  20570. </member>
  20571. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20572. <summary>
  20573. Sets the bottomBorderColor attribute of the HSSFRegionUtil object
  20574. </summary>
  20575. <param name="color">The color of the border</param>
  20576. <param name="region">The region that should have the border</param>
  20577. <param name="sheet">The sheet that the region is on.</param>
  20578. <param name="workbook">The workbook that the region is on.</param>
  20579. </member>
  20580. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderTop(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20581. <summary>
  20582. Sets the borderBottom attribute of the HSSFRegionUtil object
  20583. </summary>
  20584. <param name="border">The new border</param>
  20585. <param name="region">The region that should have the border</param>
  20586. <param name="sheet">The sheet that the region is on.</param>
  20587. <param name="workbook">The workbook that the region is on.</param>
  20588. </member>
  20589. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20590. <summary>
  20591. Sets the topBorderColor attribute of the HSSFRegionUtil object
  20592. </summary>
  20593. <param name="color">The color of the border</param>
  20594. <param name="region">The region that should have the border</param>
  20595. <param name="sheet">The sheet that the region is on.</param>
  20596. <param name="workbook">The workbook that the region is on.</param>
  20597. </member>
  20598. <member name="F:NPOI.HSSF.Util.GUID._d1">
  20599. 4 bytes - little endian
  20600. </member>
  20601. <member name="F:NPOI.HSSF.Util.GUID._d2">
  20602. 2 bytes - little endian
  20603. </member>
  20604. <member name="F:NPOI.HSSF.Util.GUID._d3">
  20605. 2 bytes - little endian
  20606. </member>
  20607. <member name="F:NPOI.HSSF.Util.GUID._d4">
  20608. 8 bytes - serialized as big endian, stored with inverted endianness here
  20609. </member>
  20610. <member name="M:NPOI.HSSF.Util.GUID.Parse(System.String)">
  20611. Read a GUID in standard text form e.g.<br/>
  20612. 13579BDF-0246-8ACE-0123-456789ABCDEF
  20613. <br/> -&gt; <br/>
  20614. 0x13579BDF, 0x0246, 0x8ACE 0x0123456789ABCDEF
  20615. </member>
  20616. <member name="T:NPOI.HSSF.Util.HSSFCellRangeAddress">
  20617. <p>Title: HSSFCellRangeAddress</p>
  20618. <p>Description:
  20619. Implementation of the cell range Address lists,like Is described in
  20620. OpenOffice.org's Excel Documentation .
  20621. In BIFF8 there Is a common way to store absolute cell range Address
  20622. lists in several records (not formulas). A cell range Address list
  20623. consists of a field with the number of ranges and the list of the range
  20624. Addresses. Each cell range Address (called an AddR structure) Contains
  20625. 4 16-bit-values.</p>
  20626. <p>Copyright: Copyright (c) 2004</p>
  20627. <p>Company: </p>
  20628. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  20629. @version 2.0-pre
  20630. </member>
  20631. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_Addr_number">
  20632. Number of following AddR structures
  20633. </member>
  20634. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_regions_list">
  20635. List of AddR structures. Each structure represents a cell range
  20636. </member>
  20637. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  20638. Construct a new HSSFCellRangeAddress object and Sets its fields appropriately .
  20639. Even this Isn't an Excel record , I kept the same behavior for reading/writing
  20640. the object's data as for a regular record .
  20641. @param in the RecordInputstream to read the record from
  20642. </member>
  20643. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddRStructureNumber">
  20644. Get the number of following AddR structures.
  20645. The number of this structures Is automatically Set when reading an Excel file
  20646. and/or increased when you manually Add a new AddR structure .
  20647. This Is the reason there Isn't a Set method for this field .
  20648. @return number of AddR structures
  20649. </member>
  20650. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.AddAddRStructure(System.Int16,System.Int16,System.Int16,System.Int16)">
  20651. Add an AddR structure .
  20652. @param first_row - the upper left hand corner's row
  20653. @param first_col - the upper left hand corner's col
  20654. @param last_row - the lower right hand corner's row
  20655. @param last_col - the lower right hand corner's col
  20656. @return the index of this AddR structure
  20657. </member>
  20658. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.RemoveAddRStructureAt(System.Int32)">
  20659. Remove the AddR structure stored at the passed in index
  20660. @param index The AddR structure's index
  20661. </member>
  20662. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.GetAddRStructureAt(System.Int32)">
  20663. return the AddR structure at the given index.
  20664. @return AddrStructure representing
  20665. </member>
  20666. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstColumn">
  20667. Get the upper left hand corner column number
  20668. @return column number for the upper left hand corner
  20669. </member>
  20670. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstRow">
  20671. Get the upper left hand corner row number
  20672. @return row number for the upper left hand corner
  20673. </member>
  20674. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastColumn">
  20675. Get the lower right hand corner column number
  20676. @return column number for the lower right hand corner
  20677. </member>
  20678. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastRow">
  20679. Get the lower right hand corner row number
  20680. @return row number for the lower right hand corner
  20681. </member>
  20682. <member name="T:NPOI.HSSF.Util.HSSFColor">
  20683. Intends to provide support for the very evil index to triplet Issue and
  20684. will likely replace the color constants interface for HSSF 2.0.
  20685. This class Contains static inner class members for representing colors.
  20686. Each color has an index (for the standard palette in Excel (tm) ),
  20687. native (RGB) triplet and string triplet. The string triplet Is as the
  20688. color would be represented by Gnumeric. Having (string) this here Is a bit of a
  20689. collusion of function between HSSF and the HSSFSerializer but I think its
  20690. a reasonable one in this case.
  20691. @author Andrew C. Oliver (acoliver at apache dot org)
  20692. @author Brian Sanders (bsanders at risklabs dot com) - full default color palette
  20693. </member>
  20694. <member name="M:NPOI.HSSF.Util.HSSFColor.#ctor">
  20695. Creates a new instance of HSSFColor
  20696. </member>
  20697. <member name="M:NPOI.HSSF.Util.HSSFColor.GetIndexHash">
  20698. this function returns all colors in a hastable. Its not implemented as a
  20699. static member/staticly initialized because that would be dirty in a
  20700. server environment as it Is intended. This means you'll eat the time
  20701. it takes to Create it once per request but you will not hold onto it
  20702. if you have none of those requests.
  20703. @return a hashtable containing all colors keyed by <c>int</c> excel-style palette indexes
  20704. </member>
  20705. <member name="M:NPOI.HSSF.Util.HSSFColor.GetMutableIndexHash">
  20706. This function returns all the Colours, stored in a Hashtable that
  20707. can be edited. No caching is performed. If you don't need to edit
  20708. the table, then call {@link #getIndexHash()} which returns a
  20709. statically cached imuatable map of colours.
  20710. </member>
  20711. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTripletHash">
  20712. <summary>
  20713. this function returns all colors in a hastable. Its not implemented as a
  20714. static member/staticly initialized because that would be dirty in a
  20715. server environment as it Is intended. This means you'll eat the time
  20716. it takes to Create it once per request but you will not hold onto it
  20717. if you have none of those requests.
  20718. </summary>
  20719. <returns>a hashtable containing all colors keyed by String gnumeric-like triplets</returns>
  20720. </member>
  20721. <member name="P:NPOI.HSSF.Util.HSSFColor.Indexed">
  20722. @return index to the standard palette
  20723. </member>
  20724. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTriplet">
  20725. @return triplet representation like that in Excel
  20726. </member>
  20727. <member name="M:NPOI.HSSF.Util.HSSFColor.GetHexString">
  20728. @return a hex string exactly like a gnumeric triplet
  20729. </member>
  20730. <member name="T:NPOI.HSSF.Util.HSSFColor.Black">
  20731. Class BLACK
  20732. </member>
  20733. <member name="T:NPOI.HSSF.Util.HSSFColor.Brown">
  20734. Class BROWN
  20735. </member>
  20736. <member name="T:NPOI.HSSF.Util.HSSFColor.OliveGreen">
  20737. Class OLIVE_GREEN
  20738. </member>
  20739. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkGreen">
  20740. Class DARK_GREEN
  20741. </member>
  20742. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkTeal">
  20743. Class DARK_TEAL
  20744. </member>
  20745. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkBlue">
  20746. Class DARK_BLUE
  20747. </member>
  20748. <member name="T:NPOI.HSSF.Util.HSSFColor.Indigo">
  20749. Class INDIGO
  20750. </member>
  20751. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey80Percent">
  20752. Class GREY_80_PERCENT
  20753. </member>
  20754. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkRed">
  20755. Class DARK_RED
  20756. </member>
  20757. <member name="T:NPOI.HSSF.Util.HSSFColor.Orange">
  20758. Class ORANGE
  20759. </member>
  20760. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkYellow">
  20761. Class DARK_YELLOW
  20762. </member>
  20763. <member name="T:NPOI.HSSF.Util.HSSFColor.Green">
  20764. Class GREEN
  20765. </member>
  20766. <member name="T:NPOI.HSSF.Util.HSSFColor.Teal">
  20767. Class TEAL
  20768. </member>
  20769. <member name="T:NPOI.HSSF.Util.HSSFColor.Blue">
  20770. Class BLUE
  20771. </member>
  20772. <member name="T:NPOI.HSSF.Util.HSSFColor.BlueGrey">
  20773. Class BLUE_GREY
  20774. </member>
  20775. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey50Percent">
  20776. Class GREY_50_PERCENT
  20777. </member>
  20778. <member name="T:NPOI.HSSF.Util.HSSFColor.Red">
  20779. Class RED
  20780. </member>
  20781. <member name="T:NPOI.HSSF.Util.HSSFColor.LightOrange">
  20782. Class LIGHT_ORANGE
  20783. </member>
  20784. <member name="T:NPOI.HSSF.Util.HSSFColor.Lime">
  20785. Class LIME
  20786. </member>
  20787. <member name="T:NPOI.HSSF.Util.HSSFColor.SeaGreen">
  20788. Class SEA_GREEN
  20789. </member>
  20790. <member name="T:NPOI.HSSF.Util.HSSFColor.Aqua">
  20791. Class AQUA
  20792. </member>
  20793. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey40Percent">
  20794. Class GREY_40_PERCENT
  20795. </member>
  20796. <member name="T:NPOI.HSSF.Util.HSSFColor.Turquoise">
  20797. Class TURQUOISE
  20798. </member>
  20799. <member name="T:NPOI.HSSF.Util.HSSFColor.SkyBlue">
  20800. Class SKY_BLUE
  20801. </member>
  20802. <member name="T:NPOI.HSSF.Util.HSSFColor.Plum">
  20803. Class PLUM
  20804. </member>
  20805. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey25Percent">
  20806. Class GREY_25_PERCENT
  20807. </member>
  20808. <member name="T:NPOI.HSSF.Util.HSSFColor.Rose">
  20809. Class ROSE
  20810. </member>
  20811. <member name="T:NPOI.HSSF.Util.HSSFColor.Tan">
  20812. Class TAN
  20813. </member>
  20814. <member name="T:NPOI.HSSF.Util.HSSFColor.LightYellow">
  20815. Class LIGHT_YELLOW
  20816. </member>
  20817. <member name="T:NPOI.HSSF.Util.HSSFColor.LightGreen">
  20818. Class LIGHT_GREEN
  20819. </member>
  20820. <member name="T:NPOI.HSSF.Util.HSSFColor.LightTurquoise">
  20821. Class LIGHT_TURQUOISE
  20822. </member>
  20823. <member name="T:NPOI.HSSF.Util.HSSFColor.PaleBlue">
  20824. Class PALE_BLUE
  20825. </member>
  20826. <member name="T:NPOI.HSSF.Util.HSSFColor.Lavender">
  20827. Class LAVENDER
  20828. </member>
  20829. <member name="T:NPOI.HSSF.Util.HSSFColor.White">
  20830. Class WHITE
  20831. </member>
  20832. <member name="T:NPOI.HSSF.Util.HSSFColor.CornflowerBlue">
  20833. Class CORNFLOWER_BLUE
  20834. </member>
  20835. <member name="T:NPOI.HSSF.Util.HSSFColor.LemonChiffon">
  20836. Class LEMON_CHIFFON
  20837. </member>
  20838. <member name="T:NPOI.HSSF.Util.HSSFColor.Maroon">
  20839. Class MAROON
  20840. </member>
  20841. <member name="T:NPOI.HSSF.Util.HSSFColor.Orchid">
  20842. Class ORCHID
  20843. </member>
  20844. <member name="T:NPOI.HSSF.Util.HSSFColor.Coral">
  20845. Class CORAL
  20846. </member>
  20847. <member name="T:NPOI.HSSF.Util.HSSFColor.RoyalBlue">
  20848. Class ROYAL_BLUE
  20849. </member>
  20850. <member name="T:NPOI.HSSF.Util.HSSFColor.LightCornflowerBlue">
  20851. Class LIGHT_CORNFLOWER_BLUE
  20852. </member>
  20853. <member name="T:NPOI.HSSF.Util.HSSFColor.Automatic">
  20854. Special Default/Normal/Automatic color.
  20855. <i>Note:</i> This class Is NOT in the default HashTables returned by HSSFColor.
  20856. The index Is a special case which Is interpreted in the various SetXXXColor calls.
  20857. @author Jason
  20858. </member>
  20859. <member name="T:NPOI.HSSF.Util.RangeAddress">
  20860. * Title: Range Address
  20861. * Description: provides connectivity utilities for ranges
  20862. *
  20863. *
  20864. * REFERENCE:
  20865. * @author IgOr KaTz &amp; EuGeNe BuMaGiN (Tal Moshaiov) (VistaPortal LDT.)
  20866. @version 1.0
  20867. </member>
  20868. <member name="M:NPOI.HSSF.Util.RangeAddress.#ctor(System.String)">
  20869. Accepts an external reference from excel.
  20870. i.e. Sheet1!$A$4:$B$9
  20871. @param _url
  20872. </member>
  20873. <member name="P:NPOI.HSSF.Util.RangeAddress.Address">
  20874. @return String <b>note: </b> All absolute references are Removed
  20875. </member>
  20876. <member name="T:NPOI.HSSF.Util.RKUtil">
  20877. Utility class for helping convert RK numbers.
  20878. @author Andrew C. Oliver (acoliver at apache dot org)
  20879. @author Glen Stampoultzis (glens at apache.org)
  20880. @author Rolf-J黵gen Moll
  20881. @see org.apache.poi.hssf.record.MulRKRecord
  20882. @see org.apache.poi.hssf.record.RKRecord
  20883. </member>
  20884. <member name="M:NPOI.HSSF.Util.RKUtil.DecodeNumber(System.Int32)">
  20885. Do the dirty work of decoding; made a private static method to
  20886. facilitate testing the algorithm
  20887. </member>
  20888. <member name="T:NPOI.HSSF.EventModel.IERFListener">
  20889. An ERFListener Is registered with the EventRecordFactory.
  20890. An ERFListener listens for Records coming from the stream
  20891. via the EventRecordFactory
  20892. @see EventRecordFactory
  20893. @author Andrew C. Oliver acoliver@apache.org
  20894. </member>
  20895. <member name="M:NPOI.HSSF.EventModel.IERFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  20896. Process a Record. This method Is called by the
  20897. EventRecordFactory when a record Is returned.
  20898. @return bool specifying whether the effort was a success.
  20899. </member>
  20900. <member name="T:NPOI.HSSF.EventModel.EventRecordFactory">
  20901. Event-based record factory. As opposed to RecordFactory
  20902. this refactored version throws record events as it comes
  20903. accross the records. I throws the "lazily" one record behind
  20904. to ensure that ContinueRecords are Processed first.
  20905. @author Andrew C. Oliver (acoliver@apache.org) - probably to blame for the bugs (so yank his chain on the list)
  20906. @author Marc Johnson (mjohnson at apache dot org) - methods taken from RecordFactory
  20907. @author Glen Stampoultzis (glens at apache.org) - methods taken from RecordFactory
  20908. @author Csaba Nagy (ncsaba at yahoo dot com)
  20909. </member>
  20910. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.#ctor(NPOI.HSSF.EventModel.IERFListener,System.Collections.ArrayList)">
  20911. Create an EventRecordFactory
  20912. @param abortable specifies whether the return from the listener
  20913. handler functions are obeyed. False means they are ignored. True
  20914. means the event loop exits on error.
  20915. </member>
  20916. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecord(NPOI.HSSF.Record.Record)">
  20917. sends the record event to all registered listeners.
  20918. @param record the record to be thrown.
  20919. @return <c>false</c> to abort. This aborts
  20920. out of the event loop should the listener return false
  20921. </member>
  20922. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecords(System.IO.Stream)">
  20923. Create an array of records from an input stream
  20924. @param in the InputStream from which the records will be
  20925. obtained
  20926. @exception RecordFormatException on error Processing the
  20927. InputStream
  20928. </member>
  20929. <member name="M:NPOI.HSSF.Model.ConvertAnchor.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  20930. <summary>
  20931. Creates the anchor.
  20932. </summary>
  20933. <param name="userAnchor">The user anchor.</param>
  20934. <returns></returns>
  20935. </member>
  20936. <member name="M:NPOI.HSSF.Model.DrawingManager.AllocateShapeId(System.Int16)">
  20937. Allocates new shape id for the new drawing Group id.
  20938. @return a new shape id.
  20939. </member>
  20940. <member name="T:NPOI.HSSF.Model.DrawingManager2">
  20941. <summary>
  20942. Provides utilities to manage drawing Groups.
  20943. </summary>
  20944. <remarks>
  20945. Glen Stampoultzis (glens at apache.org)
  20946. </remarks>
  20947. </member>
  20948. <member name="M:NPOI.HSSF.Model.DrawingManager2.ClearDrawingGroups">
  20949. <summary>
  20950. Clears the cached list of drawing Groups
  20951. </summary>
  20952. </member>
  20953. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16)">
  20954. <summary>
  20955. Allocates new shape id for the new drawing Group id.
  20956. </summary>
  20957. <param name="drawingGroupId"></param>
  20958. <returns>a new shape id.</returns>
  20959. </member>
  20960. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16,NPOI.DDF.EscherDgRecord)">
  20961. <summary>
  20962. Allocates new shape id for the new drawing group id.
  20963. </summary>
  20964. <param name="drawingGroupId"></param>
  20965. <param name="dg"></param>
  20966. <returns>a new shape id.</returns>
  20967. </member>
  20968. <member name="M:NPOI.HSSF.Model.DrawingManager2.FindNewDrawingGroupId">
  20969. <summary>
  20970. Finds the next available (1 based) drawing Group id
  20971. </summary>
  20972. <returns></returns>
  20973. </member>
  20974. <member name="T:NPOI.HSSF.Model.HSSFFormulaParser">
  20975. HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer}
  20976. @author Josh Micich
  20977. </member>
  20978. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  20979. Convenience method for parsing cell formulas. see {@link #parse(String, HSSFWorkbook, int)}
  20980. </member>
  20981. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType)">
  20982. @param formulaType a constant from {@link FormulaType}
  20983. @return the parsed formula tokens
  20984. </member>
  20985. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  20986. @param formula the formula to parse
  20987. @param workbook the parent workbook
  20988. @param formulaType a constant from {@link FormulaType}
  20989. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  20990. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  20991. the scope of the name will be ignored and the parser will match named ranges only by name
  20992. @return the parsed formula tokens
  20993. </member>
  20994. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.ToFormulaString(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  20995. Static method to convert an array of {@link Ptg}s in RPN order
  20996. to a human readable string format in infix mode.
  20997. @param book used for defined names and 3D references
  20998. @param ptgs must not be <c>null</c>
  20999. @return a human readable String
  21000. </member>
  21001. <member name="T:NPOI.HSSF.Model.LinkTable">
  21002. Link Table (OOO pdf reference: 4.10.3 ) <p/>
  21003. The main data of all types of references is stored in the Link Table inside the Workbook Globals
  21004. Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any
  21005. references in the document.
  21006. <p/>
  21007. In BIFF8 the Link Table consists of
  21008. <ul>
  21009. <li>zero or more EXTERNALBOOK Blocks<p/>
  21010. each consisting of
  21011. <ul>
  21012. <li>exactly one EXTERNALBOOK (0x01AE) record</li>
  21013. <li>zero or more EXTERNALNAME (0x0023) records</li>
  21014. <li>zero or more CRN Blocks<p/>
  21015. each consisting of
  21016. <ul>
  21017. <li>exactly one XCT (0x0059)record</li>
  21018. <li>zero or more CRN (0x005A) records (documentation says one or more)</li>
  21019. </ul>
  21020. </li>
  21021. </ul>
  21022. </li>
  21023. <li>zero or one EXTERNSHEET (0x0017) record</li>
  21024. <li>zero or more DEFINEDNAME (0x0018) records</li>
  21025. </ul>
  21026. @author Josh Micich
  21027. </member>
  21028. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor">
  21029. Create a new block for registering add-in functions
  21030. @see org.apache.poi.hssf.model.LinkTable#addNameXPtg(String)
  21031. </member>
  21032. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.String,System.String[])">
  21033. Create a new block for external references.
  21034. </member>
  21035. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.Int32)">
  21036. Create a new block for internal references. It is called when constructing a new LinkTable.
  21037. @see org.apache.poi.hssf.model.LinkTable#LinkTable(int, WorkbookRecordList)
  21038. </member>
  21039. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.GetIndexOfName(System.String)">
  21040. Performs case-insensitive search
  21041. @return -1 if not found
  21042. </member>
  21043. <member name="P:NPOI.HSSF.Model.LinkTable.RecordCount">
  21044. TODO - would not be required if calling code used RecordStream or similar
  21045. </member>
  21046. <member name="M:NPOI.HSSF.Model.LinkTable.GetFirstInternalSheetIndexForExtIndex(System.Int32)">
  21047. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  21048. @return -1 if the reference is to an external book
  21049. </member>
  21050. <member name="M:NPOI.HSSF.Model.LinkTable.GetLastInternalSheetIndexForExtIndex(System.Int32)">
  21051. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  21052. @return -1 if the reference is to an external book
  21053. </member>
  21054. <member name="M:NPOI.HSSF.Model.LinkTable.GetNameXPtg(System.String,System.Int32)">
  21055. Finds the external name definition for the given name,
  21056. optionally restricted by externsheet index, and returns
  21057. (if found) as a NameXPtg.
  21058. @param sheetRefIndex The Extern Sheet Index to look for, or -1 if any
  21059. </member>
  21060. <member name="M:NPOI.HSSF.Model.LinkTable.AddNameXPtg(System.String)">
  21061. Register an external name in this workbook
  21062. @param name the name to register
  21063. @return a NameXPtg describing this name
  21064. </member>
  21065. <member name="M:NPOI.HSSF.Model.LinkTable.FindFirstRecordLocBySid(System.Int16)">
  21066. copied from Workbook
  21067. </member>
  21068. <member name="M:NPOI.HSSF.Model.LinkTable.ChangeExternalReference(System.String,System.String)">
  21069. Changes an external referenced file to another file.
  21070. A formular in Excel which refers a cell in another file is saved in two parts:
  21071. The referenced file is stored in an reference table. the row/cell information is saved separate.
  21072. This method invokation will only change the reference in the lookup-table itself.
  21073. @param oldUrl The old URL to search for and which is to be replaced
  21074. @param newUrl The URL replacement
  21075. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  21076. </member>
  21077. <member name="T:NPOI.HSSF.Model.ParseNode">
  21078. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  21079. token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  21080. <c>Ptg</c> is non-atomic.
  21081. @author Josh Micich
  21082. </member>
  21083. <member name="M:NPOI.HSSF.Model.ParseNode.ToTokenArray(NPOI.HSSF.Model.ParseNode)">
  21084. <summary>
  21085. Collects the array of Ptg
  21086. tokens for the specified tree.
  21087. </summary>
  21088. <param name="rootNode">The root node.</param>
  21089. <returns></returns>
  21090. </member>
  21091. <member name="M:NPOI.HSSF.Model.ParseNode.CollectIfPtgs(NPOI.HSSF.Model.ParseNode.TokenCollector)">
  21092. <summary>
  21093. The IF() function Gets marked up with two or three tAttr tokens.
  21094. Similar logic will be required for CHOOSE() when it is supported
  21095. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  21096. </summary>
  21097. <param name="temp">The temp.</param>
  21098. </member>
  21099. <member name="T:NPOI.HSSF.Model.RecordOrderer">
  21100. Finds correct insert positions for records in workbook streams<p/>
  21101. See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream'
  21102. @author Josh Micich
  21103. </member>
  21104. <member name="M:NPOI.HSSF.Model.RecordOrderer.AddNewSheetRecord(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},NPOI.HSSF.Record.RecordBase)">
  21105. Adds the specified new record in the correct place in sheet records list
  21106. </member>
  21107. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetWorksheetProtectionBlockInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  21108. <summary>
  21109. Finds the index where the protection block should be inserted
  21110. </summary>
  21111. <param name="records">the records for this sheet</param>
  21112. <returns></returns>
  21113. <remark>
  21114. + BOF
  21115. o INDEX
  21116. o Calculation Settings Block
  21117. o PRINTHEADERS
  21118. o PRINTGRIDLINES
  21119. o GRIDSET
  21120. o GUTS
  21121. o DEFAULTROWHEIGHT
  21122. o SHEETPR
  21123. o Page Settings Block
  21124. o Worksheet Protection Block
  21125. o DEFCOLWIDTH
  21126. oo COLINFO
  21127. o SORT
  21128. + DIMENSION
  21129. </remark>
  21130. </member>
  21131. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsProtectionSubsequentRecord(System.Object)">
  21132. <summary>
  21133. These records may occur between the 'Worksheet Protection Block' and DIMENSION:
  21134. </summary>
  21135. <param name="rb"></param>
  21136. <returns></returns>
  21137. <remarks>
  21138. o DEFCOLWIDTH
  21139. oo COLINFO
  21140. o SORT
  21141. </remarks>
  21142. </member>
  21143. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindInsertPosForNewCondFormatTable(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  21144. <summary>
  21145. Find correct position to add new CFHeader record
  21146. </summary>
  21147. <param name="records"></param>
  21148. <returns></returns>
  21149. </member>
  21150. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindDataValidationTableInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  21151. Finds the index where the sheet validations header record should be inserted
  21152. @param records the records for this sheet
  21153. + WINDOW2
  21154. o SCL
  21155. o PANE
  21156. oo SELECTION
  21157. o STANDARDWIDTH
  21158. oo MERGEDCELLS
  21159. o LABELRANGES
  21160. o PHONETICPR
  21161. o Conditional Formatting Table
  21162. o Hyperlink Table
  21163. o Data Validity Table
  21164. o SHEETLAYOUT
  21165. o SHEETPROTECTION
  21166. o RANGEPROTECTION
  21167. + EOF
  21168. </member>
  21169. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetDimensionsIndex(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  21170. DIMENSIONS record is always present
  21171. </member>
  21172. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsEndOfRowBlock(System.Int32)">
  21173. <summary>
  21174. if the specified record ID terminates a sequence of Row block records
  21175. It is assumed that at least one row or cell value record has been found prior to the current
  21176. record
  21177. </summary>
  21178. <param name="sid"></param>
  21179. <returns></returns>
  21180. </member>
  21181. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsRowBlockRecord(System.Int32)">
  21182. <summary>
  21183. Whether the specified record id normally appears in the row blocks section of the sheet records
  21184. </summary>
  21185. <param name="sid"></param>
  21186. <returns></returns>
  21187. </member>
  21188. <member name="T:NPOI.HSSF.Model.RecordStream">
  21189. <summary>
  21190. Simplifies iteration over a sequence of Record objects.
  21191. @author Josh Micich
  21192. </summary>
  21193. </member>
  21194. <member name="M:NPOI.HSSF.Model.RecordStream.HasNext">
  21195. <summary>
  21196. Determines whether this instance has next.
  21197. </summary>
  21198. <returns>
  21199. <c>true</c> if this instance has next; otherwise, <c>false</c>.
  21200. </returns>
  21201. </member>
  21202. <member name="M:NPOI.HSSF.Model.RecordStream.GetNext">
  21203. <summary>
  21204. Gets the next record
  21205. </summary>
  21206. <returns></returns>
  21207. </member>
  21208. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextSid">
  21209. <summary>
  21210. Peeks the next sid.
  21211. </summary>
  21212. <returns>-1 if at end of records</returns>
  21213. </member>
  21214. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextClass">
  21215. <summary>
  21216. Peeks the next class.
  21217. </summary>
  21218. <returns>the class of the next Record.return null if this stream Is exhausted.</returns>
  21219. </member>
  21220. <member name="T:NPOI.HSSF.Model.RowBlocksReader">
  21221. Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and
  21222. shared formula records.
  21223. @author Josh Micich
  21224. </member>
  21225. <member name="M:NPOI.HSSF.Model.RowBlocksReader.#ctor(NPOI.HSSF.Model.RecordStream)">
  21226. Also collects any loose MergeCellRecords and puts them in the supplied
  21227. mergedCellsTable
  21228. </member>
  21229. <member name="P:NPOI.HSSF.Model.RowBlocksReader.LooseMergedCells">
  21230. Some unconventional apps place {@link MergeCellsRecord}s within the row block. They
  21231. actually should be in the {@link MergedCellsTable} which is much later (see bug 45699).
  21232. @return any loose <c>MergeCellsRecord</c>s found
  21233. </member>
  21234. <member name="P:NPOI.HSSF.Model.RowBlocksReader.PlainRecordStream">
  21235. @return a {@link RecordStream} containing all the non-{@link SharedFormulaRecord}
  21236. non-{@link ArrayRecord} and non-{@link TableRecord} Records.
  21237. </member>
  21238. <member name="T:NPOI.HSSF.Model.InternalSheet">
  21239. <summary>
  21240. Low level model implementation of a Sheet (one workbook Contains many sheets)
  21241. This file Contains the low level binary records starting at the sheets BOF and
  21242. ending with the sheets EOF. Use HSSFSheet for a high level representation.
  21243. The structures of the highlevel API use references to this to perform most of their
  21244. operations. Its probably Unwise to use these low level structures directly Unless you
  21245. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  21246. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  21247. before even attempting to use this.
  21248. </summary>
  21249. <remarks>
  21250. @author Andrew C. Oliver (acoliver at apache dot org)
  21251. @author Glen Stampoultzis (glens at apache.org)
  21252. @author Shawn Laubach (slaubach at apache dot org) Gridlines, Headers, Footers, PrintSetup, and Setting Default Column Styles
  21253. @author Jason Height (jheight at chariot dot net dot au) Clone support. DBCell and Index Record writing support
  21254. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  21255. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little)
  21256. </remarks>
  21257. </member>
  21258. <member name="F:NPOI.HSSF.Model.InternalSheet._mergedCellsTable">
  21259. java object always present, but if empty no BIFF records are written
  21260. </member>
  21261. <member name="F:NPOI.HSSF.Model.InternalSheet._dimensions">
  21262. the DimensionsRecord is always present
  21263. </member>
  21264. <member name="F:NPOI.HSSF.Model.InternalSheet._isUncalced">
  21265. Add an UncalcedRecord if not true indicating formulas have not been calculated
  21266. </member>
  21267. <member name="M:NPOI.HSSF.Model.InternalSheet.CloneSheet">
  21268. <summary>
  21269. Clones the low level records of this sheet and returns the new sheet instance.
  21270. This method is implemented by Adding methods for deep cloning to all records that
  21271. can be Added to a sheet. The Record object does not implement Cloneable.
  21272. When Adding a new record, implement a public Clone method if and only if the record
  21273. belongs to a sheet.
  21274. </summary>
  21275. <returns></returns>
  21276. </member>
  21277. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet(NPOI.HSSF.Model.RecordStream)">
  21278. <summary>
  21279. Creates the sheet.
  21280. </summary>
  21281. <param name="rs">The stream.</param>
  21282. <returns></returns>
  21283. </member>
  21284. <member name="M:NPOI.HSSF.Model.InternalSheet.#ctor(NPOI.HSSF.Model.RecordStream)">
  21285. <summary>
  21286. Initializes a new instance of the <see cref="T:NPOI.HSSF.Model.InternalSheet"/> class.
  21287. </summary>
  21288. <param name="rs">The stream.</param>
  21289. </member>
  21290. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet">
  21291. <summary>
  21292. Creates a sheet with all the usual records minus values and the "index"
  21293. record (not required). Sets the location pointer to where the first value
  21294. records should go. Use this to Create a sheet from "scratch".
  21295. </summary>
  21296. <returns>Sheet object with all values Set to defaults</returns>
  21297. </member>
  21298. <member name="M:NPOI.HSSF.Model.InternalSheet.AddMergedRegion(System.Int32,System.Int32,System.Int32,System.Int32)">
  21299. <summary>
  21300. Adds the merged region.
  21301. </summary>
  21302. <param name="rowFrom">the row index From </param>
  21303. <param name="colFrom">The column index From.</param>
  21304. <param name="rowTo">The row index To</param>
  21305. <param name="colTo">The column To.</param>
  21306. <returns></returns>
  21307. </member>
  21308. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveMergedRegion(System.Int32)">
  21309. <summary>
  21310. Removes the merged region.
  21311. </summary>
  21312. <param name="index">The index.</param>
  21313. </member>
  21314. <member name="P:NPOI.HSSF.Model.InternalSheet.ColumnInfos">
  21315. <summary>
  21316. Gets the column infos.
  21317. </summary>
  21318. <value>The column infos.</value>
  21319. </member>
  21320. <member name="M:NPOI.HSSF.Model.InternalSheet.GetMergedRegionAt(System.Int32)">
  21321. <summary>
  21322. Gets the merged region at.
  21323. </summary>
  21324. <param name="index">The index.</param>
  21325. <returns></returns>
  21326. </member>
  21327. <member name="P:NPOI.HSSF.Model.InternalSheet.NumMergedRegions">
  21328. <summary>
  21329. Gets the number of merged regions.
  21330. </summary>
  21331. <value>The number merged regions.</value>
  21332. </member>
  21333. <member name="P:NPOI.HSSF.Model.InternalSheet.NumConditionalFormattings">
  21334. <summary>
  21335. Gets the number of conditional formattings.
  21336. </summary>
  21337. <value>The number of conditional formattings.</value>
  21338. </member>
  21339. <member name="M:NPOI.HSSF.Model.InternalSheet.SetDimensions(System.Int32,System.Int16,System.Int32,System.Int16)">
  21340. <summary>
  21341. Per an earlier reported bug in working with Andy Khan's excel Read library. This
  21342. Sets the values in the sheet's DimensionsRecord object to be correct. Excel doesn't
  21343. really care, but we want to play nice with other libraries.
  21344. </summary>
  21345. <param name="firstrow">The first row.</param>
  21346. <param name="firstcol">The first column.</param>
  21347. <param name="lastrow">The last row.</param>
  21348. <param name="lastcol">The last column.</param>
  21349. </member>
  21350. <member name="P:NPOI.HSSF.Model.InternalSheet.PreOffset">
  21351. <summary>
  21352. Gets or Sets the preoffset when using DBCELL records (currently Unused) - this Is
  21353. the position of this sheet within the whole file.
  21354. </summary>
  21355. <value>the offset of the sheet's BOF within the file.</value>
  21356. </member>
  21357. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRow(System.Int32)">
  21358. <summary>
  21359. Create a row record. (does not Add it to the records contained in this sheet)
  21360. </summary>
  21361. <param name="row">row number</param>
  21362. <returns>RowRecord Created for the passed in row number</returns>
  21363. </member>
  21364. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateLabelSST(System.Int32,System.Int16,System.Int32)">
  21365. <summary>
  21366. Create a LABELSST Record (does not Add it to the records contained in this sheet)
  21367. </summary>
  21368. <param name="row">the row the LabelSST Is a member of</param>
  21369. <param name="col">the column the LabelSST defines</param>
  21370. <param name="index">the index of the string within the SST (use workbook AddSSTString method)</param>
  21371. <returns>LabelSSTRecord newly Created containing your SST Index, row,col.</returns>
  21372. </member>
  21373. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateNumber(System.Int32,System.Int16,System.Double)">
  21374. <summary>
  21375. Create a NUMBER Record (does not Add it to the records contained in this sheet)
  21376. </summary>
  21377. <param name="row">the row the NumberRecord is a member of</param>
  21378. <param name="col">the column the NumberRecord defines</param>
  21379. <param name="value">value for the number record</param>
  21380. <returns>NumberRecord for that row, col containing that value as Added to the sheet</returns>
  21381. </member>
  21382. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBlank(System.Int32,System.Int16)">
  21383. <summary>
  21384. Create a BLANK record (does not Add it to the records contained in this sheet)
  21385. </summary>
  21386. <param name="row">the row the BlankRecord is a member of</param>
  21387. <param name="col">the column the BlankRecord is a member of</param>
  21388. <returns></returns>
  21389. </member>
  21390. <member name="M:NPOI.HSSF.Model.InternalSheet.AddValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  21391. <summary>
  21392. Adds a value record to the sheet's contained binary records
  21393. (i.e. LabelSSTRecord or NumberRecord).
  21394. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  21395. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  21396. When Adding several rows you can just start at the last one by leaving loc
  21397. at what this Sets it to.
  21398. </summary>
  21399. <param name="row">the row to Add the cell value to</param>
  21400. <param name="col">the cell value record itself.</param>
  21401. </member>
  21402. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  21403. <summary>
  21404. Remove a value record from the records array.
  21405. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  21406. </summary>
  21407. <param name="row">the row of the value record you wish to Remove</param>
  21408. <param name="col">a record supporting the CellValueRecordInterface.</param>
  21409. </member>
  21410. <member name="M:NPOI.HSSF.Model.InternalSheet.ReplaceValueRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  21411. <summary>
  21412. Replace a value record from the records array.
  21413. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  21414. </summary>
  21415. <param name="newval">a record supporting the CellValueRecordInterface. this will Replace
  21416. the cell value with the same row and column. If there Isn't one, one will
  21417. be Added.</param>
  21418. </member>
  21419. <member name="M:NPOI.HSSF.Model.InternalSheet.AddRow(NPOI.HSSF.Record.RowRecord)">
  21420. <summary>
  21421. Adds a row record to the sheet
  21422. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  21423. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  21424. When Adding several rows you can just start at the last one by leaving loc
  21425. at what this Sets it to.
  21426. </summary>
  21427. <param name="row">the row record to be Added</param>
  21428. </member>
  21429. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveRow(NPOI.HSSF.Record.RowRecord)">
  21430. <summary>
  21431. Removes a row record
  21432. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  21433. </summary>
  21434. <param name="row">the row record to Remove</param>
  21435. </member>
  21436. <member name="M:NPOI.HSSF.Model.InternalSheet.GetCellValueIterator">
  21437. Get all the value records (from LOC). Records will be returned from the first
  21438. record (starting at LOC) which is a value record.
  21439. This method is "loc" sensitive. Meaning you need to set LOC to where you
  21440. want it to start searching. If you don't know do this: setLoc(getDimsLoc).
  21441. When adding several rows you can just start at the last one by leaving loc
  21442. at what this sets it to. For this method, set loc to dimsloc to start with,
  21443. subsequent calls will return values in (physical) sequence or NULL when you get to the end.
  21444. @return Iterator of CellValueRecordInterface representing the value records
  21445. </member>
  21446. <member name="P:NPOI.HSSF.Model.InternalSheet.NextRow">
  21447. <summary>
  21448. Get the NEXT RowRecord (from LOC). The first record that is a Row record
  21449. (starting at LOC) will be returned.
  21450. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  21451. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  21452. When Adding several rows you can just start at the last one by leaving loc
  21453. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  21454. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  21455. </summary>
  21456. <value>RowRecord representing the next row record or NULL if there are no more</value>
  21457. </member>
  21458. <member name="M:NPOI.HSSF.Model.InternalSheet.GetRow(System.Int32)">
  21459. <summary>
  21460. Get the NEXT (from LOC) RowRecord where rownumber matches the given rownum.
  21461. The first record that is a Row record (starting at LOC) that has the
  21462. same rownum as the given rownum will be returned.
  21463. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  21464. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  21465. When Adding several rows you can just start at the last one by leaving loc
  21466. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  21467. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  21468. </summary>
  21469. <param name="rownum">which row to return (careful with LOC)</param>
  21470. <returns>RowRecord representing the next row record or NULL if there are no more</returns>
  21471. </member>
  21472. <member name="P:NPOI.HSSF.Model.InternalSheet.PageSettings">
  21473. <summary>
  21474. Gets the page settings.
  21475. </summary>
  21476. <returns></returns>
  21477. </member>
  21478. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBOF">
  21479. <summary>
  21480. Creates the BOF record
  21481. </summary>
  21482. <returns>record containing a BOFRecord</returns>
  21483. </member>
  21484. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIndex">
  21485. <summary>
  21486. Creates the Index record - not currently used
  21487. </summary>
  21488. <returns>record containing a IndexRecord</returns>
  21489. </member>
  21490. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcMode">
  21491. <summary>
  21492. Creates the CalcMode record and Sets it to 1 (automatic formula caculation)
  21493. </summary>
  21494. <returns>record containing a CalcModeRecord</returns>
  21495. </member>
  21496. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcCount">
  21497. <summary>
  21498. Creates the CalcCount record and Sets it to 0x64 (default number of iterations)
  21499. </summary>
  21500. <returns>record containing a CalcCountRecord</returns>
  21501. </member>
  21502. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRefMode">
  21503. <summary>
  21504. Creates the RefMode record and Sets it to A1 Mode (default reference mode)
  21505. </summary>
  21506. <returns>record containing a RefModeRecord</returns>
  21507. </member>
  21508. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIteration">
  21509. <summary>
  21510. Creates the Iteration record and Sets it to false (don't iteratively calculate formulas)
  21511. </summary>
  21512. <returns>record containing a IterationRecord</returns>
  21513. </member>
  21514. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDelta">
  21515. <summary>
  21516. Creates the Delta record and Sets it to 0.0010 (default accuracy)
  21517. </summary>
  21518. <returns>record containing a DeltaRecord</returns>
  21519. </member>
  21520. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSaveRecalc">
  21521. <summary>
  21522. Creates the SaveRecalc record and Sets it to true (recalculate before saving)
  21523. </summary>
  21524. <returns>record containing a SaveRecalcRecord</returns>
  21525. </member>
  21526. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintHeaders">
  21527. <summary>
  21528. Creates the PrintHeaders record and Sets it to false (we don't Create headers yet so why print them)
  21529. </summary>
  21530. <returns>record containing a PrintHeadersRecord</returns>
  21531. </member>
  21532. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintGridlines">
  21533. <summary>
  21534. Creates the PrintGridlines record and Sets it to false (that makes for ugly sheets). As far as I can
  21535. tell this does the same thing as the GridsetRecord
  21536. </summary>
  21537. <returns>record containing a PrintGridlinesRecord</returns>
  21538. </member>
  21539. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGridset">
  21540. <summary>
  21541. Creates the GridSet record and Sets it to true (user has mucked with the gridlines)
  21542. </summary>
  21543. <returns>record containing a GridsetRecord</returns>
  21544. </member>
  21545. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGuts">
  21546. <summary>
  21547. Creates the Guts record and Sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0
  21548. </summary>
  21549. <returns>record containing a GutsRecordRecord</returns>
  21550. </member>
  21551. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultRowHeight">
  21552. <summary>
  21553. Creates the DefaultRowHeight Record and Sets its options to 0 and rowheight to 0xff
  21554. </summary>
  21555. <see cref="T:NPOI.HSSF.Record.DefaultRowHeightRecord"/>
  21556. <see cref="T:NPOI.HSSF.Record.Record"/>
  21557. <returns>record containing a DefaultRowHeightRecord</returns>
  21558. </member>
  21559. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWSBool">
  21560. Creates the WSBoolRecord and Sets its values to defaults
  21561. @see org.apache.poi.hssf.record.WSBoolRecord
  21562. @see org.apache.poi.hssf.record.Record
  21563. @return record containing a WSBoolRecord
  21564. </member>
  21565. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateHCenter">
  21566. Creates the HCenter Record and Sets it to false (don't horizontally center)
  21567. @see org.apache.poi.hssf.record.HCenterRecord
  21568. @see org.apache.poi.hssf.record.Record
  21569. @return record containing a HCenterRecord
  21570. </member>
  21571. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateVCenter">
  21572. Creates the VCenter Record and Sets it to false (don't horizontally center)
  21573. @see org.apache.poi.hssf.record.VCenterRecord
  21574. @see org.apache.poi.hssf.record.Record
  21575. @return record containing a VCenterRecord
  21576. </member>
  21577. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintSetup">
  21578. Creates the PrintSetup Record and Sets it to defaults and marks it invalid
  21579. @see org.apache.poi.hssf.record.PrintSetupRecord
  21580. @see org.apache.poi.hssf.record.Record
  21581. @return record containing a PrintSetupRecord
  21582. </member>
  21583. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultColWidth">
  21584. Creates the DefaultColWidth Record and Sets it to 8
  21585. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  21586. @see org.apache.poi.hssf.record.Record
  21587. @return record containing a DefaultColWidthRecord
  21588. </member>
  21589. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultColumnWidth">
  21590. Get the default column width for the sheet (if the columns do not define their own width)
  21591. @return default column width
  21592. </member>
  21593. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultRowHeight">
  21594. Get the default row height for the sheet (if the rows do not define their own height)
  21595. @return default row height
  21596. </member>
  21597. <member name="M:NPOI.HSSF.Model.InternalSheet.GetColumnWidth(System.Int32)">
  21598. Get the width of a given column in Units of 1/256th of a Char width
  21599. @param column index
  21600. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  21601. @see org.apache.poi.hssf.record.ColumnInfoRecord
  21602. @see #SetColumnWidth(short,short)
  21603. @return column width in Units of 1/256th of a Char width
  21604. </member>
  21605. <member name="M:NPOI.HSSF.Model.InternalSheet.GetXFIndexForColAt(System.Int16)">
  21606. Get the index to the ExtendedFormatRecord "associated" with
  21607. the column at specified 0-based index. (In this case, an
  21608. ExtendedFormatRecord index is actually associated with a
  21609. ColumnInfoRecord which spans 1 or more columns)
  21610. <br/>
  21611. Returns the index to the default ExtendedFormatRecord (0xF)
  21612. if no ColumnInfoRecord exists that includes the column
  21613. index specified.
  21614. @param column
  21615. @return index of ExtendedFormatRecord associated with
  21616. ColumnInfoRecord that includes the column index or the
  21617. index of the default ExtendedFormatRecord (0xF)
  21618. </member>
  21619. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnWidth(System.Int32,System.Int32)">
  21620. Set the width for a given column in 1/256th of a Char width Units
  21621. @param column - the column number
  21622. @param width (in Units of 1/256th of a Char width)
  21623. </member>
  21624. <member name="M:NPOI.HSSF.Model.InternalSheet.IsColumnHidden(System.Int32)">
  21625. Get the hidden property for a given column.
  21626. @param column index
  21627. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  21628. @see org.apache.poi.hssf.record.ColumnInfoRecord
  21629. @see #SetColumnHidden(short,bool)
  21630. @return whether the column is hidden or not.
  21631. </member>
  21632. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnHidden(System.Int32,System.Boolean)">
  21633. Get the hidden property for a given column.
  21634. @param column - the column number
  21635. @param hidden - whether the column is hidden or not
  21636. </member>
  21637. <member name="M:NPOI.HSSF.Model.InternalSheet.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  21638. Creates an outline Group for the specified columns.
  21639. @param fromColumn Group from this column (inclusive)
  21640. @param toColumn Group to this column (inclusive)
  21641. @param indent if true the Group will be indented by one level,
  21642. if false indenting will be Removed by one level.
  21643. </member>
  21644. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDimensions">
  21645. Creates the Dimensions Record and Sets it to bogus values (you should Set this yourself
  21646. or let the high level API do it for you)
  21647. @see org.apache.poi.hssf.record.DimensionsRecord
  21648. @see org.apache.poi.hssf.record.Record
  21649. @return record containing a DimensionsRecord
  21650. </member>
  21651. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWindowTwo">
  21652. Creates the WindowTwo Record and Sets it to:
  21653. options = 0x6b6
  21654. toprow = 0
  21655. leftcol = 0
  21656. headercolor = 0x40
  21657. pagebreakzoom = 0x0
  21658. normalzoom = 0x0
  21659. @see org.apache.poi.hssf.record.WindowTwoRecord
  21660. @see org.apache.poi.hssf.record.Record
  21661. @return record containing a WindowTwoRecord
  21662. </member>
  21663. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSelection">
  21664. <summary>
  21665. Creates the Selection record and Sets it to nothing selected
  21666. </summary>
  21667. <returns>record containing a SelectionRecord</returns>
  21668. </member>
  21669. <member name="P:NPOI.HSSF.Model.InternalSheet.TopRow">
  21670. <summary>
  21671. Gets or sets the top row.
  21672. </summary>
  21673. <value>The top row.</value>
  21674. </member>
  21675. <member name="P:NPOI.HSSF.Model.InternalSheet.LeftCol">
  21676. <summary>
  21677. Gets or sets the left col.
  21678. </summary>
  21679. <value>The left col.</value>
  21680. </member>
  21681. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCell(System.Int32,System.Int32)">
  21682. <summary>
  21683. Sets the active cell.
  21684. </summary>
  21685. <param name="row">The row.</param>
  21686. <param name="column">The column.</param>
  21687. </member>
  21688. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  21689. <summary>
  21690. Sets the active cell range.
  21691. </summary>
  21692. <param name="firstRow">The firstrow.</param>
  21693. <param name="lastRow">The lastrow.</param>
  21694. <param name="firstColumn">The firstcolumn.</param>
  21695. <param name="lastColumn">The lastcolumn.</param>
  21696. </member>
  21697. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  21698. <summary>
  21699. Sets the active cell range.
  21700. </summary>
  21701. <param name="cellranges">The cellranges.</param>
  21702. <param name="activeRange">The index of the active range.</param>
  21703. <param name="activeRow">The active row in the active range</param>
  21704. <param name="activeColumn">The active column in the active range</param>
  21705. </member>
  21706. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellRow">
  21707. <summary>
  21708. Returns the active row
  21709. </summary>
  21710. <value>the active row index</value>
  21711. @see org.apache.poi.hssf.record.SelectionRecord
  21712. </member>
  21713. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellCol">
  21714. <summary>
  21715. Gets the active cell col.
  21716. </summary>
  21717. <value>the active column index</value>
  21718. @see org.apache.poi.hssf.record.SelectionRecord
  21719. </member>
  21720. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateEOF">
  21721. <summary>
  21722. Creates the EOF record
  21723. </summary>
  21724. <returns>record containing a EOFRecord</returns>
  21725. </member>
  21726. <member name="P:NPOI.HSSF.Model.InternalSheet.GridsetRecord">
  21727. <summary>
  21728. Gets the gridset record for this sheet.
  21729. </summary>
  21730. <value>The gridset record.</value>
  21731. </member>
  21732. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordBySid(System.Int16)">
  21733. <summary>
  21734. Returns the first occurance of a record matching a particular sid.
  21735. </summary>
  21736. <param name="sid">The sid.</param>
  21737. <returns></returns>
  21738. </member>
  21739. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSCLRecord(NPOI.HSSF.Record.SCLRecord)">
  21740. <summary>
  21741. Sets the SCL record or Creates it in the correct place if it does not
  21742. already exist.
  21743. </summary>
  21744. <param name="sclRecord">The record to set.</param>
  21745. </member>
  21746. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordLocBySid(System.Int16)">
  21747. Finds the first occurance of a record matching a particular sid and
  21748. returns it's position.
  21749. @param sid the sid to search for
  21750. @return the record position of the matching record or -1 if no match
  21751. is made.
  21752. </member>
  21753. <member name="P:NPOI.HSSF.Model.InternalSheet.Header">
  21754. <summary>
  21755. Gets or sets the header.
  21756. </summary>
  21757. <value>the HeaderRecord.</value>
  21758. </member>
  21759. <member name="P:NPOI.HSSF.Model.InternalSheet.IsAutoTabColor">
  21760. <summary>
  21761. Gets or sets a value indicating whether this instance is auto tab color.
  21762. </summary>
  21763. <value>
  21764. <c>true</c> if this instance is auto tab color; otherwise, <c>false</c>.
  21765. </value>
  21766. </member>
  21767. <member name="P:NPOI.HSSF.Model.InternalSheet.Footer">
  21768. <summary>
  21769. Gets or sets the footer.
  21770. </summary>
  21771. <value>FooterRecord for the sheet.</value>
  21772. </member>
  21773. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintSetup">
  21774. Returns the PrintSetupRecord.
  21775. @return PrintSetupRecord for the sheet.
  21776. </member>
  21777. <member name="P:NPOI.HSSF.Model.InternalSheet.IsGridsPrinted">
  21778. @return <c>true</c> if gridlines are printed
  21779. </member>
  21780. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintGridlines">
  21781. Returns the PrintGridlinesRecord.
  21782. @return PrintGridlinesRecord for the sheet.
  21783. </member>
  21784. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintHeaders">
  21785. Returns the PrintHeadersRecord.
  21786. @return PrintHeadersRecord for the sheet.
  21787. </member>
  21788. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSelected(System.Boolean)">
  21789. Sets whether the sheet is selected
  21790. @param sel True to select the sheet, false otherwise.
  21791. </member>
  21792. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  21793. Creates a split (freezepane). Any existing freezepane or split pane Is overwritten.
  21794. @param colSplit Horizonatal position of split.
  21795. @param rowSplit Vertical position of split.
  21796. @param topRow Top row visible in bottom pane
  21797. @param leftmostColumn Left column visible in right pane.
  21798. </member>
  21799. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  21800. Creates a split pane. Any existing freezepane or split pane is overwritten.
  21801. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  21802. @param ySplitPos Vertical position of split (in 1/20th of a point).
  21803. @param topRow Top row visible in bottom pane
  21804. @param leftmostColumn Left column visible in right pane.
  21805. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  21806. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  21807. @see #PANE_LOWER_LEFT
  21808. @see #PANE_LOWER_RIGHT
  21809. @see #PANE_UPPER_LEFT
  21810. @see #PANE_UPPER_RIGHT
  21811. </member>
  21812. <member name="P:NPOI.HSSF.Model.InternalSheet.PaneInformation">
  21813. Returns the information regarding the currently configured pane (split or freeze).
  21814. @return null if no pane configured, or the pane information.
  21815. </member>
  21816. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePassword">
  21817. creates a Password record with password set to 00.
  21818. </member>
  21819. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateProtect">
  21820. creates a Protect record with protect set to false.
  21821. </member>
  21822. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateObjectProtect">
  21823. Creates an ObjectProtect record with protect Set to false.
  21824. @see org.apache.poi.hssf.record.ObjectProtectRecord
  21825. @see org.apache.poi.hssf.record.Record
  21826. @return an ObjectProtectRecord
  21827. </member>
  21828. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateScenarioProtect">
  21829. Creates a ScenarioProtect record with protect Set to false.
  21830. @see org.apache.poi.hssf.record.ScenarioProtectRecord
  21831. @see org.apache.poi.hssf.record.Record
  21832. @return a ScenarioProtectRecord
  21833. </member>
  21834. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayGridlines">
  21835. Returns if gridlines are Displayed.
  21836. @return whether gridlines are Displayed
  21837. </member>
  21838. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayFormulas">
  21839. Returns if formulas are Displayed.
  21840. @return whether formulas are Displayed
  21841. </member>
  21842. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayRowColHeadings">
  21843. Returns if RowColHeadings are Displayed.
  21844. @return whether RowColHeadings are Displayed
  21845. </member>
  21846. <member name="P:NPOI.HSSF.Model.InternalSheet.IsPrintRowColHeadings">
  21847. Returns if RowColHeadings are displayed.
  21848. @return whether RowColHeadings are displayed
  21849. </member>
  21850. <member name="P:NPOI.HSSF.Model.InternalSheet.IsUncalced">
  21851. @return whether an Uncalced record must be Inserted or not at generation
  21852. </member>
  21853. <member name="M:NPOI.HSSF.Model.InternalSheet.AggregateDrawingRecords(NPOI.HSSF.Model.DrawingManager2,System.Boolean)">
  21854. <summary>
  21855. Finds the DrawingRecord for our sheet, and attaches it to the DrawingManager (which knows about
  21856. the overall DrawingGroup for our workbook).
  21857. If requested, will Create a new DrawRecord if none currently exist
  21858. </summary>
  21859. <param name="drawingManager">The DrawingManager2 for our workbook</param>
  21860. <param name="CreateIfMissing">Should one be Created if missing?</param>
  21861. <returns>location of EscherAggregate record. if no EscherAggregate record is found return -1</returns>
  21862. </member>
  21863. <member name="M:NPOI.HSSF.Model.InternalSheet.Preserialize">
  21864. Perform any work necessary before the sheet is about to be Serialized.
  21865. For instance the escher aggregates size needs to be calculated before
  21866. serialization so that the dgg record (which occurs first) can be written.
  21867. </member>
  21868. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int16,System.Int16,System.Int32)">
  21869. Shifts all the page breaks in the range "count" number of rows/columns
  21870. @param breaks The page record to be Shifted
  21871. @param start Starting "main" value to Shift breaks
  21872. @param stop Ending "main" value to Shift breaks
  21873. @param count number of Units (rows/columns) to Shift by
  21874. </member>
  21875. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  21876. Shifts the horizontal page breaks for the indicated count
  21877. @param startingRow
  21878. @param endingRow
  21879. @param count
  21880. </member>
  21881. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  21882. Shifts the vertical page breaks for the indicated count
  21883. @param startingCol
  21884. @param endingCol
  21885. @param count
  21886. </member>
  21887. <member name="M:NPOI.HSSF.Model.InternalSheet.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  21888. Updates formulas in cells and conditional formats due to moving of cells
  21889. @param externSheetIndex the externSheet index of this sheet
  21890. </member>
  21891. <member name="M:NPOI.HSSF.Model.InternalSheet.GetSizeOfInitialSheetRecords(System.Int32)">
  21892. 'initial sheet records' are between INDEX and the 'Row Blocks'
  21893. @param bofRecordIndex index of record after which INDEX record is to be placed
  21894. @return count of bytes from end of INDEX record to first ROW record.
  21895. </member>
  21896. <member name="M:NPOI.HSSF.Model.InternalSheet.GetNoteRecords">
  21897. Get the {@link NoteRecord}s (related to cell comments) for this sheet
  21898. @return never <code>null</code>, typically empty array
  21899. </member>
  21900. <member name="T:NPOI.HSSF.Model.InternalWorkbook">
  21901. Low level model implementation of a Workbook. Provides creational methods
  21902. for Settings and objects contained in the workbook object.
  21903. This file Contains the low level binary records starting at the workbook's BOF and
  21904. ending with the workbook's EOF. Use HSSFWorkbook for a high level representation.
  21905. The structures of the highlevel API use references to this to perform most of their
  21906. operations. Its probably Unwise to use these low level structures directly Unless you
  21907. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  21908. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  21909. before even attempting to use this.
  21910. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  21911. @author Sergei Kozello (sergeikozello at mail.ru)
  21912. @author Shawn Laubach (slaubach at apache dot org) (Data Formats)
  21913. @author Andrew C. Oliver (acoliver at apache dot org)
  21914. @author Brian Sanders (bsanders at risklabs dot com) - custom palette
  21915. @author Dan Sherman (dsherman at Isisph.com)
  21916. @author Glen Stampoultzis (glens at apache.org)
  21917. @see org.apache.poi.hssf.usermodel.HSSFWorkbook
  21918. @version 1.0-pre
  21919. </member>
  21920. <member name="F:NPOI.HSSF.Model.InternalWorkbook.MAX_SENSITIVE_SHEET_NAME_LEN">
  21921. Excel silently truncates long sheet names to 31 chars.
  21922. This constant is used to ensure uniqueness in the first 31 chars
  21923. </member>
  21924. <member name="F:NPOI.HSSF.Model.InternalWorkbook.WORKBOOK_DIR_ENTRY_NAMES">
  21925. Normally, the Workbook will be in a POIFS Stream
  21926. called "Workbook". However, some weird XLS generators use "WORKBOOK"
  21927. </member>
  21928. <member name="F:NPOI.HSSF.Model.InternalWorkbook.OLD_WORKBOOK_DIR_ENTRY_NAME">
  21929. Name of older (pre-Excel 97) Workbook streams, which
  21930. aren't supported by HSSFWorkbook, only by
  21931. {@link OldExcelExtractor}
  21932. </member>
  21933. <member name="F:NPOI.HSSF.Model.InternalWorkbook.CODEPAGE">
  21934. constant used to Set the "codepage" wherever "codepage" is Set in records
  21935. (which is duplciated in more than one record)
  21936. </member>
  21937. <member name="F:NPOI.HSSF.Model.InternalWorkbook.records">
  21938. this Contains the Worksheet record objects
  21939. </member>
  21940. <member name="F:NPOI.HSSF.Model.InternalWorkbook.sst">
  21941. this Contains a reference to the SSTRecord so that new stings can be Added
  21942. to it.
  21943. </member>
  21944. <member name="F:NPOI.HSSF.Model.InternalWorkbook.boundsheets">
  21945. holds the "boundsheet" records (aka bundlesheet) so that they can have their
  21946. reference to their "BOF" marker
  21947. </member>
  21948. <member name="M:NPOI.HSSF.Model.InternalWorkbook.#ctor">
  21949. Creates new Workbook with no intitialization --useless right now
  21950. @see #CreateWorkbook(List)
  21951. </member>
  21952. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  21953. Read support for low level
  21954. API. Pass in an array of Record objects, A Workbook
  21955. object is constructed and passed back with all of its initialization Set
  21956. to the passed in records and references to those records held. Unlike Sheet
  21957. workbook does not use an offset (its assumed to be 0) since its first in a file.
  21958. If you need an offset then construct a new array with a 0 offset or Write your
  21959. own ;-p.
  21960. @param recs an array of Record objects
  21961. @return Workbook object
  21962. </member>
  21963. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameCommentRecord(NPOI.HSSF.Record.NameRecord)">
  21964. gets the name comment record
  21965. @param nameRecord name record who's comment is required.
  21966. @return name comment record or <code>null</code> if there isn't one for the given name.
  21967. </member>
  21968. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook">
  21969. Creates an empty workbook object with three blank sheets and all the empty
  21970. fields. Use this to Create a workbook from scratch.
  21971. </member>
  21972. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSpecificBuiltinRecord(System.Byte,System.Int32)">
  21973. Retrieves the Builtin NameRecord that matches the name and index
  21974. There shouldn't be too many names to make the sequential search too slow
  21975. @param name byte representation of the builtin name to match
  21976. @param sheetIndex Index to match
  21977. @return null if no builtin NameRecord matches
  21978. </member>
  21979. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveBuiltinRecord(System.Byte,System.Int32)">
  21980. Removes the specified Builtin NameRecord that matches the name and index
  21981. @param name byte representation of the builtin to match
  21982. @param sheetIndex zero-based sheet reference
  21983. </member>
  21984. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontRecordAt(System.Int32)">
  21985. Gets the font record at the given index in the font table. Remember
  21986. "There is No Four" (someone at M$ must have gone to Rocky Horror one too
  21987. many times)
  21988. @param idx the index to look at (0 or greater but NOT 4)
  21989. @return FontRecord located at the given index
  21990. </member>
  21991. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateNewFont">
  21992. Creates a new font record and Adds it to the "font table". This causes the
  21993. boundsheets to move down one, extended formats to move down (so this function moves
  21994. those pointers as well)
  21995. @return FontRecord that was just Created
  21996. </member>
  21997. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CloneDrawings(NPOI.HSSF.Model.InternalSheet)">
  21998. Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and
  21999. re-generate shape IDs
  22000. @param sheet the cloned sheet
  22001. </member>
  22002. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumberOfFontRecords">
  22003. Gets the number of font records
  22004. @return number of font records in the "font table"
  22005. </member>
  22006. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetBof(System.Int32,System.Int32)">
  22007. Sets the BOF for a given sheet
  22008. @param sheetnum the number of the sheet to Set the positing of the bof for
  22009. @param pos the actual bof position
  22010. </member>
  22011. <member name="P:NPOI.HSSF.Model.InternalWorkbook.BackupRecord">
  22012. Returns the position of the backup record.
  22013. </member>
  22014. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String)">
  22015. Sets the name for a given sheet. If the boundsheet record doesn't exist and
  22016. its only one more than we have, go ahead and Create it. If its > 1 more than
  22017. we have, except
  22018. @param sheetnum the sheet number (0 based)
  22019. @param sheetname the name for the sheet
  22020. </member>
  22021. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ContainsSheetName(System.String,System.Int32)">
  22022. Determines whether a workbook Contains the provided sheet name.
  22023. @param name the name to test (case insensitive match)
  22024. @param excludeSheetIdx the sheet to exclude from the Check or -1 to include all sheets in the Check.
  22025. @return true if the sheet Contains the name, false otherwise.
  22026. </member>
  22027. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String,System.Int16)">
  22028. Sets the name for a given sheet forcing the encoding. This is STILL A BAD IDEA.
  22029. Poi now automatically detects Unicode
  22030. @deprecated 3-Jan-06 Simply use SetSheetNam e(int sheetnum, String sheetname)
  22031. @param sheetnum the sheet number (0 based)
  22032. @param sheetname the name for the sheet
  22033. </member>
  22034. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetOrder(System.String,System.Int32)">
  22035. Sets the order of appearance for a given sheet.
  22036. @param sheetname the name of the sheet to reorder
  22037. @param pos the position that we want to Insert the sheet into (0 based)
  22038. </member>
  22039. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetName(System.Int32)">
  22040. Gets the name for a given sheet.
  22041. @param sheetnum the sheet number (0 based)
  22042. @return sheetname the name for the sheet
  22043. </member>
  22044. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetHidden(System.Int32)">
  22045. Gets the hidden flag for a given sheet.
  22046. @param sheetnum the sheet number (0 based)
  22047. @return True if sheet is hidden
  22048. </member>
  22049. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetVeryHidden(System.Int32)">
  22050. Gets the hidden flag for a given sheet.
  22051. Note that a sheet could instead be
  22052. set to be very hidden, which is different
  22053. ({@link #isSheetVeryHidden(int)})
  22054. @param sheetnum the sheet number (0 based)
  22055. @return True if sheet is hidden
  22056. </member>
  22057. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  22058. Hide or Unhide a sheet
  22059. @param sheetnum The sheet number
  22060. @param hidden True to mark the sheet as hidden, false otherwise
  22061. </member>
  22062. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  22063. Hide or unhide a sheet.
  22064. 0 = not hidden
  22065. 1 = hidden
  22066. 2 = very hidden.
  22067. @param sheetnum The sheet number
  22068. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  22069. </member>
  22070. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetIndex(System.String)">
  22071. Get the sheet's index
  22072. @param name sheet name
  22073. @return sheet index or -1 if it was not found.
  22074. </member>
  22075. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckSheets(System.Int32)">
  22076. if we're trying to Address one more sheet than we have, go ahead and Add it! if we're
  22077. trying to Address >1 more than we have throw an exception!
  22078. </member>
  22079. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FixTabIdRecord">
  22080. <summary>
  22081. make the tabid record look like the current situation.
  22082. </summary>
  22083. <returns>number of bytes written in the TabIdRecord</returns>
  22084. </member>
  22085. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumSheets">
  22086. returns the number of boundsheet objects contained in this workbook.
  22087. @return number of BoundSheet records
  22088. </member>
  22089. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumExFormats">
  22090. Get the number of ExtendedFormat records contained in this workbook.
  22091. @return int count of ExtendedFormat records
  22092. </member>
  22093. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontIndex(NPOI.HSSF.Record.FontRecord)">
  22094. Retrieves the index of the given font
  22095. </member>
  22096. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetStyleRecord(System.Int32)">
  22097. Returns the StyleRecord for the given
  22098. xfIndex, or null if that ExtendedFormat doesn't
  22099. have a Style set.
  22100. </member>
  22101. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetExFormatAt(System.Int32)">
  22102. Gets the ExtendedFormatRecord at the given 0-based index
  22103. @param index of the Extended format record (0-based)
  22104. @return ExtendedFormatRecord at the given index
  22105. </member>
  22106. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCellXF">
  22107. Creates a new Cell-type Extneded Format Record and Adds it to the end of
  22108. ExtendedFormatRecords collection
  22109. @return ExtendedFormatRecord that was Created
  22110. </member>
  22111. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddSSTString(NPOI.HSSF.Record.UnicodeString)">
  22112. Adds a string to the SST table and returns its index (if its a duplicate
  22113. just returns its index and update the counts) ASSUMES compressed Unicode
  22114. (meaning 8bit)
  22115. @param string the string to be Added to the SSTRecord
  22116. @return index of the string within the SSTRecord
  22117. </member>
  22118. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSSTString(System.Int32)">
  22119. given an index into the SST table, this function returns the corresponding String value
  22120. @return String containing the SST String
  22121. </member>
  22122. <member name="M:NPOI.HSSF.Model.InternalWorkbook.InsertSST">
  22123. use this function to Add a Shared String Table to an existing sheet (say
  22124. generated by a different java api) without an sst....
  22125. @see #CreateSST()
  22126. @see org.apache.poi.hssf.record.SSTRecord
  22127. </member>
  22128. <member name="M:NPOI.HSSF.Model.InternalWorkbook.Serialize(System.Int32,System.Byte[])">
  22129. Serializes all records int the worksheet section into a big byte array. Use
  22130. this to Write the Workbook out.
  22131. @param offset of the data to be written
  22132. @param data array of bytes to Write this to
  22133. </member>
  22134. <member name="M:NPOI.HSSF.Model.InternalWorkbook.PreSerialize">
  22135. Perform any work necessary before the workbook is about to be serialized.
  22136. Include in it ant code that modifies the workbook record stream and affects its size.
  22137. </member>
  22138. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBOF">
  22139. Creates the BOF record
  22140. @see org.apache.poi.hssf.record.BOFRecord
  22141. @see org.apache.poi.hssf.record.Record
  22142. @return record containing a BOFRecord
  22143. </member>
  22144. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceHdr">
  22145. Creates the InterfaceHdr record
  22146. @see org.apache.poi.hssf.record.InterfaceHdrRecord
  22147. @see org.apache.poi.hssf.record.Record
  22148. @return record containing a InterfaceHdrRecord
  22149. </member>
  22150. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateMMS">
  22151. Creates an MMS record
  22152. @see org.apache.poi.hssf.record.MMSRecord
  22153. @see org.apache.poi.hssf.record.Record
  22154. @return record containing a MMSRecord
  22155. </member>
  22156. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceEnd">
  22157. Creates the InterfaceEnd record
  22158. @see org.apache.poi.hssf.record.InterfaceEndRecord
  22159. @see org.apache.poi.hssf.record.Record
  22160. @return record containing a InterfaceEndRecord
  22161. </member>
  22162. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWriteAccess">
  22163. Creates the WriteAccess record containing the logged in user's name
  22164. @see org.apache.poi.hssf.record.WriteAccessRecord
  22165. @see org.apache.poi.hssf.record.Record
  22166. @return record containing a WriteAccessRecord
  22167. </member>
  22168. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCodepage">
  22169. Creates the Codepage record containing the constant stored in CODEPAGE
  22170. @see org.apache.poi.hssf.record.CodepageRecord
  22171. @see org.apache.poi.hssf.record.Record
  22172. @return record containing a CodepageRecord
  22173. </member>
  22174. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDSF">
  22175. Creates the DSF record containing a 0 since HSSF can't even Create Dual Stream Files
  22176. @see org.apache.poi.hssf.record.DSFRecord
  22177. @see org.apache.poi.hssf.record.Record
  22178. @return record containing a DSFRecord
  22179. </member>
  22180. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateTabId">
  22181. Creates the TabId record containing an array of 0,1,2. This release of HSSF
  22182. always has the default three sheets, no less, no more.
  22183. @see org.apache.poi.hssf.record.TabIdRecord
  22184. @see org.apache.poi.hssf.record.Record
  22185. @return record containing a TabIdRecord
  22186. </member>
  22187. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFnGroupCount">
  22188. Creates the FnGroupCount record containing the Magic number constant of 14.
  22189. @see org.apache.poi.hssf.record.FnGroupCountRecord
  22190. @see org.apache.poi.hssf.record.Record
  22191. @return record containing a FnGroupCountRecord
  22192. </member>
  22193. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowProtect">
  22194. Creates the WindowProtect record with protect Set to false.
  22195. @see org.apache.poi.hssf.record.WindowProtectRecord
  22196. @see org.apache.poi.hssf.record.Record
  22197. @return record containing a WindowProtectRecord
  22198. </member>
  22199. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtect">
  22200. Creates the Protect record with protect Set to false.
  22201. @see org.apache.poi.hssf.record.ProtectRecord
  22202. @see org.apache.poi.hssf.record.Record
  22203. @return record containing a ProtectRecord
  22204. </member>
  22205. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePassword">
  22206. Creates the Password record with password Set to 0.
  22207. @see org.apache.poi.hssf.record.PasswordRecord
  22208. @see org.apache.poi.hssf.record.Record
  22209. @return record containing a PasswordRecord
  22210. </member>
  22211. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtectionRev4">
  22212. Creates the ProtectionRev4 record with protect Set to false.
  22213. @see org.apache.poi.hssf.record.ProtectionRev4Record
  22214. @see org.apache.poi.hssf.record.Record
  22215. @return record containing a ProtectionRev4Record
  22216. </member>
  22217. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePasswordRev4">
  22218. Creates the PasswordRev4 record with password Set to 0.
  22219. @see org.apache.poi.hssf.record.PasswordRev4Record
  22220. @see org.apache.poi.hssf.record.Record
  22221. @return record containing a PasswordRev4Record
  22222. </member>
  22223. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowOne">
  22224. Creates the WindowOne record with the following magic values:
  22225. horizontal hold - 0x168
  22226. vertical hold - 0x10e
  22227. width - 0x3a5c
  22228. height - 0x23be
  22229. options - 0x38
  22230. selected tab - 0
  22231. Displayed tab - 0
  22232. num selected tab- 0
  22233. tab width ratio - 0x258
  22234. @see org.apache.poi.hssf.record.WindowOneRecord
  22235. @see org.apache.poi.hssf.record.Record
  22236. @return record containing a WindowOneRecord
  22237. </member>
  22238. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBackup">
  22239. Creates the Backup record with backup Set to 0. (loose the data, who cares)
  22240. @see org.apache.poi.hssf.record.BackupRecord
  22241. @see org.apache.poi.hssf.record.Record
  22242. @return record containing a BackupRecord
  22243. </member>
  22244. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateHideObj">
  22245. Creates the HideObj record with hide object Set to 0. (don't hide)
  22246. @see org.apache.poi.hssf.record.HideObjRecord
  22247. @see org.apache.poi.hssf.record.Record
  22248. @return record containing a HideObjRecord
  22249. </member>
  22250. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDateWindow1904">
  22251. Creates the DateWindow1904 record with windowing Set to 0. (don't window)
  22252. @see org.apache.poi.hssf.record.DateWindow1904Record
  22253. @see org.apache.poi.hssf.record.Record
  22254. @return record containing a DateWindow1904Record
  22255. </member>
  22256. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePrecision">
  22257. Creates the Precision record with precision Set to true. (full precision)
  22258. @see org.apache.poi.hssf.record.PrecisionRecord
  22259. @see org.apache.poi.hssf.record.Record
  22260. @return record containing a PrecisionRecord
  22261. </member>
  22262. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateRefreshAll">
  22263. Creates the RefreshAll record with refreshAll Set to true. (refresh all calcs)
  22264. @see org.apache.poi.hssf.record.RefreshAllRecord
  22265. @see org.apache.poi.hssf.record.Record
  22266. @return record containing a RefreshAllRecord
  22267. </member>
  22268. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBookBool">
  22269. Creates the BookBool record with saveLinkValues Set to 0. (don't save link values)
  22270. @see org.apache.poi.hssf.record.BookBoolRecord
  22271. @see org.apache.poi.hssf.record.Record
  22272. @return record containing a BookBoolRecord
  22273. </member>
  22274. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFont">
  22275. Creates a Font record with the following magic values:
  22276. fontheight = 0xc8
  22277. attributes = 0x0
  22278. color palette index = 0x7fff
  22279. bold weight = 0x190
  22280. Font Name Length = 5
  22281. Font Name = Arial
  22282. @see org.apache.poi.hssf.record.FontRecord
  22283. @see org.apache.poi.hssf.record.Record
  22284. @return record containing a FontRecord
  22285. </member>
  22286. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat(System.Int32)">
  22287. Creates an ExtendedFormatRecord object
  22288. @param id the number of the extended format record to Create (meaning its position in
  22289. a file as MS Excel would Create it.)
  22290. @return record containing an ExtendedFormatRecord
  22291. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  22292. @see org.apache.poi.hssf.record.Record
  22293. </member>
  22294. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat">
  22295. Creates an default cell type ExtendedFormatRecord object.
  22296. @return ExtendedFormatRecord with intial defaults (cell-type)
  22297. </member>
  22298. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyleRecord(System.Int32)">
  22299. Creates a new StyleRecord, for the given Extended
  22300. Format index, and adds it onto the end of the
  22301. records collection
  22302. </member>
  22303. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyle(System.Int32)">
  22304. Creates a StyleRecord object
  22305. @param id the number of the style record to Create (meaning its position in
  22306. a file as MS Excel would Create it.
  22307. @return record containing a StyleRecord
  22308. @see org.apache.poi.hssf.record.StyleRecord
  22309. @see org.apache.poi.hssf.record.Record
  22310. </member>
  22311. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePalette">
  22312. Creates a palette record initialized to the default palette
  22313. @return a PaletteRecord instance populated with the default colors
  22314. @see org.apache.poi.hssf.record.PaletteRecord
  22315. </member>
  22316. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateUseSelFS">
  22317. Creates the UseSelFS object with the use natural language flag Set to 0 (false)
  22318. @return record containing a UseSelFSRecord
  22319. @see org.apache.poi.hssf.record.UseSelFSRecord
  22320. @see org.apache.poi.hssf.record.Record
  22321. </member>
  22322. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBoundSheet(System.Int32)">
  22323. Create a "bound sheet" or "bundlesheet" (depending who you ask) record
  22324. Always Sets the sheet's bof to 0. You'll need to Set that yourself.
  22325. @param id either sheet 0,1 or 2.
  22326. @return record containing a BoundSheetRecord
  22327. @see org.apache.poi.hssf.record.BoundSheetRecord
  22328. @see org.apache.poi.hssf.record.Record
  22329. </member>
  22330. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCountry">
  22331. Creates the Country record with the default country Set to 1
  22332. and current country Set to 7 in case of russian locale ("ru_RU") and 1 otherwise
  22333. @return record containing a CountryRecord
  22334. @see org.apache.poi.hssf.record.CountryRecord
  22335. @see org.apache.poi.hssf.record.Record
  22336. </member>
  22337. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedSST">
  22338. Creates the ExtendedSST record with numstrings per bucket Set to 0x8. HSSF
  22339. doesn't yet know what to do with this thing, but we Create it with nothing in
  22340. it hardly just to make Excel happy and our sheets look like Excel's
  22341. @return record containing an ExtSSTRecord
  22342. @see org.apache.poi.hssf.record.ExtSSTRecord
  22343. @see org.apache.poi.hssf.record.Record
  22344. </member>
  22345. <member name="P:NPOI.HSSF.Model.InternalWorkbook.OrCreateLinkTable">
  22346. lazy initialization
  22347. Note - creating the link table causes creation of 1 EXTERNALBOOK and 1 EXTERNALSHEET record
  22348. </member>
  22349. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindSheetFirstNameFromExternSheet(System.Int32)">
  22350. Finds the first sheet name by his extern sheet index
  22351. @param externSheetIndex extern sheet index
  22352. @return first sheet name.
  22353. </member>
  22354. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFirstSheetIndexFromExternSheetIndex(System.Int32)">
  22355. Finds the (first) sheet index for a particular external sheet number.
  22356. @param externSheetNumber The external sheet number to convert
  22357. @return The index to the sheet found.
  22358. </member>
  22359. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetLastSheetIndexFromExternSheetIndex(System.Int32)">
  22360. Finds the last sheet index for a particular external sheet number,
  22361. which may be the same as the first (except for multi-sheet references)
  22362. @param externSheetNumber The external sheet number to convert
  22363. @return The index to the sheet found.
  22364. </member>
  22365. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckExternSheet(System.Int32)">
  22366. Returns the extern sheet number for specific sheet number.
  22367. If this sheet doesn't exist in extern sheet, add it
  22368. @param sheetNumber local sheet number
  22369. @return index to extern sheet
  22370. </member>
  22371. <member name="M:NPOI.HSSF.Model.InternalWorkbook.checkExternSheet(System.Int32,System.Int32)">
  22372. Returns the extern sheet number for specific range of sheets.
  22373. If this sheet range doesn't exist in extern sheet, add it
  22374. @param firstSheetNumber first local sheet number
  22375. @param lastSheetNumber last local sheet number
  22376. @return index to extern sheet
  22377. </member>
  22378. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumNames">
  22379. Gets the total number of names
  22380. @return number of names
  22381. </member>
  22382. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameXPtg(System.String,System.Int32,NPOI.SS.Formula.UDF.UDFFinder)">
  22383. @param name the name of an external function, typically a name of a UDF
  22384. @param sheetRefIndex the sheet ref index, or -1 if not known
  22385. @param udf locator of user-defiend functions to resolve names of VBA and Add-In functions
  22386. @return the external name or null
  22387. </member>
  22388. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameRecord(System.Int32)">
  22389. Gets the name record
  22390. @param index name index
  22391. @return name record
  22392. </member>
  22393. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateName">
  22394. Creates new name
  22395. @return new name record
  22396. </member>
  22397. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddName(NPOI.HSSF.Record.NameRecord)">
  22398. Creates new name
  22399. @return new name record
  22400. </member>
  22401. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBuiltInName(System.Byte,System.Int32)">
  22402. Generates a NameRecord to represent a built-in region
  22403. @return a new NameRecord Unless the index is invalid
  22404. </member>
  22405. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveName(System.Int32)">
  22406. Removes the name
  22407. @param namenum name index
  22408. </member>
  22409. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNameCommentRecordCache(NPOI.HSSF.Record.NameCommentRecord)">
  22410. If a {@link NameCommentRecord} is added or the name it references
  22411. is renamed, then this will update the lookup cache for it.
  22412. </member>
  22413. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFormat(System.String,System.Boolean)">
  22414. Returns a format index that matches the passed in format. It does not tie into HSSFDataFormat.
  22415. @param format the format string
  22416. @param CreateIfNotFound Creates a new format if format not found
  22417. @return the format id of a format that matches or -1 if none found and CreateIfNotFound
  22418. </member>
  22419. <member name="P:NPOI.HSSF.Model.InternalWorkbook.Formats">
  22420. Returns the list of FormatRecords in the workbook.
  22421. @return ArrayList of FormatRecords in the notebook
  22422. </member>
  22423. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.String)">
  22424. Creates a FormatRecord, Inserts it, and returns the index code.
  22425. @param format the format string
  22426. @return the index code of the format record.
  22427. @see org.apache.poi.hssf.record.FormatRecord
  22428. @see org.apache.poi.hssf.record.Record
  22429. </member>
  22430. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.Int32)">
  22431. Creates a FormatRecord object
  22432. @param id the number of the format record to create (meaning its position in
  22433. a file as M$ Excel would create it.)
  22434. </member>
  22435. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordBySid(System.Int16)">
  22436. Returns the first occurance of a record matching a particular sid.
  22437. </member>
  22438. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordLocBySid(System.Int16)">
  22439. Returns the index of a record matching a particular sid.
  22440. @param sid The sid of the record to match
  22441. @return The index of -1 if no match made.
  22442. </member>
  22443. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindNextRecordBySid(System.Int16,System.Int32)">
  22444. Returns the next occurance of a record matching a particular sid.
  22445. </member>
  22446. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsUsing1904DateWindowing">
  22447. Whether date windowing is based on 1/2/1904 or 1/1/1900.
  22448. Some versions of Excel (Mac) can save workbooks using 1904 date windowing.
  22449. @return true if using 1904 date windowing
  22450. </member>
  22451. <member name="P:NPOI.HSSF.Model.InternalWorkbook.CustomPalette">
  22452. Returns the custom palette in use for this workbook; if a custom palette record
  22453. does not exist, then it is Created.
  22454. </member>
  22455. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindDrawingGroup">
  22456. Finds the primary drawing Group, if one already exists
  22457. </member>
  22458. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDrawingGroup">
  22459. Creates a primary drawing Group record. If it already
  22460. exists then it's modified.
  22461. </member>
  22462. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveFontRecord(NPOI.HSSF.Record.FontRecord)">
  22463. Removes the given font record from the
  22464. file's list. This will make all
  22465. subsequent font indicies drop by one,
  22466. so you'll need to update those yourself!
  22467. </member>
  22468. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(NPOI.HSSF.Record.ExtendedFormatRecord)">
  22469. Removes the given ExtendedFormatRecord record from the
  22470. file's list. This will make all
  22471. subsequent font indicies drop by one,
  22472. so you'll need to update those yourself!
  22473. </member>
  22474. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(System.Int32)">
  22475. <summary>
  22476. Removes ExtendedFormatRecord record with given index from the file's list. This will make all
  22477. subsequent font indicies drop by one,so you'll need to update those yourself!
  22478. </summary>
  22479. <param name="index">index of the Extended format record (0-based)</param>
  22480. </member>
  22481. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsWriteProtected">
  22482. is the workbook protected with a password (not encrypted)?
  22483. </member>
  22484. <member name="M:NPOI.HSSF.Model.InternalWorkbook.WriteProtectWorkbook(System.String,System.String)">
  22485. protect a workbook with a password (not encypted, just Sets Writeprotect
  22486. flags and the password.
  22487. @param password to Set
  22488. </member>
  22489. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UnwriteProtectWorkbook">
  22490. Removes the Write protect flag
  22491. </member>
  22492. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  22493. @param reFindex Index to REF entry in EXTERNSHEET record in the Link Table
  22494. @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record
  22495. @return the string representation of the defined or external name
  22496. </member>
  22497. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNamesAfterCellShift(NPOI.SS.Formula.FormulaShifter)">
  22498. Updates named ranges due to moving of cells
  22499. </member>
  22500. <member name="P:NPOI.HSSF.Model.InternalWorkbook.RecalcId">
  22501. Get or create RecalcIdRecord
  22502. @see org.apache.poi.hssf.usermodel.HSSFWorkbook#setForceFormulaRecalculation(boolean)
  22503. </member>
  22504. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ChangeExternalReference(System.String,System.String)">
  22505. Changes an external referenced file to another file.
  22506. A formular in Excel which refers a cell in another file is saved in two parts:
  22507. The referenced file is stored in an reference table. the row/cell information is saved separate.
  22508. This method invokation will only change the reference in the lookup-table itself.
  22509. @param oldUrl The old URL to search for and which is to be replaced
  22510. @param newUrl The URL replacement
  22511. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  22512. </member>
  22513. <member name="T:NPOI.HSSF.Model.WorkbookRecordList">
  22514. <summary>
  22515. List for records in Workbook
  22516. </summary>
  22517. </member>
  22518. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Records">
  22519. <summary>
  22520. Gets or sets the records.
  22521. </summary>
  22522. <value>The records.</value>
  22523. </member>
  22524. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Count">
  22525. <summary>
  22526. Gets the count.
  22527. </summary>
  22528. <value>The count.</value>
  22529. </member>
  22530. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Item(System.Int32)">
  22531. <summary>
  22532. Gets the <see cref="T:NPOI.HSSF.Record.Record"/> at the specified index.
  22533. </summary>
  22534. <value></value>
  22535. </member>
  22536. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Add(System.Int32,NPOI.HSSF.Record.Record)">
  22537. <summary>
  22538. Adds the specified pos.
  22539. </summary>
  22540. <param name="pos">The pos.</param>
  22541. <param name="r">The r.</param>
  22542. </member>
  22543. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(NPOI.HSSF.Record.Record)">
  22544. <summary>
  22545. Removes the specified record.
  22546. </summary>
  22547. <param name="record">The record.</param>
  22548. </member>
  22549. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(System.Int32)">
  22550. <summary>
  22551. Removes the specified position.
  22552. </summary>
  22553. <param name="pos">The position.</param>
  22554. </member>
  22555. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Protpos">
  22556. <summary>
  22557. Gets or sets the protpos.
  22558. </summary>
  22559. <value>The protpos.</value>
  22560. </member>
  22561. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Bspos">
  22562. <summary>
  22563. Gets or sets the bspos.
  22564. </summary>
  22565. <value>The bspos.</value>
  22566. </member>
  22567. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Tabpos">
  22568. <summary>
  22569. Gets or sets the tabpos.
  22570. </summary>
  22571. <value>The tabpos.</value>
  22572. </member>
  22573. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Fontpos">
  22574. <summary>
  22575. Gets or sets the fontpos.
  22576. </summary>
  22577. <value>The fontpos.</value>
  22578. </member>
  22579. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Xfpos">
  22580. <summary>
  22581. Gets or sets the xfpos.
  22582. </summary>
  22583. <value>The xfpos.</value>
  22584. </member>
  22585. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Backuppos">
  22586. <summary>
  22587. Gets or sets the backuppos.
  22588. </summary>
  22589. <value>The backuppos.</value>
  22590. </member>
  22591. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Palettepos">
  22592. <summary>
  22593. Gets or sets the palettepos.
  22594. </summary>
  22595. <value>The palettepos.</value>
  22596. </member>
  22597. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Namepos">
  22598. <summary>
  22599. Gets or sets the namepos.
  22600. </summary>
  22601. <value>The namepos.</value>
  22602. </member>
  22603. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Supbookpos">
  22604. <summary>
  22605. Gets or sets the supbookpos.
  22606. </summary>
  22607. <value>The supbookpos.</value>
  22608. </member>
  22609. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.ExternsheetPos">
  22610. <summary>
  22611. Gets or sets the externsheet pos.
  22612. </summary>
  22613. <value>The externsheet pos.</value>
  22614. </member>
  22615. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIDecryptor.InitCipherForBlock(NPOI.POIFS.Crypt.Cipher,System.Int32)">
  22616. Initializes a cipher object for a given block index for decryption
  22617. @param cipher may be null, otherwise the given instance is reset to the new block index
  22618. @param block the block index, e.g. the persist/slide id (hslf)
  22619. @return a new cipher object, if cipher was null, otherwise the reInitialized cipher
  22620. @throws GeneralSecurityException
  22621. </member>
  22622. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIDecryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  22623. Decrypt the Document-/SummaryInformation and other optionally streams.
  22624. Opposed to other crypto modes, cryptoapi is record based and can't be used
  22625. to stream-decrypt a whole file
  22626. @see <a href="http://msdn.microsoft.com/en-us/library/dd943321(v=office.12).aspx">2.3.5.4 RC4 CryptoAPI Encrypted Summary Stream</a>
  22627. </member>
  22628. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIDecryptor.GetLength">
  22629. @return the length of the stream returned by {@link #getDataStream(DirectoryNode)}
  22630. </member>
  22631. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.Util.ILittleEndianInput)">
  22632. Initialize the builder from a stream
  22633. </member>
  22634. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  22635. Initialize the builder from scratch
  22636. </member>
  22637. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptor.InitCipherForBlock(NPOI.POIFS.Crypt.Cipher,System.Int32)">
  22638. Initializes a cipher object for a given block index for encryption
  22639. @param cipher may be null, otherwise the given instance is reset to the new block index
  22640. @param block the block index, e.g. the persist/slide id (hslf)
  22641. @return a new cipher object, if cipher was null, otherwise the reInitialized cipher
  22642. @throws GeneralSecurityException
  22643. </member>
  22644. <member name="M:NPOI.POIFS.Crypt.CryptoAPI.CryptoAPIEncryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  22645. Encrypt the Document-/SummaryInformation and other optionally streams.
  22646. Opposed to other crypto modes, cryptoapi is record based and can't be used
  22647. to stream-encrypt a whole file
  22648. @see <a href="http://msdn.microsoft.com/en-us/library/dd943321(v=office.12).aspx">2.3.5.4 RC4 CryptoAPI Encrypted Summary Stream</a>
  22649. </member>
  22650. <member name="T:NPOI.POIFS.Crypt.CryptoFunctions">
  22651. Helper functions used for standard and agile encryption
  22652. </member>
  22653. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.HashPassword(System.String,NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Int32)">
  22654. <p><cite>2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption)<br/>
  22655. 2.3.4.11 Encryption Key Generation (Agile Encryption)</cite></p>
  22656. <p>The encryption key for ECMA-376 document encryption [ECMA-376] using agile
  22657. encryption MUST be generated by using the following method, which is derived from PKCS #5:
  22658. <a href="https://www.ietf.org/rfc/rfc2898.txt">Password-Based Cryptography Version 2.0 [RFC2898]</a>.</p>
  22659. <p>Let H() be a hashing algorithm as determined by the PasswordKeyEncryptor.hashAlgorithm
  22660. element, H_n be the hash data of the n-th iteration, and a plus sign (+) represent concatenation.
  22661. The password MUST be provided as an array of Unicode characters. Limitations on the length of the
  22662. password and the characters used by the password are implementation-dependent.
  22663. The initial password hash is generated as follows:</p>
  22664. <pre>H_0 = H(salt + password)</pre>
  22665. <p>The salt used MUST be generated randomly. The salt MUST be stored in the
  22666. PasswordKeyEncryptor.saltValue element contained within the \EncryptionInfo stream as
  22667. specified in section 2.3.4.10. The hash is then iterated by using the following approach:</p>
  22668. <pre>H_n = H(iterator + H_n-1)</pre>
  22669. <p>where iterator is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented
  22670. monotonically on each iteration until PasswordKey.spinCount iterations have been performed.
  22671. The value of iterator on the last iteration MUST be one less than PasswordKey.spinCount.</p>
  22672. <p>For POI, H_final will be calculated by {@link #generateKey(byte[],HashAlgorithm,byte[],int)}</p>
  22673. @param password
  22674. @param hashAlgorithm
  22675. @param salt
  22676. @param spinCount
  22677. @return the hashed password
  22678. </member>
  22679. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.HashPassword(System.String,NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Int32,System.Boolean)">
  22680. Generalized method for read and write protection hash generation.
  22681. The difference is, read protection uses the order iterator then hash in the hash loop, whereas write protection
  22682. uses first the last hash value and then the current iterator value
  22683. @param password
  22684. @param hashAlgorithm
  22685. @param salt
  22686. @param spinCount
  22687. @param iteratorFirst if true, the iterator is hashed before the n-1 hash value,
  22688. if false the n-1 hash value is applied first
  22689. @return the hashed password
  22690. </member>
  22691. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GenerateIv(NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Byte[],System.Int32)">
  22692. <p><cite>2.3.4.12 Initialization Vector Generation (Agile Encryption)</cite></p>
  22693. <p>Initialization vectors are used in all cases for agile encryption. An initialization vector MUST be
  22694. generated by using the following method, where H() is a hash function that MUST be the same as
  22695. specified in section 2.3.4.11 and a plus sign (+) represents concatenation:</p>
  22696. <ul>
  22697. <li>If a blockKey is provided, let IV be a hash of the KeySalt and the following value:<br/>
  22698. {@code blockKey: IV = H(KeySalt + blockKey)}</li>
  22699. <li>If a blockKey is not provided, let IV be equal to the following value:<br/>
  22700. {@code KeySalt:IV = KeySalt}</li>
  22701. <li>If the number of bytes in the value of IV is less than the the value of the blockSize attribute
  22702. corresponding to the cipherAlgorithm attribute, pad the array of bytes by appending 0x36 until
  22703. the array is blockSize bytes. If the array of bytes is larger than blockSize bytes, truncate the
  22704. array to blockSize bytes.</li>
  22705. </ul>
  22706. </member>
  22707. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GenerateKey(System.Byte[],NPOI.POIFS.Crypt.HashAlgorithm,System.Byte[],System.Int32)">
  22708. <p><cite>2.3.4.11 Encryption Key Generation (Agile Encryption)</cite></p>
  22709. <p>The final hash data that is used for an encryption key is then generated by using the following
  22710. method:</p>
  22711. <pre>H_final = H(H_n + blockKey)</pre>
  22712. <p>where blockKey represents an array of bytes used to prevent two different blocks from encrypting
  22713. to the same cipher text.</p>
  22714. <p>If the size of the resulting H_final is smaller than that of PasswordKeyEncryptor.keyBits, the key
  22715. MUST be padded by appending bytes with a value of 0x36. If the hash value is larger in size than
  22716. PasswordKeyEncryptor.keyBits, the key is obtained by truncating the hash value.</p>
  22717. @param passwordHash
  22718. @param hashAlgorithm
  22719. @param blockKey
  22720. @param keySize
  22721. @return intermediate key
  22722. </member>
  22723. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetCipher(NPOI.POIFS.Crypt.ISecretKey,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.ChainingMode,System.Byte[],System.Int32)">
  22724. Initialize a new cipher object with the given cipher properties and no padding
  22725. If the given algorithm is not implemented in the JCE, it will try to load it from the bouncy castle
  22726. provider.
  22727. @param key the secrect key
  22728. @param cipherAlgorithm the cipher algorithm
  22729. @param chain the chaining mode
  22730. @param vec the initialization vector (IV), can be null
  22731. @param cipherMode Cipher.DECRYPT_MODE or Cipher.ENCRYPT_MODE
  22732. @return the requested cipher
  22733. @throws GeneralSecurityException
  22734. @throws EncryptedDocumentException if the initialization failed or if an algorithm was specified,
  22735. which depends on a missing bouncy castle provider
  22736. </member>
  22737. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetCipher(NPOI.POIFS.Crypt.IKey,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.ChainingMode,System.Byte[],System.Int32,System.String)">
  22738. Initialize a new cipher object with the given cipher properties
  22739. If the given algorithm is not implemented in the JCE, it will try to load it from the bouncy castle
  22740. provider.
  22741. @param key the secrect key
  22742. @param cipherAlgorithm the cipher algorithm
  22743. @param chain the chaining mode
  22744. @param vec the Initialization vector (IV), can be null
  22745. @param cipherMode Cipher.DECRYPT_MODE or Cipher.ENCRYPT_MODE
  22746. @param padding the padding (null = NOPADDING, ANSIX923Padding, PKCS5Padding, PKCS7Padding, ISO10126Padding, ...)
  22747. @return the requested cipher
  22748. @throws GeneralSecurityException
  22749. @throws EncryptedDocumentException if the Initialization failed or if an algorithm was specified,
  22750. which depends on a missing bouncy castle provider
  22751. </member>
  22752. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetBlock36(System.Byte[],System.Int32)">
  22753. Returns a new byte array with a tRuncated to the given size.
  22754. If the hash has less then size bytes, it will be Filled with 0x36-bytes
  22755. @param hash the to be tRuncated/filled hash byte array
  22756. @param size the size of the returned byte array
  22757. @return the pAdded hash
  22758. </member>
  22759. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.GetBlock0(System.Byte[],System.Int32)">
  22760. Returns a new byte array with a tRuncated to the given size.
  22761. If the hash has less then size bytes, it will be Filled with 0-bytes
  22762. @param hash the to be tRuncated/filled hash byte array
  22763. @param size the size of the returned byte array
  22764. @return the pAdded hash
  22765. </member>
  22766. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorVerifier1(System.String)">
  22767. Create the verifier for xor obfuscation (method 1)
  22768. @see <a href="http://msdn.microsoft.com/en-us/library/dd926947.aspx">2.3.7.1 Binary Document Password Verifier Derivation Method 1</a>
  22769. @see <a href="http://msdn.microsoft.com/en-us/library/dd905229.aspx">2.3.7.4 Binary Document Password Verifier Derivation Method 2</a>
  22770. @see <a href="http://www.ecma-international.org/news/TC45_current_work/Office Open XML Part 4 - Markup Language Reference.pdf">Part 4 - Markup Language Reference - Ecma International - 3.2.12 fileSharing</a>
  22771. @param password the password
  22772. @return the verifier (actually a short value)
  22773. </member>
  22774. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorVerifier2(System.String)">
  22775. This method generates the xor verifier for word documents &lt; 2007 (method 2).
  22776. Its output will be used as password input for the newer word generations which
  22777. utilize a real hashing algorithm like sha1.
  22778. @param password the password
  22779. @return the hashed password
  22780. @see <a href="http://msdn.microsoft.com/en-us/library/dd905229.aspx">2.3.7.4 Binary Document Password Verifier Derivation Method 2</a>
  22781. @see <a href="http://blogs.msdn.com/b/vsod/archive/2010/04/05/how-to-set-the-editing-restrictions-in-word-using-open-xml-sdk-2-0.aspx">How to Set the editing restrictions in Word using Open XML SDK 2.0</a>
  22782. @see <a href="http://www.aspose.com/blogs/aspose-blogs/vladimir-averkin/archive/2007/08/20/funny-how-the-new-powerful-cryptography-implemented-in-word-2007-turns-it-into-a-perfect-tool-for-document-password-removal.html">Funny: How the new powerful cryptography implemented in Word 2007 turns it into a perfect tool for document password removal.</a>
  22783. </member>
  22784. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.XorHashPassword(System.String)">
  22785. This method generates the xored-hashed password for word documents &lt; 2007.
  22786. </member>
  22787. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.XorHashPasswordReversed(System.String)">
  22788. Convenience function which returns the reversed xored-hashed password for further
  22789. Processing in word documents 2007 and newer, which utilize a real hashing algorithm like sha1.
  22790. </member>
  22791. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorKey1(System.String)">
  22792. Create the xor key for xor obfuscation, which is used to create the xor array (method 1)
  22793. @see <a href="http://msdn.microsoft.com/en-us/library/dd924704.aspx">2.3.7.2 Binary Document XOR Array Initialization Method 1</a>
  22794. @see <a href="http://msdn.microsoft.com/en-us/library/dd905229.aspx">2.3.7.4 Binary Document Password Verifier Derivation Method 2</a>
  22795. @param password the password
  22796. @return the xor key
  22797. </member>
  22798. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.CreateXorArray1(System.String)">
  22799. Creates an byte array for xor obfuscation (method 1)
  22800. @see <a href="http://msdn.microsoft.com/en-us/library/dd924704.aspx">2.3.7.2 Binary Document XOR Array Initialization Method 1</a>
  22801. @see <a href="http://docs.libreoffice.org/oox/html/binarycodec_8cxx_source.html">Libre Office implementation</a>
  22802. @param password the password
  22803. @return the byte array for xor obfuscation
  22804. </member>
  22805. <member name="M:NPOI.POIFS.Crypt.CryptoFunctions.toAnsiPassword(System.String)">
  22806. The provided Unicode password string is converted to a ANSI string
  22807. @param password the password
  22808. @return the ansi bytes
  22809. @see <a href="http://www.ecma-international.org/news/TC45_current_work/Office Open XML Part 4 - Markup Language Reference.pdf">Part 4 - Markup Language Reference - Ecma International</a> (3.2.29 workbookProtection)
  22810. </member>
  22811. <member name="M:NPOI.POIFS.Crypt.Decryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  22812. Return a stream with decrypted data.
  22813. <p>
  22814. Use {@link #getLength()} to Get the size of that data that can be safely read from the stream.
  22815. Just Reading to the end of the input stream is not sufficient because there are
  22816. normally pAdding bytes that must be discarded
  22817. </p>
  22818. @param dir the node to read from
  22819. @return decrypted stream
  22820. </member>
  22821. <member name="M:NPOI.POIFS.Crypt.Decryptor.GetLength">
  22822. Returns the length of the encrypted data that can be safely read with
  22823. {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}.
  22824. Just Reading to the end of the input stream is not sufficient because there are
  22825. normally pAdding bytes that must be discarded
  22826. <p>
  22827. The length variable is Initialized in {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)},
  22828. an attempt to call GetLength() prior to GetDataStream() will result in InvalidOperationException.
  22829. </p>
  22830. @return length of the encrypted data
  22831. @throws InvalidOperationException if {@link #getDataStream(NPOI.POIFS.FileSystem.DirectoryNode)}
  22832. was not called
  22833. </member>
  22834. <member name="T:NPOI.POIFS.Crypt.EncryptionHeader">
  22835. Reads and Processes OOXML Encryption Headers
  22836. The constants are largely based on ZIP constants.
  22837. </member>
  22838. <member name="M:NPOI.POIFS.Crypt.EncryptionHeader.GetCipherMode">
  22839. @deprecated use GetChainingMode().ecmaId
  22840. </member>
  22841. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagCryptoAPI">
  22842. A flag that specifies whether CryptoAPI RC4 or ECMA-376 encryption
  22843. ECMA-376 is used. It MUST be 1 unless flagExternal is 1. If flagExternal is 1, it MUST be 0.
  22844. </member>
  22845. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagDocProps">
  22846. A value that MUST be 0 if document properties are encrypted.
  22847. The encryption of document properties is specified in section 2.3.5.4.
  22848. </member>
  22849. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagExternal">
  22850. A value that MUST be 1 if extensible encryption is used. If this value is 1,
  22851. the value of every other field in this structure MUST be 0.
  22852. </member>
  22853. <member name="F:NPOI.POIFS.Crypt.EncryptionInfo.flagAES">
  22854. A value that MUST be 1 if the protected content is an ECMA-376 document
  22855. ECMA-376. If the fAES bit is 1, the fCryptoAPI bit MUST also be 1.
  22856. </member>
  22857. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  22858. Opens for decryption
  22859. </member>
  22860. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  22861. Opens for decryption
  22862. </member>
  22863. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  22864. Opens for decryption
  22865. </member>
  22866. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.DirectoryNode)">
  22867. Opens for decryption
  22868. </member>
  22869. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode)">
  22870. @deprecated Use {@link #EncryptionInfo(EncryptionMode)} (fs parameter no longer required)
  22871. </member>
  22872. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode)">
  22873. @deprecated Use {@link #EncryptionInfo(EncryptionMode)} (fs parameter no longer required)
  22874. </member>
  22875. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Crypt.EncryptionMode)">
  22876. @deprecated Use {@link #EncryptionInfo(EncryptionMode)} (dir parameter no longer required)
  22877. </member>
  22878. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  22879. @deprecated use {@link #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)}
  22880. </member>
  22881. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  22882. @deprecated use {@link #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)}
  22883. </member>
  22884. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  22885. @deprecated use {@link #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)}
  22886. </member>
  22887. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.Crypt.EncryptionMode)">
  22888. Prepares for encryption, using the given Encryption Mode, and
  22889. all other parameters as default.
  22890. @see #EncryptionInfo(EncryptionMode, CipherAlgorithm, HashAlgorithm, int, int, ChainingMode)
  22891. </member>
  22892. <member name="M:NPOI.POIFS.Crypt.EncryptionInfo.#ctor(NPOI.POIFS.Crypt.EncryptionMode,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  22893. Constructs an EncryptionInfo from scratch
  22894. @param encryptionMode see {@link EncryptionMode} for values, {@link EncryptionMode#cryptoAPI} is for
  22895. internal use only, as it's record based
  22896. @param cipherAlgorithm
  22897. @param hashAlgorithm
  22898. @param keyBits
  22899. @param blockSize
  22900. @param chainingMode
  22901. @throws EncryptedDocumentException if the given parameters mismatch, e.g. only certain combinations
  22902. of keyBits, blockSize are allowed for a given {@link CipherAlgorithm}
  22903. </member>
  22904. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.Util.ILittleEndianInput)">
  22905. Initialize the builder from a stream
  22906. </member>
  22907. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  22908. Initialize the builder from scratch
  22909. </member>
  22910. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetHeader">
  22911. @return the header data
  22912. </member>
  22913. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetVerifier">
  22914. @return the verifier data
  22915. </member>
  22916. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetDecryptor">
  22917. @return the decryptor
  22918. </member>
  22919. <member name="M:NPOI.POIFS.Crypt.IEncryptionInfoBuilder.GetEncryptor">
  22920. @return the encryptor
  22921. </member>
  22922. <member name="T:NPOI.POIFS.Crypt.EncryptionMode">
  22923. Office supports various encryption modes.
  22924. The encryption is either based on the whole Container ({@link #agile}, {@link #standard} or {@link #binaryRC4})
  22925. or record based ({@link #cryptoAPI}). The record based encryption can't be accessed directly, but will be
  22926. invoked by using the {@link Biff8EncryptionKey#setCurrentUserPassword(String)} before saving the document.
  22927. </member>
  22928. <member name="T:NPOI.POIFS.Crypt.EncryptionVerifier">
  22929. Used when Checking if a key is valid for a document
  22930. </member>
  22931. <member name="M:NPOI.POIFS.Crypt.EncryptionVerifier.GetVerifier">
  22932. The method name is misleading - you'll Get the encrypted verifier, not the plain verifier
  22933. @deprecated use GetEncryptedVerifier()
  22934. </member>
  22935. <member name="M:NPOI.POIFS.Crypt.EncryptionVerifier.GetVerifierHash">
  22936. The method name is misleading - you'll Get the encrypted verifier hash, not the plain verifier hash
  22937. @deprecated use GetEnryptedVerifierHash
  22938. </member>
  22939. <member name="M:NPOI.POIFS.Crypt.EncryptionVerifier.GetAlgorithmName">
  22940. @deprecated use GetCipherAlgorithm().jceId
  22941. </member>
  22942. <member name="M:NPOI.POIFS.Crypt.Encryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  22943. Return a output stream for encrypted data.
  22944. @param dir the node to write to
  22945. @return encrypted stream
  22946. </member>
  22947. <member name="T:NPOI.POIFS.Crypt.Standard.StandardDecryptor">
  22948. </member>
  22949. <member name="M:NPOI.POIFS.Crypt.Standard.StandardDecryptor.GetLength">
  22950. @return the length of the stream returned by {@link #getDataStream(DirectoryNode)}
  22951. </member>
  22952. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptionHeader.Write(NPOI.Util.LittleEndianByteArrayOutputStream)">
  22953. Serializes the header
  22954. </member>
  22955. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.Util.ILittleEndianInput)">
  22956. Initialize the builder from a stream
  22957. </member>
  22958. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptionInfoBuilder.Initialize(NPOI.POIFS.Crypt.EncryptionInfo,NPOI.POIFS.Crypt.CipherAlgorithm,NPOI.POIFS.Crypt.HashAlgorithm,System.Int32,System.Int32,NPOI.POIFS.Crypt.ChainingMode)">
  22959. Initialize the builder from scratch
  22960. </member>
  22961. <member name="T:NPOI.POIFS.Crypt.Standard.StandardEncryptionVerifier">
  22962. Used when Checking if a key is valid for a document
  22963. </member>
  22964. <member name="M:NPOI.POIFS.Crypt.Standard.StandardEncryptor.ConfirmPassword(System.String,System.Byte[],System.Byte[],System.Byte[],System.Byte[],System.Byte[])">
  22965. Fills the fields of verifier and header with the calculated hashes based
  22966. on the password and a random salt
  22967. see [MS-OFFCRYPTO] - 2.3.4.7 ECMA-376 Document Encryption Key Generation
  22968. </member>
  22969. <member name="T:NPOI.POIFS.FileSystem.DocumentFactoryHelper">
  22970. <summary>
  22971. A small base class for the various factories, e.g. WorkbookFactory, SlideShowFactory to combine common code here.
  22972. </summary>
  22973. </member>
  22974. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.GetDecryptedStream(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.String)">
  22975. <summary>
  22976. Wrap the OLE2 data in the NPOIFSFileSystem into a decrypted stream by using the given password.
  22977. </summary>
  22978. <param name="fs">The OLE2 stream for the document</param>
  22979. <param name="password">The password, null if the default password should be used</param>
  22980. <returns>A stream for reading the decrypted data</returns>
  22981. <exception cref="T:System.IO.IOException">If an error occurs while decrypting or if the password does not match</exception>
  22982. </member>
  22983. <member name="M:NPOI.POIFS.FileSystem.DocumentFactoryHelper.HasOOXMLHeader(System.IO.Stream)">
  22984. <summary>
  22985. Checks that the supplied InputStream (which MUST support mark and reset, or be a PushbackInputStream) has a OOXML (zip) header at the start of it.
  22986. If your InputStream does not support mark / reset, then wrap it in a PushBackInputStream, then be sure to always use that, and not the original!
  22987. </summary>
  22988. <param name="inp">An InputStream which supports either mark/reset, or is a PushbackInputStream</param>
  22989. <returns></returns>
  22990. </member>
  22991. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  22992. Copies an Entry into a target POIFS directory, recursively
  22993. </member>
  22994. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  22995. Copies all the nodes from one POIFS Directory to another
  22996. @param sourceRoot
  22997. is the source Directory to copy from
  22998. @param targetRoot
  22999. is the target Directory to copy to
  23000. </member>
  23001. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.FilteringDirectoryNode,NPOI.POIFS.FileSystem.FilteringDirectoryNode)">
  23002. Copies nodes from one Directory to the other minus the excepts
  23003. @param filteredSource The filtering source Directory to copy from
  23004. @param filteredTarget The filtering target Directory to copy to
  23005. </member>
  23006. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  23007. Copies nodes from one Directory to the other minus the excepts
  23008. @param sourceRoot
  23009. is the source Directory to copy from
  23010. @param targetRoot
  23011. is the target Directory to copy to
  23012. @param excepts
  23013. is a list of Strings specifying what nodes NOT to copy
  23014. @deprecated use {@link FilteringDirectoryNode} instead
  23015. </member>
  23016. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  23017. Copies all nodes from one POIFS to the other
  23018. @param source
  23019. is the source POIFS to copy from
  23020. @param target
  23021. is the target POIFS to copy to
  23022. </member>
  23023. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  23024. Copies all nodes from one POIFS to the other
  23025. @param source
  23026. is the source POIFS to copy from
  23027. @param target
  23028. is the target POIFS to copy to
  23029. </member>
  23030. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.OPOIFSFileSystem,System.Collections.Generic.List{System.String})">
  23031. Copies nodes from one POIFS to the other, minus the excepts.
  23032. This delegates the filtering work to {@link FilteringDirectoryNode},
  23033. so excepts can be of the form "NodeToExclude" or
  23034. "FilteringDirectory/ExcludedChildNode"
  23035. @param source is the source POIFS to copy from
  23036. @param target is the target POIFS to copy to
  23037. @param excepts is a list of Entry Names to be excluded from the copy
  23038. </member>
  23039. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.Collections.Generic.List{System.String})">
  23040. Copies nodes from one POIFS to the other, minus the excepts.
  23041. This delegates the filtering work to {@link FilteringDirectoryNode},
  23042. so excepts can be of the form "NodeToExclude" or
  23043. "FilteringDirectory/ExcludedChildNode"
  23044. @param source is the source POIFS to copy from
  23045. @param target is the target POIFS to copy to
  23046. @param excepts is a list of Entry Names to be excluded from the copy
  23047. </member>
  23048. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDirectoriesIdentical(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  23049. Checks to see if the two Directories hold the same contents.
  23050. For this to be true, they must have entries with the same names,
  23051. no entries in one but not the other, and the size+contents
  23052. of each entry must match, and they must share names.
  23053. To exclude certain parts of the Directory from being checked,
  23054. use a {@link FilteringDirectoryNode}
  23055. </member>
  23056. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDocumentsIdentical(NPOI.POIFS.FileSystem.DocumentEntry,NPOI.POIFS.FileSystem.DocumentEntry)">
  23057. Checks to see if two Documents have the same name
  23058. and the same contents. (Their parent directories are
  23059. not checked)
  23060. </member>
  23061. <member name="T:NPOI.POIFS.FileSystem.FilteringDirectoryNode">
  23062. <summary>
  23063. A DirectoryEntry filter, which exposes another DirectoryEntry less certain parts.
  23064. This is typically used when copying or comparing Filesystems.
  23065. </summary>
  23066. </member>
  23067. <member name="M:NPOI.POIFS.FileSystem.FilteringDirectoryNode.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.ICollection{System.String})">
  23068. <summary>
  23069. Creates a filter round the specified directory, which will exclude entries such as
  23070. "MyNode" and "MyDir/IgnoreNode". The excludes can stretch into children, if they contain a /.
  23071. </summary>
  23072. <param name="directory">The Directory to filter</param>
  23073. <param name="excludes">The Entries to exclude</param>
  23074. </member>
  23075. <member name="T:NPOI.POIFS.FileSystem.NDocumentOutputStream">
  23076. This class provides methods to write a DocumentEntry managed by a
  23077. {@link NPOIFSFileSystem} instance.
  23078. </member>
  23079. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document_size">
  23080. the Document's size
  23081. </member>
  23082. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._closed">
  23083. have we been closed?
  23084. </member>
  23085. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document">
  23086. the actual Document
  23087. </member>
  23088. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._property">
  23089. and its Property
  23090. </member>
  23091. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._buffer">
  23092. our buffer, when null we're into normal blocks
  23093. </member>
  23094. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._stream">
  23095. our main block stream, when we're into normal blocks
  23096. </member>
  23097. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  23098. Create an OutputStream from the specified DocumentEntry.
  23099. The specified entry will be emptied.
  23100. @param document the DocumentEntry to be written
  23101. </member>
  23102. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  23103. Create an OutputStream to create the specified new Entry
  23104. @param parent Where to create the Entry
  23105. @param name Name of the new entry
  23106. </member>
  23107. <member name="T:NPOI.POIFS.FileSystem.NotOLE2FileException">
  23108. This exception is thrown when we try to open a file that doesn't
  23109. seem to actually be an OLE2 file After all
  23110. </member>
  23111. <member name="T:NPOI.POIFS.FileSystem.OPOIFSFileSystem">
  23112. <summary>
  23113. This is the main class of the POIFS system; it manages the entire
  23114. life cycle of the filesystem.
  23115. @author Marc Johnson (mjohnson at apache dot org)
  23116. </summary>
  23117. </member>
  23118. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  23119. <summary>
  23120. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  23121. </summary>
  23122. <param name="stream">The stream.</param>
  23123. <example>
  23124. A convenience method (
  23125. CreateNonClosingInputStream()) has been provided for this purpose:
  23126. StreamwrappedStream = OPOIFSFileSystem.CreateNonClosingInputStream(is);
  23127. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  23128. is.reset();
  23129. doSomethingElse(is);
  23130. </example>
  23131. <returns></returns>
  23132. </member>
  23133. <member name="F:NPOI.POIFS.FileSystem.OPOIFSFileSystem.bigBlockSize">
  23134. What big block size the file uses. Most files
  23135. use 512 bytes, but a few use 4096
  23136. </member>
  23137. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.#ctor">
  23138. <summary>
  23139. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.OPOIFSFileSystem"/> class. intended for writing
  23140. </summary>
  23141. </member>
  23142. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.#ctor(System.IO.Stream)">
  23143. <summary>
  23144. Create a OPOIFSFileSystem from an Stream. Normally the stream is Read until
  23145. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  23146. needs to use it after this constructor completes, a work around is to wrap the
  23147. stream in order to trap the Close() call.
  23148. </summary>
  23149. <param name="stream">the Streamfrom which to Read the data</param>
  23150. </member>
  23151. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  23152. @param stream the stream to be Closed
  23153. @param success <c>false</c> if an exception is currently being thrown in the calling method
  23154. </member>
  23155. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.HasPOIFSHeader(NPOI.Util.InputStream)">
  23156. <summary>
  23157. Checks that the supplied Stream(which MUST
  23158. support mark and reset, or be a PushbackInputStream)
  23159. has a POIFS (OLE2) header at the start of it.
  23160. If your Streamdoes not support mark / reset,
  23161. then wrap it in a PushBackInputStream, then be
  23162. sure to always use that, and not the original!
  23163. </summary>
  23164. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  23165. <returns>
  23166. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  23167. </returns>
  23168. </member>
  23169. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  23170. Checks if the supplied first 8 bytes of a stream / file
  23171. has a POIFS (OLE2) header.
  23172. </member>
  23173. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  23174. <summary>
  23175. Create a new document to be Added to the root directory
  23176. </summary>
  23177. <param name="stream"> the Streamfrom which the document's data will be obtained</param>
  23178. <param name="name">the name of the new POIFSDocument</param>
  23179. <returns>the new DocumentEntry</returns>
  23180. </member>
  23181. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  23182. <summary>
  23183. Create a new DocumentEntry in the root entry; the data will be
  23184. provided later
  23185. </summary>
  23186. <param name="name">the name of the new DocumentEntry</param>
  23187. <param name="size">the size of the new DocumentEntry</param>
  23188. <param name="writer">the Writer of the new DocumentEntry</param>
  23189. <returns>the new DocumentEntry</returns>
  23190. </member>
  23191. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDirectory(System.String)">
  23192. <summary>
  23193. Create a new DirectoryEntry in the root directory
  23194. </summary>
  23195. <param name="name">the name of the new DirectoryEntry</param>
  23196. <returns>the new DirectoryEntry</returns>
  23197. </member>
  23198. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  23199. open a document in the root entry's list of entries
  23200. @param documentName the name of the document to be opened
  23201. @return a newly opened DocumentInputStream
  23202. @exception IOException if the document does not exist or the
  23203. name is that of a DirectoryEntry
  23204. </member>
  23205. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  23206. <summary>
  23207. Writes the file system.
  23208. </summary>
  23209. <param name="stream">the OutputStream to which the filesystem will be
  23210. written</param>
  23211. </member>
  23212. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.Root">
  23213. <summary>
  23214. Get the root entry
  23215. </summary>
  23216. <value>The root.</value>
  23217. </member>
  23218. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  23219. <summary>
  23220. Add a new POIFSDocument
  23221. </summary>
  23222. <param name="document">the POIFSDocument being Added</param>
  23223. </member>
  23224. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  23225. <summary>
  23226. Add a new DirectoryProperty
  23227. </summary>
  23228. <param name="directory">The directory.</param>
  23229. </member>
  23230. <member name="M:NPOI.POIFS.FileSystem.OPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  23231. <summary>
  23232. Removes the specified entry.
  23233. </summary>
  23234. <param name="entry">The entry.</param>
  23235. </member>
  23236. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ViewableArray">
  23237. <summary>
  23238. Get an array of objects, some of which may implement
  23239. POIFSViewable
  23240. </summary>
  23241. <value>an array of Object; may not be null, but may be empty</value>
  23242. </member>
  23243. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ViewableIterator">
  23244. <summary>
  23245. Get an Iterator of objects, some of which may implement
  23246. POIFSViewable
  23247. </summary>
  23248. <value>an Iterator; may not be null, but may have an empty
  23249. back end store</value>
  23250. </member>
  23251. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.PreferArray">
  23252. <summary>
  23253. Give viewers a hint as to whether to call GetViewableArray or
  23254. GetViewableIterator
  23255. </summary>
  23256. <value><c>true</c> if a viewer should call GetViewableArray, <c>false</c> if
  23257. a viewer should call GetViewableIterator </value>
  23258. </member>
  23259. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.ShortDescription">
  23260. <summary>
  23261. Provides a short description of the object, to be used when a
  23262. POIFSViewable object has not provided its contents.
  23263. </summary>
  23264. <value>The short description.</value>
  23265. </member>
  23266. <member name="P:NPOI.POIFS.FileSystem.OPOIFSFileSystem.BigBlockSize">
  23267. <summary>
  23268. Gets The Big Block size, normally 512 bytes, sometimes 4096 bytes
  23269. </summary>
  23270. <value>The size of the big block.</value>
  23271. </member>
  23272. <member name="T:NPOI.POIFS.FileSystem.BlockStore">
  23273. <summary>
  23274. This abstract class describes a way to read, store, chain
  23275. and free a series of blocks (be they Big or Small ones)
  23276. </summary>
  23277. </member>
  23278. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockStoreBlockSize">
  23279. <summary>
  23280. Returns the size of the blocks managed through the block store.
  23281. </summary>
  23282. <returns></returns>
  23283. </member>
  23284. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockAt(System.Int32)">
  23285. <summary>
  23286. Load the block at the given offset.
  23287. </summary>
  23288. <param name="offset"></param>
  23289. <returns></returns>
  23290. </member>
  23291. <member name="M:NPOI.POIFS.FileSystem.BlockStore.CreateBlockIfNeeded(System.Int32)">
  23292. <summary>
  23293. Extends the file if required to hold blocks up to
  23294. the specified offset, and return the block from there.
  23295. </summary>
  23296. <param name="offset"></param>
  23297. <returns></returns>
  23298. </member>
  23299. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBATBlockAndIndex(System.Int32)">
  23300. <summary>
  23301. Returns the BATBlock that handles the specified offset,
  23302. and the relative index within it
  23303. </summary>
  23304. <param name="offset"></param>
  23305. <returns></returns>
  23306. </member>
  23307. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetNextBlock(System.Int32)">
  23308. <summary>
  23309. Works out what block follows the specified one.
  23310. </summary>
  23311. <param name="offset"></param>
  23312. <returns></returns>
  23313. </member>
  23314. <member name="M:NPOI.POIFS.FileSystem.BlockStore.SetNextBlock(System.Int32,System.Int32)">
  23315. <summary>
  23316. Changes the record of what block follows the specified one.
  23317. </summary>
  23318. <param name="offset"></param>
  23319. <param name="nextBlock"></param>
  23320. </member>
  23321. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetFreeBlock">
  23322. <summary>
  23323. Finds a free block, and returns its offset.
  23324. This method will extend the file/stream if needed, and if doing
  23325. so, allocate new FAT blocks to address the extra space.
  23326. </summary>
  23327. <returns></returns>
  23328. </member>
  23329. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetChainLoopDetector">
  23330. <summary>
  23331. Creates a Detector for loops in the chain
  23332. </summary>
  23333. <returns></returns>
  23334. </member>
  23335. <member name="T:NPOI.POIFS.FileSystem.ChainLoopDetector">
  23336. <summary>
  23337. Used to detect if a chain has a loop in it, so
  23338. we can bail out with an error rather than
  23339. spinning away for ever...
  23340. </summary>
  23341. </member>
  23342. <member name="T:NPOI.POIFS.FileSystem.DocumentInputStream">
  23343. This class provides methods to read a DocumentEntry managed by a
  23344. {@link POIFSFileSystem} or {@link NPOIFSFileSystem} instance.
  23345. It Creates the appropriate one, and delegates, allowing us to
  23346. work transparently with the two.
  23347. </member>
  23348. <member name="F:NPOI.POIFS.FileSystem.DocumentInputStream.EOF">
  23349. returned by read operations if we're at end of document
  23350. </member>
  23351. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor">
  23352. For use by downstream implementations
  23353. </member>
  23354. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  23355. Create an InputStream from the specified DocumentEntry
  23356. @param document the DocumentEntry to be read
  23357. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  23358. been deleted?)
  23359. </member>
  23360. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  23361. Create an InputStream from the specified Document
  23362. @param document the Document to be read
  23363. </member>
  23364. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  23365. Create an InputStream from the specified Document
  23366. @param document the Document to be read
  23367. </member>
  23368. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.MarkSupported">
  23369. Tests if this input stream supports the mark and reset methods.
  23370. @return <code>true</code> always
  23371. </member>
  23372. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.Reset">
  23373. Repositions this stream to the position at the time the mark() method was
  23374. last called on this input stream. If mark() has not been called this
  23375. method repositions the stream to its beginning.
  23376. </member>
  23377. <member name="T:NPOI.POIFS.FileSystem.DocumentOutputStream">
  23378. This class provides a wrapper over an OutputStream so that Document
  23379. Writers can't accidently go over their size limits
  23380. @author Marc Johnson (mjohnson at apache dot org)
  23381. </member>
  23382. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.#ctor(System.IO.Stream,System.Int32)">
  23383. Create a DocumentOutputStream
  23384. @param stream the OutputStream to which the data is actually
  23385. read
  23386. @param limit the maximum number of bytes that can be written
  23387. </member>
  23388. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Int32)">
  23389. Writes the specified byte to this output stream. The general
  23390. contract for write is that one byte is written to the output
  23391. stream. The byte to be written is the eight low-order bits of
  23392. the argument b. The 24 high-order bits of b are ignored.
  23393. @param b the byte.
  23394. @exception IOException if an I/O error occurs. In particular,
  23395. an IOException may be thrown if the
  23396. output stream has been closed, or if the
  23397. Writer tries to write too much data.
  23398. </member>
  23399. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[])">
  23400. Writes b.Length bytes from the specified byte array
  23401. to this output stream.
  23402. @param b the data.
  23403. @exception IOException if an I/O error occurs.
  23404. </member>
  23405. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  23406. <summary>
  23407. Writes len bytes from the specified byte array starting at
  23408. offset off to this output stream. The general contract for
  23409. Write(b, off, len) is that some of the bytes in the array b are
  23410. written to the output stream in order; element b[off] is the
  23411. first byte written and b[off+len-1] is the last byte written by
  23412. this operation.
  23413. </summary>
  23414. <param name="b">the data.</param>
  23415. <param name="off">the start offset in the data.</param>
  23416. <param name="len">the number of bytes to Write.</param>
  23417. </member>
  23418. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Flush">
  23419. <summary>
  23420. Flushes this output stream and forces any buffered output bytes to be written out
  23421. </summary>
  23422. </member>
  23423. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Close">
  23424. Closes this output stream and releases any system resources
  23425. associated with this stream. The general contract of close is
  23426. that it closes the output stream. A closed stream cannot
  23427. perform output operations and cannot be reopened.
  23428. @exception IOException if an I/O error occurs.
  23429. </member>
  23430. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.WriteFiller(System.Int32,System.Byte)">
  23431. write the rest of the document's data (fill in at the end)
  23432. @param totalLimit the actual number of bytes the corresponding
  23433. document must fill
  23434. @param fill the byte to fill remaining space with
  23435. @exception IOException on I/O error
  23436. </member>
  23437. <member name="T:NPOI.POIFS.FileSystem.NDocumentInputStream">
  23438. This class provides methods to read a DocumentEntry managed by a
  23439. {@link NPOIFSFileSystem} instance.
  23440. </member>
  23441. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_offset">
  23442. current offset into the Document
  23443. </member>
  23444. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_block_count">
  23445. current block count
  23446. </member>
  23447. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset">
  23448. current marked offset into the Document (used by mark and Reset)
  23449. </member>
  23450. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset_count">
  23451. and the block count for it
  23452. </member>
  23453. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document_size">
  23454. the Document's size
  23455. </member>
  23456. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._closed">
  23457. have we been closed?
  23458. </member>
  23459. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document">
  23460. the actual Document
  23461. </member>
  23462. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  23463. Create an InputStream from the specified DocumentEntry
  23464. @param document the DocumentEntry to be read
  23465. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  23466. been deleted?)
  23467. </member>
  23468. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  23469. Create an InputStream from the specified Document
  23470. @param document the Document to be read
  23471. </member>
  23472. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.Reset">
  23473. Repositions this stream to the position at the time the mark() method was
  23474. last called on this input stream. If mark() has not been called this
  23475. method repositions the stream to its beginning.
  23476. </member>
  23477. <member name="T:NPOI.POIFS.FileSystem.NPOIFSDocument">
  23478. This class manages a document in the NIO POIFS filesystem.
  23479. This is the {@link NPOIFSFileSystem} version.
  23480. </member>
  23481. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.FileSystem.DocumentNode)">
  23482. Constructor for an existing Document
  23483. </member>
  23484. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  23485. Constructor for an existing Document
  23486. </member>
  23487. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(System.String,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.IO.Stream)">
  23488. Constructor for a new Document
  23489. @param name the name of the POIFSDocument
  23490. @param stream the InputStream we read data from
  23491. </member>
  23492. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.Free">
  23493. Frees the underlying stream and property
  23494. </member>
  23495. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.Size">
  23496. @return size of the document
  23497. </member>
  23498. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.DocumentProperty">
  23499. @return the instance's DocumentProperty
  23500. </member>
  23501. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableArray">
  23502. Get an array of objects, some of which may implement POIFSViewable
  23503. @return an array of Object; may not be null, but may be empty
  23504. </member>
  23505. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableIterator">
  23506. Get an Iterator of objects, some of which may implement POIFSViewable
  23507. @return an Iterator; may not be null, but may have an empty back end
  23508. store
  23509. </member>
  23510. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetShortDescription">
  23511. Provides a short description of the object, to be used when a
  23512. POIFSViewable object has not provided its contents.
  23513. @return short description
  23514. </member>
  23515. <member name="T:NPOI.POIFS.FileSystem.NPOIFSFileSystem">
  23516. This is the main class of the POIFS system; it manages the entire
  23517. life cycle of the filesystem.
  23518. This is the new NIO version
  23519. </member>
  23520. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  23521. Convenience method for clients that want to avoid the auto-close behaviour of the constructor.
  23522. </member>
  23523. <member name="F:NPOI.POIFS.FileSystem.NPOIFSFileSystem.bigBlockSize">
  23524. What big block size the file uses. Most files
  23525. use 512 bytes, but a few use 4096
  23526. </member>
  23527. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor">
  23528. Constructor, intended for writing
  23529. </member>
  23530. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo)">
  23531. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  23532. creating from an <tt>InputStream</tt>. The File will be opened read-only</p>
  23533. <p>Note that with this constructor, you will need to call {@link #close()}
  23534. when you're done to have the underlying file closed, as the file is
  23535. kept open during normal operation to read the data out.</p>
  23536. @param file the File from which to read the data
  23537. @exception IOException on errors reading, or on invalid data
  23538. </member>
  23539. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  23540. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  23541. creating from an <tt>InputStream</tt>.</p>
  23542. <p>Note that with this constructor, you will need to call {@link #close()}
  23543. when you're done to have the underlying file closed, as the file is
  23544. kept open during normal operation to read the data out.</p>
  23545. @param file the File from which to read or read/write the data
  23546. @param readOnly whether the POIFileSystem will only be used in read-only mode
  23547. @exception IOException on errors reading, or on invalid data
  23548. </member>
  23549. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream)">
  23550. * <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  23551. * less memory than creating from an <tt>InputStream</tt>. The stream will
  23552. * be used in read-only mode.</p>
  23553. *
  23554. * <p>Note that with this constructor, you will need to call {@link #close()}
  23555. * when you're done to have the underlying Channel closed, as the channel is
  23556. * kept open during normal operation to read the data out.</p>
  23557. *
  23558. * @param channel the FileChannel from which to read the data
  23559. *
  23560. * @exception IOException on errors reading, or on invalid data
  23561. </member>
  23562. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream,System.Boolean)">
  23563. <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  23564. less memory than creating from an <tt>InputStream</tt>.</p>
  23565. <p>Note that with this constructor, you will need to call {@link #close()}
  23566. when you're done to have the underlying Channel closed, as the channel is
  23567. kept open during normal operation to read the data out.</p>
  23568. @param channel the FileChannel from which to read or read/write the data
  23569. @param readOnly whether the POIFileSystem will only be used in read-only mode
  23570. @exception IOException on errors reading, or on invalid data
  23571. </member>
  23572. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.Stream)">
  23573. Create a POIFSFileSystem from an <tt>InputStream</tt>. Normally the stream is read until
  23574. EOF. The stream is always closed.<p/>
  23575. Some streams are usable After reaching EOF (typically those that return <code>true</code>
  23576. for <tt>markSupported()</tt>). In the unlikely case that the caller has such a stream
  23577. <i>and</i> needs to use it After this constructor completes, a work around is to wrap the
  23578. stream in order to trap the <tt>close()</tt> call. A convenience method (
  23579. <tt>CreateNonClosingInputStream()</tt>) has been provided for this purpose:
  23580. <pre>
  23581. InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  23582. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  23583. is.Reset();
  23584. doSomethingElse(is);
  23585. </pre>
  23586. Note also the special case of <tt>MemoryStream</tt> for which the <tt>close()</tt>
  23587. method does nothing.
  23588. <pre>
  23589. MemoryStream bais = ...
  23590. HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() !
  23591. bais.Reset(); // no problem
  23592. doSomethingElse(bais);
  23593. </pre>
  23594. @param stream the InputStream from which to read the data
  23595. @exception IOException on errors Reading, or on invalid data
  23596. </member>
  23597. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  23598. @param stream the stream to be closed
  23599. @param success <code>false</code> if an exception is currently being thrown in the calling method
  23600. </member>
  23601. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  23602. Checks that the supplied InputStream (which MUST
  23603. support mark and reset, or be a PushbackInputStream)
  23604. has a POIFS (OLE2) header at the start of it.
  23605. If your InputStream does not support mark / reset,
  23606. then wrap it in a PushBackInputStream, then be
  23607. sure to always use that, and not the original!
  23608. @param inp An InputStream which supports either mark/reset, or is a PushbackInputStream
  23609. </member>
  23610. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  23611. Checks if the supplied first 8 bytes of a stream / file
  23612. has a POIFS (OLE2) header.
  23613. </member>
  23614. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.ReadCoreContents">
  23615. Read and process the PropertiesTable and the
  23616. FAT / XFAT blocks, so that we're Ready to
  23617. work with the file
  23618. </member>
  23619. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBlockAt(System.Int32)">
  23620. Load the block at the given offset.
  23621. </member>
  23622. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateBlockIfNeeded(System.Int32)">
  23623. Load the block at the given offset,
  23624. extending the file if needed
  23625. </member>
  23626. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBATBlockAndIndex(System.Int32)">
  23627. Returns the BATBlock that handles the specified offset,
  23628. and the relative index within it
  23629. </member>
  23630. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetNextBlock(System.Int32)">
  23631. Works out what block follows the specified one.
  23632. </member>
  23633. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.SetNextBlock(System.Int32,System.Int32)">
  23634. Changes the record of what block follows the specified one.
  23635. </member>
  23636. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetFreeBlock">
  23637. Finds a free block, and returns its offset.
  23638. This method will extend the file if needed, and if doing
  23639. so, allocate new FAT blocks to Address the extra space.
  23640. </member>
  23641. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.PropertyTable">
  23642. For unit Testing only! Returns the underlying
  23643. properties table
  23644. </member>
  23645. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetMiniStore">
  23646. Returns the MiniStore, which performs a similar low
  23647. level function to this, except for the small blocks.
  23648. </member>
  23649. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  23650. add a new POIFSDocument to the FileSytem
  23651. @param document the POIFSDocument being Added
  23652. </member>
  23653. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  23654. add a new DirectoryProperty to the FileSystem
  23655. @param directory the DirectoryProperty being Added
  23656. </member>
  23657. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  23658. Create a new document to be Added to the root directory
  23659. @param stream the InputStream from which the document's data
  23660. will be obtained
  23661. @param name the name of the new POIFSDocument
  23662. @return the new DocumentEntry
  23663. @exception IOException on error creating the new POIFSDocument
  23664. </member>
  23665. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  23666. create a new DocumentEntry in the root entry; the data will be
  23667. provided later
  23668. @param name the name of the new DocumentEntry
  23669. @param size the size of the new DocumentEntry
  23670. @param Writer the Writer of the new DocumentEntry
  23671. @return the new DocumentEntry
  23672. @exception IOException
  23673. </member>
  23674. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDirectory(System.String)">
  23675. create a new DirectoryEntry in the root directory
  23676. @param name the name of the new DirectoryEntry
  23677. @return the new DirectoryEntry
  23678. @exception IOException on name duplication
  23679. </member>
  23680. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateOrUpdateDocument(System.IO.Stream,System.String)">
  23681. Set the contents of a document in1 the root directory,
  23682. creating if needed, otherwise updating
  23683. @param stream the InputStream from which the document's data
  23684. will be obtained
  23685. @param name the name of the new or existing POIFSDocument
  23686. @return the new or updated DocumentEntry
  23687. @exception IOException on error populating the POIFSDocument
  23688. </member>
  23689. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.IsInPlaceWriteable">
  23690. Does the filesystem support an in-place write via
  23691. {@link #writeFilesystem()} ? If false, only writing out to
  23692. a brand new file via {@link #writeFilesystem(OutputStream)}
  23693. is supported.
  23694. </member>
  23695. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem">
  23696. Write the filesystem out to the open file. Will thrown an
  23697. {@link ArgumentException} if opened from an
  23698. {@link InputStream}.
  23699. @exception IOException thrown on errors writing to the stream
  23700. </member>
  23701. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  23702. Write the filesystem out
  23703. @param stream the OutputStream to which the filesystem will be
  23704. written
  23705. @exception IOException thrown on errors writing to the stream
  23706. </member>
  23707. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.syncWithDataSource">
  23708. Has our in-memory objects write their state
  23709. to their backing blocks
  23710. </member>
  23711. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Close">
  23712. Closes the FileSystem, freeing any underlying files, streams
  23713. and buffers. After this, you will be unable to read or
  23714. write from the FileSystem.
  23715. </member>
  23716. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Root">
  23717. Get the root entry
  23718. @return the root entry
  23719. </member>
  23720. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  23721. open a document in the root entry's list of entries
  23722. @param documentName the name of the document to be opened
  23723. @return a newly opened DocumentInputStream
  23724. @exception IOException if the document does not exist or the
  23725. name is that of a DirectoryEntry
  23726. </member>
  23727. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  23728. remove an entry
  23729. @param entry to be Removed
  23730. </member>
  23731. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableArray">
  23732. Get an array of objects, some of which may implement
  23733. POIFSViewable
  23734. @return an array of Object; may not be null, but may be empty
  23735. </member>
  23736. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableIterator">
  23737. Get an Iterator of objects, some of which may implement
  23738. POIFSViewable
  23739. @return an Iterator; may not be null, but may have an empty
  23740. back end store
  23741. </member>
  23742. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetShortDescription">
  23743. Provides a short description of the object, to be used when a
  23744. POIFSViewable object has not provided its contents.
  23745. @return short description
  23746. </member>
  23747. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSize">
  23748. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  23749. </member>
  23750. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSizeDetails">
  23751. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  23752. </member>
  23753. <member name="T:NPOI.POIFS.FileSystem.NPOIFSMiniStore">
  23754. This class handles the MiniStream (small block store)
  23755. in the NIO case for {@link NPOIFSFileSystem}
  23756. </member>
  23757. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBlockAt(System.Int32)">
  23758. Load the block at the given offset.
  23759. </member>
  23760. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.CreateBlockIfNeeded(System.Int32)">
  23761. Load the block, extending the underlying stream if needed
  23762. </member>
  23763. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBATBlockAndIndex(System.Int32)">
  23764. Returns the BATBlock that handles the specified offset,
  23765. and the relative index within it
  23766. </member>
  23767. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetNextBlock(System.Int32)">
  23768. Works out what block follows the specified one.
  23769. </member>
  23770. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SetNextBlock(System.Int32,System.Int32)">
  23771. Changes the record of what block follows the specified one.
  23772. </member>
  23773. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetFreeBlock">
  23774. Finds a free block, and returns its offset.
  23775. This method will extend the file if needed, and if doing
  23776. so, allocate new FAT blocks to Address the extra space.
  23777. </member>
  23778. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SyncWithDataSource">
  23779. <summary>
  23780. Writes the SBATs to their backing blocks, and updates
  23781. the mini-stream size in the properties. Stream size is
  23782. based on full blocks used, not the data within the streams
  23783. </summary>
  23784. </member>
  23785. <member name="T:NPOI.POIFS.FileSystem.NPOIFSStream">
  23786. This handles Reading and writing a stream within a
  23787. {@link NPOIFSFileSystem}. It can supply an iterator
  23788. to read blocks, and way to write out to existing and
  23789. new blocks.
  23790. Most users will want a higher level version of this,
  23791. which deals with properties to track which stream
  23792. this is.
  23793. This only works on big block streams, it doesn't
  23794. handle small block ones.
  23795. This uses the new NIO code
  23796. TODO Implement a streaming write method, and append
  23797. </member>
  23798. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore,System.Int32)">
  23799. Constructor for an existing stream. It's up to you
  23800. to know how to Get the start block (eg from a
  23801. {@link HeaderBlock} or a {@link Property})
  23802. </member>
  23803. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore)">
  23804. Constructor for a new stream. A start block won't
  23805. be allocated until you begin writing to it.
  23806. </member>
  23807. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetStartBlock">
  23808. What block does this stream start at?
  23809. Will be {@link POIFSConstants#END_OF_CHAIN} for a
  23810. new stream that hasn't been written to yet.
  23811. </member>
  23812. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetBlockIterator">
  23813. Returns an iterator that'll supply one {@link ByteBuffer}
  23814. per block in the stream.
  23815. </member>
  23816. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.UpdateContents(System.Byte[])">
  23817. Updates the contents of the stream to the new
  23818. Set of bytes.
  23819. Note - if this is property based, you'll still
  23820. need to update the size in the property yourself
  23821. </member>
  23822. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.Free">
  23823. Frees all blocks in the stream
  23824. </member>
  23825. <member name="T:NPOI.POIFS.FileSystem.ODocumentInputStream">
  23826. This class provides methods to read a DocumentEntry managed by a
  23827. {@link POIFSFileSystem} instance.
  23828. @author Marc Johnson (mjohnson at apache dot org)
  23829. </member>
  23830. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._current_offset">
  23831. current offset into the Document
  23832. </member>
  23833. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._marked_offset">
  23834. current marked offset into the Document (used by mark and Reset)
  23835. </member>
  23836. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document_size">
  23837. the Document's size
  23838. </member>
  23839. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._closed">
  23840. have we been closed?
  23841. </member>
  23842. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document">
  23843. the actual Document
  23844. </member>
  23845. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._currentBlock">
  23846. the data block Containing the current stream pointer
  23847. </member>
  23848. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  23849. Create an InputStream from the specified DocumentEntry
  23850. @param document the DocumentEntry to be read
  23851. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  23852. been deleted?)
  23853. </member>
  23854. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  23855. Create an InputStream from the specified Document
  23856. @param document the Document to be read
  23857. </member>
  23858. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.Reset">
  23859. Repositions this stream to the position at the time the mark() method was
  23860. last called on this input stream. If mark() has not been called this
  23861. method repositions the stream to its beginning.
  23862. </member>
  23863. <member name="T:NPOI.POIFS.FileSystem.OPOIFSDocument">
  23864. <summary>
  23865. This class manages a document in the POIFS filesystem.
  23866. @author Marc Johnson (mjohnson at apache dot org)
  23867. </summary>
  23868. </member>
  23869. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.#ctor(System.String,System.IO.Stream)">
  23870. <summary>
  23871. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.OPOIFSDocument"/> class.
  23872. </summary>
  23873. <param name="name">the name of the POIFSDocument</param>
  23874. <param name="stream">the InputStream we read data from</param>
  23875. </member>
  23876. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.#ctor(System.String,NPOI.POIFS.Storage.ListManagedBlock[],System.Int32)">
  23877. <summary>
  23878. Constructor from small blocks
  23879. </summary>
  23880. <param name="name">the name of the POIFSDocument</param>
  23881. <param name="blocks">the small blocks making up the POIFSDocument</param>
  23882. <param name="length">the actual length of the POIFSDocument</param>
  23883. </member>
  23884. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.Read(System.Byte[],System.Int32)">
  23885. <summary>
  23886. read data from the internal stores
  23887. </summary>
  23888. <param name="buffer">the buffer to write to</param>
  23889. <param name="offset">the offset into our storage to read from</param>
  23890. </member>
  23891. <member name="M:NPOI.POIFS.FileSystem.OPOIFSDocument.WriteBlocks(System.IO.Stream)">
  23892. <summary>
  23893. Writes the blocks.
  23894. </summary>
  23895. <param name="stream">The stream.</param>
  23896. </member>
  23897. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.CountBlocks">
  23898. <summary>
  23899. Gets the number of BigBlock's this instance uses
  23900. </summary>
  23901. <value>count of BigBlock instances</value>
  23902. </member>
  23903. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.DocumentProperty">
  23904. <summary>
  23905. Gets the document property.
  23906. </summary>
  23907. <value>The document property.</value>
  23908. </member>
  23909. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.PreferArray">
  23910. <summary>
  23911. Provides a short description of the object to be used when a
  23912. POIFSViewable object has not provided its contents.
  23913. </summary>
  23914. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  23915. </member>
  23916. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ShortDescription">
  23917. <summary>
  23918. Gets the short description.
  23919. </summary>
  23920. <value>The short description.</value>
  23921. </member>
  23922. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.Size">
  23923. <summary>
  23924. Gets the size.
  23925. </summary>
  23926. <value>The size.</value>
  23927. </member>
  23928. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.SmallBlocks">
  23929. <summary>
  23930. Gets the small blocks.
  23931. </summary>
  23932. <value>The small blocks.</value>
  23933. </member>
  23934. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.StartBlock">
  23935. <summary>
  23936. Sets the start block for this instance
  23937. </summary>
  23938. <value>
  23939. index into the array of BigBlock instances making up the the filesystem
  23940. </value>
  23941. </member>
  23942. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ViewableArray">
  23943. <summary>
  23944. Get an array of objects, some of which may implement POIFSViewable
  23945. </summary>
  23946. <value>The viewable array.</value>
  23947. </member>
  23948. <member name="P:NPOI.POIFS.FileSystem.OPOIFSDocument.ViewableIterator">
  23949. <summary>
  23950. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  23951. </summary>
  23952. <value>The viewable iterator.</value>
  23953. </member>
  23954. <member name="T:NPOI.POIFS.FileSystem.BATManaged">
  23955. <summary>
  23956. This interface defines behaviors for objects managed by the Block
  23957. Allocation Table (BAT).
  23958. @author Marc Johnson (mjohnson at apache dot org)
  23959. </summary>
  23960. </member>
  23961. <member name="P:NPOI.POIFS.FileSystem.BATManaged.CountBlocks">
  23962. <summary>
  23963. Gets the number of BigBlock's this instance uses
  23964. </summary>
  23965. <value>count of BigBlock instances</value>
  23966. </member>
  23967. <member name="P:NPOI.POIFS.FileSystem.BATManaged.StartBlock">
  23968. <summary>
  23969. Sets the start block for this instance
  23970. </summary>
  23971. <value>index into the array of BigBlock instances making up the the filesystem</value>
  23972. </member>
  23973. <member name="T:NPOI.POIFS.FileSystem.DirectoryEntry">
  23974. <summary>
  23975. This interface defines methods specific to Directory objects
  23976. managed by a Filesystem instance.
  23977. @author Marc Johnson (mjohnson at apache dot org)
  23978. </summary>
  23979. </member>
  23980. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.Entries">
  23981. <summary>
  23982. get an iterator of the Entry instances contained directly in
  23983. this instance (in other words, children only; no grandchildren
  23984. etc.)
  23985. </summary>
  23986. <value>The entries.never null, but hasNext() may return false
  23987. immediately (i.e., this DirectoryEntry is empty). All
  23988. objects retrieved by next() are guaranteed to be
  23989. implementations of Entry.</value>
  23990. </member>
  23991. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryNames">
  23992. <summary>
  23993. get the names of all the Entries contained directly in this
  23994. instance (in other words, names of children only; no grandchildren etc).
  23995. </summary>
  23996. <value>the names of all the entries that may be retrieved with
  23997. getEntry(String), which may be empty (if this DirectoryEntry is empty
  23998. </value>
  23999. </member>
  24000. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.IsEmpty">
  24001. <summary>
  24002. is this DirectoryEntry empty?
  24003. </summary>
  24004. <value><c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.</value>
  24005. </member>
  24006. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryCount">
  24007. <summary>
  24008. find out how many Entry instances are contained directly within
  24009. this DirectoryEntry
  24010. </summary>
  24011. <value>number of immediately (no grandchildren etc.) contained
  24012. Entry instances</value>
  24013. </member>
  24014. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.GetEntry(System.String)">
  24015. <summary>
  24016. get a specified Entry by name
  24017. </summary>
  24018. <param name="name">the name of the Entry to obtain.</param>
  24019. <returns>the specified Entry, if it is directly contained in
  24020. this DirectoryEntry</returns>
  24021. </member>
  24022. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.IO.Stream)">
  24023. <summary>
  24024. Create a new DocumentEntry
  24025. </summary>
  24026. <param name="name">the name of the new DocumentEntry</param>
  24027. <param name="stream">the Stream from which to Create the new DocumentEntry</param>
  24028. <returns>the new DocumentEntry</returns>
  24029. </member>
  24030. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  24031. <summary>
  24032. Create a new DocumentEntry; the data will be provided later
  24033. </summary>
  24034. <param name="name">the name of the new DocumentEntry</param>
  24035. <param name="size">the size of the new DocumentEntry</param>
  24036. <param name="writer">BeforeWriting event handler</param>
  24037. <returns>the new DocumentEntry</returns>
  24038. </member>
  24039. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDirectory(System.String)">
  24040. <summary>
  24041. Create a new DirectoryEntry
  24042. </summary>
  24043. <param name="name">the name of the new DirectoryEntry</param>
  24044. <returns>the name of the new DirectoryEntry</returns>
  24045. </member>
  24046. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.StorageClsid">
  24047. <summary>
  24048. Gets or sets the storage ClassID.
  24049. </summary>
  24050. <value>The storage ClassID.</value>
  24051. </member>
  24052. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.HasEntry(System.String)">
  24053. <summary>
  24054. Checks if entry with specified name present
  24055. </summary>
  24056. <param name="name">entry name</param>
  24057. <returns>true if have</returns>
  24058. </member>
  24059. <member name="T:NPOI.POIFS.FileSystem.DirectoryNode">
  24060. <summary>
  24061. Simple implementation of DirectoryEntry
  24062. @author Marc Johnson (mjohnson at apache dot org)
  24063. </summary>
  24064. </member>
  24065. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.OPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  24066. <summary>
  24067. Create a DirectoryNode. This method Is not public by design; it
  24068. Is intended strictly for the internal use of this package
  24069. </summary>
  24070. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  24071. <param name="fileSystem">the OPOIFSFileSystem we belong to</param>
  24072. <param name="parent">the parent of this entry</param>
  24073. </member>
  24074. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  24075. <summary>
  24076. Create a DirectoryNode. This method Is not public by design; it
  24077. Is intended strictly for the internal use of this package
  24078. </summary>
  24079. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  24080. <param name="nFileSystem">the POIFSFileSystem we belong to</param>
  24081. <param name="parent">the parent of this entry</param>
  24082. </member>
  24083. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreatePOIFSDocumentReader(System.String)">
  24084. <summary>
  24085. open a document in the directory's entry's list of entries
  24086. </summary>
  24087. <param name="documentName">the name of the document to be opened</param>
  24088. <returns>a newly opened DocumentStream</returns>
  24089. </member>
  24090. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDocument(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  24091. <summary>
  24092. Create a new DocumentEntry; the data will be provided later
  24093. </summary>
  24094. <param name="document">the name of the new documentEntry</param>
  24095. <returns>the new DocumentEntry</returns>
  24096. </member>
  24097. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.ChangeName(System.String,System.String)">
  24098. <summary>
  24099. Change a contained Entry's name
  24100. </summary>
  24101. <param name="oldName">the original name</param>
  24102. <param name="newName">the new name</param>
  24103. <returns>true if the operation succeeded, else false</returns>
  24104. </member>
  24105. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.DeleteEntry(NPOI.POIFS.FileSystem.EntryNode)">
  24106. <summary>
  24107. Deletes the entry.
  24108. </summary>
  24109. <param name="entry">the EntryNode to be Deleted</param>
  24110. <returns>true if the entry was Deleted, else false</returns>
  24111. </member>
  24112. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Path">
  24113. <summary>
  24114. Gets the path.
  24115. </summary>
  24116. <value>this directory's path representation</value>
  24117. </member>
  24118. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.FileSystem">
  24119. <summary>
  24120. return the filesystem that this belongs to
  24121. TODO: Temporary workaround during #56791
  24122. </summary>
  24123. </member>
  24124. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.OFileSystem">
  24125. <summary>
  24126. If this is OPOIFS based, return the NPOIFSFileSystem
  24127. that this belong to, otherwise Null if NPOIFS based
  24128. return the filesystem that this belongs to
  24129. </summary>
  24130. </member>
  24131. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.NFileSystem">
  24132. <summary>
  24133. If this is NPOIFS based, return the NPOIFSFileSystem
  24134. that this belong to, otherwise Null if OPOIFS based.
  24135. return the filesystem that this belongs to
  24136. </summary>
  24137. </member>
  24138. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Entries">
  24139. <summary>
  24140. get an iterator of the Entry instances contained directly in
  24141. this instance (in other words, children only; no grandchildren
  24142. etc.)
  24143. </summary>
  24144. <value>
  24145. The entries.never null, but hasNext() may return false
  24146. immediately (i.e., this DirectoryEntry is empty). All
  24147. objects retrieved by next() are guaranteed to be
  24148. implementations of Entry.
  24149. </value>
  24150. </member>
  24151. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryNames">
  24152. get the names of all the Entries contained directly in this
  24153. instance (in other words, names of children only; no grandchildren
  24154. etc).
  24155. @return the names of all the entries that may be retrieved with
  24156. getEntry(String), which may be empty (if this
  24157. DirectoryEntry is empty)
  24158. </member>
  24159. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsEmpty">
  24160. <summary>
  24161. is this DirectoryEntry empty?
  24162. </summary>
  24163. <value>
  24164. <c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.
  24165. </value>
  24166. </member>
  24167. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryCount">
  24168. <summary>
  24169. find out how many Entry instances are contained directly within
  24170. this DirectoryEntry
  24171. </summary>
  24172. <value>
  24173. number of immediately (no grandchildren etc.) contained
  24174. Entry instances
  24175. </value>
  24176. </member>
  24177. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.GetEntry(System.String)">
  24178. <summary>
  24179. get a specified Entry by name
  24180. </summary>
  24181. <param name="name">the name of the Entry to obtain.</param>
  24182. <returns>
  24183. the specified Entry, if it is directly contained in
  24184. this DirectoryEntry
  24185. </returns>
  24186. </member>
  24187. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDirectory(System.String)">
  24188. <summary>
  24189. Create a new DirectoryEntry
  24190. </summary>
  24191. <param name="name">the name of the new DirectoryEntry</param>
  24192. <returns>the name of the new DirectoryEntry</returns>
  24193. </member>
  24194. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateOrUpdateDocument(System.String,System.IO.Stream)">
  24195. Set the contents of a document, creating if needed,
  24196. otherwise updating. Returns the created / updated DocumentEntry
  24197. @param name the name of the new or existing DocumentEntry
  24198. @param stream the InputStream from which to populate the DocumentEntry
  24199. @return the new or updated DocumentEntry
  24200. @exception IOException
  24201. </member>
  24202. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.StorageClsid">
  24203. <summary>
  24204. Gets or Sets the storage clsid for the directory entry
  24205. </summary>
  24206. <value>The storage ClassID.</value>
  24207. </member>
  24208. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDirectoryEntry">
  24209. <summary>
  24210. Is this a DirectoryEntry?
  24211. </summary>
  24212. <value>true if the Entry Is a DirectoryEntry, else false</value>
  24213. </member>
  24214. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDeleteOK">
  24215. <summary>
  24216. extensions use this method to verify internal rules regarding
  24217. deletion of the underlying store.
  24218. </summary>
  24219. <value> true if it's ok to Delete the underlying store, else
  24220. false</value>
  24221. </member>
  24222. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableArray">
  24223. <summary>
  24224. Get an array of objects, some of which may implement POIFSViewable
  24225. </summary>
  24226. <value>an array of Object; may not be null, but may be empty</value>
  24227. </member>
  24228. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableIterator">
  24229. <summary>
  24230. Get an Iterator of objects, some of which may implement
  24231. POIFSViewable
  24232. </summary>
  24233. <value>an Iterator; may not be null, but may have an empty
  24234. back end store</value>
  24235. </member>
  24236. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.PreferArray">
  24237. <summary>
  24238. Give viewers a hint as to whether to call GetViewableArray or
  24239. GetViewableIterator
  24240. </summary>
  24241. <value><c>true</c> if a viewer should call GetViewableArray; otherwise, <c>false</c>if
  24242. a viewer should call GetViewableIterator</value>
  24243. </member>
  24244. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ShortDescription">
  24245. <summary>
  24246. Provides a short description of the object, to be used when a
  24247. POIFSViewable object has not provided its contents.
  24248. </summary>
  24249. <value>The short description.</value>
  24250. </member>
  24251. <member name="T:NPOI.POIFS.FileSystem.DocumentDescriptor">
  24252. <summary>
  24253. Class DocumentDescriptor
  24254. @author Marc Johnson (mjohnson at apache dot org)
  24255. </summary>
  24256. </member>
  24257. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  24258. <summary>
  24259. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentDescriptor"/> class.
  24260. </summary>
  24261. <param name="path">the Document path</param>
  24262. <param name="name">the Document name</param>
  24263. </member>
  24264. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Path">
  24265. <summary>
  24266. Gets the path.
  24267. </summary>
  24268. <value>The path.</value>
  24269. </member>
  24270. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Name">
  24271. <summary>
  24272. Gets the name.
  24273. </summary>
  24274. <value>The name.</value>
  24275. </member>
  24276. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.Equals(System.Object)">
  24277. <summary>
  24278. equality. Two DocumentDescriptor instances are equal if they
  24279. have equal paths and names
  24280. </summary>
  24281. <param name="o">the object we're checking equality for</param>
  24282. <returns>true if the object is equal to this object</returns>
  24283. </member>
  24284. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.GetHashCode">
  24285. <summary>
  24286. Serves as a hash function for a particular type.
  24287. </summary>
  24288. <returns>
  24289. hashcode
  24290. </returns>
  24291. </member>
  24292. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.ToString">
  24293. <summary>
  24294. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24295. </summary>
  24296. <returns>
  24297. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24298. </returns>
  24299. </member>
  24300. <member name="T:NPOI.POIFS.FileSystem.DocumentEntry">
  24301. <summary>
  24302. This interface defines methods specific to Document objects
  24303. managed by a Filesystem instance.
  24304. @author Marc Johnson (mjohnson at apache dot org)
  24305. </summary>
  24306. </member>
  24307. <member name="P:NPOI.POIFS.FileSystem.DocumentEntry.Size">
  24308. <summary>
  24309. get the size of the document, in bytes
  24310. </summary>
  24311. <value>size in bytes</value>
  24312. </member>
  24313. <member name="T:NPOI.POIFS.FileSystem.DocumentNode">
  24314. <summary>
  24315. Simple implementation of DocumentEntry
  24316. @author Marc Johnson (mjohnson at apache dot org)
  24317. </summary>
  24318. </member>
  24319. <member name="M:NPOI.POIFS.FileSystem.DocumentNode.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.DirectoryNode)">
  24320. create a DocumentNode. This method Is not public by design; it
  24321. Is intended strictly for the internal use of this package
  24322. @param property the DocumentProperty for this DocumentEntry
  24323. @param parent the parent of this entry
  24324. </member>
  24325. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Document">
  24326. get the POIFSDocument
  24327. @return the internal POIFSDocument
  24328. </member>
  24329. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Size">
  24330. get the zize of the document, in bytes
  24331. @return size in bytes
  24332. </member>
  24333. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDocumentEntry">
  24334. Is this a DocumentEntry?
  24335. @return true if the Entry Is a DocumentEntry, else false
  24336. </member>
  24337. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDeleteOK">
  24338. extensions use this method to verify internal rules regarding
  24339. deletion of the underlying store.
  24340. @return true if it's ok to delete the underlying store, else
  24341. false
  24342. </member>
  24343. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableArray">
  24344. Get an array of objects, some of which may implement
  24345. POIFSViewable
  24346. @return an array of Object; may not be null, but may be empty
  24347. </member>
  24348. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableIterator">
  24349. Get an Iterator of objects, some of which may implement
  24350. POIFSViewable
  24351. @return an Iterator; may not be null, but may have an empty
  24352. back end store
  24353. </member>
  24354. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.PreferArray">
  24355. Give viewers a hint as to whether to call getViewableArray or
  24356. getViewableIterator
  24357. @return true if a viewer should call getViewableArray, false if
  24358. a viewer should call getViewableIterator
  24359. </member>
  24360. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ShortDescription">
  24361. Provides a short description of the object, to be used when a
  24362. POIFSViewable object has not provided its contents.
  24363. @return short description
  24364. </member>
  24365. <member name="T:NPOI.POIFS.FileSystem.Entry">
  24366. <summary>
  24367. This interface provides access to an object managed by a Filesystem
  24368. instance. Entry objects are further divided into DocumentEntry and
  24369. DirectoryEntry instances.
  24370. @author Marc Johnson (mjohnson at apache dot org)
  24371. </summary>
  24372. </member>
  24373. <member name="P:NPOI.POIFS.FileSystem.Entry.Name">
  24374. <summary>
  24375. Get the name of the Entry
  24376. </summary>
  24377. <value>The name.</value>
  24378. </member>
  24379. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDirectoryEntry">
  24380. <summary>
  24381. Is this a DirectoryEntry?
  24382. </summary>
  24383. <value>
  24384. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  24385. </value>
  24386. </member>
  24387. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDocumentEntry">
  24388. <summary>
  24389. Is this a DocumentEntry?
  24390. </summary>
  24391. <value>
  24392. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  24393. </value>
  24394. </member>
  24395. <member name="P:NPOI.POIFS.FileSystem.Entry.Parent">
  24396. <summary>
  24397. Get this Entry's parent (the DirectoryEntry that owns this
  24398. Entry). All Entry objects, except the root Entry, has a parent.
  24399. </summary>
  24400. <value>this Entry's parent; null iff this Is the root Entry</value>
  24401. This property is moved to EntryNode
  24402. </member>
  24403. <member name="M:NPOI.POIFS.FileSystem.Entry.Delete">
  24404. <summary>
  24405. Delete this Entry. ThIs operation should succeed, but there are
  24406. special circumstances when it will not:
  24407. If this Entry Is the root of the Entry tree, it cannot be
  24408. deleted, as there Is no way to Create another one.
  24409. If this Entry Is a directory, it cannot be deleted unless it Is
  24410. empty.
  24411. </summary>
  24412. <returns>true if the Entry was successfully deleted, else false</returns>
  24413. </member>
  24414. <member name="M:NPOI.POIFS.FileSystem.Entry.RenameTo(System.String)">
  24415. <summary>
  24416. Rename this Entry. ThIs operation will fail if:
  24417. There Is a sibling Entry (i.e., an Entry whose parent Is the
  24418. same as this Entry's parent) with the same name.
  24419. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  24420. by the Filesystem and many not be Changed.
  24421. </summary>
  24422. <param name="newName">the new name for this Entry</param>
  24423. <returns>true if the operation succeeded, else false</returns>
  24424. </member>
  24425. <member name="T:NPOI.POIFS.FileSystem.EntryNode">
  24426. <summary>
  24427. Abstract implementation of Entry
  24428. Extending classes should override isDocument() or isDirectory(), as
  24429. appropriate
  24430. Extending classes must override isDeleteOK()
  24431. @author Marc Johnson (mjohnson at apache dot org)
  24432. </summary>
  24433. </member>
  24434. <member name="M:NPOI.POIFS.FileSystem.EntryNode.#ctor(NPOI.POIFS.Properties.Property,NPOI.POIFS.FileSystem.DirectoryNode)">
  24435. <summary>
  24436. Create a DocumentNode. ThIs method Is not public by design; it
  24437. Is intended strictly for the internal use of extending classes
  24438. </summary>
  24439. <param name="property">the Property for this Entry</param>
  24440. <param name="parent">the parent of this entry</param>
  24441. </member>
  24442. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Property">
  24443. <summary>
  24444. grant access to the property
  24445. </summary>
  24446. <value>the property backing this entry</value>
  24447. </member>
  24448. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsRoot">
  24449. <summary>
  24450. Is this the root of the tree?
  24451. </summary>
  24452. <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  24453. </member>
  24454. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDeleteOK">
  24455. <summary>
  24456. extensions use this method to verify internal rules regarding
  24457. deletion of the underlying store.
  24458. </summary>
  24459. <value>
  24460. <c>true</c> if it's ok to Delete the underlying store; otherwise, <c>false</c>.
  24461. </value>
  24462. </member>
  24463. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Name">
  24464. <summary>
  24465. Get the name of the Entry
  24466. </summary>
  24467. <value>The name.</value>
  24468. Get the name of the Entry
  24469. @return name
  24470. </member>
  24471. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDirectoryEntry">
  24472. <summary>
  24473. Is this a DirectoryEntry?
  24474. </summary>
  24475. <value>
  24476. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  24477. </value>
  24478. </member>
  24479. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDocumentEntry">
  24480. <summary>
  24481. Is this a DocumentEntry?
  24482. </summary>
  24483. <value>
  24484. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  24485. </value>
  24486. </member>
  24487. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Parent">
  24488. <summary>
  24489. Get this Entry's parent (the DocumentEntry that owns this
  24490. Entry). All Entry objects, except the root Entry, has a parent.
  24491. </summary>
  24492. <value>this Entry's parent; null iff this Is the root Entry</value>
  24493. </member>
  24494. <member name="M:NPOI.POIFS.FileSystem.EntryNode.Delete">
  24495. <summary>
  24496. Delete this Entry. ThIs operation should succeed, but there are
  24497. special circumstances when it will not:
  24498. If this Entry Is the root of the Entry tree, it cannot be
  24499. deleted, as there Is no way to Create another one.
  24500. If this Entry Is a directory, it cannot be deleted unless it Is
  24501. empty.
  24502. </summary>
  24503. <returns>
  24504. true if the Entry was successfully deleted, else false
  24505. </returns>
  24506. </member>
  24507. <member name="M:NPOI.POIFS.FileSystem.EntryNode.RenameTo(System.String)">
  24508. <summary>
  24509. Rename this Entry. ThIs operation will fail if:
  24510. There Is a sibling Entry (i.e., an Entry whose parent Is the
  24511. same as this Entry's parent) with the same name.
  24512. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  24513. by the Filesystem and many not be Changed.
  24514. </summary>
  24515. <param name="newName">the new name for this Entry</param>
  24516. <returns>
  24517. true if the operation succeeded, else false
  24518. </returns>
  24519. </member>
  24520. <member name="T:NPOI.POIFS.FileSystem.OfficeXmlFileException">
  24521. <summary>
  24522. This exception is thrown when we try to open a file that's actually
  24523. an Office 2007+ XML file, rather than an OLE2 file (which is what
  24524. POIFS works with)
  24525. </summary>
  24526. </member>
  24527. <member name="T:NPOI.POIFS.FileSystem.Ole10Native">
  24528. Represents an Ole10Native record which is wrapped around certain binary
  24529. files being embedded in OLE2 documents.
  24530. @author Rainer Schwarze
  24531. </member>
  24532. <member name="T:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode">
  24533. the field encoding mode - merely a try-and-error guess ...
  24534. </member>
  24535. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.parsed">
  24536. the data is stored in parsed format - including label, command, etc.
  24537. </member>
  24538. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.unparsed">
  24539. the data is stored raw after the length field
  24540. </member>
  24541. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.compact">
  24542. the data is stored raw after the length field and the flags1 field
  24543. </member>
  24544. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  24545. <summary>
  24546. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  24547. to include a stream &quot;{01}Ole10Native&quot; which Contains the actual
  24548. data relevant for this class.
  24549. </summary>
  24550. <param name="poifs">poifs POI Filesystem object</param>
  24551. <returns>Returns an instance of this class</returns>
  24552. </member>
  24553. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.DirectoryNode)">
  24554. <summary>
  24555. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  24556. to include a stream &quot;{01}Ole10Native&quot; which contains the actual
  24557. data relevant for this class.
  24558. </summary>
  24559. <param name="directory">directory POI Filesystem object</param>
  24560. <returns>Returns an instance of this class</returns>
  24561. </member>
  24562. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.String,System.String,System.String,System.Byte[])">
  24563. Creates an instance and fills the fields based on ... the fields
  24564. </member>
  24565. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32)">
  24566. Creates an instance and Fills the fields based on the data in the given buffer.
  24567. @param data The buffer Containing the Ole10Native record
  24568. @param offset The start offset of the record in the buffer
  24569. @throws Ole10NativeException on invalid or unexcepted data format
  24570. </member>
  24571. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.TotalSize">
  24572. Returns the value of the totalSize field - the total length of the structure
  24573. is totalSize + 4 (value of this field + size of this field).
  24574. @return the totalSize
  24575. </member>
  24576. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags1">
  24577. Returns flags1 - currently unknown - usually 0x0002.
  24578. @return the flags1
  24579. </member>
  24580. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Label">
  24581. Returns the label field - usually the name of the file (without directory) but
  24582. probably may be any name specified during packaging/embedding the data.
  24583. @return the label
  24584. </member>
  24585. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.FileName">
  24586. Returns the fileName field - usually the name of the file being embedded
  24587. including the full path.
  24588. @return the fileName
  24589. </member>
  24590. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags2">
  24591. Returns flags2 - currently unknown - mostly 0x0000.
  24592. @return the flags2
  24593. </member>
  24594. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Unknown1">
  24595. Returns unknown1 field - currently unknown.
  24596. @return the unknown1
  24597. </member>
  24598. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Command">
  24599. Returns the command field - usually the name of the file being embedded
  24600. including the full path, may be a command specified during embedding the file.
  24601. @return the command
  24602. </member>
  24603. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataSize">
  24604. Returns the size of the embedded file. If the size is 0 (zero), no data has been
  24605. embedded. To be sure, that no data has been embedded, check whether
  24606. {@link #getDataBuffer()} returns <code>null</code>.
  24607. @return the dataSize
  24608. </member>
  24609. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataBuffer">
  24610. Returns the buffer Containing the embedded file's data, or <code>null</code>
  24611. if no data was embedded. Note that an embedding may provide information about
  24612. the data, but the actual data is not included. (So label, filename etc. are
  24613. available, but this method returns <code>null</code>.)
  24614. @return the dataBuffer
  24615. </member>
  24616. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags3">
  24617. Returns the flags3 - currently unknown.
  24618. @return the flags3
  24619. </member>
  24620. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.WriteOut(System.IO.Stream)">
  24621. Have the contents printer out into an OutputStream, used when writing a
  24622. file back out to disk (Normally, atom classes will keep their bytes
  24623. around, but non atom classes will just request the bytes from their
  24624. children, then chuck on their header and return)
  24625. </member>
  24626. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentPath">
  24627. <summary>
  24628. Class POIFSDocumentPath
  24629. @author Marc Johnson (mjohnson at apache dot org)
  24630. </summary>
  24631. </member>
  24632. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor">
  24633. <summary>
  24634. simple constructor for the path of a document that is in the
  24635. root of the POIFSFileSystem. The constructor that takes an
  24636. array of Strings can also be used to create such a
  24637. POIFSDocumentPath by passing it a null or empty String array
  24638. </summary>
  24639. </member>
  24640. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(System.String[])">
  24641. <summary>
  24642. constructor for the path of a document that is not in the root
  24643. of the POIFSFileSystem
  24644. </summary>
  24645. <param name="components">the Strings making up the path to a document.
  24646. The Strings must be ordered as they appear in
  24647. the directory hierarchy of the the document
  24648. -- the first string must be the name of a
  24649. directory in the root of the POIFSFileSystem,
  24650. and every Nth (for N &gt; 1) string thereafter
  24651. must be the name of a directory in the
  24652. directory identified by the (N-1)th string.
  24653. If the components parameter is null or has
  24654. zero length, the POIFSDocumentPath is
  24655. appropriate for a document that is in the
  24656. root of a POIFSFileSystem</param>
  24657. </member>
  24658. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String[])">
  24659. <summary>
  24660. constructor that adds additional subdirectories to an existing
  24661. path
  24662. </summary>
  24663. <param name="path">the existing path</param>
  24664. <param name="components">the additional subdirectory names to be added</param>
  24665. </member>
  24666. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.Equals(System.Object)">
  24667. <summary>
  24668. equality. Two POIFSDocumentPath instances are equal if they
  24669. have the same number of component Strings, and if each
  24670. component String is equal to its coresponding component String
  24671. </summary>
  24672. <param name="o">the object we're checking equality for</param>
  24673. <returns>true if the object is equal to this object</returns>
  24674. </member>
  24675. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetComponent(System.Int32)">
  24676. <summary>
  24677. get the specified component
  24678. </summary>
  24679. <param name="n">which component (0 ... length() - 1)</param>
  24680. <returns>the nth component;</returns>
  24681. </member>
  24682. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetHashCode">
  24683. <summary>
  24684. Serves as a hash function for a particular type.
  24685. </summary>
  24686. <returns>
  24687. A hash code for the current <see cref="T:System.Object"/>.
  24688. </returns>
  24689. </member>
  24690. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.ToString">
  24691. <summary>
  24692. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24693. </summary>
  24694. <returns>
  24695. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24696. </returns>
  24697. </member>
  24698. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Length">
  24699. <summary>
  24700. Gets the length.
  24701. </summary>
  24702. <value>the number of components</value>
  24703. </member>
  24704. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Parent">
  24705. <summary>
  24706. Returns the path's parent or <c>null</c> if this path
  24707. is the root path.
  24708. </summary>
  24709. <value>path of parent, or null if this path is the root path</value>
  24710. </member>
  24711. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Name">
  24712. <p>Returns the last name in the document path's name sequence.
  24713. If the document path's name sequence is empty, then the empty string is returned.</p>
  24714. @since 2016-04-09
  24715. @return The last name in the document path's name sequence, or empty string if this is the root path
  24716. </member>
  24717. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentReader">
  24718. <summary>
  24719. This class provides methods to read a DocumentEntry managed by a
  24720. Filesystem instance.
  24721. @author Marc Johnson (mjohnson at apache dot org)
  24722. </summary>
  24723. </member>
  24724. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24725. <summary>
  24726. Create an InputStream from the specified DocumentEntry
  24727. </summary>
  24728. <param name="document">the DocumentEntry to be read</param>
  24729. </member>
  24730. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.OPOIFSDocument)">
  24731. <summary>
  24732. Create an InputStream from the specified Document
  24733. </summary>
  24734. <param name="document">the Document to be read</param>
  24735. </member>
  24736. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.EOD">
  24737. <summary>
  24738. at the end Of document.
  24739. </summary>
  24740. <returns></returns>
  24741. </member>
  24742. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Available">
  24743. <summary>
  24744. Returns the number of bytes that can be read (or skipped over)
  24745. from this input stream without blocking by the next caller of a
  24746. method for this input stream. The next caller might be the same
  24747. thread or or another thread.
  24748. </summary>
  24749. <value>the number of bytes that can be read from this input
  24750. stream without blocking.</value>
  24751. </member>
  24752. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Close">
  24753. <summary>
  24754. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  24755. </summary>
  24756. </member>
  24757. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[])">
  24758. <summary>
  24759. Reads some number of bytes from the input stream and stores
  24760. them into the buffer array b. The number of bytes actually read
  24761. is returned as an integer. The definition of this method in
  24762. java.io.InputStream allows this method to block, but it won't.
  24763. If b is null, a NullPointerException is thrown. If the length
  24764. of b is zero, then no bytes are read and 0 is returned;
  24765. otherwise, there is an attempt to read at least one byte. If no
  24766. byte is available because the stream is at end of file, the
  24767. value -1 is returned; otherwise, at least one byte is read and
  24768. stored into b.
  24769. The first byte read is stored into element b[0], the next one
  24770. into b[1], and so on. The number of bytes read is, at most,
  24771. equal to the length of b. Let k be the number of bytes actually
  24772. read; these bytes will be stored in elements b[0] through
  24773. b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
  24774. If the first byte cannot be read for any reason other than end
  24775. of file, then an IOException is thrown. In particular, an
  24776. IOException is thrown if the input stream has been closed.
  24777. The read(b) method for class InputStream has the same effect as:
  24778. </summary>
  24779. <param name="b">the buffer into which the data is read.</param>
  24780. <returns>the total number of bytes read into the buffer, or -1
  24781. if there is no more data because the end of the stream
  24782. has been reached.</returns>
  24783. </member>
  24784. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[],System.Int32,System.Int32)">
  24785. <summary>
  24786. Reads up to len bytes of data from the input stream into an
  24787. array of bytes. An attempt is made to read as many as len
  24788. bytes, but a smaller number may be read, possibly zero. The
  24789. number of bytes actually read is returned as an integer.
  24790. The definition of this method in java.io.InputStream allows it
  24791. to block, but it won't.
  24792. If b is null, a NullPointerException is thrown.
  24793. If off is negative, or len is negative, or off+len is greater
  24794. than the length of the array b, then an
  24795. IndexOutOfBoundsException is thrown.
  24796. If len is zero, then no bytes are read and 0 is returned;
  24797. otherwise, there is an attempt to read at least one byte. If no
  24798. byte is available because the stream is at end of file, the
  24799. value -1 is returned; otherwise, at least one byte is read and
  24800. stored into b.
  24801. The first byte read is stored into element b[off], the next one
  24802. into b[off+1], and so on. The number of bytes read is, at most,
  24803. equal to len. Let k be the number of bytes actually read; these
  24804. bytes will be stored in elements b[off] through b[off+k-1],
  24805. leaving elements b[off+k] through b[off+len-1] unaffected.
  24806. In every case, elements b[0] through b[off] and elements
  24807. b[off+len] through b[b.length-1] are unaffected.
  24808. If the first byte cannot be read for any reason other than end
  24809. of file, then an IOException is thrown. In particular, an
  24810. IOException is thrown if the input stream has been closed.
  24811. </summary>
  24812. <param name="b">the buffer into which the data is read.</param>
  24813. <param name="off">the start offset in array b at which the data is
  24814. written.</param>
  24815. <param name="len">the maximum number of bytes to read.</param>
  24816. <returns>the total number of bytes read into the buffer, or -1
  24817. if there is no more data because the end of the stream
  24818. has been reached.</returns>
  24819. </member>
  24820. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.ReadByte">
  24821. <summary>
  24822. Reads the next byte of data from the input stream. The value
  24823. byte is returned as an int in the range 0 to 255. If no byte is
  24824. available because the end of the stream has been reached, the
  24825. value -1 is returned. The definition of this method in
  24826. java.io.InputStream allows this method to block, but it won't.
  24827. </summary>
  24828. <returns>the next byte of data, or -1 if the end of the stream
  24829. is reached.
  24830. </returns>
  24831. </member>
  24832. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Seek(System.Int64,System.IO.SeekOrigin)">
  24833. <summary>
  24834. When overridden in a derived class, sets the position within the current stream.
  24835. </summary>
  24836. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  24837. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  24838. <returns>
  24839. The new position within the current stream.
  24840. </returns>
  24841. <exception cref="T:System.IO.IOException">
  24842. An I/O error occurs.
  24843. </exception>
  24844. <exception cref="T:System.NotSupportedException">
  24845. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  24846. </exception>
  24847. <exception cref="T:System.ObjectDisposedException">
  24848. Methods were called after the stream was closed.
  24849. </exception>
  24850. </member>
  24851. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Skip(System.Int64)">
  24852. <summary>
  24853. Skips the specified n.
  24854. </summary>
  24855. <param name="n">The n.</param>
  24856. <returns></returns>
  24857. </member>
  24858. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Write(System.Byte[],System.Int32,System.Int32)">
  24859. <summary>
  24860. 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.
  24861. </summary>
  24862. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  24863. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  24864. <param name="count">The number of bytes to be written to the current stream.</param>
  24865. <exception cref="T:System.ArgumentException">
  24866. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  24867. </exception>
  24868. <exception cref="T:System.ArgumentNullException">
  24869. <paramref name="buffer"/> is null.
  24870. </exception>
  24871. <exception cref="T:System.ArgumentOutOfRangeException">
  24872. <paramref name="offset"/> or <paramref name="count"/> is negative.
  24873. </exception>
  24874. <exception cref="T:System.IO.IOException">
  24875. An I/O error occurs.
  24876. </exception>
  24877. <exception cref="T:System.NotSupportedException">
  24878. The stream does not support writing.
  24879. </exception>
  24880. <exception cref="T:System.ObjectDisposedException">
  24881. Methods were called after the stream was closed.
  24882. </exception>
  24883. </member>
  24884. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanRead">
  24885. <summary>
  24886. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  24887. </summary>
  24888. <value></value>
  24889. <returns>true if the stream supports reading; otherwise, false.
  24890. </returns>
  24891. </member>
  24892. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanSeek">
  24893. <summary>
  24894. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  24895. </summary>
  24896. <value></value>
  24897. <returns>true if the stream supports seeking; otherwise, false.
  24898. </returns>
  24899. </member>
  24900. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanWrite">
  24901. <summary>
  24902. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  24903. </summary>
  24904. <value></value>
  24905. <returns>true if the stream supports writing; otherwise, false.
  24906. </returns>
  24907. </member>
  24908. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Length">
  24909. <summary>
  24910. When overridden in a derived class, gets the length in bytes of the stream.
  24911. </summary>
  24912. <value></value>
  24913. <returns>
  24914. A long value representing the length of the stream in bytes.
  24915. </returns>
  24916. <exception cref="T:System.NotSupportedException">
  24917. A class derived from Stream does not support seeking.
  24918. </exception>
  24919. <exception cref="T:System.ObjectDisposedException">
  24920. Methods were called after the stream was closed.
  24921. </exception>
  24922. </member>
  24923. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Position">
  24924. <summary>
  24925. When overridden in a derived class, gets or sets the position within the current stream.
  24926. </summary>
  24927. <value></value>
  24928. <returns>
  24929. The current position within the stream.
  24930. </returns>
  24931. <exception cref="T:System.IO.IOException">
  24932. An I/O error occurs.
  24933. </exception>
  24934. <exception cref="T:System.NotSupportedException">
  24935. The stream does not support seeking.
  24936. </exception>
  24937. <exception cref="T:System.ObjectDisposedException">
  24938. Methods were called after the stream was closed.
  24939. </exception>
  24940. </member>
  24941. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentWriter">
  24942. <summary>
  24943. This class provides a wrapper over an OutputStream so that Document
  24944. writers can't accidently go over their size limits
  24945. @author Marc Johnson (mjohnson at apache dot org)
  24946. </summary>
  24947. </member>
  24948. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.#ctor(System.IO.Stream,System.Int32)">
  24949. <summary>
  24950. Create a POIFSDocumentWriter
  24951. </summary>
  24952. <param name="stream">the OutputStream to which the data is actually</param>
  24953. <param name="limit">the maximum number of bytes that can be written</param>
  24954. </member>
  24955. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Close">
  24956. <summary>
  24957. Closes this output stream and releases any system resources
  24958. associated with this stream. The general contract of close is
  24959. that it closes the output stream. A closed stream cannot
  24960. perform output operations and cannot be reopened.
  24961. </summary>
  24962. </member>
  24963. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Flush">
  24964. <summary>
  24965. Flushes this output stream and forces any buffered output bytes
  24966. to be written out.
  24967. </summary>
  24968. </member>
  24969. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[])">
  24970. <summary>
  24971. Writes b.length bytes from the specified byte array
  24972. to this output stream.
  24973. </summary>
  24974. <param name="b">the data.</param>
  24975. </member>
  24976. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[],System.Int32,System.Int32)">
  24977. <summary>
  24978. Writes len bytes from the specified byte array starting at
  24979. offset off to this output stream. The general contract for
  24980. write(b, off, len) is that some of the bytes in the array b are
  24981. written to the output stream in order; element b[off] is the
  24982. first byte written and b[off+len-1] is the last byte written by
  24983. this operation.
  24984. If b is null, a NullPointerException is thrown.
  24985. If off is negative, or len is negative, or off+len is greater
  24986. than the length of the array b, then an
  24987. IndexOutOfBoundsException is thrown.
  24988. </summary>
  24989. <param name="b">the data.</param>
  24990. <param name="off">the start offset in the data.</param>
  24991. <param name="len">the number of bytes to write.</param>
  24992. </member>
  24993. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteByte(System.Byte)">
  24994. <summary>
  24995. Writes the specified byte to this output stream. The general
  24996. contract for write is that one byte is written to the output
  24997. stream. The byte to be written is the eight low-order bits of
  24998. the argument b. The 24 high-order bits of b are ignored.
  24999. </summary>
  25000. <param name="b">the byte.</param>
  25001. </member>
  25002. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteFiller(System.Int32,System.Byte)">
  25003. <summary>
  25004. write the rest of the document's data (fill in at the end)
  25005. </summary>
  25006. <param name="totalLimit">the actual number of bytes the corresponding
  25007. document must fill</param>
  25008. <param name="fill">the byte to fill remaining space with</param>
  25009. </member>
  25010. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanRead">
  25011. <summary>
  25012. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  25013. </summary>
  25014. <value></value>
  25015. <returns>true if the stream supports reading; otherwise, false.
  25016. </returns>
  25017. </member>
  25018. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanSeek">
  25019. <summary>
  25020. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  25021. </summary>
  25022. <value></value>
  25023. <returns>true if the stream supports seeking; otherwise, false.
  25024. </returns>
  25025. </member>
  25026. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanWrite">
  25027. <summary>
  25028. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  25029. </summary>
  25030. <value></value>
  25031. <returns>true if the stream supports writing; otherwise, false.
  25032. </returns>
  25033. </member>
  25034. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Length">
  25035. <summary>
  25036. When overridden in a derived class, gets the length in bytes of the stream.
  25037. </summary>
  25038. <value></value>
  25039. <returns>
  25040. A long value representing the length of the stream in bytes.
  25041. </returns>
  25042. <exception cref="T:System.NotSupportedException">
  25043. A class derived from Stream does not support seeking.
  25044. </exception>
  25045. <exception cref="T:System.ObjectDisposedException">
  25046. Methods were called after the stream was closed.
  25047. </exception>
  25048. </member>
  25049. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Position">
  25050. <summary>
  25051. When overridden in a derived class, gets or sets the position within the current stream.
  25052. </summary>
  25053. <value></value>
  25054. <returns>
  25055. The current position within the stream.
  25056. </returns>
  25057. <exception cref="T:System.IO.IOException">
  25058. An I/O error occurs.
  25059. </exception>
  25060. <exception cref="T:System.NotSupportedException">
  25061. The stream does not support seeking.
  25062. </exception>
  25063. <exception cref="T:System.ObjectDisposedException">
  25064. Methods were called after the stream was closed.
  25065. </exception>
  25066. </member>
  25067. <member name="T:NPOI.POIFS.FileSystem.POIFSFileSystem">
  25068. <summary>
  25069. This is the main class of the POIFS system; it manages the entire
  25070. life cycle of the filesystem.
  25071. @author Marc Johnson (mjohnson at apache dot org)
  25072. </summary>
  25073. </member>
  25074. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  25075. <summary>
  25076. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  25077. </summary>
  25078. <param name="stream">The stream.</param>
  25079. <example>
  25080. A convenience method (
  25081. CreateNonClosingInputStream()) has been provided for this purpose:
  25082. StreamwrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  25083. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  25084. is.reset();
  25085. doSomethingElse(is);
  25086. </example>
  25087. <returns></returns>
  25088. </member>
  25089. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor">
  25090. <summary>
  25091. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSFileSystem"/> class. intended for writing
  25092. </summary>
  25093. </member>
  25094. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.Stream)">
  25095. <summary>
  25096. Create a POIFSFileSystem from an Stream. Normally the stream is Read until
  25097. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  25098. needs to use it after this constructor completes, a work around is to wrap the
  25099. stream in order to trap the Close() call.
  25100. </summary>
  25101. <param name="stream">the Streamfrom which to Read the data</param>
  25102. </member>
  25103. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  25104. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  25105. creating from an <tt>InputStream</tt>.</p>
  25106. <p>Note that with this constructor, you will need to call {@link #close()}
  25107. when you're done to have the underlying file closed, as the file is
  25108. kept open during normal operation to read the data out.</p>
  25109. @param readOnly whether the POIFileSystem will only be used in read-only mode
  25110. @param file the File from which to read the data
  25111. @exception IOException on errors reading, or on invalid data
  25112. </member>
  25113. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.FileInfo)">
  25114. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  25115. creating from an <tt>InputStream</tt>. The File will be opened read-only</p>
  25116. <p>Note that with this constructor, you will need to call {@link #close()}
  25117. when you're done to have the underlying file closed, as the file is
  25118. kept open during normal operation to read the data out.</p>
  25119. @param file the File from which to read the data
  25120. @exception IOException on errors reading, or on invalid data
  25121. </member>
  25122. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  25123. <summary>
  25124. Checks that the supplied Stream(which MUST
  25125. support mark and reset, or be a PushbackInputStream)
  25126. has a POIFS (OLE2) header at the start of it.
  25127. If your Streamdoes not support mark / reset,
  25128. then wrap it in a PushBackInputStream, then be
  25129. sure to always use that, and not the original!
  25130. </summary>
  25131. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  25132. <returns>
  25133. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  25134. </returns>
  25135. </member>
  25136. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  25137. Checks if the supplied first 8 bytes of a stream / file
  25138. has a POIFS (OLE2) header.
  25139. </member>
  25140. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.Create(System.IO.FileInfo)">
  25141. Creates a new {@link POIFSFileSystem} in a new {@link File}.
  25142. Use {@link #POIFSFileSystem(File)} to open an existing File,
  25143. this should only be used to create a new empty filesystem.
  25144. @param file The file to create and open
  25145. @return The created and opened {@link POIFSFileSystem}
  25146. </member>
  25147. <member name="T:NPOI.POIFS.Macros.VBAMacroExtractor">
  25148. This tool extracts out the source of all VBA Modules of an office file,
  25149. both OOXML (eg XLSM) and OLE2/POIFS (eg DOC), to STDOUT or a directory.
  25150. @since 3.15-beta2
  25151. </member>
  25152. <member name="M:NPOI.POIFS.Macros.VBAMacroExtractor.Extract(System.IO.FileInfo,System.IO.DirectoryInfo,System.String)">
  25153. Extracts the VBA modules from a macro-enabled office file and Writes them
  25154. to files in <tt>outputDir</tt>.
  25155. Creates the <tt>outputDir</tt>, directory, including any necessary but
  25156. nonexistent parent directories, if <tt>outputDir</tt> does not exist.
  25157. If <tt>outputDir</tt> is null, Writes the contents to standard out instead.
  25158. @param input the macro-enabled office file.
  25159. @param outputDir the directory to write the extracted VBA modules to.
  25160. @param extension file extension of the extracted VBA modules
  25161. @since 3.15-beta2
  25162. </member>
  25163. <member name="M:NPOI.POIFS.Macros.VBAMacroExtractor.Extract(System.IO.FileInfo,System.IO.DirectoryInfo)">
  25164. Extracts the VBA modules from a macro-enabled office file and Writes them
  25165. to <tt>.vba</tt> files in <tt>outputDir</tt>.
  25166. Creates the <tt>outputDir</tt>, directory, including any necessary but
  25167. nonexistent parent directories, if <tt>outputDir</tt> does not exist.
  25168. If <tt>outputDir</tt> is null, Writes the contents to standard out instead.
  25169. @param input the macro-enabled office file.
  25170. @param outputDir the directory to write the extracted VBA modules to.
  25171. @since 3.15-beta2
  25172. </member>
  25173. <member name="T:NPOI.POIFS.Macros.VBAMacroReader">
  25174. Finds all VBA Macros in an office file (OLE2/POIFS and OOXML/OPC),
  25175. and returns them.
  25176. @since 3.15-beta2
  25177. </member>
  25178. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadMacros">
  25179. Reads all macros from all modules of the opened office file.
  25180. @return All the macros and their contents
  25181. @since 3.15-beta2
  25182. </member>
  25183. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.FindMacros(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Macros.VBAMacroReader.ModuleMap)">
  25184. Recursively traverses directory structure rooted at <tt>dir</tt>.
  25185. For each macro module that is found, the module's name and code are
  25186. Added to <tt>modules</tt>.
  25187. @param dir
  25188. @param modules
  25189. @throws IOException
  25190. @since 3.15-beta2
  25191. </member>
  25192. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadString(NPOI.Util.InputStream,System.Int32,System.Text.Encoding)">
  25193. Read <tt>length</tt> bytes of MBCS (multi-byte character Set) characters from the stream
  25194. @param stream the inputstream to read from
  25195. @param length number of bytes to read from stream
  25196. @param charset the character Set encoding of the bytes in the stream
  25197. @return a java String in the supplied character Set
  25198. @throws IOException
  25199. </member>
  25200. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadModule(NPOI.Util.RLEDecompressingInputStream,System.String,NPOI.POIFS.Macros.VBAMacroReader.ModuleMap)">
  25201. Reads module from DIR node in input stream and Adds it to the modules map for decompression later
  25202. on the second pass through this function, the module will be decompressed
  25203. Side-effects: Adds a new module to the module map or Sets the buf field on the module
  25204. to the decompressed stream contents (the VBA code for one module)
  25205. @param in the Run-length encoded input stream to read from
  25206. @param streamName the stream name of the module
  25207. @param modules a map to store the modules
  25208. @throws IOException
  25209. </member>
  25210. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.TrySkip(NPOI.Util.InputStream,System.Int64)">
  25211. Skips <tt>n</tt> bytes in an input stream, throwing IOException if the
  25212. number of bytes skipped is different than requested.
  25213. @throws IOException
  25214. </member>
  25215. <member name="M:NPOI.POIFS.Macros.VBAMacroReader.ReadMacros(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.Macros.VBAMacroReader.ModuleMap)">
  25216. Reads VBA Project modules from a VBA Project directory located at
  25217. <tt>macroDir</tt> into <tt>modules</tt>.
  25218. @since 3.15-beta2
  25219. </member>
  25220. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent">
  25221. Class POIFSWriterEvent
  25222. @author Marc Johnson (mjohnson at apache dot org)
  25223. @version %I%, %G%
  25224. </member>
  25225. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  25226. namespace scoped constructor
  25227. @param stream the DocumentOutputStream, freshly opened
  25228. @param path the path of the document
  25229. @param documentName the name of the document
  25230. @param limit the limit, in bytes, that can be written to the
  25231. stream
  25232. </member>
  25233. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Stream">
  25234. @return the DocumentOutputStream, freshly opened
  25235. </member>
  25236. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Path">
  25237. @return the document's path
  25238. </member>
  25239. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Name">
  25240. @return the document's name
  25241. </member>
  25242. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Limit">
  25243. @return the limit on writing, in bytes
  25244. </member>
  25245. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs">
  25246. <summary>
  25247. EventArgs for POIFSWriter
  25248. author: Tony Qu
  25249. </summary>
  25250. </member>
  25251. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  25252. <summary>
  25253. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent"/> class.
  25254. </summary>
  25255. <param name="stream">the POIFSDocumentWriter, freshly opened</param>
  25256. <param name="path">the path of the document</param>
  25257. <param name="documentName">the name of the document</param>
  25258. <param name="limit">the limit, in bytes, that can be written to the stream</param>
  25259. </member>
  25260. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Limit">
  25261. <summary>
  25262. Gets the limit on writing, in bytes
  25263. </summary>
  25264. <value>The limit.</value>
  25265. </member>
  25266. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Name">
  25267. <summary>
  25268. Gets the document's name
  25269. </summary>
  25270. <value>The name.</value>
  25271. </member>
  25272. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Path">
  25273. <summary>
  25274. Gets the document's path
  25275. </summary>
  25276. <value>The path.</value>
  25277. </member>
  25278. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Stream">
  25279. <summary>
  25280. the POIFSDocumentWriter, freshly opened
  25281. </summary>
  25282. <value>The stream.</value>
  25283. </member>
  25284. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterListener">
  25285. Interface POIFSWriterListener
  25286. @author Marc Johnson (mjohnson at apache dot org)
  25287. @version %I%, %G%
  25288. </member>
  25289. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterListener.ProcessPOIFSWriterEvent(NPOI.POIFS.EventFileSystem.POIFSWriterEvent)">
  25290. Process a POIFSWriterEvent that this listener had registered
  25291. for
  25292. @param event the POIFSWriterEvent
  25293. </member>
  25294. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReader">
  25295. <summary>
  25296. An event-driven Reader for POIFS file systems. Users of this class
  25297. first Create an instance of it, then use the RegisterListener
  25298. methods to Register POIFSReaderListener instances for specific
  25299. documents. Once all the listeners have been Registered, the Read()
  25300. method is called, which results in the listeners being notified as
  25301. their documents are Read.
  25302. @author Marc Johnson (mjohnson at apache dot org)
  25303. </summary>
  25304. </member>
  25305. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.#ctor">
  25306. <summary>
  25307. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSReader"/> class.
  25308. </summary>
  25309. </member>
  25310. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.Read(System.IO.Stream)">
  25311. <summary>
  25312. Read from an InputStream and Process the documents we Get
  25313. </summary>
  25314. <param name="stream">the InputStream from which to Read the data</param>
  25315. <returns>POIFSDocument list</returns>
  25316. </member>
  25317. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  25318. Register a POIFSReaderListener for all documents
  25319. @param listener the listener to be registered
  25320. @exception NullPointerException if listener is null
  25321. @exception InvalidOperationException if read() has already been
  25322. called
  25323. </member>
  25324. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,System.String)">
  25325. Register a POIFSReaderListener for a document in the root
  25326. directory
  25327. @param listener the listener to be registered
  25328. @param name the document name
  25329. @exception NullPointerException if listener is null or name is
  25330. null or empty
  25331. @exception InvalidOperationException if read() has already been
  25332. called
  25333. </member>
  25334. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  25335. Register a POIFSReaderListener for a document in the specified
  25336. directory
  25337. @param listener the listener to be registered
  25338. @param path the document path; if null, the root directory is
  25339. assumed
  25340. @param name the document name
  25341. @exception NullPointerException if listener is null or name is
  25342. null or empty
  25343. @exception InvalidOperationException if read() has already been
  25344. called
  25345. </member>
  25346. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.ProcessProperties(NPOI.POIFS.Storage.BlockList,NPOI.POIFS.Storage.BlockList,System.Collections.IEnumerator,NPOI.POIFS.FileSystem.POIFSDocumentPath)">
  25347. <summary>
  25348. Processes the properties.
  25349. </summary>
  25350. <param name="small_blocks">The small_blocks.</param>
  25351. <param name="big_blocks">The big_blocks.</param>
  25352. <param name="properties">The properties.</param>
  25353. <param name="path">The path.</param>
  25354. <returns></returns>
  25355. </member>
  25356. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEvent">
  25357. Class POIFSReaderEvent
  25358. @author Marc Johnson (mjohnson at apache dot org)
  25359. @version %I%, %G%
  25360. </member>
  25361. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.#ctor(NPOI.POIFS.FileSystem.DocumentInputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  25362. package scoped constructor
  25363. @param stream the DocumentInputStream, freshly opened
  25364. @param path the path of the document
  25365. @param documentName the name of the document
  25366. </member>
  25367. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Stream">
  25368. @return the DocumentInputStream, freshly opened
  25369. </member>
  25370. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Path">
  25371. @return the document's path
  25372. </member>
  25373. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Name">
  25374. @return the document's name
  25375. </member>
  25376. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEventArgs">
  25377. <summary>
  25378. EventArgs for POIFSReader
  25379. author: Tony Qu
  25380. </summary>
  25381. </member>
  25382. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderListener">
  25383. Interface POIFSReaderListener
  25384. @author Marc Johnson (mjohnson at apache dot org)
  25385. @version %I%, %G%
  25386. </member>
  25387. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderListener.ProcessPOIFSReaderEvent(NPOI.POIFS.EventFileSystem.POIFSReaderEvent)">
  25388. Process a POIFSReaderEvent that this listener had Registered
  25389. for
  25390. @param event the POIFSReaderEvent
  25391. </member>
  25392. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry">
  25393. A registry for POIFSReaderListeners and the DocumentDescriptors of
  25394. the documents those listeners are interested in
  25395. @author Marc Johnson (mjohnson at apache dot org)
  25396. @version %I%, %G%
  25397. </member>
  25398. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.#ctor">
  25399. Construct the registry
  25400. </member>
  25401. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  25402. Register a POIFSReaderListener for a particular document
  25403. @param listener the listener
  25404. @param path the path of the document of interest
  25405. @param documentName the name of the document of interest
  25406. </member>
  25407. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  25408. Register for all documents
  25409. @param listener the listener who wants to Get all documents
  25410. </member>
  25411. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.GetListeners(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  25412. Get am iterator of listeners for a particular document
  25413. @param path the document path
  25414. @param name the name of the document
  25415. @return an Iterator POIFSReaderListeners; may be empty
  25416. </member>
  25417. <member name="T:NPOI.POIFS.NIO.ByteArrayBackedDataSource">
  25418. <summary>
  25419. A POIFS <see cref="T:NPOI.POIFS.NIO.DataSource"/> backed by a byte array.
  25420. </summary>
  25421. </member>
  25422. <member name="T:NPOI.POIFS.NIO.FileBackedDataSource">
  25423. <summary>
  25424. A POIFS DataSource backed by a File
  25425. TODO - Return the ByteBuffers in such a way that in RW mode,
  25426. changes to the buffer end up on the disk (will fix the HPSF TestWrite
  25427. currently failing unit test when done)
  25428. </summary>
  25429. </member>
  25430. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Read(System.Int32,System.Int64)">
  25431. <summary>
  25432. Reads a sequence of bytes from this FileStream starting at the given file position.
  25433. </summary>
  25434. <param name="length"></param>
  25435. <param name="position">The file position at which the transfer is to begin;</param>
  25436. <returns></returns>
  25437. </member>
  25438. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Write(NPOI.Util.ByteBuffer,System.Int64)">
  25439. <summary>
  25440. Writes a sequence of bytes to this FileStream from the given Stream,
  25441. starting at the given file position.
  25442. </summary>
  25443. <param name="src">The Stream from which bytes are to be transferred</param>
  25444. <param name="position">The file position at which the transfer is to begin;
  25445. must be non-negative</param>
  25446. </member>
  25447. <member name="T:NPOI.POIFS.NIO.DataSource">
  25448. <summary>
  25449. Common definition of how we read and write bytes
  25450. </summary>
  25451. </member>
  25452. <member name="M:NPOI.POIFS.NIO.DataSource.Close">
  25453. <summary>
  25454. Close the underlying stream
  25455. </summary>
  25456. </member>
  25457. <member name="M:NPOI.POIFS.NIO.DataSource.CopyTo(System.IO.Stream)">
  25458. <summary>
  25459. Copies the contents to the specified Stream
  25460. </summary>
  25461. <param name="stream"></param>
  25462. </member>
  25463. <member name="M:NPOI.POIFS.Properties.NPropertyTable.PreWrite">
  25464. Prepare to be written
  25465. </member>
  25466. <member name="T:NPOI.POIFS.Properties.Child">
  25467. <summary>
  25468. This interface defines methods for finding and setting sibling
  25469. Property instances
  25470. @author Marc Johnson (mjohnson at apache dot org)
  25471. </summary>
  25472. </member>
  25473. <member name="P:NPOI.POIFS.Properties.Child.PreviousChild">
  25474. <summary>
  25475. Gets or sets the previous child.
  25476. </summary>
  25477. <value>The previous child.</value>
  25478. </member>
  25479. <member name="P:NPOI.POIFS.Properties.Child.NextChild">
  25480. <summary>
  25481. Gets or sets the next child.
  25482. </summary>
  25483. <value>The next child.</value>
  25484. </member>
  25485. <member name="T:NPOI.POIFS.Properties.DirectoryProperty">
  25486. <summary>
  25487. Trivial extension of Property for POIFSDocuments
  25488. @author Marc Johnson (mjohnson at apache dot org)
  25489. </summary>
  25490. </member>
  25491. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.String)">
  25492. <summary>
  25493. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  25494. </summary>
  25495. <param name="name">the name of the directory</param>
  25496. </member>
  25497. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  25498. <summary>
  25499. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  25500. </summary>
  25501. <param name="index">index number</param>
  25502. <param name="array">byte data</param>
  25503. <param name="offset">offset into byte data</param>
  25504. </member>
  25505. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.ChangeName(NPOI.POIFS.Properties.Property,System.String)">
  25506. <summary>
  25507. Change a Property's name
  25508. </summary>
  25509. <param name="property">the Property whose name Is being Changed.</param>
  25510. <param name="newName">the new name for the Property</param>
  25511. <returns>true if the name Change could be made, else false</returns>
  25512. </member>
  25513. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.DeleteChild(NPOI.POIFS.Properties.Property)">
  25514. <summary>
  25515. Delete a Property
  25516. </summary>
  25517. <param name="property">the Property being Deleted</param>
  25518. <returns>true if the Property could be Deleted, else false</returns>
  25519. </member>
  25520. <member name="T:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator">
  25521. <summary>
  25522. Directory Property Comparer
  25523. </summary>
  25524. </member>
  25525. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Equals(System.Object)">
  25526. <summary>
  25527. Object equality, implemented as object identity
  25528. </summary>
  25529. <param name="o">Object we're being Compared to</param>
  25530. <returns>true if identical, else false</returns>
  25531. </member>
  25532. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Compare(NPOI.POIFS.Properties.Property,NPOI.POIFS.Properties.Property)">
  25533. <summary>
  25534. Compare method. Assumes both parameters are non-null
  25535. instances of Property. One property is less than another if
  25536. its name is shorter than the other property's name. If the
  25537. names are the same length, the property whose name comes
  25538. before the other property's name, alphabetically, is less
  25539. than the other property.
  25540. </summary>
  25541. <param name="o1">first object to compare, better be a Property</param>
  25542. <param name="o2">second object to compare, better be a Property</param>
  25543. <returns>negative value if o1 smaller than o2,
  25544. zero if o1 equals o2,
  25545. positive value if o1 bigger than o2.</returns>
  25546. </member>
  25547. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.IsDirectory">
  25548. <summary>
  25549. Gets a value indicating whether this instance is directory.
  25550. </summary>
  25551. <value>
  25552. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  25553. </value>
  25554. </member>
  25555. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PreWrite">
  25556. <summary>
  25557. Perform whatever activities need to be performed prior to
  25558. writing
  25559. </summary>
  25560. </member>
  25561. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.Children">
  25562. <summary>
  25563. Get an iterator over the children of this Parent; all elements
  25564. are instances of Property.
  25565. </summary>
  25566. <value>Iterator of children; may refer to an empty collection</value>
  25567. </member>
  25568. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.AddChild(NPOI.POIFS.Properties.Property)">
  25569. <summary>
  25570. Add a new child to the collection of children
  25571. </summary>
  25572. <param name="property">the new child to be added; must not be null</param>
  25573. </member>
  25574. <member name="T:NPOI.POIFS.Properties.DocumentProperty">
  25575. <summary>
  25576. Trivial extension of Property for POIFSDocuments
  25577. @author Marc Johnson (mjohnson at apache dot org)
  25578. </summary>
  25579. </member>
  25580. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.String,System.Int32)">
  25581. <summary>
  25582. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  25583. </summary>
  25584. <param name="name">POIFSDocument name</param>
  25585. <param name="size">POIFSDocument size</param>
  25586. </member>
  25587. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  25588. <summary>
  25589. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  25590. </summary>
  25591. <param name="index">index number</param>
  25592. <param name="array">byte data</param>
  25593. <param name="offset">offset into byte data</param>
  25594. </member>
  25595. <member name="P:NPOI.POIFS.Properties.DocumentProperty.Document">
  25596. <summary>
  25597. Gets or sets the document.
  25598. </summary>
  25599. <value>the associated POIFSDocument</value>
  25600. </member>
  25601. <member name="P:NPOI.POIFS.Properties.DocumentProperty.IsDirectory">
  25602. <summary>
  25603. Determines whether this instance is directory.
  25604. </summary>
  25605. <returns>
  25606. <c>true</c> if this instance is directory; otherwise, <c>false</c>.
  25607. </returns>
  25608. </member>
  25609. <member name="M:NPOI.POIFS.Properties.DocumentProperty.PreWrite">
  25610. <summary>
  25611. Perform whatever activities need to be performed prior to
  25612. writing
  25613. </summary>
  25614. </member>
  25615. <member name="M:NPOI.POIFS.Properties.DocumentProperty.UpdateSize(System.Int32)">
  25616. Update the size of the property's data
  25617. </member>
  25618. <member name="T:NPOI.POIFS.Properties.Parent">
  25619. <summary>
  25620. Behavior for parent (directory) properties
  25621. @author Marc Johnson27591@hotmail.com
  25622. </summary>
  25623. </member>
  25624. <member name="P:NPOI.POIFS.Properties.Parent.Children">
  25625. <summary>
  25626. Get an iterator over the children of this Parent
  25627. all elements are instances of Property.
  25628. </summary>
  25629. <returns></returns>
  25630. </member>
  25631. <member name="M:NPOI.POIFS.Properties.Parent.AddChild(NPOI.POIFS.Properties.Property)">
  25632. <summary>
  25633. Add a new child to the collection of children
  25634. </summary>
  25635. <param name="property">the new child to be added; must not be null</param>
  25636. </member>
  25637. <member name="P:NPOI.POIFS.Properties.Parent.PreviousChild">
  25638. <summary>
  25639. Sets the previous child.
  25640. </summary>
  25641. </member>
  25642. <member name="P:NPOI.POIFS.Properties.Parent.NextChild">
  25643. <summary>
  25644. Sets the next child.
  25645. </summary>
  25646. </member>
  25647. <member name="T:NPOI.POIFS.Properties.Property">
  25648. <summary>
  25649. This abstract base class is the ancestor of all classes
  25650. implementing POIFS Property behavior.
  25651. @author Marc Johnson (mjohnson at apache dot org)
  25652. </summary>
  25653. </member>
  25654. <member name="M:NPOI.POIFS.Properties.Property.#ctor">
  25655. <summary>
  25656. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.Property"/> class.
  25657. </summary>
  25658. </member>
  25659. <member name="M:NPOI.POIFS.Properties.Property.#ctor(System.Int32,System.Byte[],System.Int32)">
  25660. <summary>
  25661. Constructor from byte data
  25662. </summary>
  25663. <param name="index">index number</param>
  25664. <param name="array">byte data</param>
  25665. <param name="offset">offset into byte data</param>
  25666. </member>
  25667. <member name="M:NPOI.POIFS.Properties.Property.WriteData(System.IO.Stream)">
  25668. <summary>
  25669. Write the raw data to an OutputStream.
  25670. </summary>
  25671. <param name="stream">the OutputStream to which the data Should be
  25672. written.</param>
  25673. </member>
  25674. <member name="P:NPOI.POIFS.Properties.Property.StartBlock">
  25675. <summary>
  25676. Gets or sets the start block for the document referred to by this
  25677. Property.
  25678. </summary>
  25679. <value>the start block index</value>
  25680. </member>
  25681. <member name="P:NPOI.POIFS.Properties.Property.ShouldUseSmallBlocks">
  25682. <summary>
  25683. Based on the currently defined size, Should this property use
  25684. small blocks?
  25685. </summary>
  25686. <returns>true if the size Is less than _big_block_minimum_bytes</returns>
  25687. </member>
  25688. <member name="M:NPOI.POIFS.Properties.Property.IsSmall(System.Int32)">
  25689. <summary>
  25690. does the length indicate a small document?
  25691. </summary>
  25692. <param name="length">length in bytes</param>
  25693. <returns>
  25694. <c>true</c> if the length Is less than
  25695. _big_block_minimum_bytes; otherwise, <c>false</c>.
  25696. </returns>
  25697. </member>
  25698. <member name="P:NPOI.POIFS.Properties.Property.Name">
  25699. <summary>
  25700. Gets or sets the name of this property
  25701. </summary>
  25702. <value>property name</value>
  25703. </member>
  25704. <member name="P:NPOI.POIFS.Properties.Property.IsDirectory">
  25705. <summary>
  25706. Gets a value indicating whether this instance is directory.
  25707. </summary>
  25708. <value>
  25709. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  25710. </value>
  25711. </member>
  25712. <member name="P:NPOI.POIFS.Properties.Property.StorageClsid">
  25713. <summary>
  25714. Gets or sets the storage class ID for this property stream. ThIs Is the Class ID
  25715. of the COM object which can read and write this property stream </summary>
  25716. <value>Storage Class ID</value>
  25717. </member>
  25718. <member name="P:NPOI.POIFS.Properties.Property.PropertyType">
  25719. <summary>
  25720. Set the property type. Makes no attempt to validate the value.
  25721. </summary>
  25722. <value>the property type (root, file, directory)</value>
  25723. </member>
  25724. <member name="P:NPOI.POIFS.Properties.Property.NodeColor">
  25725. <summary>
  25726. Sets the color of the node.
  25727. </summary>
  25728. <value>the node color (red or black)</value>
  25729. </member>
  25730. <member name="P:NPOI.POIFS.Properties.Property.ChildProperty">
  25731. <summary>
  25732. Sets the child property.
  25733. </summary>
  25734. <value>the child property's index in the Property Table</value>
  25735. </member>
  25736. <member name="P:NPOI.POIFS.Properties.Property.ChildIndex">
  25737. <summary>
  25738. Get the child property (its index in the Property Table)
  25739. </summary>
  25740. <value>The index of the child.</value>
  25741. </member>
  25742. <member name="P:NPOI.POIFS.Properties.Property.Size">
  25743. <summary>
  25744. Gets or sets the size of the document associated with this Property
  25745. </summary>
  25746. <value>the size of the document, in bytes</value>
  25747. </member>
  25748. <member name="P:NPOI.POIFS.Properties.Property.Index">
  25749. <summary>
  25750. Gets or sets the index.
  25751. </summary>
  25752. <value>The index.</value>
  25753. Get the index for this Property
  25754. @return the index of this Property within its Property Table
  25755. </member>
  25756. <member name="M:NPOI.POIFS.Properties.Property.PreWrite">
  25757. <summary>
  25758. Perform whatever activities need to be performed prior to
  25759. writing
  25760. </summary>
  25761. </member>
  25762. <member name="P:NPOI.POIFS.Properties.Property.NextChildIndex">
  25763. <summary>
  25764. Gets the index of the next child.
  25765. </summary>
  25766. <value>The index of the next child.</value>
  25767. </member>
  25768. <member name="P:NPOI.POIFS.Properties.Property.PreviousChildIndex">
  25769. <summary>
  25770. Gets the index of the previous child.
  25771. </summary>
  25772. <value>The index of the previous child.</value>
  25773. </member>
  25774. <member name="M:NPOI.POIFS.Properties.Property.IsValidIndex(System.Int32)">
  25775. <summary>
  25776. Determines whether the specified index Is valid
  25777. </summary>
  25778. <param name="index">value to be checked</param>
  25779. <returns>
  25780. <c>true</c> if the index Is valid; otherwise, <c>false</c>.
  25781. </returns>
  25782. </member>
  25783. <member name="P:NPOI.POIFS.Properties.Property.PreviousChild">
  25784. <summary>
  25785. Gets or sets the previous child.
  25786. </summary>
  25787. <value>the new 'previous' child; may be null, which has
  25788. the effect of saying there Is no 'previous' child</value>
  25789. </member>
  25790. <member name="P:NPOI.POIFS.Properties.Property.NextChild">
  25791. <summary>
  25792. Gets or sets the next Child
  25793. </summary>
  25794. <value> the new 'next' child; may be null, which has the
  25795. effect of saying there Is no 'next' child</value>
  25796. </member>
  25797. <member name="P:NPOI.POIFS.Properties.Property.ViewableArray">
  25798. <summary>
  25799. Get an array of objects, some of which may implement
  25800. POIFSViewable
  25801. </summary>
  25802. <value>an array of Object; may not be null, but may be empty</value>
  25803. </member>
  25804. <member name="P:NPOI.POIFS.Properties.Property.ViewableIterator">
  25805. <summary>
  25806. Get an Iterator of objects, some of which may implement POIFSViewable
  25807. </summary>
  25808. <value> may not be null, but may have an empty
  25809. back end store</value>
  25810. </member>
  25811. <member name="P:NPOI.POIFS.Properties.Property.PreferArray">
  25812. <summary>
  25813. Give viewers a hint as to whether to call GetViewableArray or
  25814. GetViewableIterator
  25815. </summary>
  25816. <value><c>true</c> if a viewer Should call GetViewableArray; otherwise, <c>false</c>
  25817. if a viewer Should call GetViewableIterator
  25818. </value>
  25819. </member>
  25820. <member name="P:NPOI.POIFS.Properties.Property.ShortDescription">
  25821. <summary>
  25822. Provides a short description of the object, to be used when a
  25823. POIFSViewable object has not provided its contents.
  25824. </summary>
  25825. <value>The short description.</value>
  25826. </member>
  25827. <member name="T:NPOI.POIFS.Properties.PropertyConstants">
  25828. <summary>
  25829. Constants used by Properties namespace
  25830. </summary>
  25831. </member>
  25832. <member name="M:NPOI.POIFS.Properties.PropertyFactory.ConvertToProperties(NPOI.POIFS.Storage.ListManagedBlock[])">
  25833. <summary>
  25834. Convert raw data blocks to an array of Property's
  25835. </summary>
  25836. <param name="blocks">The blocks to be converted</param>
  25837. <returns>the converted List of Property objects. May contain
  25838. nulls, but will not be null</returns>
  25839. </member>
  25840. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock)">
  25841. Default constructor
  25842. </member>
  25843. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock,NPOI.POIFS.Storage.RawDataBlockList)">
  25844. reading constructor (used when we've read in a file and we want
  25845. to extract the property table from it). Populates the
  25846. properties thoroughly
  25847. @param startBlock the first block of the property table
  25848. @param blockList the list of blocks
  25849. @exception IOException if anything goes wrong (which should be
  25850. a result of the input being NFG)
  25851. </member>
  25852. <member name="M:NPOI.POIFS.Properties.PropertyTable.PreWrite">
  25853. Prepare to be written Leon
  25854. </member>
  25855. <member name="P:NPOI.POIFS.Properties.PropertyTable.CountBlocks">
  25856. Return the number of BigBlock's this instance uses
  25857. @return count of BigBlock instances
  25858. </member>
  25859. <member name="M:NPOI.POIFS.Properties.PropertyTable.WriteBlocks(System.IO.Stream)">
  25860. Write the storage to an Stream
  25861. @param stream the Stream to which the stored data should
  25862. be written
  25863. @exception IOException on problems writing to the specified
  25864. stream
  25865. </member>
  25866. <member name="M:NPOI.POIFS.Properties.RootProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  25867. <summary>
  25868. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.RootProperty"/> class.
  25869. </summary>
  25870. <param name="index">index number</param>
  25871. <param name="array">byte data</param>
  25872. <param name="offset">offset into byte data</param>
  25873. </member>
  25874. <member name="P:NPOI.POIFS.Properties.RootProperty.Size">
  25875. <summary>
  25876. Gets or sets the size of the document associated with this Property
  25877. </summary>
  25878. <value>the size of the document, in bytes</value>
  25879. </member>
  25880. <member name="T:NPOI.POIFS.Storage.HeaderBlock">
  25881. <summary>
  25882. The block containing the archive header
  25883. @author Marc Johnson (mjohnson at apache dot org)
  25884. </summary>
  25885. </member>
  25886. <member name="F:NPOI.POIFS.Storage.HeaderBlock.bigBlockSize">
  25887. What big block Size the file uses. Most files
  25888. use 512 bytes, but a few use 4096
  25889. </member>
  25890. <member name="F:NPOI.POIFS.Storage.HeaderBlock._sbat_count">
  25891. Number of small block allocation table blocks (int)
  25892. (Number of MiniFAT Sectors in Microsoft parlance)
  25893. </member>
  25894. <member name="M:NPOI.POIFS.Storage.HeaderBlock.#ctor(System.IO.Stream)">
  25895. <summary>
  25896. create a new HeaderBlockReader from an Stream
  25897. </summary>
  25898. <param name="stream">the source Stream</param>
  25899. </member>
  25900. <member name="M:NPOI.POIFS.Storage.HeaderBlock.AlertShortRead(System.Int32,System.Int32)">
  25901. <summary>
  25902. Alerts the short read.
  25903. </summary>
  25904. <param name="read">The read.</param>
  25905. <param name="expectedReadSize">The expected size.</param>
  25906. </member>
  25907. <member name="P:NPOI.POIFS.Storage.HeaderBlock.PropertyStart">
  25908. <summary>
  25909. Get start of Property Table
  25910. </summary>
  25911. <value>the index of the first block of the Property Table</value>
  25912. </member>
  25913. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATStart">
  25914. <summary>
  25915. Gets start of small block allocation table
  25916. </summary>
  25917. <value>The SBAT start.</value>
  25918. </member>
  25919. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATCount">
  25920. <summary>
  25921. Gets number of BAT blocks
  25922. </summary>
  25923. <value>The BAT count.</value>
  25924. </member>
  25925. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BATArray">
  25926. <summary>
  25927. Gets the BAT array.
  25928. </summary>
  25929. <value>The BAT array.</value>
  25930. </member>
  25931. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATCount">
  25932. <summary>
  25933. Gets the XBAT count.
  25934. </summary>
  25935. <value>The XBAT count.</value>
  25936. @return XBAT count
  25937. </member>
  25938. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATIndex">
  25939. <summary>
  25940. Gets the index of the XBAT.
  25941. </summary>
  25942. <value>The index of the XBAT.</value>
  25943. </member>
  25944. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BigBlockSize">
  25945. <summary>
  25946. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  25947. </summary>
  25948. <value>The size of the big block.</value>
  25949. @return
  25950. </member>
  25951. <member name="T:NPOI.POIFS.Storage.BATBlock">
  25952. <summary>
  25953. A block of block allocation table entries. BATBlocks are created
  25954. only through a static factory method: createBATBlocks.
  25955. @author Marc Johnson (mjohnson at apache dot org)
  25956. </summary>
  25957. </member>
  25958. <member name="F:NPOI.POIFS.Storage.BATBlock._values">
  25959. For a regular fat block, these are 128 / 1024
  25960. next sector values.
  25961. For a XFat (DIFat) block, these are 127 / 1023
  25962. next sector values, then a chaining value.
  25963. </member>
  25964. <member name="F:NPOI.POIFS.Storage.BATBlock._has_free_sectors">
  25965. Does this BATBlock have any free sectors in it?
  25966. </member>
  25967. <member name="F:NPOI.POIFS.Storage.BATBlock.ourBlockIndex">
  25968. Where in the file are we?
  25969. </member>
  25970. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor">
  25971. <summary>
  25972. Create a single instance initialized with default values
  25973. </summary>
  25974. </member>
  25975. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32,System.Int32)">
  25976. Create a single instance initialized (perhaps partially) with entries
  25977. @param entries the array of block allocation table entries
  25978. @param start_index the index of the first entry to be written
  25979. to the block
  25980. @param end_index the index, plus one, of the last entry to be
  25981. written to the block (writing is for all index
  25982. k, start_index &lt;= k &lt; end_index)
  25983. </member>
  25984. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.IO.BinaryReader)">
  25985. Create a single BATBlock from the byte buffer, which must hold at least
  25986. one big block of data to be read.
  25987. </member>
  25988. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateEmptyBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.Boolean)">
  25989. **
  25990. </member>
  25991. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[])">
  25992. <summary>
  25993. Create an array of BATBlocks from an array of int block
  25994. allocation table entries
  25995. </summary>
  25996. <param name="bigBlockSize">the poifs bigBlockSize</param>
  25997. <param name="entries">the array of int entries</param>
  25998. <returns>the newly created array of BATBlocks</returns>
  25999. </member>
  26000. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateXBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32)">
  26001. <summary>
  26002. Create an array of XBATBlocks from an array of int block
  26003. allocation table entries
  26004. </summary>
  26005. <param name="bigBlockSize"></param>
  26006. <param name="entries">the array of int entries</param>
  26007. <param name="startBlock">the start block of the array of XBAT blocks</param>
  26008. <returns>the newly created array of BATBlocks</returns>
  26009. </member>
  26010. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateStorageRequirements(System.Int32)">
  26011. <summary>
  26012. Calculate how many BATBlocks are needed to hold a specified
  26013. number of BAT entries.
  26014. </summary>
  26015. <param name="entryCount">the number of entries</param>
  26016. <returns>the number of BATBlocks needed</returns>
  26017. </member>
  26018. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateXBATStorageRequirements(System.Int32)">
  26019. <summary>
  26020. Calculate how many XBATBlocks are needed to hold a specified
  26021. number of BAT entries.
  26022. </summary>
  26023. <param name="entryCount">the number of entries</param>
  26024. <returns>the number of XBATBlocks needed</returns>
  26025. </member>
  26026. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateMaximumSize(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  26027. Calculates the maximum size of a file which is addressable given the
  26028. number of FAT (BAT) sectors specified. (We don't care if those BAT
  26029. blocks come from the 109 in the header, or from header + XBATS, it
  26030. won't affect the calculation)
  26031. The actual file size will be between [size of fatCount-1 blocks] and
  26032. [size of fatCount blocks].
  26033. For 512 byte block sizes, this means we may over-estimate by up to 65kb.
  26034. For 4096 byte block sizes, this means we may over-estimate by up to 4mb
  26035. </member>
  26036. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerBlock">
  26037. <summary>
  26038. Gets the entries per block.
  26039. </summary>
  26040. <value>The number of entries per block</value>
  26041. </member>
  26042. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerXBATBlock">
  26043. <summary>
  26044. Gets the entries per XBAT block.
  26045. </summary>
  26046. <value>number of entries per XBAT block</value>
  26047. </member>
  26048. <member name="P:NPOI.POIFS.Storage.BATBlock.XBATChainOffset">
  26049. <summary>
  26050. Gets the XBAT chain offset.
  26051. </summary>
  26052. <value>offset of chain index of XBAT block</value>
  26053. </member>
  26054. <member name="P:NPOI.POIFS.Storage.BATBlock.HasFreeSectors">
  26055. Does this BATBlock have any free sectors in it, or
  26056. is it full?
  26057. </member>
  26058. <member name="M:NPOI.POIFS.Storage.BATBlock.GetUsedSectors(System.Boolean)">
  26059. How many sectors in this block are taken?
  26060. Note that calling {@link #hasFreeSectors()} is much quicker
  26061. </member>
  26062. <member name="P:NPOI.POIFS.Storage.BATBlock.OurBlockIndex">
  26063. Retrieve where in the file we live
  26064. </member>
  26065. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(System.Int32[],System.Int32,System.Int32)">
  26066. <summary>
  26067. Create a single instance initialized (perhaps partially) with entries
  26068. </summary>
  26069. <param name="entries">the array of block allocation table entries</param>
  26070. <param name="start_index">the index of the first entry to be written
  26071. to the block</param>
  26072. <param name="end_index">the index, plus one, of the last entry to be
  26073. written to the block (writing is for all index
  26074. k, start_index less than k less than end_index)
  26075. </param>
  26076. </member>
  26077. <member name="M:NPOI.POIFS.Storage.BATBlock.WriteData(System.IO.Stream)">
  26078. <summary>
  26079. Write the block's data to an Stream
  26080. </summary>
  26081. <param name="stream">the Stream to which the stored data should
  26082. be written</param>
  26083. </member>
  26084. <member name="T:NPOI.POIFS.Storage.BigBlock">
  26085. <summary>
  26086. Abstract base class of all POIFS block storage classes. All
  26087. extensions of BigBlock should write 512 bytes of data when
  26088. requested to write their data.
  26089. This class has package scope, as there is no reason at this time to
  26090. make the class public.
  26091. @author Marc Johnson (mjohnson at apache dot org)
  26092. </summary>
  26093. </member>
  26094. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream,System.Byte[])">
  26095. <summary>
  26096. Default implementation of write for extending classes that
  26097. contain their data in a simple array of bytes.
  26098. </summary>
  26099. <param name="stream">the OutputStream to which the data should be written.</param>
  26100. <param name="data">the byte array of to be written.</param>
  26101. </member>
  26102. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteBlocks(System.IO.Stream)">
  26103. <summary>
  26104. Write the block's data to an OutputStream
  26105. </summary>
  26106. <param name="stream">the OutputStream to which the stored data should be written</param>
  26107. </member>
  26108. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream)">
  26109. <summary>
  26110. Write the storage to an OutputStream
  26111. </summary>
  26112. <param name="stream">the OutputStream to which the stored data should be written </param>
  26113. </member>
  26114. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableReader">
  26115. <summary>
  26116. This class manages and creates the Block Allocation Table, which is
  26117. basically a set of linked lists of block indices.
  26118. Each block of the filesystem has an index. The first block, the
  26119. header, is skipped; the first block after the header is index 0,
  26120. the next is index 1, and so on.
  26121. A block's index is also its index into the Block Allocation
  26122. Table. The entry that it finds in the Block Allocation Table is the
  26123. index of the next block in the linked list of blocks making up a
  26124. file, or it is set to -2: end of list.
  26125. @author Marc Johnson (mjohnson at apache dot org)
  26126. </summary>
  26127. </member>
  26128. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32,System.Int32[],System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  26129. <summary>
  26130. create a BlockAllocationTableReader for an existing filesystem. Side
  26131. effect: when this method finishes, the BAT blocks will have
  26132. been Removed from the raw block list, and any blocks labeled as
  26133. 'unused' in the block allocation table will also have been
  26134. Removed from the raw block list. </summary>
  26135. <param name="bigBlockSizse">the poifs bigBlockSize</param>
  26136. <param name="block_count">the number of BAT blocks making up the block allocation table</param>
  26137. <param name="block_array">the array of BAT block indices from the
  26138. filesystem's header</param>
  26139. <param name="xbat_count">the number of XBAT blocks</param>
  26140. <param name="xbat_index">the index of the first XBAT block</param>
  26141. <param name="raw_block_list">the list of RawDataBlocks</param>
  26142. </member>
  26143. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  26144. <summary>
  26145. create a BlockAllocationTableReader from an array of raw data blocks
  26146. </summary>
  26147. <param name="bigBlockSize"></param>
  26148. <param name="blocks">the raw data</param>
  26149. <param name="raw_block_list">the list holding the managed blocks</param>
  26150. </member>
  26151. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26152. <summary>
  26153. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableReader"/> class.
  26154. </summary>
  26155. </member>
  26156. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.FetchBlocks(System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  26157. <summary>
  26158. walk the entries from a specified point and return the
  26159. associated blocks. The associated blocks are Removed from the block list
  26160. </summary>
  26161. <param name="startBlock">the first block in the chain</param>
  26162. <param name="headerPropertiesStartBlock"></param>
  26163. <param name="blockList">the raw data block list</param>
  26164. <returns>array of ListManagedBlocks, in their correct order</returns>
  26165. </member>
  26166. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.IsUsed(System.Int32)">
  26167. <summary>
  26168. determine whether the block specified by index is used or not
  26169. </summary>
  26170. <param name="index">determine whether the block specified by index is used or not</param>
  26171. <returns>
  26172. <c>true</c> if the specified block is used; otherwise, <c>false</c>.
  26173. </returns>
  26174. </member>
  26175. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.GetNextBlockIndex(System.Int32)">
  26176. <summary>
  26177. return the next block index
  26178. </summary>
  26179. <param name="index">The index of the current block</param>
  26180. <returns>index of the next block (may be
  26181. POIFSConstants.END_OF_CHAIN, indicating end of chain
  26182. (duh))</returns>
  26183. </member>
  26184. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.SetEntries(NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  26185. <summary>
  26186. Convert an array of blocks into a Set of integer indices
  26187. </summary>
  26188. <param name="blocks">the array of blocks containing the indices</param>
  26189. <param name="raw_blocks">the list of blocks being managed. Unused
  26190. blocks will be eliminated from the list</param>
  26191. </member>
  26192. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableWriter">
  26193. <summary>
  26194. This class manages and creates the Block Allocation Table, which is
  26195. basically a set of linked lists of block indices.
  26196. Each block of the filesystem has an index. The first block, the
  26197. header, is skipped; the first block after the header is index 0,
  26198. the next is index 1, and so on.
  26199. A block's index is also its index into the Block Allocation
  26200. Table. The entry that it finds in the Block Allocation Table is the
  26201. index of the next block in the linked list of blocks making up a
  26202. file, or it is set to -2: end of list.
  26203. *
  26204. @author Marc Johnson (mjohnson at apache dot org)
  26205. </summary>
  26206. </member>
  26207. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26208. <summary>
  26209. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableWriter"/> class.
  26210. </summary>
  26211. </member>
  26212. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.CreateBlocks">
  26213. <summary>
  26214. Create the BATBlocks we need
  26215. </summary>
  26216. <returns>start block index of BAT blocks</returns>
  26217. </member>
  26218. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.AllocateSpace(System.Int32)">
  26219. <summary>
  26220. Allocate space for a block of indices
  26221. </summary>
  26222. <param name="blockCount">the number of blocks to allocate space for</param>
  26223. <returns>the starting index of the blocks</returns>
  26224. </member>
  26225. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.StartBlock">
  26226. <summary>
  26227. Sets the start block for this instance
  26228. </summary>
  26229. <value>
  26230. index into the array of BigBlock instances making up the the filesystem
  26231. </value>
  26232. </member>
  26233. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.SimpleCreateBlocks">
  26234. <summary>
  26235. create the BATBlocks
  26236. </summary>
  26237. </member>
  26238. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.WriteBlocks(System.IO.Stream)">
  26239. <summary>
  26240. Write the storage to an OutputStream
  26241. </summary>
  26242. <param name="stream">the OutputStream to which the stored data should be written</param>
  26243. </member>
  26244. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.CountBlocks">
  26245. <summary>
  26246. Gets the number of BigBlock's this instance uses
  26247. </summary>
  26248. <value>count of BigBlock instances</value>
  26249. </member>
  26250. <member name="T:NPOI.POIFS.Storage.BlockList">
  26251. <summary>
  26252. Interface for lists of blocks that are mapped by block allocation
  26253. tables
  26254. @author Marc Johnson (mjohnson at apache dot org)
  26255. </summary>
  26256. </member>
  26257. <member name="M:NPOI.POIFS.Storage.BlockList.Zap(System.Int32)">
  26258. <summary>
  26259. remove the specified block from the list
  26260. </summary>
  26261. <param name="index">the index of the specified block; if the index is
  26262. out of range, that's ok</param>
  26263. </member>
  26264. <member name="M:NPOI.POIFS.Storage.BlockList.Remove(System.Int32)">
  26265. <summary>
  26266. Remove and return the specified block from the list
  26267. </summary>
  26268. <param name="index">the index of the specified block</param>
  26269. <returns>the specified block</returns>
  26270. </member>
  26271. <member name="M:NPOI.POIFS.Storage.BlockList.FetchBlocks(System.Int32,System.Int32)">
  26272. <summary>
  26273. get the blocks making up a particular stream in the list. The
  26274. blocks are removed from the list.
  26275. </summary>
  26276. <param name="startBlock">the index of the first block in the stream</param>
  26277. <param name="headerPropertiesStartBlock"></param>
  26278. <returns>the stream as an array of correctly ordered blocks</returns>
  26279. </member>
  26280. <member name="P:NPOI.POIFS.Storage.BlockList.BAT">
  26281. <summary>
  26282. set the associated BlockAllocationTable
  26283. </summary>
  26284. <value>the associated BlockAllocationTable</value>
  26285. </member>
  26286. <member name="M:NPOI.POIFS.Storage.BlockListImpl.#ctor">
  26287. <summary>
  26288. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockListImpl"/> class.
  26289. </summary>
  26290. </member>
  26291. <member name="M:NPOI.POIFS.Storage.BlockListImpl.SetBlocks(NPOI.POIFS.Storage.ListManagedBlock[])">
  26292. <summary>
  26293. provide blocks to manage
  26294. </summary>
  26295. <param name="blocks">blocks to be managed</param>
  26296. </member>
  26297. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Zap(System.Int32)">
  26298. <summary>
  26299. remove the specified block from the list
  26300. </summary>
  26301. <param name="index">the index of the specified block; if the index is
  26302. out of range, that's ok</param>
  26303. </member>
  26304. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Remove(System.Int32)">
  26305. <summary>
  26306. Remove and return the specified block from the list
  26307. </summary>
  26308. <param name="index">the index of the specified block</param>
  26309. <returns>the specified block</returns>
  26310. </member>
  26311. <member name="M:NPOI.POIFS.Storage.BlockListImpl.FetchBlocks(System.Int32,System.Int32)">
  26312. <summary>
  26313. get the blocks making up a particular stream in the list. The
  26314. blocks are removed from the list.
  26315. </summary>
  26316. <param name="startBlock">the index of the first block in the stream</param>
  26317. <param name="headerPropertiesStartBlock"></param>
  26318. <returns>
  26319. the stream as an array of correctly ordered blocks
  26320. </returns>
  26321. </member>
  26322. <member name="P:NPOI.POIFS.Storage.BlockListImpl.BAT">
  26323. <summary>
  26324. set the associated BlockAllocationTable
  26325. </summary>
  26326. <value>the associated BlockAllocationTable</value>
  26327. </member>
  26328. <member name="T:NPOI.POIFS.Storage.BlockWritable">
  26329. <summary>
  26330. An interface for persisting block storage of POIFS components.
  26331. @author Marc Johnson (mjohnson at apache dot org)
  26332. </summary>
  26333. </member>
  26334. <member name="M:NPOI.POIFS.Storage.BlockWritable.WriteBlocks(System.IO.Stream)">
  26335. <summary>
  26336. Writes the blocks.
  26337. </summary>
  26338. <param name="stream">The stream.</param>
  26339. </member>
  26340. <member name="T:NPOI.POIFS.Storage.DataInputBlock">
  26341. Wraps a <c>byte</c> array and provides simple data input access.
  26342. Internally, this class maintains a buffer read index, so that for the most part, primitive
  26343. data can be read in a data-input-stream-like manner.<p/>
  26344. Note - the calling class should call the {@link #available()} method to detect end-of-buffer
  26345. and Move to the next data block when the current is exhausted.
  26346. For optimisation reasons, no error handling is performed in this class. Thus, mistakes in
  26347. calling code ran may raise ugly exceptions here, like {@link ArrayIndexOutOfBoundsException},
  26348. etc .<p/>
  26349. The multi-byte primitive input methods ({@link #readUshortLE()}, {@link #readIntLE()} and
  26350. {@link #readLongLE()}) have corresponding 'spanning Read' methods which (when required) perform
  26351. a read across the block boundary. These spanning read methods take the previous
  26352. {@link DataInputBlock} as a parameter.
  26353. Reads of larger amounts of data (into <c>byte</c> array buffers) must be managed by the caller
  26354. since these could conceivably involve more than two blocks.
  26355. @author Josh Micich
  26356. </member>
  26357. <member name="F:NPOI.POIFS.Storage.DataInputBlock._buf">
  26358. Possibly any size (usually 512K or 64K). Assumed to be at least 8 bytes for all blocks
  26359. before the end of the stream. The last block in the stream can be any size except zero.
  26360. </member>
  26361. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE">
  26362. Reads a <c>short</c> which was encoded in <em>little endian</em> format.
  26363. </member>
  26364. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE(NPOI.POIFS.Storage.DataInputBlock)">
  26365. Reads a <c>short</c> which spans the end of <c>prevBlock</c> and the start of this block.
  26366. </member>
  26367. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE">
  26368. Reads an <c>int</c> which was encoded in <em>little endian</em> format.
  26369. </member>
  26370. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  26371. Reads an <c>int</c> which spans the end of <c>prevBlock</c> and the start of this block.
  26372. </member>
  26373. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE">
  26374. Reads a <c>long</c> which was encoded in <em>little endian</em> format.
  26375. </member>
  26376. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  26377. Reads a <c>long</c> which spans the end of <c>prevBlock</c> and the start of this block.
  26378. </member>
  26379. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadSpanning(NPOI.POIFS.Storage.DataInputBlock,System.Int32,System.Byte[])">
  26380. Reads a small amount of data from across the boundary between two blocks.
  26381. The {@link #_readIndex} of this (the second) block is updated accordingly.
  26382. Note- this method (and other code) assumes that the second {@link DataInputBlock}
  26383. always is big enough to complete the read without being exhausted.
  26384. </member>
  26385. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadFully(System.Byte[],System.Int32,System.Int32)">
  26386. Reads <c>len</c> bytes from this block into the supplied buffer.
  26387. </member>
  26388. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(NPOI.POIFS.Storage.RawDataBlock)">
  26389. <summary>
  26390. create a document block from a raw data block
  26391. </summary>
  26392. <param name="block">The block.</param>
  26393. </member>
  26394. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  26395. <summary>
  26396. Create a single instance initialized with data.
  26397. </summary>
  26398. <param name="stream">the InputStream delivering the data.</param>
  26399. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26400. </member>
  26401. <member name="P:NPOI.POIFS.Storage.DocumentBlock.Size">
  26402. <summary>
  26403. Get the number of bytes Read for this block.
  26404. </summary>
  26405. <value>bytes Read into the block</value>
  26406. </member>
  26407. <member name="P:NPOI.POIFS.Storage.DocumentBlock.PartiallyRead">
  26408. <summary>
  26409. Was this a partially Read block?
  26410. </summary>
  26411. <value><c>true</c> if the block was only partially filled with data</value>
  26412. </member>
  26413. <member name="P:NPOI.POIFS.Storage.DocumentBlock.FillByte">
  26414. <summary>
  26415. Gets the fill byte used
  26416. </summary>
  26417. <value>The fill byte.</value>
  26418. </member>
  26419. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  26420. <summary>
  26421. convert a single long array into an array of DocumentBlock
  26422. instances
  26423. </summary>
  26424. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26425. <param name="array">the byte array to be converted</param>
  26426. <param name="size">the intended size of the array (which may be smaller)</param>
  26427. <returns>an array of DocumentBlock instances, filled from the
  26428. input array</returns>
  26429. </member>
  26430. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Read(NPOI.POIFS.Storage.DocumentBlock[],System.Byte[],System.Int32)">
  26431. <summary>
  26432. Read data from an array of DocumentBlocks
  26433. </summary>
  26434. <param name="blocks">the blocks to Read from</param>
  26435. <param name="buffer">the buffer to Write the data into</param>
  26436. <param name="offset">the offset into the array of blocks to Read from</param>
  26437. </member>
  26438. <member name="M:NPOI.POIFS.Storage.DocumentBlock.WriteData(System.IO.Stream)">
  26439. <summary>
  26440. Write the storage to an OutputStream
  26441. </summary>
  26442. <param name="stream">the OutputStream to which the stored data should
  26443. be written</param>
  26444. </member>
  26445. <member name="T:NPOI.POIFS.Storage.HeaderBlockConstants">
  26446. <summary>
  26447. Constants used in reading/writing the Header block
  26448. @author Marc Johnson (mjohnson at apache dot org)
  26449. </summary>
  26450. </member>
  26451. <member name="T:NPOI.POIFS.Storage.HeaderBlockReader">
  26452. <summary>
  26453. The block containing the archive header
  26454. @author Marc Johnson (mjohnson at apache dot org)
  26455. </summary>
  26456. </member>
  26457. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader.bigBlockSize">
  26458. What big block Size the file uses. Most files
  26459. use 512 bytes, but a few use 4096
  26460. </member>
  26461. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader._sbat_count">
  26462. Number of small block allocation table blocks (int)
  26463. (Number of MiniFAT Sectors in Microsoft parlance)
  26464. </member>
  26465. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.#ctor(System.IO.Stream)">
  26466. <summary>
  26467. create a new HeaderBlockReader from an Stream
  26468. </summary>
  26469. <param name="stream">the source Stream</param>
  26470. </member>
  26471. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.AlertShortRead(System.Int32,System.Int32)">
  26472. <summary>
  26473. Alerts the short read.
  26474. </summary>
  26475. <param name="read">The read.</param>
  26476. <param name="expectedReadSize">expected size to read</param>
  26477. </member>
  26478. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.PropertyStart">
  26479. <summary>
  26480. Get start of Property Table
  26481. </summary>
  26482. <value>the index of the first block of the Property Table</value>
  26483. </member>
  26484. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.SBATStart">
  26485. <summary>
  26486. Gets start of small block allocation table
  26487. </summary>
  26488. <value>The SBAT start.</value>
  26489. </member>
  26490. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATCount">
  26491. <summary>
  26492. Gets number of BAT blocks
  26493. </summary>
  26494. <value>The BAT count.</value>
  26495. </member>
  26496. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATArray">
  26497. <summary>
  26498. Gets the BAT array.
  26499. </summary>
  26500. <value>The BAT array.</value>
  26501. </member>
  26502. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATCount">
  26503. <summary>
  26504. Gets the XBAT count.
  26505. </summary>
  26506. <value>The XBAT count.</value>
  26507. @return XBAT count
  26508. </member>
  26509. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATIndex">
  26510. <summary>
  26511. Gets the index of the XBAT.
  26512. </summary>
  26513. <value>The index of the XBAT.</value>
  26514. </member>
  26515. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BigBlockSize">
  26516. <summary>
  26517. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  26518. </summary>
  26519. <value>The size of the big block.</value>
  26520. @return
  26521. </member>
  26522. <member name="T:NPOI.POIFS.Storage.HeaderBlockWriter">
  26523. <summary>
  26524. The block containing the archive header
  26525. @author Marc Johnson (mjohnson at apache dot org)
  26526. </summary>
  26527. </member>
  26528. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.SetBATBlocks(System.Int32,System.Int32)">
  26529. <summary>
  26530. Set BAT block parameters. Assumes that all BAT blocks are
  26531. contiguous. Will construct XBAT blocks if necessary and return
  26532. the array of newly constructed XBAT blocks.
  26533. </summary>
  26534. <param name="blockCount">count of BAT blocks</param>
  26535. <param name="startBlock">index of first BAT block</param>
  26536. <returns>array of XBAT blocks; may be zero Length, will not be
  26537. null</returns>
  26538. </member>
  26539. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.PropertyStart">
  26540. <summary>
  26541. Set start of Property Table
  26542. </summary>
  26543. <value>the index of the first block of the Property
  26544. Table</value>
  26545. </member>
  26546. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBAStart">
  26547. <summary>
  26548. Set start of small block allocation table
  26549. </summary>
  26550. <value>the index of the first big block of the small
  26551. block allocation table</value>
  26552. </member>
  26553. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBATBlockCount">
  26554. <summary>
  26555. Set count of SBAT blocks
  26556. </summary>
  26557. <value>the number of SBAT blocks</value>
  26558. </member>
  26559. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.CalculateXBATStorageRequirements(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  26560. <summary>
  26561. For a given number of BAT blocks, calculate how many XBAT
  26562. blocks will be needed
  26563. </summary>
  26564. <param name="bigBlockSize"></param>
  26565. <param name="blockCount">number of BAT blocks</param>
  26566. <returns>number of XBAT blocks needed</returns>
  26567. </member>
  26568. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.WriteBlocks(System.IO.Stream)">
  26569. <summary>
  26570. Write the block's data to an Stream
  26571. </summary>
  26572. <param name="stream">the Stream to which the stored data should
  26573. be written
  26574. </param>
  26575. </member>
  26576. <member name="T:NPOI.POIFS.Storage.ListManagedBlock">
  26577. <summary>
  26578. An interface for blocks managed by a list that works with a
  26579. BlockAllocationTable to keep block sequences straight
  26580. @author Marc Johnson (mjohnson at apache dot org
  26581. </summary>
  26582. </member>
  26583. <member name="P:NPOI.POIFS.Storage.ListManagedBlock.Data">
  26584. <summary>
  26585. Get the data from the block
  26586. </summary>
  26587. <value>the block's data as a byte array</value>
  26588. </member>
  26589. <member name="T:NPOI.POIFS.Storage.PropertyBlock">
  26590. <summary>
  26591. A block of Property instances
  26592. @author Marc Johnson (mjohnson at apache dot org)
  26593. </summary>
  26594. </member>
  26595. <member name="M:NPOI.POIFS.Storage.PropertyBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Properties.Property[],System.Int32)">
  26596. <summary>
  26597. Create a single instance initialized with default values
  26598. </summary>
  26599. <param name="bigBlockSize"></param>
  26600. <param name="properties">the properties to be inserted</param>
  26601. <param name="offset">the offset into the properties array</param>
  26602. </member>
  26603. <member name="M:NPOI.POIFS.Storage.PropertyBlock.CreatePropertyBlockArray(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.List{NPOI.POIFS.Properties.Property})">
  26604. <summary>
  26605. Create an array of PropertyBlocks from an array of Property
  26606. instances, creating empty Property instances to make up any
  26607. shortfall
  26608. </summary>
  26609. <param name="bigBlockSize"></param>
  26610. <param name="properties">the Property instances to be converted into PropertyBlocks, in a java List</param>
  26611. <returns>the array of newly created PropertyBlock instances</returns>
  26612. </member>
  26613. <member name="M:NPOI.POIFS.Storage.PropertyBlock.WriteData(System.IO.Stream)">
  26614. <summary>
  26615. Write the block's data to an OutputStream
  26616. </summary>
  26617. <param name="stream">the OutputStream to which the stored data should be written</param>
  26618. </member>
  26619. <member name="T:NPOI.POIFS.Storage.RawDataBlock">
  26620. <summary>
  26621. A big block created from an InputStream, holding the raw data
  26622. @author Marc Johnson (mjohnson at apache dot org
  26623. </summary>
  26624. </member>
  26625. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream)">
  26626. <summary>
  26627. Constructor RawDataBlock
  26628. </summary>
  26629. <param name="stream">the Stream from which the data will be read</param>
  26630. </member>
  26631. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream,System.Int32)">
  26632. <summary>
  26633. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlock"/> class.
  26634. </summary>
  26635. <param name="stream">the Stream from which the data will be read</param>
  26636. <param name="blockSize">the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}</param>
  26637. </member>
  26638. <member name="P:NPOI.POIFS.Storage.RawDataBlock.EOF">
  26639. <summary>
  26640. When we read the data, did we hit end of file?
  26641. </summary>
  26642. <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
  26643. it's possible to both have data, and also hit EoF...</value>
  26644. </member>
  26645. <member name="P:NPOI.POIFS.Storage.RawDataBlock.HasData">
  26646. <summary>
  26647. Did we actually find any data to read? It's possible,
  26648. in the event of a short last block, to both have hit
  26649. the EoF, but also to have data
  26650. </summary>
  26651. <value><c>true</c> if this instance has data; otherwise, <c>false</c>.</value>
  26652. </member>
  26653. <member name="P:NPOI.POIFS.Storage.RawDataBlock.Data">
  26654. <summary>
  26655. Get the data from the block
  26656. </summary>
  26657. <value>the block's data as a byte array</value>
  26658. </member>
  26659. <member name="T:NPOI.POIFS.Storage.RawDataBlockList">
  26660. <summary>
  26661. A list of RawDataBlocks instances, and methods to manage the list
  26662. @author Marc Johnson (mjohnson at apache dot org
  26663. </summary>
  26664. </member>
  26665. <member name="M:NPOI.POIFS.Storage.RawDataBlockList.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  26666. <summary>
  26667. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlockList"/> class.
  26668. </summary>
  26669. <param name="stream">the InputStream from which the data will be read</param>
  26670. <param name="bigBlockSize">The big block size, either 512 bytes or 4096 bytes</param>
  26671. </member>
  26672. <member name="T:NPOI.POIFS.Storage.SmallBlockTableReader">
  26673. <summary>
  26674. This class implements reading the small document block list from an
  26675. existing file
  26676. @author Marc Johnson (mjohnson at apache dot org)
  26677. </summary>
  26678. </member>
  26679. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader._getSmallDocumentBlockReader(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  26680. <summary>
  26681. fetch the small document block list from an existing file, normally
  26682. needed for debugging and low level dumping. You should typically call
  26683. </summary>
  26684. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26685. <param name="blockList">the raw data from which the small block table will be extracted</param>
  26686. <param name="root">the root property (which contains the start block and small block table size)</param>
  26687. <param name="sbatStart">the start block of the SBAT</param>
  26688. <returns>the small document block reader</returns>
  26689. </member>
  26690. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader.GetSmallDocumentBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  26691. <summary>
  26692. fetch the small document block list from an existing file
  26693. </summary>
  26694. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26695. <param name="blockList">the raw data from which the small block table will be extracted</param>
  26696. <param name="root">the root property (which contains the start block and small block table size)</param>
  26697. <param name="sbatStart">the start block of the SBAT</param>
  26698. <returns>the small document block list</returns>
  26699. </member>
  26700. <member name="T:NPOI.POIFS.Storage.SmallBlockTableWriter">
  26701. <summary>
  26702. This class implements reading the small document block list from an
  26703. existing file
  26704. @author Marc Johnson (mjohnson at apache dot org)
  26705. </summary>
  26706. </member>
  26707. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.IList{NPOI.POIFS.FileSystem.OPOIFSDocument},NPOI.POIFS.Properties.RootProperty)">
  26708. <summary>
  26709. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallBlockTableWriter"/> class.
  26710. </summary>
  26711. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26712. <param name="documents">a IList of POIFSDocument instances</param>
  26713. <param name="root">the Filesystem's root property</param>
  26714. </member>
  26715. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBATBlockCount">
  26716. <summary>
  26717. Get the number of SBAT blocks
  26718. </summary>
  26719. <value>number of SBAT big blocks</value>
  26720. </member>
  26721. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBAT">
  26722. <summary>
  26723. Gets the SBAT.
  26724. </summary>
  26725. <value>the Small Block Allocation Table</value>
  26726. </member>
  26727. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.CountBlocks">
  26728. <summary>
  26729. Return the number of BigBlock's this instance uses
  26730. </summary>
  26731. <value>count of BigBlock instances</value>
  26732. </member>
  26733. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.StartBlock">
  26734. <summary>
  26735. Sets the start block.
  26736. </summary>
  26737. <value>The start block.</value>
  26738. </member>
  26739. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.WriteBlocks(System.IO.Stream)">
  26740. <summary>
  26741. Write the storage to an OutputStream
  26742. </summary>
  26743. <param name="stream">the OutputStream to which the stored data should be written</param>
  26744. </member>
  26745. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlock">
  26746. <summary>
  26747. Storage for documents that are too small to use regular
  26748. DocumentBlocks for their data
  26749. @author Marc Johnson (mjohnson at apache dot org)
  26750. </summary>
  26751. </member>
  26752. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  26753. <summary>
  26754. convert a single long array into an array of SmallDocumentBlock
  26755. instances
  26756. </summary>
  26757. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26758. <param name="array">the byte array to be converted</param>
  26759. <param name="size">the intended size of the array (which may be smaller)</param>
  26760. <returns>an array of SmallDocumentBlock instances, filled from
  26761. the array</returns>
  26762. </member>
  26763. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Fill(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.IList{NPOI.POIFS.Storage.SmallDocumentBlock})">
  26764. <summary>
  26765. fill out a List of SmallDocumentBlocks so that it fully occupies
  26766. a Set of big blocks
  26767. </summary>
  26768. <param name="bigBlockSize"></param>
  26769. <param name="blocks">the List to be filled out.</param>
  26770. <returns>number of big blocks the list encompasses</returns>
  26771. </member>
  26772. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.BlockWritable[],System.Int32)">
  26773. <summary>
  26774. Factory for creating SmallDocumentBlocks from DocumentBlocks
  26775. </summary>
  26776. <param name="bigBlocksSize"></param>
  26777. <param name="store">the original DocumentBlocks</param>
  26778. <param name="size">the total document size</param>
  26779. <returns>an array of new SmallDocumentBlocks instances</returns>
  26780. </member>
  26781. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Extract(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[])">
  26782. <summary>
  26783. create a list of SmallDocumentBlock's from raw data
  26784. </summary>
  26785. <param name="bigBlockSize"></param>
  26786. <param name="blocks">the raw data containing the SmallDocumentBlock</param>
  26787. <returns>a List of SmallDocumentBlock's extracted from the input</returns>
  26788. </member>
  26789. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Read(NPOI.POIFS.Storage.BlockWritable[],System.Byte[],System.Int32)">
  26790. <summary>
  26791. Read data from an array of SmallDocumentBlocks
  26792. </summary>
  26793. <param name="blocks">the blocks to Read from.</param>
  26794. <param name="buffer">the buffer to Write the data into.</param>
  26795. <param name="offset">the offset into the array of blocks to Read from</param>
  26796. </member>
  26797. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.CalcSize(System.Int32)">
  26798. <summary>
  26799. Calculate the storage size of a Set of SmallDocumentBlocks
  26800. </summary>
  26801. <param name="size"> number of SmallDocumentBlocks</param>
  26802. <returns>total size</returns>
  26803. </member>
  26804. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.MakeEmptySmallDocumentBlock(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26805. <summary>
  26806. Makes the empty small document block.
  26807. </summary>
  26808. <returns></returns>
  26809. </member>
  26810. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.ConvertToBlockCount(System.Int32)">
  26811. <summary>
  26812. Converts to block count.
  26813. </summary>
  26814. <param name="size">The size.</param>
  26815. <returns></returns>
  26816. </member>
  26817. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.WriteBlocks(System.IO.Stream)">
  26818. <summary>
  26819. Write the storage to an OutputStream
  26820. </summary>
  26821. <param name="stream">the OutputStream to which the stored data should
  26822. be written</param>
  26823. </member>
  26824. <member name="P:NPOI.POIFS.Storage.SmallDocumentBlock.Data">
  26825. <summary>
  26826. Get the data from the block
  26827. </summary>
  26828. <value>the block's data as a byte array</value>
  26829. </member>
  26830. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlockList">
  26831. <summary>
  26832. A list of SmallDocumentBlocks instances, and methods to manage the list
  26833. @author Marc Johnson (mjohnson at apache dot org)
  26834. </summary>
  26835. </member>
  26836. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlockList.#ctor(System.Collections.Generic.List{NPOI.POIFS.Storage.SmallDocumentBlock})">
  26837. <summary>
  26838. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallDocumentBlockList"/> class.
  26839. </summary>
  26840. <param name="blocks">a list of SmallDocumentBlock instances</param>
  26841. </member>
  26842. <member name="T:NPOI.POIFS.Common.POIFSBigBlockSize">
  26843. <p>A class describing attributes of the Big Block Size</p>
  26844. </member>
  26845. <member name="M:NPOI.POIFS.Common.POIFSBigBlockSize.GetHeaderValue">
  26846. Returns the value that Gets written into the
  26847. header.
  26848. Is the power of two that corresponds to the
  26849. size of the block, eg 512 => 9
  26850. </member>
  26851. <member name="T:NPOI.POIFS.Common.POIFSConstants">
  26852. <summary>
  26853. A repository for constants shared by POI classes.
  26854. @author Marc Johnson (mjohnson at apache dot org)
  26855. </summary>
  26856. </member>
  26857. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALLER_BIG_BLOCK_SIZE">
  26858. Most files use 512 bytes as their big block size
  26859. </member>
  26860. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGER_BIG_BLOCK_SIZE">
  26861. Some use 4096 bytes
  26862. </member>
  26863. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_SIZE">
  26864. Most files use 512 bytes as their big block size
  26865. </member>
  26866. <member name="F:NPOI.POIFS.Common.POIFSConstants.MINI_BLOCK_SIZE">
  26867. Most files use 512 bytes as their big block size
  26868. </member>
  26869. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALL_BLOCK_SIZE">
  26870. How big a block in the small block stream is. Fixed size
  26871. </member>
  26872. <member name="F:NPOI.POIFS.Common.POIFSConstants.PROPERTY_SIZE">
  26873. How big a single property is
  26874. </member>
  26875. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE">
  26876. The minimum size of a document before it's stored using
  26877. Big Blocks (normal streams). Smaller documents go in the
  26878. Mini Stream (SBAT / Small Blocks)
  26879. </member>
  26880. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGEST_REGULAR_SECTOR_NUMBER">
  26881. The highest sector number you're allowed, 0xFFFFFFFA
  26882. </member>
  26883. <member name="F:NPOI.POIFS.Common.POIFSConstants.FAT_SECTOR_BLOCK">
  26884. Indicates the sector holds a FAT block (0xFFFFFFFD)
  26885. </member>
  26886. <member name="F:NPOI.POIFS.Common.POIFSConstants.DIFAT_SECTOR_BLOCK">
  26887. Indicates the sector holds a DIFAT block (0xFFFFFFFC)
  26888. </member>
  26889. <member name="F:NPOI.POIFS.Common.POIFSConstants.END_OF_CHAIN">
  26890. Indicates the sector is the end of a chain (0xFFFFFFFE)
  26891. </member>
  26892. <member name="F:NPOI.POIFS.Common.POIFSConstants.UNUSED_BLOCK">
  26893. Indicates the sector is not used (0xFFFFFFFF)
  26894. </member>
  26895. <member name="F:NPOI.POIFS.Common.POIFSConstants.OOXML_FILE_HEADER">
  26896. The first 4 bytes of an OOXML file, used in detection
  26897. </member>
  26898. <member name="F:NPOI.POIFS.Common.POIFSConstants.RAW_XML_FILE_HEADER">
  26899. The first 5 bytes of a raw XML file, used in detection
  26900. </member>
  26901. <member name="T:NPOI.POIFS.Dev.POIFSViewable">
  26902. <summary>
  26903. Interface for a drill-down viewable object. Such an object has
  26904. content that may or may not be displayed, at the discretion of the
  26905. viewer. The content is returned to the viewer as an array or as an
  26906. Iterator, and the object provides a clue as to which technique the
  26907. viewer should use to get its content.
  26908. A POIFSViewable object is also expected to provide a short
  26909. description of itself, that can be used by a viewer when the
  26910. viewable object is collapsed.
  26911. @author Marc Johnson (mjohnson at apache dot org)
  26912. </summary>
  26913. </member>
  26914. <member name="P:NPOI.POIFS.Dev.POIFSViewable.PreferArray">
  26915. <summary>
  26916. Provides a short description of the object to be used when a
  26917. POIFSViewable object has not provided its contents.
  26918. </summary>
  26919. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  26920. </member>
  26921. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ShortDescription">
  26922. <summary>
  26923. Gets the short description.
  26924. </summary>
  26925. <value>The short description.</value>
  26926. </member>
  26927. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableArray">
  26928. <summary>
  26929. Get an array of objects, some of which may implement POIFSViewable
  26930. </summary>
  26931. <value>The viewable array.</value>
  26932. </member>
  26933. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableIterator">
  26934. <summary>
  26935. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  26936. </summary>
  26937. <value>The viewable iterator.</value>
  26938. </member>
  26939. <member name="T:NPOI.POIFS.Dev.POIFSViewEngine">
  26940. <summary>
  26941. This class contains methods used to inspect POIFSViewable objects
  26942. @author Marc Johnson (mjohnson at apache dot org)
  26943. </summary>
  26944. </member>
  26945. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.InspectViewable(System.Object,System.Boolean,System.Int32,System.String)">
  26946. <summary>
  26947. Inspect an object that may be viewable, and drill down if told to
  26948. </summary>
  26949. <param name="viewable">the object to be viewed</param>
  26950. <param name="drilldown">if <c>true</c> and the object implements POIFSViewable, inspect the objects' contents</param>
  26951. <param name="indentLevel">how far in to indent each string</param>
  26952. <param name="indentString">string to use for indenting</param>
  26953. <returns>a List of Strings holding the content</returns>
  26954. </member>
  26955. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.Indent(System.Int32,System.String,System.String)">
  26956. <summary>
  26957. Indents the specified indent level.
  26958. </summary>
  26959. <param name="indentLevel">how far in to indent each string</param>
  26960. <param name="indentString">string to use for indenting</param>
  26961. <param name="data">The data.</param>
  26962. <returns></returns>
  26963. </member>
  26964. <member name="M:NPOI.Util.POIUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  26965. Copies an Entry into a target POIFS directory, recursively
  26966. </member>
  26967. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  26968. Copies nodes from one POIFS to the other minus the excepts
  26969. @param source
  26970. is the source POIFS to copy from
  26971. @param target
  26972. is the target POIFS to copy to
  26973. @param excepts
  26974. is a list of Strings specifying what nodes NOT to copy
  26975. </member>
  26976. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  26977. Copies nodes from one POIFS to the other minus the excepts
  26978. @param source
  26979. is the source POIFS to copy from
  26980. @param target
  26981. is the target POIFS to copy to
  26982. @param excepts
  26983. is a list of Strings specifying what nodes NOT to copy
  26984. </member>
  26985. <member name="T:NPOI.Util.BlockingInputStream">
  26986. Implementation of a BlockingInputStream to provide data to
  26987. RawDataBlock that expects data in 512 byte chunks. Useful to read
  26988. data from slow (ie, non FileInputStream) sources, for example when
  26989. Reading an OLE2 Document over a network.
  26990. Possible extentions: add a timeout. Curently a call to Read(byte[]) on this
  26991. class is blocking, so use at your own peril if your underlying stream blocks.
  26992. @author Jens Gerhard
  26993. @author aviks - documentation cleanups.
  26994. </member>
  26995. <member name="M:NPOI.Util.BlockingInputStream.Read(System.Byte[])">
  26996. We had to revert to byte per byte Reading to keep
  26997. with slow network connections on one hand, without
  26998. missing the end-of-file.
  26999. This is the only method that does its own thing in this class
  27000. everything else is delegated to aggregated stream.
  27001. THIS IS A BLOCKING BLOCK READ!!!
  27002. </member>
  27003. <member name="M:NPOI.Util.BoundedInputStream.#ctor(NPOI.Util.ByteArrayInputStream,System.Int64)">
  27004. <summary>
  27005. Creates a new <c>BoundedInputStream</c> that wraps the given input
  27006. stream and limits it to a certain size.
  27007. </summary>
  27008. <param name="in1">The wrapped input stream</param>
  27009. <param name="size">The maximum number of bytes to return</param>
  27010. </member>
  27011. <member name="M:NPOI.Util.BoundedInputStream.#ctor(NPOI.Util.ByteArrayInputStream)">
  27012. <summary>
  27013. Creates a new <c>BoundedInputStream</c> that wraps the given input
  27014. stream and is unlimited.
  27015. </summary>
  27016. <param name="in1">The wrapped input stream</param>
  27017. </member>
  27018. <member name="M:NPOI.Util.BoundedInputStream.Read">
  27019. <summary>
  27020. Invokes the delegate's <code>read()</code> method if
  27021. the current position is less than the limit.
  27022. </summary>
  27023. <returns>the byte read or -1 if the end of stream
  27024. or the limit has been reached.</returns>
  27025. <exception cref="T:System.IO.IOException">if an I/O error occurs</exception>
  27026. </member>
  27027. <member name="M:NPOI.Util.ByteBuffer.Remaining">
  27028. <summary>
  27029. Returns the number of elements between the current position and the limit.
  27030. </summary>
  27031. <returns>The number of elements remaining in this buffer</returns>
  27032. </member>
  27033. <member name="M:NPOI.Util.ByteBuffer.HasRemaining">
  27034. <summary>
  27035. Tells whether there are any elements between the current position and the limit.
  27036. </summary>
  27037. <returns>true if, and only if, there is at least one element remaining in this buffer</returns>
  27038. </member>
  27039. <member name="T:NPOI.Util.ClassID">
  27040. <summary>
  27041. Represents a class ID (16 bytes). Unlike other little-endian
  27042. type the {@link ClassID} is not just 16 bytes stored in the wrong
  27043. order. Instead, it is a double word (4 bytes) followed by two
  27044. words (2 bytes each) followed by 8 bytes.
  27045. @author Rainer Klute
  27046. <a href="mailto:klute@rainer-klute.de">klute@rainer-klute.de</a>
  27047. @version $Id: ClassID.java 489730 2006-12-22 19:18:16Z bayard $
  27048. @since 2002-02-09
  27049. </summary>
  27050. </member>
  27051. <member name="F:NPOI.Util.ClassID.bytes">
  27052. The bytes making out the class ID in correct order,
  27053. i.e. big-endian.
  27054. </member>
  27055. <member name="M:NPOI.Util.ClassID.#ctor(System.Byte[],System.Int32)">
  27056. <summary>
  27057. Creates a <see cref="T:NPOI.Util.ClassID"/> and Reads its value from a byte array.
  27058. </summary>
  27059. <param name="src">The byte array to Read from.</param>
  27060. <param name="offset">The offset of the first byte to Read.</param>
  27061. </member>
  27062. <member name="M:NPOI.Util.ClassID.#ctor">
  27063. <summary>
  27064. Creates a <see cref="T:NPOI.Util.ClassID"/> and initializes its value with 0x00 bytes.
  27065. </summary>
  27066. </member>
  27067. <member name="M:NPOI.Util.ClassID.#ctor(System.String)">
  27068. <p>Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
  27069. format <code>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</code>.</p>
  27070. @param externalForm representation of the Class ID represented by this object.
  27071. </member>
  27072. <member name="F:NPOI.Util.ClassID.LENGTH">
  27073. The number of bytes occupied by this object in the byte
  27074. stream.
  27075. </member>
  27076. <member name="P:NPOI.Util.ClassID.Length">
  27077. <summary>
  27078. Gets the length.
  27079. </summary>
  27080. <value>The number of bytes occupied by this object in the byte stream.</value>
  27081. </member>
  27082. <member name="P:NPOI.Util.ClassID.Bytes">
  27083. <summary>
  27084. Gets or sets the bytes making out the class ID. They are returned in correct order, i.e. big-endian.
  27085. </summary>
  27086. <value>the bytes making out the class ID..</value>
  27087. </member>
  27088. <member name="M:NPOI.Util.ClassID.Read(System.Byte[],System.Int32)">
  27089. <summary>
  27090. Reads the class ID's value from a byte array by turning little-endian into big-endian.
  27091. </summary>
  27092. <param name="src">The byte array to Read from</param>
  27093. <param name="offset">The offset within the </param>
  27094. <returns>A byte array containing the class ID.</returns>
  27095. </member>
  27096. <member name="M:NPOI.Util.ClassID.Write(System.Byte[],System.Int32)">
  27097. <summary>
  27098. Writes the class ID to a byte array in the little-endian format.
  27099. </summary>
  27100. <param name="dst">The byte array to Write to.</param>
  27101. <param name="offset">The offset within the </param>
  27102. </member>
  27103. <member name="M:NPOI.Util.ClassID.Equals(System.Object)">
  27104. <summary>
  27105. Checks whether this ClassID is equal to another
  27106. object.
  27107. </summary>
  27108. <param name="o">the object to compare this PropertySet with</param>
  27109. <returns>true if the objects are equal, else
  27110. false</returns>
  27111. </member>
  27112. <member name="M:NPOI.Util.ClassID.GetHashCode">
  27113. <summary>
  27114. Serves as a hash function for a particular type.
  27115. </summary>
  27116. <returns>
  27117. A hash code for the current <see cref="T:System.Object"/>.
  27118. </returns>
  27119. </member>
  27120. <member name="M:NPOI.Util.ClassID.ToString">
  27121. <summary>
  27122. Returns a human-Readable representation of the Class ID in standard
  27123. format <c>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</c>.
  27124. </summary>
  27125. <returns>
  27126. A String representation of the Class ID represented by this object..
  27127. </returns>
  27128. </member>
  27129. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Byte)">
  27130. <summary>
  27131. Fills the specified array.
  27132. </summary>
  27133. <param name="array">The array.</param>
  27134. <param name="defaultValue">The default value.</param>
  27135. </member>
  27136. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Int32,System.Int32,System.Byte)">
  27137. <summary>
  27138. Assigns the specified byte value to each element of the specified
  27139. range of the specified array of bytes. The range to be filled
  27140. extends from index <tt>fromIndex</tt>, inclusive, to index
  27141. <tt>toIndex</tt>, exclusive. (If <tt>fromIndex==toIndex</tt>, the
  27142. range to be filled is empty.)
  27143. </summary>
  27144. <param name="a">the array to be filled</param>
  27145. <param name="fromIndex">the index of the first element (inclusive) to be filled with the specified value</param>
  27146. <param name="toIndex">the index of the last element (exclusive) to be filled with the specified value</param>
  27147. <param name="val">the value to be stored in all elements of the array</param>
  27148. <exception cref="T:System.ArgumentException">if <c>fromIndex &gt; toIndex</c></exception>
  27149. <exception cref="T:System.IndexOutOfRangeException"> if <c>fromIndex &lt; 0</c> or <c>toIndex &gt; a.length</c></exception>
  27150. </member>
  27151. <member name="M:NPOI.Util.Arrays.RangeCheck(System.Int32,System.Int32,System.Int32)">
  27152. <summary>
  27153. Checks that {@code fromIndex} and {@code toIndex} are in
  27154. the range and throws an appropriate exception, if they aren't.
  27155. </summary>
  27156. <param name="length"></param>
  27157. <param name="fromIndex"></param>
  27158. <param name="toIndex"></param>
  27159. </member>
  27160. <member name="M:NPOI.Util.Arrays.AsList(System.Array)">
  27161. <summary>
  27162. Convert Array to ArrayList
  27163. </summary>
  27164. <param name="arr">source array</param>
  27165. <returns></returns>
  27166. </member>
  27167. <member name="M:NPOI.Util.Arrays.Fill(System.Int32[],System.Byte)">
  27168. <summary>
  27169. Fills the specified array.
  27170. </summary>
  27171. <param name="array">The array.</param>
  27172. <param name="defaultValue">The default value.</param>
  27173. </member>
  27174. <member name="M:NPOI.Util.Arrays.Equals(System.Object,System.Object)">
  27175. <summary>
  27176. Equals the specified a1.
  27177. </summary>
  27178. <param name="a1">The a1.</param>
  27179. <param name="b1">The b1.</param>
  27180. <returns></returns>
  27181. </member>
  27182. <member name="M:NPOI.Util.Arrays.Equals(System.Object[],System.Object[])">
  27183. Returns <c>true</c> if the two specified arrays of Objects are
  27184. <i>equal</i> to one another. The two arrays are considered equal if
  27185. both arrays contain the same number of elements, and all corresponding
  27186. pairs of elements in the two arrays are equal. Two objects <c>e1</c>
  27187. and <c>e2</c> are considered <i>equal</i> if <c>(e1==null ? e2==null
  27188. : e1.equals(e2))</c>. In other words, the two arrays are equal if
  27189. they contain the same elements in the same order. Also, two array
  27190. references are considered equal if both are <c>null</c>.
  27191. @param a one array to be tested for equality
  27192. @param a2 the other array to be tested for equality
  27193. @return <c>true</c> if the two arrays are equal
  27194. </member>
  27195. <member name="M:NPOI.Util.Arrays.ArrayMoveWithin(System.Object[],System.Int32,System.Int32,System.Int32)">
  27196. <summary>
  27197. Moves a number of entries in an array to another point in the array, shifting those inbetween as required.
  27198. </summary>
  27199. <param name="array">The array to alter</param>
  27200. <param name="moveFrom">The (0 based) index of the first entry to move</param>
  27201. <param name="moveTo">The (0 based) index of the positition to move to</param>
  27202. <param name="numToMove">The number of entries to move</param>
  27203. </member>
  27204. <member name="M:NPOI.Util.Arrays.CopyOf(System.Byte[],System.Int32)">
  27205. <summary>
  27206. Copies the specified array, truncating or padding with zeros (if
  27207. necessary) so the copy has the specified length. This method is temporary
  27208. replace for Arrays.copyOf() until we start to require JDK 1.6.
  27209. </summary>
  27210. <param name="source">the array to be copied</param>
  27211. <param name="newLength">the length of the copy to be returned</param>
  27212. <returns>a copy of the original array, truncated or padded with zeros to obtain the specified length</returns>
  27213. </member>
  27214. <member name="M:NPOI.Util.Arrays.HashCode(System.Int64[])">
  27215. Returns a hash code based on the contents of the specified array.
  27216. For any two <tt>long</tt> arrays <tt>a</tt> and <tt>b</tt>
  27217. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27218. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27219. The value returned by this method is the same value that would be
  27220. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27221. method on a {@link List} Containing a sequence of {@link Long}
  27222. instances representing the elements of <tt>a</tt> in the same order.
  27223. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27224. @param a the array whose hash value to compute
  27225. @return a content-based hash code for <tt>a</tt>
  27226. @since 1.5
  27227. </member>
  27228. <member name="M:NPOI.Util.Arrays.HashCode(System.Int32[])">
  27229. Returns a hash code based on the contents of the specified array.
  27230. For any two non-null <tt>int</tt> arrays <tt>a</tt> and <tt>b</tt>
  27231. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27232. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27233. The value returned by this method is the same value that would be
  27234. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27235. method on a {@link List} Containing a sequence of {@link int}
  27236. instances representing the elements of <tt>a</tt> in the same order.
  27237. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27238. @param a the array whose hash value to compute
  27239. @return a content-based hash code for <tt>a</tt>
  27240. @since 1.5
  27241. </member>
  27242. <member name="M:NPOI.Util.Arrays.HashCode(System.Int16[])">
  27243. Returns a hash code based on the contents of the specified array.
  27244. For any two <tt>short</tt> arrays <tt>a</tt> and <tt>b</tt>
  27245. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27246. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27247. The value returned by this method is the same value that would be
  27248. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27249. method on a {@link List} Containing a sequence of {@link short}
  27250. instances representing the elements of <tt>a</tt> in the same order.
  27251. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27252. @param a the array whose hash value to compute
  27253. @return a content-based hash code for <tt>a</tt>
  27254. @since 1.5
  27255. </member>
  27256. <member name="M:NPOI.Util.Arrays.HashCode(System.Char[])">
  27257. Returns a hash code based on the contents of the specified array.
  27258. For any two <tt>char</tt> arrays <tt>a</tt> and <tt>b</tt>
  27259. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27260. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27261. The value returned by this method is the same value that would be
  27262. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27263. method on a {@link List} Containing a sequence of {@link Character}
  27264. instances representing the elements of <tt>a</tt> in the same order.
  27265. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27266. @param a the array whose hash value to compute
  27267. @return a content-based hash code for <tt>a</tt>
  27268. @since 1.5
  27269. </member>
  27270. <member name="M:NPOI.Util.Arrays.HashCode(System.Byte[])">
  27271. Returns a hash code based on the contents of the specified array.
  27272. For any two <tt>byte</tt> arrays <tt>a</tt> and <tt>b</tt>
  27273. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27274. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27275. The value returned by this method is the same value that would be
  27276. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27277. method on a {@link List} Containing a sequence of {@link Byte}
  27278. instances representing the elements of <tt>a</tt> in the same order.
  27279. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27280. @param a the array whose hash value to compute
  27281. @return a content-based hash code for <tt>a</tt>
  27282. @since 1.5
  27283. </member>
  27284. <member name="M:NPOI.Util.Arrays.HashCode(System.Boolean[])">
  27285. Returns a hash code based on the contents of the specified array.
  27286. For any two <tt>bool</tt> arrays <tt>a</tt> and <tt>b</tt>
  27287. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27288. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27289. The value returned by this method is the same value that would be
  27290. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27291. method on a {@link List} Containing a sequence of {@link Boolean}
  27292. instances representing the elements of <tt>a</tt> in the same order.
  27293. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27294. @param a the array whose hash value to compute
  27295. @return a content-based hash code for <tt>a</tt>
  27296. @since 1.5
  27297. </member>
  27298. <member name="M:NPOI.Util.Arrays.HashCode(System.Single[])">
  27299. Returns a hash code based on the contents of the specified array.
  27300. For any two <tt>float</tt> arrays <tt>a</tt> and <tt>b</tt>
  27301. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27302. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27303. The value returned by this method is the same value that would be
  27304. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27305. method on a {@link List} Containing a sequence of {@link Float}
  27306. instances representing the elements of <tt>a</tt> in the same order.
  27307. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27308. @param a the array whose hash value to compute
  27309. @return a content-based hash code for <tt>a</tt>
  27310. @since 1.5
  27311. </member>
  27312. <member name="M:NPOI.Util.Arrays.HashCode(System.Double[])">
  27313. Returns a hash code based on the contents of the specified array.
  27314. For any two <tt>double</tt> arrays <tt>a</tt> and <tt>b</tt>
  27315. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27316. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27317. The value returned by this method is the same value that would be
  27318. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27319. method on a {@link List} Containing a sequence of {@link Double}
  27320. instances representing the elements of <tt>a</tt> in the same order.
  27321. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27322. @param a the array whose hash value to compute
  27323. @return a content-based hash code for <tt>a</tt>
  27324. @since 1.5
  27325. </member>
  27326. <member name="M:NPOI.Util.Arrays.HashCode(System.Object[])">
  27327. Returns a hash code based on the contents of the specified array. If
  27328. the array Contains other arrays as elements, the hash code is based on
  27329. their identities rather than their contents. It is therefore
  27330. acceptable to invoke this method on an array that Contains itself as an
  27331. element, either directly or indirectly through one or more levels of
  27332. arrays.
  27333. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  27334. <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27335. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27336. The value returned by this method is equal to the value that would
  27337. be returned by <tt>Arrays.AsList(a).HashCode()</tt>, unless <tt>a</tt>
  27338. is <tt>null</tt>, in which case <tt>0</tt> is returned.
  27339. @param a the array whose content-based hash code to compute
  27340. @return a content-based hash code for <tt>a</tt>
  27341. @see #deepHashCode(Object[])
  27342. @since 1.5
  27343. </member>
  27344. <member name="M:NPOI.Util.Arrays.DeepHashCode(System.Object[])">
  27345. Returns a hash code based on the "deep contents" of the specified
  27346. array. If the array Contains other arrays as elements, the
  27347. hash code is based on their contents and so on, ad infInitum.
  27348. It is therefore unacceptable to invoke this method on an array that
  27349. Contains itself as an element, either directly or indirectly through
  27350. one or more levels of arrays. The behavior of such an invocation is
  27351. undefined.
  27352. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  27353. <tt>Arrays.DeepEquals(a, b)</tt>, it is also the case that
  27354. <tt>Arrays.DeepHashCode(a) == Arrays.DeepHashCode(b)</tt>.
  27355. The computation of the value returned by this method is similar to
  27356. that of the value returned by {@link List#hashCode()} on a list
  27357. Containing the same elements as <tt>a</tt> in the same order, with one
  27358. difference: If an element <tt>e</tt> of <tt>a</tt> is itself an array,
  27359. its hash code is computed not by calling <tt>e.HashCode()</tt>, but as
  27360. by calling the appropriate overloading of <tt>Arrays.HashCode(e)</tt>
  27361. if <tt>e</tt> is an array of a primitive type, or as by calling
  27362. <tt>Arrays.DeepHashCode(e)</tt> recursively if <tt>e</tt> is an array
  27363. of a reference type. If <tt>a</tt> is <tt>null</tt>, this method
  27364. returns 0.
  27365. @param a the array whose deep-content-based hash code to compute
  27366. @return a deep-content-based hash code for <tt>a</tt>
  27367. @see #hashCode(Object[])
  27368. @since 1.5
  27369. </member>
  27370. <member name="M:NPOI.Util.Arrays.DeepEquals(System.Object[],System.Object[])">
  27371. Returns <tt>true</tt> if the two specified arrays are <i>deeply
  27372. Equal</i> to one another. Unlike the {@link #Equals(Object[],Object[])}
  27373. method, this method is appropriate for use with nested arrays of
  27374. arbitrary depth.
  27375. Two array references are considered deeply equal if both
  27376. are <tt>null</tt>, or if they refer to arrays that contain the same
  27377. number of elements and all corresponding pairs of elements in the two
  27378. arrays are deeply Equal.
  27379. Two possibly <tt>null</tt> elements <tt>e1</tt> and <tt>e2</tt> are
  27380. deeply equal if any of the following conditions hold:
  27381. <ul>
  27382. <li> <tt>e1</tt> and <tt>e2</tt> are both arrays of object reference
  27383. types, and <tt>Arrays.DeepEquals(e1, e2) would return true</tt></li>
  27384. <li> <tt>e1</tt> and <tt>e2</tt> are arrays of the same primitive
  27385. type, and the appropriate overloading of
  27386. <tt>Arrays.Equals(e1, e2)</tt> would return true.</li>
  27387. <li> <tt>e1 == e2</tt></li>
  27388. <li> <tt>e1.Equals(e2)</tt> would return true.</li>
  27389. </ul>
  27390. Note that this defInition permits <tt>null</tt> elements at any depth.
  27391. If either of the specified arrays contain themselves as elements
  27392. either directly or indirectly through one or more levels of arrays,
  27393. the behavior of this method is undefined.
  27394. @param a1 one array to be tested for Equality
  27395. @param a2 the other array to be tested for Equality
  27396. @return <tt>true</tt> if the two arrays are equal
  27397. @see #Equals(Object[],Object[])
  27398. @see Objects#deepEquals(Object, Object)
  27399. @since 1.5
  27400. </member>
  27401. <member name="M:NPOI.Util.Arrays.ToString(System.Int64[])">
  27402. Returns a string representation of the contents of the specified array.
  27403. The string representation consists of a list of the array's elements,
  27404. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27405. Separated by the characters <tt>", "</tt> (a comma followed by a
  27406. space). Elements are Converted to strings as by
  27407. <tt>String.ValueOf(long)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27408. is <tt>null</tt>.
  27409. @param a the array whose string representation to return
  27410. @return a string representation of <tt>a</tt>
  27411. @since 1.5
  27412. </member>
  27413. <member name="M:NPOI.Util.Arrays.ToString(System.Int32[])">
  27414. Returns a string representation of the contents of the specified array.
  27415. The string representation consists of a list of the array's elements,
  27416. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27417. Separated by the characters <tt>", "</tt> (a comma followed by a
  27418. space). Elements are Converted to strings as by
  27419. <tt>String.ValueOf(int)</tt>. Returns <tt>"null"</tt> if <tt>a</tt> is
  27420. <tt>null</tt>.
  27421. @param a the array whose string representation to return
  27422. @return a string representation of <tt>a</tt>
  27423. @since 1.5
  27424. </member>
  27425. <member name="M:NPOI.Util.Arrays.ToString(System.Int16[])">
  27426. Returns a string representation of the contents of the specified array.
  27427. The string representation consists of a list of the array's elements,
  27428. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27429. Separated by the characters <tt>", "</tt> (a comma followed by a
  27430. space). Elements are Converted to strings as by
  27431. <tt>String.ValueOf(short)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27432. is <tt>null</tt>.
  27433. @param a the array whose string representation to return
  27434. @return a string representation of <tt>a</tt>
  27435. @since 1.5
  27436. </member>
  27437. <member name="M:NPOI.Util.Arrays.ToString(System.Char[])">
  27438. Returns a string representation of the contents of the specified array.
  27439. The string representation consists of a list of the array's elements,
  27440. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27441. Separated by the characters <tt>", "</tt> (a comma followed by a
  27442. space). Elements are Converted to strings as by
  27443. <tt>String.ValueOf(char)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27444. is <tt>null</tt>.
  27445. @param a the array whose string representation to return
  27446. @return a string representation of <tt>a</tt>
  27447. @since 1.5
  27448. </member>
  27449. <member name="M:NPOI.Util.Arrays.ToString(System.Byte[])">
  27450. Returns a string representation of the contents of the specified array.
  27451. The string representation consists of a list of the array's elements,
  27452. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements
  27453. are Separated by the characters <tt>", "</tt> (a comma followed
  27454. by a space). Elements are Converted to strings as by
  27455. <tt>String.ValueOf(byte)</tt>. Returns <tt>"null"</tt> if
  27456. <tt>a</tt> is <tt>null</tt>.
  27457. @param a the array whose string representation to return
  27458. @return a string representation of <tt>a</tt>
  27459. @since 1.5
  27460. </member>
  27461. <member name="M:NPOI.Util.Arrays.ToString(System.Boolean[])">
  27462. Returns a string representation of the contents of the specified array.
  27463. The string representation consists of a list of the array's elements,
  27464. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27465. Separated by the characters <tt>", "</tt> (a comma followed by a
  27466. space). Elements are Converted to strings as by
  27467. <tt>String.ValueOf(bool)</tt>. Returns <tt>"null"</tt> if
  27468. <tt>a</tt> is <tt>null</tt>.
  27469. @param a the array whose string representation to return
  27470. @return a string representation of <tt>a</tt>
  27471. @since 1.5
  27472. </member>
  27473. <member name="M:NPOI.Util.Arrays.ToString(System.Single[])">
  27474. Returns a string representation of the contents of the specified array.
  27475. The string representation consists of a list of the array's elements,
  27476. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27477. Separated by the characters <tt>", "</tt> (a comma followed by a
  27478. space). Elements are Converted to strings as by
  27479. <tt>String.ValueOf(float)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27480. is <tt>null</tt>.
  27481. @param a the array whose string representation to return
  27482. @return a string representation of <tt>a</tt>
  27483. @since 1.5
  27484. </member>
  27485. <member name="M:NPOI.Util.Arrays.ToString(System.Double[])">
  27486. Returns a string representation of the contents of the specified array.
  27487. The string representation consists of a list of the array's elements,
  27488. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27489. Separated by the characters <tt>", "</tt> (a comma followed by a
  27490. space). Elements are Converted to strings as by
  27491. <tt>String.ValueOf(double)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27492. is <tt>null</tt>.
  27493. @param a the array whose string representation to return
  27494. @return a string representation of <tt>a</tt>
  27495. @since 1.5
  27496. </member>
  27497. <member name="M:NPOI.Util.Arrays.DeepToString(System.Object[])">
  27498. Returns a string representation of the "deep contents" of the specified
  27499. array. If the array Contains other arrays as elements, the string
  27500. representation Contains their contents and so on. This method is
  27501. designed for Converting multidimensional arrays to strings.
  27502. The string representation consists of a list of the array's
  27503. elements, enclosed in square brackets (<tt>"[]"</tt>). Adjacent
  27504. elements are Separated by the characters <tt>", "</tt> (a comma
  27505. followed by a space). Elements are Converted to strings as by
  27506. <tt>String.ValueOf(Object)</tt>, unless they are themselves
  27507. arrays.
  27508. If an element <tt>e</tt> is an array of a primitive type, it is
  27509. Converted to a string as by invoking the appropriate overloading of
  27510. <tt>Arrays.ToString(e)</tt>. If an element <tt>e</tt> is an array of a
  27511. reference type, it is Converted to a string as by invoking
  27512. this method recursively.
  27513. To avoid infInite recursion, if the specified array Contains itself
  27514. as an element, or Contains an indirect reference to itself through one
  27515. or more levels of arrays, the self-reference is Converted to the string
  27516. <tt>"[...]"</tt>. For example, an array Containing only a reference
  27517. to itself would be rendered as <tt>"[[...]]"</tt>.
  27518. This method returns <tt>"null"</tt> if the specified array
  27519. is <tt>null</tt>.
  27520. @param a the array whose string representation to return
  27521. @return a string representation of <tt>a</tt>
  27522. @see #ToString(Object[])
  27523. @since 1.5
  27524. </member>
  27525. <member name="M:NPOI.Util.Arrays.ToString(System.Object[])">
  27526. Returns a string representation of the contents of the specified array.
  27527. If the array contains other arrays as elements, they are converted to
  27528. strings by the {@link Object#toString} method inherited from
  27529. <tt>Object</tt>, which describes their <i>identities</i> rather than
  27530. their contents.
  27531. <p>The value returned by this method is equal to the value that would
  27532. be returned by <tt>Arrays.asList(a).toString()</tt>, unless <tt>a</tt>
  27533. is <tt>null</tt>, in which case <tt>"null"</tt> is returned.</p>
  27534. @param a the array whose string representation to return
  27535. @return a string representation of <tt>a</tt>
  27536. @see #deepToString(Object[])
  27537. @since 1.5
  27538. </member>
  27539. <member name="F:NPOI.Util.BigInteger._signum">
  27540. The signum of this BigInteger: -1 for negative, 0 for zero, or
  27541. 1 for positive. Note that the BigInteger zero <i>must</i> have
  27542. a signum of 0. This is necessary to ensures that there is exactly one
  27543. representation for each BigInteger value.
  27544. @serial
  27545. </member>
  27546. <member name="F:NPOI.Util.BigInteger.mag">
  27547. The magnitude of this BigInteger, in <i>big-endian</i> order: the
  27548. zeroth element of this array is the most-significant int of the
  27549. magnitude. The magnitude must be "minimal" in that the most-significant
  27550. int ({@code mag[0]}) must be non-zero. This is necessary to
  27551. ensure that there is exactly one representation for each BigInteger
  27552. value. Note that this implies that the BigInteger zero has a
  27553. zero-length mag array.
  27554. </member>
  27555. <member name="F:NPOI.Util.BigInteger.bitCount">
  27556. One plus the bitCount of this BigInteger. Zeros means unitialized.
  27557. @serial
  27558. @see #bitCount
  27559. @deprecated Deprecated since logical value is offset from stored
  27560. value and correction factor is applied in accessor method.
  27561. </member>
  27562. <member name="F:NPOI.Util.BigInteger.bitLength">
  27563. One plus the bitLength of this BigInteger. Zeros means unitialized.
  27564. (either value is acceptable).
  27565. @serial
  27566. @see #bitLength()
  27567. @deprecated Deprecated since logical value is offset from stored
  27568. value and correction factor is applied in accessor method.
  27569. </member>
  27570. <member name="F:NPOI.Util.BigInteger.firstNonzeroIntNum">
  27571. Two plus the index of the lowest-order int in the magnitude of this
  27572. BigInteger that contains a nonzero int, or -2 (either value is acceptable).
  27573. The least significant int has int-number 0, the next int in order of
  27574. increasing significance has int-number 1, and so forth.
  27575. @deprecated Deprecated since logical value is offset from stored
  27576. value and correction factor is applied in accessor method.
  27577. </member>
  27578. <member name="F:NPOI.Util.BigInteger.LONG_MASK">
  27579. This mask is used to obtain the value of an int as if it were unsigned.
  27580. </member>
  27581. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[],System.Int32)">
  27582. This internal constructor differs from its public cousin
  27583. with the arguments reversed in two ways: it assumes that its
  27584. arguments are correct, and it doesn't copy the magnitude array.
  27585. </member>
  27586. <member name="M:NPOI.Util.BigInteger.#ctor(System.Byte[])">
  27587. Translates a byte array containing the two's-complement binary
  27588. representation of a BigInteger into a BigInteger. The input array is
  27589. assumed to be in <i>big-endian</i> byte-order: the most significant
  27590. byte is in the zeroth element.
  27591. @param val big-endian two's-complement binary representation of
  27592. BigInteger.
  27593. @throws NumberFormatException {@code val} is zero bytes long.
  27594. </member>
  27595. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[])">
  27596. This private constructor translates an int array containing the
  27597. two's-complement binary representation of a BigInteger into a
  27598. BigInteger. The input array is assumed to be in <i>big-endian</i>
  27599. int-order: the most significant int is in the zeroth element.
  27600. </member>
  27601. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int64)">
  27602. Constructs a BigInteger with the specified value, which may not be zero.
  27603. </member>
  27604. <member name="M:NPOI.Util.BigInteger.TrustedStripLeadingZeroInts(System.Int32[])">
  27605. Returns the input array stripped of any leading zero bytes.
  27606. Since the source is trusted the copying may be skipped.
  27607. </member>
  27608. <member name="M:NPOI.Util.BigInteger.ToString(System.Int32)">
  27609. Returns the String representation of this BigInteger in the
  27610. given radix. If the radix is outside the range from {@link
  27611. Character#Min_RADIX} to {@link Character#Max_RADIX} inclusive,
  27612. it will default to 10 (as is the case for
  27613. {@code Integer.toString}). The digit-to-character mapping
  27614. provided by {@code Character.forDigit} is used, and a minus
  27615. sign is prepended if appropriate. (This representation is
  27616. compatible with the {@link #BigInteger(String, int) (String,
  27617. int)} constructor.)
  27618. @param radix radix of the String representation.
  27619. @return String representation of this BigInteger in the given radix.
  27620. @see Integer#toString
  27621. @see Character#forDigit
  27622. @see #BigInteger(java.lang.String, int)
  27623. </member>
  27624. <member name="F:NPOI.Util.BigInteger.ZERO">
  27625. The BigInteger constant zero.
  27626. @since 1.2
  27627. </member>
  27628. <member name="F:NPOI.Util.BigInteger.One">
  27629. The BigInteger constant one.
  27630. @since 1.2
  27631. </member>
  27632. <member name="F:NPOI.Util.BigInteger.Two">
  27633. The BigInteger constant two. (Not exported.)
  27634. </member>
  27635. <member name="F:NPOI.Util.BigInteger.TEN">
  27636. The BigInteger constant ten.
  27637. @since 1.5
  27638. </member>
  27639. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int64)">
  27640. Returns a BigInteger whose value is equal to that of the
  27641. specified {@code long}. This "static factory method" is
  27642. provided in preference to a ({@code long}) constructor
  27643. because it allows for reuse of frequently used BigIntegers.
  27644. @param val value of the BigInteger to return.
  27645. @return a BigInteger with the specified value.
  27646. </member>
  27647. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int32[])">
  27648. Returns a BigInteger with the given two's complement representation.
  27649. Assumes that the input array will not be modified (the returned
  27650. BigInteger will reference the input array if feasible).
  27651. </member>
  27652. <member name="M:NPOI.Util.BigInteger.BitLengthForInt(System.Int32)">
  27653. Package private method to return bit length for an integer.
  27654. </member>
  27655. <member name="M:NPOI.Util.BigInteger.BitCount">
  27656. Returns the number of bits in the two's complement representation
  27657. of this BigInteger that differ from its sign bit. This method is
  27658. useful when implementing bit-vector style sets atop BigIntegers.
  27659. @return number of bits in the two's complement representation
  27660. of this BigInteger that differ from its sign bit.
  27661. </member>
  27662. <member name="M:NPOI.Util.BigInteger.Abs">
  27663. Returns a BigInteger whose value is the absolute value of this
  27664. BigInteger.
  27665. @return {@code abs(this)}
  27666. </member>
  27667. <member name="M:NPOI.Util.BigInteger.Negate">
  27668. Returns a BigInteger whose value is {@code (-this)}.
  27669. @return {@code -this}
  27670. </member>
  27671. <member name="M:NPOI.Util.BigInteger.Pow(System.Int32)">
  27672. Returns a BigInteger whose value is <c>(this<sup>exponent</sup>)</c>.
  27673. Note that {@code exponent} is an integer rather than a BigInteger.
  27674. @param exponent exponent to which this BigInteger is to be raised.
  27675. @return <c>this<sup>exponent</sup></c>
  27676. @throws ArithmeticException {@code exponent} is negative. (This would
  27677. cause the operation to yield a non-integer value.)
  27678. </member>
  27679. <member name="M:NPOI.Util.BigInteger.MultiplyToLen(System.Int32[],System.Int32,System.Int32[],System.Int32,System.Int32[])">
  27680. Multiplies int arrays x and y to the specified lengths and places
  27681. the result into z. There will be no leading zeros in the resultant array.
  27682. </member>
  27683. <member name="M:NPOI.Util.BigInteger.mulAdd(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  27684. Multiply an array by one word k and add to result, return the carry
  27685. </member>
  27686. <member name="M:NPOI.Util.BigInteger.squareToLen(System.Int32[],System.Int32,System.Int32[])">
  27687. Squares the contents of the int array x. The result is placed into the
  27688. int array z. The contents of x are not changed.
  27689. </member>
  27690. <member name="M:NPOI.Util.BigInteger.addOne(System.Int32[],System.Int32,System.Int32,System.Int32)">
  27691. Add one word to the number a mlen words into a. Return the resulting
  27692. carry.
  27693. </member>
  27694. <member name="M:NPOI.Util.BigInteger.Signum">
  27695. Returns the signum function of this BigInteger.
  27696. @return -1, 0 or 1 as the value of this BigInteger is negative, zero or
  27697. positive.
  27698. </member>
  27699. <member name="M:NPOI.Util.BigInteger.ToByteArray">
  27700. Returns a byte array containing the two's-complement
  27701. representation of this BigInteger. The byte array will be in
  27702. <i>big-endian</i> byte-order: the most significant byte is in
  27703. the zeroth element. The array will contain the minimum number
  27704. of bytes required to represent this BigInteger, including at
  27705. least one sign bit, which is {@code (ceil((this.bitLength() +
  27706. 1)/8))}. (This representation is compatible with the
  27707. {@link #BigInteger(byte[]) (byte[])} constructor.)
  27708. @return a byte array containing the two's-complement representation of
  27709. this BigInteger.
  27710. @see #BigInteger(byte[])
  27711. </member>
  27712. <member name="M:NPOI.Util.BigInteger.intLength">
  27713. Returns the length of the two's complement representation in ints,
  27714. including space for at least one sign bit.
  27715. </member>
  27716. <member name="M:NPOI.Util.BigInteger.GetInt(System.Int32)">
  27717. Returns the specified int of the little-endian two's complement
  27718. representation (int 0 is the least significant). The int number can
  27719. be arbitrarily high (values are logically preceded by infinitely many
  27720. sign ints).
  27721. </member>
  27722. <member name="M:NPOI.Util.BigInteger.FirstNonzeroIntNum">
  27723. Returns the index of the int that contains the first nonzero int in the
  27724. little-endian binary representation of the magnitude (int 0 is the
  27725. least significant). If the magnitude is zero, return value is undefined.
  27726. </member>
  27727. <member name="M:NPOI.Util.BigInteger.stripLeadingZeroBytes(System.Byte[])">
  27728. Returns a copy of the input array stripped of any leading zero bytes.
  27729. </member>
  27730. <member name="M:NPOI.Util.BigInteger.makePositive(System.Byte[])">
  27731. Takes an array a representing a negative 2's-complement number and
  27732. returns the minimal (no leading zero bytes) unsigned whose value is -a.
  27733. </member>
  27734. <member name="M:NPOI.Util.BigInteger.makePositive(System.Int32[])">
  27735. Takes an array a representing a negative 2's-complement number and
  27736. returns the minimal (no leading zero ints) unsigned whose value is -a.
  27737. </member>
  27738. <member name="M:NPOI.Util.BigInteger.NumberOfLeadingZeros(System.Int32)">
  27739. Returns the number of zero bits preceding the highest-order
  27740. ("leftmost") one-bit in the two's complement binary representation
  27741. of the specified {@code int} value. Returns 32 if the
  27742. specified value has no one-bits in its two's complement representation,
  27743. in other words if it is equal to zero.
  27744. Note that this method is closely related to the logarithm base 2.
  27745. For all positive {@code int} values x:
  27746. <ul>
  27747. <li>floor(log<sub>2</sub>(x)) = {@code 31 - numberOfLeadingZeros(x)}</li>
  27748. <li>ceil(log<sub>2</sub>(x)) = {@code 32 - numberOfLeadingZeros(x - 1)}</li>
  27749. </ul>
  27750. @return the number of zero bits preceding the highest-order
  27751. ("leftmost") one-bit in the two's complement binary representation
  27752. of the specified {@code int} value, or 32 if the value
  27753. is equal to zero.
  27754. @since 1.5
  27755. </member>
  27756. <member name="M:NPOI.Util.BigInteger.NumberOfTrailingZeros(System.Int32)">
  27757. Returns the number of zero bits following the lowest-order ("rightmost")
  27758. one-bit in the two's complement binary representation of the specified
  27759. {@code int} value. Returns 32 if the specified value has no
  27760. one-bits in its two's complement representation, in other words if it is
  27761. equal to zero.
  27762. @return the number of zero bits following the lowest-order ("rightmost")
  27763. one-bit in the two's complement binary representation of the
  27764. specified {@code int} value, or 32 if the value is equal
  27765. to zero.
  27766. @since 1.5
  27767. </member>
  27768. <member name="M:NPOI.Util.BigInteger.BitCountForInt(System.Int32)">
  27769. Returns the number of one-bits in the two's complement binary
  27770. representation of the specified {@code int} value. This function is
  27771. sometimes referred to as the <i>population count</i>.
  27772. @return the number of one-bits in the two's complement binary
  27773. representation of the specified {@code int} value.
  27774. @since 1.5
  27775. </member>
  27776. <member name="M:NPOI.Util.BigInteger.compareMagnitude(NPOI.Util.BigInteger)">
  27777. Compares the magnitude array of this BigInteger with the specified
  27778. BigInteger's. This is the version of compareTo ignoring sign.
  27779. @param val BigInteger whose magnitude array to be compared.
  27780. @return -1, 0 or 1 as this magnitude array is less than, equal to or
  27781. greater than the magnitude aray for the specified BigInteger's.
  27782. </member>
  27783. <member name="M:NPOI.Util.BigInteger.Equals(System.Object)">
  27784. Compares this BigInteger with the specified Object for equality.
  27785. @param x Object to which this BigInteger is to be compared.
  27786. @return {@code true} if and only if the specified Object is a
  27787. BigInteger whose value is numerically equal to this BigInteger.
  27788. </member>
  27789. <member name="M:NPOI.Util.BigInteger.Min(NPOI.Util.BigInteger)">
  27790. Returns the minimum of this BigInteger and {@code val}.
  27791. @param val value with which the minimum is to be computed.
  27792. @return the BigInteger whose value is the lesser of this BigInteger and
  27793. {@code val}. If they are equal, either may be returned.
  27794. </member>
  27795. <member name="M:NPOI.Util.BigInteger.Max(NPOI.Util.BigInteger)">
  27796. Returns the maximum of this BigInteger and {@code val}.
  27797. @param val value with which the maximum is to be computed.
  27798. @return the BigInteger whose value is the greater of this and
  27799. {@code val}. If they are equal, either may be returned.
  27800. </member>
  27801. <member name="M:NPOI.Util.BigInteger.GetHashCode">
  27802. Returns the hash code for this BigInteger.
  27803. @return hash code for this BigInteger.
  27804. </member>
  27805. <member name="M:NPOI.Util.BigInteger.IntValue">
  27806. Converts this BigInteger to an {@code int}. This
  27807. conversion is analogous to a
  27808. <i>narrowing primitive conversion</i> from {@code long} to
  27809. {@code int} as defined in section 5.1.3 of
  27810. <cite>The Java(TM) Language Specification</cite>:
  27811. if this BigInteger is too big to fit in an
  27812. {@code int}, only the low-order 32 bits are returned.
  27813. Note that this conversion can lose information about the
  27814. overall magnitude of the BigInteger value as well as return a
  27815. result with the opposite sign.
  27816. @return this BigInteger converted to an {@code int}.
  27817. </member>
  27818. <member name="M:NPOI.Util.BigInteger.LongValue">
  27819. Converts this BigInteger to a {@code long}. This
  27820. conversion is analogous to a
  27821. <i>narrowing primitive conversion</i> from {@code long} to
  27822. {@code int} as defined in section 5.1.3 of
  27823. <cite>The Java(TM) Language Specification</cite>:
  27824. if this BigInteger is too big to fit in a
  27825. {@code long}, only the low-order 64 bits are returned.
  27826. Note that this conversion can lose information about the
  27827. overall magnitude of the BigInteger value as well as return a
  27828. result with the opposite sign.
  27829. @return this BigInteger converted to a {@code long}.
  27830. </member>
  27831. <member name="M:NPOI.Util.BigInteger.ShiftRight(System.Int32)">
  27832. Returns a BigInteger whose value is {@code (this >> n)}. Sign
  27833. extension is performed. The shift distance, {@code n}, may be
  27834. negative, in which case this method performs a left shift.
  27835. (Computes <c>floor(this / 2<sup>n</sup>)</c>.)
  27836. @param n shift distance, in bits.
  27837. @return {@code this >> n}
  27838. @throws ArithmeticException if the shift distance is {@code
  27839. Integer.Min_VALUE}.
  27840. @see #shiftLeft
  27841. </member>
  27842. <member name="M:NPOI.Util.BigInteger.Not">
  27843. Returns a BigInteger whose value is {@code (~this)}. (This method
  27844. returns a negative value if and only if this BigInteger is
  27845. non-negative.)
  27846. @return {@code ~this}
  27847. </member>
  27848. <member name="M:NPOI.Util.BigInteger.Or(NPOI.Util.BigInteger)">
  27849. Returns a BigInteger whose value is {@code (this | val)}. (This method
  27850. returns a negative BigInteger if and only if either this or val is
  27851. negative.)
  27852. @param val value to be OR'ed with this BigInteger.
  27853. @return {@code this | val}
  27854. </member>
  27855. <member name="M:NPOI.Util.BigInteger.Multiply(System.Int64)">
  27856. Package private methods used by BigDecimal code to multiply a BigInteger
  27857. with a long. Assumes v is not equal to INFLATED.
  27858. </member>
  27859. <member name="M:NPOI.Util.BigInteger.Multiply(NPOI.Util.BigInteger)">
  27860. Returns a BigInteger whose value is {@code (this * val)}.
  27861. @param val value to be multiplied by this BigInteger.
  27862. @return {@code this * val}
  27863. </member>
  27864. <member name="M:NPOI.Util.BigInteger.Add(NPOI.Util.BigInteger)">
  27865. Returns a BigInteger whose value is {@code (this + val)}.
  27866. @param val value to be added to this BigInteger.
  27867. @return {@code this + val}
  27868. </member>
  27869. <member name="M:NPOI.Util.BigInteger.add(System.Int32[],System.Int32[])">
  27870. Adds the contents of the int arrays x and y. This method allocates
  27871. a new int array to hold the answer and returns a reference to that
  27872. array.
  27873. </member>
  27874. <member name="M:NPOI.Util.BigInteger.Subtract(NPOI.Util.BigInteger)">
  27875. Returns a BigInteger whose value is {@code (this - val)}.
  27876. @param val value to be subtracted from this BigInteger.
  27877. @return {@code this - val}
  27878. </member>
  27879. <member name="M:NPOI.Util.BigInteger.Subtract(System.Int32[],System.Int32[])">
  27880. Subtracts the contents of the second int arrays (little) from the
  27881. first (big). The first int array (big) must represent a larger number
  27882. than the second. This method allocates the space necessary to hold the
  27883. answer.
  27884. </member>
  27885. <member name="M:NPOI.Util.BigInteger.Divide(NPOI.Util.BigInteger)">
  27886. Returns a BigInteger whose value is {@code (this / val)}.
  27887. @param val value by which this BigInteger is to be divided.
  27888. @return {@code this / val}
  27889. @throws ArithmeticException if {@code val} is zero.
  27890. </member>
  27891. <member name="F:NPOI.Util.MutableBigInteger._value">
  27892. Holds the magnitude of this MutableBigInteger in big endian order.
  27893. The magnitude may start at an offset into the value array, and it may
  27894. end before the length of the value array.
  27895. </member>
  27896. <member name="F:NPOI.Util.MutableBigInteger.intLen">
  27897. The number of ints of the value array that are currently used
  27898. to hold the magnitude of this MutableBigInteger. The magnitude starts
  27899. at an offset and offset + intLen may be less than value.Length.
  27900. </member>
  27901. <member name="F:NPOI.Util.MutableBigInteger.offset">
  27902. The offset into the value array where the magnitude of this
  27903. MutableBigInteger begins.
  27904. </member>
  27905. <member name="F:NPOI.Util.MutableBigInteger.One">
  27906. MutableBigInteger with one element value array with the value 1. Used by
  27907. BigDecimal divideAndRound to increment the quotient. Use this constant
  27908. only when the method is not going to modify this object.
  27909. </member>
  27910. <member name="M:NPOI.Util.MutableBigInteger.#ctor">
  27911. The default constructor. An empty MutableBigInteger is created with
  27912. a one word capacity.
  27913. </member>
  27914. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32)">
  27915. Construct a new MutableBigInteger with a magnitude specified by
  27916. the int val.
  27917. </member>
  27918. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32[])">
  27919. Construct a new MutableBigInteger with the specified value array
  27920. up to the length of the array supplied.
  27921. </member>
  27922. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.BigInteger)">
  27923. Construct a new MutableBigInteger with a magnitude equal to the
  27924. specified BigInteger.
  27925. </member>
  27926. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.MutableBigInteger)">
  27927. Construct a new MutableBigInteger with a magnitude equal to the
  27928. specified MutableBigInteger.
  27929. </member>
  27930. <member name="M:NPOI.Util.MutableBigInteger.getMagnitudeArray">
  27931. Internal helper method to return the magnitude array. The caller is not
  27932. supposed to modify the returned array.
  27933. </member>
  27934. <member name="M:NPOI.Util.MutableBigInteger.toLong">
  27935. Convert this MutableBigInteger to a long value. The caller has to make
  27936. sure this MutableBigInteger can be fit into long.
  27937. </member>
  27938. <member name="M:NPOI.Util.MutableBigInteger.toBigInteger(System.Int32)">
  27939. Convert this MutableBigInteger to a BigInteger object.
  27940. </member>
  27941. <member name="M:NPOI.Util.MutableBigInteger.clear">
  27942. Clear out a MutableBigInteger for reuse.
  27943. </member>
  27944. <member name="M:NPOI.Util.MutableBigInteger.reset">
  27945. Set a MutableBigInteger to zero, removing its offset.
  27946. </member>
  27947. <member name="M:NPOI.Util.MutableBigInteger.compare(NPOI.Util.MutableBigInteger)">
  27948. Compare the magnitude of two MutableBigIntegers. Returns -1, 0 or 1
  27949. as this MutableBigInteger is numerically less than, equal to, or
  27950. greater than <c>b</c>.
  27951. </member>
  27952. <member name="M:NPOI.Util.MutableBigInteger.compareHalf(NPOI.Util.MutableBigInteger)">
  27953. Compare this against half of a MutableBigInteger object (Needed for
  27954. remainder tests).
  27955. Assumes no leading unnecessary zeros, which holds for results
  27956. from divide().
  27957. </member>
  27958. <member name="M:NPOI.Util.MutableBigInteger.getLowestSetBit">
  27959. Return the index of the lowest set bit in this MutableBigInteger. If the
  27960. magnitude of this MutableBigInteger is zero, -1 is returned.
  27961. </member>
  27962. <member name="M:NPOI.Util.MutableBigInteger.getInt(System.Int32)">
  27963. Return the int in use in this MutableBigInteger at the specified
  27964. index. This method is not used because it is not inlined on all
  27965. platforms.
  27966. </member>
  27967. <member name="M:NPOI.Util.MutableBigInteger.getLong(System.Int32)">
  27968. Return a long which is equal to the unsigned value of the int in
  27969. use in this MutableBigInteger at the specified index. This method is
  27970. not used because it is not inlined on all platforms.
  27971. </member>
  27972. <member name="M:NPOI.Util.MutableBigInteger.normalize">
  27973. Ensure that the MutableBigInteger is in normal form, specifically
  27974. making sure that there are no leading zeros, and that if the
  27975. magnitude is zero, then intLen is zero.
  27976. </member>
  27977. <member name="M:NPOI.Util.MutableBigInteger.ensureCapacity(System.Int32)">
  27978. If this MutableBigInteger cannot hold len words, increase the size
  27979. of the value array to len words.
  27980. </member>
  27981. <member name="M:NPOI.Util.MutableBigInteger.toIntArray">
  27982. Convert this MutableBigInteger into an int array with no leading
  27983. zeros, of a length that is equal to this MutableBigInteger's intLen.
  27984. </member>
  27985. <member name="M:NPOI.Util.MutableBigInteger.setInt(System.Int32,System.Int32)">
  27986. Sets the int at index+offset in this MutableBigInteger to val.
  27987. This does not get inlined on all platforms so it is not used
  27988. as often as originally intended.
  27989. </member>
  27990. <member name="M:NPOI.Util.MutableBigInteger.setValue(System.Int32[],System.Int32)">
  27991. Sets this MutableBigInteger's value array to the specified array.
  27992. The intLen is set to the specified length.
  27993. </member>
  27994. <member name="M:NPOI.Util.MutableBigInteger.copyValue(NPOI.Util.MutableBigInteger)">
  27995. Sets this MutableBigInteger's value array to a copy of the specified
  27996. array. The intLen is set to the length of the new array.
  27997. </member>
  27998. <member name="M:NPOI.Util.MutableBigInteger.copyValue(System.Int32[])">
  27999. Sets this MutableBigInteger's value array to a copy of the specified
  28000. array. The intLen is set to the length of the specified array.
  28001. </member>
  28002. <member name="M:NPOI.Util.MutableBigInteger.isOne">
  28003. Returns true iff this MutableBigInteger has a value of one.
  28004. </member>
  28005. <member name="M:NPOI.Util.MutableBigInteger.isZero">
  28006. Returns true iff this MutableBigInteger has a value of zero.
  28007. </member>
  28008. <member name="M:NPOI.Util.MutableBigInteger.isEven">
  28009. Returns true iff this MutableBigInteger is even.
  28010. </member>
  28011. <member name="M:NPOI.Util.MutableBigInteger.isOdd">
  28012. Returns true iff this MutableBigInteger is odd.
  28013. </member>
  28014. <member name="M:NPOI.Util.MutableBigInteger.isNormal">
  28015. Returns true iff this MutableBigInteger is in normal form. A
  28016. MutableBigInteger is in normal form if it has no leading zeros
  28017. after the offset, and intLen + offset &lt;= value.Length.
  28018. </member>
  28019. <member name="M:NPOI.Util.MutableBigInteger.toString">
  28020. Returns a String representation of this MutableBigInteger in radix 10.
  28021. </member>
  28022. <member name="M:NPOI.Util.MutableBigInteger.rightShift(System.Int32)">
  28023. Right shift this MutableBigInteger n bits. The MutableBigInteger is left
  28024. in normal form.
  28025. </member>
  28026. <member name="M:NPOI.Util.MutableBigInteger.leftShift(System.Int32)">
  28027. Left shift this MutableBigInteger n bits.
  28028. </member>
  28029. <member name="M:NPOI.Util.MutableBigInteger.divadd(System.Int32[],System.Int32[],System.Int32)">
  28030. A primitive used for division. This method adds in one multiple of the
  28031. divisor a back to the dividend result at a specified offset. It is used
  28032. when qhat was estimated too large, and must be adjusted.
  28033. </member>
  28034. <member name="M:NPOI.Util.MutableBigInteger.mulsub(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  28035. This method is used for division. It multiplies an n word input a by one
  28036. word input x, and subtracts the n word product from q. This is needed
  28037. when subtracting qhat*divisor from dividend.
  28038. </member>
  28039. <member name="M:NPOI.Util.MutableBigInteger.primitiveRightShift(System.Int32)">
  28040. Right shift this MutableBigInteger n bits, where n is
  28041. less than 32.
  28042. Assumes that intLen > 0, n > 0 for speed
  28043. </member>
  28044. <member name="M:NPOI.Util.MutableBigInteger.primitiveLeftShift(System.Int32)">
  28045. Left shift this MutableBigInteger n bits, where n is
  28046. less than 32.
  28047. Assumes that intLen > 0, n > 0 for speed
  28048. </member>
  28049. <member name="M:NPOI.Util.MutableBigInteger.add(NPOI.Util.MutableBigInteger)">
  28050. Adds the contents of two MutableBigInteger objects.The result
  28051. is placed within this MutableBigInteger.
  28052. The contents of the addend are not changed.
  28053. </member>
  28054. <member name="M:NPOI.Util.MutableBigInteger.subtract(NPOI.Util.MutableBigInteger)">
  28055. Subtracts the smaller of this and b from the larger and places the
  28056. result into this MutableBigInteger.
  28057. </member>
  28058. <member name="M:NPOI.Util.MutableBigInteger.difference(NPOI.Util.MutableBigInteger)">
  28059. Subtracts the smaller of a and b from the larger and places the result
  28060. into the larger. Returns 1 if the answer is in a, -1 if in b, 0 if no
  28061. operation was performed.
  28062. </member>
  28063. <member name="M:NPOI.Util.MutableBigInteger.multiply(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  28064. Multiply the contents of two MutableBigInteger objects. The result is
  28065. placed into MutableBigInteger z. The contents of y are not changed.
  28066. </member>
  28067. <member name="M:NPOI.Util.MutableBigInteger.mul(System.Int32,NPOI.Util.MutableBigInteger)">
  28068. Multiply the contents of this MutableBigInteger by the word y. The
  28069. result is placed into z.
  28070. </member>
  28071. <member name="M:NPOI.Util.MutableBigInteger.divideOneWord(System.Int32,NPOI.Util.MutableBigInteger)">
  28072. This method is used for division of an n word dividend by a one word
  28073. divisor. The quotient is placed into quotient. The one word divisor is
  28074. specified by divisor.
  28075. @return the remainder of the division is returned.
  28076. </member>
  28077. <member name="M:NPOI.Util.MutableBigInteger.divide(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  28078. Calculates the quotient of this div b and places the quotient in the
  28079. provided MutableBigInteger objects and the remainder object is returned.
  28080. Uses Algorithm D in Knuth section 4.3.1.
  28081. Many optimizations to that algorithm have been adapted from the Colin
  28082. Plumb C library.
  28083. It special cases one word divisors for speed. The content of b is not
  28084. changed.
  28085. </member>
  28086. <member name="M:NPOI.Util.MutableBigInteger.divide(System.Int64,NPOI.Util.MutableBigInteger)">
  28087. Internally used to calculate the quotient of this div v and places the
  28088. quotient in the provided MutableBigInteger object and the remainder is
  28089. returned.
  28090. @return the remainder of the division will be returned.
  28091. </member>
  28092. <member name="M:NPOI.Util.MutableBigInteger.divideMagnitude(System.Int32[],NPOI.Util.MutableBigInteger)">
  28093. Divide this MutableBigInteger by the divisor represented by its magnitude
  28094. array. The quotient will be placed into the provided quotient object &amp;
  28095. the remainder object is returned.
  28096. </member>
  28097. <member name="M:NPOI.Util.MutableBigInteger.unsignedLongCompare(System.Int64,System.Int64)">
  28098. Compare two longs as if they were unsigned.
  28099. Returns true iff one is bigger than two.
  28100. </member>
  28101. <member name="M:NPOI.Util.MutableBigInteger.divWord(System.Int32[],System.Int64,System.Int32)">
  28102. This method divides a long quantity by an int to estimate
  28103. qhat for two multi precision numbers. It is used when
  28104. the signed value of n is less than zero.
  28105. </member>
  28106. <member name="M:NPOI.Util.MutableBigInteger.hybridGCD(NPOI.Util.MutableBigInteger)">
  28107. Calculate GCD of this and b. This and b are changed by the computation.
  28108. </member>
  28109. <member name="M:NPOI.Util.MutableBigInteger.binaryGCD(NPOI.Util.MutableBigInteger)">
  28110. Calculate GCD of this and v.
  28111. Assumes that this and v are not zero.
  28112. </member>
  28113. <member name="M:NPOI.Util.MutableBigInteger.binaryGcd(System.Int32,System.Int32)">
  28114. Calculate GCD of a and b interpreted as unsigned integers.
  28115. </member>
  28116. <member name="M:NPOI.Util.MutableBigInteger.mutableModInverse(NPOI.Util.MutableBigInteger)">
  28117. Returns the modInverse of this mod p. This and p are not affected by
  28118. the operation.
  28119. </member>
  28120. <member name="M:NPOI.Util.MutableBigInteger.modInverse(NPOI.Util.MutableBigInteger)">
  28121. Calculate the multiplicative inverse of this mod mod, where mod is odd.
  28122. This and mod are not changed by the calculation.
  28123. This method implements an algorithm due to Richard Schroeppel, that uses
  28124. the same intermediate representation as Montgomery Reduction
  28125. ("Montgomery Form"). The algorithm is described in an unpublished
  28126. manuscript entitled "Fast Modular Reciprocals."
  28127. </member>
  28128. <member name="M:NPOI.Util.MutableBigInteger.euclidModInverse(System.Int32)">
  28129. Uses the extended Euclidean algorithm to compute the modInverse of base
  28130. mod a modulus that is a power of 2. The modulus is 2^k.
  28131. </member>
  28132. <member name="T:NPOI.Util.BitField">
  28133. <summary>
  28134. Manage operations dealing with bit-mapped fields.
  28135. @author Marc Johnson (mjohnson at apache dot org)
  28136. @author Andrew C. Oliver (acoliver at apache dot org)
  28137. </summary>
  28138. </member>
  28139. <member name="M:NPOI.Util.BitField.#ctor(System.Int32)">
  28140. <summary>
  28141. Create a <see cref="T:NPOI.Util.BitField"/> instance
  28142. </summary>
  28143. <param name="mask">
  28144. the mask specifying which bits apply to this
  28145. BitField. Bits that are set in this mask are the
  28146. bits that this BitField operates on
  28147. </param>
  28148. </member>
  28149. <member name="M:NPOI.Util.BitField.#ctor(System.UInt32)">
  28150. <summary>
  28151. Create a <see cref="T:NPOI.Util.BitField"/> instance
  28152. </summary>
  28153. <param name="mask">
  28154. the mask specifying which bits apply to this
  28155. BitField. Bits that are set in this mask are the
  28156. bits that this BitField operates on
  28157. </param>
  28158. </member>
  28159. <member name="M:NPOI.Util.BitField.Clear(System.Int32)">
  28160. <summary>
  28161. Clear the bits.
  28162. </summary>
  28163. <param name="holder">the int data containing the bits we're interested in</param>
  28164. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  28165. </member>
  28166. <member name="M:NPOI.Util.BitField.ClearShort(System.Int16)">
  28167. <summary>
  28168. Clear the bits.
  28169. </summary>
  28170. <param name="holder">the short data containing the bits we're interested in</param>
  28171. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  28172. </member>
  28173. <member name="M:NPOI.Util.BitField.GetRawValue(System.Int32)">
  28174. <summary>
  28175. Obtain the value for the specified BitField, appropriately
  28176. shifted right. Many users of a BitField will want to treat the
  28177. specified bits as an int value, and will not want to be aware
  28178. that the value is stored as a BitField (and so shifted left so
  28179. many bits)
  28180. </summary>
  28181. <param name="holder">the int data containing the bits we're interested in</param>
  28182. <returns>the selected bits, shifted right appropriately</returns>
  28183. </member>
  28184. <member name="M:NPOI.Util.BitField.GetShortRawValue(System.Int16)">
  28185. <summary>
  28186. Obtain the value for the specified BitField, unshifted
  28187. </summary>
  28188. <param name="holder">the short data containing the bits we're interested in</param>
  28189. <returns>the selected bits</returns>
  28190. </member>
  28191. <member name="M:NPOI.Util.BitField.GetShortValue(System.Int16)">
  28192. <summary>
  28193. Obtain the value for the specified BitField, appropriately
  28194. shifted right, as a short. Many users of a BitField will want
  28195. to treat the specified bits as an int value, and will not want
  28196. to be aware that the value is stored as a BitField (and so
  28197. shifted left so many bits)
  28198. </summary>
  28199. <param name="holder">the short data containing the bits we're interested in</param>
  28200. <returns>the selected bits, shifted right appropriately</returns>
  28201. </member>
  28202. <member name="M:NPOI.Util.BitField.GetValue(System.Int32)">
  28203. <summary>
  28204. Obtain the value for the specified BitField, appropriately
  28205. shifted right. Many users of a BitField will want to treat the
  28206. specified bits as an int value, and will not want to be aware
  28207. that the value is stored as a BitField (and so shifted left so
  28208. many bits)
  28209. </summary>
  28210. <param name="holder">the int data containing the bits we're interested in</param>
  28211. <returns>the selected bits, shifted right appropriately</returns>
  28212. </member>
  28213. <member name="M:NPOI.Util.BitField.IsAllSet(System.Int32)">
  28214. <summary>
  28215. Are all of the bits set or not? This is a stricter test than
  28216. isSet, in that all of the bits in a multi-bit set must be set
  28217. for this method to return true
  28218. </summary>
  28219. <param name="holder">the int data containing the bits we're interested in</param>
  28220. <returns>
  28221. <c>true</c> if all of the bits are set otherwise, <c>false</c>.
  28222. </returns>
  28223. </member>
  28224. <member name="M:NPOI.Util.BitField.IsSet(System.Int32)">
  28225. <summary>
  28226. is the field set or not? This is most commonly used for a
  28227. single-bit field, which is often used to represent a boolean
  28228. value; the results of using it for a multi-bit field is to
  28229. determine whether *any* of its bits are set
  28230. </summary>
  28231. <param name="holder">the int data containing the bits we're interested in</param>
  28232. <returns>
  28233. <c>true</c> if any of the bits are set; otherwise, <c>false</c>.
  28234. </returns>
  28235. </member>
  28236. <member name="M:NPOI.Util.BitField.Set(System.Int32)">
  28237. <summary>
  28238. Set the bits.
  28239. </summary>
  28240. <param name="holder">the int data containing the bits we're interested in</param>
  28241. <returns>the value of holder with the specified bits set to 1</returns>
  28242. </member>
  28243. <member name="M:NPOI.Util.BitField.SetBoolean(System.Int32,System.Boolean)">
  28244. <summary>
  28245. Set a boolean BitField
  28246. </summary>
  28247. <param name="holder">the int data containing the bits we're interested in</param>
  28248. <param name="flag">indicating whether to set or clear the bits</param>
  28249. <returns>the value of holder with the specified bits set or cleared</returns>
  28250. </member>
  28251. <member name="M:NPOI.Util.BitField.SetShort(System.Int16)">
  28252. <summary>
  28253. Set the bits.
  28254. </summary>
  28255. <param name="holder">the short data containing the bits we're interested in</param>
  28256. <returns>the value of holder with the specified bits set to 1</returns>
  28257. </member>
  28258. <member name="M:NPOI.Util.BitField.SetShortBoolean(System.Int16,System.Boolean)">
  28259. <summary>
  28260. Set a boolean BitField
  28261. </summary>
  28262. <param name="holder">the short data containing the bits we're interested in</param>
  28263. <param name="flag">indicating whether to set or clear the bits</param>
  28264. <returns>the value of holder with the specified bits set or cleared</returns>
  28265. </member>
  28266. <member name="M:NPOI.Util.BitField.SetShortValue(System.Int16,System.Int16)">
  28267. <summary>
  28268. Obtain the value for the specified BitField, appropriately
  28269. shifted right, as a short. Many users of a BitField will want
  28270. to treat the specified bits as an int value, and will not want
  28271. to be aware that the value is stored as a BitField (and so
  28272. shifted left so many bits)
  28273. </summary>
  28274. <param name="holder">the short data containing the bits we're interested in</param>
  28275. <param name="value">the new value for the specified bits</param>
  28276. <returns>the selected bits, shifted right appropriately</returns>
  28277. </member>
  28278. <member name="M:NPOI.Util.BitField.SetValue(System.Int32,System.Int32)">
  28279. <summary>
  28280. Sets the value.
  28281. </summary>
  28282. <param name="holder">the byte data containing the bits we're interested in</param>
  28283. <param name="value">The value.</param>
  28284. <returns></returns>
  28285. </member>
  28286. <member name="M:NPOI.Util.BitField.SetByteBoolean(System.Byte,System.Boolean)">
  28287. <summary>
  28288. Set a boolean BitField
  28289. </summary>
  28290. <param name="holder"> the byte data containing the bits we're interested in</param>
  28291. <param name="flag">indicating whether to set or clear the bits</param>
  28292. <returns>the value of holder with the specified bits set or cleared</returns>
  28293. </member>
  28294. <member name="M:NPOI.Util.BitField.ClearByte(System.Byte)">
  28295. <summary>
  28296. Clears the bits.
  28297. </summary>
  28298. <param name="holder">the byte data containing the bits we're interested in</param>
  28299. <returns>the value of holder with the specified bits cleared</returns>
  28300. </member>
  28301. <member name="M:NPOI.Util.BitField.SetByte(System.Byte)">
  28302. <summary>
  28303. Set the bits.
  28304. </summary>
  28305. <param name="holder">the byte data containing the bits we're interested in</param>
  28306. <returns>the value of holder with the specified bits set to 1</returns>
  28307. </member>
  28308. <member name="T:NPOI.Util.BitFieldFactory">
  28309. <summary>
  28310. Returns immutable Btfield instances.
  28311. @author Jason Height (jheight at apache dot org)
  28312. </summary>
  28313. </member>
  28314. <member name="M:NPOI.Util.BitFieldFactory.GetInstance(System.Int32)">
  28315. <summary>
  28316. Gets the instance.
  28317. </summary>
  28318. <param name="mask">The mask.</param>
  28319. <returns></returns>
  28320. </member>
  28321. <member name="T:NPOI.Util.ByteField">
  28322. <summary>
  28323. representation of a byte (8-bit) field at a fixed location within a
  28324. byte array
  28325. @author Marc Johnson (mjohnson at apache dot org
  28326. </summary>
  28327. </member>
  28328. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32)">
  28329. <summary>
  28330. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28331. </summary>
  28332. <param name="offset">The offset.</param>
  28333. </member>
  28334. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte)">
  28335. <summary>
  28336. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28337. </summary>
  28338. <param name="offset">The offset.</param>
  28339. <param name="value">The value.</param>
  28340. </member>
  28341. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte[])">
  28342. <summary>
  28343. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28344. </summary>
  28345. <param name="offset">The offset.</param>
  28346. <param name="data">The data.</param>
  28347. </member>
  28348. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte,System.Byte[])">
  28349. <summary>
  28350. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28351. </summary>
  28352. <param name="offset">The offset.</param>
  28353. <param name="_value">The _value.</param>
  28354. <param name="data">The data.</param>
  28355. </member>
  28356. <member name="P:NPOI.Util.ByteField.Value">
  28357. <summary>
  28358. Gets or sets the value.
  28359. </summary>
  28360. <value>The value.</value>
  28361. </member>
  28362. <member name="M:NPOI.Util.ByteField.ReadFromBytes(System.Byte[])">
  28363. <summary>
  28364. set the value from its offset into an array of bytes
  28365. </summary>
  28366. <param name="data">the byte array from which the value is to be read</param>
  28367. </member>
  28368. <member name="M:NPOI.Util.ByteField.ReadFromStream(System.IO.Stream)">
  28369. <summary>
  28370. set the value from an Stream
  28371. </summary>
  28372. <param name="stream">the Stream from which the value is to be read</param>
  28373. </member>
  28374. <member name="M:NPOI.Util.ByteField.Set(System.Byte,System.Byte[])">
  28375. <summary>
  28376. set the ByteField's current value and write it to a byte array
  28377. </summary>
  28378. <param name="value">value to be set</param>
  28379. <param name="data">the byte array to write the value to</param>
  28380. </member>
  28381. <member name="M:NPOI.Util.ByteField.ToString">
  28382. <summary>
  28383. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28384. </summary>
  28385. <returns>
  28386. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28387. </returns>
  28388. </member>
  28389. <member name="M:NPOI.Util.ByteField.WriteToBytes(System.Byte[])">
  28390. <summary>
  28391. write the value out to an array of bytes at the appropriate offset
  28392. </summary>
  28393. <param name="data">the array of bytes to which the value is to be written</param>
  28394. </member>
  28395. <member name="T:NPOI.Util.CodePageUtil">
  28396. Utilities for working with Microsoft CodePages.
  28397. <p>Provides constants for understanding numeric codepages,
  28398. along with utilities to translate these into Java Character Sets.</p>
  28399. </member>
  28400. <member name="F:NPOI.Util.CodePageUtil.CP_037">
  28401. <p>Codepage 037, a special case</p>
  28402. </member>
  28403. <member name="F:NPOI.Util.CodePageUtil.CP_SJIS">
  28404. <p>Codepage for SJIS</p>
  28405. </member>
  28406. <member name="F:NPOI.Util.CodePageUtil.CP_GBK">
  28407. <p>Codepage for GBK, aka MS936</p>
  28408. </member>
  28409. <member name="F:NPOI.Util.CodePageUtil.CP_MS949">
  28410. <p>Codepage for MS949</p>
  28411. </member>
  28412. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16">
  28413. <p>Codepage for UTF-16</p>
  28414. </member>
  28415. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16_BE">
  28416. <p>Codepage for UTF-16 big-endian</p>
  28417. </member>
  28418. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1250">
  28419. <p>Codepage for Windows 1250</p>
  28420. </member>
  28421. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1251">
  28422. <p>Codepage for Windows 1251</p>
  28423. </member>
  28424. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1252">
  28425. <p>Codepage for Windows 1252</p>
  28426. </member>
  28427. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1253">
  28428. <p>Codepage for Windows 1253</p>
  28429. </member>
  28430. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1254">
  28431. <p>Codepage for Windows 1254</p>
  28432. </member>
  28433. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1255">
  28434. <p>Codepage for Windows 1255</p>
  28435. </member>
  28436. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1256">
  28437. <p>Codepage for Windows 1256</p>
  28438. </member>
  28439. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1257">
  28440. <p>Codepage for Windows 1257</p>
  28441. </member>
  28442. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1258">
  28443. <p>Codepage for Windows 1258</p>
  28444. </member>
  28445. <member name="F:NPOI.Util.CodePageUtil.CP_JOHAB">
  28446. <p>Codepage for Johab</p>
  28447. </member>
  28448. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMAN">
  28449. <p>Codepage for Macintosh Roman (Java: MacRoman)</p>
  28450. </member>
  28451. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_JAPAN">
  28452. <p>Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  28453. cp943)</p>
  28454. </member>
  28455. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_TRADITIONAL">
  28456. <p>Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  28457. MS950, or cp937)</p>
  28458. </member>
  28459. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_KOREAN">
  28460. <p>Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  28461. cp949)</p>
  28462. </member>
  28463. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ARABIC">
  28464. <p>Codepage for Macintosh Arabic (Java: MacArabic)</p>
  28465. </member>
  28466. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_HEBREW">
  28467. <p>Codepage for Macintosh Hebrew (Java: MacHebrew)</p>
  28468. </member>
  28469. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_GREEK">
  28470. <p>Codepage for Macintosh Greek (Java: MacGreek)</p>
  28471. </member>
  28472. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CYRILLIC">
  28473. <p>Codepage for Macintosh Cyrillic (Java: MacCyrillic)</p>
  28474. </member>
  28475. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_SIMPLE">
  28476. <p>Codepage for Macintosh Chinese Simplified (Java: unknown - use
  28477. EUC_CN, ISO2022_CN_GB, MS936 or cp935)</p>
  28478. </member>
  28479. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMANIA">
  28480. <p>Codepage for Macintosh Romanian (Java: MacRomania)</p>
  28481. </member>
  28482. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_UKRAINE">
  28483. <p>Codepage for Macintosh Ukrainian (Java: MacUkraine)</p>
  28484. </member>
  28485. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_THAI">
  28486. <p>Codepage for Macintosh Thai (Java: MacThai)</p>
  28487. </member>
  28488. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CENTRAL_EUROPE">
  28489. <p>Codepage for Macintosh Central Europe (Latin-2)
  28490. (Java: MacCentralEurope)</p>
  28491. </member>
  28492. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ICELAND">
  28493. <p>Codepage for Macintosh Iceland (Java: MacIceland)</p>
  28494. </member>
  28495. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_TURKISH">
  28496. <p>Codepage for Macintosh Turkish (Java: MacTurkish)</p>
  28497. </member>
  28498. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CROATIAN">
  28499. <p>Codepage for Macintosh Croatian (Java: MacCroatian)</p>
  28500. </member>
  28501. <member name="F:NPOI.Util.CodePageUtil.CP_US_ACSII">
  28502. <p>Codepage for US-ASCII</p>
  28503. </member>
  28504. <member name="F:NPOI.Util.CodePageUtil.CP_KOI8_R">
  28505. <p>Codepage for KOI8-R</p>
  28506. </member>
  28507. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_1">
  28508. <p>Codepage for ISO-8859-1</p>
  28509. </member>
  28510. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_2">
  28511. <p>Codepage for ISO-8859-2</p>
  28512. </member>
  28513. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_3">
  28514. <p>Codepage for ISO-8859-3</p>
  28515. </member>
  28516. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_4">
  28517. <p>Codepage for ISO-8859-4</p>
  28518. </member>
  28519. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_5">
  28520. <p>Codepage for ISO-8859-5</p>
  28521. </member>
  28522. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_6">
  28523. <p>Codepage for ISO-8859-6</p>
  28524. </member>
  28525. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_7">
  28526. <p>Codepage for ISO-8859-7</p>
  28527. </member>
  28528. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_8">
  28529. <p>Codepage for ISO-8859-8</p>
  28530. </member>
  28531. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_9">
  28532. <p>Codepage for ISO-8859-9</p>
  28533. </member>
  28534. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP1">
  28535. <p>Codepage for ISO-2022-JP</p>
  28536. </member>
  28537. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP2">
  28538. <p>Another codepage for ISO-2022-JP</p>
  28539. </member>
  28540. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP3">
  28541. <p>Yet another codepage for ISO-2022-JP</p>
  28542. </member>
  28543. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_KR">
  28544. <p>Codepage for ISO-2022-KR</p>
  28545. </member>
  28546. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_JP">
  28547. <p>Codepage for EUC-JP</p>
  28548. </member>
  28549. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_KR">
  28550. <p>Codepage for EUC-KR</p>
  28551. </member>
  28552. <member name="F:NPOI.Util.CodePageUtil.CP_GB2312">
  28553. <p>Codepage for GB2312</p>
  28554. </member>
  28555. <member name="F:NPOI.Util.CodePageUtil.CP_GB18030">
  28556. <p>Codepage for GB18030</p>
  28557. </member>
  28558. <member name="F:NPOI.Util.CodePageUtil.CP_US_ASCII2">
  28559. <p>Another codepage for US-ASCII</p>
  28560. </member>
  28561. <member name="F:NPOI.Util.CodePageUtil.CP_UTF8">
  28562. <p>Codepage for UTF-8</p>
  28563. </member>
  28564. <member name="F:NPOI.Util.CodePageUtil.CP_UNICODE">
  28565. <p>Codepage for Unicode</p>
  28566. </member>
  28567. <member name="M:NPOI.Util.CodePageUtil.GetBytesInCodePage(System.String,System.Int32)">
  28568. Converts a string into bytes, in the equivalent character encoding
  28569. to the supplied codepage number.
  28570. @param string The string to convert
  28571. @param codepage The codepage number
  28572. </member>
  28573. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32)">
  28574. Converts the bytes into a String, based on the equivalent character encoding
  28575. to the supplied codepage number.
  28576. @param string The byte of the string to convert
  28577. @param codepage The codepage number
  28578. </member>
  28579. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32,System.Int32,System.Int32)">
  28580. Converts the bytes into a String, based on the equivalent character encoding
  28581. to the supplied codepage number.
  28582. @param string The byte of the string to convert
  28583. @param codepage The codepage number
  28584. </member>
  28585. <member name="M:NPOI.Util.CodePageUtil.CodepageToEncoding(System.Int32)">
  28586. <p>Turns a codepage number into the equivalent character encoding's
  28587. name.</p>
  28588. @param codepage The codepage number
  28589. @return The character encoding's name. If the codepage number is 65001,
  28590. the encoding name is "UTF-8". All other positive numbers are mapped to
  28591. "cp" followed by the number, e.g. if the codepage number is 1252 the
  28592. returned character encoding name will be "cp1252".
  28593. @exception UnsupportedEncodingException if the specified codepage is
  28594. less than zero.
  28595. </member>
  28596. <member name="T:NPOI.Util.Collections.HashSet`1">
  28597. <summary>
  28598. This class comes from Java
  28599. </summary>
  28600. </member>
  28601. <member name="M:NPOI.Util.Collections.HashSet`1.#ctor">
  28602. <summary>
  28603. Initializes a new instance of the class.
  28604. </summary>
  28605. </member>
  28606. <member name="M:NPOI.Util.Collections.HashSet`1.Add(`0)">
  28607. <summary>
  28608. Adds the specified o.
  28609. </summary>
  28610. <param name="o">The o.</param>
  28611. </member>
  28612. <member name="M:NPOI.Util.Collections.HashSet`1.Contains(`0)">
  28613. <summary>
  28614. Determines whether [contains] [the specified o].
  28615. </summary>
  28616. <param name="o">The o.</param>
  28617. <returns>
  28618. <c>true</c> if [contains] [the specified o]; otherwise, <c>false</c>.
  28619. </returns>
  28620. </member>
  28621. <member name="M:NPOI.Util.Collections.HashSet`1.CopyTo(`0[],System.Int32)">
  28622. <summary>
  28623. 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.
  28624. </summary>
  28625. <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>
  28626. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  28627. <exception cref="T:System.ArgumentNullException">
  28628. <paramref name="array"/> is null.
  28629. </exception>
  28630. <exception cref="T:System.ArgumentOutOfRangeException">
  28631. <paramref name="index"/> is less than zero.
  28632. </exception>
  28633. <exception cref="T:System.ArgumentException">
  28634. <paramref name="array"/> is multidimensional.
  28635. -or-
  28636. <paramref name="index"/> is equal to or greater than the length of <paramref name="array"/>.
  28637. -or-
  28638. 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"/>.
  28639. </exception>
  28640. <exception cref="T:System.ArgumentException">
  28641. The type of the source <see cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
  28642. </exception>
  28643. </member>
  28644. <member name="P:NPOI.Util.Collections.HashSet`1.Count">
  28645. <summary>
  28646. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  28647. </summary>
  28648. <value></value>
  28649. <returns>
  28650. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  28651. </returns>
  28652. </member>
  28653. <member name="M:NPOI.Util.Collections.HashSet`1.GetEnumerator">
  28654. <summary>
  28655. Returns an enumerator that iterates through a collection.
  28656. </summary>
  28657. <returns>
  28658. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  28659. </returns>
  28660. </member>
  28661. <member name="M:NPOI.Util.Collections.HashSet`1.Remove(`0)">
  28662. <summary>
  28663. Removes the specified o.
  28664. </summary>
  28665. <param name="o">The o.</param>
  28666. </member>
  28667. <member name="M:NPOI.Util.Collections.HashSet`1.Clear">
  28668. <summary>
  28669. Removes all of the elements from this set.
  28670. The set will be empty after this call returns.
  28671. </summary>
  28672. </member>
  28673. <member name="T:NPOI.Util.Collections.Properties">
  28674. <summary>
  28675. This class comes from Java
  28676. </summary>
  28677. </member>
  28678. <member name="M:NPOI.Util.Collections.Properties.#ctor">
  28679. <summary>
  28680. Initializes a new instance of the <see cref="T:NPOI.Util.Collections.Properties"/> class.
  28681. </summary>
  28682. </member>
  28683. <member name="M:NPOI.Util.Collections.Properties.Remove(System.String)">
  28684. <summary>
  28685. Removes the specified key.
  28686. </summary>
  28687. <param name="key">The key.</param>
  28688. <returns></returns>
  28689. </member>
  28690. <member name="M:NPOI.Util.Collections.Properties.GetEnumerator">
  28691. <summary>
  28692. Gets the enumerator.
  28693. </summary>
  28694. <returns></returns>
  28695. </member>
  28696. <member name="M:NPOI.Util.Collections.Properties.ContainsKey(System.String)">
  28697. <summary>
  28698. Determines whether the specified key contains key.
  28699. </summary>
  28700. <param name="key">The key.</param>
  28701. <returns>
  28702. <c>true</c> if the specified key contains key; otherwise, <c>false</c>.
  28703. </returns>
  28704. </member>
  28705. <member name="M:NPOI.Util.Collections.Properties.Add(System.String,System.String)">
  28706. <summary>
  28707. Adds the specified key.
  28708. </summary>
  28709. <param name="key">The key.</param>
  28710. <param name="value">The value.</param>
  28711. </member>
  28712. <member name="P:NPOI.Util.Collections.Properties.Count">
  28713. <summary>
  28714. Gets the count.
  28715. </summary>
  28716. <value>The count.</value>
  28717. </member>
  28718. <member name="P:NPOI.Util.Collections.Properties.Item(System.String)">
  28719. <summary>
  28720. Gets or sets the <see cref="T:System.String"/> with the specified key.
  28721. </summary>
  28722. <value></value>
  28723. </member>
  28724. <member name="P:NPOI.Util.Collections.Properties.Keys">
  28725. <summary>
  28726. Gets the keys.
  28727. </summary>
  28728. <value>The keys.</value>
  28729. </member>
  28730. <member name="M:NPOI.Util.Collections.Properties.Clear">
  28731. <summary>
  28732. Clears this instance.
  28733. </summary>
  28734. </member>
  28735. <member name="M:NPOI.Util.Collections.Properties.Load(System.IO.Stream)">
  28736. <summary>
  28737. Loads the specified in stream.
  28738. </summary>
  28739. <param name="inStream">The in stream.</param>
  28740. </member>
  28741. <member name="M:NPOI.Util.Collections.Properties.LoadConvert(System.String)">
  28742. <summary>
  28743. Loads the convert.
  28744. </summary>
  28745. <param name="theString">The string.</param>
  28746. <returns></returns>
  28747. <remarks>
  28748. Converts encoded &#92;uxxxx to unicode chars
  28749. and changes special saved chars to their original forms
  28750. </remarks>
  28751. </member>
  28752. <member name="M:NPOI.Util.Collections.Properties.ContinueLine(System.String)">
  28753. <summary>
  28754. Continues the line.
  28755. </summary>
  28756. <param name="line">The line.</param>
  28757. <returns></returns>
  28758. </member>
  28759. <member name="T:NPOI.Util.CRC32">
  28760. <summary>
  28761. CRC Verification
  28762. </summary>
  28763. </member>
  28764. <member name="M:NPOI.Util.CRC32.#ctor">
  28765. <summary>
  28766. Initializes a new instance of the <see cref="T:NPOI.Util.CRC32"/> class.
  28767. </summary>
  28768. </member>
  28769. <member name="M:NPOI.Util.CRC32.ByteCRC(System.Byte[]@)">
  28770. <summary>
  28771. CRC Bytes.
  28772. </summary>
  28773. <param name="buffer">The buffer.</param>
  28774. <returns></returns>
  28775. </member>
  28776. <member name="M:NPOI.Util.CRC32.StringCRC(System.String)">
  28777. <summary>
  28778. String CRC
  28779. </summary>
  28780. <param name="sInputString">the string</param>
  28781. <returns></returns>
  28782. </member>
  28783. <member name="M:NPOI.Util.CRC32.FileCRC(System.String)">
  28784. <summary>
  28785. File CRC
  28786. </summary>
  28787. <param name="sInputFilename">the input file</param>
  28788. <returns></returns>
  28789. </member>
  28790. <member name="M:NPOI.Util.CRC32.StreamCRC(System.IO.Stream)">
  28791. <summary>
  28792. Stream CRC
  28793. </summary>
  28794. <param name="inFile">the input stream</param>
  28795. <returns></returns>
  28796. </member>
  28797. <member name="T:NPOI.Util.FixedField">
  28798. <summary>
  28799. behavior of a field at a fixed location within a byte array
  28800. @author Marc Johnson (mjohnson at apache dot org
  28801. </summary>
  28802. </member>
  28803. <member name="M:NPOI.Util.FixedField.ReadFromBytes(System.Byte[])">
  28804. <summary>
  28805. set the value from its offset into an array of bytes
  28806. </summary>
  28807. <param name="data">the byte array from which the value is to be read</param>
  28808. </member>
  28809. <member name="M:NPOI.Util.FixedField.ReadFromStream(System.IO.Stream)">
  28810. <summary>
  28811. set the value from an Stream
  28812. </summary>
  28813. <param name="stream">the Stream from which the value is to be read</param>
  28814. </member>
  28815. <member name="M:NPOI.Util.FixedField.ToString">
  28816. <summary>
  28817. return the value as a String
  28818. </summary>
  28819. <returns></returns>
  28820. </member>
  28821. <member name="M:NPOI.Util.FixedField.WriteToBytes(System.Byte[])">
  28822. <summary>
  28823. write the value out to an array of bytes at the appropriate offset
  28824. </summary>
  28825. <param name="data">the array of bytes to which the value is to be written</param>
  28826. </member>
  28827. <member name="T:NPOI.Util.HexDump">
  28828. <summary>
  28829. dump data in hexadecimal format; derived from a HexDump utility I
  28830. wrote in June 2001.
  28831. @author Marc Johnson
  28832. @author Glen Stampoultzis (glens at apache.org)
  28833. </summary>
  28834. </member>
  28835. <member name="F:NPOI.Util.HexDump.DIGITS_LOWER">
  28836. Used to build output as Hex
  28837. </member>
  28838. <member name="F:NPOI.Util.HexDump.DIGITS_UPPER">
  28839. Used to build output as Hex
  28840. </member>
  28841. <member name="M:NPOI.Util.HexDump.Dump(System.Byte[],System.Int64,System.Int32,System.Int32)">
  28842. dump an array of bytes to a String
  28843. @param data the byte array to be dumped
  28844. @param offset its offset, whatever that might mean
  28845. @param index initial index into the byte array
  28846. @param length number of characters to output
  28847. @exception ArrayIndexOutOfBoundsException if the index is
  28848. outside the data array's bounds
  28849. @return output string
  28850. </member>
  28851. <member name="M:NPOI.Util.HexDump.Dump(System.IO.Stream,System.IO.Stream,System.Int32,System.Int32)">
  28852. Dumps <code>bytesToDump</code> bytes to an output stream.
  28853. @param in The stream to read from
  28854. @param out The output stream
  28855. @param start The index to use as the starting position for the left hand side label
  28856. @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
  28857. </member>
  28858. <member name="M:NPOI.Util.HexDump.ShortToHex(System.Int32)">
  28859. <summary>
  28860. Shorts to hex.
  28861. </summary>
  28862. <param name="value">The value.</param>
  28863. <returns>char array of 2 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28864. </member>
  28865. <member name="M:NPOI.Util.HexDump.ByteToHex(System.Int32)">
  28866. <summary>
  28867. Bytes to hex.
  28868. </summary>
  28869. <param name="value">The value.</param>
  28870. <returns>char array of 1 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28871. </member>
  28872. <member name="M:NPOI.Util.HexDump.IntToHex(System.Int32)">
  28873. <summary>
  28874. Ints to hex.
  28875. </summary>
  28876. <param name="value">The value.</param>
  28877. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28878. </member>
  28879. <member name="M:NPOI.Util.HexDump.LongToHex(System.Int64)">
  28880. <summary>
  28881. char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'
  28882. </summary>
  28883. <param name="value">The value.</param>
  28884. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28885. </member>
  28886. <member name="M:NPOI.Util.HexDump.ToHexChars(System.Int64,System.Int32)">
  28887. <summary>
  28888. Toes the hex chars.
  28889. </summary>
  28890. <param name="pValue">The p value.</param>
  28891. <param name="nBytes">The n bytes.</param>
  28892. <returns>char array of uppercase hex chars, zero padded and prefixed with '0x'</returns>
  28893. </member>
  28894. <member name="M:NPOI.Util.HexRead.ReadData(System.String)">
  28895. <summary>
  28896. This method reads hex data from a filename and returns a byte array.
  28897. The file may contain line comments that are preceeded with a # symbol.
  28898. </summary>
  28899. <param name="filename">The filename to read</param>
  28900. <returns>The bytes read from the file.</returns>
  28901. <exception cref="T:System.IO.IOException">If there was a problem while reading the file.</exception>
  28902. </member>
  28903. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.String)">
  28904. <summary>
  28905. Same as ReadData(String) except that this method allows you to specify sections within
  28906. a file. Sections are referenced using section headers in the form:
  28907. </summary>
  28908. <param name="stream">The stream.</param>
  28909. <param name="section">The section.</param>
  28910. <returns></returns>
  28911. </member>
  28912. <member name="M:NPOI.Util.HexRead.ReadData(System.String,System.String)">
  28913. <summary>
  28914. Reads the data.
  28915. </summary>
  28916. <param name="filename">The filename.</param>
  28917. <param name="section">The section.</param>
  28918. <returns></returns>
  28919. </member>
  28920. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.Int32)">
  28921. <summary>
  28922. Reads the data.
  28923. </summary>
  28924. <param name="stream">The stream.</param>
  28925. <param name="eofChar">The EOF char.</param>
  28926. <returns></returns>
  28927. </member>
  28928. <member name="M:NPOI.Util.HexRead.ReadFromString(System.String)">
  28929. <summary>
  28930. Reads from string.
  28931. </summary>
  28932. <param name="data">The data.</param>
  28933. <returns></returns>
  28934. </member>
  28935. <member name="M:NPOI.Util.HexRead.ReadToEOL(System.IO.Stream)">
  28936. <summary>
  28937. Reads to EOL.
  28938. </summary>
  28939. <param name="stream">The stream.</param>
  28940. </member>
  28941. <member name="M:NPOI.Util.InputStream.Read">
  28942. <summary>
  28943. Reads the next byte of data from the input stream. The value byte is
  28944. returned as an <c>int</c> in the range <c>0</c> to
  28945. <c>255</c>. If no byte is available because the end of the stream
  28946. has been reached, the value <c>-1</c> is returned. This method
  28947. blocks until input data is available, the end of the stream is detected,
  28948. or an exception is thrown.
  28949. A subclass must provide an implementation of this method.
  28950. </summary>
  28951. <returns>
  28952. the next byte of data, or <c>-1</c> if the end of the
  28953. stream is reached.
  28954. </returns>
  28955. <exception cref="T:System.IO.IOException">if an I/O error occurs</exception>
  28956. </member>
  28957. <member name="M:NPOI.Util.InputStream.Read(System.Byte[])">
  28958. <summary>
  28959. Reads some number of bytes from the input stream and stores them into
  28960. the buffer array <c>b</c>. The number of bytes actually read is
  28961. returned as an integer. This method blocks until input data is
  28962. available, end of file is detected, or an exception is thrown.
  28963. <p> If the length of <c>b</c> is zero, then no bytes are read and
  28964. <c>0</c> is returned; otherwise, there is an attempt to read at
  28965. least one byte. If no byte is available because the stream is at the
  28966. end of the file, the value <c>-1</c> is returned; otherwise, at
  28967. least one byte is read and stored into <c>b</c>.</p>
  28968. <p> The first byte read is stored into element <c>b[0]</c>, the
  28969. next one into <c>b[1]</c>, and so on. The number of bytes read is,
  28970. at most, equal to the length of <c>b</c>. Let <i>k</i> be the
  28971. number of bytes actually read; these bytes will be stored in elements
  28972. <c>b[0]</c> through <c>b[</c><i>k</i><c>-1]</c>,
  28973. leaving elements <c>b[</c><i>k</i><c>]</c> through
  28974. <c>b[b.length-1]</c> unaffected.</p>
  28975. <p> The <c>read(b)</c> method for class <c>InputStream</c>
  28976. has the same effect as: <pre><c> read(b, 0, b.length) </c></pre></p>
  28977. </summary>
  28978. <param name="b">the buffer into which the data is read.</param>
  28979. <returns>
  28980. the total number of bytes read into the buffer, or
  28981. <c>-1</c> if there is no more data because the end of
  28982. the stream has been reached.
  28983. </returns>
  28984. <exception cref="T:System.IO.IOException">If the first byte cannot be read for any reason
  28985. other than the end of the file, if the input stream has been closed, or
  28986. if some other I/O error occurs.</exception>
  28987. <exception cref="T:System.NullReferenceException">if <c>b</c> is <c>null</c>.</exception>
  28988. <see cref="M:NPOI.Util.InputStream.Read(System.Byte[],System.Int32,System.Int32)"/>
  28989. </member>
  28990. <member name="M:NPOI.Util.InputStream.Read(System.Byte[],System.Int32,System.Int32)">
  28991. <summary>
  28992. Reads up to <c>len</c> bytes of data from the input stream into
  28993. an array of bytes. An attempt is made to read as many as
  28994. <c>len</c> bytes, but a smaller number may be read.
  28995. The number of bytes actually read is returned as an integer.
  28996. <p> This method blocks until input data is available, end of file is
  28997. detected, or an exception is thrown.</p>
  28998. <p> If <c>len</c> is zero, then no bytes are read and
  28999. <c>0</c> is returned; otherwise, there is an attempt to read at
  29000. least one byte. If no byte is available because the stream is at end of
  29001. file, the value <c>-1</c> is returned; otherwise, at least one
  29002. byte is read and stored into <c>b</c>.</p>
  29003. <p> The first byte read is stored into element <c>b[off]</c>, the
  29004. next one into <c>b[off+1]</c>, and so on. The number of bytes read
  29005. is, at most, equal to <c>len</c>. Let <i>k</i> be the number of
  29006. bytes actually read; these bytes will be stored in elements
  29007. <c>b[off]</c> through <c>b[off+</c><i>k</i><c>-1]</c>,
  29008. leaving elements <c>b[off+</c><i>k</i><c>]</c> through
  29009. <c>b[off+len-1]</c> unaffected.</p>
  29010. <p> In every case, elements <c>b[0]</c> through
  29011. <c>b[off]</c> and elements <c>b[off+len]</c> through
  29012. <c>b[b.length-1]</c> are unaffected.</p>
  29013. <p> The <c>read(b,</c> <c>off,</c> <c>len)</c> method
  29014. for class <c>InputStream</c> simply calls the method
  29015. <c>read()</c> repeatedly. If the first such call results in an
  29016. <c>IOException</c>, that exception is returned from the call to
  29017. the <c>read(b,</c> <c>off,</c> <c>len)</c> method. If
  29018. any subsequent call to <c>read()</c> results in a
  29019. <c>IOException</c>, the exception is caught and treated as if it
  29020. were end of file; the bytes read up to that point are stored into
  29021. <c>b</c> and the number of bytes read before the exception
  29022. occurred is returned. The default implementation of this method blocks
  29023. until the requested amount of input data <c>len</c> has been read,
  29024. end of file is detected, or an exception is thrown. Subclasses are encouraged
  29025. to provide a more efficient implementation of this method.</p>
  29026. </summary>
  29027. <param name="b">the buffer into which the data is read.</param>
  29028. <param name="off">the start offset in array <c>b</c> at which the data is written.</param>
  29029. <param name="len">the maximum number of bytes to read.</param>
  29030. <returns>
  29031. the total number of bytes read into the buffer, or
  29032. <c>-1</c> if there is no more data because the end of
  29033. the stream has been reached.</returns>
  29034. <exception cref="T:System.IO.IOException">If the first byte cannot be read for any reason
  29035. other than end of file, or if the input stream has been closed, or if
  29036. some other I/O error occurs.</exception>
  29037. <exception cref="T:System.NullReferenceException">If <c>b</c> is <c>null</c>.</exception>
  29038. <exception cref="T:System.IndexOutOfRangeException">If <c>off</c> is negative,
  29039. <c>len</c> is negative, or <c>len</c> is greater than
  29040. <c>b.length - off</c></exception>
  29041. <see cref="M:NPOI.Util.InputStream.Read"/>
  29042. </member>
  29043. <member name="M:NPOI.Util.InputStream.Skip(System.Int64)">
  29044. <summary>
  29045. Skips over and discards <c>n</c> bytes of data from this input
  29046. stream. The <c>skip</c> method may, for a variety of reasons, end
  29047. up skipping over some smaller number of bytes, possibly <c>0</c>.
  29048. This may result from any of a number of conditions; reaching end of file
  29049. before <c>n</c> bytes have been skipped is only one possibility.
  29050. The actual number of bytes skipped is returned. If {@code n} is
  29051. negative, the {@code skip} method for class {@code InputStream} always
  29052. returns 0, and no bytes are skipped. Subclasses may handle the negative
  29053. value differently.
  29054. <p> The <c>skip</c> method of this class creates a
  29055. byte array and then repeatedly reads into it until <c>n</c> bytes
  29056. have been read or the end of the stream has been reached. Subclasses are
  29057. encouraged to provide a more efficient implementation of this method.
  29058. For instance, the implementation may depend on the ability to seek.</p>
  29059. </summary>
  29060. <param name="n">the number of bytes to be skipped.</param>
  29061. <returns>the actual number of bytes skipped.</returns>
  29062. <exception cref="T:System.IO.IOException">if the stream does not support seek,
  29063. or if some other I/O error occurs.
  29064. </exception>
  29065. </member>
  29066. <member name="M:NPOI.Util.InputStream.Available">
  29067. <summary>
  29068. Returns an estimate of the number of bytes that can be read (or
  29069. skipped over) from this input stream without blocking by the next
  29070. invocation of a method for this input stream. The next invocation
  29071. might be the same thread or another thread. A single read or skip of this
  29072. many bytes will not block, but may read or skip fewer bytes.
  29073. <p> Note that while some implementations of {@code InputStream} will return
  29074. the total number of bytes in the stream, many will not. It is
  29075. never correct to use the return value of this method to allocate
  29076. a buffer intended to hold all data in this stream.</p>
  29077. <p> A subclass' implementation of this method may choose to throw an
  29078. {@link IOException} if this input stream has been closed by
  29079. invoking the {@link #close()} method.</p>
  29080. <p> The {@code available} method for class {@code InputStream} always
  29081. returns {@code 0}.</p>
  29082. <p> This method should be overridden by subclasses.</p>
  29083. </summary>
  29084. <exception cref="T:System.IO.IOException">if an I/O error occurs.</exception>
  29085. </member>
  29086. <member name="M:NPOI.Util.InputStream.Close">
  29087. <summary>
  29088. Closes this input stream and releases any system resources associated
  29089. with the stream.
  29090. <p> The <c>Close</c> method of <c>InputStream</c> does nothing.</p>
  29091. </summary>
  29092. <exception cref="T:System.IO.IOException">if an I/O error occurs.</exception>
  29093. </member>
  29094. <member name="M:NPOI.Util.InputStream.Mark(System.Int32)">
  29095. <summary>
  29096. Marks the current position in this input stream. A subsequent call to
  29097. the <c>reset</c> method repositions this stream at the last marked
  29098. position so that subsequent reads re-read the same bytes.
  29099. <p> The <c>readlimit</c> arguments tells this input stream to
  29100. allow that many bytes to be read before the mark position gets
  29101. invalidated.</p>
  29102. <p> The general contract of <c>mark</c> is that, if the method
  29103. <c>markSupported</c> returns <c>true</c>, the stream somehow
  29104. remembers all the bytes read after the call to <c>mark</c> and
  29105. stands ready to supply those same bytes again if and whenever the method
  29106. <c>reset</c> is called. However, the stream is not required to
  29107. remember any data at all if more than <c>readlimit</c> bytes are
  29108. read from the stream before <c>reset</c> is called.</p>
  29109. <p> Marking a closed stream should not have any effect on the stream.</p>
  29110. <p> The <c>mark</c> method of <c>InputStream</c> does
  29111. nothing.</p>
  29112. </summary>
  29113. <param name="readlimit">the maximum limit of bytes that can be read before
  29114. the mark position becomes invalid.
  29115. </param>
  29116. <see cref="M:NPOI.Util.InputStream.Reset"/>
  29117. </member>
  29118. <member name="M:NPOI.Util.InputStream.Reset">
  29119. <summary>
  29120. Repositions this stream to the position at the time the
  29121. <c>mark</c> method was last called on this input stream.
  29122. <p> The general contract of <c>reset</c> is:</p>
  29123. <ul>
  29124. <li> If the method <c>markSupported</c> returns
  29125. <c>true</c>, then:
  29126. <ul><li> If the method <c>mark</c> has not been called since
  29127. the stream was created, or the number of bytes read from the stream
  29128. since <c>mark</c> was last called is larger than the argument
  29129. to <c>mark</c> at that last call, then an
  29130. <c>IOException</c> might be thrown.</li>
  29131. <li> If such an <c>IOException</c> is not thrown, then the
  29132. stream is reset to a state such that all the bytes read since the
  29133. most recent call to <c>mark</c> (or since the start of the
  29134. file, if <c>mark</c> has not been called) will be resupplied
  29135. to subsequent callers of the <c>read</c> method, followed by
  29136. any bytes that otherwise would have been the next input data as of
  29137. the time of the call to <c>reset</c>. </li>
  29138. <li> If the method <c>markSupported</c> returns
  29139. <c>false</c>, then:
  29140. <ul><li> The call to <c>reset</c> may throw an
  29141. <c>IOException</c>.</li>
  29142. <li> If an <c>IOException</c> is not thrown, then the stream
  29143. is reset to a fixed state that depends on the particular type of the
  29144. input stream and how it was created. The bytes that will be supplied
  29145. to subsequent callers of the <c>read</c> method depend on the
  29146. particular type of the input stream. </li></ul></li></ul></li></ul>
  29147. <p>The method <c>reset</c> for class <c>InputStream</c>
  29148. does nothing except throw an <c>IOException</c>.</p>
  29149. </summary>
  29150. </member>
  29151. <member name="M:NPOI.Util.InputStream.MarkSupported">
  29152. <summary>
  29153. Tests if this input stream supports the <c>mark</c> and
  29154. <c>reset</c> methods. Whether or not <c>mark</c> and
  29155. <c>reset</c> are supported is an invariant property of a
  29156. particular input stream instance. The <c>markSupported</c> method
  29157. of <c>InputStream</c> returns <c>false</c>.
  29158. </summary>
  29159. <returns>
  29160. <c>true</c> if this stream instance supports the mark
  29161. and reset methods; <c>false</c> otherwise.
  29162. <see cref="M:NPOI.Util.InputStream.Mark(System.Int32)"/>
  29163. <see cref="M:NPOI.Util.InputStream.Reset"/>
  29164. </returns>
  29165. </member>
  29166. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32)">
  29167. <summary>
  29168. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing byte array class.
  29169. </summary>
  29170. <param name="offset">offset of the field within its byte array.</param>
  29171. </member>
  29172. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32)">
  29173. <summary>
  29174. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  29175. byte array and initialize its value
  29176. </summary>
  29177. <param name="offset">offset of the field within its byte array</param>
  29178. <param name="value">the initial value</param>
  29179. </member>
  29180. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Byte[])">
  29181. <summary>
  29182. Construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  29183. byte array and initialize its value from its byte array
  29184. </summary>
  29185. <param name="offset">offset of the field within its byte array</param>
  29186. <param name="data">the byte array to Read the value from</param>
  29187. </member>
  29188. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32,System.Byte[])">
  29189. <summary>
  29190. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  29191. byte array, initialize its value, and write the value to a byte
  29192. </summary>
  29193. <param name="offset">offset of the field within its byte array</param>
  29194. <param name="value">the initial value</param>
  29195. <param name="data">the byte array to write the value to</param>
  29196. </member>
  29197. <member name="P:NPOI.Util.IntegerField.Value">
  29198. <summary>
  29199. get or Set the IntegerField's current value
  29200. </summary>
  29201. <value>The value.</value>
  29202. <returns></returns>
  29203. </member>
  29204. <member name="M:NPOI.Util.IntegerField.Set(System.Int32,System.Byte[])">
  29205. <summary>
  29206. Set the IntegerField's current value and write it to a byte array
  29207. </summary>
  29208. <param name="value">value to be Set</param>
  29209. <param name="data">the byte array to write the value to</param>
  29210. </member>
  29211. <member name="M:NPOI.Util.IntegerField.ReadFromBytes(System.Byte[])">
  29212. <summary>
  29213. Set the value from its offset into an array of bytes
  29214. </summary>
  29215. <param name="data">The data.</param>
  29216. </member>
  29217. <member name="M:NPOI.Util.IntegerField.ReadFromStream(System.IO.Stream)">
  29218. <summary>
  29219. Set the value from an Stream
  29220. </summary>
  29221. <param name="stream">the Stream from which the value is to be Read</param>
  29222. </member>
  29223. <member name="M:NPOI.Util.IntegerField.WriteToBytes(System.Byte[])">
  29224. <summary>
  29225. write the value out to an array of bytes at the appropriate offset
  29226. </summary>
  29227. <param name="data"> the array of bytes to which the value is to be written </param>
  29228. </member>
  29229. <member name="M:NPOI.Util.IntegerField.Write(System.Int32,System.Int32,System.Byte[])">
  29230. <summary>
  29231. Same as using the constructor <see cref="T:NPOI.Util.IntegerField"/> with the same
  29232. parameter list. Avoid creation of an useless object.
  29233. </summary>
  29234. <param name="offset">offset of the field within its byte array</param>
  29235. <param name="value">the initial value</param>
  29236. <param name="data">the byte array to write the value to</param>
  29237. </member>
  29238. <member name="M:NPOI.Util.IntegerField.ToString">
  29239. <summary>
  29240. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29241. </summary>
  29242. <returns>
  29243. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29244. </returns>
  29245. </member>
  29246. <member name="T:NPOI.Util.IntList">
  29247. <summary>
  29248. 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
  29249. the mimicry of List is as follows:
  29250. <ul>
  29251. <li> if possible, operations designated 'optional' in the List
  29252. interface are attempted</li>
  29253. <li> wherever the List interface refers to an Object, substitute
  29254. int</li>
  29255. <li> wherever the List interface refers to a Collection or List,
  29256. substitute IntList</li>
  29257. </ul>
  29258. the mimicry is not perfect, however:
  29259. <ul>
  29260. <li> operations involving Iterators or ListIterators are not
  29261. supported</li>
  29262. <li> Remove(Object) becomes RemoveValue to distinguish it from
  29263. Remove(int index)</li>
  29264. <li> subList is not supported</li>
  29265. </ul>
  29266. @author Marc Johnson
  29267. </summary>
  29268. </member>
  29269. <member name="M:NPOI.Util.IntList.#ctor">
  29270. <summary>
  29271. create an IntList of default size
  29272. </summary>
  29273. </member>
  29274. <member name="M:NPOI.Util.IntList.#ctor(NPOI.Util.IntList)">
  29275. <summary>
  29276. create a copy of an existing IntList
  29277. </summary>
  29278. <param name="list">the existing IntList</param>
  29279. </member>
  29280. <member name="M:NPOI.Util.IntList.#ctor(System.Int32,System.Int32)">
  29281. <summary>
  29282. create an IntList with a predefined Initial size
  29283. </summary>
  29284. <param name="initialCapacity">the size for the internal array</param>
  29285. <param name="fillvalue"></param>
  29286. </member>
  29287. <member name="M:NPOI.Util.IntList.Add(System.Int32,System.Int32)">
  29288. <summary>
  29289. add the specfied value at the specified index
  29290. </summary>
  29291. <param name="index">the index where the new value is to be Added</param>
  29292. <param name="value">the new value</param>
  29293. </member>
  29294. <member name="M:NPOI.Util.IntList.Add(System.Int32)">
  29295. <summary>
  29296. Appends the specified element to the end of this list
  29297. </summary>
  29298. <param name="value">element to be Appended to this list.</param>
  29299. <returns>return true (as per the general contract of the Collection.add method</returns>
  29300. </member>
  29301. <member name="M:NPOI.Util.IntList.AddAll(NPOI.Util.IntList)">
  29302. <summary>
  29303. Appends all of the elements in the specified collection to the
  29304. end of this list, in the order that they are returned by the
  29305. specified collection's iterator. The behavior of this
  29306. operation is unspecified if the specified collection is
  29307. modified while the operation is in progress. (Note that this
  29308. will occur if the specified collection is this list, and it's
  29309. nonempty.)
  29310. </summary>
  29311. <param name="c">collection whose elements are to be Added to this list.</param>
  29312. <returns>return true if this list Changed as a result of the call.</returns>
  29313. </member>
  29314. <member name="M:NPOI.Util.IntList.AddAll(System.Int32,NPOI.Util.IntList)">
  29315. <summary>
  29316. Inserts all of the elements in the specified collection into
  29317. this list at the specified position. Shifts the element
  29318. currently at that position (if any) and any subsequent elements
  29319. to the right (increases their indices). The new elements will
  29320. appear in this list in the order that they are returned by the
  29321. specified collection's iterator. The behavior of this
  29322. operation is unspecified if the specified collection is
  29323. modified while the operation is in progress. (Note that this
  29324. will occur if the specified collection is this list, and it's
  29325. nonempty.)
  29326. </summary>
  29327. <param name="index">index at which to insert first element from the specified collection.</param>
  29328. <param name="c">elements to be inserted into this list.</param>
  29329. <returns>return true if this list Changed as a result of the call.</returns>
  29330. </member>
  29331. <member name="M:NPOI.Util.IntList.Clear">
  29332. <summary>
  29333. Removes all of the elements from this list. This list will be
  29334. empty After this call returns (unless it throws an exception).
  29335. </summary>
  29336. </member>
  29337. <member name="M:NPOI.Util.IntList.Contains(System.Int32)">
  29338. <summary>
  29339. Returns true if this list Contains the specified element. More
  29340. formally, returns true if and only if this list Contains at
  29341. least one element e such that o == e
  29342. </summary>
  29343. <param name="o">element whose presence in this list is to be Tested.</param>
  29344. <returns>return true if this list Contains the specified element.</returns>
  29345. </member>
  29346. <member name="M:NPOI.Util.IntList.ContainsAll(NPOI.Util.IntList)">
  29347. <summary>
  29348. Returns true if this list Contains all of the elements of the
  29349. specified collection.
  29350. </summary>
  29351. <param name="c">collection to be Checked for Containment in this list.</param>
  29352. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  29353. </member>
  29354. <member name="M:NPOI.Util.IntList.Equals(System.Object)">
  29355. <summary>
  29356. Compares the specified object with this list for Equality.
  29357. Returns true if and only if the specified object is also a
  29358. list, both lists have the same size, and all corresponding
  29359. pairs of elements in the two lists are Equal. (Two elements e1
  29360. and e2 are equal if e1 == e2.) In other words, two lists are
  29361. defined to be equal if they contain the same elements in the
  29362. same order. This defInition ensures that the Equals method
  29363. works properly across different implementations of the List
  29364. interface.
  29365. </summary>
  29366. <param name="o">the object to be Compared for Equality with this list.</param>
  29367. <returns>return true if the specified object is equal to this list.</returns>
  29368. </member>
  29369. <member name="M:NPOI.Util.IntList.Get(System.Int32)">
  29370. <summary>
  29371. Returns the element at the specified position in this list.
  29372. </summary>
  29373. <param name="index">index of element to return.</param>
  29374. <returns>return the element at the specified position in this list.</returns>
  29375. </member>
  29376. <member name="M:NPOI.Util.IntList.GetHashCode">
  29377. <summary>
  29378. Returns the hash code value for this list. The hash code of a
  29379. list is defined to be the result of the following calculation:
  29380. <code>
  29381. hashCode = 1;
  29382. Iterator i = list.Iterator();
  29383. while (i.HasNext()) {
  29384. Object obj = i.Next();
  29385. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  29386. }
  29387. </code>
  29388. This ensures that list1.Equals(list2) implies that
  29389. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  29390. list2, as required by the general contract of Object.HashCode.
  29391. </summary>
  29392. <returns>return the hash code value for this list.</returns>
  29393. </member>
  29394. <member name="M:NPOI.Util.IntList.IndexOf(System.Int32)">
  29395. <summary>
  29396. Returns the index in this list of the first occurrence of the
  29397. specified element, or -1 if this list does not contain this
  29398. element. More formally, returns the lowest index i such that
  29399. (o == Get(i)), or -1 if there is no such index.
  29400. </summary>
  29401. <param name="o">element to search for.</param>
  29402. <returns>return the index in this list of the first occurrence of the
  29403. specified element, or -1 if this list does not contain
  29404. this element.</returns>
  29405. </member>
  29406. <member name="M:NPOI.Util.IntList.IsEmpty">
  29407. <summary>
  29408. Returns true if this list Contains no elements.
  29409. </summary>
  29410. <returns>return true if this list Contains no elements.</returns>
  29411. </member>
  29412. <member name="M:NPOI.Util.IntList.LastIndexOf(System.Int32)">
  29413. <summary>
  29414. Returns the index in this list of the last occurrence of the
  29415. specified element, or -1 if this list does not contain this
  29416. element. More formally, returns the highest index i such that
  29417. (o == Get(i)), or -1 if there is no such index.
  29418. </summary>
  29419. <param name="o">element to search for.</param>
  29420. <returns>the index in this list of the last occurrence of the
  29421. specified element, or -1 if this list does not contain
  29422. this element.
  29423. </returns>
  29424. </member>
  29425. <member name="M:NPOI.Util.IntList.Remove(System.Int32)">
  29426. <summary>
  29427. Removes the element at the specified position in this list.
  29428. Shifts any subsequent elements to the left (subtracts one from
  29429. their indices). Returns the element that was Removed from the
  29430. list.
  29431. </summary>
  29432. <param name="index">the index of the element to Removed.</param>
  29433. <returns>return the element previously at the specified position.</returns>
  29434. </member>
  29435. <member name="M:NPOI.Util.IntList.RemoveValue(System.Int32)">
  29436. <summary>
  29437. Removes the first occurrence in this list of the specified
  29438. element (optional operation). If this list does not contain
  29439. the element, it is unChanged. More formally, Removes the
  29440. element with the lowest index i such that (o.Equals(get(i)))
  29441. (if such an element exists).
  29442. </summary>
  29443. <param name="o">element to be Removed from this list, if present.</param>
  29444. <returns>return true if this list Contained the specified element.</returns>
  29445. </member>
  29446. <member name="M:NPOI.Util.IntList.RemoveAll(NPOI.Util.IntList)">
  29447. <summary>
  29448. Removes from this list all the elements that are Contained in
  29449. the specified collection
  29450. </summary>
  29451. <param name="c">collection that defines which elements will be Removed from the list.</param>
  29452. <returns>return true if this list Changed as a result of the call.</returns>
  29453. </member>
  29454. <member name="M:NPOI.Util.IntList.RetainAll(NPOI.Util.IntList)">
  29455. <summary>
  29456. Retains only the elements in this list that are Contained in
  29457. the specified collection. In other words, Removes from this
  29458. list all the elements that are not Contained in the specified
  29459. collection.
  29460. </summary>
  29461. <param name="c">collection that defines which elements this Set will retain.</param>
  29462. <returns>return true if this list Changed as a result of the call.</returns>
  29463. </member>
  29464. <member name="M:NPOI.Util.IntList.Set(System.Int32,System.Int32)">
  29465. <summary>
  29466. Replaces the element at the specified position in this list with the specified element
  29467. </summary>
  29468. <param name="index">index of element to Replace.</param>
  29469. <param name="element">element to be stored at the specified position.</param>
  29470. <returns>the element previously at the specified position.</returns>
  29471. </member>
  29472. <member name="M:NPOI.Util.IntList.Size">
  29473. <summary>
  29474. Returns the number of elements in this list. If this list
  29475. Contains more than Int32.MaxValue elements, returns
  29476. Int32.MaxValue.
  29477. </summary>
  29478. <returns>the number of elements in this IntList</returns>
  29479. </member>
  29480. <member name="P:NPOI.Util.IntList.Count">
  29481. <summary>
  29482. the number of elements in this IntList
  29483. </summary>
  29484. </member>
  29485. <member name="M:NPOI.Util.IntList.ToArray">
  29486. <summary>
  29487. Returns an array Containing all of the elements in this list in
  29488. proper sequence. Obeys the general contract of the
  29489. Collection.ToArray method.
  29490. </summary>
  29491. <returns>an array Containing all of the elements in this list in proper sequence.</returns>
  29492. </member>
  29493. <member name="M:NPOI.Util.IntList.ToArray(System.Int32[])">
  29494. <summary>
  29495. Returns an array Containing all of the elements in this list in
  29496. proper sequence. Obeys the general contract of the
  29497. Collection.ToArray(Object[]) method.
  29498. </summary>
  29499. <param name="a">the array into which the elements of this list are to
  29500. be stored, if it is big enough; otherwise, a new array
  29501. is allocated for this purpose.</param>
  29502. <returns>return an array Containing the elements of this list.</returns>
  29503. </member>
  29504. <member name="T:NPOI.Util.IntMapper`1">
  29505. <summary>
  29506. A List of objects that are indexed AND keyed by an int; also allows for Getting
  29507. the index of a value in the list
  29508. <p>I am happy is someone wants to re-implement this without using the
  29509. internal list and hashmap. If so could you please make sure that
  29510. you can add elements half way into the list and have the value-key mappings
  29511. update</p>
  29512. </summary>
  29513. <typeparam name="T"></typeparam>
  29514. <remarks>@author Jason Height</remarks>
  29515. </member>
  29516. <member name="M:NPOI.Util.IntMapper`1.#ctor">
  29517. <summary>
  29518. create an IntMapper of default size
  29519. </summary>
  29520. </member>
  29521. <member name="M:NPOI.Util.IntMapper`1.Add(`0)">
  29522. <summary>
  29523. Appends the specified element to the end of this list
  29524. </summary>
  29525. <param name="value">element to be Appended to this list.</param>
  29526. <returns>return true (as per the general contract of the Collection.add method)</returns>
  29527. </member>
  29528. <member name="P:NPOI.Util.IntMapper`1.Size">
  29529. <summary>
  29530. Gets the size.
  29531. </summary>
  29532. </member>
  29533. <member name="P:NPOI.Util.IntMapper`1.Item(System.Int32)">
  29534. <summary>
  29535. Gets the T object at the specified index.
  29536. </summary>
  29537. <param name="index"></param>
  29538. <returns></returns>
  29539. </member>
  29540. <member name="M:NPOI.Util.IntMapper`1.GetIndex(`0)">
  29541. <summary>
  29542. Gets the index of T object.
  29543. </summary>
  29544. <param name="o">The o.</param>
  29545. <returns></returns>
  29546. </member>
  29547. <member name="M:NPOI.Util.IntMapper`1.GetEnumerator">
  29548. <summary>
  29549. Gets the enumerator.
  29550. </summary>
  29551. <returns></returns>
  29552. </member>
  29553. <member name="T:NPOI.Util.IDelayableLittleEndianOutput">
  29554. <summary>
  29555. Implementors of this interface allow client code to 'delay' writing to a certain section of a
  29556. data output stream.<br/>
  29557. A typical application is for writing BIFF records when the size is not known until well after
  29558. the header has been written. The client code can call <see cref="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput"/>
  29559. to reserve two bytes of the output for the 'ushort size' header field. The delayed output can
  29560. be written at any stage.
  29561. </summary>
  29562. <remarks>@author Josh Micich</remarks>
  29563. </member>
  29564. <member name="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput(System.Int32)">
  29565. <summary>
  29566. Creates an output stream intended for outputting a sequence of <c>size</c> bytes.
  29567. </summary>
  29568. <param name="size"></param>
  29569. <returns></returns>
  29570. </member>
  29571. <member name="M:NPOI.Util.IOUtils.PeekFirst8Bytes(NPOI.Util.InputStream)">
  29572. Peeks at the first 8 bytes of the stream. Returns those bytes, but
  29573. with the stream unaffected. Requires a stream that supports mark/reset,
  29574. or a PushbackInputStream. If the stream has &gt;0 but &lt;8 bytes,
  29575. remaining bytes will be zero.
  29576. @throws EmptyFileException if the stream is empty
  29577. </member>
  29578. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream)">
  29579. <summary>
  29580. Reads all the data from the input stream, and returns
  29581. the bytes Read.
  29582. </summary>
  29583. <param name="stream">The stream.</param>
  29584. <returns></returns>
  29585. <remarks>Tony Qu changed the code</remarks>
  29586. </member>
  29587. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream,System.Int32)">
  29588. <summary>
  29589. Reads up to {@code length} bytes from the input stream, and returns the bytes read.
  29590. </summary>
  29591. <param name="stream"></param>
  29592. <param name="length"></param>
  29593. <returns></returns>
  29594. </member>
  29595. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[])">
  29596. <summary>
  29597. Reads the fully.
  29598. </summary>
  29599. <param name="stream">The stream.</param>
  29600. <param name="b">The b.</param>
  29601. <returns></returns>
  29602. </member>
  29603. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  29604. <summary>
  29605. Same as the normal InputStream#read(byte[], int, int), but tries to ensure
  29606. that the buffer is filled completely if possible, i.e. b.remaining()
  29607. returns 0.
  29608. If the end of file is reached before any bytes are Read, returns -1.
  29609. If the end of the file is reached after some bytes are read, returns the
  29610. number of bytes read. If the end of the file isn't reached before the
  29611. buffer has no more remaining capacity, will return the number of bytes
  29612. that were read.
  29613. </summary>
  29614. <param name="stream">the stream from which the data is read.</param>
  29615. <param name="b">the buffer into which the data is read.</param>
  29616. <param name="off">the start offset in array b at which the data is written.</param>
  29617. <param name="len">the maximum number of bytes to read.</param>
  29618. <returns></returns>
  29619. </member>
  29620. <member name="M:NPOI.Util.IOUtils.Copy(System.IO.Stream,System.IO.Stream)">
  29621. <summary>
  29622. Copies all the data from the given InputStream to the OutputStream. It
  29623. leaves both streams open, so you will still need to close them once done.
  29624. </summary>
  29625. <param name="inp"></param>
  29626. <param name="out1"></param>
  29627. </member>
  29628. <member name="M:NPOI.Util.IOUtils.CloseQuietly(System.IO.Stream)">
  29629. Quietly (no exceptions) close Closable resource. In case of error it will
  29630. be printed to {@link IOUtils} class logger.
  29631. @param closeable
  29632. resource to close
  29633. </member>
  29634. <member name="T:NPOI.Util.LittleEndianByteArrayInputStream">
  29635. <summary>
  29636. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianInput"/>
  29637. </summary>
  29638. <remarks>@author Josh Micich</remarks>
  29639. </member>
  29640. <member name="T:NPOI.Util.LittleEndianByteArrayOutputStream">
  29641. <summary>
  29642. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  29643. </summary>
  29644. <remarks>@author Josh Micich</remarks>
  29645. </member>
  29646. <member name="T:NPOI.Util.ILittleEndianInput">
  29647. @author Josh Micich
  29648. </member>
  29649. <member name="T:NPOI.Util.LittleEndianInputStream">
  29650. <summary>
  29651. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianInput"/><p/>
  29652. This class does not buffer any input, so the stream Read position maintained
  29653. by this class is consistent with that of the inner stream.
  29654. </summary>
  29655. <remarks>
  29656. @author Josh Micich
  29657. </remarks>
  29658. </member>
  29659. <member name="M:NPOI.Util.LittleEndianInputStream.Read(System.Byte[])">
  29660. <summary>
  29661. Reads up to <code>byte.length</code> bytes of data from this
  29662. input stream into an array of bytes. This method blocks until some
  29663. input is available.
  29664. simulate java FilterInputStream
  29665. </summary>
  29666. <param name="b"></param>
  29667. <returns></returns>
  29668. </member>
  29669. <member name="M:NPOI.Util.LittleEndianInputStream.Read(System.Byte[],System.Int32,System.Int32)">
  29670. <summary>
  29671. Reads up to <code>len</code> bytes of data from this input stream
  29672. into an array of bytes.If<code> len</code> is not zero, the method
  29673. blocks until some input is available; otherwise, no
  29674. bytes are read and<code>0</code> is returned.
  29675. simulate java FilterInputStream
  29676. </summary>
  29677. <param name="b"></param>
  29678. <param name="off"></param>
  29679. <param name="len"></param>
  29680. <returns></returns>
  29681. </member>
  29682. <member name="T:NPOI.Util.ILittleEndianOutput">
  29683. @author Josh Micich
  29684. </member>
  29685. <member name="T:NPOI.Util.LittleEndianOutputStream">
  29686. <summary>
  29687. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  29688. </summary>
  29689. <remarks>@author Josh Micich</remarks>
  29690. </member>
  29691. <member name="T:NPOI.Util.LittleEndian">
  29692. <summary>
  29693. a utility class for handling little-endian numbers, which the 80x86 world is
  29694. replete with. The methods are all static, and input/output is from/to byte
  29695. arrays, or from InputStreams.
  29696. </summary>
  29697. <remarks>
  29698. @author Marc Johnson (mjohnson at apache dot org)
  29699. @author Andrew Oliver (acoliver at apache dot org)
  29700. </remarks>
  29701. </member>
  29702. <member name="M:NPOI.Util.LittleEndian.#ctor">
  29703. <summary>
  29704. Initializes a new instance of the <see cref="T:NPOI.Util.LittleEndian"/> class.
  29705. </summary>
  29706. </member>
  29707. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[],System.Int32)">
  29708. <summary>
  29709. get a short value from a byte array
  29710. </summary>
  29711. <param name="data">the byte array</param>
  29712. <param name="offset">a starting offset into the byte array</param>
  29713. <returns>the short (16-bit) value</returns>
  29714. </member>
  29715. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[],System.Int32)">
  29716. <summary>
  29717. get an unsigned short value from a byte array
  29718. </summary>
  29719. <param name="data">the byte array</param>
  29720. <param name="offset">a starting offset into the byte array</param>
  29721. <returns>the unsigned short (16-bit) value in an integer</returns>
  29722. </member>
  29723. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[])">
  29724. <summary>
  29725. get a short value from a byte array
  29726. </summary>
  29727. <param name="data">a starting offset into the byte array</param>
  29728. <returns>the short (16-bit) value</returns>
  29729. </member>
  29730. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[])">
  29731. <summary>
  29732. get a short value from a byte array
  29733. </summary>
  29734. <param name="data">the unsigned short (16-bit) value in an integer</param>
  29735. <returns></returns>
  29736. </member>
  29737. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[],System.Int32)">
  29738. <summary>
  29739. get an int value from a byte array
  29740. </summary>
  29741. <param name="data">the byte array</param>
  29742. <param name="offset">a starting offset into the byte array</param>
  29743. <returns>the int (32-bit) value</returns>
  29744. </member>
  29745. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[])">
  29746. <summary>
  29747. get an int value from the beginning of a byte array
  29748. </summary>
  29749. <param name="data">the byte array</param>
  29750. <returns>the int (32-bit) value</returns>
  29751. </member>
  29752. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[],System.Int32)">
  29753. <summary>
  29754. Gets the U int.
  29755. </summary>
  29756. <param name="data">the byte array</param>
  29757. <param name="offset">a starting offset into the byte array</param>
  29758. <returns>the unsigned int (32-bit) value in a long</returns>
  29759. </member>
  29760. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[])">
  29761. <summary>
  29762. Gets the U int.
  29763. </summary>
  29764. <param name="data">the byte array</param>
  29765. <returns>the unsigned int (32-bit) value in a long</returns>
  29766. </member>
  29767. <member name="M:NPOI.Util.LittleEndian.GetLong(System.Byte[],System.Int32)">
  29768. <summary>
  29769. get a long value from a byte array
  29770. </summary>
  29771. <param name="data">the byte array</param>
  29772. <param name="offset">a starting offset into the byte array</param>
  29773. <returns>the long (64-bit) value</returns>
  29774. </member>
  29775. <member name="M:NPOI.Util.LittleEndian.GetDouble(System.Byte[],System.Int32)">
  29776. <summary>
  29777. get a double value from a byte array, reads it in little endian format
  29778. then converts the resulting revolting IEEE 754 (curse them) floating
  29779. point number to a c# double
  29780. </summary>
  29781. <param name="data">the byte array</param>
  29782. <param name="offset">a starting offset into the byte array</param>
  29783. <returns>the double (64-bit) value</returns>
  29784. </member>
  29785. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int32,System.Int16)">
  29786. <summary>
  29787. Puts the short.
  29788. </summary>
  29789. <param name="data">the byte array</param>
  29790. <param name="offset">a starting offset into the byte array</param>
  29791. <param name="value">The value.</param>
  29792. </member>
  29793. <member name="M:NPOI.Util.LittleEndian.PutByte(System.Byte[],System.Int32,System.Int32)">
  29794. <summary>
  29795. Added for consistency with other put~() methods
  29796. </summary>
  29797. <param name="data">the byte array</param>
  29798. <param name="offset">a starting offset into the byte array</param>
  29799. <param name="value">The value.</param>
  29800. </member>
  29801. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32,System.Int32)">
  29802. <summary>
  29803. Puts the U short.
  29804. </summary>
  29805. <param name="data">the byte array</param>
  29806. <param name="offset">a starting offset into the byte array</param>
  29807. <param name="value">The value.</param>
  29808. </member>
  29809. <member name="M:NPOI.Util.LittleEndian.PutShort(System.IO.Stream,System.Int16)">
  29810. Put signed short into output stream
  29811. @param value
  29812. the short (16-bit) value
  29813. @param outputStream
  29814. output stream
  29815. @throws IOException
  29816. if an I/O error occurs
  29817. </member>
  29818. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32,System.Int32)">
  29819. <summary>
  29820. put an int value into a byte array
  29821. </summary>
  29822. <param name="data">the byte array</param>
  29823. <param name="offset">a starting offset into the byte array</param>
  29824. <param name="value">the int (32-bit) value</param>
  29825. </member>
  29826. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Int32,System.IO.Stream)">
  29827. <summary>
  29828. Put int into output stream
  29829. </summary>
  29830. <param name="value">the int (32-bit) value</param>
  29831. <param name="outputStream">output stream</param>
  29832. </member>
  29833. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int32,System.Int64)">
  29834. <summary>
  29835. put a long value into a byte array
  29836. </summary>
  29837. <param name="data">the byte array</param>
  29838. <param name="offset">a starting offset into the byte array</param>
  29839. <param name="value">the long (64-bit) value</param>
  29840. </member>
  29841. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Int32,System.Double)">
  29842. <summary>
  29843. put a double value into a byte array
  29844. </summary>
  29845. <param name="data">the byte array</param>
  29846. <param name="offset">a starting offset into the byte array</param>
  29847. <param name="value">the double (64-bit) value</param>
  29848. </member>
  29849. <member name="M:NPOI.Util.LittleEndian.ReadShort(System.IO.Stream)">
  29850. <summary>
  29851. Reads the short.
  29852. </summary>
  29853. <param name="stream">The stream.</param>
  29854. <returns></returns>
  29855. </member>
  29856. <member name="M:NPOI.Util.LittleEndian.ReadInt(System.IO.Stream)">
  29857. <summary>
  29858. get an int value from an Stream
  29859. </summary>
  29860. <param name="stream">the Stream from which the int is to be read</param>
  29861. <returns>the int (32-bit) value</returns>
  29862. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  29863. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  29864. </member>
  29865. <member name="M:NPOI.Util.LittleEndian.ReadLong(System.IO.Stream)">
  29866. <summary>
  29867. get a long value from a Stream
  29868. </summary>
  29869. <param name="stream">the Stream from which the long is to be read</param>
  29870. <returns>the long (64-bit) value</returns>
  29871. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  29872. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  29873. </member>
  29874. <member name="M:NPOI.Util.LittleEndian.UByteToInt(System.Byte)">
  29875. <summary>
  29876. Us the byte to int.
  29877. </summary>
  29878. <param name="b">The b.</param>
  29879. <returns></returns>
  29880. </member>
  29881. <member name="M:NPOI.Util.LittleEndian.GetByteArray(System.Byte[],System.Int32,System.Int32)">
  29882. <summary>
  29883. Copy a portion of a byte array
  29884. </summary>
  29885. <param name="data"> the original byte array</param>
  29886. <param name="offset">Where to start copying from.</param>
  29887. <param name="size">Number of bytes to copy.</param>
  29888. <returns>The byteArray value</returns>
  29889. <exception cref="T:System.IndexOutOfRangeException">
  29890. if copying would cause access ofdata outside array bounds.
  29891. </exception>
  29892. </member>
  29893. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[])">
  29894. <summary>
  29895. Gets the unsigned byte.
  29896. </summary>
  29897. <param name="data">the byte array</param>
  29898. <returns></returns>
  29899. </member>
  29900. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[],System.Int32)">
  29901. <summary>
  29902. Gets the unsigned byte.
  29903. </summary>
  29904. <param name="data">the byte array</param>
  29905. <param name="offset">a starting offset into the byte array</param>
  29906. <returns></returns>
  29907. </member>
  29908. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Double)">
  29909. <summary>
  29910. Puts the double.
  29911. </summary>
  29912. <param name="data">the byte array</param>
  29913. <param name="value">The value.</param>
  29914. </member>
  29915. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Double,System.IO.Stream)">
  29916. put a double value into a byte array
  29917. @param value
  29918. the double (64-bit) value
  29919. @param outputStream
  29920. output stream
  29921. @throws IOException
  29922. if an I/O error occurs
  29923. </member>
  29924. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Int64,System.IO.Stream)">
  29925. Put unsigned int into output stream
  29926. @param value
  29927. the int (32-bit) value
  29928. @param outputStream
  29929. output stream
  29930. @throws IOException
  29931. if an I/O error occurs
  29932. </member>
  29933. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.Int32,System.UInt32)">
  29934. <summary>
  29935. Puts the uint.
  29936. </summary>
  29937. <param name="data">the byte array</param>
  29938. <param name="offset">a starting offset into the byte array</param>
  29939. <param name="value">The value.</param>
  29940. </member>
  29941. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int64)">
  29942. <summary>
  29943. Puts the long.
  29944. </summary>
  29945. <param name="data">the byte array</param>
  29946. <param name="value">The value.</param>
  29947. </member>
  29948. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Int64,System.IO.Stream)">
  29949. Put long into output stream
  29950. @param value
  29951. the long (64-bit) value
  29952. @param outputStream
  29953. output stream
  29954. @throws IOException
  29955. if an I/O error occurs
  29956. </member>
  29957. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.UInt64)">
  29958. <summary>
  29959. Puts the long.
  29960. </summary>
  29961. <param name="data">the byte array</param>
  29962. <param name="value">The value.</param>
  29963. </member>
  29964. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.Int32,System.UInt64)">
  29965. <summary>
  29966. Puts the ulong.
  29967. </summary>
  29968. <param name="data">the byte array</param>
  29969. <param name="offset">a starting offset into the byte array</param>
  29970. <param name="value">The value.</param>
  29971. </member>
  29972. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.Int64,System.Int32)">
  29973. <summary>
  29974. Puts the number.
  29975. </summary>
  29976. <param name="data">the byte array</param>
  29977. <param name="offset">a starting offset into the byte array</param>
  29978. <param name="value">The value.</param>
  29979. <param name="size">The size.</param>
  29980. </member>
  29981. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.UInt64,System.Int32)">
  29982. <summary>
  29983. Puts the number.
  29984. </summary>
  29985. <param name="data">the byte array</param>
  29986. <param name="offset">a starting offset into the byte array</param>
  29987. <param name="value">The value.</param>
  29988. <param name="size">The size.</param>
  29989. </member>
  29990. <member name="M:NPOI.Util.LittleEndian.PutShortArray(System.Byte[],System.Int32,System.Int16[])">
  29991. <summary>
  29992. Puts the short array.
  29993. </summary>
  29994. <param name="data">the byte array</param>
  29995. <param name="offset">a starting offset into the byte array</param>
  29996. <param name="value">The value.</param>
  29997. </member>
  29998. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32)">
  29999. <summary>
  30000. Puts the U short.
  30001. </summary>
  30002. <param name="data">the byte array</param>
  30003. <param name="value">The value.</param>
  30004. </member>
  30005. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Int32,System.IO.Stream)">
  30006. Put unsigned short into output stream
  30007. @param value
  30008. the unsigned short (16-bit) value
  30009. @param outputStream
  30010. output stream
  30011. @throws IOException
  30012. if an I/O error occurs
  30013. </member>
  30014. <member name="M:NPOI.Util.LittleEndian.ReadFromStream(System.IO.Stream,System.Int32)">
  30015. <summary>
  30016. Reads from stream.
  30017. </summary>
  30018. <param name="stream">The stream.</param>
  30019. <param name="size">The size.</param>
  30020. <returns></returns>
  30021. </member>
  30022. <member name="M:NPOI.Util.LittleEndian.ReadULong(System.IO.Stream)">
  30023. <summary>
  30024. Reads the long.
  30025. </summary>
  30026. <param name="stream">The stream.</param>
  30027. <returns></returns>
  30028. </member>
  30029. <member name="T:NPOI.Util.LocaleUtil">
  30030. This utility class is used to set locale and time zone settings beside
  30031. of the JDK internal {@link java.util.Locale#setDefault(Locale)} and
  30032. {@link java.util.TimeZone#setDefault(TimeZone)} methods, because
  30033. the locale/time zone specific handling of certain office documents -
  30034. maybe for different time zones / locales ... - shouldn't affect
  30035. other java components.
  30036. The settings are saved in a {@link java.lang.ThreadLocal},
  30037. so they only apply to the current thread and can't be set globally.
  30038. </member>
  30039. <member name="F:NPOI.Util.LocaleUtil.TIMEZONE_UTC">
  30040. Excel doesn't store TimeZone information in the file, so if in doubt,
  30041. use UTC to perform calculations
  30042. </member>
  30043. <member name="F:NPOI.Util.LocaleUtil.CHARSET_1252">
  30044. Default encoding for unknown byte encodings of native files
  30045. (at least it's better than to rely on a platform dependent encoding
  30046. for legacy stuff ...)
  30047. </member>
  30048. <member name="M:NPOI.Util.LocaleUtil.SetUserTimeZone(System.TimeZone)">
  30049. As time zone information is not stored in any format, it can be
  30050. set before any date calculations take place.
  30051. This setting is specific to the current thread.
  30052. @param timezone the timezone under which date calculations take place
  30053. </member>
  30054. <member name="M:NPOI.Util.LocaleUtil.GetUserTimeZone">
  30055. @return the time zone which is used for date calculations, defaults to UTC
  30056. </member>
  30057. <member name="M:NPOI.Util.LocaleUtil.SetUserLocale(System.Globalization.CultureInfo)">
  30058. Sets default user locale.
  30059. This setting is specific to the current thread.
  30060. </member>
  30061. <member name="M:NPOI.Util.LocaleUtil.GetUserLocale">
  30062. @return the default user locale, defaults to {@link Locale#ROOT}
  30063. </member>
  30064. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar">
  30065. @return a calendar for the user locale and time zone
  30066. </member>
  30067. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.Int32,System.Int32,System.Int32)">
  30068. Convenience method - month is 0-based as in java.util.Calendar
  30069. @param year
  30070. @param month
  30071. @param day
  30072. @return a calendar for the user locale and time zone, and the given date
  30073. </member>
  30074. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  30075. Convenience method - month is 0-based as in java.util.Calendar
  30076. @param year
  30077. @param month
  30078. @param day
  30079. @param hour
  30080. @param minute
  30081. @param second
  30082. @return a calendar for the user locale and time zone, and the given date
  30083. </member>
  30084. <member name="M:NPOI.Util.LocaleUtil.GetLocaleCalendar(System.TimeZone)">
  30085. @return a calendar for the user locale and time zone
  30086. </member>
  30087. <member name="M:NPOI.Util.LongField.#ctor(System.Int32)">
  30088. <summary>
  30089. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  30090. </summary>
  30091. <param name="offset">The offset.</param>
  30092. </member>
  30093. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64)">
  30094. <summary>
  30095. construct the LongField with its offset into its containing
  30096. byte array and initialize its value
  30097. </summary>
  30098. <param name="offset">offset of the field within its byte array</param>
  30099. <param name="value">the initial value</param>
  30100. </member>
  30101. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Byte[])">
  30102. <summary>
  30103. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  30104. byte array and initialize its value from its byte array
  30105. </summary>
  30106. <param name="offset">The offset of the field within its byte array</param>
  30107. <param name="data">the byte array to read the value from</param>
  30108. </member>
  30109. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64,System.Byte[])">
  30110. <summary>
  30111. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  30112. byte array, initialize its value, and write the value to a byte
  30113. array
  30114. </summary>
  30115. <param name="offset">offset of the field within its byte array</param>
  30116. <param name="value">the initial value</param>
  30117. <param name="data">the byte array to write the value to</param>
  30118. </member>
  30119. <member name="P:NPOI.Util.LongField.Value">
  30120. <summary>
  30121. Getg or sets the LongField's current value
  30122. </summary>
  30123. <value>The current value</value>
  30124. </member>
  30125. <member name="M:NPOI.Util.LongField.Set(System.Int64,System.Byte[])">
  30126. <summary>
  30127. set the LongField's current value and write it to a byte array
  30128. </summary>
  30129. <param name="value">value to be set</param>
  30130. <param name="data">the byte array to write the value to</param>
  30131. </member>
  30132. <member name="M:NPOI.Util.LongField.ReadFromBytes(System.Byte[])">
  30133. <summary>
  30134. set the value from its offset into an array of bytes
  30135. </summary>
  30136. <param name="data">the byte array from which the value is to be read</param>
  30137. </member>
  30138. <member name="M:NPOI.Util.LongField.ReadFromStream(System.IO.Stream)">
  30139. <summary>
  30140. set the value from an Stream
  30141. </summary>
  30142. <param name="stream">the Stream from which the value is to be</param>
  30143. </member>
  30144. <member name="M:NPOI.Util.LongField.WriteToBytes(System.Byte[])">
  30145. <summary>
  30146. write the value out to an array of bytes at the appropriate offset
  30147. </summary>
  30148. <param name="data">the array of bytes to which the value is to be written</param>
  30149. </member>
  30150. <member name="M:NPOI.Util.LongField.Write(System.Int32,System.Int64,System.Byte[])">
  30151. <summary>
  30152. Same as using the constructor <see cref="T:NPOI.Util.LongField"/> with the same
  30153. parameter list. Avoid creation of an useless object.
  30154. </summary>
  30155. <param name="offset">offset of the field within its byte array</param>
  30156. <param name="value">the initial value</param>
  30157. <param name="data">the byte array to write the value to</param>
  30158. </member>
  30159. <member name="M:NPOI.Util.LongField.ToString">
  30160. <summary>
  30161. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  30162. </summary>
  30163. <returns>
  30164. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  30165. </returns>
  30166. </member>
  30167. <member name="T:NPOI.Util.LZWDecompresser">
  30168. This class provides common functionality for the
  30169. various LZW implementations in the different file
  30170. formats.
  30171. It's currently used by HDGF and HMEF.
  30172. Two good resources on LZW are:
  30173. http://en.wikipedia.org/wiki/LZW
  30174. http://marknelson.us/1989/10/01/lzw-data-compression/
  30175. </member>
  30176. <member name="F:NPOI.Util.LZWDecompresser.maskMeansCompressed">
  30177. Does the mask bit mean it's compressed or uncompressed?
  30178. </member>
  30179. <member name="F:NPOI.Util.LZWDecompresser.codeLengthIncrease">
  30180. How much to append to the code length in the stream
  30181. to Get the real code length? Normally 2 or 3
  30182. </member>
  30183. <member name="F:NPOI.Util.LZWDecompresser.positionIsBigEndian">
  30184. Does the 12 bits of the position Get stored in
  30185. Little Endian or Big Endian form?
  30186. This controls whether a pos+length of 0x12 0x34
  30187. becomes a position of 0x123 or 0x312
  30188. </member>
  30189. <member name="M:NPOI.Util.LZWDecompresser.populateDictionary(System.Byte[])">
  30190. Populates the dictionary, and returns where in it
  30191. to begin writing new codes.
  30192. Generally, if the dictionary is pre-populated, then new
  30193. codes should be placed at the end of that block.
  30194. Equally, if the dictionary is left with all zeros, then
  30195. usually the new codes can go in at the start.
  30196. </member>
  30197. <member name="M:NPOI.Util.LZWDecompresser.adjustDictionaryOffset(System.Int32)">
  30198. Adjusts the position offset if needed when looking
  30199. something up in the dictionary.
  30200. </member>
  30201. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream)">
  30202. Decompresses the given input stream, returning the array of bytes
  30203. of the decompressed input.
  30204. </member>
  30205. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream,System.IO.Stream)">
  30206. Perform a streaming decompression of the input.
  30207. Works by:
  30208. 1) Reading a flag byte, the 8 bits of which tell you if the
  30209. following 8 codes are compressed our un-compressed
  30210. 2) Consider the 8 bits in turn
  30211. 3) If the bit is Set, the next code is un-compressed, so
  30212. add it to the dictionary and output it
  30213. 4) If the bit isn't Set, then read in the length and start
  30214. position in the dictionary, and output the bytes there
  30215. 5) Loop until we've done all 8 bits, then read in the next
  30216. flag byte
  30217. </member>
  30218. <member name="M:NPOI.Util.LZWDecompresser.fromInt(System.Int32)">
  30219. Given an integer, turn it into a java byte, handling
  30220. the wrapping.
  30221. This is a convenience method
  30222. </member>
  30223. <member name="M:NPOI.Util.LZWDecompresser.fromByte(System.Byte)">
  30224. Given a java byte, turn it into an integer between 0
  30225. and 255 (i.e. handle the unwrapping).
  30226. This is a convenience method
  30227. </member>
  30228. <member name="T:NPOI.Util.NullLogger">
  30229. <summary>
  30230. A Logger class that strives to make it as easy as possible for
  30231. developers to write Log calls, while simultaneously making those
  30232. calls as cheap as possible by performing lazy evaluation of the Log
  30233. message.
  30234. @author Marc Johnson (mjohnson at apache dot org)
  30235. @author Glen Stampoultzis (glens at apache.org)
  30236. @author Nicola Ken Barozzi (nicolaken at apache.org)
  30237. </summary>
  30238. </member>
  30239. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object)">
  30240. Log a message
  30241. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30242. @param obj1 The object to Log.
  30243. </member>
  30244. <member name="M:NPOI.Util.NullLogger.Check(System.Int32)">
  30245. Check if a Logger is enabled to Log at the specified level
  30246. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30247. </member>
  30248. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object)">
  30249. Log a message. Lazily appends Object parameters together.
  30250. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30251. @param obj1 first object to place in the message
  30252. @param obj2 second object to place in the message
  30253. </member>
  30254. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  30255. Log a message. Lazily appends Object parameters together.
  30256. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30257. @param obj1 first Object to place in the message
  30258. @param obj2 second Object to place in the message
  30259. @param obj3 third Object to place in the message
  30260. </member>
  30261. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  30262. Log a message. Lazily appends Object parameters together.
  30263. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30264. @param obj1 first Object to place in the message
  30265. @param obj2 second Object to place in the message
  30266. @param obj3 third Object to place in the message
  30267. @param obj4 fourth Object to place in the message
  30268. </member>
  30269. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30270. Log a message. Lazily appends Object parameters together.
  30271. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30272. @param obj1 first Object to place in the message
  30273. @param obj2 second Object to place in the message
  30274. @param obj3 third Object to place in the message
  30275. @param obj4 fourth Object to place in the message
  30276. @param obj5 fifth Object to place in the message
  30277. </member>
  30278. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30279. Log a message. Lazily appends Object parameters together.
  30280. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30281. @param obj1 first Object to place in the message
  30282. @param obj2 second Object to place in the message
  30283. @param obj3 third Object to place in the message
  30284. @param obj4 fourth Object to place in the message
  30285. @param obj5 fifth Object to place in the message
  30286. @param obj6 sixth Object to place in the message
  30287. </member>
  30288. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30289. Log a message. Lazily appends Object parameters together.
  30290. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30291. @param obj1 first Object to place in the message
  30292. @param obj2 second Object to place in the message
  30293. @param obj3 third Object to place in the message
  30294. @param obj4 fourth Object to place in the message
  30295. @param obj5 fifth Object to place in the message
  30296. @param obj6 sixth Object to place in the message
  30297. @param obj7 seventh Object to place in the message
  30298. </member>
  30299. <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)">
  30300. Log a message. Lazily appends Object parameters together.
  30301. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30302. @param obj1 first Object to place in the message
  30303. @param obj2 second Object to place in the message
  30304. @param obj3 third Object to place in the message
  30305. @param obj4 fourth Object to place in the message
  30306. @param obj5 fifth Object to place in the message
  30307. @param obj6 sixth Object to place in the message
  30308. @param obj7 seventh Object to place in the message
  30309. @param obj8 eighth Object to place in the message
  30310. </member>
  30311. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Exception)">
  30312. Log a message
  30313. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30314. @param obj1 The object to Log. This is converted to a string.
  30315. @param exception An exception to be Logged
  30316. </member>
  30317. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  30318. Log a message. Lazily appends Object parameters together.
  30319. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30320. @param obj1 first Object to place in the message
  30321. @param obj2 second Object to place in the message
  30322. @param exception An exception to be Logged
  30323. </member>
  30324. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  30325. Log a message. Lazily appends Object parameters together.
  30326. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30327. @param obj1 first Object to place in the message
  30328. @param obj2 second Object to place in the message
  30329. @param obj3 third object to place in the message
  30330. @param exception An error message to be Logged
  30331. </member>
  30332. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30333. Log a message. Lazily appends Object parameters together.
  30334. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30335. @param obj1 first Object to place in the message
  30336. @param obj2 second Object to place in the message
  30337. @param obj3 third object to place in the message
  30338. @param obj4 fourth object to place in the message
  30339. @param exception An exception to be Logged
  30340. </member>
  30341. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30342. Log a message. Lazily appends Object parameters together.
  30343. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30344. @param obj1 first Object to place in the message
  30345. @param obj2 second Object to place in the message
  30346. @param obj3 third object to place in the message
  30347. @param obj4 fourth object to place in the message
  30348. @param obj5 fifth object to place in the message
  30349. @param exception An exception to be Logged
  30350. </member>
  30351. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30352. Log a message. Lazily appends Object parameters together.
  30353. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30354. @param obj1 first Object to place in the message
  30355. @param obj2 second Object to place in the message
  30356. @param obj3 third object to place in the message
  30357. @param obj4 fourth object to place in the message
  30358. @param obj5 fifth object to place in the message
  30359. @param obj6 sixth object to place in the message
  30360. @param exception An exception to be Logged
  30361. </member>
  30362. <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)">
  30363. Log a message. Lazily appends Object parameters together.
  30364. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30365. @param obj1 first Object to place in the message
  30366. @param obj2 second Object to place in the message
  30367. @param obj3 third object to place in the message
  30368. @param obj4 fourth object to place in the message
  30369. @param obj5 fifth object to place in the message
  30370. @param obj6 sixth object to place in the message
  30371. @param obj7 seventh object to place in the message
  30372. @param exception An exception to be Logged
  30373. </member>
  30374. <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)">
  30375. Log a message. Lazily appends Object parameters together.
  30376. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30377. @param obj1 first Object to place in the message
  30378. @param obj2 second Object to place in the message
  30379. @param obj3 third object to place in the message
  30380. @param obj4 fourth object to place in the message
  30381. @param obj5 fifth object to place in the message
  30382. @param obj6 sixth object to place in the message
  30383. @param obj7 seventh object to place in the message
  30384. @param obj8 eighth object to place in the message
  30385. @param exception An exception to be Logged
  30386. </member>
  30387. <member name="F:NPOI.Util.PngUtils.PNG_FILE_HEADER">
  30388. File header for PNG format.
  30389. </member>
  30390. <member name="M:NPOI.Util.PngUtils.MatchesPngHeader(System.Byte[],System.Int32)">
  30391. Checks if the offset matches the PNG header.
  30392. @param data the data to check.
  30393. @param offset the offset to check at.
  30394. @return {@code true} if the offset matches.
  30395. </member>
  30396. <member name="F:NPOI.Util.POILogFactory._loggers">
  30397. Map of POILogger instances, with classes as keys
  30398. </member>
  30399. <member name="F:NPOI.Util.POILogFactory._nullLogger">
  30400. A common instance of NullLogger, as it does nothing
  30401. we only need the one
  30402. </member>
  30403. <member name="F:NPOI.Util.POILogFactory._loggerClassName">
  30404. The name of the class to use. Initialised the
  30405. first time we need it
  30406. </member>
  30407. <member name="M:NPOI.Util.POILogFactory.#ctor">
  30408. <summary>
  30409. Initializes a new instance of the <see cref="T:NPOI.Util.POILogFactory"/> class.
  30410. </summary>
  30411. </member>
  30412. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.Type)">
  30413. <summary>
  30414. Get a logger, based on a class name
  30415. </summary>
  30416. <param name="type">the class whose name defines the log</param>
  30417. <returns>a POILogger for the specified class</returns>
  30418. </member>
  30419. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.String)">
  30420. <summary>
  30421. Get a logger, based on a String
  30422. </summary>
  30423. <param name="cat">the String that defines the log</param>
  30424. <returns>a POILogger for the specified class</returns>
  30425. </member>
  30426. <member name="M:NPOI.Util.POILogger.#ctor">
  30427. package scope so it cannot be instantiated outside of the util
  30428. package. You need a POILogger? Go to the POILogFactory for one
  30429. </member>
  30430. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object)">
  30431. Log a message
  30432. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30433. @param obj1 The object to Log. This is converted to a string.
  30434. </member>
  30435. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Exception)">
  30436. Log a message
  30437. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30438. @param obj1 The object to Log. This is converted to a string.
  30439. @param exception An exception to be Logged
  30440. </member>
  30441. <member name="M:NPOI.Util.POILogger.Check(System.Int32)">
  30442. Check if a Logger is enabled to Log at the specified level
  30443. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30444. </member>
  30445. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object)">
  30446. Log a message. Lazily appends Object parameters together.
  30447. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30448. @param obj1 first object to place in the message
  30449. @param obj2 second object to place in the message
  30450. </member>
  30451. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  30452. Log a message. Lazily appends Object parameters together.
  30453. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30454. @param obj1 first Object to place in the message
  30455. @param obj2 second Object to place in the message
  30456. @param obj3 third Object to place in the message
  30457. </member>
  30458. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  30459. Log a message. Lazily appends Object parameters together.
  30460. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30461. @param obj1 first Object to place in the message
  30462. @param obj2 second Object to place in the message
  30463. @param obj3 third Object to place in the message
  30464. @param obj4 fourth Object to place in the message
  30465. </member>
  30466. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30467. Log a message. Lazily appends Object parameters together.
  30468. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30469. @param obj1 first Object to place in the message
  30470. @param obj2 second Object to place in the message
  30471. @param obj3 third Object to place in the message
  30472. @param obj4 fourth Object to place in the message
  30473. @param obj5 fifth Object to place in the message
  30474. </member>
  30475. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30476. Log a message. Lazily appends Object parameters together.
  30477. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30478. @param obj1 first Object to place in the message
  30479. @param obj2 second Object to place in the message
  30480. @param obj3 third Object to place in the message
  30481. @param obj4 fourth Object to place in the message
  30482. @param obj5 fifth Object to place in the message
  30483. @param obj6 sixth Object to place in the message
  30484. </member>
  30485. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30486. Log a message. Lazily appends Object parameters together.
  30487. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30488. @param obj1 first Object to place in the message
  30489. @param obj2 second Object to place in the message
  30490. @param obj3 third Object to place in the message
  30491. @param obj4 fourth Object to place in the message
  30492. @param obj5 fifth Object to place in the message
  30493. @param obj6 sixth Object to place in the message
  30494. @param obj7 seventh Object to place in the message
  30495. </member>
  30496. <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)">
  30497. Log a message. Lazily appends Object parameters together.
  30498. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30499. @param obj1 first Object to place in the message
  30500. @param obj2 second Object to place in the message
  30501. @param obj3 third Object to place in the message
  30502. @param obj4 fourth Object to place in the message
  30503. @param obj5 fifth Object to place in the message
  30504. @param obj6 sixth Object to place in the message
  30505. @param obj7 seventh Object to place in the message
  30506. @param obj8 eighth Object to place in the message
  30507. </member>
  30508. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Exception)">
  30509. Log an exception, without a message
  30510. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30511. @param exception An exception to be Logged
  30512. </member>
  30513. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  30514. Log a message. Lazily appends Object parameters together.
  30515. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30516. @param obj1 first Object to place in the message
  30517. @param obj2 second Object to place in the message
  30518. @param exception An exception to be Logged
  30519. </member>
  30520. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  30521. Log a message. Lazily appends Object parameters together.
  30522. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30523. @param obj1 first Object to place in the message
  30524. @param obj2 second Object to place in the message
  30525. @param obj3 third object to place in the message
  30526. @param exception An error message to be Logged
  30527. </member>
  30528. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30529. Log a message. Lazily appends Object parameters together.
  30530. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30531. @param obj1 first Object to place in the message
  30532. @param obj2 second Object to place in the message
  30533. @param obj3 third object to place in the message
  30534. @param obj4 fourth object to place in the message
  30535. @param exception An exception to be Logged
  30536. </member>
  30537. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30538. Log a message. Lazily appends Object parameters together.
  30539. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30540. @param obj1 first Object to place in the message
  30541. @param obj2 second Object to place in the message
  30542. @param obj3 third object to place in the message
  30543. @param obj4 fourth object to place in the message
  30544. @param obj5 fifth object to place in the message
  30545. @param exception An exception to be Logged
  30546. </member>
  30547. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30548. Log a message. Lazily appends Object parameters together.
  30549. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30550. @param obj1 first Object to place in the message
  30551. @param obj2 second Object to place in the message
  30552. @param obj3 third object to place in the message
  30553. @param obj4 fourth object to place in the message
  30554. @param obj5 fifth object to place in the message
  30555. @param obj6 sixth object to place in the message
  30556. @param exception An exception to be Logged
  30557. </member>
  30558. <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)">
  30559. Log a message. Lazily appends Object parameters together.
  30560. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30561. @param obj1 first Object to place in the message
  30562. @param obj2 second Object to place in the message
  30563. @param obj3 third object to place in the message
  30564. @param obj4 fourth object to place in the message
  30565. @param obj5 fifth object to place in the message
  30566. @param obj6 sixth object to place in the message
  30567. @param obj7 seventh object to place in the message
  30568. @param exception An exception to be Logged
  30569. </member>
  30570. <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)">
  30571. Log a message. Lazily appends Object parameters together.
  30572. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30573. @param obj1 first Object to place in the message
  30574. @param obj2 second Object to place in the message
  30575. @param obj3 third object to place in the message
  30576. @param obj4 fourth object to place in the message
  30577. @param obj5 fifth object to place in the message
  30578. @param obj6 sixth object to place in the message
  30579. @param obj7 seventh object to place in the message
  30580. @param obj8 eighth object to place in the message
  30581. @param exception An exception to be Logged
  30582. </member>
  30583. <member name="M:NPOI.Util.PushbackInputStream.ReadByte">
  30584. <summary>
  30585. 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.
  30586. </summary>
  30587. <returns>
  30588. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  30589. </returns>
  30590. <exception cref="T:System.NotSupportedException">
  30591. The stream does not support reading.
  30592. </exception>
  30593. <exception cref="T:System.ObjectDisposedException">
  30594. Methods were called after the stream was closed.
  30595. </exception>
  30596. </member>
  30597. <member name="M:NPOI.Util.PushbackInputStream.Unread(System.Int32)">
  30598. <summary>
  30599. Unreads the specified b.
  30600. </summary>
  30601. <param name="b">The b.</param>
  30602. </member>
  30603. <member name="P:NPOI.Util.PushbackInputStream.CanRead">
  30604. <summary>
  30605. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  30606. </summary>
  30607. <value></value>
  30608. <returns>true if the stream supports reading; otherwise, false.
  30609. </returns>
  30610. </member>
  30611. <member name="M:NPOI.Util.PushbackInputStream.Unread(System.Byte[],System.Int32,System.Int32)">
  30612. <summary>
  30613. Pushes back a portion of an array of bytes by copying it to the front
  30614. of the pushback buffer.
  30615. </summary>
  30616. <param name="b">the byte array to push back.</param>
  30617. <param name="off">the start offset of the data.</param>
  30618. <param name="len">the number of bytes to push back.</param>
  30619. </member>
  30620. <member name="P:NPOI.Util.PushbackInputStream.CanSeek">
  30621. <summary>
  30622. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  30623. </summary>
  30624. <value></value>
  30625. <returns>true if the stream supports seeking; otherwise, false.
  30626. </returns>
  30627. </member>
  30628. <member name="P:NPOI.Util.PushbackInputStream.CanWrite">
  30629. <summary>
  30630. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  30631. </summary>
  30632. <value></value>
  30633. <returns>true if the stream supports writing; otherwise, false.
  30634. </returns>
  30635. </member>
  30636. <member name="P:NPOI.Util.PushbackInputStream.Length">
  30637. <summary>
  30638. When overridden in a derived class, gets the length in bytes of the stream.
  30639. </summary>
  30640. <value></value>
  30641. <returns>
  30642. A long value representing the length of the stream in bytes.
  30643. </returns>
  30644. <exception cref="T:System.NotSupportedException">
  30645. A class derived from Stream does not support seeking.
  30646. </exception>
  30647. <exception cref="T:System.ObjectDisposedException">
  30648. Methods were called after the stream was closed.
  30649. </exception>
  30650. </member>
  30651. <member name="P:NPOI.Util.PushbackInputStream.Position">
  30652. <summary>
  30653. When overridden in a derived class, gets or sets the position within the current stream.
  30654. </summary>
  30655. <value></value>
  30656. <returns>
  30657. The current position within the stream.
  30658. </returns>
  30659. <exception cref="T:System.IO.IOException">
  30660. An I/O error occurs.
  30661. </exception>
  30662. <exception cref="T:System.NotSupportedException">
  30663. The stream does not support seeking.
  30664. </exception>
  30665. <exception cref="T:System.ObjectDisposedException">
  30666. Methods were called after the stream was closed.
  30667. </exception>
  30668. </member>
  30669. <member name="M:NPOI.Util.PushbackInputStream.Close">
  30670. <summary>
  30671. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  30672. </summary>
  30673. </member>
  30674. <member name="M:NPOI.Util.PushbackInputStream.Flush">
  30675. <summary>
  30676. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  30677. </summary>
  30678. <exception cref="T:System.IO.IOException">
  30679. An I/O error occurs.
  30680. </exception>
  30681. </member>
  30682. <member name="M:NPOI.Util.PushbackInputStream.Seek(System.Int64,System.IO.SeekOrigin)">
  30683. <summary>
  30684. When overridden in a derived class, sets the position within the current stream.
  30685. </summary>
  30686. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  30687. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  30688. <returns>
  30689. The new position within the current stream.
  30690. </returns>
  30691. <exception cref="T:System.IO.IOException">
  30692. An I/O error occurs.
  30693. </exception>
  30694. <exception cref="T:System.NotSupportedException">
  30695. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  30696. </exception>
  30697. <exception cref="T:System.ObjectDisposedException">
  30698. Methods were called after the stream was closed.
  30699. </exception>
  30700. </member>
  30701. <member name="M:NPOI.Util.PushbackInputStream.SetLength(System.Int64)">
  30702. <summary>
  30703. When overridden in a derived class, sets the length of the current stream.
  30704. </summary>
  30705. <param name="value">The desired length of the current stream in bytes.</param>
  30706. <exception cref="T:System.IO.IOException">
  30707. An I/O error occurs.
  30708. </exception>
  30709. <exception cref="T:System.NotSupportedException">
  30710. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  30711. </exception>
  30712. <exception cref="T:System.ObjectDisposedException">
  30713. Methods were called after the stream was closed.
  30714. </exception>
  30715. </member>
  30716. <member name="M:NPOI.Util.PushbackInputStream.Write(System.Byte[],System.Int32,System.Int32)">
  30717. <summary>
  30718. 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.
  30719. </summary>
  30720. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  30721. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  30722. <param name="count">The number of bytes to be written to the current stream.</param>
  30723. <exception cref="T:System.ArgumentException">
  30724. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  30725. </exception>
  30726. <exception cref="T:System.ArgumentNullException">
  30727. <paramref name="buffer"/> is null.
  30728. </exception>
  30729. <exception cref="T:System.ArgumentOutOfRangeException">
  30730. <paramref name="offset"/> or <paramref name="count"/> is negative.
  30731. </exception>
  30732. <exception cref="T:System.IO.IOException">
  30733. An I/O error occurs.
  30734. </exception>
  30735. <exception cref="T:System.NotSupportedException">
  30736. The stream does not support writing.
  30737. </exception>
  30738. <exception cref="T:System.ObjectDisposedException">
  30739. Methods were called after the stream was closed.
  30740. </exception>
  30741. </member>
  30742. <member name="M:NPOI.Util.PushbackInputStream.WriteByte(System.Byte)">
  30743. <summary>
  30744. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  30745. </summary>
  30746. <param name="value">The byte to write to the stream.</param>
  30747. <exception cref="T:System.IO.IOException">
  30748. An I/O error occurs.
  30749. </exception>
  30750. <exception cref="T:System.NotSupportedException">
  30751. The stream does not support writing, or the stream is already closed.
  30752. </exception>
  30753. <exception cref="T:System.ObjectDisposedException">
  30754. Methods were called after the stream was closed.
  30755. </exception>
  30756. </member>
  30757. <member name="M:NPOI.Util.PushbackStream.ReadByte">
  30758. <summary>
  30759. 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.
  30760. </summary>
  30761. <returns>
  30762. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  30763. </returns>
  30764. <exception cref="T:System.NotSupportedException">
  30765. The stream does not support reading.
  30766. </exception>
  30767. <exception cref="T:System.ObjectDisposedException">
  30768. Methods were called after the stream was closed.
  30769. </exception>
  30770. </member>
  30771. <member name="M:NPOI.Util.PushbackStream.Read(System.Byte[],System.Int32,System.Int32)">
  30772. <summary>
  30773. 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.
  30774. </summary>
  30775. <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>
  30776. <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>
  30777. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  30778. <returns>
  30779. 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.
  30780. </returns>
  30781. <exception cref="T:System.ArgumentException">
  30782. The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
  30783. </exception>
  30784. <exception cref="T:System.ArgumentNullException">
  30785. <paramref name="buffer"/> is null.
  30786. </exception>
  30787. <exception cref="T:System.ArgumentOutOfRangeException">
  30788. <paramref name="offset"/> or <paramref name="count"/> is negative.
  30789. </exception>
  30790. <exception cref="T:System.IO.IOException">
  30791. An I/O error occurs.
  30792. </exception>
  30793. <exception cref="T:System.NotSupportedException">
  30794. The stream does not support reading.
  30795. </exception>
  30796. <exception cref="T:System.ObjectDisposedException">
  30797. Methods were called after the stream was closed.
  30798. </exception>
  30799. </member>
  30800. <member name="M:NPOI.Util.PushbackStream.Unread(System.Int32)">
  30801. <summary>
  30802. Unreads the specified b.
  30803. </summary>
  30804. <param name="b">The b.</param>
  30805. </member>
  30806. <member name="P:NPOI.Util.PushbackStream.CanRead">
  30807. <summary>
  30808. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  30809. </summary>
  30810. <value></value>
  30811. <returns>true if the stream supports reading; otherwise, false.
  30812. </returns>
  30813. </member>
  30814. <member name="P:NPOI.Util.PushbackStream.CanSeek">
  30815. <summary>
  30816. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  30817. </summary>
  30818. <value></value>
  30819. <returns>true if the stream supports seeking; otherwise, false.
  30820. </returns>
  30821. </member>
  30822. <member name="P:NPOI.Util.PushbackStream.CanWrite">
  30823. <summary>
  30824. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  30825. </summary>
  30826. <value></value>
  30827. <returns>true if the stream supports writing; otherwise, false.
  30828. </returns>
  30829. </member>
  30830. <member name="P:NPOI.Util.PushbackStream.Length">
  30831. <summary>
  30832. When overridden in a derived class, gets the length in bytes of the stream.
  30833. </summary>
  30834. <value></value>
  30835. <returns>
  30836. A long value representing the length of the stream in bytes.
  30837. </returns>
  30838. <exception cref="T:System.NotSupportedException">
  30839. A class derived from Stream does not support seeking.
  30840. </exception>
  30841. <exception cref="T:System.ObjectDisposedException">
  30842. Methods were called after the stream was closed.
  30843. </exception>
  30844. </member>
  30845. <member name="P:NPOI.Util.PushbackStream.Position">
  30846. <summary>
  30847. When overridden in a derived class, gets or sets the position within the current stream.
  30848. </summary>
  30849. <value></value>
  30850. <returns>
  30851. The current position within the stream.
  30852. </returns>
  30853. <exception cref="T:System.IO.IOException">
  30854. An I/O error occurs.
  30855. </exception>
  30856. <exception cref="T:System.NotSupportedException">
  30857. The stream does not support seeking.
  30858. </exception>
  30859. <exception cref="T:System.ObjectDisposedException">
  30860. Methods were called after the stream was closed.
  30861. </exception>
  30862. </member>
  30863. <member name="M:NPOI.Util.PushbackStream.Close">
  30864. <summary>
  30865. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  30866. </summary>
  30867. </member>
  30868. <member name="M:NPOI.Util.PushbackStream.Flush">
  30869. <summary>
  30870. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  30871. </summary>
  30872. <exception cref="T:System.IO.IOException">
  30873. An I/O error occurs.
  30874. </exception>
  30875. </member>
  30876. <member name="M:NPOI.Util.PushbackStream.Seek(System.Int64,System.IO.SeekOrigin)">
  30877. <summary>
  30878. When overridden in a derived class, sets the position within the current stream.
  30879. </summary>
  30880. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  30881. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  30882. <returns>
  30883. The new position within the current stream.
  30884. </returns>
  30885. <exception cref="T:System.IO.IOException">
  30886. An I/O error occurs.
  30887. </exception>
  30888. <exception cref="T:System.NotSupportedException">
  30889. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  30890. </exception>
  30891. <exception cref="T:System.ObjectDisposedException">
  30892. Methods were called after the stream was closed.
  30893. </exception>
  30894. </member>
  30895. <member name="M:NPOI.Util.PushbackStream.SetLength(System.Int64)">
  30896. <summary>
  30897. When overridden in a derived class, sets the length of the current stream.
  30898. </summary>
  30899. <param name="value">The desired length of the current stream in bytes.</param>
  30900. <exception cref="T:System.IO.IOException">
  30901. An I/O error occurs.
  30902. </exception>
  30903. <exception cref="T:System.NotSupportedException">
  30904. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  30905. </exception>
  30906. <exception cref="T:System.ObjectDisposedException">
  30907. Methods were called after the stream was closed.
  30908. </exception>
  30909. </member>
  30910. <member name="M:NPOI.Util.PushbackStream.Write(System.Byte[],System.Int32,System.Int32)">
  30911. <summary>
  30912. 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.
  30913. </summary>
  30914. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  30915. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  30916. <param name="count">The number of bytes to be written to the current stream.</param>
  30917. <exception cref="T:System.ArgumentException">
  30918. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  30919. </exception>
  30920. <exception cref="T:System.ArgumentNullException">
  30921. <paramref name="buffer"/> is null.
  30922. </exception>
  30923. <exception cref="T:System.ArgumentOutOfRangeException">
  30924. <paramref name="offset"/> or <paramref name="count"/> is negative.
  30925. </exception>
  30926. <exception cref="T:System.IO.IOException">
  30927. An I/O error occurs.
  30928. </exception>
  30929. <exception cref="T:System.NotSupportedException">
  30930. The stream does not support writing.
  30931. </exception>
  30932. <exception cref="T:System.ObjectDisposedException">
  30933. Methods were called after the stream was closed.
  30934. </exception>
  30935. </member>
  30936. <member name="M:NPOI.Util.PushbackStream.WriteByte(System.Byte)">
  30937. <summary>
  30938. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  30939. </summary>
  30940. <param name="value">The byte to write to the stream.</param>
  30941. <exception cref="T:System.IO.IOException">
  30942. An I/O error occurs.
  30943. </exception>
  30944. <exception cref="T:System.NotSupportedException">
  30945. The stream does not support writing, or the stream is already closed.
  30946. </exception>
  30947. <exception cref="T:System.ObjectDisposedException">
  30948. Methods were called after the stream was closed.
  30949. </exception>
  30950. </member>
  30951. <member name="T:NPOI.Util.RecordFormatException">
  30952. A common exception thrown by our binary format Parsers
  30953. (especially HSSF and DDF), when they hit invalid
  30954. format or data when Processing a record.
  30955. </member>
  30956. <member name="T:NPOI.Util.RLEDecompressingInputStream">
  30957. Wrapper of InputStream which provides Run Length Encoding (RLE)
  30958. decompression on the fly. Uses MS-OVBA decompression algorithm. See
  30959. http://download.microsoft.com/download/2/4/8/24862317-78F0-4C4B-B355-C7B2C1D997DB/[MS-OVBA].pdf
  30960. </member>
  30961. <member name="F:NPOI.Util.RLEDecompressingInputStream.POWER2">
  30962. Bitmasks for performance
  30963. </member>
  30964. <member name="F:NPOI.Util.RLEDecompressingInputStream.in1">
  30965. the wrapped inputstream
  30966. </member>
  30967. <member name="F:NPOI.Util.RLEDecompressingInputStream.buf">
  30968. a byte buffer with size 4096 for storing a single chunk
  30969. </member>
  30970. <member name="F:NPOI.Util.RLEDecompressingInputStream.pos">
  30971. the current position in the byte buffer for Reading
  30972. </member>
  30973. <member name="F:NPOI.Util.RLEDecompressingInputStream.len">
  30974. the number of bytes in the byte buffer
  30975. </member>
  30976. <member name="M:NPOI.Util.RLEDecompressingInputStream.#ctor(System.IO.Stream)">
  30977. Creates a new wrapper RLE Decompression InputStream.
  30978. @param in The stream to wrap with the RLE Decompression
  30979. @throws IOException
  30980. </member>
  30981. <member name="M:NPOI.Util.RLEDecompressingInputStream.ReadChunk">
  30982. Reads a single chunk from the underlying inputstream.
  30983. @return number of bytes that were Read, or -1 if the end of the stream was reached.
  30984. @throws IOException
  30985. </member>
  30986. <member name="M:NPOI.Util.RLEDecompressingInputStream.GetCopyLenBits(System.Int32)">
  30987. Helper method to determine how many bits in the CopyToken are used for the CopyLength.
  30988. @param offset
  30989. @return returns the number of bits in the copy token (a value between 4 and 12)
  30990. </member>
  30991. <member name="M:NPOI.Util.RLEDecompressingInputStream.ReadShort">
  30992. Convenience method for read a 2-bytes short in little endian encoding.
  30993. @return short value from the stream, -1 if end of stream is reached
  30994. @throws IOException
  30995. </member>
  30996. <member name="M:NPOI.Util.RLEDecompressingInputStream.ReadInt">
  30997. Convenience method for read a 4-bytes int in little endian encoding.
  30998. @return integer value from the stream, -1 if end of stream is reached
  30999. @throws IOException
  31000. </member>
  31001. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32)">
  31002. <summary>
  31003. construct the ShortField with its offset into its containing
  31004. byte array
  31005. </summary>
  31006. <param name="offset">offset of the field within its byte array</param>
  31007. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  31008. </member>
  31009. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16)">
  31010. <summary>
  31011. construct the ShortField with its offset into its containing byte array and initialize its value
  31012. </summary>
  31013. <param name="offset">offset of the field within its byte array</param>
  31014. <param name="value">the initial value</param>
  31015. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  31016. </member>
  31017. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Byte[])">
  31018. <summary>
  31019. Construct the ShortField with its offset into its containing
  31020. byte array and initialize its value from its byte array
  31021. </summary>
  31022. <param name="offset">offset of the field within its byte array</param>
  31023. <param name="data">the byte array to read the value from</param>
  31024. <exception cref="T:System.IndexOutOfRangeException">if the offset is not
  31025. within the range of 0..(data.length - 1)</exception>
  31026. </member>
  31027. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16,System.Byte[]@)">
  31028. <summary>
  31029. construct the ShortField with its offset into its containing
  31030. byte array, initialize its value, and write its value to its
  31031. byte array
  31032. </summary>
  31033. <param name="offset">offset of the field within its byte array</param>
  31034. <param name="value">the initial value</param>
  31035. <param name="data">the byte array to write the value to</param>
  31036. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  31037. </member>
  31038. <member name="P:NPOI.Util.ShortField.Value">
  31039. <summary>
  31040. Gets or sets the value.
  31041. </summary>
  31042. <value>The value.</value>
  31043. </member>
  31044. <member name="M:NPOI.Util.ShortField.Set(System.Int16,System.Byte[]@)">
  31045. <summary>
  31046. set the ShortField's current value and write it to a byte array
  31047. </summary>
  31048. <param name="value">value to be set</param>
  31049. <param name="data">the byte array to write the value to</param>
  31050. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  31051. of range</exception>
  31052. </member>
  31053. <member name="M:NPOI.Util.ShortField.ReadFromBytes(System.Byte[])">
  31054. <summary>
  31055. set the value from its offset into an array of bytes
  31056. </summary>
  31057. <param name="data">the byte array from which the value is to be read</param>
  31058. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  31059. of range</exception>
  31060. </member>
  31061. <member name="M:NPOI.Util.ShortField.ReadFromStream(System.IO.Stream)">
  31062. <summary>
  31063. set the value from an Stream
  31064. </summary>
  31065. <param name="stream">the Stream from which the value is to be
  31066. read</param>
  31067. <exception cref="T:System.IO.IOException">if an IOException is thrown from reading
  31068. the Stream</exception>
  31069. <exception cref="T:NPOI.Util.BufferUnderrunException">if there is not enough data
  31070. available from the Stream</exception>
  31071. </member>
  31072. <member name="M:NPOI.Util.ShortField.WriteToBytes(System.Byte[])">
  31073. <summary>
  31074. write the value out to an array of bytes at the appropriate
  31075. offset
  31076. </summary>
  31077. <param name="data">the array of bytes to which the value is to be
  31078. written</param>
  31079. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  31080. of range</exception>
  31081. </member>
  31082. <member name="M:NPOI.Util.ShortField.Write(System.Int32,System.Int16,System.Byte[]@)">
  31083. <summary>
  31084. Same as using the constructor <see cref="T:NPOI.Util.ShortField"/> with the same
  31085. parameter list. Avoid creation of an useless object.
  31086. </summary>
  31087. <param name="offset">offset of the field within its byte array</param>
  31088. <param name="value">the initial value</param>
  31089. <param name="data">the byte array to write the value to</param>
  31090. </member>
  31091. <member name="M:NPOI.Util.ShortField.ToString">
  31092. <summary>
  31093. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31094. </summary>
  31095. <returns>
  31096. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31097. </returns>
  31098. </member>
  31099. <member name="T:NPOI.Util.ShortList">
  31100. <summary>
  31101. A List of short's; as full an implementation of the java.Util.List
  31102. interface as possible, with an eye toward minimal creation of
  31103. objects
  31104. the mimicry of List is as follows:
  31105. <ul>
  31106. <li> if possible, operations designated 'optional' in the List
  31107. interface are attempted</li>
  31108. <li> wherever the List interface refers to an Object, substitute
  31109. short</li>
  31110. <li> wherever the List interface refers to a Collection or List,
  31111. substitute shortList</li>
  31112. </ul>
  31113. the mimicry is not perfect, however:
  31114. <ul>
  31115. <li> operations involving Iterators or ListIterators are not
  31116. supported</li>
  31117. <li> Remove(Object) becomes RemoveValue to distinguish it from
  31118. Remove(short index)</li>
  31119. <li> subList is not supported</li>
  31120. </ul>
  31121. </summary>
  31122. </member>
  31123. <member name="M:NPOI.Util.ShortList.#ctor">
  31124. <summary>
  31125. create an shortList of default size
  31126. </summary>
  31127. </member>
  31128. <member name="M:NPOI.Util.ShortList.#ctor(NPOI.Util.ShortList)">
  31129. <summary>
  31130. create a copy of an existing shortList
  31131. </summary>
  31132. <param name="list">the existing shortList</param>
  31133. </member>
  31134. <member name="M:NPOI.Util.ShortList.#ctor(System.Int32)">
  31135. <summary>
  31136. create an shortList with a predefined Initial size
  31137. </summary>
  31138. <param name="InitialCapacity">the size for the internal array</param>
  31139. </member>
  31140. <member name="M:NPOI.Util.ShortList.Add(System.Int32,System.Int16)">
  31141. <summary>
  31142. add the specfied value at the specified index
  31143. </summary>
  31144. <param name="index">the index where the new value is to be Added</param>
  31145. <param name="value">the new value</param>
  31146. </member>
  31147. <member name="M:NPOI.Util.ShortList.Add(System.Int16)">
  31148. <summary>
  31149. Appends the specified element to the end of this list
  31150. </summary>
  31151. <param name="value">element to be Appended to this list.</param>
  31152. <returns>return true (as per the general contract of the Collection.add method).</returns>
  31153. </member>
  31154. <member name="M:NPOI.Util.ShortList.AddAll(NPOI.Util.ShortList)">
  31155. <summary>
  31156. Appends all of the elements in the specified collection to the
  31157. end of this list, in the order that they are returned by the
  31158. specified collection's iterator. The behavior of this
  31159. operation is unspecified if the specified collection is
  31160. modified while the operation is in progress. (Note that this
  31161. will occur if the specified collection is this list, and it's
  31162. nonempty.)
  31163. </summary>
  31164. <param name="c">collection whose elements are to be Added to this list.</param>
  31165. <returns>return true if this list Changed as a result of the call.</returns>
  31166. </member>
  31167. <member name="M:NPOI.Util.ShortList.AddAll(System.Int32,NPOI.Util.ShortList)">
  31168. <summary>
  31169. Inserts all of the elements in the specified collection into
  31170. this list at the specified position. Shifts the element
  31171. currently at that position (if any) and any subsequent elements
  31172. to the right (increases their indices). The new elements will
  31173. appear in this list in the order that they are returned by the
  31174. specified collection's iterator. The behavior of this
  31175. operation is unspecified if the specified collection is
  31176. modified while the operation is in progress. (Note that this
  31177. will occur if the specified collection is this list, and it's
  31178. nonempty.)
  31179. </summary>
  31180. <param name="index">index at which to insert first element from the specified collection.</param>
  31181. <param name="c">elements to be inserted into this list.</param>
  31182. <returns>return true if this list Changed as a result of the call.</returns>
  31183. <exception cref="T:System.IndexOutOfRangeException"> if the index is out of range (index &lt; 0 || index &gt; size())</exception>
  31184. </member>
  31185. <member name="M:NPOI.Util.ShortList.Clear">
  31186. <summary>
  31187. Removes all of the elements from this list. This list will be
  31188. empty After this call returns (unless it throws an exception).
  31189. </summary>
  31190. </member>
  31191. <member name="M:NPOI.Util.ShortList.Contains(System.Int16)">
  31192. <summary>
  31193. Returns true if this list Contains the specified element. More
  31194. formally, returns true if and only if this list Contains at
  31195. least one element e such that o == e
  31196. </summary>
  31197. <param name="o">element whose presence in this list is to be Tested.</param>
  31198. <returns>return true if this list Contains the specified element.</returns>
  31199. </member>
  31200. <member name="M:NPOI.Util.ShortList.ContainsAll(NPOI.Util.ShortList)">
  31201. <summary>
  31202. Returns true if this list Contains all of the elements of the specified collection.
  31203. </summary>
  31204. <param name="c">collection to be Checked for Containment in this list.</param>
  31205. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  31206. </member>
  31207. <member name="M:NPOI.Util.ShortList.Equals(System.Object)">
  31208. <summary>
  31209. Compares the specified object with this list for Equality.
  31210. Returns true if and only if the specified object is also a
  31211. list, both lists have the same size, and all corresponding
  31212. pairs of elements in the two lists are Equal. (Two elements e1
  31213. and e2 are equal if e1 == e2.) In other words, two lists are
  31214. defined to be equal if they contain the same elements in the
  31215. same order. This defInition ensures that the Equals method
  31216. works properly across different implementations of the List
  31217. interface.
  31218. </summary>
  31219. <param name="o">the object to be Compared for Equality with this list.</param>
  31220. <returns>return true if the specified object is equal to this list.</returns>
  31221. </member>
  31222. <member name="M:NPOI.Util.ShortList.Get(System.Int32)">
  31223. <summary>
  31224. Returns the element at the specified position in this list.
  31225. </summary>
  31226. <param name="index">index of element to return.</param>
  31227. <returns>return the element at the specified position in this list.</returns>
  31228. </member>
  31229. <member name="M:NPOI.Util.ShortList.GetHashCode">
  31230. <summary>
  31231. Returns the hash code value for this list. The hash code of a
  31232. list is defined to be the result of the following calculation:
  31233. <code>
  31234. hashCode = 1;
  31235. Iterator i = list.Iterator();
  31236. while (i.HasNext()) {
  31237. Object obj = i.Next();
  31238. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  31239. }
  31240. </code>
  31241. This ensures that list1.Equals(list2) implies that
  31242. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  31243. list2, as required by the general contract of Object.HashCode.
  31244. </summary>
  31245. <returns>return the hash code value for this list.</returns>
  31246. </member>
  31247. <member name="M:NPOI.Util.ShortList.IndexOf(System.Int16)">
  31248. <summary>
  31249. Returns the index in this list of the first occurrence of the
  31250. specified element, or -1 if this list does not contain this
  31251. element. More formally, returns the lowest index i such that
  31252. (o == Get(i)), or -1 if there is no such index.
  31253. </summary>
  31254. <param name="o">element to search for.</param>
  31255. <returns>the index in this list of the first occurrence of the
  31256. specified element, or -1 if this list does not contain
  31257. this element.
  31258. </returns>
  31259. </member>
  31260. <member name="M:NPOI.Util.ShortList.IsEmpty">
  31261. <summary>
  31262. Returns true if this list Contains no elements.
  31263. </summary>
  31264. <returns>return true if this list Contains no elements.</returns>
  31265. </member>
  31266. <member name="M:NPOI.Util.ShortList.LastIndexOf(System.Int16)">
  31267. <summary>
  31268. Returns the index in this list of the last occurrence of the
  31269. specified element, or -1 if this list does not contain this
  31270. element. More formally, returns the highest index i such that
  31271. (o == Get(i)), or -1 if there is no such index.
  31272. </summary>
  31273. <param name="o">element to search for.</param>
  31274. <returns>return the index in this list of the last occurrence of the
  31275. specified element, or -1 if this list does not contain this element.</returns>
  31276. </member>
  31277. <member name="M:NPOI.Util.ShortList.Remove(System.Int32)">
  31278. <summary>
  31279. Removes the element at the specified position in this list.
  31280. Shifts any subsequent elements to the left (subtracts one from
  31281. their indices). Returns the element that was Removed from the
  31282. list.
  31283. </summary>
  31284. <param name="index">the index of the element to Removed.</param>
  31285. <returns>return the element previously at the specified position.</returns>
  31286. </member>
  31287. <member name="M:NPOI.Util.ShortList.RemoveValue(System.Int16)">
  31288. <summary>
  31289. Removes the first occurrence in this list of the specified
  31290. element (optional operation). If this list does not contain
  31291. the element, it is unChanged. More formally, Removes the
  31292. element with the lowest index i such that (o.Equals(get(i)))
  31293. (if such an element exists).
  31294. </summary>
  31295. <param name="o">element to be Removed from this list, if present.</param>
  31296. <returns>return true if this list Contained the specified element.</returns>
  31297. </member>
  31298. <member name="M:NPOI.Util.ShortList.RemoveAll(NPOI.Util.ShortList)">
  31299. <summary>
  31300. Removes from this list all the elements that are Contained in the specified collection
  31301. </summary>
  31302. <param name="c">collection that defines which elements will be removed from this list.</param>
  31303. <returns>return true if this list Changed as a result of the call.</returns>
  31304. </member>
  31305. <member name="M:NPOI.Util.ShortList.RetainAll(NPOI.Util.ShortList)">
  31306. <summary>
  31307. Retains only the elements in this list that are Contained in
  31308. the specified collection. In other words, Removes from this
  31309. list all the elements that are not Contained in the specified
  31310. collection.
  31311. </summary>
  31312. <param name="c">collection that defines which elements this Set will retain.</param>
  31313. <returns>return true if this list Changed as a result of the call.</returns>
  31314. </member>
  31315. <member name="M:NPOI.Util.ShortList.Set(System.Int32,System.Int16)">
  31316. <summary>
  31317. Replaces the element at the specified position in this list with the specified element
  31318. </summary>
  31319. <param name="index">index of element to Replace.</param>
  31320. <param name="element">element to be stored at the specified position.</param>
  31321. <returns>return the element previously at the specified position.</returns>
  31322. </member>
  31323. <member name="M:NPOI.Util.ShortList.Size">
  31324. <summary>
  31325. Returns the number of elements in this list. If this list
  31326. Contains more than Int32.MaxValue elements, returns
  31327. Int32.MaxValue.
  31328. </summary>
  31329. <returns>return the number of elements in this shortList</returns>
  31330. </member>
  31331. <member name="P:NPOI.Util.ShortList.Count">
  31332. <summary>
  31333. the number of elements in this shortList
  31334. </summary>
  31335. </member>
  31336. <member name="M:NPOI.Util.ShortList.ToArray">
  31337. <summary>
  31338. Returns an array Containing all of the elements in this list in
  31339. proper sequence. Obeys the general contract of the
  31340. Collection.ToArray method.
  31341. </summary>
  31342. <returns>an array Containing all of the elements in this list in
  31343. proper sequence.</returns>
  31344. </member>
  31345. <member name="M:NPOI.Util.ShortList.ToArray(System.Int16[])">
  31346. <summary>
  31347. Returns an array Containing all of the elements in this list in
  31348. proper sequence. Obeys the general contract of the
  31349. Collection.ToArray(Object[]) method.
  31350. </summary>
  31351. <param name="a">the array into which the elements of this list are to
  31352. be stored, if it is big enough; otherwise, a new array
  31353. is allocated for this purpose.</param>
  31354. <returns>return an array Containing the elements of this list.</returns>
  31355. </member>
  31356. <member name="T:NPOI.Util.StringUtil">
  31357. <summary>
  31358. Title: String Utility Description: Collection of string handling utilities
  31359. @author Andrew C. Oliver
  31360. @author Sergei Kozello (sergeikozello at mail.ru)
  31361. @author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
  31362. @since May 10, 2002
  31363. @version 1.0
  31364. </summary>
  31365. </member>
  31366. <member name="M:NPOI.Util.StringUtil.#ctor">
  31367. Constructor for the StringUtil object
  31368. </member>
  31369. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[],System.Int32,System.Int32)">
  31370. <summary>
  31371. Given a byte array of 16-bit unicode characters in Little Endian
  31372. Format (most important byte last), return a Java String representation
  31373. of it.
  31374. { 0x16, 0x00 } -0x16
  31375. </summary>
  31376. <param name="str">the byte array to be converted</param>
  31377. <param name="offset">the initial offset into the
  31378. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  31379. <param name="len">the Length of the string</param>
  31380. <returns>the converted string</returns>
  31381. </member>
  31382. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[])">
  31383. <summary>
  31384. Given a byte array of 16-bit unicode characters in little endian
  31385. Format (most important byte last), return a Java String representation
  31386. of it.
  31387. { 0x16, 0x00 } -0x16
  31388. </summary>
  31389. <param name="str">the byte array to be converted</param>
  31390. <returns>the converted string</returns>
  31391. </member>
  31392. <member name="M:NPOI.Util.StringUtil.GetToUnicodeLE(System.String)">
  31393. Convert String to 16-bit unicode characters in little endian format
  31394. @param string the string
  31395. @return the byte array of 16-bit unicode characters
  31396. </member>
  31397. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[],System.Int32,System.Int32)">
  31398. <summary>
  31399. Given a byte array of 16-bit unicode characters in big endian
  31400. Format (most important byte first), return a Java String representation
  31401. of it.
  31402. { 0x00, 0x16 } -0x16
  31403. </summary>
  31404. <param name="str">the byte array to be converted</param>
  31405. <param name="offset">the initial offset into the
  31406. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  31407. <param name="len">the Length of the string</param>
  31408. <returns> the converted string</returns>
  31409. </member>
  31410. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[])">
  31411. <summary>
  31412. Given a byte array of 16-bit unicode characters in big endian
  31413. Format (most important byte first), return a Java String representation
  31414. of it.
  31415. { 0x00, 0x16 } -0x16
  31416. </summary>
  31417. <param name="str">the byte array to be converted</param>
  31418. <returns>the converted string</returns>
  31419. </member>
  31420. <member name="M:NPOI.Util.StringUtil.GetFromCompressedUnicode(System.Byte[],System.Int32,System.Int32)">
  31421. <summary>
  31422. Read 8 bit data (in IsO-8859-1 codepage) into a (unicode) Java
  31423. String and return.
  31424. (In Excel terms, read compressed 8 bit unicode as a string)
  31425. </summary>
  31426. <param name="str">byte array to read</param>
  31427. <param name="offset">offset to read byte array</param>
  31428. <param name="len">Length to read byte array</param>
  31429. <returns>generated String instance by reading byte array</returns>
  31430. </member>
  31431. <member name="M:NPOI.Util.StringUtil.PutCompressedUnicode(System.String,System.Byte[],System.Int32)">
  31432. <summary>
  31433. Takes a unicode (java) string, and returns it as 8 bit data (in IsO-8859-1
  31434. codepage).
  31435. (In Excel terms, write compressed 8 bit unicode)
  31436. </summary>
  31437. <param name="input">the String containing the data to be written</param>
  31438. <param name="output">the byte array to which the data Is to be written</param>
  31439. <param name="offset">an offset into the byte arrat at which the data Is start when written</param>
  31440. </member>
  31441. <member name="M:NPOI.Util.StringUtil.PutUnicodeLE(System.String,System.Byte[],System.Int32)">
  31442. <summary>
  31443. Takes a unicode string, and returns it as little endian (most
  31444. important byte last) bytes in the supplied byte array.
  31445. (In Excel terms, write uncompressed unicode)
  31446. </summary>
  31447. <param name="input">the String containing the unicode data to be written</param>
  31448. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String</param>
  31449. <param name="offset">the offset to start writing into the byte array</param>
  31450. </member>
  31451. <member name="M:NPOI.Util.StringUtil.PutUnicodeBE(System.String,System.Byte[],System.Int32)">
  31452. <summary>
  31453. Takes a unicode string, and returns it as big endian (most
  31454. important byte first) bytes in the supplied byte array.
  31455. (In Excel terms, write uncompressed unicode)
  31456. </summary>
  31457. <param name="input">the String containing the unicode data to be written</param>
  31458. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String.</param>
  31459. <param name="offset">the offset to start writing into the byte array</param>
  31460. </member>
  31461. <member name="M:NPOI.Util.StringUtil.GetPreferredEncoding">
  31462. <summary>
  31463. Gets the preferred encoding.
  31464. </summary>
  31465. <returns>the encoding we want to use, currently hardcoded to IsO-8859-1</returns>
  31466. </member>
  31467. <member name="M:NPOI.Util.StringUtil.HasMultibyte(System.String)">
  31468. <summary>
  31469. check the parameter Has multibyte character
  31470. </summary>
  31471. <param name="value"> string to check</param>
  31472. <returns>
  31473. <c>true</c> if Has at least one multibyte character; otherwise, <c>false</c>.
  31474. </returns>
  31475. </member>
  31476. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput)">
  31477. InputStream <c>in</c> is expected to contain:
  31478. <ol>
  31479. <li>ushort nChars</li>
  31480. <li>byte is16BitFlag</li>
  31481. <li>byte[]/char[] characterData</li>
  31482. </ol>
  31483. For this encoding, the is16BitFlag is always present even if nChars==0.
  31484. </member>
  31485. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput,System.Int32)">
  31486. InputStream <c>in</c> is expected to contain:
  31487. <ol>
  31488. <li>byte is16BitFlag</li>
  31489. <li>byte[]/char[] characterData</li>
  31490. </ol>
  31491. For this encoding, the is16BitFlag is always present even if nChars==0.
  31492. <br/>
  31493. This method should be used when the nChars field is <em>not</em> stored
  31494. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  31495. #readUnicodeString(LittleEndianInput)} can be used.
  31496. </member>
  31497. <member name="M:NPOI.Util.StringUtil.WriteUnicodeString(NPOI.Util.ILittleEndianOutput,System.String)">
  31498. OutputStream <c>out</c> will get:
  31499. <ol>
  31500. <li>ushort nChars</li>
  31501. <li>byte is16BitFlag</li>
  31502. <li>byte[]/char[] characterData</li>
  31503. </ol>
  31504. For this encoding, the is16BitFlag is always present even if nChars==0.
  31505. </member>
  31506. <member name="M:NPOI.Util.StringUtil.WriteUnicodeStringFlagAndData(NPOI.Util.ILittleEndianOutput,System.String)">
  31507. OutputStream <c>out</c> will get:
  31508. <ol>
  31509. <li>byte is16BitFlag</li>
  31510. <li>byte[]/char[] characterData</li>
  31511. </ol>
  31512. For this encoding, the is16BitFlag is always present even if nChars==0.
  31513. <br/>
  31514. This method should be used when the nChars field is <em>not</em> stored
  31515. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  31516. #writeUnicodeString(LittleEndianOutput, String)} can be used.
  31517. </member>
  31518. <member name="M:NPOI.Util.StringUtil.GetEncodedSize(System.String)">
  31519. <summary>
  31520. Gets the number of bytes that would be written by WriteUnicodeString(LittleEndianOutput, String)
  31521. </summary>
  31522. <param name="value">The value.</param>
  31523. <returns></returns>
  31524. </member>
  31525. <member name="M:NPOI.Util.StringUtil.IsUnicodeString(System.String)">
  31526. <summary>
  31527. Checks to see if a given String needs to be represented as Unicode
  31528. </summary>
  31529. <param name="value">The value.</param>
  31530. <returns>
  31531. <c>true</c> if string needs Unicode to be represented.; otherwise, <c>false</c>.
  31532. </returns>
  31533. <remarks>Tony Qu change the logic</remarks>
  31534. </member>
  31535. <member name="M:NPOI.Util.StringUtil.ToHexString(System.String)">
  31536. <summary>
  31537. Encodes non-US-ASCII characters in a string, good for encoding file names for download
  31538. http://www.acriticsreview.com/List.aspx?listid=42
  31539. </summary>
  31540. <param name="s"></param>
  31541. <returns></returns>
  31542. </member>
  31543. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Char)">
  31544. <summary>
  31545. Encodes a non-US-ASCII character.
  31546. </summary>
  31547. <param name="chr"></param>
  31548. <returns></returns>
  31549. </member>
  31550. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int16)">
  31551. <summary>
  31552. Encodes a non-US-ASCII character.
  31553. </summary>
  31554. <param name="chr"></param>
  31555. <returns></returns>
  31556. </member>
  31557. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int32)">
  31558. <summary>
  31559. Encodes a non-US-ASCII character.
  31560. </summary>
  31561. <param name="chr"></param>
  31562. <returns></returns>
  31563. </member>
  31564. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int64)">
  31565. <summary>
  31566. Encodes a non-US-ASCII character.
  31567. </summary>
  31568. <param name="chr"></param>
  31569. <returns></returns>
  31570. </member>
  31571. <member name="M:NPOI.Util.StringUtil.NeedToEncode(System.Char)">
  31572. <summary>
  31573. Determines if the character needs to be encoded.
  31574. http://www.acriticsreview.com/List.aspx?listid=42
  31575. </summary>
  31576. <param name="chr"></param>
  31577. <returns></returns>
  31578. </member>
  31579. <member name="M:NPOI.Util.StringUtil.mapMsCodepointString(System.String)">
  31580. Some strings may contain encoded characters of the unicode private use area.
  31581. Currently the characters of the symbol fonts are mapped to the corresponding
  31582. characters in the normal unicode range.
  31583. @param string the original string
  31584. @return the string with mapped characters
  31585. @see <a href="http://www.alanwood.net/unicode/private_use_area.html#symbol">Private Use Area (symbol)</a>
  31586. @see <a href="http://www.alanwood.net/demos/symbol.html">Symbol font - Unicode alternatives for Greek and special characters in HTML</a>
  31587. </member>
  31588. <member name="F:NPOI.Util.StringUtil.MIN_HIGH_SURROGATE">
  31589. The minimum value of a
  31590. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  31591. Unicode high-surrogate code unit</a>
  31592. in the UTF-16 encoding, constant {@code '\u005CuD800'}.
  31593. A high-surrogate is also known as a <i>leading-surrogate</i>.
  31594. @since 1.5
  31595. </member>
  31596. <member name="F:NPOI.Util.StringUtil.MAX_HIGH_SURROGATE">
  31597. The maximum value of a
  31598. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  31599. Unicode high-surrogate code unit</a>
  31600. in the UTF-16 encoding, constant {@code '\u005CuDBFF'}.
  31601. A high-surrogate is also known as a <i>leading-surrogate</i>.
  31602. @since 1.5
  31603. </member>
  31604. <member name="F:NPOI.Util.StringUtil.MIN_LOW_SURROGATE">
  31605. The minimum value of a
  31606. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  31607. Unicode low-surrogate code unit</a>
  31608. in the UTF-16 encoding, constant {@code '\u005CuDC00'}.
  31609. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  31610. @since 1.5
  31611. </member>
  31612. <member name="F:NPOI.Util.StringUtil.MAX_LOW_SURROGATE">
  31613. The maximum value of a
  31614. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  31615. Unicode low-surrogate code unit</a>
  31616. in the UTF-16 encoding, constant {@code '\u005CuDFFF'}.
  31617. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  31618. @since 1.5
  31619. </member>
  31620. <member name="M:NPOI.Util.StringUtil.toCodePoint(System.Char,System.Char)">
  31621. Converts the specified surrogate pair to its supplementary code
  31622. point value. This method does not validate the specified
  31623. surrogate pair. The caller must validate it using {@link
  31624. #isSurrogatePair(char, char) isSurrogatePair} if necessary.
  31625. @param high the high-surrogate code unit
  31626. @param low the low-surrogate code unit
  31627. @return the supplementary code point composed from the
  31628. specified surrogate pair.
  31629. @since 1.5
  31630. </member>
  31631. <member name="M:NPOI.Util.StringUtil.CharCount(System.Int32)">
  31632. Determines the number of {@code char} values needed to
  31633. represent the specified character (Unicode code point). If the
  31634. specified character is equal to or greater than 0x10000, then
  31635. the method returns 2. Otherwise, the method returns 1.
  31636. This method doesn't validate the specified character to be a
  31637. valid Unicode code point. The caller must validate the
  31638. character value using {@link #isValidCodePoint(int) isValidCodePoint}
  31639. if necessary.
  31640. @param codePoint the character (Unicode code point) to be tested.
  31641. @return 2 if the character is a valid supplementary character; 1 otherwise.
  31642. @see Character#isSupplementaryCodePoint(int)
  31643. @since 1.5
  31644. </member>
  31645. <member name="T:NPOI.Util.SystemOutLogger">
  31646. <summary>
  31647. A logger class that strives to make it as easy as possible for
  31648. developers to write log calls, while simultaneously making those
  31649. calls as cheap as possible by performing lazy Evaluation of the log
  31650. message.
  31651. </summary>
  31652. <remarks>
  31653. @author Marc Johnson (mjohnson at apache dot org)
  31654. @author Glen Stampoultzis (glens at apache.org)
  31655. @author Nicola Ken Barozzi (nicolaken at apache.org)
  31656. </remarks>
  31657. </member>
  31658. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object)">
  31659. <summary>
  31660. Log a message
  31661. </summary>
  31662. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  31663. <param name="obj1">The object to log.</param>
  31664. </member>
  31665. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object,System.Exception)">
  31666. <summary>
  31667. Log a message
  31668. </summary>
  31669. <param name="level"> One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  31670. <param name="obj1">The object to log. This is Converted to a string.</param>
  31671. <param name="exception">An exception to be logged</param>
  31672. </member>
  31673. <member name="M:NPOI.Util.SystemOutLogger.Check(System.Int32)">
  31674. <summary>
  31675. Check if a logger is enabled to log at the specified level
  31676. </summary>
  31677. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  31678. <returns></returns>
  31679. </member>
  31680. <member name="M:NPOI.Util.TempFile.CreateTempFile(System.String,System.String)">
  31681. Creates a temporary file. Files are collected into one directory and by default are
  31682. deleted on exit from the VM. Files can be kept by defining the system property
  31683. <c>poi.keep.tmp.files</c>.
  31684. Dont forget to close all files or it might not be possible to delete them.
  31685. </member>
  31686. <member name="T:NPOI.Util.ULongField">
  31687. <summary>
  31688. </summary>
  31689. </member>
  31690. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32)">
  31691. <summary>
  31692. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  31693. </summary>
  31694. <param name="offset">The offset.</param>
  31695. </member>
  31696. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64)">
  31697. <summary>
  31698. construct the LongField with its offset into its containing
  31699. byte array and initialize its value
  31700. </summary>
  31701. <param name="offset">offset of the field within its byte array</param>
  31702. <param name="value">the initial value</param>
  31703. </member>
  31704. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.Byte[])">
  31705. <summary>
  31706. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  31707. byte array and initialize its value from its byte array
  31708. </summary>
  31709. <param name="offset">The offset of the field within its byte array</param>
  31710. <param name="data">the byte array to read the value from</param>
  31711. </member>
  31712. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64,System.Byte[])">
  31713. <summary>
  31714. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  31715. byte array, initialize its value, and write the value to a byte
  31716. array
  31717. </summary>
  31718. <param name="offset">offset of the field within its byte array</param>
  31719. <param name="value">the initial value</param>
  31720. <param name="data">the byte array to write the value to</param>
  31721. </member>
  31722. <member name="P:NPOI.Util.ULongField.Value">
  31723. <summary>
  31724. Getg or sets the LongField's current value
  31725. </summary>
  31726. <value>The current value</value>
  31727. </member>
  31728. <member name="M:NPOI.Util.ULongField.Set(System.UInt64,System.Byte[])">
  31729. <summary>
  31730. set the LongField's current value and write it to a byte array
  31731. </summary>
  31732. <param name="value">value to be set</param>
  31733. <param name="data">the byte array to write the value to</param>
  31734. </member>
  31735. <member name="M:NPOI.Util.ULongField.ReadFromBytes(System.Byte[])">
  31736. <summary>
  31737. set the value from its offset into an array of bytes
  31738. </summary>
  31739. <param name="data">the byte array from which the value is to be read</param>
  31740. </member>
  31741. <member name="M:NPOI.Util.ULongField.ReadFromStream(System.IO.Stream)">
  31742. <summary>
  31743. set the value from an Stream
  31744. </summary>
  31745. <param name="stream">the Stream from which the value is to be</param>
  31746. </member>
  31747. <member name="M:NPOI.Util.ULongField.WriteToBytes(System.Byte[])">
  31748. <summary>
  31749. write the value out to an array of bytes at the appropriate offset
  31750. </summary>
  31751. <param name="data">the array of bytes to which the value is to be written</param>
  31752. </member>
  31753. <member name="M:NPOI.Util.ULongField.ToString">
  31754. <summary>
  31755. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31756. </summary>
  31757. <returns>
  31758. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31759. </returns>
  31760. </member>
  31761. <member name="T:NPOI.Util.Units">
  31762. @author Yegor Kozlov
  31763. </member>
  31764. <member name="F:NPOI.Util.Units.EMU_PER_PIXEL">
  31765. In Escher absolute distances are specified in
  31766. English Metric Units (EMUs), occasionally referred to as A units;
  31767. there are 360000 EMUs per centimeter, 914400 EMUs per inch, 12700 EMUs per point.
  31768. </member>
  31769. <member name="F:NPOI.Util.Units.MASTER_DPI">
  31770. Master DPI (576 pixels per inch).
  31771. Used by the reference coordinate system in PowerPoint (HSLF)
  31772. </member>
  31773. <member name="F:NPOI.Util.Units.PIXEL_DPI">
  31774. Pixels DPI (96 pixels per inch)
  31775. </member>
  31776. <member name="F:NPOI.Util.Units.POINT_DPI">
  31777. Points DPI (72 pixels per inch)
  31778. </member>
  31779. <member name="M:NPOI.Util.Units.ToEMU(System.Double)">
  31780. <summary>
  31781. Converts points to EMUs
  31782. </summary>
  31783. <param name="value"></param>
  31784. <returns>EMUs</returns>
  31785. </member>
  31786. <member name="M:NPOI.Util.Units.PixelToEMU(System.Int32)">
  31787. Converts pixels to EMUs
  31788. @param pixels pixels
  31789. @return EMUs
  31790. </member>
  31791. <member name="M:NPOI.Util.Units.FixedPointToDecimal(System.Int32)">
  31792. Converts a value of type FixedPoint to a decimal number
  31793. @param fixedPoint
  31794. @return decimal number
  31795. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  31796. </member>
  31797. <member name="M:NPOI.Util.Units.DoubleToFixedPoint(System.Double)">
  31798. Converts a value of type floating point to a FixedPoint
  31799. @param floatPoint
  31800. @return fixedPoint
  31801. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  31802. </member>
  31803. <member name="T:NPOI.SS.Format.CellNumberPartHandler">
  31804. Internal helper class for CellNumberFormatter
  31805. </member>
  31806. <member name="T:NPOI.SS.Format.CellNumberStringMod">
  31807. Internal helper class for CellNumberFormatter
  31808. This class represents a single modification to a result string. The way
  31809. this works is complicated, but so is numeric formatting. In general, for
  31810. most formats, we use a DecimalFormat object that will Put the string out
  31811. in a known format, usually with all possible leading and trailing zeros.
  31812. We then walk through the result and the original format, and note any
  31813. modifications that need to be made. Finally, we go through and apply
  31814. them all, dealing with overlapping modifications.
  31815. </member>
  31816. <member name="T:NPOI.SS.Format.CellDateFormatter">
  31817. Formats a date value.
  31818. @author Ken Arnold, Industrious Media LLC
  31819. </member>
  31820. <member name="M:NPOI.SS.Format.CellDateFormatter.#ctor(System.String)">
  31821. Creates a new date formatter with the given specification.
  31822. @param format The format.
  31823. </member>
  31824. <member name="M:NPOI.SS.Format.CellDateFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31825. {@inheritDoc}
  31826. </member>
  31827. <member name="M:NPOI.SS.Format.CellDateFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31828. {@inheritDoc}
  31829. <p/>
  31830. For a date, this is <tt>"mm/d/y"</tt>.
  31831. </member>
  31832. <member name="T:NPOI.SS.Format.CellElapsedFormatter">
  31833. This class : printing out an elapsed time format.
  31834. @author Ken Arnold, Industrious Media LLC
  31835. </member>
  31836. <member name="M:NPOI.SS.Format.CellElapsedFormatter.#ctor(System.String)">
  31837. Creates a elapsed time formatter.
  31838. @param pattern The pattern to Parse.
  31839. </member>
  31840. <member name="M:NPOI.SS.Format.CellElapsedFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31841. {@inheritDoc}
  31842. </member>
  31843. <member name="M:NPOI.SS.Format.CellElapsedFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31844. {@inheritDoc}
  31845. <p/>
  31846. For a date, this is <tt>"mm/d/y"</tt>.
  31847. </member>
  31848. <!-- Badly formed XML comment ignored for member "T:NPOI.SS.Format.CellFormat" -->
  31849. <member name="T:NPOI.SS.Format.CellFormat.GeneralCellFormat">
  31850. Format a value as it would be were no format specified. This is also
  31851. used when the format specified is <tt>General</tt>.
  31852. </member>
  31853. <member name="F:NPOI.SS.Format.CellFormat.formatCache">
  31854. Maps a format string to its Parsed version for efficiencies sake.
  31855. </member>
  31856. <member name="M:NPOI.SS.Format.CellFormat.GetInstance(System.String)">
  31857. Returns a {@link CellFormat} that applies the given format. Two calls
  31858. with the same format may or may not return the same object.
  31859. @param format The format.
  31860. @return A {@link CellFormat} that applies the given format.
  31861. </member>
  31862. <member name="M:NPOI.SS.Format.CellFormat.#ctor(System.String)">
  31863. Creates a new object.
  31864. @param format The format.
  31865. </member>
  31866. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Object)">
  31867. Returns the result of Applying the format to the given value. If the
  31868. value is a number (a type of {@link Number} object), the correct number
  31869. format type is chosen; otherwise it is considered a text object.
  31870. @param value The value
  31871. @return The result, in a {@link CellFormatResult}.
  31872. </member>
  31873. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.DateTime,System.Double)">
  31874. Returns the result of applying the format to the given date.
  31875. @param date The date.
  31876. @param numericValue The numeric value for the date.
  31877. @return The result, in a {@link CellFormatResult}.
  31878. </member>
  31879. <member name="M:NPOI.SS.Format.CellFormat.Apply(NPOI.SS.UserModel.ICell)">
  31880. Fetches the appropriate value from the cell, and returns the result of
  31881. Applying it to the appropriate format. For formula cells, the computed
  31882. value is what is used.
  31883. @param c The cell.
  31884. @return The result, in a {@link CellFormatResult}.
  31885. </member>
  31886. <member name="M:NPOI.SS.Format.CellFormat.GetApplicableFormatPart(System.Object)">
  31887. Returns the {@link CellFormatPart} that applies to the value. Result
  31888. depends on how many parts the cell format has, the cell value and any
  31889. conditions. The value must be a {@link Number}.
  31890. @param value The value.
  31891. @return The {@link CellFormatPart} that applies to the value.
  31892. </member>
  31893. <member name="M:NPOI.SS.Format.CellFormat.UltimateType(NPOI.SS.UserModel.ICell)">
  31894. Returns the ultimate cell type, following the results of formulas. If
  31895. the cell is a {@link Cell#CELL_TYPE_FORMULA}, this returns the result of
  31896. {@link Cell#getCachedFormulaResultType()}. Otherwise this returns the
  31897. result of {@link Cell#getCellType()}.
  31898. @param cell The cell.
  31899. @return The ultimate type of this cell.
  31900. </member>
  31901. <member name="M:NPOI.SS.Format.CellFormat.Equals(System.Object)">
  31902. Returns <tt>true</tt> if the other object is a {@link CellFormat} object
  31903. with the same format.
  31904. @param obj The other object.
  31905. @return <tt>true</tt> if the two objects are Equal.
  31906. </member>
  31907. <member name="M:NPOI.SS.Format.CellFormat.GetHashCode">
  31908. Returns a hash code for the format.
  31909. @return A hash code for the format.
  31910. </member>
  31911. <member name="T:NPOI.SS.Format.CellFormatCondition">
  31912. This object represents a condition in a cell format.
  31913. @author Ken Arnold, Industrious Media LLC
  31914. </member>
  31915. <member name="M:NPOI.SS.Format.CellFormatCondition.GetInstance(System.String,System.String)">
  31916. Returns an instance of a condition object.
  31917. @param opString The operator as a string. One of <tt>"&lt;"</tt>,
  31918. <tt>"&lt;="</tt>, <tt>">"</tt>, <tt>">="</tt>,
  31919. <tt>"="</tt>, <tt>"=="</tt>, <tt>"!="</tt>, or
  31920. <tt>"&lt;>"</tt>.
  31921. @param constStr The constant (such as <tt>"12"</tt>).
  31922. @return A condition object for the given condition.
  31923. </member>
  31924. <member name="M:NPOI.SS.Format.CellFormatCondition.Pass(System.Double)">
  31925. Returns <tt>true</tt> if the given value passes the constraint's test.
  31926. @param value The value to compare against.
  31927. @return <tt>true</tt> if the given value passes the constraint's test.
  31928. </member>
  31929. <member name="T:NPOI.SS.Format.CellFormatPart">
  31930. Objects of this class represent a single part of a cell format expression.
  31931. Each cell can have up to four of these for positive, zero, negative, and text
  31932. values.
  31933. <p/>
  31934. Each format part can contain a color, a condition, and will always contain a
  31935. format specification. For example <tt>"[Red][>=10]#"</tt> has a color
  31936. (<tt>[Red]</tt>), a condition (<tt>>=10</tt>) and a format specification
  31937. (<tt>#</tt>).
  31938. <p/>
  31939. This class also Contains patterns for matching the subparts of format
  31940. specification. These are used internally, but are made public in case other
  31941. code has use for them.
  31942. @author Ken Arnold, Industrious Media LLC
  31943. </member>
  31944. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_PAT">
  31945. Pattern for the color part of a cell format part.
  31946. </member>
  31947. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_PAT">
  31948. Pattern for the condition part of a cell format part.
  31949. </member>
  31950. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_PAT">
  31951. Pattern for the format specification part of a cell format part.
  31952. </member>
  31953. <member name="F:NPOI.SS.Format.CellFormatPart.CURRENCY_PAT">
  31954. Pattern for the currency symbol part of a cell format part
  31955. </member>
  31956. <member name="F:NPOI.SS.Format.CellFormatPart.FORMAT_PAT">
  31957. Pattern for an entire cell single part.
  31958. </member>
  31959. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_GROUP">
  31960. Within {@link #FORMAT_PAT}, the group number for the matched color.
  31961. </member>
  31962. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_OPERATOR_GROUP">
  31963. Within {@link #FORMAT_PAT}, the group number for the operator in the
  31964. condition.
  31965. </member>
  31966. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_VALUE_GROUP">
  31967. Within {@link #FORMAT_PAT}, the group number for the value in the
  31968. condition.
  31969. </member>
  31970. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_GROUP">
  31971. Within {@link #FORMAT_PAT}, the group number for the format
  31972. specification.
  31973. </member>
  31974. <member name="M:NPOI.SS.Format.CellFormatPart.#ctor(System.String)">
  31975. Create an object to represent a format part.
  31976. @param desc The string to Parse.
  31977. </member>
  31978. <member name="M:NPOI.SS.Format.CellFormatPart.Applies(System.Object)">
  31979. Returns <tt>true</tt> if this format part applies to the given value. If
  31980. the value is a number and this is part has a condition, returns
  31981. <tt>true</tt> only if the number passes the condition. Otherwise, this
  31982. allways return <tt>true</tt>.
  31983. @param valueObject The value to Evaluate.
  31984. @return <tt>true</tt> if this format part applies to the given value.
  31985. </member>
  31986. <member name="M:NPOI.SS.Format.CellFormatPart.FindGroup(System.Text.RegularExpressions.Regex,System.String,System.String)">
  31987. Returns the number of the first group that is the same as the marker
  31988. string. Starts from group 1.
  31989. @param pat The pattern to use.
  31990. @param str The string to match against the pattern.
  31991. @param marker The marker value to find the group of.
  31992. @return The matching group number.
  31993. @throws ArgumentException No group matches the marker.
  31994. </member>
  31995. <member name="M:NPOI.SS.Format.CellFormatPart.GetColor(System.Text.RegularExpressions.Match)">
  31996. Returns the color specification from the matcher, or <tt>null</tt> if
  31997. there is none.
  31998. @param m The matcher for the format part.
  31999. @return The color specification or <tt>null</tt>.
  32000. </member>
  32001. <member name="M:NPOI.SS.Format.CellFormatPart.GetCondition(System.Text.RegularExpressions.Match)">
  32002. Returns the condition specification from the matcher, or <tt>null</tt> if
  32003. there is none.
  32004. @param m The matcher for the format part.
  32005. @return The condition specification or <tt>null</tt>.
  32006. </member>
  32007. <member name="M:NPOI.SS.Format.CellFormatPart.GetCellFormatType(System.Text.RegularExpressions.Match)">
  32008. Returns the CellFormatType object implied by the format specification for
  32009. the format part.
  32010. @param matcher The matcher for the format part.
  32011. @return The CellFormatType.
  32012. </member>
  32013. <member name="M:NPOI.SS.Format.CellFormatPart.GetFormatter(System.Text.RegularExpressions.Match)">
  32014. Returns the formatter object implied by the format specification for the
  32015. format part.
  32016. @param matcher The matcher for the format part.
  32017. @return The formatter.
  32018. </member>
  32019. <member name="M:NPOI.SS.Format.CellFormatPart.formatType(System.String)">
  32020. Returns the type of format.
  32021. @param fdesc The format specification
  32022. @return The type of format.
  32023. </member>
  32024. <member name="M:NPOI.SS.Format.CellFormatPart.QuoteSpecial(System.String,NPOI.SS.Format.CellFormatType)">
  32025. Returns a version of the original string that has any special characters
  32026. quoted (or escaped) as appropriate for the cell format type. The format
  32027. type object is queried to see what is special.
  32028. @param repl The original string.
  32029. @param type The format type representation object.
  32030. @return A version of the string with any special characters Replaced.
  32031. @see CellFormatType#isSpecial(char)
  32032. </member>
  32033. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Object)">
  32034. Apply this format part to the given value. This returns a {@link
  32035. CellFormatResult} object with the results.
  32036. @param value The value to apply this format part to.
  32037. @return A {@link CellFormatResult} object Containing the results of
  32038. Applying the format to the value.
  32039. </member>
  32040. <member name="P:NPOI.SS.Format.CellFormatPart.CellFormatType">
  32041. Returns the CellFormatType object implied by the format specification for
  32042. the format part.
  32043. @return The CellFormatType.
  32044. </member>
  32045. <member name="P:NPOI.SS.Format.CellFormatPart.HasCondition">
  32046. Returns <tt>true</tt> if this format part has a condition.
  32047. @return <tt>true</tt> if this format part has a condition.
  32048. </member>
  32049. <member name="M:NPOI.SS.Format.CellFormatPart.ExpandChar(System.String)">
  32050. Expands a character. This is only partly done, because we don't have the
  32051. correct info. In Excel, this would be expanded to fill the rest of the
  32052. cell, but we don't know, in general, what the "rest of the cell" is1.
  32053. @param part The character to be repeated is the second character in this
  32054. string.
  32055. @return The character repeated three times.
  32056. </member>
  32057. <member name="M:NPOI.SS.Format.CellFormatPart.Group(System.Text.RegularExpressions.Match,System.Int32)">
  32058. Returns the string from the group, or <tt>""</tt> if the group is
  32059. <tt>null</tt>.
  32060. @param m The matcher.
  32061. @param g The group number.
  32062. @return The group or <tt>""</tt>.
  32063. </member>
  32064. <member name="T:NPOI.SS.Format.CellFormatResult">
  32065. This object Contains the result of Applying a cell format or cell format part
  32066. to a value.
  32067. @author Ken Arnold, Industrious Media LLC
  32068. @see CellFormatPart#Apply(Object)
  32069. @see CellFormat#Apply(Object)
  32070. </member>
  32071. <member name="P:NPOI.SS.Format.CellFormatResult.Applies">
  32072. This is <tt>true</tt> if no condition was given that applied to the
  32073. value, or if the condition is satisfied. If a condition is relevant, and
  32074. when applied the value fails the test, this is <tt>false</tt>.
  32075. </member>
  32076. <member name="P:NPOI.SS.Format.CellFormatResult.Text">
  32077. The resulting text. This will never be <tt>null</tt>.
  32078. </member>
  32079. <member name="P:NPOI.SS.Format.CellFormatResult.TextColor">
  32080. The color the format Sets, or <tt>null</tt> if the format Sets no color.
  32081. This will always be <tt>null</tt> if {@link #applies} is <tt>false</tt>.
  32082. </member>
  32083. <member name="M:NPOI.SS.Format.CellFormatResult.#ctor(System.Boolean,System.String,System.Drawing.Color)">
  32084. Creates a new format result object.
  32085. @param applies The value for {@link #applies}.
  32086. @param text The value for {@link #text}.
  32087. @param textColor The value for {@link #textColor}.
  32088. </member>
  32089. <member name="T:NPOI.SS.Format.CellFormatter">
  32090. This is the abstract supertype for the various cell formatters.
  32091. @author Ken Arnold, Industrious Media LLC
  32092. </member>
  32093. <member name="F:NPOI.SS.Format.CellFormatter.format">
  32094. The original specified format.
  32095. </member>
  32096. <member name="F:NPOI.SS.Format.CellFormatter.LOCALE">
  32097. This is the locale used to Get a consistent format result from which to
  32098. work.
  32099. </member>
  32100. <member name="M:NPOI.SS.Format.CellFormatter.#ctor(System.String)">
  32101. Creates a new formatter object, storing the format in {@link #format}.
  32102. @param format The format.
  32103. </member>
  32104. <member name="M:NPOI.SS.Format.CellFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32105. Format a value according the format string.
  32106. @param toAppendTo The buffer to append to.
  32107. @param value The value to format.
  32108. </member>
  32109. <member name="M:NPOI.SS.Format.CellFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32110. Format a value according to the type, in the most basic way.
  32111. @param toAppendTo The buffer to append to.
  32112. @param value The value to format.
  32113. </member>
  32114. <member name="M:NPOI.SS.Format.CellFormatter.Format(System.Object)">
  32115. Formats the value, returning the resulting string.
  32116. @param value The value to format.
  32117. @return The value, formatted.
  32118. </member>
  32119. <member name="M:NPOI.SS.Format.CellFormatter.SimpleFormat(System.Object)">
  32120. Formats the value in the most basic way, returning the resulting string.
  32121. @param value The value to format.
  32122. @return The value, formatted.
  32123. </member>
  32124. <member name="M:NPOI.SS.Format.CellFormatter.Quote(System.String)">
  32125. Returns the input string, surrounded by quotes.
  32126. @param str The string to quote.
  32127. @return The input string, surrounded by quotes.
  32128. </member>
  32129. <member name="T:NPOI.SS.Format.CellFormatType">
  32130. The different kinds of formats that the formatter understands.
  32131. @author Ken Arnold, Industrious Media LLC
  32132. </member>
  32133. <member name="F:NPOI.SS.Format.CellFormatType.GENERAL">
  32134. The general (default) format; also used for <tt>"General"</tt>.
  32135. </member>
  32136. <member name="F:NPOI.SS.Format.CellFormatType.NUMBER">
  32137. A numeric format.
  32138. </member>
  32139. <member name="F:NPOI.SS.Format.CellFormatType.DATE">
  32140. A date format.
  32141. </member>
  32142. <member name="F:NPOI.SS.Format.CellFormatType.ELAPSED">
  32143. An elapsed time format.
  32144. </member>
  32145. <member name="F:NPOI.SS.Format.CellFormatType.TEXT">
  32146. A text format.
  32147. </member>
  32148. <member name="M:NPOI.SS.Format.CellFormatType.IsSpecial(System.Char)">
  32149. Returns <tt>true</tt> if the format is special and needs to be quoted.
  32150. @param ch The character to test.
  32151. @return <tt>true</tt> if the format is special and needs to be quoted.
  32152. </member>
  32153. <member name="M:NPOI.SS.Format.CellFormatType.Formatter(System.String)">
  32154. Returns a new formatter of the appropriate type, for the given pattern.
  32155. The pattern must be appropriate for the type.
  32156. @param pattern The pattern to use.
  32157. @return A new formatter of the appropriate type, for the given pattern.
  32158. </member>
  32159. <member name="T:NPOI.SS.Format.CellGeneralFormatter">
  32160. A formatter for the default "General" cell format.
  32161. @author Ken Arnold, Industrious Media LLC
  32162. </member>
  32163. <member name="M:NPOI.SS.Format.CellGeneralFormatter.#ctor">
  32164. Creates a new general formatter.
  32165. </member>
  32166. <member name="M:NPOI.SS.Format.CellGeneralFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32167. The general style is not quite the same as any other, or any combination
  32168. of others.
  32169. @param toAppendTo The buffer to append to.
  32170. @param value The value to format.
  32171. </member>
  32172. <member name="M:NPOI.SS.Format.CellGeneralFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32173. Equivalent to {@link #formatValue(StringBuilder,Object)}. {@inheritDoc}.
  32174. </member>
  32175. <member name="T:NPOI.SS.Format.CellNumberFormatter">
  32176. This class : printing out a value using a number format.
  32177. @author Ken Arnold, Industrious Media LLC
  32178. </member>
  32179. <member name="T:NPOI.SS.Format.CellNumberFormatter.GeneralNumberFormatter">
  32180. <summary>
  32181. The CellNumberFormatter.simpleValue() method uses the SIMPLE_NUMBER
  32182. CellFormatter defined here. The CellFormat.GENERAL_FORMAT CellFormat
  32183. no longer uses the SIMPLE_NUMBER CellFormatter.
  32184. Note that the simpleValue()/SIMPLE_NUMBER CellFormatter format
  32185. ("#" for integer values, and "#.#" for floating-point values) is
  32186. different from the 'General' format for numbers ("#" for integer
  32187. values and "#.#########" for floating-point values).
  32188. </summary>
  32189. </member>
  32190. <member name="T:NPOI.SS.Format.CellNumberFormatter.Special">
  32191. This class is used to mark where the special characters in the format
  32192. are, as opposed to the other characters that are simply printed.
  32193. </member>
  32194. <member name="M:NPOI.SS.Format.CellNumberFormatter.#ctor(System.String)">
  32195. Creates a new cell number formatter.
  32196. @param format The format to Parse.
  32197. </member>
  32198. <member name="M:NPOI.SS.Format.CellNumberFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32199. {@inheritDoc}
  32200. </member>
  32201. <member name="M:NPOI.SS.Format.CellNumberFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32202. {@inheritDoc}
  32203. <p/>
  32204. For a number, this is <tt>"#"</tt> for integer values, and <tt>"#.#"</tt>
  32205. for floating-point values.
  32206. </member>
  32207. <member name="T:NPOI.SS.Format.CellTextFormatter">
  32208. This class : printing out text.
  32209. @author Ken Arnold, Industrious Media LLC
  32210. </member>
  32211. <member name="M:NPOI.SS.Format.CellTextFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  32212. {@inheritDoc}
  32213. </member>
  32214. <member name="M:NPOI.SS.Format.CellTextFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  32215. {@inheritDoc}
  32216. <p/>
  32217. For text, this is just printing the text.
  32218. </member>
  32219. <member name="F:NPOI.SS.Format.SimpleFraction.denominator">
  32220. The denominator.
  32221. </member>
  32222. <member name="F:NPOI.SS.Format.SimpleFraction.numerator">
  32223. The numerator.
  32224. </member>
  32225. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionExactDenominator(System.Double,System.Int32)">
  32226. Create a fraction given a double value and a denominator.
  32227. @param val double value of fraction
  32228. @param exactDenom the exact denominator
  32229. @return a SimpleFraction with the given values set.
  32230. </member>
  32231. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Int32)">
  32232. Create a fraction given the double value and either the maximum error
  32233. allowed or the maximum number of denominator digits.
  32234. @param value the double value to convert to a fraction.
  32235. @param maxDenominator maximum denominator value allowed.
  32236. @throws RuntimeException if the continued fraction failed to
  32237. converge.
  32238. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  32239. </member>
  32240. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Double,System.Int32,System.Int32)">
  32241. Create a fraction given the double value and either the maximum error
  32242. allowed or the maximum number of denominator digits.
  32243. <p>
  32244. References:
  32245. <ul>
  32246. <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
  32247. Continued Fraction</a> equations (11) and (22)-(26)</li>
  32248. </ul>
  32249. </p>
  32250. Based on org.apache.commons.math.fraction.Fraction from Apache Commons-Math.
  32251. YK: The only reason of having this class is to avoid dependency on the Commons-Math jar.
  32252. @param value the double value to convert to a fraction.
  32253. @param epsilon maximum error allowed. The resulting fraction is within
  32254. <code>epsilon</code> of <code>value</code>, in absolute terms.
  32255. @param maxDenominator maximum denominator value allowed.
  32256. @param maxIterations maximum number of convergents
  32257. @throws RuntimeException if the continued fraction failed to
  32258. converge.
  32259. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  32260. </member>
  32261. <member name="M:NPOI.SS.Format.SimpleFraction.#ctor(System.Int32,System.Int32)">
  32262. Create a fraction given a numerator and denominator.
  32263. @param numerator
  32264. @param denominator maxDenominator The maximum allowed value for denominator
  32265. </member>
  32266. <member name="P:NPOI.SS.Format.SimpleFraction.Denominator">
  32267. Access the denominator.
  32268. @return the denominator.
  32269. </member>
  32270. <member name="P:NPOI.SS.Format.SimpleFraction.Numerator">
  32271. Access the numerator.
  32272. @return the numerator.
  32273. </member>
  32274. <member name="T:NPOI.SS.Formula.Atp.ArgumentsEvaluator">
  32275. Evaluator for formula arguments.
  32276. @author jfaenomoto@gmail.com
  32277. </member>
  32278. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDateArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  32279. Evaluate a generic {@link ValueEval} argument to a double value that represents a date in POI.
  32280. @param arg {@link ValueEval} an argument.
  32281. @param srcCellRow number cell row.
  32282. @param srcCellCol number cell column.
  32283. @return a double representing a date in POI.
  32284. @throws EvaluationException exception upon argument evaluation.
  32285. </member>
  32286. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDatesArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  32287. Evaluate a generic {@link ValueEval} argument to an array of double values that represents dates in POI.
  32288. @param arg {@link ValueEval} an argument.
  32289. @param srcCellRow number cell row.
  32290. @param srcCellCol number cell column.
  32291. @return an array of doubles representing dates in POI.
  32292. @throws EvaluationException exception upon argument evaluation.
  32293. </member>
  32294. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateNumberArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  32295. Evaluate a generic {@link ValueEval} argument to a double value.
  32296. @param arg {@link ValueEval} an argument.
  32297. @param srcCellRow number cell row.
  32298. @param srcCellCol number cell column.
  32299. @return a double value.
  32300. @throws EvaluationException exception upon argument evaluation.
  32301. </member>
  32302. <member name="T:NPOI.SS.Formula.Atp.DateParser">
  32303. Parser for java dates.
  32304. @author jfaenomoto@gmail.com
  32305. </member>
  32306. <member name="M:NPOI.SS.Formula.Atp.DateParser.ParseDate(System.String)">
  32307. Parses a date from a string.
  32308. @param strVal a string with a date pattern.
  32309. @return a date parsed from argument.
  32310. @throws EvaluationException exception upon parsing.
  32311. </member>
  32312. <member name="M:NPOI.SS.Formula.Atp.DateParser.MakeDate(System.Int32,System.Int32,System.Int32)">
  32313. @param month 1-based
  32314. </member>
  32315. <member name="T:NPOI.SS.Formula.Atp.NetworkdaysFunction">
  32316. Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()<br/>
  32317. Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non
  32318. saturday/sunday date.
  32319. <p/>
  32320. <b>Syntax</b><br/>
  32321. <b>NETWORKDAYS</b>(<b>startDate</b>, <b>endDate</b>, holidays)
  32322. <p/>
  32323. @author jfaenomoto@gmail.com
  32324. </member>
  32325. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.#ctor(NPOI.SS.Formula.Atp.ArgumentsEvaluator)">
  32326. Constructor.
  32327. @param anEvaluator an injected {@link ArgumentsEvaluator}.
  32328. </member>
  32329. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  32330. Evaluate for NETWORKDAYS. Given two dates and a optional date or interval of holidays, determines how many working days are there
  32331. between those dates.
  32332. @return {@link ValueEval} for the number of days between two dates.
  32333. </member>
  32334. <member name="T:NPOI.SS.Formula.Atp.WorkdayCalculator">
  32335. A calculator for workdays, considering dates as excel representations.
  32336. @author jfaenomoto@gmail.com
  32337. </member>
  32338. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.#ctor">
  32339. Constructor.
  32340. </member>
  32341. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Double,System.Double[])">
  32342. Calculate how many workdays are there between a start and an end date, as excel representations, considering a range of holidays.
  32343. @param start start date.
  32344. @param end end date.
  32345. @param holidays an array of holidays.
  32346. @return number of workdays between start and end dates, including both dates.
  32347. </member>
  32348. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Int32,System.Double[])">
  32349. Calculate the workday past x workdays from a starting date, considering a range of holidays.
  32350. @param start start date.
  32351. @param workdays number of workdays to be past from starting date.
  32352. @param holidays an array of holidays.
  32353. @return date past x workdays.
  32354. </member>
  32355. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.PastDaysOfWeek(System.Double,System.Double,System.DayOfWeek)">
  32356. Calculates how many days of week past between a start and an end date.
  32357. @param start start date.
  32358. @param end end date.
  32359. @param dayOfWeek a day of week as represented by {@link Calendar} constants.
  32360. @return how many days of week past in this interval.
  32361. </member>
  32362. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateNonWeekendHolidays(System.Double,System.Double,System.Double[])">
  32363. Calculates how many holidays in a list are workdays, considering an interval of dates.
  32364. @param start start date.
  32365. @param end end date.
  32366. @param holidays an array of holidays.
  32367. @return number of holidays that occur in workdays, between start and end dates.
  32368. </member>
  32369. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsWeekend(System.Double)">
  32370. @param aDate a given date.
  32371. @return <code>true</code> if date is weekend, <code>false</code> otherwise.
  32372. </member>
  32373. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsHoliday(System.Double,System.Double[])">
  32374. @param aDate a given date.
  32375. @param holidays an array of holidays.
  32376. @return <code>true</code> if date is a holiday, <code>false</code> otherwise.
  32377. </member>
  32378. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsNonWorkday(System.Double,System.Double[])">
  32379. @param aDate a given date.
  32380. @param holidays an array of holidays.
  32381. @return <code>1</code> is not a workday, <code>0</code> otherwise.
  32382. </member>
  32383. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsInARange(System.Double,System.Double,System.Double)">
  32384. @param start start date.
  32385. @param end end date.
  32386. @param aDate a date to be analyzed.
  32387. @return <code>true</code> if aDate is between start and end dates, <code>false</code> otherwise.
  32388. </member>
  32389. <member name="T:NPOI.SS.Formula.Atp.WorkdayFunction">
  32390. Implementation of Excel 'Analysis ToolPak' function WORKDAY()<br/>
  32391. Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non
  32392. saturday/sunday date.
  32393. <p/>
  32394. <b>Syntax</b><br/>
  32395. <b>WORKDAY</b>(<b>startDate</b>, <b>days</b>, holidays)
  32396. <p/>
  32397. @author jfaenomoto@gmail.com
  32398. </member>
  32399. <member name="M:NPOI.SS.Formula.Atp.WorkdayFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  32400. Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past
  32401. number of parametrized workdays.
  32402. @return {@link ValueEval} with date as its value.
  32403. </member>
  32404. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetSupportedFunctionNames">
  32405. Returns a collection of ATP function names implemented by POI.
  32406. @return an array of supported functions
  32407. @since 3.8 beta6
  32408. </member>
  32409. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetNotSupportedFunctionNames">
  32410. Returns a collection of ATP function names NOT implemented by POI.
  32411. @return an array of not supported functions
  32412. @since 3.8 beta6
  32413. </member>
  32414. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  32415. Register a ATP function in runtime.
  32416. @param name the function name
  32417. @param func the functoin to register
  32418. @throws ArgumentException if the function is unknown or already registered.
  32419. @since 3.8 beta6
  32420. </member>
  32421. <member name="T:NPOI.SS.Formula.Atp.MRound">
  32422. Implementation of Excel 'Analysis ToolPak' function MROUND()<br/>
  32423. Returns a number rounded to the desired multiple.<p/>
  32424. <b>Syntax</b><br/>
  32425. <b>MROUND</b>(<b>number</b>, <b>multiple</b>)
  32426. <p/>
  32427. @author Yegor Kozlov
  32428. </member>
  32429. <member name="T:NPOI.SS.Formula.Atp.ParityFunction">
  32430. Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()<br/>
  32431. @author Josh Micich
  32432. </member>
  32433. <member name="T:NPOI.SS.Formula.Atp.RandBetween">
  32434. * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()<br/>
  32435. *
  32436. * Returns a random integer number between the numbers you specify.<p/>
  32437. *
  32438. * <b>Syntax</b><br/>
  32439. * <b>RANDBETWEEN</b>(<b>bottom</b>, <b>top</b>)<p/>
  32440. *
  32441. * <b>bottom</b> is the smallest integer RANDBETWEEN will return.<br/>
  32442. * <b>top</b> is the largest integer RANDBETWEEN will return.<br/>
  32443. * @author Brendan Nolan
  32444. </member>
  32445. <member name="M:NPOI.SS.Formula.Atp.RandBetween.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  32446. Evaluate for RANDBETWEEN(). Must be given two arguments. Bottom must be greater than top.
  32447. Bottom is rounded up and top value is rounded down. After rounding top has to be set greater
  32448. than top.
  32449. @see org.apache.poi.ss.formula.functions.FreeRefFunction#evaluate(org.apache.poi.ss.formula.eval.ValueEval[], org.apache.poi.ss.formula.OperationEvaluationContext)
  32450. </member>
  32451. <member name="T:NPOI.SS.Formula.Atp.YearFrac">
  32452. Implementation of Excel 'Analysis ToolPak' function YEARFRAC()<br/>
  32453. Returns the fraction of the year spanned by two dates.<p/>
  32454. <b>Syntax</b><br/>
  32455. <b>YEARFRAC</b>(<b>startDate</b>, <b>endDate</b>, basis)<p/>
  32456. The <b>basis</b> optionally specifies the behaviour of YEARFRAC as follows:
  32457. <table border="0" cellpadding="1" cellspacing="0" summary="basis parameter description">
  32458. <tr><th>Value</th><th>Days per Month</th><th>Days per Year</th></tr>
  32459. <tr align='center'><td>0 (default)</td><td>30</td><td>360</td></tr>
  32460. <tr align='center'><td>1</td><td>actual</td><td>actual</td></tr>
  32461. <tr align='center'><td>2</td><td>actual</td><td>360</td></tr>
  32462. <tr align='center'><td>3</td><td>actual</td><td>365</td></tr>
  32463. <tr align='center'><td>4</td><td>30</td><td>360</td></tr>
  32464. </table>
  32465. </member>
  32466. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator">
  32467. <summary>
  32468. Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
  32469. Algorithm inspired by www.dwheeler.com/yearfrac
  32470. @author Josh Micich
  32471. </summary>
  32472. <remarks>
  32473. Date Count convention
  32474. http://en.wikipedia.org/wiki/Day_count_convention
  32475. </remarks>
  32476. <remarks>
  32477. Office Online Help on YEARFRAC
  32478. http://office.microsoft.com/en-us/excel/HP052093441033.aspx
  32479. </remarks>
  32480. </member>
  32481. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.MS_PER_HOUR">
  32482. use UTC time-zone to avoid daylight savings issues
  32483. </member>
  32484. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.LONG_MONTH_LEN">
  32485. the length of normal long months i.e. 31
  32486. </member>
  32487. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SHORT_MONTH_LEN">
  32488. the length of normal short months i.e. 30
  32489. </member>
  32490. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Calculate(System.Double,System.Double,System.Int32)">
  32491. <summary>
  32492. Calculates YEARFRAC()
  32493. </summary>
  32494. <param name="pStartDateVal">The start date.</param>
  32495. <param name="pEndDateVal">The end date.</param>
  32496. <param name="basis">The basis value.</param>
  32497. <returns></returns>
  32498. </member>
  32499. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis0(System.Int32,System.Int32)">
  32500. <summary>
  32501. Basis 0, 30/360 date convention
  32502. </summary>
  32503. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32504. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32505. <returns></returns>
  32506. </member>
  32507. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis1(System.Int32,System.Int32)">
  32508. <summary>
  32509. Basis 1, Actual/Actual date convention
  32510. </summary>
  32511. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32512. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32513. <returns></returns>
  32514. </member>
  32515. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis2(System.Int32,System.Int32)">
  32516. <summary>
  32517. Basis 2, Actual/360 date convention
  32518. </summary>
  32519. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32520. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32521. <returns></returns>
  32522. </member>
  32523. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis3(System.Double,System.Double)">
  32524. <summary>
  32525. Basis 3, Actual/365 date convention
  32526. </summary>
  32527. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32528. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32529. <returns></returns>
  32530. </member>
  32531. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis4(System.Int32,System.Int32)">
  32532. <summary>
  32533. Basis 4, European 30/360 date convention
  32534. </summary>
  32535. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32536. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32537. <returns></returns>
  32538. </member>
  32539. <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)">
  32540. <summary>
  32541. Calculates the adjusted.
  32542. </summary>
  32543. <param name="startDate">The start date.</param>
  32544. <param name="endDate">The end date.</param>
  32545. <param name="date1day">The date1day.</param>
  32546. <param name="date2day">The date2day.</param>
  32547. <returns></returns>
  32548. </member>
  32549. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32550. <summary>
  32551. Determines whether [is last day of month] [the specified date].
  32552. </summary>
  32553. <param name="date">The date.</param>
  32554. <returns>
  32555. <c>true</c> if [is last day of month] [the specified date]; otherwise, <c>false</c>.
  32556. </returns>
  32557. </member>
  32558. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.GetLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32559. <summary>
  32560. Gets the last day of month.
  32561. </summary>
  32562. <param name="date">The date.</param>
  32563. <returns></returns>
  32564. </member>
  32565. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.ShouldCountFeb29(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32566. <summary>
  32567. Assumes dates are no more than 1 year apart.
  32568. </summary>
  32569. <param name="start">The start.</param>
  32570. <param name="end">The end.</param>
  32571. <returns><c>true</c>
  32572. if dates both within a leap year, or span a period including Feb 29</returns>
  32573. </member>
  32574. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.DateDiff(System.Int64,System.Int64)">
  32575. <summary>
  32576. return the whole number of days between the two time-stamps. Both time-stamps are
  32577. assumed to represent 12:00 midnight on the respective day.
  32578. </summary>
  32579. <param name="startDateTicks">The start date ticks.</param>
  32580. <param name="endDateTicks">The end date ticks.</param>
  32581. <returns></returns>
  32582. </member>
  32583. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.AverageYearLength(System.Int32,System.Int32)">
  32584. <summary>
  32585. Averages the length of the year.
  32586. </summary>
  32587. <param name="startYear">The start year.</param>
  32588. <param name="endYear">The end year.</param>
  32589. <returns></returns>
  32590. </member>
  32591. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLeapYear(System.Int32)">
  32592. <summary>
  32593. determine Leap Year
  32594. </summary>
  32595. <param name="i">the year</param>
  32596. <returns></returns>
  32597. </member>
  32598. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsGreaterThanOneYear(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32599. <summary>
  32600. Determines whether [is greater than one year] [the specified start].
  32601. </summary>
  32602. <param name="start">The start date.</param>
  32603. <param name="end">The end date.</param>
  32604. <returns>
  32605. <c>true</c> if [is greater than one year] [the specified start]; otherwise, <c>false</c>.
  32606. </returns>
  32607. </member>
  32608. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CreateDate(System.Int32)">
  32609. <summary>
  32610. Creates the date.
  32611. </summary>
  32612. <param name="dayCount">The day count.</param>
  32613. <returns></returns>
  32614. </member>
  32615. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate">
  32616. <summary>
  32617. Simple Date Wrapper
  32618. </summary>
  32619. </member>
  32620. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.month">
  32621. 1-based month
  32622. </member>
  32623. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.day">
  32624. day of month
  32625. </member>
  32626. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.ticks">
  32627. milliseconds since 1970
  32628. </member>
  32629. <member name="T:NPOI.SS.Formula.BaseFormulaEvaluator">
  32630. Common functionality across file formats for Evaluating formula cells.<p/>
  32631. </member>
  32632. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.BaseFormulaEvaluator[])">
  32633. Coordinates several formula Evaluators together so that formulas that involve external
  32634. references can be Evaluated.
  32635. @param workbookNames the simple file names used to identify the workbooks in formulas
  32636. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  32637. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  32638. </member>
  32639. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.ClearAllCachedResultValues">
  32640. Should be called whenever there are major Changes (e.g. moving sheets) to input cells
  32641. in the Evaluated workbook. If performance is not critical, a single call to this method
  32642. may be used instead of many specific calls to the Notify~ methods.
  32643. Failure to call this method After changing cell values will cause incorrect behaviour
  32644. of the Evaluate~ methods of this class
  32645. </member>
  32646. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  32647. If cell Contains a formula, the formula is Evaluated and returned,
  32648. else the CellValue simply copies the appropriate cell value from
  32649. the cell and also its cell type. This method should be preferred over
  32650. EvaluateInCell() when the call should not modify the contents of the
  32651. original cell.
  32652. @param cell may be <code>null</code> signifying that the cell is not present (or blank)
  32653. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  32654. </member>
  32655. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  32656. If cell Contains formula, it Evaluates the formula, and
  32657. Puts the formula result back into the cell, in place
  32658. of the old formula.
  32659. Else if cell does not contain formula, this method leaves
  32660. the cell unChanged.
  32661. Note that the same instance of HSSFCell is returned to
  32662. allow chained calls like:
  32663. <pre>
  32664. int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType;
  32665. </pre>
  32666. Be aware that your cell value will be Changed to hold the
  32667. result of the formula. If you simply want the formula
  32668. value computed for you, use {@link #EvaluateFormulaCellEnum(Cell)}}
  32669. @param cell
  32670. @return the {@code cell} that was passed in, allowing for chained calls
  32671. </member>
  32672. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  32673. If cell Contains formula, it Evaluates the formula, and saves the result of the formula. The
  32674. cell remains as a formula cell. If the cell does not contain formula, this method returns -1
  32675. and leaves the cell unChanged.
  32676. Note that the type of the <em>formula result</em> is returned, so you know what kind of
  32677. cached formula result is also stored with the formula.
  32678. <pre>
  32679. int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell);
  32680. </pre>
  32681. Be aware that your cell will hold both the formula, and the result. If you want the cell
  32682. Replaced with the result of the formula, use {@link #EvaluateInCell(NPOI.SS.UserModel.Cell)}
  32683. @param cell The cell to Evaluate
  32684. @return -1 for non-formula cells, or the type of the <em>formula result</em>
  32685. </member>
  32686. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateFormulaCellEnum(NPOI.SS.UserModel.ICell)">
  32687. If cell Contains formula, it Evaluates the formula,
  32688. and saves the result of the formula. The cell
  32689. remains as a formula cell.
  32690. Else if cell does not contain formula, this method leaves
  32691. the cell unChanged.
  32692. Note that the type of the formula result is returned,
  32693. so you know what kind of value is also stored with
  32694. the formula.
  32695. <pre>
  32696. ICellType EvaluatedCellType = Evaluator.EvaluateFormulaCellEnum(cell);
  32697. </pre>
  32698. Be aware that your cell will hold both the formula,
  32699. and the result. If you want the cell Replaced with
  32700. the result of the formula, use {@link #Evaluate(NPOI.SS.UserModel.Cell)} }
  32701. @param cell The cell to Evaluate
  32702. @return The type of the formula result (the cell's type remains as CellType.FORMULA however)
  32703. If cell is not a formula cell, returns {@link CellType#_NONE} rather than throwing an exception.
  32704. @since POI 3.15 beta 3
  32705. </member>
  32706. <member name="M:NPOI.SS.Formula.BaseFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  32707. Loops over all cells in all sheets of the supplied
  32708. workbook.
  32709. For cells that contain formulas, their formulas are
  32710. Evaluated, and the results are saved. These cells
  32711. remain as formula cells.
  32712. For cells that do not contain formulas, no Changes
  32713. are made.
  32714. This is a helpful wrapper around looping over all
  32715. cells, and calling EvaluateFormulaCell on each one.
  32716. </member>
  32717. <member name="P:NPOI.SS.Formula.BaseFormulaEvaluator.IgnoreMissingWorkbooks">
  32718. {@inheritDoc}
  32719. </member>
  32720. <member name="P:NPOI.SS.Formula.BaseFormulaEvaluator.DebugEvaluationOutputForNextEval">
  32721. {@inheritDoc}
  32722. </member>
  32723. <member name="T:NPOI.SS.Formula.Eval.NotImplementedFunctionException">
  32724. An exception thrown by implementors of {@link FormulaEvaluator} when
  32725. attempting to evaluate a formula which requires a function that POI
  32726. does not (yet) support.
  32727. </member>
  32728. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell">
  32729. Represents a cell being used for forked Evaluation that has had a value Set different from the
  32730. corresponding cell in the shared master workbook.
  32731. @author Josh Micich
  32732. </member>
  32733. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell._masterCell">
  32734. corresponding cell from master workbook
  32735. </member>
  32736. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet">
  32737. Represents a sheet being used for forked Evaluation. Initially, objects of this class contain
  32738. only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)},
  32739. the master cell object is logically Replaced with a {@link ForkedEvaluationCell} instance, which
  32740. will be used in all subsequent Evaluations.
  32741. @author Josh Micich
  32742. </member>
  32743. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet._sharedCellsByRowCol">
  32744. Only cells which have been split are Put in this map. (This has been done to conserve memory).
  32745. </member>
  32746. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationWorkbook">
  32747. Represents a workbook being used for forked Evaluation. Most operations are delegated to the
  32748. shared master workbook, except those that potentially involve cell values that may have been
  32749. updated After a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
  32750. </member>
  32751. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator">
  32752. An alternative workbook Evaluator that saves memory in situations where a single workbook is
  32753. concurrently and independently Evaluated many times. With standard formula Evaluation, around
  32754. 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link NPOI.xssf.usermodel.XSSFWorkbook}.
  32755. This class enables a 'master workbook' to be loaded just once and shared between many Evaluation
  32756. clients. Each Evaluation client Creates its own {@link ForkedEvaluator} and can Set cell values
  32757. that will be used for local Evaluations (and don't disturb Evaluations on other Evaluators).
  32758. @author Josh Micich
  32759. </member>
  32760. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.UDF.UDFFinder)">
  32761. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  32762. </member>
  32763. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.UpdateCell(System.String,System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  32764. Sets the specified cell to the supplied <tt>value</tt>
  32765. @param sheetName the name of the sheet Containing the cell
  32766. @param rowIndex zero based
  32767. @param columnIndex zero based
  32768. </member>
  32769. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.CopyUpdatedCells(NPOI.SS.UserModel.IWorkbook)">
  32770. Copies the values of all updated cells (modified by calls to {@link
  32771. #updateCell(String, int, int, ValueEval)}) to the supplied <tt>workbook</tt>.<br/>
  32772. Typically, the supplied <tt>workbook</tt> is a writable copy of the 'master workbook',
  32773. but at the very least it must contain sheets with the same names.
  32774. </member>
  32775. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Evaluate(System.String,System.Int32,System.Int32)">
  32776. If cell Contains a formula, the formula is Evaluated and returned,
  32777. else the CellValue simply copies the appropriate cell value from
  32778. the cell and also its cell type. This method should be preferred over
  32779. EvaluateInCell() when the call should not modify the contents of the
  32780. original cell.
  32781. @param sheetName the name of the sheet Containing the cell
  32782. @param rowIndex zero based
  32783. @param columnIndex zero based
  32784. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  32785. </member>
  32786. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.Eval.Forked.ForkedEvaluator[])">
  32787. Coordinates several formula Evaluators together so that formulas that involve external
  32788. references can be Evaluated.
  32789. @param workbookNames the simple file names used to identify the workbooks in formulas
  32790. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  32791. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  32792. </member>
  32793. <member name="T:NPOI.SS.Formula.Eval.AreaEval">
  32794. Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas
  32795. </member>
  32796. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstRow">
  32797. returns the 0-based index of the first row in
  32798. this area.
  32799. </member>
  32800. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastRow">
  32801. returns the 0-based index of the last row in
  32802. this area.
  32803. </member>
  32804. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstColumn">
  32805. returns the 0-based index of the first col in
  32806. this area.
  32807. </member>
  32808. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastColumn">
  32809. returns the 0-based index of the last col in
  32810. this area.
  32811. </member>
  32812. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Contains(System.Int32,System.Int32)">
  32813. returns true if the cell at row and col specified
  32814. as absolute indexes in the sheet is contained in
  32815. this area.
  32816. @param row
  32817. @param col
  32818. </member>
  32819. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsColumn(System.Int32)">
  32820. returns true if the specified col is in range
  32821. @param col
  32822. </member>
  32823. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsRow(System.Int32)">
  32824. returns true if the specified row is in range
  32825. @param row
  32826. </member>
  32827. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetAbsoluteValue(System.Int32,System.Int32)">
  32828. @return the ValueEval from within this area at the specified row and col index. Never
  32829. <code>null</code> (possibly {@link BlankEval}). The specified indexes should be absolute
  32830. indexes in the sheet and not relative indexes within the area.
  32831. </member>
  32832. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetRelativeValue(System.Int32,System.Int32)">
  32833. @return the ValueEval from within this area at the specified relativeRowIndex and
  32834. relativeColumnIndex. Never <c>null</c> (possibly {@link BlankEval}). The
  32835. specified indexes should relative to the top left corner of this area.
  32836. </member>
  32837. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  32838. Creates an {@link AreaEval} offset by a relative amount from from the upper left cell
  32839. of this area
  32840. </member>
  32841. <member name="T:NPOI.SS.Formula.Eval.AreaEvalBase">
  32842. @author Josh Micich
  32843. </member>
  32844. <member name="M:NPOI.SS.Formula.Eval.AreaEvalBase.IsSubTotal(System.Int32,System.Int32)">
  32845. @return whether cell at rowIndex and columnIndex is a subtotal.
  32846. By default return false which means 'don't care about subtotals'
  32847. </member>
  32848. <member name="T:NPOI.SS.Formula.Eval.BlankEval">
  32849. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt; This class is a
  32850. marker class. It is a special value for empty cells.
  32851. </member>
  32852. <member name="T:NPOI.SS.Formula.Eval.BoolEval">
  32853. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32854. </member>
  32855. <member name="M:NPOI.SS.Formula.Eval.BoolEval.ValueOf(System.Boolean)">
  32856. Convenience method for the following:<br/>
  32857. <c>(b ? BoolEval.TRUE : BoolEval.FALSE)</c>
  32858. @return a <c>BoolEval</c> instance representing <c>b</c>.
  32859. </member>
  32860. <member name="T:NPOI.SS.Formula.Eval.ConcatEval">
  32861. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32862. </member>
  32863. <member name="T:NPOI.SS.Formula.Eval.ErrorEval">
  32864. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32865. </member>
  32866. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NULL_INTERSECTION">
  32867. <b>#NULL!</b> - Intersection of two cell ranges is empty
  32868. </member>
  32869. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.DIV_ZERO">
  32870. <b>#DIV/0!</b> - Division by zero
  32871. </member>
  32872. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.VALUE_INVALID">
  32873. <b>#VALUE!</b> - Wrong type of operand
  32874. </member>
  32875. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.REF_INVALID">
  32876. <b>#REF!</b> - Illegal or deleted cell reference
  32877. </member>
  32878. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NAME_INVALID">
  32879. <b>#NAME?</b> - Wrong function or range name
  32880. </member>
  32881. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NUM_ERROR">
  32882. <b>#NUM!</b> - Value range overflow
  32883. </member>
  32884. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NA">
  32885. <b>#N/A</b> - Argument or function not available
  32886. </member>
  32887. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.ValueOf(System.Int32)">
  32888. Translates an Excel internal error code into the corresponding POI ErrorEval instance
  32889. @param errorCode
  32890. </member>
  32891. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.GetText(System.Int32)">
  32892. Converts error codes to text. Handles non-standard error codes OK.
  32893. For debug/test purposes (and for formatting error messages).
  32894. @return the String representation of the specified Excel error code.
  32895. </member>
  32896. <member name="T:NPOI.SS.Formula.Eval.Eval">
  32897. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32898. </member>
  32899. <member name="T:NPOI.SS.Formula.Eval.EvaluationException">
  32900. This class is used to simplify error handling logic <i>within</i> operator and function
  32901. implementations. Note - <c>OperationEval.Evaluate()</c> and <c>Function.Evaluate()</c>
  32902. method signatures do not throw this exception so it cannot propagate outside.<p/>
  32903. Here is an example coded without <c>EvaluationException</c>, to show how it can help:
  32904. <pre>
  32905. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  32906. // ...
  32907. Eval arg0 = args[0];
  32908. if(arg0 is ErrorEval) {
  32909. return arg0;
  32910. }
  32911. if(!(arg0 is AreaEval)) {
  32912. return ErrorEval.VALUE_INVALID;
  32913. }
  32914. double temp = 0;
  32915. AreaEval area = (AreaEval)arg0;
  32916. ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
  32917. for (int i = 0; i &lt; values.Length; i++) {
  32918. ValueEval ve = values[i];
  32919. if(ve is ErrorEval) {
  32920. return ve;
  32921. }
  32922. if(!(ve is NumericValueEval)) {
  32923. return ErrorEval.VALUE_INVALID;
  32924. }
  32925. temp += ((NumericValueEval)ve).NumberValue;
  32926. }
  32927. // ...
  32928. }
  32929. </pre>
  32930. In this example, if any error is encountered while Processing the arguments, an error is
  32931. returned immediately. This code is difficult to refactor due to all the points where errors
  32932. are returned.<br/>
  32933. Using <c>EvaluationException</c> allows the error returning code to be consolidated to one
  32934. place.<p/>
  32935. <pre>
  32936. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  32937. try {
  32938. // ...
  32939. AreaEval area = GetAreaArg(args[0]);
  32940. double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
  32941. // ...
  32942. } catch (EvaluationException e) {
  32943. return e.GetErrorEval();
  32944. }
  32945. }
  32946. private static AreaEval GetAreaArg(Eval arg0){
  32947. if (arg0 is ErrorEval) {
  32948. throw new EvaluationException((ErrorEval) arg0);
  32949. }
  32950. if (arg0 is AreaEval) {
  32951. return (AreaEval) arg0;
  32952. }
  32953. throw EvaluationException.InvalidValue();
  32954. }
  32955. private double sumValues(ValueEval[] values){
  32956. double temp = 0;
  32957. for (int i = 0; i &lt; values.Length; i++) {
  32958. ValueEval ve = values[i];
  32959. if (ve is ErrorEval) {
  32960. throw new EvaluationException((ErrorEval) ve);
  32961. }
  32962. if (!(ve is NumericValueEval)) {
  32963. throw EvaluationException.InvalidValue();
  32964. }
  32965. temp += ((NumericValueEval) ve).NumberValue;
  32966. }
  32967. return temp;
  32968. }
  32969. </pre>
  32970. It is not mandatory to use EvaluationException, doing so might give the following advantages:<br/>
  32971. - Methods can more easily be extracted, allowing for re-use.<br/>
  32972. - Type management (typecasting etc) is simpler because error conditions have been Separated from
  32973. intermediate calculation values.<br/>
  32974. - Fewer local variables are required. Local variables can have stronger types.<br/>
  32975. - It is easier to mimic common Excel error handling behaviour (exit upon encountering first
  32976. error), because exceptions conveniently propagate up the call stack regardless of execution
  32977. points or the number of levels of nested calls.<p/>
  32978. <b>Note</b> - Only standard evaluation errors are represented by <c>EvaluationException</c> (
  32979. i.e. conditions expected to be encountered when evaluating arbitrary Excel formulas). Conditions
  32980. that could never occur in an Excel spReadsheet should result in runtime exceptions. Care should
  32981. be taken to not translate any POI internal error into an Excel evaluation error code.
  32982. @author Josh Micich
  32983. </member>
  32984. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidValue">
  32985. <b>#VALUE!</b> - Wrong type of operand
  32986. </member>
  32987. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidRef">
  32988. <b>#REF!</b> - Illegal or deleted cell reference
  32989. </member>
  32990. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.NumberError">
  32991. <b>#NUM!</b> - Value range overflow
  32992. </member>
  32993. <member name="T:NPOI.SS.Formula.Eval.FunctionEval">
  32994. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32995. </member>
  32996. <member name="T:NPOI.SS.Formula.Eval.FunctionEval.FunctionID">
  32997. Some function IDs that require special treatment
  32998. </member>
  32999. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.IF">
  33000. 1
  33001. </member>
  33002. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.OFFSET">
  33003. 78
  33004. </member>
  33005. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.CHOOSE">
  33006. 100
  33007. </member>
  33008. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.INDIRECT">
  33009. 148
  33010. </member>
  33011. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.EXTERNAL_FUNC">
  33012. 255
  33013. </member>
  33014. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.ProduceFunctions">
  33015. @see https://www.openoffice.org/sc/excelfileformat.pdf
  33016. </member>
  33017. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  33018. Register a new function in runtime.
  33019. @param name the function name
  33020. @param func the functoin to register
  33021. @throws ArgumentException if the function is unknown or already registered.
  33022. @since 3.8 beta6
  33023. </member>
  33024. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetSupportedFunctionNames">
  33025. Returns a collection of function names implemented by POI.
  33026. @return an array of supported functions
  33027. @since 3.8 beta6
  33028. </member>
  33029. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetNotSupportedFunctionNames">
  33030. Returns an array of function names NOT implemented by POI.
  33031. @return an array of not supported functions
  33032. @since 3.8 beta6
  33033. </member>
  33034. <member name="T:NPOI.SS.Formula.Eval.IntersectionEval">
  33035. @author Josh Micich
  33036. </member>
  33037. <member name="M:NPOI.SS.Formula.Eval.IntersectionEval.ResolveRange(NPOI.SS.Formula.Eval.AreaEval,NPOI.SS.Formula.Eval.AreaEval)">
  33038. @return simple rectangular {@link AreaEval} which represents the intersection of areas
  33039. <c>aeA</c> and <c>aeB</c>. If the two areas do not intersect, the result is <code>null</code>.
  33040. </member>
  33041. <member name="T:NPOI.SS.Formula.Eval.FunctionNameEval">
  33042. @author Josh Micich
  33043. </member>
  33044. <member name="M:NPOI.SS.Formula.Eval.FunctionNameEval.#ctor(System.String)">
  33045. Creates a NameEval representing a function name
  33046. </member>
  33047. <member name="T:NPOI.SS.Formula.Eval.ExternalNameEval">
  33048. Evaluation of a Name defined in a Sheet or Workbook scope
  33049. </member>
  33050. <member name="T:NPOI.SS.Formula.Eval.NumberEval">
  33051. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33052. </member>
  33053. <member name="T:NPOI.SS.Formula.Eval.NumericValueEval">
  33054. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33055. </member>
  33056. <member name="T:NPOI.SS.Formula.Eval.OperandResolver">
  33057. Provides functionality for evaluating arguments to functions and operators.
  33058. @author Josh Micich
  33059. </member>
  33060. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.GetSingleValue(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33061. Retrieves a single value from a variety of different argument types according to standard
  33062. Excel rules. Does not perform any type conversion.
  33063. @param arg the Evaluated argument as passed to the function or operator.
  33064. @param srcCellRow used when arg is a single column AreaRef
  33065. @param srcCellCol used when arg is a single row AreaRef
  33066. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c> or <c>BlankEval</c>.
  33067. Never <c>null</c> or <c>ErrorEval</c>.
  33068. @throws EvaluationException(#VALUE!) if srcCellRow or srcCellCol do not properly index into
  33069. an AreaEval. If the actual value retrieved is an ErrorEval, a corresponding
  33070. EvaluationException is thrown.
  33071. </member>
  33072. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  33073. Implements (some perhaps not well known) Excel functionality to select a single cell from an
  33074. area depending on the coordinates of the calling cell. Here is an example demonstrating
  33075. both selection from a single row area and a single column area in the same formula.
  33076. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  33077. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  33078. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  33079. <tr><th>2</th><td> </td><td> </td><td> </td><td>200</td></tr>
  33080. <tr><th>3</th><td> </td><td> </td><td> </td><td>300</td></tr>
  33081. <tr><th>3</th><td> </td><td> </td><td> </td><td>400</td></tr>
  33082. </table>
  33083. If the formula "=1000+A1:B1+D2:D3" is put into the 9 cells from A2 to C4, the spReadsheet
  33084. will look like this:
  33085. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  33086. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  33087. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  33088. <tr><th>2</th><td>1215</td><td>1220</td><td>#VALUE!</td><td>200</td></tr>
  33089. <tr><th>3</th><td>1315</td><td>1320</td><td>#VALUE!</td><td>300</td></tr>
  33090. <tr><th>4</th><td>#VALUE!</td><td>#VALUE!</td><td>#VALUE!</td><td>400</td></tr>
  33091. </table>
  33092. Note that the row area (A1:B1) does not include column C and the column area (D2:D3) does
  33093. not include row 4, so the values in C1(=25) and D4(=400) are not accessible to the formula
  33094. as written, but in the 4 cells A2:B3, the row and column selection works ok.<p/>
  33095. The same concept is extended to references across sheets, such that even multi-row,
  33096. multi-column areas can be useful.<p/>
  33097. Of course with carefully (or carelessly) chosen parameters, cyclic references can occur and
  33098. hence this method <b>can</b> throw a 'circular reference' EvaluationException. Note that
  33099. this method does not attempt to detect cycles. Every cell in the specified Area <c>ae</c>
  33100. has already been Evaluated prior to this method call. Any cell (or cell<b>s</b>) part of
  33101. <c>ae</c> that would incur a cyclic reference error if selected by this method, will
  33102. already have the value <c>ErrorEval.CIRCULAR_REF_ERROR</c> upon entry to this method. It
  33103. is assumed logic exists elsewhere to produce this behaviour.
  33104. @return whatever the selected cell's Evaluated value Is. Never <c>null</c>. Never
  33105. <c>ErrorEval</c>.
  33106. @if there is a problem with indexing into the area, or if the
  33107. Evaluated cell has an error.
  33108. </member>
  33109. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromAreaInternal(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  33110. @return possibly <c>ErrorEval</c>, and <c>null</c>
  33111. </member>
  33112. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToInt(NPOI.SS.Formula.Eval.ValueEval)">
  33113. Applies some conversion rules if the supplied value is not already an integer.<br/>
  33114. Value is first Coerced to a <c>double</c> ( See <c>CoerceValueTodouble()</c> ).<p/>
  33115. Excel typically Converts doubles to integers by truncating toward negative infinity.<br/>
  33116. The equivalent java code Is:<br/>
  33117. <c>return (int)Math.floor(d);</c><br/>
  33118. <b>not</b>:<br/>
  33119. <c>return (int)d; // wrong - rounds toward zero</c>
  33120. </member>
  33121. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToDouble(NPOI.SS.Formula.Eval.ValueEval)">
  33122. Applies some conversion rules if the supplied value is not already a number.
  33123. Note - <c>BlankEval</c> is not supported and must be handled by the caller.
  33124. @param ev must be a <c>NumberEval</c>, <c>StringEval</c> or <c>BoolEval</c>
  33125. @return actual, Parsed or interpreted double value (respectively).
  33126. @throws EvaluationException(#VALUE!) only if a StringEval is supplied and cannot be Parsed
  33127. as a double (See <c>Parsedouble()</c> for allowable formats).
  33128. @throws Exception if the supplied parameter is not <c>NumberEval</c>,
  33129. <c>StringEval</c> or <c>BoolEval</c>
  33130. </member>
  33131. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ParseDouble(System.String)">
  33132. Converts a string to a double using standard rules that Excel would use.<br/>
  33133. Tolerates currency prefixes, commas, leading and trailing spaces.<p/>
  33134. Some examples:<br/>
  33135. " 123 " -&gt; 123.0<br/>
  33136. ".123" -&gt; 0.123<br/>
  33137. These not supported yet:<br/>
  33138. " $ 1,000.00 " -&gt; 1000.0<br/>
  33139. "$1.25E4" -&gt; 12500.0<br/>
  33140. "5**2" -&gt; 500<br/>
  33141. "250%" -&gt; 2.5<br/>
  33142. @param text
  33143. @return <c>null</c> if the specified text cannot be Parsed as a number
  33144. </member>
  33145. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToString(NPOI.SS.Formula.Eval.ValueEval)">
  33146. @param ve must be a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>, or <c>BlankEval</c>
  33147. @return the Converted string value. never <c>null</c>
  33148. </member>
  33149. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToBoolean(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  33150. @return <c>null</c> to represent blank values
  33151. @throws EvaluationException if ve is an ErrorEval, or if a string value cannot be converted
  33152. </member>
  33153. <member name="T:NPOI.SS.Formula.Eval.OperationEval">
  33154. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33155. </member>
  33156. <member name="T:NPOI.SS.Formula.Eval.PercentEval">
  33157. Implementation of Excel formula token '%'. <p/>
  33158. @author Josh Micich
  33159. </member>
  33160. <member name="T:NPOI.SS.Formula.Eval.RangeEval">
  33161. @author Josh Micich
  33162. </member>
  33163. <member name="T:NPOI.SS.Formula.Eval.RefEval">
  33164. @author Amol S Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33165. RefEval is the base interface for Ref2D and Ref3DEval. Basically a RefEval
  33166. impl should contain reference to the original ReferencePtg or Ref3DPtg as
  33167. well as the "value" resulting from the evaluation of the cell
  33168. reference. Thus if the HSSFCell has type CELL_TYPE_NUMERIC, the contained
  33169. value object should be of type NumberEval; if cell type is CELL_TYPE_STRING,
  33170. contained value object should be of type StringEval
  33171. </member>
  33172. <member name="M:NPOI.SS.Formula.Eval.RefEval.GetInnerValueEval(System.Int32)">
  33173. The (possibly Evaluated) ValueEval contained
  33174. in this RefEval. eg. if cell A1 Contains "test"
  33175. then in a formula referring to cell A1
  33176. the RefEval representing
  33177. A1 will return as the InnerValueEval the
  33178. object of concrete type StringEval
  33179. </member>
  33180. <member name="P:NPOI.SS.Formula.Eval.RefEval.Column">
  33181. returns the zero based column index.
  33182. </member>
  33183. <member name="P:NPOI.SS.Formula.Eval.RefEval.Row">
  33184. returns the zero based row index.
  33185. </member>
  33186. <member name="P:NPOI.SS.Formula.Eval.RefEval.NumberOfSheets">
  33187. returns the number of sheets this applies to
  33188. </member>
  33189. <member name="M:NPOI.SS.Formula.Eval.RefEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  33190. Creates an {@link AreaEval} offset by a relative amount from this RefEval
  33191. </member>
  33192. <member name="T:NPOI.SS.Formula.Eval.EqualEval">
  33193. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33194. </member>
  33195. <member name="T:NPOI.SS.Formula.Eval.GreaterEqualEval">
  33196. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33197. </member>
  33198. <member name="T:NPOI.SS.Formula.Eval.GreaterThanEval">
  33199. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33200. </member>
  33201. <member name="T:NPOI.SS.Formula.Eval.LessEqualEval">
  33202. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33203. </member>
  33204. <member name="T:NPOI.SS.Formula.Eval.LessThanEval">
  33205. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33206. </member>
  33207. <member name="T:NPOI.SS.Formula.Eval.NotEqualEval">
  33208. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33209. </member>
  33210. <member name="T:NPOI.SS.Formula.Eval.RelationalOperationEval">
  33211. @author Amol S. Deshmukh &lt; amolweb at ya hoo Dot com &gt;
  33212. </member>
  33213. <member name="T:NPOI.SS.Formula.Eval.StringEval">
  33214. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33215. </member>
  33216. <member name="T:NPOI.SS.Formula.Eval.StringValueEval">
  33217. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33218. </member>
  33219. <member name="P:NPOI.SS.Formula.Eval.StringValueEval.StringValue">
  33220. @return never <code>null</code>, possibly empty string.
  33221. </member>
  33222. <member name="T:NPOI.SS.Formula.Eval.AddEval">
  33223. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33224. This is a documentation of the observed behaviour of
  33225. the '+' operator in Excel:
  33226. - 1+TRUE = 2
  33227. - 1+FALSE = 1
  33228. - 1+"true" = #VALUE!
  33229. - 1+"1" = 2
  33230. - 1+A1 = #VALUE if A1 Contains "1"
  33231. - 1+A1 = 2 if A1 Contains ="1"
  33232. - 1+A1 = 2 if A1 Contains TRUE or =TRUE
  33233. - 1+A1 = #VALUE! if A1 Contains "TRUE" or ="TRUE"
  33234. </member>
  33235. <member name="T:NPOI.SS.Formula.Eval.DivideEval">
  33236. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33237. </member>
  33238. <member name="T:NPOI.SS.Formula.Eval.MultiplyEval">
  33239. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33240. </member>
  33241. <member name="T:NPOI.SS.Formula.Eval.PowerEval">
  33242. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33243. </member>
  33244. <member name="T:NPOI.SS.Formula.Eval.SubtractEval">
  33245. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33246. </member>
  33247. <member name="T:NPOI.SS.Formula.Eval.UnaryMinusEval">
  33248. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33249. </member>
  33250. <member name="T:NPOI.SS.Formula.Eval.UnaryPlusEval">
  33251. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33252. </member>
  33253. <member name="T:NPOI.SS.Formula.Eval.ValueEval">
  33254. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33255. </member>
  33256. <member name="T:NPOI.SS.Formula.Functions.AverageIfs">
  33257. Implementation for the Excel function AverageIfs<br/>
  33258. <p>
  33259. Syntax : <br/>
  33260. AverageIfs ( <b>average_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  33261. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  33262. <ul>
  33263. <li><b>average_range</b> Required. One or more cells to get the average, including numbers or names, ranges,
  33264. or cell references that contain numbers. Blank and text values are ignored.</li>
  33265. <li><b>criteria1_range</b> Required. The first range in which
  33266. to evaluate the associated criteria.</li>
  33267. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  33268. cell reference, or text that define which cells in the criteria_range1
  33269. argument will be counted</li>
  33270. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  33271. Up to 127 range/criteria pairs are allowed.</li>
  33272. </ul>
  33273. </p>
  33274. @author Yegor Kozlov
  33275. </member>
  33276. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  33277. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  33278. as the <code>avgRange</code> argument
  33279. @throws EvaluationException if
  33280. </member>
  33281. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.GetAvgFromMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  33282. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeAvg</code>
  33283. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  33284. @param aeAvg the range to calculate
  33285. @return the computed value
  33286. </member>
  33287. <member name="T:NPOI.SS.Formula.Functions.BaseNumberUtils">
  33288. <p>Some utils for Converting from and to any base</p>
  33289. @author cedric dot walter @ gmail dot com
  33290. </member>
  33291. <member name="T:NPOI.SS.Formula.Functions.Bin2Dec">
  33292. Implementation for Excel Bin2Dec() function.<p/>
  33293. <p/>
  33294. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>)<br/>
  33295. <p/>
  33296. Converts a binary number to decimal.
  33297. <p/>
  33298. Number is the binary number you want to convert. Number cannot contain more than 10 characters (10 bits).
  33299. The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits.
  33300. Negative numbers are represented using two's-complement notation.
  33301. <p/>
  33302. Remark
  33303. If number is not a valid binary number, or if number contains more than 10 characters (10 bits),
  33304. BIN2DEC returns the #NUM! error value.
  33305. @author cedric dot walter @ gmail dot com
  33306. </member>
  33307. <member name="T:NPOI.SS.Formula.Functions.Code">
  33308. Implementation for Excel CODE () function.<p/>
  33309. <p/>
  33310. <b>Syntax</b>:<br/> <b>CODE </b>(<b>text</b> )<br/>
  33311. <p/>
  33312. Returns a numeric code for the first character in a text string. The returned code corresponds to the character set used by your computer.
  33313. <p/>
  33314. text The text for which you want the code of the first character.
  33315. @author cedric dot walter @ gmail dot com
  33316. </member>
  33317. <member name="T:NPOI.SS.Formula.Functions.Complex">
  33318. Implementation for Excel COMPLEX () function.<p/>
  33319. <p/>
  33320. <b>Syntax</b>:<br/> <b>COMPLEX </b>(<b>real_num</b>,<b>i_num</b>,<b>suffix </b> )<br/>
  33321. <p/>
  33322. Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.
  33323. <p/>
  33324. <p/>
  33325. All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J".
  33326. Using uppercase results in the #VALUE! error value. All functions that accept two
  33327. or more complex numbers require that all suffixes match.
  33328. <p/>
  33329. <b>real_num</b> The real coefficient of the complex number.
  33330. If this argument is nonnumeric, this function returns the #VALUE! error value.
  33331. <p/>
  33332. <p/>
  33333. <b>i_num</b> The imaginary coefficient of the complex number.
  33334. If this argument is nonnumeric, this function returns the #VALUE! error value.
  33335. <p/>
  33336. <p/>
  33337. <b>suffix</b> The suffix for the imaginary component of the complex number.
  33338. <ul>
  33339. <li>If omitted, suffix is assumed to be "i".</li>
  33340. <li>If suffix is neither "i" nor "j", COMPLEX returns the #VALUE! error value.</li>
  33341. </ul>
  33342. @author cedric dot walter @ gmail dot com
  33343. </member>
  33344. <member name="T:NPOI.SS.Formula.Functions.Countifs">
  33345. Implementation for the function COUNTIFS
  33346. <p>
  33347. Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2])
  33348. </p>
  33349. </member>
  33350. <member name="T:NPOI.SS.Formula.Functions.Dec2Bin">
  33351. Implementation for Excel Bin2Dec() function.<p/>
  33352. <p/>
  33353. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>,<b>[places]</b> )<br/>
  33354. <p/>
  33355. Converts a decimal number to binary.
  33356. <p/>
  33357. The DEC2BIN function syntax has the following arguments:
  33358. <ul>
  33359. <li>Number Required. The decimal integer you want to Convert. If number is negative, valid place values are ignored and DEC2BIN returns a 10-character (10-bit) binary number in which the most significant bit is the sign bit. The remaining 9 bits are magnitude bits. Negative numbers are represented using two's-complement notation.</li>
  33360. <li>Places Optional. The number of characters to use. If places is omitted, DEC2BIN uses the minimum number of characters necessary. Places is useful for pAdding the return value with leading 0s (zeros).</li>
  33361. </ul>
  33362. <p/>
  33363. Remarks
  33364. <ul>
  33365. <li>If number &lt; -512 or if number &gt; 511, DEC2BIN returns the #NUM! error value.</li>
  33366. <li>If number is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  33367. <li>If DEC2BIN requires more than places characters, it returns the #NUM! error value.</li>
  33368. <li>If places is not an integer, it is tRuncated.</li>
  33369. <li>If places is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  33370. <li>If places is zero or negative, DEC2BIN returns the #NUM! error value.</li>
  33371. </ul>
  33372. @author cedric dot walter @ gmail dot com
  33373. </member>
  33374. <member name="T:NPOI.SS.Formula.Functions.Dec2Hex">
  33375. Implementation for Excel DELTA() function.<p/>
  33376. <p/>
  33377. <b>Syntax</b>:<br/> <b>DEC2HEX </b>(<b>number</b>,<b>places</b> )<br/>
  33378. <p/>
  33379. Converts a decimal number to hexadecimal.
  33380. The decimal integer you want to Convert. If number is negative, places is ignored
  33381. and this function returns a 10-character (40-bit) hexadecimal number in which the
  33382. most significant bit is the sign bit. The remaining 39 bits are magnitude bits.
  33383. Negative numbers are represented using two's-complement notation.
  33384. <ul>
  33385. <li>If number &lt; -549,755,813,888 or if number &gt; 549,755,813,887, this function returns the #NUM! error value.</li>
  33386. <li>If number is nonnumeric, this function returns the #VALUE! error value.</li>
  33387. </ul>
  33388. <h2>places</h2>
  33389. The number of characters to use. The places argument is useful for pAdding the
  33390. return value with leading 0s (zeros).
  33391. <ul>
  33392. <li>If this argument is omitted, this function uses the minimum number of characters necessary.</li>
  33393. <li>If this function requires more than places characters, it returns the #NUM! error value.</li>
  33394. <li>If this argument is nonnumeric, this function returns the #VALUE! error value.</li>
  33395. <li>If this argument is negative, this function returns the #NUM! error value.</li>
  33396. <li>If this argument Contains a decimal value, this function ignores the numbers to the right side of the decimal point.</li>
  33397. </ul>
  33398. @author cedric dot walter @ gmail dot com
  33399. </member>
  33400. <member name="T:NPOI.SS.Formula.Functions.Delta">
  33401. Implementation for Excel DELTA() function.<p/>
  33402. <p/>
  33403. <b>Syntax</b>:<br/> <b>DELTA </b>(<b>number1</b>,<b>number2</b> )<br/>
  33404. <p/>
  33405. Tests whether two values are Equal. Returns 1 if number1 = number2; returns 0 otherwise.
  33406. Use this function to filter a Set of values. For example, by summing several DELTA functions
  33407. you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.
  33408. <ul>
  33409. <li>If number1 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  33410. <li>If number2 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  33411. </ul>
  33412. @author cedric dot walter @ gmail dot com
  33413. </member>
  33414. <member name="T:NPOI.SS.Formula.Functions.DGet">
  33415. Implementation of the DGet function:
  33416. Finds the value of a column in an area with given conditions.
  33417. TODO:
  33418. - wildcards ? and * in string conditions
  33419. - functions as conditions
  33420. </member>
  33421. <member name="T:NPOI.SS.Formula.Functions.DMin">
  33422. Implementation of the DMin function:
  33423. Finds the minimum value of a column in an area with given conditions.
  33424. TODO:
  33425. - wildcards ? and * in string conditions
  33426. - functions as conditions
  33427. </member>
  33428. <member name="T:NPOI.SS.Formula.Functions.DStarRunner">
  33429. This class performs a D* calculation. It takes an {@link IDStarAlgorithm} object and
  33430. uses it for calculating the result value. Iterating a database and Checking the
  33431. entries against the Set of conditions is done here.
  33432. </member>
  33433. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForName(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  33434. @param nameValueEval Must not be a RefEval or AreaEval. Thus make sure resolveReference() is called on the value first!
  33435. @param db
  33436. @return
  33437. @throws EvaluationException
  33438. </member>
  33439. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForString(NPOI.SS.Formula.Eval.AreaEval,System.String)">
  33440. For a given database returns the column number for a column heading.
  33441. @param db Database.
  33442. @param name Column heading.
  33443. @return Corresponding column number.
  33444. @If it's not possible to turn all headings into strings.
  33445. </member>
  33446. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.FullFillsConditions(NPOI.SS.Formula.Eval.AreaEval,System.Int32,NPOI.SS.Formula.Eval.AreaEval)">
  33447. Checks a row in a database against a condition database.
  33448. @param db Database.
  33449. @param row The row in the database to Check.
  33450. @param cdb The condition database to use for Checking.
  33451. @return Whether the row matches the conditions.
  33452. @If references could not be Resolved or comparison
  33453. operators and operands didn't match.
  33454. </member>
  33455. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNormalCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  33456. Test a value against a simple (&lt; &gt; &lt;= &gt;= = starts-with) condition string.
  33457. @param value The value to Check.
  33458. @param condition The condition to check for.
  33459. @return Whether the condition holds.
  33460. @If comparison operator and operands don't match.
  33461. </member>
  33462. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNumericCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.DStarRunner.Operator,System.String)">
  33463. Test whether a value matches a numeric condition.
  33464. @param valueEval Value to Check.
  33465. @param op Comparator to use.
  33466. @param condition Value to check against.
  33467. @return whether the condition holds.
  33468. @If it's impossible to turn the condition into a number.
  33469. </member>
  33470. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.ResolveReference(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  33471. Resolve a ValueEval that's in an AreaEval.
  33472. @param db AreaEval from which the cell to resolve is retrieved.
  33473. @param dbRow Relative row in the AreaEval.
  33474. @param dbCol Relative column in the AreaEval.
  33475. @return A ValueEval that is a NumberEval, StringEval, BoolEval, BlankEval or ErrorEval.
  33476. </member>
  33477. <member name="T:NPOI.SS.Formula.Functions.EOMonth">
  33478. Implementation for the Excel EOMONTH() function.<p/>
  33479. <p/>
  33480. EOMONTH() returns the date of the last day of a month..<p/>
  33481. <p/>
  33482. <b>Syntax</b>:<br/>
  33483. <b>EOMONTH</b>(<b>start_date</b>,<b>months</b>)<p/>
  33484. <p/>
  33485. <b>start_date</b> is the starting date of the calculation
  33486. <b>months</b> is the number of months to be Added to <b>start_date</b>,
  33487. to give a new date. For this new date, <b>EOMONTH</b> returns the date of
  33488. the last day of the month. <b>months</b> may be positive (in the future),
  33489. zero or negative (in the past).
  33490. </member>
  33491. <member name="T:NPOI.SS.Formula.Functions.Errortype">
  33492. Implementation for the ERROR.TYPE() Excel function.
  33493. <p>
  33494. <b>Syntax:</b><br/>
  33495. <b>ERROR.TYPE</b>(<b>errorValue</b>)</p>
  33496. <p>
  33497. Returns a number corresponding to the error type of the supplied argument.</p>
  33498. <p>
  33499. <table border="1" cellpadding="1" cellspacing="1" summary="Return values for ERROR.TYPE()">
  33500. <tr><td>errorValue</td><td>Return Value</td></tr>
  33501. <tr><td>#NULL!</td><td>1</td></tr>
  33502. <tr><td>#DIV/0!</td><td>2</td></tr>
  33503. <tr><td>#VALUE!</td><td>3</td></tr>
  33504. <tr><td>#REF!</td><td>4</td></tr>
  33505. <tr><td>#NAME?</td><td>5</td></tr>
  33506. <tr><td>#NUM!</td><td>6</td></tr>
  33507. <tr><td>#N/A!</td><td>7</td></tr>
  33508. <tr><td>everything else</td><td>#N/A!</td></tr>
  33509. </table>
  33510. Note - the results of ERROR.TYPE() are different to the constants defined in
  33511. <tt>ErrorConstants</tt>.
  33512. </p>
  33513. @author Josh Micich
  33514. </member>
  33515. <member name="T:NPOI.SS.Formula.Functions.FactDouble">
  33516. Implementation for Excel FACTDOUBLE() function.<p/>
  33517. <p/>
  33518. <b>Syntax</b>:<br/> <b>FACTDOUBLE </b>(<b>number</b>)<br/>
  33519. <p/>
  33520. Returns the double factorial of a number.
  33521. <p/>
  33522. Number is the value for which to return the double factorial. If number is not an integer, it is truncated.
  33523. <p/>
  33524. Remarks
  33525. <ul>
  33526. <li>If number is nonnumeric, FACTDOUBLE returns the #VALUE! error value.</li>
  33527. <li>If number is negative, FACTDOUBLE returns the #NUM! error value.</li>
  33528. </ul>
  33529. Use a cache for more speed of previously calculated factorial
  33530. @author cedric dot walter @ gmail dot com
  33531. </member>
  33532. <member name="T:NPOI.SS.Formula.Functions.Finance">
  33533. Implementation of the financial functions pmt, fv, ppmt, ipmt.
  33534. @author Mike Argyriou micharg@gmail.com
  33535. </member>
  33536. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  33537. Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type)
  33538. function, which calculates the payments for a loan or the future value of an investment
  33539. @param r
  33540. - periodic interest rate represented as a decimal.
  33541. @param nper
  33542. - number of total payments / periods.
  33543. @param pv
  33544. - present value -- borrowed or invested principal.
  33545. @param fv
  33546. - future value of loan or annuity.
  33547. @param type
  33548. - when payment is made: beginning of period is 1; end, 0.
  33549. @return <code>double</code> representing periodic payment amount.
  33550. </member>
  33551. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double)">
  33552. Overloaded pmt() call omitting type, which defaults to 0.
  33553. @see #pmt(double, int, double, double, int)
  33554. </member>
  33555. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double)">
  33556. Overloaded pmt() call omitting fv and type, which both default to 0.
  33557. @see #pmt(double, int, double, double, int)
  33558. </member>
  33559. <member name="M:NPOI.SS.Formula.Functions.Finance.IPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  33560. Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV,
  33561. FV, Type) function, which calculates the portion of the payment at a
  33562. given period that is the interest on previous balance.
  33563. @param r
  33564. - periodic interest rate represented as a decimal.
  33565. @param per
  33566. - period (payment number) to check value at.
  33567. @param nper
  33568. - number of total payments / periods.
  33569. @param pv
  33570. - present value -- borrowed or invested principal.
  33571. @param fv
  33572. - future value of loan or annuity.
  33573. @param type
  33574. - when payment is made: beginning of period is 1; end, 0.
  33575. @return <code>double</code> representing interest portion of payment.
  33576. @see #pmt(double, int, double, double, int)
  33577. @see #fv(double, int, double, double, int)
  33578. </member>
  33579. <member name="M:NPOI.SS.Formula.Functions.Finance.PPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  33580. Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV,
  33581. FV, Type) function, which calculates the portion of the payment at a
  33582. given period that will apply to principal.
  33583. @param r
  33584. - periodic interest rate represented as a decimal.
  33585. @param per
  33586. - period (payment number) to check value at.
  33587. @param nper
  33588. - number of total payments / periods.
  33589. @param pv
  33590. - present value -- borrowed or invested principal.
  33591. @param fv
  33592. - future value of loan or annuity.
  33593. @param type
  33594. - when payment is made: beginning of period is 1; end, 0.
  33595. @return <code>double</code> representing principal portion of payment.
  33596. @see #pmt(double, int, double, double, int)
  33597. @see #ipmt(double, int, int, double, double, bool)
  33598. </member>
  33599. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  33600. Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV,
  33601. Type) function, which calculates future value or principal at period N.
  33602. @param r
  33603. - periodic interest rate represented as a decimal.
  33604. @param nper
  33605. - number of total payments / periods.
  33606. @param pmt
  33607. - periodic payment amount.
  33608. @param pv
  33609. - present value -- borrowed or invested principal.
  33610. @param type
  33611. - when payment is made: beginning of period is 1; end, 0.
  33612. @return <code>double</code> representing future principal value.
  33613. </member>
  33614. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double)">
  33615. Overloaded fv() call omitting type, which defaults to 0.
  33616. @see #fv(double, int, double, double, int)
  33617. </member>
  33618. <member name="T:NPOI.SS.Formula.Functions.Hex2Dec">
  33619. Implementation for Excel HEX2DEC() function.<p/>
  33620. <p/>
  33621. <b>Syntax</b>:<br/> <b>HEX2DEC </b>(<b>number</b>)<br/>
  33622. <p/>
  33623. Converts a hexadecimal number to decimal.
  33624. <p/>
  33625. Number is the hexadecimal number you want to Convert. Number cannot contain more than 10 characters (40 bits).
  33626. The most significant bit of number is the sign bit.
  33627. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
  33628. Remark
  33629. If number is not a valid hexadecimal number, HEX2DEC returns the #NUM! error value.
  33630. @author cedric dot walter @ gmail dot com
  33631. </member>
  33632. <member name="T:NPOI.SS.Formula.Functions.Hyperlink">
  33633. Implementation of Excel HYPERLINK function.<p/>
  33634. In Excel this function has special behaviour - it causes the displayed cell value to behave like
  33635. a hyperlink in the GUI. From an evaluation perspective however, it is very simple.<p/>
  33636. <b>Syntax</b>:<br/>
  33637. <b>HYPERLINK</b>(<b>link_location</b>, friendly_name)<p/>
  33638. <b>link_location</b> The URL of the hyperlink <br/>
  33639. <b>friendly_name</b> (optional) the value to display<p/>
  33640. Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}).
  33641. @author Wayne Clingingsmith
  33642. </member>
  33643. <member name="T:NPOI.SS.Formula.Functions.IDStarAlgorithm">
  33644. Interface specifying how an algorithm to be used by {@link DStarRunner} should look like.
  33645. Each implementing class should correspond to one of the D* functions.
  33646. </member>
  33647. <member name="M:NPOI.SS.Formula.Functions.IDStarAlgorithm.ProcessMatch(NPOI.SS.Formula.Eval.ValueEval)">
  33648. Process a match that is found during a run through a database.
  33649. @param eval ValueEval of the cell in the matching row. References will already be Resolved.
  33650. @return Whether we should continue iterating through the database.
  33651. </member>
  33652. <member name="P:NPOI.SS.Formula.Functions.IDStarAlgorithm.Result">
  33653. Return a result ValueEval that will be the result of the calculation.
  33654. This is always called at the end of a run through the database.
  33655. @return a ValueEval
  33656. </member>
  33657. <member name="T:NPOI.SS.Formula.Functions.Imaginary">
  33658. Implementation for Excel IMAGINARY() function.<p/>
  33659. <p/>
  33660. <b>Syntax</b>:<br/> <b>IMAGINARY </b>(<b>Inumber</b>)<br/>
  33661. <p/>
  33662. Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.
  33663. <p/>
  33664. Inumber is a complex number for which you want the imaginary coefficient.
  33665. <p/>
  33666. Remarks
  33667. <ul>
  33668. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  33669. </ul>
  33670. @author cedric dot walter @ gmail dot com
  33671. </member>
  33672. <member name="T:NPOI.SS.Formula.Functions.ImReal">
  33673. Implementation for Excel ImReal() function.<p/>
  33674. <p/>
  33675. <b>Syntax</b>:<br/> <b>ImReal </b>(<b>Inumber</b>)<br/>
  33676. <p/>
  33677. Returns the real coefficient of a complex number in x + yi or x + yj text format.
  33678. <p/>
  33679. Inumber A complex number for which you want the real coefficient.
  33680. <p/>
  33681. Remarks
  33682. <ul>
  33683. <li>If inumber is not in the form x + yi or x + yj, this function returns the #NUM! error value.</li>
  33684. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  33685. </ul>
  33686. @author cedric dot walter @ gmail dot com
  33687. </member>
  33688. <member name="T:NPOI.SS.Formula.Functions.Intercept">
  33689. Implementation of Excel function INTERCEPT()<p/>
  33690. Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values<br/>
  33691. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  33692. <b>Syntax</b>:<br/>
  33693. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  33694. @author Johan Karlsteen
  33695. </member>
  33696. <member name="T:NPOI.SS.Formula.Functions.LinearRegressionFunction">
  33697. Base class for linear regression functions.
  33698. Calculates the linear regression line that is used to predict y values from x values<br/>
  33699. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  33700. <b>Syntax</b>:<br/>
  33701. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  33702. or
  33703. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  33704. @author Johan Karlsteen
  33705. </member>
  33706. <member name="T:NPOI.SS.Formula.Functions.Mirr">
  33707. Calculates Modified internal rate of return. Syntax is MIRR(cash_flow_values, finance_rate, reinvest_rate)
  33708. <p>Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost
  33709. of the investment and the interest received on reinvestment of cash.</p>
  33710. Values is an array or a reference to cells that contain numbers. These numbers represent a series of payments (negative values) and income (positive values) occurring at regular periods.
  33711. <ul>
  33712. <li>Values must contain at least one positive value and one negative value to calculate the modified internal rate of return. Otherwise, MIRR returns the #DIV/0! error value.</li>
  33713. <li>If an array or reference argument Contains text, logical values, or empty cells, those values are ignored; however, cells with the value zero are included.</li>
  33714. </ul>
  33715. Finance_rate is the interest rate you pay on the money used in the cash flows.
  33716. Reinvest_rate is the interest rate you receive on the cash flows as you reinvest them.
  33717. @author Carlos Delgado (carlos dot del dot est at gmail dot com)
  33718. @author Cédric Walter (cedric dot walter at gmail dot com)
  33719. @see <a href="http://en.wikipedia.org/wiki/MIRR">Wikipedia on MIRR</a>
  33720. @see <a href="http://office.microsoft.com/en-001/excel-help/mirr-HP005209180.aspx">Excel MIRR</a>
  33721. @see {@link Irr}
  33722. </member>
  33723. <member name="T:NPOI.SS.Formula.Functions.Oct2Dec">
  33724. <p>Implementation for Excel Oct2Dec() function.</p>
  33725. <p>
  33726. Converts an octal number to decimal.
  33727. </p>
  33728. <p>
  33729. <b>Syntax</b>:<br/> <b>Oct2Dec </b>(<b>number</b> )
  33730. </p>
  33731. <p/>
  33732. Number is the octal number you want to Convert. Number may not contain more than 10 octal characters (30 bits).
  33733. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits.
  33734. Negative numbers are represented using two's-complement notation..
  33735. <p/>
  33736. If number is not a valid octal number, OCT2DEC returns the #NUM! error value.
  33737. @author cedric dot walter @ gmail dot com
  33738. </member>
  33739. <member name="T:NPOI.SS.Formula.Functions.PPMT">
  33740. Compute the interest portion of a payment.
  33741. @author Mike Argyriou micharg@gmail.com
  33742. </member>
  33743. <member name="T:NPOI.SS.Formula.Functions.Quotient">
  33744. <p>Implementation for Excel QUOTIENT () function.</p>
  33745. <p>
  33746. <b>Syntax</b>:<br/> <b>QUOTIENT</b>(<b>Numerator</b>,<b>Denominator</b>)<br/>
  33747. </p>
  33748. <p>
  33749. Numerator is the dividend.
  33750. Denominator is the divisor.
  33751. Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.
  33752. </p>
  33753. If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value.
  33754. If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value.
  33755. @author cedric dot walter @ gmail dot com
  33756. </member>
  33757. <member name="T:NPOI.SS.Formula.Functions.Rank">
  33758. * 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.
  33759. * Syntax:
  33760. * RANK(number,ref,order)
  33761. * Number is the number whose rank you want to find.
  33762. * Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored.
  33763. * Order is a number specifying how to rank number.
  33764. * If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order.
  33765. * If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.
  33766. *
  33767. * @author Rubin Wang
  33768. </member>
  33769. <member name="T:NPOI.SS.Formula.Functions.Rate">
  33770. Implements the Excel Rate function
  33771. </member>
  33772. <member name="M:NPOI.SS.Formula.Functions.Rate.CheckValue(System.Double)">
  33773. Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases
  33774. @throws EvaluationException (#NUM!) if result is NaN or Infinity
  33775. </member>
  33776. <member name="T:NPOI.SS.Formula.Functions.Rept">
  33777. Implementation for Excel REPT () function.<p/>
  33778. <p/>
  33779. <b>Syntax</b>:<br/> <b>REPT </b>(<b>text</b>,<b>number_times</b> )<br/>
  33780. <p/>
  33781. Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.
  33782. text : text The text that you want to repeat.
  33783. number_times: A positive number specifying the number of times to repeat text.
  33784. If number_times is 0 (zero), REPT returns "" (empty text).
  33785. If this argument contains a decimal value, this function ignores the numbers to the right side of the decimal point.
  33786. The result of the REPT function cannot be longer than 32,767 characters, or REPT returns #VALUE!.
  33787. @author cedric dot walter @ gmail dot com
  33788. </member>
  33789. <member name="T:NPOI.SS.Formula.Functions.Roman">
  33790. Implementation for Excel WeekNum() function.<p/>
  33791. <p/>
  33792. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  33793. <p/>
  33794. Returns a number that indicates where the week falls numerically within a year.
  33795. <p/>
  33796. <p/>
  33797. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  33798. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  33799. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  33800. Return_type is a number that determines on which day the week begins. The default is 1.
  33801. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  33802. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  33803. @author cedric dot walter @ gmail dot com
  33804. </member>
  33805. <member name="M:NPOI.SS.Formula.Functions.Roman.integerToRoman(System.Int32)">
  33806. Classic conversion.
  33807. @param number
  33808. @return
  33809. </member>
  33810. <member name="M:NPOI.SS.Formula.Functions.Roman.MakeConcise(System.String,System.Int32)">
  33811. Use conversion rule to factor some parts and make them more concise
  33812. @param result
  33813. @param form
  33814. @return
  33815. </member>
  33816. <member name="T:NPOI.SS.Formula.Functions.Slope">
  33817. Implementation of Excel function SLOPE()<p/>
  33818. Calculates the SLOPE of the linear regression line that is used to predict y values from x values<br/>
  33819. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  33820. <b>Syntax</b>:<br/>
  33821. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  33822. @author Johan Karlsteen
  33823. </member>
  33824. <member name="T:NPOI.SS.Formula.Functions.AverageIf">
  33825. Implementation for the Excel function SUMIF<p>
  33826. Syntax : <br/>
  33827. AVERAGEIF ( <b>range</b>, <b>criteria</b>, avg_range ) <br/>
  33828. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  33829. <tr><th>range</th><td>The range over which criteria is applied. Also used for included values when the third parameter is not present</td></tr>
  33830. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  33831. <tr><th>avg_range</th><td>Locates the top-left corner of the corresponding range of addends - values to be included (after being selected by the criteria)</td></tr>
  33832. </table><br/>
  33833. </p>
  33834. @author Josh Micich
  33835. </member>
  33836. <member name="T:NPOI.SS.Formula.Functions.Sumifs">
  33837. Implementation for the Excel function SUMIFS<br/>
  33838. <p>
  33839. Syntax : <br/>
  33840. SUMIFS ( <b>sum_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  33841. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  33842. <ul>
  33843. <li><b>sum_range</b> Required. One or more cells to sum, including numbers or names, ranges,
  33844. or cell references that contain numbers. Blank and text values are ignored.</li>
  33845. <li><b>criteria1_range</b> Required. The first range in which
  33846. to evaluate the associated criteria.</li>
  33847. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  33848. cell reference, or text that define which cells in the criteria_range1
  33849. argument will be added</li>
  33850. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  33851. Up to 127 range/criteria pairs are allowed.</li>
  33852. </ul>
  33853. </p>
  33854. @author Yegor Kozlov
  33855. </member>
  33856. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteria(NPOI.SS.Formula.Functions.IMatchPredicate[])">
  33857. Verify that each <code>criteria</code> predicate is valid, i.e. not an error
  33858. @throws EvaluationException if there are criteria which resulted in Errors.
  33859. </member>
  33860. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  33861. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  33862. as the <code>sumRange</code> argument
  33863. @throws EvaluationException if
  33864. </member>
  33865. <member name="M:NPOI.SS.Formula.Functions.Sumifs.SumMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  33866. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeSum</code>
  33867. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  33868. @param aeSum the range to sum
  33869. @return the computed value
  33870. </member>
  33871. <member name="T:NPOI.SS.Formula.Functions.Proper">
  33872. <summary>
  33873. Implementation of the PROPER function:
  33874. Normalizes all words (separated by non-word characters) by
  33875. making the first letter upper and the rest lower case.
  33876. </summary>
  33877. </member>
  33878. <member name="T:NPOI.SS.Formula.Functions.WeekdayFunc">
  33879. Implementation for the Excel function WEEKDAY
  33880. @author Thies Wellpott
  33881. </member>
  33882. <member name="M:NPOI.SS.Formula.Functions.WeekdayFunc.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  33883. * Perform WEEKDAY(date, returnOption) function.
  33884. * Note: Parameter texts are from German EXCEL-2010 help.
  33885. * Parameters in args[]:
  33886. * args[0] serialDate
  33887. * EXCEL-date value
  33888. * Standardmaessig ist der 1. Januar 1900 die fortlaufende Zahl 1 und
  33889. * der 1. Januar 2008 die fortlaufende Zahl 39.448, da dieser Tag nach 39.448 Tagen
  33890. * auf den 01.01.1900 folgt.
  33891. * @return Option (optional)
  33892. * Bestimmt den Rueckgabewert:
  33893. 1 oder nicht angegeben Zahl 1 (Sonntag) bis 7 (Samstag). Verhaelt sich wie fruehere Microsoft Excel-Versionen.
  33894. 2 Zahl 1 (Montag) bis 7 (Sonntag).
  33895. 3 Zahl 0 (Montag) bis 6 (Sonntag).
  33896. 11 Die Zahlen 1 (Montag) bis 7 (Sonntag)
  33897. 12 Die Zahlen 1 (Dienstag) bis 7 (Montag)
  33898. 13 Die Zahlen 1 (Mittwoch) bis 7 (Dienstag)
  33899. 14 Die Zahlen 1 (Donnerstag) bis 7 (Mittwoch)
  33900. 15 Die Zahlen 1 (Freitag) bis 7 (Donnerstag)
  33901. 16 Die Zahlen 1 (Samstag) bis 7 (Freitag)
  33902. 17 Die Zahlen 1 (Sonntag) bis 7 (Samstag)
  33903. </member>
  33904. <member name="T:NPOI.SS.Formula.Functions.WeekNum">
  33905. Implementation for Excel WeekNum() function.<p/>
  33906. <p/>
  33907. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  33908. <p/>
  33909. Returns a number that indicates where the week falls numerically within a year.
  33910. <p/>
  33911. <p/>
  33912. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  33913. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  33914. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  33915. Return_type is a number that determines on which day the week begins. The default is 1.
  33916. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  33917. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  33918. @author cedric dot walter @ gmail dot com
  33919. </member>
  33920. <member name="T:NPOI.SS.Formula.Functions.EDate">
  33921. Implementation of Excel 'Analysis ToolPak' function EDATE()<br/>
  33922. Adds a specified number of months to the specified date.<p/>
  33923. <b>Syntax</b><br/>
  33924. <b>EDATE</b>(<b>date</b>, <b>number</b>)
  33925. <p/>
  33926. @author Tomas Herceg
  33927. </member>
  33928. <member name="T:NPOI.SS.Formula.Functions.Iserr">
  33929. contribute by Pavel Egorov
  33930. https://github.com/xoposhiy/npoi/commit/27b34a2389030c7115a666ace65daafda40d61af
  33931. Implementation of Excel <tt>ISERR()</tt> function.<p/>
  33932. <b>Syntax</b>:<br/>
  33933. <b>ISERR</b>(<b>value</b>)<p/>
  33934. <b>value</b> The value to be tested<p/>
  33935. Returns the logical value <tt>TRUE</tt> if value refers to any error value except
  33936. <tt>'#N/A'</tt>; otherwise, it returns <tt>FALSE</tt>.
  33937. </member>
  33938. <member name="T:NPOI.SS.Formula.Functions.Address">
  33939. Creates a text reference as text, given specified row and column numbers.
  33940. @author Aniket Banerjee (banerjee@google.com)
  33941. </member>
  33942. <member name="P:NPOI.SS.Formula.Functions.SubtotalInstance.IsSubtotalCounted">
  33943. ignore nested subtotals.
  33944. </member>
  33945. <member name="T:NPOI.SS.Formula.Functions.Percentile">
  33946. Returns the k-th percentile of values in a range. You can use this function to establish a threshold of
  33947. acceptance. For example, you can decide to examine candidates who score above the 90th percentile.
  33948. PERCENTILE(array,k)
  33949. Array is the array or range of data that defines relative standing.
  33950. K is the percentile value in the range 0..1, inclusive.
  33951. <strong>Remarks</strong>
  33952. <ul>
  33953. <li>if array is empty or Contains more than 8,191 data points, PERCENTILE returns the #NUM! error value.</li>
  33954. <li>If k is nonnumeric, PERCENTILE returns the #VALUE! error value.</li>
  33955. <li>If k is &lt; 0 or if k &gt; 1, PERCENTILE returns the #NUM! error value.</li>
  33956. <li>If k is not a multiple of 1/(n - 1), PERCENTILE interpolates to determine the value at the k-th percentile.</li>
  33957. </ul>
  33958. </member>
  33959. <member name="T:NPOI.SS.Formula.Functions.AggregateFunction">
  33960. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33961. </member>
  33962. <member name="T:NPOI.SS.Formula.Functions.BooleanFunction">
  33963. Here are the general rules concerning Boolean functions:
  33964. <ol>
  33965. <li> Blanks are ignored (not either true or false) </li>
  33966. <li> Strings are ignored if part of an area ref or cell ref, otherwise they must be 'true' or 'false'</li>
  33967. <li> Numbers: 0 is false. Any other number is TRUE </li>
  33968. <li> Areas: *all* cells in area are evaluated according to the above rules</li>
  33969. </ol>
  33970. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33971. </member>
  33972. <member name="T:NPOI.SS.Formula.Functions.False">
  33973. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33974. </member>
  33975. <member name="T:NPOI.SS.Formula.Functions.True">
  33976. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33977. </member>
  33978. <member name="T:NPOI.SS.Formula.Functions.CalendarFieldFunction">
  33979. Implementation of Excel functions Date parsing functions:
  33980. Date - DAY, MONTH and YEAR
  33981. Time - HOUR, MINUTE and SECOND
  33982. @author Others (not mentioned in code)
  33983. @author Thies Wellpott
  33984. </member>
  33985. <member name="T:NPOI.SS.Formula.Functions.Ceiling">
  33986. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33987. </member>
  33988. <member name="T:NPOI.SS.Formula.Functions.Choose">
  33989. @author Josh Micich
  33990. </member>
  33991. <member name="T:NPOI.SS.Formula.Functions.Columns">
  33992. Implementation for Excel COLUMNS function.
  33993. @author Josh Micich
  33994. </member>
  33995. <member name="T:NPOI.SS.Formula.Functions.Combin">
  33996. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33997. </member>
  33998. <member name="T:NPOI.SS.Formula.Functions.Count">
  33999. Counts the number of cells that contain numeric data within
  34000. the list of arguments.
  34001. Excel Syntax
  34002. COUNT(value1,value2,...)
  34003. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  34004. TODO: Check this properly Matches excel on edge cases
  34005. like formula cells, error cells etc
  34006. </member>
  34007. <member name="M:NPOI.SS.Formula.Functions.Count.SubtotalInstance">
  34008. Create an instance of Count to use in {@link Subtotal}
  34009. <p>
  34010. If there are other subtotals within argument refs (or nested subtotals),
  34011. these nested subtotals are ignored to avoid double counting.
  34012. </p>
  34013. @see Subtotal
  34014. </member>
  34015. <member name="T:NPOI.SS.Formula.Functions.Counta">
  34016. Counts the number of cells that contain data within the list of arguments.
  34017. Excel Syntax
  34018. COUNTA(value1,value2,...)
  34019. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  34020. @author Josh Micich
  34021. </member>
  34022. <member name="M:NPOI.SS.Formula.Functions.Counta.SubtotalPredicate.Matches(NPOI.SS.Formula.TwoDEval,System.Int32,System.Int32)">
  34023. don't count cells that are subtotals
  34024. </member>
  34025. <member name="T:NPOI.SS.Formula.Functions.Countblank">
  34026. Implementation for the function COUNTBLANK
  34027. <p>
  34028. Syntax: COUNTBLANK ( range )
  34029. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34030. <tr><th>range </th><td>is the range of cells to count blanks</td></tr>
  34031. </table>
  34032. </p>
  34033. @author Mads Mohr Christensen
  34034. </member>
  34035. <member name="T:NPOI.SS.Formula.Functions.Countif">
  34036. Implementation for the function COUNTIF<p/>
  34037. Syntax: COUNTIF ( range, criteria )
  34038. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  34039. <tr><th>range </th><td>is the range of cells to be Counted based on the criteria</td></tr>
  34040. <tr><th>criteria</th><td>is used to determine which cells to Count</td></tr>
  34041. </table>
  34042. <p/>
  34043. @author Josh Micich
  34044. </member>
  34045. <member name="P:NPOI.SS.Formula.Functions.Countif.CmpOp.Length">
  34046. @return number of characters used to represent this operator
  34047. </member>
  34048. <member name="M:NPOI.SS.Formula.Functions.Countif.StringMatcher.GetWildCardPattern(System.String)">
  34049. <summary>
  34050. Translates Excel countif wildcard strings into .NET regex strings
  34051. </summary>
  34052. <param name="value">Excel wildcard expression</param>
  34053. <returns>return null if the specified value contains no special wildcard characters.</returns>
  34054. </member>
  34055. <member name="M:NPOI.SS.Formula.Functions.Countif.CountMatchingCellsInArea(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  34056. @return the number of evaluated cells in the range that match the specified criteria
  34057. </member>
  34058. <member name="M:NPOI.SS.Formula.Functions.Countif.EvaluateCriteriaArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34059. @return the de-referenced criteria arg (possibly {@link ErrorEval})
  34060. </member>
  34061. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateGeneralMatchPredicate(NPOI.SS.Formula.Eval.StringEval)">
  34062. When the second argument is a string, many things are possible
  34063. </member>
  34064. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateCriteriaPredicate(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34065. Creates a criteria predicate object for the supplied criteria arg
  34066. @return <code>null</code> if the arg evaluates to blank.
  34067. </member>
  34068. <member name="M:NPOI.SS.Formula.Functions.Countif.ParseBoolean(System.String)">
  34069. bool literals ('TRUE', 'FALSE') treated similarly but NOT same as numbers.
  34070. </member>
  34071. <member name="T:NPOI.SS.Formula.Functions.IMatchPredicate">
  34072. Common interface for the matching criteria.
  34073. </member>
  34074. <member name="T:NPOI.SS.Formula.Functions.CountUtils">
  34075. Common logic for COUNT, COUNTA and COUNTIF
  34076. @author Josh Micich
  34077. </member>
  34078. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInRef(NPOI.SS.Formula.Eval.RefEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  34079. @return the number of evaluated cells in the range that match the specified criteria
  34080. </member>
  34081. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInArea(NPOI.SS.Formula.ThreeDEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  34082. @return the number of evaluated cells in the range that match the specified criteria
  34083. </member>
  34084. <member name="T:NPOI.SS.Formula.Functions.DateFunc">
  34085. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  34086. </member>
  34087. <member name="M:NPOI.SS.Formula.Functions.DateFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  34088. * Note - works with Java Calendar months, not Excel months
  34089. * Java Calendar month = Excel month + 1
  34090. </member>
  34091. <member name="T:NPOI.SS.Formula.Functions.Days360">
  34092. <p>Calculates the number of days between two dates based on a 360-day year
  34093. (twelve 30-day months), which is used in some accounting calculations. Use
  34094. this function to help compute payments if your accounting system is based on
  34095. twelve 30-day months.</p>
  34096. {@code DAYS360(start_date,end_date,[method])}
  34097. <ul>
  34098. <li>Start_date, end_date (required):<br/>
  34099. The two dates between which you want to know the number of days.<br/>
  34100. If start_date occurs after end_date, the DAYS360 function returns a negative number.</li>
  34101. <li>Method (optional):<br/>
  34102. A logical value that specifies whether to use the U.S. or European method in the calculation</li>
  34103. <li>Method set to false or omitted:<br/>
  34104. the DAYS360 function uses the U.S. (NASD) method. If the starting date is the 31st of a month,
  34105. it becomes equal to the 30th of the same month. If the ending date is the 31st of a month and
  34106. the starting date is earlier than the 30th of a month, the ending date becomes equal to the
  34107. 1st of the next month, otherwise the ending date becomes equal to the 30th of the same month.
  34108. The month February and leap years are handled in the following way:<br/>
  34109. On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", FALSE)} returns 1 day
  34110. because the DAYS360 function ignores the extra days added to February.<br/>
  34111. On a leap year the function {@code =DAYS360("2/29/96","3/1/96", FALSE)} returns 1 day for
  34112. the same reason.</li>
  34113. <li>Method Set to true:<br/>
  34114. When you set the method parameter to TRUE, the DAYS360 function uses the European method.
  34115. Starting dates or ending dates that occur on the 31st of a month become equal to the 30th of
  34116. the same month. The month February and leap years are handled in the following way:<br/>
  34117. On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", TRUE)} returns
  34118. 3 days because the DAYS360 function is counting the extra days added to February to give
  34119. February 30 days.<br/>
  34120. On a leap year the function {@code =DAYS360("2/29/96", "3/1/96", TRUE)} returns
  34121. 2 days for the same reason.</li>
  34122. </ul>
  34123. @see <a href="https://support.microsoft.com/en-us/kb/235575">DAYS360 Function Produces Different Values Depending on the Version of Excel</a>
  34124. </member>
  34125. <member name="T:NPOI.SS.Formula.Functions.Degrees">
  34126. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34127. </member>
  34128. <member name="T:NPOI.SS.Formula.Functions.Dollar">
  34129. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34130. </member>
  34131. <member name="T:NPOI.SS.Formula.Functions.Even">
  34132. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34133. </member>
  34134. <member name="T:NPOI.SS.Formula.Functions.Exp">
  34135. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34136. </member>
  34137. <member name="T:NPOI.SS.Formula.Functions.Fact">
  34138. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34139. </member>
  34140. <member name="T:NPOI.SS.Formula.Functions.FinanceFunction">
  34141. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34142. Super class for all Evals for financial function evaluation.
  34143. </member>
  34144. <member name="T:NPOI.SS.Formula.Functions.FinanceLib">
  34145. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34146. This class Is a functon library for common fiscal functions.
  34147. <b>Glossary of terms/abbreviations:</b>
  34148. <br/>
  34149. <ul>
  34150. <li><em>FV:</em> Future Value</li>
  34151. <li><em>PV:</em> Present Value</li>
  34152. <li><em>NPV:</em> Net Present Value</li>
  34153. <li><em>PMT:</em> (Periodic) Payment</li>
  34154. </ul>
  34155. For more info on the terms/abbreviations please use the references below
  34156. (hyperlinks are subject to Change):
  34157. <br/>Online References:
  34158. <ol>
  34159. <li>GNU Emacs Calc 2.02 Manual: http://theory.uwinnipeg.ca/gnu/calc/calc_203.html</li>
  34160. <li>Yahoo Financial Glossary: http://biz.yahoo.com/f/g/nn.html#y</li>
  34161. <li>MS Excel function reference: http://office.microsoft.com/en-us/assistance/CH062528251033.aspx</li>
  34162. </ol>
  34163. <h3>Implementation Notes:</h3>
  34164. Symbols used in the formulae that follow:<br/>
  34165. <ul>
  34166. <li>p: present value</li>
  34167. <li>f: future value</li>
  34168. <li>n: number of periods</li>
  34169. <li>y: payment (in each period)</li>
  34170. <li>r: rate</li>
  34171. <li>^: the power operator (NOT the java bitwise XOR operator!)</li>
  34172. </ul>
  34173. [From MS Excel function reference] Following are some of the key formulas
  34174. that are used in this implementation:
  34175. <pre>
  34176. p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
  34177. ny + p + f=0 ...{when r=0}
  34178. </pre>
  34179. </member>
  34180. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.fv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  34181. Future value of an amount given the number of payments, rate, amount
  34182. of individual payment, present value and bool value indicating whether
  34183. payments are due at the beginning of period
  34184. (false => payments are due at end of period)
  34185. @param r rate
  34186. @param n num of periods
  34187. @param y pmt per period
  34188. @param p future value
  34189. @param t type (true=pmt at end of period, false=pmt at begining of period)
  34190. </member>
  34191. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  34192. Present value of an amount given the number of future payments, rate, amount
  34193. of individual payment, future value and bool value indicating whether
  34194. payments are due at the beginning of period
  34195. (false => payments are due at end of period)
  34196. @param r
  34197. @param n
  34198. @param y
  34199. @param f
  34200. @param t
  34201. </member>
  34202. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.npv(System.Double,System.Double[])">
  34203. calculates the Net Present Value of a principal amount
  34204. given the disCount rate and a sequence of cash flows
  34205. (supplied as an array). If the amounts are income the value should
  34206. be positive, else if they are payments and not income, the
  34207. value should be negative.
  34208. @param r
  34209. @param cfs cashflow amounts
  34210. </member>
  34211. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pmt(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  34212. @param r
  34213. @param n
  34214. @param p
  34215. @param f
  34216. @param t
  34217. </member>
  34218. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.nper(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  34219. @param r
  34220. @param y
  34221. @param p
  34222. @param f
  34223. @param t
  34224. </member>
  34225. <member name="T:NPOI.SS.Formula.Functions.Fixed0ArgFunction">
  34226. Convenience base class for functions that only take zero arguments.
  34227. @author Josh Micich
  34228. </member>
  34229. <member name="T:NPOI.SS.Formula.Functions.Fixed1ArgFunction">
  34230. Convenience base class for functions that must take exactly one argument.
  34231. @author Josh Micich
  34232. </member>
  34233. <member name="T:NPOI.SS.Formula.Functions.Fixed2ArgFunction">
  34234. Convenience base class for functions that must take exactly two arguments.
  34235. @author Josh Micich
  34236. </member>
  34237. <member name="T:NPOI.SS.Formula.Functions.Fixed3ArgFunction">
  34238. Convenience base class for functions that must take exactly three arguments.
  34239. @author Josh Micich
  34240. </member>
  34241. <member name="T:NPOI.SS.Formula.Functions.Fixed4ArgFunction">
  34242. Convenience base class for functions that must take exactly four arguments.
  34243. @author Josh Micich
  34244. </member>
  34245. <member name="T:NPOI.SS.Formula.Functions.Floor">
  34246. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34247. </member>
  34248. <member name="T:NPOI.SS.Formula.Functions.FreeRefFunction">
  34249. For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are
  34250. passed in as arguments, and the exact location remains fixed. However, a select few Excel
  34251. functions have the ability to access cells that were not part of any reference passed as an
  34252. argument.<br/>
  34253. Two important functions with this feature are <b>INDIRECT</b> and <b>OFFSet</b><p/>
  34254. In POI, the <c>HSSFFormulaEvaluator</c> Evaluates every cell in each reference argument before
  34255. calling the function. This means that functions using fixed references do not need access to
  34256. the rest of the workbook to execute. Hence the <c>Evaluate()</c> method on the common
  34257. interface <c>Function</c> does not take a workbook parameter.
  34258. This interface recognises the requirement of some functions to freely Create and Evaluate
  34259. references beyond those passed in as arguments.
  34260. @author Josh Micich
  34261. </member>
  34262. <member name="M:NPOI.SS.Formula.Functions.FreeRefFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  34263. @param args the pre-Evaluated arguments for this function. args is never <code>null</code>,
  34264. nor are any of its elements.
  34265. @param ec primarily used to identify the source cell Containing the formula being Evaluated.
  34266. may also be used to dynamically create reference evals.
  34267. @return never <code>null</code>. Possibly an instance of <c>ErrorEval</c> in the case of
  34268. a specified Excel error (Exceptions are never thrown to represent Excel errors).
  34269. </member>
  34270. <member name="T:NPOI.SS.Formula.Functions.Function">
  34271. <summary>
  34272. Function serves as a marker interface.
  34273. </summary>
  34274. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34275. </member>
  34276. <member name="M:NPOI.SS.Formula.Functions.Function.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  34277. <summary>
  34278. Evaluates the specified args.
  34279. </summary>
  34280. <param name="args">the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval</param>
  34281. <param name="srcRowIndex">row index of the cell containing the formula under evaluation</param>
  34282. <param name="srcColumnIndex">column index of the cell containing the formula under evaluation</param>
  34283. <returns></returns>
  34284. </member>
  34285. <member name="T:NPOI.SS.Formula.Functions.Function0Arg">
  34286. Implemented by all functions that can be called with zero arguments
  34287. @author Josh Micich
  34288. </member>
  34289. <member name="M:NPOI.SS.Formula.Functions.Function0Arg.Evaluate(System.Int32,System.Int32)">
  34290. see {@link Function#Evaluate(ValueEval[], int, int)}
  34291. </member>
  34292. <member name="T:NPOI.SS.Formula.Functions.Function1Arg">
  34293. Implemented by all functions that can be called with one argument
  34294. @author Josh Micich
  34295. </member>
  34296. <member name="M:NPOI.SS.Formula.Functions.Function1Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  34297. see {@link Function#Evaluate(ValueEval[], int, int)}
  34298. </member>
  34299. <member name="T:NPOI.SS.Formula.Functions.Function2Arg">
  34300. Implemented by all functions that can be called with two arguments
  34301. @author Josh Micich
  34302. </member>
  34303. <member name="M:NPOI.SS.Formula.Functions.Function2Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  34304. see {@link Function#Evaluate(ValueEval[], int, int)}
  34305. </member>
  34306. <member name="T:NPOI.SS.Formula.Functions.Function3Arg">
  34307. Implemented by all functions that can be called with three arguments
  34308. @author Josh Micich
  34309. </member>
  34310. <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)">
  34311. see {@link Function#Evaluate(ValueEval[], int, int)}
  34312. </member>
  34313. <member name="T:NPOI.SS.Formula.Functions.Function4Arg">
  34314. Implemented by all functions that can be called with four arguments
  34315. @author Josh Micich
  34316. </member>
  34317. <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)">
  34318. see {@link Function#Evaluate(ValueEval[], int, int)}
  34319. </member>
  34320. <member name="T:NPOI.SS.Formula.Functions.Hlookup">
  34321. Implementation of the HLOOKUP() function.<p/>
  34322. HLOOKUP Finds a column in a lookup table by the first row value and returns the value from another row.<br/>
  34323. <b>Syntax</b>:<br/>
  34324. <b>HLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>row_index_num</b>, range_lookup)<p/>
  34325. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  34326. <b>table_array</b> An area reference for the lookup data. <br/>
  34327. <b>row_index_num</b> a 1 based index specifying which row value of the lookup data will be returned.<br/>
  34328. <b>range_lookup</b> If TRUE (default), HLOOKUP Finds the largest value less than or equal to
  34329. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  34330. @author Josh Micich
  34331. </member>
  34332. <member name="M:NPOI.SS.Formula.Functions.Hlookup.CreateResultColumnVector(NPOI.SS.Formula.Eval.AreaEval,System.Int32)">
  34333. Returns one column from an <c>AreaEval</c>
  34334. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  34335. </member>
  34336. <member name="T:NPOI.SS.Formula.Functions.IfFunc">
  34337. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34338. </member>
  34339. <member name="T:NPOI.SS.Formula.Functions.Index">
  34340. Implementation for the Excel function INDEX
  34341. Syntax : <br/>
  34342. INDEX ( reference, row_num[, column_num [, area_num]])<br/>
  34343. INDEX ( array, row_num[, column_num])
  34344. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  34345. <tr><th>reference</th><td>typically an area reference, possibly a union of areas</td></tr>
  34346. <tr><th>array</th><td>a literal array value (currently not supported)</td></tr>
  34347. <tr><th>row_num</th><td>selects the row within the array or area reference</td></tr>
  34348. <tr><th>column_num</th><td>selects column within the array or area reference. default Is 1</td></tr>
  34349. <tr><th>area_num</th><td>used when reference Is a union of areas</td></tr>
  34350. </table>
  34351. @author Josh Micich
  34352. </member>
  34353. <member name="M:NPOI.SS.Formula.Functions.Index.GetValueFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
  34354. @param colArgWasPassed <c>false</c> if the INDEX argument lIst had just 2 items
  34355. (exactly 1 comma). If anything Is passed for the <c>column_num</c> argument
  34356. (including {@link BlankEval} or {@link MIssingArgEval}) this parameter will be
  34357. <c>true</c>. ThIs parameter is needed because error codes are slightly
  34358. different when only 2 args are passed.
  34359. </member>
  34360. <member name="M:NPOI.SS.Formula.Functions.Index.ResolveIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34361. @param arg a 1-based index.
  34362. @return the Resolved 1-based index. Zero if the arg was missing or blank
  34363. @throws EvaluationException if the arg Is an error value evaluates to a negative numeric value
  34364. </member>
  34365. <member name="T:NPOI.SS.Formula.Functions.Indirect">
  34366. Implementation for Excel function INDIRECT<p/>
  34367. INDIRECT() returns the cell or area reference denoted by the text argument.<p/>
  34368. <b>Syntax</b>:<br/>
  34369. <b>INDIRECT</b>(<b>ref_text</b>,isA1Style)<p/>
  34370. <b>ref_text</b> a string representation of the desired reference as it would normally be written
  34371. in a cell formula.<br/>
  34372. <b>isA1Style</b> (default TRUE) specifies whether the ref_text should be interpreted as A1-style
  34373. or R1C1-style.
  34374. @author Josh Micich
  34375. </member>
  34376. <member name="M:NPOI.SS.Formula.Functions.Indirect.ParseWorkbookAndSheetName(System.String)">
  34377. @return array of length 2: {workbookName, sheetName,}. Second element will always be
  34378. present. First element may be null if sheetName is unqualified.
  34379. Returns <code>null</code> if text cannot be parsed.
  34380. </member>
  34381. <member name="M:NPOI.SS.Formula.Functions.Indirect.UnescapeString(System.String)">
  34382. @return <code>null</code> if there is a syntax error in any escape sequence
  34383. (the typical syntax error is a single quote character not followed by another).
  34384. </member>
  34385. <member name="T:NPOI.SS.Formula.Functions.Int">
  34386. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34387. </member>
  34388. <member name="T:NPOI.SS.Formula.Functions.Irr">
  34389. Calculates the internal rate of return.
  34390. Syntax is IRR(values) or IRR(values,guess)
  34391. @author Marcel May
  34392. @author Yegor Kozlov
  34393. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">Wikipedia on IRR</a>
  34394. @see <a href="http://office.microsoft.com/en-us/excel-help/irr-HP005209146.aspx">Excel IRR</a>
  34395. </member>
  34396. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[])">
  34397. Computes the internal rate of return using an estimated irr of 10 percent.
  34398. @param income the income values.
  34399. @return the irr.
  34400. </member>
  34401. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[],System.Double)">
  34402. Calculates IRR using the Newton-Raphson Method.
  34403. <p>
  34404. Starting with the guess, the method cycles through the calculation until the result
  34405. is accurate within 0.00001 percent. If IRR can't find a result that works
  34406. after 20 tries, the Double.NaN is returned.
  34407. </p>
  34408. <p>
  34409. The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
  34410. @see <a href="http://commons.apache.org">http://commons.apache.org</a>
  34411. </p>
  34412. @param values the income values.
  34413. @param guess the initial guess of irr.
  34414. @return the irr value. The method returns <code>Double.NaN</code>
  34415. if the maximum iteration count is exceeded
  34416. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
  34417. http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
  34418. @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
  34419. http://en.wikipedia.org/wiki/Newton%27s_method</a>
  34420. </member>
  34421. <member name="T:NPOI.SS.Formula.Functions.Isblank">
  34422. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34423. </member>
  34424. <member name="T:NPOI.SS.Formula.Functions.Iserror">
  34425. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34426. </member>
  34427. <member name="T:NPOI.SS.Formula.Functions.Islogical">
  34428. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34429. </member>
  34430. <member name="T:NPOI.SS.Formula.Functions.Isna">
  34431. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34432. </member>
  34433. <member name="T:NPOI.SS.Formula.Functions.Isnontext">
  34434. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34435. </member>
  34436. <member name="T:NPOI.SS.Formula.Functions.Isnumber">
  34437. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34438. </member>
  34439. <member name="T:NPOI.SS.Formula.Functions.Isref">
  34440. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34441. </member>
  34442. <member name="T:NPOI.SS.Formula.Functions.Istext">
  34443. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34444. </member>
  34445. <member name="T:NPOI.SS.Formula.Functions.LogicalFunction">
  34446. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34447. </member>
  34448. <member name="M:NPOI.SS.Formula.Functions.LogicalFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval)">
  34449. @param arg any {@link ValueEval}, potentially {@link BlankEval} or {@link ErrorEval}.
  34450. </member>
  34451. <member name="T:NPOI.SS.Formula.Functions.Lookup">
  34452. Implementation of Excel function LOOKUP.<p/>
  34453. LOOKUP Finds an index row in a lookup table by the first column value and returns the value from another column.
  34454. <b>Syntax</b>:<br/>
  34455. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>lookup_vector</b>, result_vector)<p/>
  34456. <b>lookup_value</b> The value to be found in the lookup vector.<br/>
  34457. <b>lookup_vector</b> An area reference for the lookup data. <br/>
  34458. <b>result_vector</b> Single row or single column area reference from which the result value Is chosen.<br/>
  34459. @author Josh Micich
  34460. </member>
  34461. <member name="T:NPOI.SS.Formula.Functions.LookupUtils">
  34462. Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
  34463. @author Josh Micich
  34464. </member>
  34465. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.CreateVector(NPOI.SS.Formula.TwoDEval)">
  34466. @return <c>null</c> if the supplied area is neither a single row nor a single colum
  34467. </member>
  34468. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRowOrColIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34469. Processes the third argument to VLOOKUP, or HLOOKUP (<b>col_index_num</b>
  34470. or <b>row_index_num</b> respectively).<br/>
  34471. Sample behaviour:
  34472. <table border="0" cellpAdding="1" cellspacing="2" summary="Sample behaviour">
  34473. <tr><th>Input Return</th><th>Value </th><th>Thrown Error</th></tr>
  34474. <tr><td>5</td><td>4</td><td> </td></tr>
  34475. <tr><td>2.9</td><td>2</td><td> </td></tr>
  34476. <tr><td>"5"</td><td>4</td><td> </td></tr>
  34477. <tr><td>"2.18e1"</td><td>21</td><td> </td></tr>
  34478. <tr><td>"-$2"</td><td>-3</td><td>*</td></tr>
  34479. <tr><td>FALSE</td><td>-1</td><td>*</td></tr>
  34480. <tr><td>TRUE</td><td>0</td><td> </td></tr>
  34481. <tr><td>"TRUE"</td><td> </td><td>#REF!</td></tr>
  34482. <tr><td>"abc"</td><td> </td><td>#REF!</td></tr>
  34483. <tr><td>""</td><td> </td><td>#REF!</td></tr>
  34484. <tr><td>&lt;blank&gt;</td><td> </td><td>#VALUE!</td></tr>
  34485. </table><br/>
  34486. * Note - out of range errors (both too high and too low) are handled by the caller.
  34487. @return column or row index as a zero-based value
  34488. </member>
  34489. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveTableArrayArg(NPOI.SS.Formula.Eval.ValueEval)">
  34490. The second argument (table_array) should be an area ref, but can actually be a cell ref, in
  34491. which case it Is interpreted as a 1x1 area ref. Other scalar values cause #VALUE! error.
  34492. </member>
  34493. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRangeLookupArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34494. Resolves the last (optional) parameter (<b>range_lookup</b>) to the VLOOKUP and HLOOKUP functions.
  34495. @param rangeLookupArg
  34496. @param srcCellRow
  34497. @param srcCellCol
  34498. @return
  34499. @throws EvaluationException
  34500. </member>
  34501. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.LookupIndexOfExactValue(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector)">
  34502. Finds first (lowest index) exact occurrence of specified value.
  34503. @param lookupComparer the value to be found in column or row vector
  34504. @param vector the values to be searched. For VLOOKUP this Is the first column of the
  34505. tableArray. For HLOOKUP this Is the first row of the tableArray.
  34506. @return zero based index into the vector, -1 if value cannot be found
  34507. </member>
  34508. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.PerformBinarySearch(NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupValueComparer)">
  34509. Excel has funny behaviour when the some elements in the search vector are the wrong type.
  34510. </member>
  34511. <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)">
  34512. Excel seems to handle mismatched types initially by just stepping 'mid' ix forward to the
  34513. first compatible value.
  34514. @param midIx 'mid' index (value which has the wrong type)
  34515. @return usually -1, signifying that the BinarySearchIndex has been narrowed to the new mid
  34516. index. Zero or greater signifies that an exact match for the lookup value was found
  34517. </member>
  34518. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.FindLastIndexInRunOfEqualValues(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,System.Int32,System.Int32)">
  34519. Once the binary search has found a single match, (V/H)LOOKUP steps one by one over subsequent
  34520. values to choose the last matching item.
  34521. </member>
  34522. <member name="T:NPOI.SS.Formula.Functions.CompareResult">
  34523. Enumeration to support <b>4</b> valued comparison results.<p/>
  34524. Excel lookup functions have complex behaviour in the case where the lookup array has mixed
  34525. types, and/or Is Unordered. Contrary to suggestions in some Excel documentation, there
  34526. does not appear to be a Universal ordering across types. The binary search algorithm used
  34527. Changes behaviour when the Evaluated 'mid' value has a different type to the lookup value.<p/>
  34528. A simple int might have done the same job, but there Is risk in confusion with the well
  34529. known <c>Comparable.CompareTo()</c> and <c>Comparator.Compare()</c> which both use
  34530. a ubiquitous 3 value result encoding.
  34531. </member>
  34532. <member name="T:NPOI.SS.Formula.Functions.BinarySearchIndexes">
  34533. Encapsulates some standard binary search functionality so the Unusual Excel behaviour can
  34534. be clearly distinguished.
  34535. </member>
  34536. <member name="M:NPOI.SS.Formula.Functions.BinarySearchIndexes.GetMidIx">
  34537. @return -1 if the search range Is empty
  34538. </member>
  34539. <member name="T:NPOI.SS.Formula.Functions.ValueVector">
  34540. Represents a single row or column within an <c>AreaEval</c>.
  34541. </member>
  34542. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparer.CompareTo(NPOI.SS.Formula.Eval.ValueEval)">
  34543. @return one of 4 instances or <c>CompareResult</c>: <c>LESS_THAN</c>, <c>EQUAL</c>,
  34544. <c>GREATER_THAN</c> or <c>TYPE_MISMATCH</c>
  34545. </member>
  34546. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparerBase.GetValueAsString">
  34547. used only for debug purposes
  34548. </member>
  34549. <member name="T:NPOI.SS.Formula.Functions.Match">
  34550. Implementation for the MATCH() Excel function.<p/>
  34551. <b>Syntax:</b><br/>
  34552. <b>MATCH</b>(<b>lookup_value</b>, <b>lookup_array</b>, match_type)<p/>
  34553. Returns a 1-based index specifying at what position in the <b>lookup_array</b> the specified
  34554. <b>lookup_value</b> Is found.<p/>
  34555. Specific matching behaviour can be modified with the optional <b>match_type</b> parameter.
  34556. <table border="0" cellpAdding="1" cellspacing="0" summary="match_type parameter description">
  34557. <tr><th>Value</th><th>Matching Behaviour</th></tr>
  34558. <tr><td>1</td><td>(default) Find the largest value that Is less than or equal to lookup_value.
  34559. The lookup_array must be in ascending <i>order</i>*.</td></tr>
  34560. <tr><td>0</td><td>Find the first value that Is exactly equal to lookup_value.
  34561. The lookup_array can be in any order.</td></tr>
  34562. <tr><td>-1</td><td>Find the smallest value that Is greater than or equal to lookup_value.
  34563. The lookup_array must be in descending <i>order</i>*.</td></tr>
  34564. </table>
  34565. * Note regarding <i>order</i> - For the <b>match_type</b> cases that require the lookup_array to
  34566. be ordered, MATCH() can produce incorrect results if this requirement Is not met. Observed
  34567. behaviour in Excel Is to return the lowest index value for which every item after that index
  34568. breaks the match rule.<br/>
  34569. The (ascending) sort order expected by MATCH() Is:<br/>
  34570. numbers (low to high), strings (A to Z), bool (FALSE to TRUE)<br/>
  34571. MATCH() ignores all elements in the lookup_array with a different type to the lookup_value.
  34572. Type conversion of the lookup_array elements Is never performed.
  34573. @author Josh Micich
  34574. </member>
  34575. <member name="M:NPOI.SS.Formula.Functions.Match.FindIndexOfValue(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.ValueVector,System.Boolean,System.Boolean)">
  34576. @return zero based index
  34577. </member>
  34578. <member name="T:NPOI.SS.Formula.Functions.MathX">
  34579. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34580. This class Is an extension to the standard math library
  34581. provided by java.lang.Math class. It follows the Math class
  34582. in that it has a private constructor and all static methods.
  34583. </member>
  34584. <member name="M:NPOI.SS.Formula.Functions.MathX.Round(System.Double,System.Int32)">
  34585. Returns a value rounded to p digits after decimal.
  34586. If p Is negative, then the number Is rounded to
  34587. places to the left of the decimal point. eg.
  34588. 10.23 rounded to -1 will give: 10. If p Is zero,
  34589. the returned value Is rounded to the nearest integral
  34590. value.
  34591. If n Is negative, the resulting value Is obtained
  34592. as the round value of absolute value of n multiplied
  34593. by the sign value of n (@see MathX.sign(double d)).
  34594. Thus, -0.6666666 rounded to p=0 will give -1 not 0.
  34595. If n Is NaN, returned value Is NaN.
  34596. @param n
  34597. @param p
  34598. </member>
  34599. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundUp(System.Double,System.Int32)">
  34600. Returns a value rounded-up to p digits after decimal.
  34601. If p Is negative, then the number Is rounded to
  34602. places to the left of the decimal point. eg.
  34603. 10.23 rounded to -1 will give: 20. If p Is zero,
  34604. the returned value Is rounded to the nearest integral
  34605. value.
  34606. If n Is negative, the resulting value Is obtained
  34607. as the round-up value of absolute value of n multiplied
  34608. by the sign value of n (@see MathX.sign(double d)).
  34609. Thus, -0.2 rounded-up to p=0 will give -1 not 0.
  34610. If n Is NaN, returned value Is NaN.
  34611. @param n
  34612. @param p
  34613. </member>
  34614. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundDown(System.Double,System.Int32)">
  34615. Returns a value rounded to p digits after decimal.
  34616. If p Is negative, then the number Is rounded to
  34617. places to the left of the decimal point. eg.
  34618. 10.23 rounded to -1 will give: 10. If p Is zero,
  34619. the returned value Is rounded to the nearest integral
  34620. value.
  34621. If n Is negative, the resulting value Is obtained
  34622. as the round-up value of absolute value of n multiplied
  34623. by the sign value of n (@see MathX.sign(double d)).
  34624. Thus, -0.8 rounded-down to p=0 will give 0 not -1.
  34625. If n Is NaN, returned value Is NaN.
  34626. @param n
  34627. @param p
  34628. </member>
  34629. <member name="M:NPOI.SS.Formula.Functions.MathX.Average(System.Double[])">
  34630. average of all values
  34631. @param values
  34632. </member>
  34633. <member name="M:NPOI.SS.Formula.Functions.MathX.Sum(System.Double[])">
  34634. sum of all values
  34635. @param values
  34636. </member>
  34637. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumsq(System.Double[])">
  34638. sum of squares of all values
  34639. @param values
  34640. </member>
  34641. <member name="M:NPOI.SS.Formula.Functions.MathX.Product(System.Double[])">
  34642. product of all values
  34643. @param values
  34644. </member>
  34645. <member name="M:NPOI.SS.Formula.Functions.MathX.Min(System.Double[])">
  34646. min of all values. If supplied array Is zero Length,
  34647. double.POSITIVE_INFINITY Is returned.
  34648. @param values
  34649. </member>
  34650. <member name="M:NPOI.SS.Formula.Functions.MathX.Max(System.Double[])">
  34651. min of all values. If supplied array Is zero Length,
  34652. double.NEGATIVE_INFINITY Is returned.
  34653. @param values
  34654. </member>
  34655. <member name="M:NPOI.SS.Formula.Functions.MathX.Floor(System.Double,System.Double)">
  34656. Note: this function Is different from java.lang.Math.floor(..).
  34657. When n and s are "valid" arguments, the returned value Is: Math.floor(n/s) * s;
  34658. <br/>
  34659. n and s are invalid if any of following conditions are true:
  34660. <ul>
  34661. <li>s Is zero</li>
  34662. <li>n Is negative and s Is positive</li>
  34663. <li>n Is positive and s Is negative</li>
  34664. </ul>
  34665. In all such cases, double.NaN Is returned.
  34666. @param n
  34667. @param s
  34668. </member>
  34669. <member name="M:NPOI.SS.Formula.Functions.MathX.Ceiling(System.Double,System.Double)">
  34670. Note: this function Is different from java.lang.Math.ceil(..).
  34671. When n and s are "valid" arguments, the returned value Is: Math.ceiling(n/s) * s;
  34672. <br/>
  34673. n and s are invalid if any of following conditions are true:
  34674. <ul>
  34675. <li>s Is zero</li>
  34676. <li>n Is negative and s Is positive</li>
  34677. <li>n Is positive and s Is negative</li>
  34678. </ul>
  34679. In all such cases, double.NaN Is returned.
  34680. @param n
  34681. @param s
  34682. </member>
  34683. <member name="M:NPOI.SS.Formula.Functions.MathX.Factorial(System.Int32)">
  34684. <br/> for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
  34685. <br/> else if n == 0; factorial n = 1
  34686. <br/> else if n &lt; 0; factorial n = double.NaN
  34687. <br/> Loss of precision can occur if n Is large enough.
  34688. If n Is large so that the resulting value would be greater
  34689. than double.MAX_VALUE; double.POSITIVE_INFINITY Is returned.
  34690. If n &lt; 0, double.NaN Is returned.
  34691. @param n
  34692. </member>
  34693. <member name="M:NPOI.SS.Formula.Functions.MathX.Mod(System.Double,System.Double)">
  34694. returns the remainder resulting from operation:
  34695. n / d.
  34696. <br/> The result has the sign of the divisor.
  34697. <br/> Examples:
  34698. <ul>
  34699. <li>mod(3.4, 2) = 1.4</li>
  34700. <li>mod(-3.4, 2) = 0.6</li>
  34701. <li>mod(-3.4, -2) = -1.4</li>
  34702. <li>mod(3.4, -2) = -0.6</li>
  34703. </ul>
  34704. If d == 0, result Is NaN
  34705. @param n
  34706. @param d
  34707. </member>
  34708. <member name="M:NPOI.SS.Formula.Functions.MathX.Acosh(System.Double)">
  34709. inverse hyperbolic cosine
  34710. @param d
  34711. </member>
  34712. <member name="M:NPOI.SS.Formula.Functions.MathX.Asinh(System.Double)">
  34713. inverse hyperbolic sine
  34714. @param d
  34715. </member>
  34716. <member name="M:NPOI.SS.Formula.Functions.MathX.Atanh(System.Double)">
  34717. inverse hyperbolic tangent
  34718. @param d
  34719. </member>
  34720. <member name="M:NPOI.SS.Formula.Functions.MathX.Cosh(System.Double)">
  34721. hyperbolic cosine
  34722. @param d
  34723. </member>
  34724. <member name="M:NPOI.SS.Formula.Functions.MathX.Sinh(System.Double)">
  34725. hyperbolic sine
  34726. @param d
  34727. </member>
  34728. <member name="M:NPOI.SS.Formula.Functions.MathX.Tanh(System.Double)">
  34729. hyperbolic tangent
  34730. @param d
  34731. </member>
  34732. <member name="M:NPOI.SS.Formula.Functions.MathX.SumProduct(System.Double[][])">
  34733. returns the sum of product of corresponding double value in each
  34734. subarray. It Is the responsibility of the caller to Ensure that
  34735. all the subarrays are of equal Length. If the subarrays are
  34736. not of equal Length, the return value can be Unpredictable.
  34737. @param arrays
  34738. </member>
  34739. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2my2(System.Double[],System.Double[])">
  34740. returns the sum of difference of squares of corresponding double
  34741. value in each subarray: ie. sigma (xarr[i]^2-yarr[i]^2)
  34742. <br/>
  34743. It Is the responsibility of the caller
  34744. to Ensure that the two subarrays are of equal Length. If the
  34745. subarrays are not of equal Length, the return value can be
  34746. Unpredictable.
  34747. @param xarr
  34748. @param yarr
  34749. </member>
  34750. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2py2(System.Double[],System.Double[])">
  34751. returns the sum of sum of squares of corresponding double
  34752. value in each subarray: ie. sigma (xarr[i]^2 + yarr[i]^2)
  34753. <br/>
  34754. It Is the responsibility of the caller
  34755. to Ensure that the two subarrays are of equal Length. If the
  34756. subarrays are not of equal Length, the return value can be
  34757. Unpredictable.
  34758. @param xarr
  34759. @param yarr
  34760. </member>
  34761. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumxmy2(System.Double[],System.Double[])">
  34762. returns the sum of squares of difference of corresponding double
  34763. value in each subarray: ie. sigma ( (xarr[i]-yarr[i])^2 )
  34764. <br/>
  34765. It Is the responsibility of the caller
  34766. to Ensure that the two subarrays are of equal Length. If the
  34767. subarrays are not of equal Length, the return value can be
  34768. Unpredictable.
  34769. @param xarr
  34770. @param yarr
  34771. </member>
  34772. <member name="M:NPOI.SS.Formula.Functions.MathX.NChooseK(System.Int32,System.Int32)">
  34773. returns the total number of combinations possible when
  34774. k items are chosen out of total of n items. If the number
  34775. Is too large, loss of precision may occur (since returned
  34776. value Is double). If the returned value Is larger than
  34777. double.MAX_VALUE, double.POSITIVE_INFINITY Is returned.
  34778. If either of the parameters Is negative, double.NaN Is returned.
  34779. @param n
  34780. @param k
  34781. </member>
  34782. <member name="T:NPOI.SS.Formula.Functions.MinaMaxa">
  34783. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34784. </member>
  34785. <member name="T:NPOI.SS.Formula.Functions.Mod">
  34786. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34787. </member>
  34788. <member name="T:NPOI.SS.Formula.Functions.Mode">
  34789. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34790. </member>
  34791. <member name="M:NPOI.SS.Formula.Functions.Mode.Evaluate(System.Double[])">
  34792. if v is zero length or contains no duplicates, return value is
  34793. Double.NaN. Else returns the value that occurs most times and if there is
  34794. a tie, returns the first such value.
  34795. @param v
  34796. </member>
  34797. <member name="T:NPOI.SS.Formula.Functions.MultiOperandNumericFunction">
  34798. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34799. This Is the base class for all excel function evaluator
  34800. classes that take variable number of operands, and
  34801. where the order of operands does not matter
  34802. </member>
  34803. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.MaxNumOperands">
  34804. Maximum number of operands accepted by this function.
  34805. Subclasses may override to Change default value.
  34806. </member>
  34807. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.IsSubtotalCounted">
  34808. Whether to count nested subtotals.
  34809. </member>
  34810. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.CollectValues(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.MultiOperandNumericFunction.DoubleList)">
  34811. Collects values from a single argument
  34812. </member>
  34813. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.GetNumberArray(NPOI.SS.Formula.Eval.ValueEval[])">
  34814. Returns a double array that contains values for the numeric cells
  34815. from among the list of operands. Blanks and Blank equivalent cells
  34816. are ignored. Error operands or cells containing operands of type
  34817. that are considered invalid and would result in #VALUE! error in
  34818. excel cause this function to return <c>null</c>.
  34819. @return never <c>null</c>
  34820. </member>
  34821. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.AreSubArraysConsistent(System.Double[][])">
  34822. Ensures that a two dimensional array has all sub-arrays present and the same Length
  34823. @return <c>false</c> if any sub-array Is missing, or Is of different Length
  34824. </member>
  34825. <member name="T:NPOI.SS.Formula.Functions.Na">
  34826. Implementation of Excel function NA()
  34827. @author Josh Micich
  34828. </member>
  34829. <member name="T:NPOI.SS.Formula.Functions.NotImplementedFunction">
  34830. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34831. This Is the default implementation of a Function class.
  34832. The default behaviour Is to return a non-standard ErrorEval
  34833. "ErrorEval.FUNCTION_NOT_IMPLEMENTED". This error should alert
  34834. the user that the formula contained a function that Is not
  34835. yet implemented.
  34836. </member>
  34837. <member name="T:NPOI.SS.Formula.Functions.Now">
  34838. Implementation of Excel NOW() Function
  34839. @author Frank Taffelt
  34840. </member>
  34841. <member name="T:NPOI.SS.Formula.Functions.Abs">
  34842. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34843. </member>
  34844. <member name="T:NPOI.SS.Formula.Functions.Acos">
  34845. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34846. </member>
  34847. <member name="T:NPOI.SS.Formula.Functions.Acosh">
  34848. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34849. Support for hyperbolic trig functions was Added as a part of
  34850. Java distribution only in JDK1.5. This class uses custom
  34851. naive implementation based on formulas at:
  34852. http://www.math2.org/math/trig/hyperbolics.htm
  34853. These formulas seem to agree with excel's implementation.
  34854. </member>
  34855. <member name="T:NPOI.SS.Formula.Functions.Asin">
  34856. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34857. </member>
  34858. <member name="T:NPOI.SS.Formula.Functions.Asinh">
  34859. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34860. Support for hyperbolic trig functions was Added as a part of
  34861. Java distribution only in JDK1.5. This class uses custom
  34862. naive implementation based on formulas at:
  34863. http://www.math2.org/math/trig/hyperbolics.htm
  34864. These formulas seem to agree with excel's implementation.
  34865. </member>
  34866. <member name="T:NPOI.SS.Formula.Functions.Atan">
  34867. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34868. </member>
  34869. <member name="T:NPOI.SS.Formula.Functions.Atan2">
  34870. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34871. </member>
  34872. <member name="T:NPOI.SS.Formula.Functions.Atanh">
  34873. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34874. Support for hyperbolic trig functions was Added as a part of
  34875. Java distribution only in JDK1.5. This class uses custom
  34876. naive implementation based on formulas at:
  34877. http://www.math2.org/math/trig/hyperbolics.htm
  34878. These formulas seem to agree with excel's implementation.
  34879. </member>
  34880. <member name="T:NPOI.SS.Formula.Functions.Cos">
  34881. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34882. </member>
  34883. <member name="T:NPOI.SS.Formula.Functions.Cosh">
  34884. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34885. </member>
  34886. <member name="T:NPOI.SS.Formula.Functions.Ln">
  34887. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34888. </member>
  34889. <member name="T:NPOI.SS.Formula.Functions.Log">
  34890. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34891. Log: LOG(number,[base])
  34892. </member>
  34893. <member name="T:NPOI.SS.Formula.Functions.Log10">
  34894. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34895. </member>
  34896. <member name="T:NPOI.SS.Formula.Functions.NumericFunction">
  34897. @author Amol S. Deshmukh &lt; amolweb at yahoo dot com &gt;
  34898. </member>
  34899. <member name="T:NPOI.SS.Formula.Functions.Pi">
  34900. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34901. </member>
  34902. <member name="M:NPOI.SS.Formula.Functions.Poisson.IsDefaultResult(System.Double,System.Double)">
  34903. This checks is x = 0 and the mean = 0.
  34904. Excel currently returns the value 1 where as the
  34905. maths common implementation will error.
  34906. @param x The number.
  34907. @param mean The mean.
  34908. @return If a default value should be returned.
  34909. </member>
  34910. <member name="F:NPOI.SS.Formula.Functions.Poisson.FACTORIALS">
  34911. All long-representable factorials
  34912. </member>
  34913. <member name="T:NPOI.SS.Formula.Functions.Rand">
  34914. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34915. </member>
  34916. <member name="T:NPOI.SS.Formula.Functions.Sin">
  34917. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34918. </member>
  34919. <member name="T:NPOI.SS.Formula.Functions.Sinh">
  34920. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34921. </member>
  34922. <member name="T:NPOI.SS.Formula.Functions.Sqrt">
  34923. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34924. </member>
  34925. <member name="T:NPOI.SS.Formula.Functions.Tan">
  34926. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34927. </member>
  34928. <member name="T:NPOI.SS.Formula.Functions.Tanh">
  34929. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34930. </member>
  34931. <member name="T:NPOI.SS.Formula.Functions.Odd">
  34932. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34933. </member>
  34934. <member name="T:NPOI.SS.Formula.Functions.Offset">
  34935. Implementation for Excel function OFFSet()<p/>
  34936. OFFSet returns an area reference that Is a specified number of rows and columns from a
  34937. reference cell or area.<p/>
  34938. <b>Syntax</b>:<br/>
  34939. <b>OFFSet</b>(<b>reference</b>, <b>rows</b>, <b>cols</b>, height, width)<p/>
  34940. <b>reference</b> Is the base reference.<br/>
  34941. <b>rows</b> Is the number of rows up or down from the base reference.<br/>
  34942. <b>cols</b> Is the number of columns left or right from the base reference.<br/>
  34943. <b>height</b> (default same height as base reference) Is the row Count for the returned area reference.<br/>
  34944. <b>width</b> (default same width as base reference) Is the column Count for the returned area reference.<br/>
  34945. @author Josh Micich
  34946. </member>
  34947. <member name="T:NPOI.SS.Formula.Functions.Offset.EvalEx">
  34948. Exceptions are used within this class to help simplify flow control when error conditions
  34949. are enCountered
  34950. </member>
  34951. <member name="T:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange">
  34952. A one dimensional base + offset. Represents either a row range or a column range.
  34953. Two instances of this class toGether specify an area range.
  34954. </member>
  34955. <member name="M:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange.NormaliseAndTranslate(System.Int32)">
  34956. Moves the range by the specified translation amount.<p/>
  34957. This method also 'normalises' the range: Excel specifies that the width and height
  34958. parameters (Length field here) cannot be negative. However, OFFSet() does produce
  34959. sensible results in these cases. That behavior Is replicated here. <p/>
  34960. @param translationAmount may be zero negative or positive
  34961. @return the equivalent <c>LinearOffsetRange</c> with a positive Length, moved by the
  34962. specified translationAmount.
  34963. </member>
  34964. <member name="T:NPOI.SS.Formula.Functions.Offset.BaseRef">
  34965. Encapsulates either an area or cell reference which may be 2d or 3d.
  34966. </member>
  34967. <member name="M:NPOI.SS.Formula.Functions.Offset.EvaluateIntArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34968. OFFSet's numeric arguments (2..5) have similar Processing rules
  34969. </member>
  34970. <member name="M:NPOI.SS.Formula.Functions.Offset.ConvertDoubleToInt(System.Double)">
  34971. Fractional values are silently truncated by Excel.
  34972. Truncation Is toward negative infinity.
  34973. </member>
  34974. <member name="T:NPOI.SS.Formula.Functions.Pmt">
  34975. Implementation for the PMT() Excel function.<p/>
  34976. <b>Syntax:</b><br/>
  34977. <b>PMT</b>(<b>rate</b>, <b>nper</b>, <b>pv</b>, fv, type)<p/>
  34978. Returns the constant repayment amount required for a loan assuming a constant interest rate.<p/>
  34979. <b>rate</b> the loan interest rate.<br/>
  34980. <b>nper</b> the number of loan repayments.<br/>
  34981. <b>pv</b> the present value of the future payments (or principle).<br/>
  34982. <b>fv</b> the future value (default zero) surplus cash at the end of the loan lifetime.<br/>
  34983. <b>type</b> whether payments are due at the beginning(1) or end(0 - default) of each payment period.<br/>
  34984. </member>
  34985. <member name="T:NPOI.SS.Formula.Functions.Power">
  34986. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34987. </member>
  34988. <member name="T:NPOI.SS.Formula.Functions.Radians">
  34989. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34990. </member>
  34991. <member name="T:NPOI.SS.Formula.Functions.Rows">
  34992. Implementation for Excel ROWS function.
  34993. @author Josh Micich
  34994. </member>
  34995. <member name="T:NPOI.SS.Formula.Functions.StatsLib">
  34996. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34997. Library for common statistics functions
  34998. </member>
  34999. <member name="M:NPOI.SS.Formula.Functions.StatsLib.avedev(System.Double[])">
  35000. returns the mean of deviations from mean.
  35001. @param v
  35002. </member>
  35003. <member name="M:NPOI.SS.Formula.Functions.StatsLib.mode(System.Double[])">
  35004. if v Is zero Length or Contains no duplicates, return value
  35005. Is double.NaN. Else returns the value that occurs most times
  35006. and if there Is a tie, returns the first such value.
  35007. @param v
  35008. </member>
  35009. <member name="T:NPOI.SS.Formula.Functions.Subtotal">
  35010. Implementation for the Excel function SUBTOTAL<p>
  35011. <b>Syntax :</b> <br/>
  35012. SUBTOTAL ( <b>functionCode</b>, <b>ref1</b>, ref2 ... ) <br/>
  35013. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  35014. <tr><td><b>functionCode</b></td><td>(1-11) Selects the underlying aggregate function to be used (see table below)</td></tr>
  35015. <tr><td><b>ref1</b>, ref2 ...</td><td>Arguments to be passed to the underlying aggregate function</td></tr>
  35016. </table><br/>
  35017. </p>
  35018. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  35019. <tr><th>functionCode</th><th>Aggregate Function</th></tr>
  35020. <tr align='center'><td>1</td><td>AVERAGE</td></tr>
  35021. <tr align='center'><td>2</td><td>COUNT</td></tr>
  35022. <tr align='center'><td>3</td><td>COUNTA</td></tr>
  35023. <tr align='center'><td>4</td><td>MAX</td></tr>
  35024. <tr align='center'><td>5</td><td>MIN</td></tr>
  35025. <tr align='center'><td>6</td><td>PRODUCT</td></tr>
  35026. <tr align='center'><td>7</td><td>STDEV</td></tr>
  35027. <tr align='center'><td>8</td><td>STDEVP *</td></tr>
  35028. <tr align='center'><td>9</td><td>SUM</td></tr>
  35029. <tr align='center'><td>10</td><td>VAR *</td></tr>
  35030. <tr align='center'><td>11</td><td>VARP *</td></tr>
  35031. <tr align='center'><td>101-111</td><td>*</td></tr>
  35032. </table><br/>
  35033. * Not implemented in POI yet. Functions 101-111 are the same as functions 1-11 but with
  35034. the option 'ignore hidden values'.
  35035. <p/>
  35036. @author Paul Tomlin &lt; pault at bulk sms dot com &gt;
  35037. </member>
  35038. <member name="T:NPOI.SS.Formula.Functions.Sumif">
  35039. Implementation for the Excel function SUMIF<p>
  35040. Syntax : <br/>
  35041. SUMIF ( <b>range</b>, <b>criteria</b>, sum_range ) <br/>
  35042. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  35043. <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>
  35044. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  35045. <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>
  35046. </table><br/>
  35047. </p>
  35048. @author Josh Micich
  35049. </member>
  35050. <member name="M:NPOI.SS.Formula.Functions.Sumif.CreateSumRange(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  35051. @return a range of the same dimensions as aeRange using eval to define the top left corner.
  35052. @throws EvaluationException if eval is not a reference
  35053. </member>
  35054. <member name="M:NPOI.SS.Formula.Functions.Sumproduct.GetProductTerm(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  35055. Determines a <c>double</c> value for the specified <c>ValueEval</c>.
  35056. @param IsScalarProduct <c>false</c> for SUMPRODUCTs over area refs.
  35057. @throws EvalEx if <c>ve</c> represents an error value.
  35058. <p/>
  35059. Note - string values and empty cells are interpreted differently depending on
  35060. <c>isScalarProduct</c>. For scalar products, if any term Is blank or a string, the
  35061. error (#VALUE!) Is raised. For area (sum)products, if any term Is blank or a string, the
  35062. result Is zero.
  35063. </member>
  35064. <member name="T:NPOI.SS.Formula.Functions.Concatenate">
  35065. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35066. </member>
  35067. <member name="T:NPOI.SS.Formula.Functions.Exact">
  35068. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35069. </member>
  35070. <member name="T:NPOI.SS.Formula.Functions.LeftRight">
  35071. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35072. </member>
  35073. <member name="T:NPOI.SS.Formula.Functions.Len">
  35074. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35075. </member>
  35076. <member name="T:NPOI.SS.Formula.Functions.Lower">
  35077. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35078. </member>
  35079. <member name="T:NPOI.SS.Formula.Functions.Mid">
  35080. <summary>
  35081. An implementation of the MID function
  35082. MID returns a specific number of
  35083. Chars from a text string, starting at the specified position.
  35084. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org;
  35085. </summary>
  35086. </member>
  35087. <member name="T:NPOI.SS.Formula.Functions.Replace">
  35088. An implementation of the Replace function:
  35089. Replaces part of a text string based on the number of Chars
  35090. you specify, with another text string.
  35091. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35092. </member>
  35093. <member name="M:NPOI.SS.Formula.Functions.Replace.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  35094. Replaces part of a text string based on the number of Chars
  35095. you specify, with another text string.
  35096. @see org.apache.poi.hssf.record.formula.eval.Eval
  35097. </member>
  35098. <member name="T:NPOI.SS.Formula.Functions.Substitute">
  35099. An implementation of the SUBSTITUTE function:
  35100. Substitutes text in a text string with new text, some number of times.
  35101. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35102. </member>
  35103. <member name="M:NPOI.SS.Formula.Functions.Substitute.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  35104. Substitutes text in a text string with new text, some number of times.
  35105. @see org.apache.poi.hssf.record.formula.eval.Eval
  35106. </member>
  35107. <member name="T:NPOI.SS.Formula.Functions.Text">
  35108. An implementation of the TEXT function
  35109. TEXT returns a number value formatted with the given number formatting string.
  35110. This function is not a complete implementation of the Excel function, but
  35111. handles most of the common cases. All work is passed down to
  35112. {@link DataFormatter} to be done, as this works much the same as the
  35113. display focused work that that does.
  35114. </member>
  35115. <member name="T:NPOI.SS.Formula.Functions.TextFunction">
  35116. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35117. </member>
  35118. <member name="F:NPOI.SS.Formula.Functions.TextFunction.TRIM">
  35119. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35120. <summary>
  35121. An implementation of the TRIM function:
  35122. <para>
  35123. Removes leading and trailing spaces from value if evaluated operand value is string.
  35124. </para>
  35125. </summary>
  35126. </member>
  35127. <member name="F:NPOI.SS.Formula.Functions.TextFunction.MID">
  35128. <summary>
  35129. An implementation of the MID function
  35130. MID returns a specific number of
  35131. characters from a text string, starting at the specified position.
  35132. Syntax: MID(text, start_num, num_chars)
  35133. </summary>
  35134. </member>
  35135. <member name="F:NPOI.SS.Formula.Functions.TextFunction.FIND">
  35136. @author Torstein Tauno Svendsen (torstei@officenet.no)
  35137. <summary>
  35138. Implementation of the FIND() function.
  35139. <para>
  35140. Syntax: FIND(Find_text, within_text, start_num)
  35141. </para>
  35142. <para> FIND returns the character position of the first (case sensitive) occurrence of
  35143. Find_text inside within_text. The third parameter,
  35144. start_num, is optional (default=1) and specifies where to start searching
  35145. from. Character positions are 1-based.</para>
  35146. </summary>
  35147. </member>
  35148. <member name="F:NPOI.SS.Formula.Functions.TextFunction.SEARCH">
  35149. <summary>
  35150. Implementation of the FIND() function. SEARCH is a case-insensitive version of FIND()
  35151. <para>
  35152. Syntax: SEARCH(Find_text, within_text, start_num)
  35153. </para>
  35154. </summary>
  35155. </member>
  35156. <member name="T:NPOI.SS.Formula.Functions.Trim">
  35157. An implementation of the TRIM function:
  35158. Removes leading and trailing spaces from value if Evaluated operand
  35159. value Is string.
  35160. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35161. </member>
  35162. <member name="T:NPOI.SS.Formula.Functions.Upper">
  35163. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35164. </member>
  35165. <member name="T:NPOI.SS.Formula.Functions.TimeFunc">
  35166. Implementation for the Excel function TIME
  35167. @author Steven Butler (sebutler @ gmail dot com)
  35168. Based on POI {@link DateFunc}
  35169. </member>
  35170. <member name="M:NPOI.SS.Formula.Functions.TimeFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  35171. Converts the supplied hours, minutes and seconds to an Excel time value.
  35172. @param ds array of 3 doubles Containing hours, minutes and seconds.
  35173. Non-integer inputs are tRuncated to an integer before further calculation
  35174. of the time value.
  35175. @return An Excel representation of a time of day.
  35176. If the time value represents more than a day, the days are Removed from
  35177. the result, leaving only the time of day component.
  35178. @throws NPOI.SS.Formula.Eval.EvaluationException
  35179. If any of the arguments are greater than 32767 or the hours
  35180. minutes and seconds when combined form a time value less than 0, the function
  35181. Evaluates to an error.
  35182. </member>
  35183. <member name="F:NPOI.SS.Formula.Functions.Value.MIN_DISTANCE_BETWEEN_THOUSANDS_SEPARATOR">
  35184. "1,0000" is valid, "1,00" is not
  35185. </member>
  35186. <member name="M:NPOI.SS.Formula.Functions.Value.ConvertTextToNumber(System.String)">
  35187. TODO see if the same functionality is needed in {@link OperandResolver#parseDouble(String)}
  35188. @return <code>null</code> if there is any problem converting the text
  35189. </member>
  35190. <member name="T:NPOI.SS.Formula.Functions.Var1or2ArgFunction">
  35191. Convenience base class for any function which must take two or three
  35192. arguments
  35193. @author Josh Micich
  35194. </member>
  35195. <member name="T:NPOI.SS.Formula.Functions.Var2or3ArgFunction">
  35196. Convenience base class for any function which must take two or three
  35197. arguments
  35198. @author Josh Micich
  35199. </member>
  35200. <member name="T:NPOI.SS.Formula.Functions.Var3or4ArgFunction">
  35201. Convenience base class for any function which must take three or four
  35202. arguments
  35203. @author Josh Micich
  35204. </member>
  35205. <member name="T:NPOI.SS.Formula.Functions.Vlookup">
  35206. Implementation of the VLOOKUP() function.<p/>
  35207. VLOOKUP Finds a row in a lookup table by the first column value and returns the value from another column.<br/>
  35208. <b>Syntax</b>:<br/>
  35209. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>col_index_num</b>, range_lookup)<p/>
  35210. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  35211. <b>table_array</b> An area reference for the lookup data. <br/>
  35212. <b>col_index_num</b> a 1 based index specifying which column value of the lookup data will be returned.<br/>
  35213. <b>range_lookup</b> If TRUE (default), VLOOKUP Finds the largest value less than or equal to
  35214. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  35215. @author Josh Micich
  35216. </member>
  35217. <member name="M:NPOI.SS.Formula.Functions.Vlookup.CreateResultColumnVector(NPOI.SS.Formula.TwoDEval,System.Int32)">
  35218. Returns one column from an <c>AreaEval</c>
  35219. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  35220. </member>
  35221. <member name="T:NPOI.SS.Formula.Functions.XYNumericFunction">
  35222. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35223. </member>
  35224. <member name="M:NPOI.SS.Formula.Functions.XYNumericFunction.CreateAccumulator">
  35225. Constructs a new instance of the Accumulator used to calculated this function
  35226. </member>
  35227. <member name="T:NPOI.SS.Formula.PTG.Area3DPxg">
  35228. <p>Title: XSSF Area 3D Reference (Sheet + Area)</p>
  35229. <p>Description: Defined an area in an external or different sheet. </p>
  35230. <p>REFERENCE: </p>
  35231. <p>This is XSSF only, as it stores the sheet / book references
  35232. in String form. The HSSF equivalent using indexes is {@link Area3DPtg}</p>
  35233. </member>
  35234. <member name="T:NPOI.SS.Formula.PTG.Deleted3DPxg">
  35235. An XSSF only representation of a reference to a deleted area
  35236. </member>
  35237. <member name="T:NPOI.SS.Formula.PTG.NameXPxg">
  35238. A Name, be that a Named Range or a Function / User Defined
  35239. Function, Addressed in the HSSF External Sheet style.
  35240. <p>This is XSSF only, as it stores the sheet / book references
  35241. in String form. The HSSF equivalent using indexes is {@link NameXPtg}</p>
  35242. </member>
  35243. <member name="T:NPOI.SS.Formula.PTG.Pxg">
  35244. An XSSF only special kind of Ptg, which stores the sheet / book
  35245. reference in string form.
  35246. </member>
  35247. <member name="T:NPOI.SS.Formula.PTG.Pxg3D">
  35248. An XSSF only special kind of Ptg, which stores a range of
  35249. sheet / book references in string form.
  35250. </member>
  35251. <member name="T:NPOI.SS.Formula.PTG.Ref3DPxg">
  35252. <p>Title: XSSF 3D Reference</p>
  35253. <p>Description: Defines a cell in an external or different sheet.</p>
  35254. <p>REFERENCE: </p>
  35255. <p>This is XSSF only, as it stores the sheet / book references
  35256. in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}</p>
  35257. </member>
  35258. <member name="T:NPOI.SS.Formula.PTG.SharedFormula">
  35259. Encapsulates logic to convert shared formulaa into non shared equivalent
  35260. </member>
  35261. <member name="M:NPOI.SS.Formula.PTG.SharedFormula.ConvertSharedFormulas(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  35262. Creates a non shared formula from the shared formula counterpart, i.e.
  35263. Converts the shared formula into the equivalent {@link org.apache.poi.ss.formula.ptg.Ptg} array that it would have,
  35264. were it not shared.
  35265. @param ptgs parsed tokens of the shared formula
  35266. @param formulaRow
  35267. @param formulaColumn
  35268. </member>
  35269. <member name="T:NPOI.SS.Formula.PTG.AbstractFunctionPtg">
  35270. This class provides the base functionality for Excel sheet functions
  35271. There are two kinds of function Ptgs - tFunc and tFuncVar
  35272. Therefore, this class will have ONLY two subclasses
  35273. @author Avik Sengupta
  35274. @author Andrew C. Oliver (acoliver at apache dot org)
  35275. </member>
  35276. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_NAME_IF">
  35277. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  35278. </member>
  35279. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_INDEX_EXTERNAL">
  35280. All external functions have function index 255
  35281. </member>
  35282. <member name="P:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsExternalFunction">
  35283. external functions Get some special Processing
  35284. @return <c>true</c> if this is an external function
  35285. </member>
  35286. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsBuiltInFunctionName(System.String)">
  35287. Used to detect whether a function name found in a formula is one of the standard excel functions
  35288. The name matching is case insensitive.
  35289. @return <c>true</c> if the name specifies a standard worksheet function,
  35290. <c>false</c> if the name should be assumed to be an external function.
  35291. </member>
  35292. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.LookupIndex(System.String)">
  35293. Resolves internal function names into function indexes.
  35294. The name matching is case insensitive.
  35295. @return the standard worksheet function index if found, otherwise <c>FUNCTION_INDEX_EXTERNAL</c>
  35296. </member>
  35297. <member name="T:NPOI.SS.Formula.PTG.AddPtg">
  35298. Addition operator PTG the "+" binomial operator. If you need more
  35299. explanation than that then well...We really can't help you here.
  35300. @author Andrew C. Oliver (acoliver@apache.org)
  35301. @author Jason Height (jheight at chariot dot net dot au)
  35302. </member>
  35303. <member name="M:NPOI.SS.Formula.PTG.AddPtg.ToFormulaString(System.String[])">
  35304. implementation of method from OperationsPtg
  35305. </member>
  35306. <member name="T:NPOI.SS.Formula.PTG.Area2DPtgBase">
  35307. Common superclass of 2-D area refs
  35308. </member>
  35309. <member name="T:NPOI.SS.Formula.PTG.Area3DPtg">
  35310. <p>Title: Area 3D Ptg - 3D reference (Sheet + Area)</p>
  35311. <p>Description: Defined an area in Extern Sheet. </p>
  35312. <p>REFERENCE: </p>
  35313. This is HSSF only, as it matches the HSSF file format way of
  35314. referring to the sheet by an extern index. The XSSF equivalent
  35315. is {@link Area3DPxg}
  35316. </member>
  35317. <member name="M:NPOI.SS.Formula.PTG.Area3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  35318. @return text representation of this area reference that can be used in text
  35319. formulas. The sheet name will get properly delimited if required.
  35320. </member>
  35321. <member name="T:NPOI.SS.Formula.PTG.AreaErrPtg">
  35322. AreaErr - handles deleted cell area references.
  35323. @author Daniel Noll (daniel at nuix dot com dot au)
  35324. </member>
  35325. <member name="T:NPOI.SS.Formula.PTG.AreaI">
  35326. Common interface for AreaPtg and Area3DPtg, and their
  35327. child classes.
  35328. </member>
  35329. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstRow">
  35330. @return the first row in the area
  35331. </member>
  35332. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastRow">
  35333. @return last row in the range (x2 in x1,y1-x2,y2)
  35334. </member>
  35335. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstColumn">
  35336. @return the first column number in the area.
  35337. </member>
  35338. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastColumn">
  35339. @return lastcolumn in the area
  35340. </member>
  35341. <member name="T:NPOI.SS.Formula.PTG.AreaNPtg">
  35342. Specifies a rectangular area of cells A1:A4 for instance.
  35343. @author Jason Height (jheight at chariot dot net dot au)
  35344. </member>
  35345. <member name="T:NPOI.SS.Formula.PTG.AreaPtg">
  35346. Specifies a rectangular area of cells A1:A4 for instance.
  35347. @author Jason Height (jheight at chariot dot net dot au)
  35348. </member>
  35349. <member name="T:NPOI.SS.Formula.PTG.AreaPtgBase">
  35350. Specifies a rectangular area of cells A1:A4 for instance.
  35351. @author andy
  35352. @author Jason Height (jheight at chariot dot net dot au)
  35353. </member>
  35354. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.NotImplemented">
  35355. TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.
  35356. see similar comment in ReferencePtg
  35357. </member>
  35358. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_1_first_row">
  35359. zero based, Unsigned 16 bit
  35360. </member>
  35361. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_2_last_row">
  35362. zero based, Unsigned 16 bit
  35363. </member>
  35364. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_3_first_column">
  35365. zero based, Unsigned 8 bit
  35366. </member>
  35367. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_4_last_column">
  35368. zero based, Unsigned 8 bit
  35369. </member>
  35370. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SortTopLeftToBottomRight">
  35371. Sort the first and last row and columns in-place to the preferred (top left:bottom right) order
  35372. Note: Sort only occurs when an instance is constructed or when this method is called.
  35373. <p>For example, <code>$E5:B$10</code> becomes <code>B5:$E$10</code></p>
  35374. </member>
  35375. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstRow">
  35376. @return the first row in the area
  35377. </member>
  35378. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastRow">
  35379. @return last row in the range (x2 in x1,y1-x2,y2)
  35380. </member>
  35381. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstColumn">
  35382. @return the first column number in the area.
  35383. </member>
  35384. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstRowRelative">
  35385. @return whether or not the first row is a relative reference or not.
  35386. </member>
  35387. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstColRelative">
  35388. @return Isrelative first column to relative or not
  35389. </member>
  35390. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumn">
  35391. @return lastcolumn in the area
  35392. </member>
  35393. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumnRaw">
  35394. @return last column and bitmask (the raw field)
  35395. </member>
  35396. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastRowRelative">
  35397. @return last row relative or not
  35398. </member>
  35399. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastColRelative">
  35400. @return lastcol relative or not
  35401. </member>
  35402. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SetLastColumnRaw(System.Int16)">
  35403. Set the last column irrespective of the bitmasks
  35404. </member>
  35405. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg">
  35406. ArrayPtg - handles arrays
  35407. The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
  35408. includes the Ptg sid and the reserved bytes. The next Ptg in the expression then follows.
  35409. It is only after the "size" of all the Ptgs is met, that the ArrayPtg data is actually
  35410. held after this. So Ptg.CreateParsedExpression keeps track of the number of
  35411. ArrayPtg elements and need to Parse the data upto the FORMULA record size.
  35412. @author Jason Height (jheight at chariot dot net dot au)
  35413. </member>
  35414. <member name="F:NPOI.SS.Formula.PTG.ArrayPtg.PLAIN_TOKEN_SIZE">
  35415. The size of the plain tArray token written within the standard formula tokens
  35416. (not including the data which comes after all formula tokens)
  35417. </member>
  35418. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.#ctor(System.Object[][])">
  35419. @param values2d array values arranged in rows
  35420. </member>
  35421. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.GetValueIndex(System.Int32,System.Int32)">
  35422. Note - (2D) array elements are stored column by column
  35423. @return the index into the internal 1D array for the specified column and row
  35424. </member>
  35425. <member name="P:NPOI.SS.Formula.PTG.ArrayPtg.Size">
  35426. This size includes the size of the array Ptg plus the Array Ptg Token value size
  35427. </member>
  35428. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg.Initial">
  35429. Represents the initial plain tArray token (without the constant data that trails the whole
  35430. formula). Objects of this class are only temporary and cannot be used as {@link Ptg}s.
  35431. These temporary objects get converted to {@link ArrayPtg} by the
  35432. {@link #finishReading(LittleEndianInput)} method.
  35433. </member>
  35434. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.Initial.FinishReading(NPOI.Util.ILittleEndianInput)">
  35435. Read in the actual token (array) values. This occurs
  35436. AFTER the last Ptg in the expression.
  35437. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf
  35438. </member>
  35439. <member name="T:NPOI.SS.Formula.PTG.AttrPtg">
  35440. "Special Attributes"
  35441. This seems to be a Misc Stuff and Junk record. One function it serves Is
  35442. in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option Set)
  35443. @author andy
  35444. @author Jason Height (jheight at chariot dot net dot au)
  35445. </member>
  35446. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._jumpTable">
  35447. only used for tAttrChoose: table of offsets to starts of args
  35448. </member>
  35449. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._chooseFuncOffset">
  35450. only used for tAttrChoose: offset to the tFuncVar for CHOOSE()
  35451. </member>
  35452. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBefore">
  35453. 00H = Spaces before the next token (not allowed before tParen token)
  35454. </member>
  35455. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBefore">
  35456. 01H = Carriage returns before the next token (not allowed before tParen token)
  35457. </member>
  35458. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeOpenParen">
  35459. 02H = Spaces before opening parenthesis (only allowed before tParen token)
  35460. </member>
  35461. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeOpenParen">
  35462. 03H = Carriage returns before opening parenthesis (only allowed before tParen token)
  35463. </member>
  35464. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeCloseParen">
  35465. 04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  35466. </member>
  35467. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeCloseParen">
  35468. 05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  35469. </member>
  35470. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceAfterEquality">
  35471. 06H = Spaces following the equality sign (only in macro sheets)
  35472. </member>
  35473. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSpace(NPOI.SS.Formula.PTG.AttrPtg.SpaceType,System.Int32)">
  35474. <summary>
  35475. Creates the space.
  35476. </summary>
  35477. <param name="type">a constant from SpaceType</param>
  35478. <param name="count">The count.</param>
  35479. </member>
  35480. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateIf(System.Int32)">
  35481. <summary>
  35482. Creates if.
  35483. </summary>
  35484. <param name="dist">distance (in bytes) to start of either
  35485. tFuncVar(IF) token (when false parameter is not present).</param>
  35486. </member>
  35487. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSkip(System.Int32)">
  35488. <summary>
  35489. Creates the skip.
  35490. </summary>
  35491. <param name="dist">distance (in bytes) to position behind tFuncVar(IF) token (minus 1).</param>
  35492. </member>
  35493. <member name="T:NPOI.SS.Formula.PTG.BoolPtg">
  35494. bool (bool)
  35495. Stores a (java) bool value in a formula.
  35496. @author Paul Krause (pkrause at soundbite dot com)
  35497. @author Andrew C. Oliver (acoliver at apache dot org)
  35498. @author Jason Height (jheight at chariot dot net dot au)
  35499. </member>
  35500. <member name="T:NPOI.SS.Formula.PTG.ConcatPtg">
  35501. @author andy
  35502. @author Jason Height (jheight at chariot dot net dot au)
  35503. </member>
  35504. <member name="T:NPOI.SS.Formula.PTG.ControlPtg">
  35505. Common baseclass for
  35506. tExp
  35507. tTbl
  35508. tParen
  35509. tNlr
  35510. tAttr
  35511. tSheet
  35512. tEndSheet
  35513. </member>
  35514. <member name="T:NPOI.SS.Formula.PTG.DeletedArea3DPtg">
  35515. Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
  35516. Description: Defined a area in Extern Sheet.
  35517. REFERENCE:
  35518. @author Patrick Luby
  35519. @version 1.0-pre
  35520. </member>
  35521. <member name="T:NPOI.SS.Formula.PTG.DeletedRef3DPtg">
  35522. Title: Deleted Reference 3D Ptg
  35523. Description: Defined a cell in extern sheet.
  35524. REFERENCE:
  35525. @author Patrick Luby
  35526. @version 1.0-pre
  35527. </member>
  35528. <member name="M:NPOI.SS.Formula.PTG.DeletedRef3DPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35529. Creates new DeletedRef3DPtg
  35530. </member>
  35531. <member name="T:NPOI.SS.Formula.PTG.DividePtg">
  35532. This PTG implements the standard binomial divide "/"
  35533. @author Andrew C. Oliver acoliver at apache dot org
  35534. @author Jason Height (jheight at chariot dot net dot au)
  35535. </member>
  35536. <member name="T:NPOI.SS.Formula.PTG.EqualPtg">
  35537. @author andy
  35538. </member>
  35539. <member name="T:NPOI.SS.Formula.PTG.ErrPtg">
  35540. @author Daniel Noll (daniel at nuix dot com dot au)
  35541. </member>
  35542. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NULL_INTERSECTION">
  35543. <b>#NULL!</b> - Intersection of two cell ranges is empty
  35544. </member>
  35545. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.DIV_ZERO">
  35546. <b>#DIV/0!</b> - Division by zero
  35547. </member>
  35548. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.VALUE_INVALID">
  35549. <b>#VALUE!</b> - Wrong type of operand
  35550. </member>
  35551. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.REF_INVALID">
  35552. <b>#REF!</b> - Illegal or deleted cell reference
  35553. </member>
  35554. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NAME_INVALID">
  35555. <b>#NAME?</b> - Wrong function or range name
  35556. </member>
  35557. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NUM_ERROR">
  35558. <b>#NUM!</b> - Value range overflow
  35559. </member>
  35560. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.N_A">
  35561. <b>#N/A</b> - Argument or function not available
  35562. </member>
  35563. <member name="M:NPOI.SS.Formula.PTG.ErrPtg.#ctor(System.Int32)">
  35564. Creates new ErrPtg
  35565. </member>
  35566. <member name="T:NPOI.SS.Formula.PTG.ExpPtg">
  35567. @author andy
  35568. @author Jason Height (jheight at chariot dot net dot au)
  35569. @author dmui (save existing implementation)
  35570. </member>
  35571. <member name="T:NPOI.SS.Formula.PTG.FuncPtg">
  35572. @author aviks
  35573. @author Jason Height (jheight at chariot dot net dot au)
  35574. @author Danny Mui (dmui at apache dot org) (Leftover handling)
  35575. </member>
  35576. <member name="T:NPOI.SS.Formula.PTG.FuncVarPtg">
  35577. @author Jason Height (jheight at chariot dot net dot au)
  35578. </member>
  35579. <member name="F:NPOI.SS.Formula.PTG.FuncVarPtg.SUM">
  35580. Single instance of this token for 'sum() taking a single argument'
  35581. </member>
  35582. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(NPOI.Util.ILittleEndianInput)">
  35583. Creates new function pointer from a byte array
  35584. usually called while reading an excel file.
  35585. </member>
  35586. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(System.String,System.Int32)">
  35587. Create a function ptg from a string tokenised by the parser
  35588. </member>
  35589. <member name="T:NPOI.SS.Formula.PTG.GreaterEqualPtg">
  35590. PTG class to implement greater or equal to
  35591. @author fred at stsci dot edu
  35592. </member>
  35593. <member name="T:NPOI.SS.Formula.PTG.GreaterThanPtg">
  35594. Greater than operator PTG ">"
  35595. @author Cameron Riley (criley at ekmail.com)
  35596. </member>
  35597. <member name="P:NPOI.SS.Formula.PTG.GreaterThanPtg.NumberOfOperands">
  35598. Get the number of operands for the Less than operator
  35599. @return int the number of operands
  35600. </member>
  35601. <member name="M:NPOI.SS.Formula.PTG.GreaterThanPtg.ToFormulaString(System.String[])">
  35602. Implementation of method from OperationsPtg
  35603. @param operands a String array of operands
  35604. @return String the Formula as a String
  35605. </member>
  35606. <member name="T:NPOI.SS.Formula.PTG.IntersectionPtg">
  35607. @author Daniel Noll (daniel at nuix dot com dot au)
  35608. </member>
  35609. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString">
  35610. Implementation of method from Ptg
  35611. </member>
  35612. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString(System.String[])">
  35613. implementation of method from OperationsPtg
  35614. </member>
  35615. <member name="T:NPOI.SS.Formula.PTG.IntPtg">
  35616. Integer (unsigned short integer)
  35617. Stores an Unsigned short value (java int) in a formula
  35618. @author Andrew C. Oliver (acoliver at apache dot org)
  35619. @author Jason Height (jheight at chariot dot net dot au)
  35620. </member>
  35621. <member name="M:NPOI.SS.Formula.PTG.IntPtg.IsInRange(System.Int32)">
  35622. Excel represents integers 0..65535 with the tInt token.
  35623. @return <c>true</c> if the specified value is within the range of values
  35624. <c>IntPtg</c> can represent.
  35625. </member>
  35626. <member name="T:NPOI.SS.Formula.PTG.LessEqualPtg">
  35627. Ptg class to implement less than or equal
  35628. @author fred at stsci dot edu
  35629. </member>
  35630. <member name="T:NPOI.SS.Formula.PTG.LessThanPtg">
  35631. Less than operator PTG "&lt;". The SID is taken from the
  35632. Openoffice.orgs Documentation of the Excel File Format,
  35633. Table 3.5.7
  35634. @author Cameron Riley (criley at ekmail.com)
  35635. </member>
  35636. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.sid">
  35637. the sid for the less than operator as hex
  35638. </member>
  35639. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.LESSTHAN">
  35640. identifier for LESS THAN char
  35641. </member>
  35642. <member name="P:NPOI.SS.Formula.PTG.LessThanPtg.NumberOfOperands">
  35643. Get the number of operands for the Less than operator
  35644. @return int the number of operands
  35645. </member>
  35646. <member name="M:NPOI.SS.Formula.PTG.LessThanPtg.ToFormulaString(System.String[])">
  35647. Implementation of method from OperationsPtg
  35648. @param operands a String array of operands
  35649. @return String the Formula as a String
  35650. </member>
  35651. <member name="T:NPOI.SS.Formula.PTG.MemAreaPtg">
  35652. @author Daniel Noll (daniel at nuix dot com dot au)
  35653. </member>
  35654. <member name="M:NPOI.SS.Formula.PTG.MemAreaPtg.#ctor(System.Int32)">
  35655. Creates new MemAreaPtg
  35656. </member>
  35657. <member name="T:NPOI.SS.Formula.PTG.MemErrPtg">
  35658. @author andy
  35659. @author Jason Height (jheight at chariot dot net dot au)
  35660. @author Daniel Noll (daniel at nuix dot com dot au)
  35661. </member>
  35662. <member name="M:NPOI.SS.Formula.PTG.MemErrPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35663. Creates new MemErrPtg
  35664. </member>
  35665. <member name="T:NPOI.SS.Formula.PTG.MemFuncPtg">
  35666. @author Glen Stampoultzis (glens at apache.org)
  35667. </member>
  35668. <member name="M:NPOI.SS.Formula.PTG.MemFuncPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35669. Creates new function pointer from a byte array
  35670. usually called while Reading an excel file.
  35671. </member>
  35672. <member name="T:NPOI.SS.Formula.PTG.MissingArgPtg">
  35673. Missing Function Arguments
  35674. Avik Sengupta &lt;avik at apache.org&gt;
  35675. @author Jason Height (jheight at chariot dot net dot au)
  35676. </member>
  35677. <member name="T:NPOI.SS.Formula.PTG.MultiplyPtg">
  35678. Implements the standard mathmatical multiplication - *
  35679. @author Andrew C. Oliver (acoliver at apache dot org)
  35680. @author Jason Height (jheight at chariot dot net dot au)
  35681. </member>
  35682. <member name="T:NPOI.SS.Formula.PTG.NamePtg">
  35683. @author andy
  35684. @author Jason Height (jheight at chariot dot net dot au)
  35685. </member>
  35686. <member name="F:NPOI.SS.Formula.PTG.NamePtg.field_1_label_index">
  35687. one-based index to defined name record
  35688. </member>
  35689. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(System.Int32)">
  35690. @param nameIndex zero-based index to name within workbook
  35691. </member>
  35692. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35693. Creates new NamePtg
  35694. </member>
  35695. <member name="P:NPOI.SS.Formula.PTG.NamePtg.Index">
  35696. @return zero based index to a defined name record in the LinkTable
  35697. </member>
  35698. <member name="T:NPOI.SS.Formula.PTG.NameXPtg">
  35699. A Name, be that a Named Range or a Function / User Defined
  35700. Function, addressed in the HSSF External Sheet style.
  35701. This is HSSF only, as it matches the HSSF file format way of
  35702. referring to the sheet by an extern index. The XSSF equivalent
  35703. is {@link NameXPxg}
  35704. </member>
  35705. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._sheetRefIndex">
  35706. index to REF entry in externsheet record
  35707. </member>
  35708. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._nameNumber">
  35709. index to defined name or externname table(1 based)
  35710. </member>
  35711. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._reserved">
  35712. reserved must be 0
  35713. </member>
  35714. <member name="M:NPOI.SS.Formula.PTG.NameXPtg.#ctor(System.Int32,System.Int32)">
  35715. @param sheetRefIndex index to REF entry in externsheet record
  35716. @param nameIndex index to defined name or externname table
  35717. </member>
  35718. <member name="T:NPOI.SS.Formula.PTG.NotEqualPtg">
  35719. Ptg class to implement not equal
  35720. @author fred at stsci dot edu
  35721. </member>
  35722. <member name="T:NPOI.SS.Formula.PTG.NumberPtg">
  35723. Number
  35724. Stores a floating point value in a formula
  35725. value stored in a 8 byte field using IEEE notation
  35726. @author Avik Sengupta
  35727. @author Jason Height (jheight at chariot dot net dot au)
  35728. </member>
  35729. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35730. Create a NumberPtg from a byte array Read from disk
  35731. </member>
  35732. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(System.String)">
  35733. Create a NumberPtg from a string representation of the number
  35734. Number format is not checked, it is expected to be validated in the parser
  35735. that calls this method.
  35736. @param value : String representation of a floating point number
  35737. </member>
  35738. <member name="T:NPOI.SS.Formula.PTG.OperandPtg">
  35739. @author Josh Micich
  35740. </member>
  35741. <member name="P:NPOI.SS.Formula.PTG.OperandPtg.IsBaseToken">
  35742. All Operand <c>Ptg</c>s are classifed ('relative', 'value', 'array')
  35743. </member>
  35744. <member name="T:NPOI.SS.Formula.PTG.OperationPtg">
  35745. defines a Ptg that is an operation instead of an operand
  35746. @author andy
  35747. </member>
  35748. <member name="M:NPOI.SS.Formula.PTG.OperationPtg.ToFormulaString(System.String[])">
  35749. returns a string representation of the operations
  35750. the Length of the input array should equal the number returned by
  35751. @see #GetNumberOfOperands
  35752. </member>
  35753. <member name="P:NPOI.SS.Formula.PTG.OperationPtg.NumberOfOperands">
  35754. The number of operands expected by the operations
  35755. </member>
  35756. <member name="T:NPOI.SS.Formula.PTG.ParenthesisPtg">
  35757. While formula tokens are stored in RPN order and thus do not need parenthesis for
  35758. precedence reasons, Parenthesis tokens ARE written to Ensure that user entered
  35759. parenthesis are Displayed as-is on Reading back
  35760. Avik Sengupta &lt;lists@aviksengupta.com&gt;
  35761. Andrew C. Oliver (acoliver at apache dot org)
  35762. @author Jason Height (jheight at chariot dot net dot au)
  35763. </member>
  35764. <member name="T:NPOI.SS.Formula.PTG.PercentPtg">
  35765. Percent PTG.
  35766. @author Daniel Noll (daniel at nuix.com.au)
  35767. </member>
  35768. <member name="T:NPOI.SS.Formula.PTG.PowerPtg">
  35769. @author andy
  35770. @author Jason Height (jheight at chariot dot net dot au)
  35771. </member>
  35772. <member name="T:NPOI.SS.Formula.PTG.Ptg">
  35773. <c>Ptg</c> represents a syntactic token in a formula. 'PTG' is an acronym for
  35774. '<b>p</b>arse <b>t</b>hin<b>g</b>'. Originally, the name referred to the single
  35775. byte identifier at the start of the token, but in POI, <c>Ptg</c> encapsulates
  35776. the whole formula token (initial byte + value data).
  35777. <c>Ptg</c>s are logically arranged in a tree representing the structure of the
  35778. Parsed formula. However, in BIFF files <c>Ptg</c>s are written/Read in
  35779. <em>Reverse-Polish Notation</em> order. The RPN ordering also simplifies formula
  35780. evaluation logic, so POI mostly accesses <c>Ptg</c>s in the same way.
  35781. @author andy
  35782. @author avik
  35783. @author Jason Height (jheight at chariot dot net dot au)
  35784. </member>
  35785. <member name="M:NPOI.SS.Formula.PTG.Ptg.ReadTokens(System.Int32,NPOI.Util.ILittleEndianInput)">
  35786. Reads <c>size</c> bytes of the input stream, to Create an array of <c>Ptg</c>s.
  35787. Extra data (beyond <c>size</c>) may be Read if and <c>ArrayPtg</c>s are present.
  35788. </member>
  35789. <member name="M:NPOI.SS.Formula.PTG.Ptg.Clone">
  35790. @return a distinct copy of this <c>Ptg</c> if the class is mutable, or the same instance
  35791. if the class is immutable.
  35792. </member>
  35793. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSize(NPOI.SS.Formula.PTG.Ptg[])">
  35794. This method will return the same result as {@link #getEncodedSizeWithoutArrayData(Ptg[])}
  35795. if there are no array tokens present.
  35796. @return the full size taken to encode the specified <c>Ptg</c>s
  35797. </member>
  35798. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSizeWithoutArrayData(NPOI.SS.Formula.PTG.Ptg[])">
  35799. Used to calculate value that should be encoded at the start of the encoded Ptg token array;
  35800. @return the size of the encoded Ptg tokens not including any trailing array data.
  35801. </member>
  35802. <member name="M:NPOI.SS.Formula.PTG.Ptg.SerializePtgs(NPOI.SS.Formula.PTG.Ptg[],System.Byte[],System.Int32)">
  35803. Writes the ptgs to the data buffer, starting at the specified offset.
  35804. <br/>
  35805. The 2 byte encode Length field is <b>not</b> written by this method.
  35806. @return number of bytes written
  35807. </member>
  35808. <member name="P:NPOI.SS.Formula.PTG.Ptg.Size">
  35809. @return the encoded Length of this Ptg, including the initial Ptg type identifier byte.
  35810. </member>
  35811. <member name="P:NPOI.SS.Formula.PTG.Ptg.IsBaseToken">
  35812. @return <c>false</c> if this token is classified as 'reference', 'value', or 'array'
  35813. </member>
  35814. <member name="M:NPOI.SS.Formula.PTG.Ptg.Write(NPOI.Util.ILittleEndianOutput)">
  35815. Write this Ptg to a byte array
  35816. </member>
  35817. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToFormulaString">
  35818. return a string representation of this token alone
  35819. </member>
  35820. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToString">
  35821. Overridden toString method to Ensure object hash is not printed.
  35822. This helps Get rid of gratuitous diffs when comparing two dumps
  35823. Subclasses may output more relevant information by overriding this method
  35824. </member>
  35825. <member name="P:NPOI.SS.Formula.PTG.Ptg.PtgClass">
  35826. @return the 'operand class' (REF/VALUE/ARRAY) for this Ptg
  35827. </member>
  35828. <member name="P:NPOI.SS.Formula.PTG.Ptg.RVAType">
  35829. Debug / diagnostic method to get this token's 'operand class' type.
  35830. @return 'R' for 'reference', 'V' for 'value', 'A' for 'array' and '.' for base tokens
  35831. </member>
  35832. <member name="T:NPOI.SS.Formula.PTG.RangePtg">
  35833. @author Daniel Noll (daniel at nuix dot com dot au)
  35834. </member>
  35835. <member name="M:NPOI.SS.Formula.PTG.RangePtg.ToFormulaString(System.String[])">
  35836. implementation of method from OperationsPtg
  35837. </member>
  35838. <member name="T:NPOI.SS.Formula.PTG.Ref2DPtgBase">
  35839. @author Josh Micich
  35840. </member>
  35841. <member name="M:NPOI.SS.Formula.PTG.Ref2DPtgBase.#ctor(System.String)">
  35842. Takes in a String representation of a cell reference and fills out the
  35843. numeric fields.
  35844. </member>
  35845. <member name="T:NPOI.SS.Formula.PTG.Ref3DPtg">
  35846. Title: Reference 3D Ptg
  35847. Description: Defined a cell in extern sheet.
  35848. REFERENCE:
  35849. @author Libin Roman (Vista Portal LDT. Developer)
  35850. @author Jason Height (jheight at chariot dot net dot au)
  35851. @version 1.0-pre
  35852. </member>
  35853. <member name="F:NPOI.SS.Formula.PTG.Ref3DPtg.rowRelative">
  35854. Field 2
  35855. - lower 8 bits is the zero based Unsigned byte column index
  35856. - bit 16 - IsRowRelative
  35857. - bit 15 - IsColumnRelative
  35858. </member>
  35859. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.#ctor">
  35860. Creates new AreaPtg
  35861. </member>
  35862. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  35863. @return text representation of this cell reference that can be used in text
  35864. formulas. The sheet name will Get properly delimited if required.
  35865. </member>
  35866. <member name="T:NPOI.SS.Formula.PTG.RefErrorPtg">
  35867. RefError - handles deleted cell reference
  35868. @author Jason Height (jheight at chariot dot net dot au)
  35869. </member>
  35870. <member name="T:NPOI.SS.Formula.PTG.RefNPtg">
  35871. RefNPtg
  35872. @author Jason Height (jheight at apache dot com)
  35873. </member>
  35874. <member name="M:NPOI.SS.Formula.PTG.RefNPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35875. Creates new ValueReferencePtg
  35876. </member>
  35877. <member name="T:NPOI.SS.Formula.PTG.RefPtg">
  35878. ReferencePtg - handles references (such as A1, A2, IA4)
  35879. @author Andrew C. Oliver (acoliver@apache.org)
  35880. @author Jason Height (jheight at chariot dot net dot au)
  35881. </member>
  35882. <member name="M:NPOI.SS.Formula.PTG.RefPtg.#ctor(System.String)">
  35883. Takes in a String representation of a cell reference and Fills out the
  35884. numeric fields.
  35885. </member>
  35886. <member name="T:NPOI.SS.Formula.PTG.RefPtgBase">
  35887. ReferencePtgBase - handles references (such as A1, A2, IA4)
  35888. @author Andrew C. Oliver (acoliver@apache.org)
  35889. @author Jason Height (jheight at chariot dot net dot au)
  35890. </member>
  35891. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_1_row">
  35892. The row index - zero based Unsigned 16 bit value
  35893. </member>
  35894. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_2_col">
  35895. Field 2
  35896. - lower 8 bits is the zero based Unsigned byte column index
  35897. - bit 16 - IsRowRelative
  35898. - bit 15 - IsColumnRelative
  35899. </member>
  35900. <member name="M:NPOI.SS.Formula.PTG.RefPtgBase.#ctor(System.String)">
  35901. Takes in a String representation of a cell reference and Fills out the
  35902. numeric fields.
  35903. </member>
  35904. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.Row">
  35905. Returns the row number as a short, which will be
  35906. wrapped (negative) for values between 32769 and 65535
  35907. </member>
  35908. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.RowAsInt">
  35909. Returns the row number as an int, between 0 and 65535
  35910. </member>
  35911. <member name="T:NPOI.SS.Formula.PTG.ScalarConstantPtg">
  35912. @author Josh Micich
  35913. </member>
  35914. <member name="T:NPOI.SS.Formula.PTG.StringPtg">
  35915. String Stores a String value in a formula value stored in the format
  35916. &lt;Length 2 bytes&gt;char[]
  35917. @author Werner Froidevaux
  35918. @author Jason Height (jheight at chariot dot net dot au)
  35919. @author Bernard Chesnoy
  35920. </member>
  35921. <member name="F:NPOI.SS.Formula.PTG.StringPtg.FORMULA_DELIMITER">
  35922. the Char (")used in formulas to delimit string literals
  35923. </member>
  35924. <member name="F:NPOI.SS.Formula.PTG.StringPtg.field_1_Length">
  35925. NOTE: OO doc says 16bit Length, but BiffViewer says 8 Book says something
  35926. totally different, so don't look there!
  35927. </member>
  35928. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35929. Create a StringPtg from a stream
  35930. </member>
  35931. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(System.String)">
  35932. Create a StringPtg from a string representation of the number Number
  35933. format Is not Checked, it Is expected to be Validated in the Parser that
  35934. calls this method.
  35935. @param value :
  35936. String representation of a floating point number
  35937. </member>
  35938. <member name="T:NPOI.SS.Formula.PTG.SubtractPtg">
  35939. @author andy
  35940. @author Jason Height (jheight at chariot dot net dot au)
  35941. </member>
  35942. <member name="T:NPOI.SS.Formula.PTG.TblPtg">
  35943. This ptg indicates a data table.
  35944. It only occurs in a FORMULA record, never in an
  35945. ARRAY or NAME record. When ptgTbl occurs in a
  35946. formula, it is the only token in the formula.
  35947. This indicates that the cell containing the
  35948. formula is an interior cell in a data table;
  35949. the table description is found in a TABLE
  35950. record. Rows and columns which contain input
  35951. values to be substituted in the table do
  35952. not contain ptgTbl.
  35953. See page 811 of the june 08 binary docs.
  35954. </member>
  35955. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_1_first_row">
  35956. The row number of the upper left corner
  35957. </member>
  35958. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_2_first_col">
  35959. The column number of the upper left corner
  35960. </member>
  35961. <member name="T:NPOI.SS.Formula.PTG.UnaryMinusPtg">
  35962. Unary Plus operator
  35963. does not have any effect on the operand
  35964. @author Avik Sengupta
  35965. </member>
  35966. <member name="M:NPOI.SS.Formula.PTG.UnaryMinusPtg.ToFormulaString(System.String[])">
  35967. implementation of method from OperationsPtg
  35968. </member>
  35969. <member name="T:NPOI.SS.Formula.PTG.UnaryPlusPtg">
  35970. Unary Plus operator
  35971. does not have any effect on the operand
  35972. @author Avik Sengupta
  35973. </member>
  35974. <member name="M:NPOI.SS.Formula.PTG.UnaryPlusPtg.ToFormulaString(System.String[])">
  35975. implementation of method from OperationsPtg
  35976. </member>
  35977. <member name="T:NPOI.SS.Formula.PTG.UnionPtg">
  35978. @author Glen Stampoultzis (glens at apache.org)
  35979. </member>
  35980. <member name="M:NPOI.SS.Formula.PTG.UnionPtg.ToFormulaString(System.String[])">
  35981. implementation of method from OperationsPtg
  35982. </member>
  35983. <member name="T:NPOI.SS.Formula.PTG.UnknownPtg">
  35984. @author andy
  35985. @author Jason Height (jheight at chariot dot net dot au)
  35986. </member>
  35987. <member name="M:NPOI.SS.Formula.PTG.UnknownPtg.#ctor">
  35988. Creates new UnknownPtg
  35989. </member>
  35990. <member name="T:NPOI.SS.Formula.PTG.ValueOperatorPtg">
  35991. Common baseclass of all value operators.
  35992. Subclasses include all Unary and binary operators except for the reference operators (IntersectionPtg, RangePtg, UnionPtg)
  35993. @author Josh Micich
  35994. </member>
  35995. <member name="P:NPOI.SS.Formula.PTG.ValueOperatorPtg.IsBaseToken">
  35996. All Operator <c>Ptg</c>s are base tokens (i.e. are not RVA classified)
  35997. </member>
  35998. <member name="T:NPOI.SS.Formula.SheetRangeEvaluator">
  35999. Evaluator for returning cells or sheets for a range of sheets
  36000. </member>
  36001. <member name="T:NPOI.SS.Formula.ThreeDEval">
  36002. Optional Extension to the likes of {@link AreaEval} and
  36003. {@link NPOI.SS.Formula.Eval.AreaEvalBase},
  36004. which allows for looking up 3D (sheet+row+column) Evaluations
  36005. </member>
  36006. <member name="M:NPOI.SS.Formula.ThreeDEval.GetValue(System.Int32,System.Int32,System.Int32)">
  36007. @param sheetIndex sheet index (zero based)
  36008. @param rowIndex relative row index (zero based)
  36009. @param columnIndex relative column index (zero based)
  36010. @return element at the specified row and column position
  36011. </member>
  36012. <member name="T:NPOI.SS.Formula.TwoDEval">
  36013. Common interface of {@link AreaEval} and {@link org.apache.poi.ss.formula.eval.AreaEvalBase},
  36014. for 2D (row+column) evaluations
  36015. </member>
  36016. <member name="M:NPOI.SS.Formula.TwoDEval.GetValue(System.Int32,System.Int32)">
  36017. @param rowIndex relative row index (zero based)
  36018. @param columnIndex relative column index (zero based)
  36019. @return element at the specified row and column position
  36020. </member>
  36021. <member name="P:NPOI.SS.Formula.TwoDEval.IsRow">
  36022. @return <c>true</c> if the area has just a single row, this also includes
  36023. the trivial case when the area has just a single cell.
  36024. </member>
  36025. <member name="P:NPOI.SS.Formula.TwoDEval.IsColumn">
  36026. @return <c>true</c> if the area has just a single column, this also includes
  36027. the trivial case when the area has just a single cell.
  36028. </member>
  36029. <member name="M:NPOI.SS.Formula.TwoDEval.GetRow(System.Int32)">
  36030. @param rowIndex relative row index (zero based)
  36031. @return a single row {@link TwoDEval}
  36032. </member>
  36033. <member name="M:NPOI.SS.Formula.TwoDEval.GetColumn(System.Int32)">
  36034. @param columnIndex relative column index (zero based)
  36035. @return a single column {@link TwoDEval}
  36036. </member>
  36037. <member name="M:NPOI.SS.Formula.TwoDEval.IsSubTotal(System.Int32,System.Int32)">
  36038. @return true if the cell at row and col is a subtotal
  36039. </member>
  36040. <member name="T:NPOI.SS.Formula.UDF.IndexedUDFFinder">
  36041. A UDFFinder that can retrieve functions both by name and by fake index.
  36042. @author Yegor Kozlov
  36043. </member>
  36044. <member name="T:NPOI.SS.Formula.UDF.AggregatingUDFFinder">
  36045. Collects Add-in libraries and VB macro functions toGether into one UDF Finder
  36046. @author PUdalau
  36047. </member>
  36048. <member name="M:NPOI.SS.Formula.UDF.AggregatingUDFFinder.FindFunction(System.String)">
  36049. <summary>
  36050. Returns executor by specified name.
  36051. </summary>
  36052. <param name="name">Name of function.</param>
  36053. <returns>Function executor. null if not found</returns>
  36054. </member>
  36055. <member name="M:NPOI.SS.Formula.UDF.AggregatingUDFFinder.Add(NPOI.SS.Formula.UDF.UDFFinder)">
  36056. <summary>
  36057. Add a new toolpack
  36058. </summary>
  36059. <param name="toolPack"></param>
  36060. </member>
  36061. <member name="T:NPOI.SS.Formula.UDF.DefaultUDFFinder">
  36062. Default UDF Finder - for Adding your own user defined functions.
  36063. @author PUdalau
  36064. </member>
  36065. <member name="T:NPOI.SS.Formula.UDF.UDFFinder">
  36066. Common interface for "Add-in" libraries and user defined function libraries.
  36067. @author PUdalau
  36068. </member>
  36069. <member name="M:NPOI.SS.Formula.UDF.UDFFinder.FindFunction(System.String)">
  36070. Returns executor by specified name. Returns <code>null</code> if the function name is unknown.
  36071. @param name Name of function.
  36072. @return Function executor.
  36073. </member>
  36074. <member name="T:NPOI.SS.Formula.IWorkbookEvaluatorProvider">
  36075. Provides access to a {@link WorkbookEvaluator}, eg for use with
  36076. {@link CollaboratingWorkbooksEnvironment}
  36077. For POI internal use only
  36078. </member>
  36079. <member name="M:NPOI.SS.Formula.IWorkbookEvaluatorProvider.GetWorkbookEvaluator">
  36080. Provide the underlying WorkbookEvaluator
  36081. </member>
  36082. <member name="T:NPOI.SS.Formula.Constant.ConstantValueParser">
  36083. To support Constant Values (2.5.7) as required by the CRN record.
  36084. This class is also used for two dimensional arrays which are encoded by
  36085. EXTERNALNAME (5.39) records and Array tokens.<p/>
  36086. @author Josh Micich
  36087. </member>
  36088. <member name="M:NPOI.SS.Formula.Constant.ConstantValueParser.GetEncodedSize(System.Object)">
  36089. @return encoded size without the 'type' code byte
  36090. </member>
  36091. <member name="T:NPOI.SS.Formula.Constant.ErrorConstant">
  36092. <summary>
  36093. Represents a constant error code value as encoded in a constant values array.
  36094. This class is a type-safe wrapper for a 16-bit int value performing a similar job to
  36095. <c>ErrorEval</c>
  36096. </summary>
  36097. <remarks> @author Josh Micich</remarks>
  36098. </member>
  36099. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.#ctor(System.Int32)">
  36100. <summary>
  36101. Initializes a new instance of the <see cref="T:NPOI.SS.Formula.Constant.ErrorConstant"/> class.
  36102. </summary>
  36103. <param name="errorCode">The error code.</param>
  36104. </member>
  36105. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.ErrorCode">
  36106. <summary>
  36107. Gets the error code.
  36108. </summary>
  36109. <value>The error code.</value>
  36110. </member>
  36111. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.Text">
  36112. <summary>
  36113. Gets the text.
  36114. </summary>
  36115. <value>The text.</value>
  36116. </member>
  36117. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ValueOf(System.Int32)">
  36118. <summary>
  36119. Values the of.
  36120. </summary>
  36121. <param name="errorCode">The error code.</param>
  36122. <returns></returns>
  36123. </member>
  36124. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ToString">
  36125. <summary>
  36126. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  36127. </summary>
  36128. <returns>
  36129. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  36130. </returns>
  36131. </member>
  36132. <member name="T:NPOI.SS.Formula.CellCacheEntry">
  36133. Stores the parameters that identify the evaluation of one cell.<br/>
  36134. </member>
  36135. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults">
  36136. Calls formulaCell.SetFormulaResult(null, null) recursively all the way up the tree of
  36137. dependencies. Calls usedCell.ClearConsumingCell(fc) for each child of a cell that Is
  36138. Cleared along the way.
  36139. @param formulaCells
  36140. </member>
  36141. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults(NPOI.SS.Formula.IEvaluationListener,System.Int32)">
  36142. Identical To {@link #RecurseClearCachedFormulaResults()} except for the listener call-backs
  36143. </member>
  36144. <member name="T:NPOI.SS.Formula.CellEvaluationFrame">
  36145. Stores details about the current evaluation of a cell.<br/>
  36146. </member>
  36147. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.AddSensitiveInputCell(NPOI.SS.Formula.CellCacheEntry)">
  36148. @param inputCell a cell directly used by the formula of this evaluation frame
  36149. </member>
  36150. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.GetSensitiveInputCells">
  36151. @return never <c>null</c>, (possibly empty) array of all cells directly used while
  36152. evaluating the formula of this frame.
  36153. </member>
  36154. <member name="T:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment">
  36155. Manages a collection of {@link WorkbookEvaluator}s, in order To support evaluation of formulas
  36156. across spreadsheets.<p/>
  36157. For POI internal use only
  36158. @author Josh Micich
  36159. </member>
  36160. <member name="M:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment.Unhook">
  36161. </member>
  36162. <member name="T:NPOI.SS.Formula.EvaluationCache">
  36163. Performance optimisation for {@link HSSFFormulaEvaluator}. This class stores previously
  36164. calculated values of already visited cells, To avoid unnecessary re-calculation when the
  36165. same cells are referenced multiple times
  36166. @author Josh Micich
  36167. </member>
  36168. <member name="F:NPOI.SS.Formula.EvaluationCache._evaluationListener">
  36169. only used for testing. <c>null</c> otherwise
  36170. </member>
  36171. <member name="M:NPOI.SS.Formula.EvaluationCache.Clear">
  36172. Should be called whenever there are Changes To input cells in the evaluated workbook.
  36173. </member>
  36174. <member name="T:NPOI.SS.Formula.IEvaluationCell">
  36175. Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
  36176. and non-formula cells.<br/>
  36177. Implementors of this class must implement {@link #HashCode()} and {@link #Equals(Object)}
  36178. To provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
  36179. For POI internal use only
  36180. @author Josh Micich
  36181. </member>
  36182. <member name="T:NPOI.SS.Formula.IEvaluationName">
  36183. Abstracts a name record for formula evaluation.<br/>
  36184. For POI internal use only
  36185. @author Josh Micich
  36186. </member>
  36187. <member name="T:NPOI.SS.Formula.IEvaluationSheet">
  36188. Abstracts a sheet for the purpose of formula evaluation.<br/>
  36189. For POI internal use only
  36190. @author Josh Micich
  36191. </member>
  36192. <member name="M:NPOI.SS.Formula.IEvaluationSheet.GetCell(System.Int32,System.Int32)">
  36193. @return <c>null</c> if there is no cell at the specified coordinates
  36194. </member>
  36195. <member name="M:NPOI.SS.Formula.IEvaluationSheet.ClearAllCachedResultValues">
  36196. Propagated from {@link EvaluationWorkbook#clearAllCachedResultValues()} to clear locally cached data.
  36197. @see WorkbookEvaluator#clearAllCachedResultValues()
  36198. @see EvaluationWorkbook#clearAllCachedResultValues()
  36199. </member>
  36200. <member name="T:NPOI.SS.Formula.EvaluationTracker">
  36201. <summary>
  36202. Instances of this class keep track of multiple dependent cell evaluations due
  36203. To recursive calls To <see cref="M:NPOI.SS.Formula.WorkbookEvaluator.Evaluate(NPOI.SS.Formula.IEvaluationCell)"/>
  36204. The main purpose of this class is To detect an attempt To evaluate a cell
  36205. that is already being evaluated. In other words, it detects circular
  36206. references in spreadsheet formulas.
  36207. </summary>
  36208. <remarks>
  36209. @author Josh Micich
  36210. </remarks>
  36211. </member>
  36212. <member name="M:NPOI.SS.Formula.EvaluationTracker.StartEvaluate(NPOI.SS.Formula.FormulaCellCacheEntry)">
  36213. Notifies this evaluation tracker that evaluation of the specified cell Is
  36214. about To start.<br/>
  36215. In the case of a <c>true</c> return code, the caller should
  36216. continue evaluation of the specified cell, and also be sure To call
  36217. <c>endEvaluate()</c> when complete.<br/>
  36218. In the case of a <c>null</c> return code, the caller should
  36219. return an evaluation result of
  36220. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  36221. <br/>
  36222. @return <c>false</c> if the specified cell is already being evaluated
  36223. </member>
  36224. <member name="M:NPOI.SS.Formula.EvaluationTracker.EndEvaluate(NPOI.SS.Formula.CellCacheEntry)">
  36225. Notifies this evaluation tracker that the evaluation of the specified cell is complete. <p/>
  36226. Every successful call To <c>startEvaluate</c> must be followed by a call To <c>endEvaluate</c> (recommended in a finally block) To enable
  36227. proper tracking of which cells are being evaluated at any point in time.<p/>
  36228. Assuming a well behaved client, parameters To this method would not be
  36229. required. However, they have been included To assert correct behaviour,
  36230. and form more meaningful error messages.
  36231. </member>
  36232. <member name="T:NPOI.SS.Formula.IEvaluationWorkbook">
  36233. Abstracts a workbook for the purpose of formula evaluation.<br/>
  36234. For POI internal use only
  36235. @author Josh Micich
  36236. </member>
  36237. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetSheetIndex(NPOI.SS.Formula.IEvaluationSheet)">
  36238. @return -1 if the specified sheet is from a different book
  36239. </member>
  36240. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.Int32)">
  36241. HSSF Only - fetch the external-style sheet details
  36242. <p>Return will have no workbook set if it's actually in our own workbook</p>
  36243. </member>
  36244. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.String,System.String,System.Int32)">
  36245. XSSF Only - fetch the external-style sheet details
  36246. <p>Return will have no workbook set if it's actually in our own workbook</p>
  36247. </member>
  36248. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  36249. HSSF Only - convert an external sheet index to an internal sheet index,
  36250. for an external-style reference to one of this workbook's own sheets
  36251. </member>
  36252. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.Int32,System.Int32)">
  36253. HSSF Only - fetch the external-style name details
  36254. </member>
  36255. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.String,System.String,System.Int32)">
  36256. XSSF Only - fetch the external-style name details
  36257. </member>
  36258. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ClearAllCachedResultValues">
  36259. Propagated from {@link WorkbookEvaluator#clearAllCachedResultValues()} to clear locally cached data.
  36260. Implementations must call the same method on all referenced {@link EvaluationSheet} instances, as well as clearing local caches.
  36261. @see WorkbookEvaluator#clearAllCachedResultValues()
  36262. </member>
  36263. <member name="T:NPOI.SS.Formula.IExternSheetReferenceToken">
  36264. Should be implemented by any {@link Ptg} subclass that needs Has an extern sheet index <br/>
  36265. For POI internal use only
  36266. @author Josh Micich
  36267. </member>
  36268. <member name="T:NPOI.SS.Formula.Formula">
  36269. Encapsulates an encoded formula token array.
  36270. @author Josh Micich
  36271. </member>
  36272. <member name="F:NPOI.SS.Formula.Formula._byteEncoding">
  36273. immutable
  36274. </member>
  36275. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput)">
  36276. Convenience method for {@link #read(int, LittleEndianInput, int)}
  36277. </member>
  36278. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput,System.Int32)">
  36279. When there are no array constants present, <c>encodedTokenLen</c>==<c>totalEncodedLen</c>
  36280. @param encodedTokenLen number of bytes in the stream taken by the plain formula tokens
  36281. @param totalEncodedLen the total number of bytes in the formula (includes trailing encoding
  36282. for array constants, but does not include 2 bytes for initial <c>ushort encodedTokenLen</c> field.
  36283. @return A new formula object as read from the stream. Possibly empty, never <code>null</code>.
  36284. </member>
  36285. <member name="M:NPOI.SS.Formula.Formula.Serialize(NPOI.Util.ILittleEndianOutput)">
  36286. Writes The formula encoding is includes:
  36287. <ul>
  36288. <li>ushort tokenDataLen</li>
  36289. <li>tokenData</li>
  36290. <li>arrayConstantData (if present)</li>
  36291. </ul>
  36292. </member>
  36293. <member name="P:NPOI.SS.Formula.Formula.EncodedSize">
  36294. @return total formula encoding length. The formula encoding includes:
  36295. <ul>
  36296. <li>ushort tokenDataLen</li>
  36297. <li>tokenData</li>
  36298. <li>arrayConstantData (optional)</li>
  36299. </ul>
  36300. Note - this value is different to <c>tokenDataLength</c>
  36301. </member>
  36302. <member name="P:NPOI.SS.Formula.Formula.EncodedTokenSize">
  36303. This method is often used when the formula length does not appear immediately before
  36304. the encoded token data.
  36305. @return the encoded length of the plain formula tokens. This does <em>not</em> include
  36306. the leading ushort field, nor any trailing array constant data.
  36307. </member>
  36308. <member name="M:NPOI.SS.Formula.Formula.Create(NPOI.SS.Formula.PTG.Ptg[])">
  36309. Creates a {@link Formula} object from a supplied {@link Ptg} array.
  36310. Handles <code>null</code>s OK.
  36311. @param ptgs may be <code>null</code>
  36312. @return Never <code>null</code> (Possibly empty if the supplied <c>ptgs</c> is <code>null</code>)
  36313. </member>
  36314. <member name="M:NPOI.SS.Formula.Formula.GetTokens(NPOI.SS.Formula.Formula)">
  36315. Gets the {@link Ptg} array from the supplied {@link Formula}.
  36316. Handles <code>null</code>s OK.
  36317. @param formula may be <code>null</code>
  36318. @return possibly <code>null</code> (if the supplied <c>formula</c> is <code>null</code>)
  36319. </member>
  36320. <member name="P:NPOI.SS.Formula.Formula.ExpReference">
  36321. Gets the locator for the corresponding {@link SharedFormulaRecord}, {@link ArrayRecord} or
  36322. {@link TableRecord} if this formula belongs to such a grouping. The {@link CellReference}
  36323. returned by this method will match the top left corner of the range of that grouping.
  36324. The return value is usually not the same as the location of the cell containing this formula.
  36325. @return the firstRow &amp; firstColumn of an array formula or shared formula that this formula
  36326. belongs to. <code>null</code> if this formula is not part of an array or shared formula.
  36327. </member>
  36328. <member name="T:NPOI.SS.Formula.FormulaCellCache">
  36329. @author Josh Micich
  36330. </member>
  36331. <member name="M:NPOI.SS.Formula.FormulaCellCache.Get(NPOI.SS.Formula.IEvaluationCell)">
  36332. @return <c>null</c> if not found
  36333. </member>
  36334. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntry">
  36335. Stores the cached result of a formula evaluation, along with the Set of sensititive input cells
  36336. </member>
  36337. <member name="F:NPOI.SS.Formula.FormulaCellCacheEntry._sensitiveInputCells">
  36338. Cells 'used' in the current evaluation of the formula corresponding To this cache entry
  36339. If any of the following cells Change, this cache entry needs To be Cleared
  36340. </member>
  36341. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntrySet">
  36342. A custom implementation of {@link java.util.HashSet} in order To reduce memory consumption.
  36343. Profiling tests (Oct 2008) have shown that each element {@link FormulaCellCacheEntry} takes
  36344. around 32 bytes To store in a HashSet, but around 6 bytes To store here. For Spreadsheets with
  36345. thousands of formula cells with multiple interdependencies, the savings can be very significant.
  36346. @author Josh Micich
  36347. </member>
  36348. <member name="T:NPOI.SS.Formula.FormulaParseException">
  36349. <summary>
  36350. Specific exception thrown when a supplied formula does not Parse properly.
  36351. Primarily used by test cases when testing for specific parsing exceptions.
  36352. </summary>
  36353. </member>
  36354. <member name="M:NPOI.SS.Formula.FormulaParseException.#ctor(System.String)">
  36355. <summary>
  36356. This class was given package scope until it would become Clear that it is useful to general client code.
  36357. </summary>
  36358. <param name="msg"></param>
  36359. </member>
  36360. <member name="F:NPOI.SS.Formula.FormulaParser.look">
  36361. Lookahead Character.
  36362. Gets value '\0' when the input string is exhausted
  36363. </member>
  36364. <member name="F:NPOI.SS.Formula.FormulaParser._inIntersection">
  36365. Tracks whether the run of whitespace preceeding "look" could be an
  36366. intersection operator. See GetChar.
  36367. </member>
  36368. <member name="M:NPOI.SS.Formula.FormulaParser.#ctor(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32,System.Int32)">
  36369. Create the formula Parser, with the string that is To be
  36370. Parsed against the supplied workbook.
  36371. A later call the Parse() method To return ptg list in
  36372. rpn order, then call the GetRPNPtg() To retrive the
  36373. Parse results.
  36374. This class is recommended only for single threaded use.
  36375. If you only have a usermodel.HSSFWorkbook, and not a
  36376. model.Workbook, then use the convenience method on
  36377. usermodel.HSSFFormulaEvaluator
  36378. </member>
  36379. <member name="M:NPOI.SS.Formula.FormulaParser.Parse(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,NPOI.SS.Formula.FormulaType,System.Int32,System.Int32)">
  36380. * Parse a formula into a array of tokens
  36381. * Side effect: creates name (Workbook.createName) if formula contains unrecognized names (names are likely UDFs)
  36382. *
  36383. * @param formula the formula to parse
  36384. * @param workbook the parent workbook
  36385. * @param formulaType the type of the formula, see {@link FormulaType}
  36386. * @param sheetIndex the 0-based index of the sheet this formula belongs to.
  36387. * @param rowIndex - the related cell's row index in 0-based form (-1 if the formula is not cell related)
  36388. * used to handle structured references that have the "#This Row" quantifier.
  36389. * The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  36390. * the scope of the name will be ignored and the parser will match names only by name
  36391. *
  36392. * @return array of parsed tokens
  36393. * @throws FormulaParseException if the formula is unparsable
  36394. </member>
  36395. <member name="M:NPOI.SS.Formula.FormulaParser.ParseStructuredReference(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32)">
  36396. Parse a structured reference. Converts the structured
  36397. reference to the area that represent it.
  36398. @param tableText - The structured reference text
  36399. @param workbook - the parent workbook
  36400. @param rowIndex - the 0-based cell's row index ( used to handle "#This Row" quantifiers )
  36401. @return the area that being represented by the structured reference.
  36402. </member>
  36403. <member name="M:NPOI.SS.Formula.FormulaParser.GetChar">
  36404. Read New Character From Input Stream
  36405. </member>
  36406. <member name="M:NPOI.SS.Formula.FormulaParser.expected(System.String)">
  36407. Report What Was Expected
  36408. </member>
  36409. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlpha(System.Char)">
  36410. Recognize an Alpha Character
  36411. </member>
  36412. <member name="M:NPOI.SS.Formula.FormulaParser.IsDigit(System.Char)">
  36413. Recognize a Decimal Digit
  36414. </member>
  36415. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlNum(System.Char)">
  36416. Recognize an Alphanumeric
  36417. </member>
  36418. <member name="M:NPOI.SS.Formula.FormulaParser.IsWhite(System.Char)">
  36419. Recognize White Space
  36420. </member>
  36421. <member name="M:NPOI.SS.Formula.FormulaParser.SkipWhite">
  36422. Skip Over Leading White Space
  36423. </member>
  36424. <member name="M:NPOI.SS.Formula.FormulaParser.Match(System.Char)">
  36425. Consumes the next input character if it is equal To the one specified otherwise throws an
  36426. unchecked exception. This method does <b>not</b> consume whitespace (before or after the
  36427. matched character).
  36428. </member>
  36429. <member name="M:NPOI.SS.Formula.FormulaParser.GetNum">
  36430. Get a Number
  36431. </member>
  36432. <member name="M:NPOI.SS.Formula.FormulaParser.NeedsMemFunc(NPOI.SS.Formula.ParseNode)">
  36433. From OOO doc: "Whenever one operand of the reference subexpression is a function,
  36434. a defined name, a 3D reference, or an external reference (and no error occurs),
  36435. a tMemFunc token is used"
  36436. </member>
  36437. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidDefinedNameChar(System.Char)">
  36438. @return <c>true</c> if the specified character may be used in a defined name
  36439. </member>
  36440. <member name="M:NPOI.SS.Formula.FormulaParser.CheckValidRangeOperand(System.String,System.Int32,NPOI.SS.Formula.ParseNode)">
  36441. @param currentParsePosition used to format a potential error message
  36442. </member>
  36443. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidRangeOperand(NPOI.SS.Formula.ParseNode)">
  36444. @return false if sub-expression represented the specified ParseNode definitely
  36445. cannot appear on either side of the range (':') operator
  36446. </member>
  36447. <member name="M:NPOI.SS.Formula.FormulaParser.ParseRangeable">
  36448. Parses area refs (things which could be the operand of ':') and simple factors
  36449. Examples
  36450. <pre>
  36451. A$1
  36452. $A$1 : $B1
  36453. A1 ....... C2
  36454. Sheet1 !$A1
  36455. a..b!A1
  36456. 'my sheet'!A1
  36457. .my.sheet!A1
  36458. 'my sheet':'my alt sheet'!A1
  36459. .my.sheet1:.my.sheet2!$B$2
  36460. my.named..range.
  36461. 'my sheet'!my.named.range
  36462. .my.sheet!my.named.range
  36463. foo.bar(123.456, "abc")
  36464. 123.456
  36465. "abc"
  36466. true
  36467. [Foo.xls]!$A$1
  36468. [Foo.xls]'my sheet'!$A$1
  36469. [Foo.xls]!my.named.range
  36470. </pre>
  36471. </member>
  36472. <member name="M:NPOI.SS.Formula.FormulaParser.ParseStructuredReference(System.String)">
  36473. Parses a structured reference, returns it as area reference.
  36474. Examples:
  36475. <pre>
  36476. Table1[col]
  36477. Table1[[#Totals],[col]]
  36478. Table1[#Totals]
  36479. Table1[#All]
  36480. Table1[#Data]
  36481. Table1[#Headers]
  36482. Table1[#Totals]
  36483. Table1[#This Row]
  36484. Table1[[#All],[col]]
  36485. Table1[[#Headers],[col]]
  36486. Table1[[#Totals],[col]]
  36487. Table1[[#All],[col1]:[col2]]
  36488. Table1[[#Data],[col1]:[col2]]
  36489. Table1[[#Headers],[col1]:[col2]]
  36490. Table1[[#Totals],[col1]:[col2]]
  36491. Table1[[#Headers],[#Data],[col2]]
  36492. Table1[[#This Row], [col1]]
  36493. Table1[ [col1]:[col2] ]
  36494. </pre>
  36495. @param tableName
  36496. @return
  36497. </member>
  36498. <member name="M:NPOI.SS.Formula.FormulaParser.ParseAsColumnQuantifier">
  36499. Tries to parse the next as column - can contain whitespace
  36500. Caller should save pointer.
  36501. @return
  36502. </member>
  36503. <member name="M:NPOI.SS.Formula.FormulaParser.ParseAsSpecialQuantifier">
  36504. Tries to parse the next as special quantifier
  36505. Caller should save pointer.
  36506. @return
  36507. </member>
  36508. <member name="M:NPOI.SS.Formula.FormulaParser.ParseNonRange(System.Int32)">
  36509. Parses simple factors that are not primitive ranges or range components
  36510. i.e. '!', ':'(and equiv '...') do not appear
  36511. Examples
  36512. <pre>
  36513. my.named...range.
  36514. foo.bar(123.456, "abc")
  36515. 123.456
  36516. "abc"
  36517. true
  36518. </pre>
  36519. </member>
  36520. <member name="M:NPOI.SS.Formula.FormulaParser.CreateAreaRefParseNode(NPOI.SS.Formula.SheetIdentifier,NPOI.SS.Formula.FormulaParser.SimpleRangePart,NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  36521. @param sheetIden may be <code>null</code>
  36522. @param part1
  36523. @param part2 may be <code>null</code>
  36524. </member>
  36525. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleRangePart">
  36526. Parses out a potential LHS or RHS of a ':' intended to produce a plain AreaRef. Normally these are
  36527. proper cell references but they could also be row or column refs like "$AC" or "10"
  36528. @return <code>null</code> (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
  36529. </member>
  36530. <member name="M:NPOI.SS.Formula.FormulaParser.ReduceRangeExpression(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.PTG.Ptg)">
  36531. "A1", "B3" -> "A1:B3"
  36532. "sheet1!A1", "B3" -> "sheet1!A1:B3"
  36533. @return <c>null</c> if the range expression cannot / shouldn't be reduced.
  36534. </member>
  36535. <member name="T:NPOI.SS.Formula.FormulaParser.SimpleRangePart">
  36536. A1, $A1, A$1, $A$1, A, 1
  36537. </member>
  36538. <member name="M:NPOI.SS.Formula.FormulaParser.SimpleRangePart.IsCompatibleForArea(NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  36539. @return <c>true</c> if the two range parts can be combined in an
  36540. {@link AreaPtg} ( Note - the explicit range operator (:) may still be valid
  36541. when this method returns <c>false</c> )
  36542. </member>
  36543. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetName">
  36544. Note - caller should reset {@link #_pointer} upon <code>null</code> result
  36545. @return The sheet name as an identifier <code>null</code> if '!' is not found in the right place
  36546. </member>
  36547. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetRange(System.String,NPOI.SS.Formula.NameIdentifier)">
  36548. If we have something that looks like [book]Sheet1: or
  36549. Sheet1, see if it's actually a range eg Sheet1:Sheet2!
  36550. </member>
  36551. <member name="M:NPOI.SS.Formula.FormulaParser.IsUnquotedSheetNameChar(System.Char)">
  36552. very similar to {@link SheetNameFormatter#isSpecialChar(char)}
  36553. </member>
  36554. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidCellReference(System.String)">
  36555. @return <c>true</c> if the specified name is a valid cell reference
  36556. </member>
  36557. <member name="M:NPOI.SS.Formula.FormulaParser.Function(System.String)">
  36558. Note - Excel Function names are 'case aware but not case sensitive'. This method may end
  36559. up creating a defined name record in the workbook if the specified name is not an internal
  36560. Excel Function, and Has not been encountered before.
  36561. Side effect: creates workbook name if name is not recognized (name is probably a UDF)
  36562. @param name case preserved Function name (as it was entered/appeared in the formula).
  36563. </member>
  36564. <member name="M:NPOI.SS.Formula.FormulaParser.AddName(System.String)">
  36565. Adds a name (named range or user defined function) to underlying workbook's names table
  36566. @param functionName
  36567. </member>
  36568. <member name="M:NPOI.SS.Formula.FormulaParser.GetFunction(System.String,NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.ParseNode[])">
  36569. * Generates the variable Function ptg for the formula.
  36570. *
  36571. * For IF Formulas, Additional PTGs are Added To the Tokens
  36572. * @param name a {@link NamePtg} or {@link NameXPtg} or <code>null</code>
  36573. * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
  36574. </member>
  36575. <member name="M:NPOI.SS.Formula.FormulaParser.Arguments">
  36576. Get arguments To a Function
  36577. </member>
  36578. <member name="M:NPOI.SS.Formula.FormulaParser.PowerFactor">
  36579. Parse and Translate a Math Factor
  36580. </member>
  36581. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleFactor">
  36582. factors (without ^ or % )
  36583. </member>
  36584. <member name="M:NPOI.SS.Formula.FormulaParser.GetNumberPtgFromString(System.String,System.String,System.String)">
  36585. Get a PTG for an integer from its string representation.
  36586. return Int or Number Ptg based on size of input
  36587. </member>
  36588. <member name="M:NPOI.SS.Formula.FormulaParser.Term">
  36589. Parse and Translate a Math Term
  36590. </member>
  36591. <member name="M:NPOI.SS.Formula.FormulaParser.AdditiveExpression">
  36592. Parse and Translate an Expression
  36593. </member>
  36594. <member name="M:NPOI.SS.Formula.FormulaParser.Parse">
  36595. API call To execute the parsing of the formula
  36596. </member>
  36597. <member name="T:NPOI.SS.Formula.IFormulaParsingWorkbook">
  36598. Abstracts a workbook for the purpose of formula parsing.<br/>
  36599. For POI internal use only
  36600. @author Josh Micich
  36601. </member>
  36602. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetName(System.String,System.Int32)">
  36603. <summary>
  36604. named range name matching is case insensitive
  36605. </summary>
  36606. <param name="name">The name.</param>
  36607. <param name="sheetIndex">Index of the sheet.</param>
  36608. <returns></returns>
  36609. </member>
  36610. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.CreateName">
  36611. <summary>
  36612. Return the underlying workbook
  36613. </summary>
  36614. <returns></returns>
  36615. </member>
  36616. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetTable(System.String)">
  36617. <summary>
  36618. XSSF Only - gets a table that exists in the worksheet
  36619. </summary>
  36620. <param name="name"></param>
  36621. <returns></returns>
  36622. </member>
  36623. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  36624. <summary>
  36625. Return an external name (named range, function, user-defined function) Ptg
  36626. </summary>
  36627. <param name="name">The name.</param>
  36628. <param name="sheet"></param>
  36629. <returns></returns>
  36630. </member>
  36631. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.CellReference,NPOI.SS.Formula.SheetIdentifier)">
  36632. <summary>
  36633. Produce the appropriate Ptg for a 3d cell reference
  36634. </summary>
  36635. <param name="cell"></param>
  36636. <param name="sheet"></param>
  36637. <returns></returns>
  36638. </member>
  36639. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.AreaReference,NPOI.SS.Formula.SheetIdentifier)">
  36640. <summary>
  36641. Produce the appropriate Ptg for a 3d area reference
  36642. </summary>
  36643. <param name="area"></param>
  36644. <param name="sheet"></param>
  36645. <returns></returns>
  36646. </member>
  36647. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String)">
  36648. <summary>
  36649. Gets the externSheet index for a sheet from this workbook
  36650. </summary>
  36651. <param name="sheetName">Name of the sheet.</param>
  36652. <returns></returns>
  36653. </member>
  36654. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String,System.String)">
  36655. <summary>
  36656. Gets the externSheet index for a sheet from an external workbook
  36657. </summary>
  36658. <param name="workbookName">Name of the workbook, e.g. "BudGet.xls"</param>
  36659. <param name="sheetName">a name of a sheet in that workbook</param>
  36660. <returns></returns>
  36661. </member>
  36662. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetSpreadsheetVersion">
  36663. <summary>
  36664. Returns an enum holding spReadhseet properties specific to an Excel version (
  36665. max column and row numbers, max arguments to a function, etc.)
  36666. </summary>
  36667. <returns></returns>
  36668. </member>
  36669. <member name="T:NPOI.SS.Formula.FormulaRenderer">
  36670. Common logic for rendering formulas.<br/>
  36671. For POI internal use only
  36672. @author Josh Micich
  36673. </member>
  36674. <member name="M:NPOI.SS.Formula.FormulaRenderer.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  36675. Static method To convert an array of {@link Ptg}s in RPN order
  36676. To a human readable string format in infix mode.
  36677. @param book used for defined names and 3D references
  36678. @param ptgs must not be <c>null</c>
  36679. @return a human readable String
  36680. </member>
  36681. <member name="T:NPOI.SS.Formula.IFormulaRenderingWorkbook">
  36682. Abstracts a workbook for the purpose of converting formula To text.<br/>
  36683. For POI internal use only
  36684. @author Josh Micich
  36685. </member>
  36686. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetExternalSheet(System.Int32)">
  36687. @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
  36688. </member>
  36689. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetFirstNameByExternSheet(System.Int32)">
  36690. @return the name of the (first) sheet referred to by the given external sheet index
  36691. </member>
  36692. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetLastNameByExternSheet(System.Int32)">
  36693. @return the name of the (last) sheet referred to by the given external sheet index
  36694. </member>
  36695. <member name="T:NPOI.SS.Formula.FormulaType">
  36696. Enumeration of various formula types.<br/>
  36697. For POI internal use only
  36698. @author Josh Micich
  36699. </member>
  36700. <member name="T:NPOI.SS.Formula.FormulaUsedBlankCellSet">
  36701. Optimisation - compacts many blank cell references used by a single formula.
  36702. @author Josh Micich
  36703. </member>
  36704. <member name="T:NPOI.SS.Formula.Function.FunctionDataBuilder">
  36705. Temporarily collects <c>FunctionMetadata</c> instances for creation of a
  36706. <c>FunctionMetadataRegistry</c>.
  36707. @author Josh Micich
  36708. </member>
  36709. <member name="F:NPOI.SS.Formula.Function.FunctionDataBuilder._mutatingFunctionIndexes">
  36710. stores indexes of all functions with footnotes (i.e. whose definitions might Change)
  36711. </member>
  36712. <member name="T:NPOI.SS.Formula.Function.FunctionMetadata">
  36713. Holds information about Excel built-in functions.
  36714. @author Josh Micich
  36715. </member>
  36716. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataReader">
  36717. Converts the text meta-data file into a <c>FunctionMetadataRegistry</c>
  36718. @author Josh Micich
  36719. </member>
  36720. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataReader.ELLIPSIS">
  36721. plain ASCII text metadata file uses three dots for ellipsis
  36722. </member>
  36723. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataReader.ValidateFunctionName(System.String)">
  36724. Makes sure that footnote digits from the original OOO document have not been accidentally
  36725. left behind
  36726. </member>
  36727. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataRegistry">
  36728. Allows clients to Get <c>FunctionMetadata</c> instances for any built-in function of Excel.
  36729. @author Josh Micich
  36730. </member>
  36731. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataRegistry.FUNCTION_NAME_IF">
  36732. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  36733. </member>
  36734. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataRegistry.LookupIndexByName(System.String)">
  36735. Resolves a built-in function index.
  36736. @param name uppercase function name
  36737. @return a negative value if the function name is not found.
  36738. This typically occurs for external functions.
  36739. </member>
  36740. <member name="T:NPOI.SS.Formula.ICacheEntry">
  36741. A (mostly) opaque interface To allow test clients To trace cache values
  36742. Each spreadsheet cell Gets one unique cache entry instance. These objects
  36743. are safe To use as keys in {@link java.util.HashMap}s
  36744. </member>
  36745. <member name="T:NPOI.SS.Formula.IEvaluationListener">
  36746. Tests can implement this class To track the internal working of the {@link WorkbookEvaluator}.<br/>
  36747. For POI internal testing use only
  36748. @author Josh Micich
  36749. </member>
  36750. <member name="M:NPOI.SS.Formula.IEvaluationListener.SortDependentCachedValues(NPOI.SS.Formula.ICacheEntry[])">
  36751. Internally, formula {@link ICacheEntry}s are stored in Sets which may Change ordering due
  36752. To seemingly trivial Changes. This method is provided To make the order of call-backs To
  36753. {@link #onClearDependentCachedValue(ICacheEntry, int)} more deterministic.
  36754. </member>
  36755. <member name="T:NPOI.SS.Formula.IStabilityClassifier">
  36756. Used to help optimise cell evaluation result caching by allowing applications to specify which
  36757. parts of a workbook are <em>final</em>.<br/>
  36758. The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.
  36759. This classification refers to potential actions (on the evaluated workbook) by the evaluating
  36760. application. It does not refer to operations performed by the evaluator ({@link
  36761. WorkbookEvaluator}).<br/>
  36762. <br/>
  36763. <b>General guidelines</b>:
  36764. <ul>
  36765. <li>a plain value cell can be marked as 'final' if it will not be changed after the first call
  36766. to {@link WorkbookEvaluator#evaluate(EvaluationCell)}.
  36767. </li>
  36768. <li>a formula cell can be marked as 'final' if its formula will not be changed after the first
  36769. call to {@link WorkbookEvaluator#evaluate(EvaluationCell)}. This remains true even if changes
  36770. in dependent values may cause the evaluated value to change.</li>
  36771. <li>plain value cells should be marked as 'not final' if their plain value value may change.
  36772. </li>
  36773. <li>formula cells should be marked as 'not final' if their formula definition may change.</li>
  36774. <li>cells which may switch between plain value and formula should also be marked as 'not final'.
  36775. </li>
  36776. </ul>
  36777. <b>Notes</b>:
  36778. <ul>
  36779. <li>If none of the spreadsheet cells is expected to have its definition changed after evaluation
  36780. begins, every cell can be marked as 'final'. This is the most efficient / least resource
  36781. intensive option.</li>
  36782. <li>To retain freedom to change any cell definition at any time, an application may classify all
  36783. cells as 'not final'. This freedom comes at the expense of greater memory consumption.</li>
  36784. <li>For the purpose of these classifications, setting the cached formula result of a cell (for
  36785. example in {@link HSSFFormulaEvaluator#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)})
  36786. does not constitute changing the definition of the cell.</li>
  36787. <li>Updating cells which have been classified as 'final' will cause the evaluator to behave
  36788. unpredictably (typically ignoring the update).</li>
  36789. </ul>
  36790. @author Josh Micich
  36791. </member>
  36792. <member name="F:NPOI.SS.Formula.IStabilityClassifier.TOTALLY_IMMUTABLE">
  36793. Convenience implementation for situations where all cell definitions remain fixed after
  36794. evaluation begins.
  36795. </member>
  36796. <member name="M:NPOI.SS.Formula.IStabilityClassifier.IsCellFinal(System.Int32,System.Int32,System.Int32)">
  36797. Checks if a cell's value(/formula) is fixed - in other words - not expected to be modified
  36798. between calls to the evaluator. (Note - this is an independent concept from whether a
  36799. formula cell's evaluated value may change during successive calls to the evaluator).
  36800. @param sheetIndex zero based index into workbook sheet list
  36801. @param rowIndex zero based row index of cell
  36802. @param columnIndex zero based column index of cell
  36803. @return <c>false</c> if the evaluating application may need to modify the specified
  36804. cell between calls to the evaluator.
  36805. </member>
  36806. <member name="T:NPOI.SS.Formula.LazyAreaEval">
  36807. Provides Lazy Evaluation to 3D Ranges
  36808. </member>
  36809. <member name="M:NPOI.SS.Formula.LazyAreaEval.IsSubTotal(System.Int32,System.Int32)">
  36810. @return whether cell at rowIndex and columnIndex is a subtotal
  36811. </member>
  36812. <member name="T:NPOI.SS.Formula.LazyRefEval">
  36813. Provides Lazy Evaluation to a 3D Reference
  36814. TODO Provide access to multiple sheets where present
  36815. </member>
  36816. <member name="T:NPOI.SS.Formula.OperandClassTransformer">
  36817. This class performs 'operand class' transformation. Non-base Tokens are classified into three
  36818. operand classes:
  36819. <ul>
  36820. <li>reference</li>
  36821. <li>value</li>
  36822. <li>array</li>
  36823. </ul>
  36824. <p/>
  36825. The operand class chosen for each Token depends on the formula type and the Token's place
  36826. in the formula. If POI Gets the operand class wrong, Excel <em>may</em> interpret the formula
  36827. incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!',
  36828. but resolves correctly when the user presses F2, enter.<p/>
  36829. The logic implemented here was partially inspired by the description in
  36830. "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there
  36831. seems To be inconsistent with observed Excel behaviour (These differences have not been fully
  36832. investigated). The implementation in this class Has been heavily modified in order To satisfy
  36833. concrete examples of how Excel performs the same logic (see TestRVA).<p/>
  36834. Hopefully, as Additional important test cases are identified and Added To the test suite,
  36835. patterns might become more obvious in this code and allow for simplification.
  36836. @author Josh Micich
  36837. </member>
  36838. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformFormula(NPOI.SS.Formula.ParseNode)">
  36839. Traverses the supplied formula parse tree, calling <c>Ptg.SetClass()</c> for each non-base
  36840. Token To Set its operand class.
  36841. </member>
  36842. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformNode(NPOI.SS.Formula.ParseNode,System.Byte,System.Boolean)">
  36843. @param callerForceArrayFlag <c>true</c> if one of the current node's parents is a
  36844. function Ptg which Has been Changed from default 'V' To 'A' type (due To requirements on
  36845. the function return value).
  36846. </member>
  36847. <member name="T:NPOI.SS.Formula.OperationEvaluationContext">
  36848. Contains all the contextual information required to Evaluate an operation
  36849. within a formula
  36850. For POI internal use only
  36851. @author Josh Micich
  36852. </member>
  36853. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.CreateExternSheetRefEvaluator(System.String,System.String)">
  36854. @return <code>null</code> if either workbook or sheet is not found
  36855. </member>
  36856. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.GetDynamicReference(System.String,System.String,System.String,System.String,System.Boolean)">
  36857. Resolves a cell or area reference dynamically.
  36858. @param workbookName the name of the workbook Containing the reference. If <code>null</code>
  36859. the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
  36860. a {@link CollaboratingWorkbooksEnvironment} must be set up.
  36861. @param sheetName the name of the sheet Containing the reference. May be <code>null</code>
  36862. (when <c>workbookName</c> is also null) in which case the current workbook and sheet is
  36863. assumed.
  36864. @param refStrPart1 the single cell reference or first part of the area reference. Must not
  36865. be <code>null</code>.
  36866. @param refStrPart2 the second part of the area reference. For single cell references this
  36867. parameter must be <code>null</code>
  36868. @param isA1Style specifies the format for <c>refStrPart1</c> and <c>refStrPart2</c>.
  36869. Pass <c>true</c> for 'A1' style and <c>false</c> for 'R1C1' style.
  36870. TODO - currently POI only supports 'A1' reference style
  36871. @return a {@link RefEval} or {@link AreaEval}
  36872. </member>
  36873. <member name="T:NPOI.SS.Formula.OperationEvaluatorFactory">
  36874. This class Creates <c>OperationEval</c> instances To help evaluate <c>OperationPtg</c>
  36875. formula Tokens.
  36876. @author Josh Micich
  36877. </member>
  36878. <member name="M:NPOI.SS.Formula.OperationEvaluatorFactory.Evaluate(NPOI.SS.Formula.PTG.OperationPtg,NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  36879. returns the OperationEval concrete impl instance corresponding
  36880. to the supplied operationPtg
  36881. </member>
  36882. <member name="T:NPOI.SS.Formula.ParseNode">
  36883. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  36884. Token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  36885. <c>Ptg</c> is non-atomic.
  36886. </member>
  36887. <member name="M:NPOI.SS.Formula.ParseNode.ToTokenArray(NPOI.SS.Formula.ParseNode)">
  36888. Collects the array of <c>Ptg</c> Tokens for the specified tree.
  36889. </member>
  36890. <member name="M:NPOI.SS.Formula.ParseNode.CollectIfPtgs(NPOI.SS.Formula.ParseNode.TokenCollector)">
  36891. The IF() function Gets marked up with two or three tAttr Tokens.
  36892. Similar logic will be required for CHOOSE() when it is supported
  36893. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  36894. </member>
  36895. <member name="T:NPOI.SS.Formula.PlainCellCache">
  36896. @author Josh Micich
  36897. </member>
  36898. <member name="T:NPOI.SS.Formula.PlainValueCellCacheEntry">
  36899. Used for non-formula cells, primarily To keep track of the referencing (formula) cells.
  36900. @author Josh Micich
  36901. </member>
  36902. <member name="T:NPOI.SS.Formula.FormulaShifter">
  36903. @author Josh Micich
  36904. </member>
  36905. <member name="F:NPOI.SS.Formula.FormulaShifter._externSheetIndex">
  36906. Extern sheet index of sheet where moving is occurring
  36907. </member>
  36908. <member name="F:NPOI.SS.Formula.FormulaShifter._sheetName">
  36909. Sheet name of the sheet where moving is occurring,
  36910. used for updating XSSF style 3D references on row shifts.
  36911. </member>
  36912. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.String,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.FormulaShifter.ShiftMode,NPOI.SS.SpreadsheetVersion)">
  36913. Create an instance for Shifting row.
  36914. For example, this will be called on {@link NPOI.HSSF.UserModel.HSSFSheet#ShiftRows(int, int, int)} }
  36915. </member>
  36916. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.Int32)">
  36917. Create an instance for shifting sheets.
  36918. For example, this will be called on {@link org.apache.poi.hssf.usermodel.HSSFWorkbook#setSheetOrder(String, int)}
  36919. </member>
  36920. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustFormula(NPOI.SS.Formula.PTG.Ptg[],System.Int32)">
  36921. @param ptgs - if necessary, will get modified by this method
  36922. @param currentExternSheetIx - the extern sheet index of the sheet that contains the formula being adjusted
  36923. @return <c>true</c> if a change was made to the formula tokens
  36924. </member>
  36925. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowMove(NPOI.SS.Formula.PTG.Ptg,System.Int32)">
  36926. <summary>
  36927. </summary>
  36928. <param name="ptg"></param>
  36929. <param name="currentExternSheetIx"></param>
  36930. <returns>in-place modified ptg (if row move would cause Ptg to change),
  36931. deleted ref ptg (if row move causes an error),
  36932. or null (if no Ptg change is needed)</returns>
  36933. </member>
  36934. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowCopy(NPOI.SS.Formula.PTG.Ptg)">
  36935. Call this on any ptg reference contained in a row of cells that was copied.
  36936. If the ptg reference is relative, the references will be shifted by the distance
  36937. that the rows were copied.
  36938. In the future similar functions could be written due to column copying or
  36939. individual cell copying. Just make sure to only call adjustPtgDueToRowCopy on
  36940. formula cells that are copied (unless row shifting, where references outside
  36941. of the shifted region need to be updated to reflect the shift, a copy is self-contained).
  36942. @param ptg the ptg to shift
  36943. @return deleted ref ptg, in-place modified ptg, or null
  36944. If Ptg would be shifted off the first or last row of a sheet, return deleted ref
  36945. If Ptg needs to be changed, modifies Ptg in-place
  36946. If Ptg doesn't need to be changed, returns <code>null</code>
  36947. </member>
  36948. <member name="M:NPOI.SS.Formula.FormulaShifter.RowCopyRefPtg(NPOI.SS.Formula.PTG.RefPtgBase)">
  36949. Modifies rptg in-place and return a reference to rptg if the cell reference
  36950. would move due to a row copy operation
  36951. Returns <code>null</code> or {@link #RefErrorPtg} if no change was made
  36952. @param aptg
  36953. @return
  36954. </member>
  36955. <member name="M:NPOI.SS.Formula.FormulaShifter.RowCopyAreaPtg(NPOI.SS.Formula.PTG.AreaPtgBase)">
  36956. Modifies aptg in-place and return a reference to aptg if the first or last row of
  36957. of the Area reference would move due to a row copy operation
  36958. Returns <code>null</code> or {@link #AreaErrPtg} if no change was made
  36959. @param aptg
  36960. @return null, AreaErrPtg, or modified aptg
  36961. </member>
  36962. <member name="T:NPOI.SS.Formula.SheetNameFormatter">
  36963. Formats sheet names for use in formula expressions.
  36964. @author Josh Micich
  36965. </member>
  36966. <member name="M:NPOI.SS.Formula.SheetNameFormatter.Format(System.String)">
  36967. Used to format sheet names as they would appear in cell formula expressions.
  36968. @return the sheet name UnChanged if there is no need for delimiting. Otherwise the sheet
  36969. name is enclosed in single quotes ('). Any single quotes which were already present in the
  36970. sheet name will be converted to double single quotes ('').
  36971. </member>
  36972. <member name="M:NPOI.SS.Formula.SheetNameFormatter.AppendFormat(System.Text.StringBuilder,System.String)">
  36973. Convenience method for when a StringBuilder is already available
  36974. @param out - sheet name will be Appended here possibly with delimiting quotes
  36975. </member>
  36976. <member name="M:NPOI.SS.Formula.SheetNameFormatter.IsSpecialChar(System.Char)">
  36977. @return <c>true</c> if the presence of the specified Char in a sheet name would
  36978. require the sheet name to be delimited in formulas. This includes every non-alphanumeric
  36979. Char besides Underscore '_'.
  36980. </member>
  36981. <member name="M:NPOI.SS.Formula.SheetNameFormatter.CellReferenceIsWithinRange(System.String,System.String)">
  36982. Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they
  36983. look like cell references.
  36984. <p/>
  36985. This code is currently being used for translating formulas represented with <code>Ptg</code>
  36986. tokens into human readable text form. In formula expressions, a sheet name always has a
  36987. trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
  36988. method returns but it is worth noting the likely consumers of these formula text strings:
  36989. <ol>
  36990. <li>POI's own formula parser</li>
  36991. <li>Visual reading by human</li>
  36992. <li>VBA automation entry into Excel cell contents e.g. ActiveCell.Formula = "=c64!A1"</li>
  36993. <li>Manual entry into Excel cell contents</li>
  36994. <li>Some third party formula parser</li>
  36995. </ol>
  36996. At the time of writing, POI's formula parser tolerates cell-like sheet names in formulas
  36997. with or without delimiters. The same goes for Excel(2007), both manual and automated entry.
  36998. <p/>
  36999. For better or worse this implementation attempts to replicate Excel's formula renderer.
  37000. Excel uses range checking on the apparent 'row' and 'column' components. Note however that
  37001. the maximum sheet size varies across versions.
  37002. @see org.apache.poi.hssf.util.CellReference
  37003. </member>
  37004. <member name="M:NPOI.SS.Formula.SheetNameFormatter.NameLooksLikePlainCellReference(System.String)">
  37005. Note - this method assumes the specified rawSheetName has only letters and digits. It
  37006. cannot be used to match absolute or range references (using the dollar or colon char).
  37007. Some notable cases:
  37008. <blockquote><table border="0" cellpAdding="1" cellspacing="0"
  37009. summary="Notable cases.">
  37010. <tr><th>Input </th><th>Result </th><th>Comments</th></tr>
  37011. <tr><td>"A1" </td><td>true</td><td> </td></tr>
  37012. <tr><td>"a111" </td><td>true</td><td> </td></tr>
  37013. <tr><td>"AA" </td><td>false</td><td> </td></tr>
  37014. <tr><td>"aa1" </td><td>true</td><td> </td></tr>
  37015. <tr><td>"A1A" </td><td>false</td><td> </td></tr>
  37016. <tr><td>"A1A1" </td><td>false</td><td> </td></tr>
  37017. <tr><td>"A$1:$C$20" </td><td>false</td><td>Not a plain cell reference</td></tr>
  37018. <tr><td>"SALES20080101" </td><td>true</td>
  37019. <td>Still needs delimiting even though well out of range</td></tr>
  37020. </table></blockquote>
  37021. @return <c>true</c> if there is any possible ambiguity that the specified rawSheetName
  37022. could be interpreted as a valid cell name.
  37023. </member>
  37024. <member name="T:NPOI.SS.Formula.SheetRefEvaluator">
  37025. @author Josh Micich
  37026. </member>
  37027. <member name="M:NPOI.SS.Formula.SheetRefEvaluator.IsSubTotal(System.Int32,System.Int32)">
  37028. @return whether cell at rowIndex and columnIndex is a subtotal
  37029. @see org.apache.poi.ss.formula.functions.Subtotal
  37030. </member>
  37031. <member name="T:NPOI.SS.Formula.WorkbookDependentFormula">
  37032. Should be implemented by any {@link Ptg} subclass that needs a workbook To render its formula.
  37033. <br/>
  37034. For POI internal use only
  37035. @author Josh Micich
  37036. </member>
  37037. <member name="T:NPOI.SS.Formula.WorkbookEvaluator">
  37038. Evaluates formula cells.<p/>
  37039. For performance reasons, this class keeps a cache of all previously calculated intermediate
  37040. cell values. Be sure To call {@link #ClearCache()} if any workbook cells are Changed between
  37041. calls To evaluate~ methods on this class.<br/>
  37042. For POI internal use only
  37043. @author Josh Micich
  37044. </member>
  37045. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetName(System.Int32)">
  37046. also for debug use. Used in ToString methods
  37047. </member>
  37048. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.ClearAllCachedResultValues">
  37049. Should be called whenever there are Changes To input cells in the evaluated workbook.
  37050. Failure To call this method after changing cell values will cause incorrect behaviour
  37051. of the evaluate~ methods of this class
  37052. </member>
  37053. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyUpdateCell(NPOI.SS.Formula.IEvaluationCell)">
  37054. Should be called To tell the cell value cache that the specified (value or formula) cell
  37055. Has Changed.
  37056. </member>
  37057. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyDeleteCell(NPOI.SS.Formula.IEvaluationCell)">
  37058. Should be called To tell the cell value cache that the specified cell Has just been
  37059. deleted.
  37060. </member>
  37061. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetIndex(System.String)">
  37062. Case-insensitive.
  37063. @return -1 if sheet with specified name does not exist
  37064. </member>
  37065. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateAny(NPOI.SS.Formula.IEvaluationCell,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  37066. @return never <c>null</c>, never {@link BlankEval}
  37067. </member>
  37068. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.AddExceptionInfo(System.NotImplementedException,System.Int32,System.Int32,System.Int32)">
  37069. Adds the current cell reference to the exception for easier debugging.
  37070. Would be nice to get the formula text as well, but that seems to require
  37071. too much digging around and casting to get the FormulaRenderingWorkbook.
  37072. </member>
  37073. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetValueFromNonFormulaCell(NPOI.SS.Formula.IEvaluationCell)">
  37074. Gets the value from a non-formula cell.
  37075. @param cell may be <c>null</c>
  37076. @return {@link BlankEval} if cell is <c>null</c> or blank, never <c>null</c>
  37077. </member>
  37078. <member name="F:NPOI.SS.Formula.WorkbookEvaluator.dbgEvaluationOutputForNextEval">
  37079. whether print detailed messages about the next formula evaluation
  37080. </member>
  37081. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.CountTokensToBeSkipped(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  37082. Calculates the number of tokens that the evaluator should skip upon reaching a tAttrSkip.
  37083. @return the number of tokens (starting from <c>startIndex+1</c>) that need to be skipped
  37084. to achieve the specified <c>distInBytes</c> skip distance.
  37085. </member>
  37086. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.DereferenceResult(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  37087. Dereferences a single value from any AreaEval or RefEval evaluation result.
  37088. If the supplied evaluationResult is just a plain value, it is returned as-is.
  37089. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>,
  37090. <c>BlankEval</c> or <c>ErrorEval</c>. Never <c>null</c>.
  37091. </member>
  37092. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetEvalForPtg(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.OperationEvaluationContext)">
  37093. returns an appropriate Eval impl instance for the Ptg. The Ptg must be
  37094. one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg,
  37095. StringPtg, BoolPtg <br/>special Note: OperationPtg subtypes cannot be
  37096. passed here!
  37097. </member>
  37098. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateReference(NPOI.SS.Formula.IEvaluationSheet,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  37099. Used by the lazy ref evals whenever they need To Get the value of a contained cell.
  37100. </member>
  37101. <member name="P:NPOI.SS.Formula.WorkbookEvaluator.IgnoreMissingWorkbooks">
  37102. Whether to ignore missing references to external workbooks and
  37103. use cached formula results in the main workbook instead.
  37104. <p>
  37105. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  37106. With this method you can control how POI handles such missing references:
  37107. <ul>
  37108. <li>by default ignoreMissingWorkbooks=false and POI throws {@link WorkbookNotFoundException}
  37109. if an external reference cannot be resolved</li>
  37110. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  37111. that already exists in the main workbook</li>
  37112. </ul>
  37113. </p>
  37114. @param ignore whether to ignore missing references to external workbooks
  37115. @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575 for details</a>
  37116. </member>
  37117. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSupportedFunctionNames">
  37118. Return a collection of functions that POI can evaluate
  37119. @return names of functions supported by POI
  37120. </member>
  37121. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetNotSupportedFunctionNames">
  37122. Return a collection of functions that POI does not support
  37123. @return names of functions NOT supported by POI
  37124. </member>
  37125. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  37126. Register a ATP function in runtime.
  37127. @param name the function name
  37128. @param func the functoin to register
  37129. @throws IllegalArgumentException if the function is unknown or already registered.
  37130. @since 3.8 beta6
  37131. </member>
  37132. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  37133. Register a function in runtime.
  37134. @param name the function name
  37135. @param func the functoin to register
  37136. @throws IllegalArgumentException if the function is unknown or already registered.
  37137. @since 3.8 beta6
  37138. </member>
  37139. <member name="T:NPOI.SS.UserModel.Helpers.RowShifter">
  37140. Helper for Shifting rows up or down
  37141. This abstract class exists to consolidate duplicated code between XSSFRowShifter and HSSFRowShifter (currently methods sprinkled throughout HSSFSheet)
  37142. </member>
  37143. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.ShiftMergedRegions(System.Int32,System.Int32,System.Int32)">
  37144. Shifts, grows, or shrinks the merged regions due to a row Shift.
  37145. Merged regions that are completely overlaid by Shifting will be deleted.
  37146. @param startRow the row to start Shifting
  37147. @param endRow the row to end Shifting
  37148. @param n the number of rows to shift
  37149. @return an array of affected merged regions, doesn't contain deleted ones
  37150. </member>
  37151. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateNamedRanges(NPOI.SS.Formula.FormulaShifter)">
  37152. Updated named ranges
  37153. </member>
  37154. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateFormulas(NPOI.SS.Formula.FormulaShifter)">
  37155. Update formulas.
  37156. </member>
  37157. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateRowFormulas(NPOI.SS.UserModel.IRow,NPOI.SS.Formula.FormulaShifter)">
  37158. Update the formulas in specified row using the formula Shifting policy specified by Shifter
  37159. @param row the row to update the formulas on
  37160. @param Shifter the formula Shifting policy
  37161. </member>
  37162. <member name="M:NPOI.SS.UserModel.Helpers.RowShifter.UpdateHyperlinks(NPOI.SS.Formula.FormulaShifter)">
  37163. Shift the Hyperlink anchors (not the hyperlink text, even if the hyperlink
  37164. is of type LINK_DOCUMENT and refers to a cell that was Shifted). Hyperlinks
  37165. do not track the content they point to.
  37166. @param Shifter the formula Shifting policy
  37167. </member>
  37168. <member name="F:NPOI.SS.UserModel.BorderDiagonal.None">
  37169. <summary>
  37170. No diagional border
  37171. </summary>
  37172. </member>
  37173. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Backward">
  37174. <summary>
  37175. Backward diagional border, from left-top to right-bottom
  37176. </summary>
  37177. </member>
  37178. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Forward">
  37179. <summary>
  37180. Forward diagional border, from right-top to left-bottom
  37181. </summary>
  37182. </member>
  37183. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Both">
  37184. <summary>
  37185. Both forward and backward diagional border
  37186. </summary>
  37187. </member>
  37188. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.#ctor">
  37189. Default CellCopyPolicy, uses default policy
  37190. For custom CellCopyPolicy, use {@link Builder} class
  37191. </member>
  37192. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.#ctor(NPOI.SS.UserModel.CellCopyPolicy)">
  37193. Copy constructor
  37194. @param other policy to copy
  37195. </member>
  37196. <member name="M:NPOI.SS.UserModel.CellCopyPolicy.Builder.#ctor">
  37197. Builder class for CellCopyPolicy
  37198. </member>
  37199. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellValue">
  37200. @return the copyCellValue
  37201. </member>
  37202. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellStyle">
  37203. @return the copyCellStyle
  37204. </member>
  37205. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyCellFormula">
  37206. @return the copyCellFormula
  37207. </member>
  37208. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyHyperlink">
  37209. @return the copyHyperlink
  37210. </member>
  37211. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsMergeHyperlink">
  37212. @return the mergeHyperlink
  37213. </member>
  37214. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyRowHeight">
  37215. @return the copyRowHeight
  37216. </member>
  37217. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCondenseRows">
  37218. If condenseRows is true, a discontinuities in srcRows will be Removed when copied to destination
  37219. For example:
  37220. Sheet.CopyRows({Row(1), Row(2), Row(5)}, 11, policy) results in rows 1, 2, and 5
  37221. being copied to rows 11, 12, and 13 if condenseRows is True, or rows 11, 11, 15 if condenseRows is false
  37222. @return the condenseRows
  37223. </member>
  37224. <member name="P:NPOI.SS.UserModel.CellCopyPolicy.IsCopyMergedRegions">
  37225. @return the copyMergedRegions
  37226. </member>
  37227. <member name="T:NPOI.SS.UserModel.Charts.IBarChartData`2">
  37228. <summary>
  37229. Data for a Bar Chart
  37230. </summary>
  37231. <typeparam name="Tx"></typeparam>
  37232. <typeparam name="Ty"></typeparam>
  37233. </member>
  37234. <member name="M:NPOI.SS.UserModel.Charts.IBarChartData`2.GetSeries">
  37235. @return list of all series.
  37236. </member>
  37237. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetCategoryAxisData">
  37238. @return data source used for category axis data.
  37239. </member>
  37240. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetValues">
  37241. @return data source used for value axis.
  37242. </member>
  37243. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.PointCount">
  37244. Return number of points contained by data source.
  37245. @return number of points contained by data source
  37246. </member>
  37247. <member name="M:NPOI.SS.UserModel.Charts.IChartDataSource`1.GetPointAt(System.Int32)">
  37248. Returns point value at specified index.
  37249. @param index index to value from
  37250. @return point value at specified index.
  37251. @throws {@code IndexOutOfBoundsException} if index
  37252. parameter not in range {@code 0 &lt;= index &lt;= pointCount}
  37253. </member>
  37254. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsReference">
  37255. Returns {@code true} if charts data source is valid cell range.
  37256. @return {@code true} if charts data source is valid cell range
  37257. </member>
  37258. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsNumeric">
  37259. Returns {@code true} if data source points should be treated as numbers.
  37260. @return {@code true} if data source points should be treated as numbers
  37261. </member>
  37262. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.FormulaString">
  37263. Returns formula representation of the data source. It is only applicable
  37264. for data source that is valid cell range.
  37265. @return formula representation of the data source
  37266. @throws {@code UnsupportedOperationException} if the data source is not a
  37267. reference.
  37268. </member>
  37269. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(System.String)">
  37270. Sets the title of the series as a string literal.
  37271. @param title
  37272. </member>
  37273. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(NPOI.SS.Util.CellReference)">
  37274. Sets the title of the series as a cell reference.
  37275. @param titleReference
  37276. </member>
  37277. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleString">
  37278. @return title as string literal.
  37279. </member>
  37280. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleCellReference">
  37281. @return title as cell reference.
  37282. </member>
  37283. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleType">
  37284. @return title type.
  37285. </member>
  37286. <member name="T:NPOI.SS.UserModel.Charts.ILineChartData`2">
  37287. <summary>
  37288. Data for a Line Chart
  37289. </summary>
  37290. <typeparam name="Tx"></typeparam>
  37291. <typeparam name="Ty"></typeparam>
  37292. </member>
  37293. <member name="M:NPOI.SS.UserModel.Charts.ILineChartData`2.GetSeries">
  37294. @return list of all series.
  37295. </member>
  37296. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetCategoryAxisData">
  37297. @return data source used for category axis data.
  37298. </member>
  37299. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetValues">
  37300. @return data source used for value axis.
  37301. </member>
  37302. <member name="T:NPOI.SS.UserModel.Charts.AxisCrossBetween">
  37303. Specifies the possible crossing states of an axis.
  37304. @author Roman Kashitsyn
  37305. </member>
  37306. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.Between">
  37307. Specifies the value axis shall cross the category axis
  37308. between data markers.
  37309. </member>
  37310. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.MidpointCategory">
  37311. Specifies the value axis shall cross the category axis at
  37312. the midpoint of a category.
  37313. </member>
  37314. <member name="T:NPOI.SS.UserModel.Charts.AxisCrosses">
  37315. Specifies the possible crossing points for an axis.
  37316. @author Roman Kashitsyn
  37317. </member>
  37318. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.AutoZero">
  37319. The category axis crosses at the zero point of the value axis (if
  37320. possible), or the minimum value (if the minimum is greater than zero) or
  37321. the maximum (if the maximum is less than zero).
  37322. </member>
  37323. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Min">
  37324. The axis crosses at the maximum value.
  37325. </member>
  37326. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Max">
  37327. Axis crosses at the minimum value of the chart.
  37328. </member>
  37329. <member name="T:NPOI.SS.UserModel.Charts.AxisOrientation">
  37330. Specifies the possible ways to place a picture on a data point, series, wall, or floor.
  37331. @author Roman Kashitsyn
  37332. </member>
  37333. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MaxToMin">
  37334. Specifies that the values on the axis shall be reversed
  37335. so they go from maximum to minimum.
  37336. </member>
  37337. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MinToMax">
  37338. Specifies that the axis values shall be in the usual
  37339. order, minimum to maximum.
  37340. </member>
  37341. <member name="T:NPOI.SS.UserModel.Charts.AxisPosition">
  37342. Enumeration of all possible axis positions.
  37343. @author Roman Kashitsyn
  37344. </member>
  37345. <member name="T:NPOI.SS.UserModel.Charts.IChartAxis">
  37346. High level representation of chart axis.
  37347. @author Roman Kashitsyn
  37348. </member>
  37349. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Id">
  37350. @return axis id
  37351. </member>
  37352. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Position">
  37353. get or set axis position
  37354. </member>
  37355. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.NumberFormat">
  37356. get or set axis number format
  37357. </member>
  37358. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetLogBase">
  37359. @return true if log base is defined, false otherwise
  37360. </member>
  37361. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.LogBase">
  37362. @param logBase a number between 2 and 1000 (inclusive)
  37363. @return axis log base or 0.0 if not Set
  37364. @throws ArgumentException if log base not within allowed range
  37365. </member>
  37366. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMinimum">
  37367. @return true if minimum value is defined, false otherwise
  37368. </member>
  37369. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Minimum">
  37370. get or set axis minimum
  37371. 0.0 if not Set
  37372. </member>
  37373. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMaximum">
  37374. @return true if maximum value is defined, false otherwise
  37375. </member>
  37376. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Maximum">
  37377. get or set axis maximum
  37378. 0.0 if not Set
  37379. </member>
  37380. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Orientation">
  37381. get or set axis orientation
  37382. </member>
  37383. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Crosses">
  37384. get or set axis cross type
  37385. </member>
  37386. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.CrossAxis(NPOI.SS.UserModel.Charts.IChartAxis)">
  37387. Declare this axis cross another axis.
  37388. @param axis that this axis should cross
  37389. </member>
  37390. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsVisible">
  37391. @return visibility of the axis.
  37392. </member>
  37393. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MajorTickMark">
  37394. @return major tick mark.
  37395. </member>
  37396. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MinorTickMark">
  37397. @return minor tick mark.
  37398. </member>
  37399. <member name="T:NPOI.SS.UserModel.Charts.IChartAxisFactory">
  37400. <summary>
  37401. A factory for different chart axis.
  37402. </summary>
  37403. <remarks>@author Roman Kashitsyn</remarks>
  37404. </member>
  37405. <member name="M:NPOI.SS.UserModel.Charts.IChartAxisFactory.CreateValueAxis(NPOI.SS.UserModel.Charts.AxisPosition)">
  37406. <summary>
  37407. returns new value axis
  37408. </summary>
  37409. <param name="pos"></param>
  37410. <returns></returns>
  37411. </member>
  37412. <member name="T:NPOI.SS.UserModel.Charts.IChartData">
  37413. <summary>
  37414. A base for all chart data types.
  37415. </summary>
  37416. <remarks>
  37417. @author Roman Kashitsyn
  37418. </remarks>
  37419. </member>
  37420. <member name="M:NPOI.SS.UserModel.Charts.IChartData.FillChart(NPOI.SS.UserModel.IChart,NPOI.SS.UserModel.Charts.IChartAxis[])">
  37421. <summary>
  37422. Fills a chart with data specified by implementation.
  37423. </summary>
  37424. <param name="chart">a chart to fill in</param>
  37425. <param name="axis">chart axis to use</param>
  37426. </member>
  37427. <member name="T:NPOI.SS.UserModel.Charts.IChartDataFactory">
  37428. <summary>
  37429. A factory for different chart data types.
  37430. </summary>
  37431. <remarks>
  37432. @author Roman Kashitsyn
  37433. </remarks>
  37434. </member>
  37435. <member name="M:NPOI.SS.UserModel.Charts.IChartDataFactory.CreateScatterChartData``2">
  37436. <summary>
  37437. returns an appropriate ScatterChartData instance
  37438. </summary>
  37439. <returns></returns>
  37440. </member>
  37441. <member name="T:NPOI.SS.UserModel.Charts.IChartLegend">
  37442. <summary>
  37443. High level representation of chart legend.
  37444. </summary>
  37445. <remarks>@author Roman Kashitsyn</remarks>
  37446. </member>
  37447. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.Position">
  37448. <summary>
  37449. legend position
  37450. </summary>
  37451. <returns></returns>
  37452. </member>
  37453. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.IsOverlay">
  37454. <summary>
  37455. If true the legend is positioned over the chart area otherwise
  37456. the legend is displayed next to it.
  37457. Default is no overlay.
  37458. </summary>
  37459. </member>
  37460. <member name="T:NPOI.SS.UserModel.Charts.LayoutMode">
  37461. <summary>
  37462. Specifies the possible ways to store a chart element's position.
  37463. </summary>
  37464. <remarks>
  37465. @author Roman Kashitsyn
  37466. </remarks>
  37467. </member>
  37468. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Edge">
  37469. <summary>
  37470. Specifies that the Width or Height shall be interpreted as the Right or Bottom of the chart element.
  37471. </summary>
  37472. </member>
  37473. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Factor">
  37474. <summary>
  37475. Specifies that the Width or Height shall be interpreted as the width or Height of the chart element.
  37476. </summary>
  37477. </member>
  37478. <member name="T:NPOI.SS.UserModel.Charts.LayoutTarget">
  37479. <summary>
  37480. Specifies whether to layout the plot area by its inside (not including axis
  37481. and axis labels) or outside (including axis and axis labels).
  37482. </summary>
  37483. <remarks>
  37484. @author Roman Kashitsyn
  37485. </remarks>
  37486. </member>
  37487. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Inner">
  37488. <summary>
  37489. Specifies that the plot area size shall determine the size of the plot area, not including the tick marks and axis labels.
  37490. </summary>
  37491. </member>
  37492. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Outer">
  37493. <summary>
  37494. Specifies that the plot area size shall determine the
  37495. size of the plot area, the tick marks, and the axis
  37496. labels.
  37497. </summary>
  37498. </member>
  37499. <member name="T:NPOI.SS.UserModel.Charts.LegendPosition">
  37500. <summary>
  37501. Enumeration of all possible chart legend positions.
  37502. </summary>
  37503. <remarks>
  37504. @author Roman Kashitsyn
  37505. </remarks>
  37506. </member>
  37507. <member name="T:NPOI.SS.UserModel.Charts.IManualLayout">
  37508. High level representation of chart element manual layout.
  37509. @author Roman Kashitsyn
  37510. </member>
  37511. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetTarget(NPOI.SS.UserModel.Charts.LayoutTarget)">
  37512. Sets the layout target.
  37513. @param target new layout target.
  37514. </member>
  37515. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetTarget">
  37516. Returns current layout target.
  37517. @return current layout target
  37518. </member>
  37519. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetXMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37520. Sets the x-coordinate layout mode.
  37521. @param mode new x-coordinate layout mode.
  37522. </member>
  37523. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetXMode">
  37524. Returns current x-coordinnate layout mode.
  37525. @return current x-coordinate layout mode.
  37526. </member>
  37527. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetYMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37528. Sets the y-coordinate layout mode.
  37529. @param mode new y-coordinate layout mode.
  37530. </member>
  37531. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetYMode">
  37532. Returns current y-coordinate layout mode.
  37533. @return current y-coordinate layout mode.
  37534. </member>
  37535. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetX">
  37536. Returns the x location of the chart element.
  37537. @return the x location (left) of the chart element or 0.0 if
  37538. not Set.
  37539. </member>
  37540. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetX(System.Double)">
  37541. Specifies the x location (left) of the chart element as a
  37542. fraction of the width of the chart. If Left Mode is Factor,
  37543. then the position is relative to the default position for the
  37544. chart element.
  37545. </member>
  37546. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetY">
  37547. Returns current y location of the chart element.
  37548. @return the y location (top) of the chart element or 0.0 if not
  37549. Set.
  37550. </member>
  37551. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetY(System.Double)">
  37552. Specifies the y location (top) of the chart element as a
  37553. fraction of the height of the chart. If Top Mode is Factor,
  37554. then the position is relative to the default position for the
  37555. chart element.
  37556. </member>
  37557. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37558. Specifies how to interpret the Width element for this manual
  37559. layout.
  37560. @param mode new width layout mode of this manual layout.
  37561. </member>
  37562. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthMode">
  37563. Returns current width mode of this manual layout.
  37564. @return width mode of this manual layout.
  37565. </member>
  37566. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37567. Specifies how to interpret the Height element for this manual
  37568. layout.
  37569. @param mode new height mode of this manual layout.
  37570. </member>
  37571. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightMode">
  37572. Returns current height mode of this
  37573. @return height mode of this manual layout.
  37574. </member>
  37575. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthRatio(System.Double)">
  37576. Specifies the width (if Width Mode is Factor) or right (if
  37577. Width Mode is Edge) of the chart element as a fraction of the
  37578. width of the chart.
  37579. @param ratio a fraction of the width of the chart.
  37580. </member>
  37581. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthRatio">
  37582. Returns current fraction of the width of the chart.
  37583. @return fraction of the width of the chart or 0.0 if not Set.
  37584. </member>
  37585. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightRatio(System.Double)">
  37586. Specifies the height (if Height Mode is Factor) or bottom (if
  37587. Height Mode is edge) of the chart element as a fraction of the
  37588. height of the chart.
  37589. @param ratio a fraction of the height of the chart.
  37590. </member>
  37591. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightRatio">
  37592. Returns current fraction of the height of the chart.
  37593. @return fraction of the height of the chart or 0.0 if not Set.
  37594. </member>
  37595. <member name="T:NPOI.SS.UserModel.Charts.ManuallyPositionable">
  37596. Abstraction of chart element that can be positioned with manual
  37597. layout.
  37598. @author Roman Kashitsyn
  37599. </member>
  37600. <member name="M:NPOI.SS.UserModel.Charts.ManuallyPositionable.GetManualLayout">
  37601. Returns manual layout for the chart element.
  37602. @return manual layout for the chart element.
  37603. </member>
  37604. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartData`2">
  37605. Data for a Scatter Chart
  37606. </member>
  37607. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  37608. @param xs data source to be used for X axis values
  37609. @param ys data source to be used for Y axis values
  37610. @return a new scatter charts series
  37611. </member>
  37612. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.GetSeries">
  37613. @return list of all series
  37614. </member>
  37615. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartSeries`2">
  37616. Represents scatter charts serie.
  37617. @author Roman Kashitsyn
  37618. </member>
  37619. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetXValues">
  37620. @return data source used for X axis values
  37621. </member>
  37622. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetYValues">
  37623. @return data source used for Y axis values
  37624. </member>
  37625. <member name="T:NPOI.SS.UserModel.Charts.IValueAxis">
  37626. @author Roman Kashitsyn
  37627. </member>
  37628. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.GetCrossBetween">
  37629. @return cross between type
  37630. </member>
  37631. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.SetCrossBetween(NPOI.SS.UserModel.Charts.AxisCrossBetween)">
  37632. @param crossBetween cross between type
  37633. </member>
  37634. <member name="T:NPOI.SS.UserModel.IColorScaleFormatting">
  37635. High level representation for the Color Scale / Colour Scale /
  37636. Color Gradient Formatting component of Conditional Formatting Settings
  37637. </member>
  37638. <!-- Badly formed XML comment ignored for member "P:NPOI.SS.UserModel.IColorScaleFormatting.NumControlPoints" -->
  37639. <member name="P:NPOI.SS.UserModel.IColorScaleFormatting.Colors">
  37640. get or sets the list of colours that are interpolated
  37641. between.The number must match {@link #getNumControlPoints()}
  37642. </member>
  37643. <member name="P:NPOI.SS.UserModel.IColorScaleFormatting.Thresholds">
  37644. Gets the list of thresholds
  37645. </member>
  37646. <member name="M:NPOI.SS.UserModel.IColorScaleFormatting.CreateThreshold">
  37647. Creates a new, empty Threshold
  37648. </member>
  37649. <member name="T:NPOI.SS.UserModel.IConditionalFormattingThreshold">
  37650. The Threshold / CFVO / Conditional Formatting Value Object.
  37651. <p>This defines how to calculate the ranges for a conditional
  37652. formatting rule, eg which values Get a Green Traffic Light
  37653. icon and which Yellow or Red.</p>
  37654. </member>
  37655. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.RangeType">
  37656. Get the Range Type used
  37657. </member>
  37658. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.Formula">
  37659. Changes the Range Type used
  37660. <p>If you change the range type, you need to
  37661. ensure that the Formula and Value parameters
  37662. are compatible with it before saving</p>
  37663. Formula to use to calculate the threshold,
  37664. or <code>null</code> if no formula
  37665. </member>
  37666. <member name="P:NPOI.SS.UserModel.IConditionalFormattingThreshold.Value">
  37667. Sets the formula used to calculate the threshold,
  37668. or unsets it if <code>null</code> is given.
  37669. Gets the value used for the threshold, or
  37670. <code>null</code> if there isn't one.
  37671. </member>
  37672. <member name="T:NPOI.SS.UserModel.ConditionType">
  37673. Represents a type of a conditional formatting rule
  37674. </member>
  37675. <member name="F:NPOI.SS.UserModel.ConditionType.CellValueIs">
  37676. This conditional formatting rule compares a cell value
  37677. to a formula calculated result, using an operator
  37678. </member>
  37679. <member name="F:NPOI.SS.UserModel.ConditionType.Formula">
  37680. This conditional formatting rule contains a formula to evaluate.
  37681. When the formula result is true, the cell is highlighted.
  37682. </member>
  37683. <member name="F:NPOI.SS.UserModel.ConditionType.ColorScale">
  37684. This conditional formatting rule contains a color scale,
  37685. with the cell background set according to a gradient.
  37686. </member>
  37687. <member name="F:NPOI.SS.UserModel.ConditionType.DataBar">
  37688. This conditional formatting rule sets a data bar, with the
  37689. cell populated with bars based on their values
  37690. </member>
  37691. <member name="F:NPOI.SS.UserModel.ConditionType.Filter">
  37692. This conditional formatting rule that files the values
  37693. </member>
  37694. <member name="F:NPOI.SS.UserModel.ConditionType.IconSet">
  37695. This conditional formatting rule sets a data bar, with the
  37696. cell populated with bars based on their values
  37697. </member>
  37698. <member name="T:NPOI.SS.UserModel.IDataBarFormatting">
  37699. High level representation for the DataBar Formatting
  37700. component of Conditional Formatting Settings
  37701. </member>
  37702. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.IsLeftToRight">
  37703. Is the bar Drawn from Left-to-Right, or from
  37704. Right-to-Left
  37705. </member>
  37706. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.IsIconOnly">
  37707. Should Icon + Value be displayed, or only the Icon?
  37708. </member>
  37709. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.WidthMin">
  37710. How much of the cell width, in %, should be given to
  37711. the min value?
  37712. </member>
  37713. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.WidthMax">
  37714. How much of the cell width, in %, should be given to
  37715. the max value?
  37716. </member>
  37717. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.MinThreshold">
  37718. The threshold that defines "everything from here down is minimum"
  37719. </member>
  37720. <member name="P:NPOI.SS.UserModel.IDataBarFormatting.MaxThreshold">
  37721. The threshold that defines "everything from here up is maximum"
  37722. </member>
  37723. <member name="T:NPOI.SS.UserModel.DataConsolidateFunction">
  37724. Enum mapping the values of STDataConsolidateFunction
  37725. </member>
  37726. <member name="T:NPOI.SS.UserModel.ExcelGeneralNumberFormat">
  37727. A format that formats a double as Excel would, ignoring FieldPosition.
  37728. All other operations are unsupported.
  37729. </member>
  37730. <member name="T:NPOI.SS.UserModel.ExtendedColor">
  37731. Represents a XSSF-style color (based on either a
  37732. {@link NPOI.XSSF.UserModel.XSSFColor} or a
  37733. {@link NPOI.HSSF.Record.Common.ExtendedColor}
  37734. </member>
  37735. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsAuto">
  37736. A bool value indicating the color is automatic
  37737. </member>
  37738. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsIndexed">
  37739. A bool value indicating the color is indexed
  37740. </member>
  37741. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsRGB">
  37742. A bool value indicating the color is RGB / ARGB
  37743. </member>
  37744. <member name="P:NPOI.SS.UserModel.ExtendedColor.IsThemed">
  37745. A bool value indicating the color is from a Theme
  37746. </member>
  37747. <member name="P:NPOI.SS.UserModel.ExtendedColor.Index">
  37748. Indexed Color value, if {@link #isIndexed()} is true
  37749. </member>
  37750. <member name="P:NPOI.SS.UserModel.ExtendedColor.Theme">
  37751. Index of Theme color, if {@link #isThemed()} is true
  37752. </member>
  37753. <member name="P:NPOI.SS.UserModel.ExtendedColor.RGB">
  37754. Standard Red Green Blue ctColor value (RGB).
  37755. If there was an A (Alpha) value, it will be stripped.
  37756. </member>
  37757. <member name="P:NPOI.SS.UserModel.ExtendedColor.ARGB">
  37758. Standard Alpha Red Green Blue ctColor value (ARGB).
  37759. </member>
  37760. <member name="P:NPOI.SS.UserModel.ExtendedColor.StoredRBG">
  37761. RGB or ARGB or null
  37762. </member>
  37763. <member name="P:NPOI.SS.UserModel.ExtendedColor.RGBWithTint">
  37764. Standard Red Green Blue ctColor value (RGB) with applied tint.
  37765. Alpha values are ignored.
  37766. </member>
  37767. <member name="P:NPOI.SS.UserModel.ExtendedColor.ARGBHex">
  37768. Return the ARGB value in hex format, eg FF00FF00.
  37769. Works for both regular and indexed colours.
  37770. Sets the ARGB value from hex format, eg FF0077FF.
  37771. Only works for regular (non-indexed) colours
  37772. </member>
  37773. <member name="P:NPOI.SS.UserModel.ExtendedColor.Tint">
  37774. Specifies the tint value applied to the ctColor.
  37775. <p>
  37776. If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final
  37777. ctColor applied.
  37778. </p>
  37779. <p>
  37780. The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and
  37781. 1.0 means 100% lighten. Also, 0.0 means no Change.
  37782. </p>
  37783. <p>
  37784. In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where
  37785. HLSMAX is currently 255.
  37786. </p>
  37787. Here are some examples of how to apply tint to ctColor:
  37788. <blockquote>
  37789. <pre>
  37790. If (tint &lt; 0)
  37791. Lum' = Lum * (1.0 + tint)
  37792. For example: Lum = 200; tint = -0.5; Darken 50%
  37793. Lum' = 200 * (0.5) =&gt; 100
  37794. For example: Lum = 200; tint = -1.0; Darken 100% (make black)
  37795. Lum' = 200 * (1.0-1.0) =&gt; 0
  37796. If (tint &gt; 0)
  37797. Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
  37798. For example: Lum = 100; tint = 0.75; Lighten 75%
  37799. Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
  37800. = 100 * .25 + (255 - 255 * .25)
  37801. = 25 + (255 - 63) = 25 + 192 = 217
  37802. For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
  37803. Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
  37804. = 100 * 0 + (255 - 255 * 0)
  37805. = 0 + (255 - 0) = 255
  37806. </pre>
  37807. </blockquote>
  37808. @return the tint value
  37809. </member>
  37810. <member name="T:NPOI.SS.UserModel.FontUnderline">
  37811. the different types of possible underline formatting
  37812. @author Gisella Bronzetti
  37813. </member>
  37814. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE">
  37815. Single-line underlining under each character in the cell.
  37816. The underline is drawn through the descenders of
  37817. characters such as g and p..
  37818. </member>
  37819. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE">
  37820. Double-line underlining under each character in the
  37821. cell. underlines are drawn through the descenders of
  37822. characters such as g and p.
  37823. </member>
  37824. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE_ACCOUNTING">
  37825. Single-line accounting underlining under each
  37826. character in the cell. The underline is drawn under the
  37827. descenders of characters such as g and p.
  37828. </member>
  37829. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE_ACCOUNTING">
  37830. Double-line accounting underlining under each
  37831. character in the cell. The underlines are drawn under
  37832. the descenders of characters such as g and p.
  37833. </member>
  37834. <member name="F:NPOI.SS.UserModel.FontUnderline.NONE">
  37835. No underline.
  37836. </member>
  37837. <member name="T:NPOI.SS.UserModel.FractionFormat">
  37838. <p>Format class that handles Excel style fractions, such as "# #/#" and "#/###"</p>
  37839. <p>As of this writing, this is still not 100% accurate, but it does a reasonable job
  37840. of trying to mimic Excel's fraction calculations. It does not currently
  37841. maintain Excel's spacing.</p>
  37842. <p>This class relies on a method lifted nearly verbatim from org.apache.math.fraction.
  37843. If further uses for Commons Math are found, we will consider Adding it as a dependency.
  37844. For now, we have in-lined the one method to keep things simple.</p>
  37845. </member>
  37846. <member name="M:NPOI.SS.UserModel.FractionFormat.#ctor(System.String,System.String)">
  37847. Single parameter ctor
  37848. @param denomFormatString The format string for the denominator
  37849. </member>
  37850. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.IconSet">
  37851. <summary>
  37852. Get or set the Icon Set used
  37853. </summary>
  37854. </member>
  37855. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.IsIconOnly">
  37856. Changes the Icon Set used
  37857. <p>If the new Icon Set has a different number of
  37858. icons to the old one, you <em>must</em> update the
  37859. thresholds before saving!</p>
  37860. Should Icon + Value be displayed, or only the Icon?
  37861. </member>
  37862. <member name="P:NPOI.SS.UserModel.IIconMultiStateFormatting.Thresholds">
  37863. Gets the list of thresholds
  37864. Sets the of thresholds. The number must match
  37865. {@link IconSet#num} for the current {@link #getIconSet()}
  37866. </member>
  37867. <member name="M:NPOI.SS.UserModel.IIconMultiStateFormatting.CreateThreshold">
  37868. Creates a new, empty Threshold
  37869. </member>
  37870. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_ARROW">
  37871. Green Up / Yellow Side / Red Down arrows
  37872. </member>
  37873. <member name="F:NPOI.SS.UserModel.IconSet.GREY_3_ARROWS">
  37874. Grey Up / Side / Down arrows
  37875. </member>
  37876. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_FLAGS">
  37877. Green / Yellow / Red flags
  37878. </member>
  37879. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_TRAFFIC_LIGHTS">
  37880. Green / Yellow / Red traffic lights (no background). Default
  37881. </member>
  37882. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_TRAFFIC_LIGHTS_BOX">
  37883. Green / Yellow / Red traffic lights on a black square background.
  37884. Note, MS-XLS docs v20141018 say this is id=5 but seems to be id=4
  37885. </member>
  37886. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SHAPES">
  37887. Green Circle / Yellow Triangle / Red Diamond.
  37888. Note, MS-XLS docs v20141018 say this is id=4 but seems to be id=5
  37889. </member>
  37890. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SYMBOLS_CIRCLE">
  37891. Green Tick / Yellow ! / Red Cross on a circle background
  37892. </member>
  37893. <member name="F:NPOI.SS.UserModel.IconSet.GYR_3_SYMBOLS">
  37894. Green Tick / Yellow ! / Red Cross (no background)
  37895. </member>
  37896. <member name="F:NPOI.SS.UserModel.IconSet.GYR_4_ARROWS">
  37897. Green Up / Yellow NE / Yellow SE / Red Down arrows
  37898. </member>
  37899. <member name="F:NPOI.SS.UserModel.IconSet.GREY_4_ARROWS">
  37900. Grey Up / NE / SE / Down arrows
  37901. </member>
  37902. <member name="F:NPOI.SS.UserModel.IconSet.RB_4_TRAFFIC_LIGHTS">
  37903. Red / Light Red / Grey / Black traffic lights
  37904. </member>
  37905. <member name="F:NPOI.SS.UserModel.IconSet.GYRB_4_TRAFFIC_LIGHTS">
  37906. Green / Yellow / Red / Black traffic lights
  37907. </member>
  37908. <member name="F:NPOI.SS.UserModel.IconSet.id">
  37909. Numeric ID of the icon set
  37910. </member>
  37911. <member name="F:NPOI.SS.UserModel.IconSet.num">
  37912. How many icons in the set
  37913. </member>
  37914. <member name="F:NPOI.SS.UserModel.IconSet.name">
  37915. Name (system) of the set
  37916. </member>
  37917. <member name="T:NPOI.SS.UserModel.IgnoredErrorType">
  37918. Types of ignored workbook and worksheet error.
  37919. TODO Implement these for HSSF too, using FeatFormulaErr2,
  37920. see bugzilla bug #46136 for details
  37921. </member>
  37922. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.CalculatedColumn">
  37923. ????. Probably XSSF-only.
  37924. </member>
  37925. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.EmptyCellReference">
  37926. Whether to check for references to empty cells.
  37927. HSSF + XSSF.
  37928. </member>
  37929. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.EvaluationError">
  37930. Whether to check for calculation/Evaluation errors.
  37931. HSSF + XSSF.
  37932. </member>
  37933. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.Formula">
  37934. Whether to check formulas in the range of the shared feature
  37935. that are inconsistent with formulas in neighbouring cells.
  37936. HSSF + XSSF.
  37937. </member>
  37938. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.FormulaRange">
  37939. Whether to check formulas in the range of the shared feature
  37940. with references to less than the entirety of a range Containing
  37941. continuous data.
  37942. HSSF + XSSF.
  37943. </member>
  37944. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.ListDataValidation">
  37945. ????. Is this XSSF-specific the same as performDataValidation
  37946. in HSSF?
  37947. </member>
  37948. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.NumberStoredAsText">
  37949. Whether to check the format of string values and warn
  37950. if they look to actually be numeric values.
  37951. HSSF + XSSF.
  37952. </member>
  37953. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.TwoDigitTextYear">
  37954. ????. Is this XSSF-specific the same as CheckDateTimeFormats
  37955. in HSSF?
  37956. </member>
  37957. <member name="F:NPOI.SS.UserModel.IgnoredErrorType.UnlockedFormula">
  37958. Whether to check for unprotected formulas.
  37959. HSSF + XSSF.
  37960. </member>
  37961. <member name="T:NPOI.SS.UserModel.IndexedColors">
  37962. A deprecated indexing scheme for colours that is still required for some records, and for backwards
  37963. compatibility with OLE2 formats.
  37964. <p>
  37965. Each element corresponds to a color index (zero-based). When using the default indexed color palette,
  37966. the values are not written out, but instead are implied. When the color palette has been modified from default,
  37967. then the entire color palette is used.
  37968. </p>
  37969. @author Yegor Kozlov
  37970. </member>
  37971. <member name="M:NPOI.SS.UserModel.IndexedColors.FromInt(System.Int32)">
  37972. @param index the index of the color
  37973. @return the corresponding IndexedColors enum
  37974. @throws IllegalArgumentException if index is not a valid IndexedColors
  37975. @since 3.15-beta2
  37976. </member>
  37977. <member name="P:NPOI.SS.UserModel.IndexedColors.Index">
  37978. Returns index of this color
  37979. @return index of this color
  37980. </member>
  37981. <member name="F:NPOI.SS.UserModel.Table.IsStructuredReference">
  37982. Regular expression matching a Structured Reference (Table syntax) for XSSF table expressions.
  37983. Public for unit tests
  37984. @see <a href="https://support.office.com/en-us/article/Using-structured-references-with-Excel-tables-F5ED2452-2337-4F71-BED3-C8AE6D2B276E">
  37985. Excel Structured Reference Syntax
  37986. </a>
  37987. </member>
  37988. <member name="T:NPOI.SS.UserModel.ITable">
  37989. XSSF Only!
  37990. High level abstraction of table in a workbook.
  37991. </member>
  37992. <member name="P:NPOI.SS.UserModel.ITable.StartColIndex">
  37993. Get the top-left column index relative to the sheet
  37994. @return table start column index on sheet
  37995. </member>
  37996. <member name="P:NPOI.SS.UserModel.ITable.StartRowIndex">
  37997. Get the top-left row index on the sheet
  37998. @return table start row index on sheet
  37999. </member>
  38000. <member name="P:NPOI.SS.UserModel.ITable.EndColIndex">
  38001. Get the bottom-right column index on the sheet
  38002. @return table end column index on sheet
  38003. </member>
  38004. <member name="P:NPOI.SS.UserModel.ITable.EndRowIndex">
  38005. Get the bottom-right row index
  38006. @return table end row index on sheet
  38007. </member>
  38008. <member name="P:NPOI.SS.UserModel.ITable.Name">
  38009. Get the name of the table.
  38010. @return table name
  38011. </member>
  38012. <member name="M:NPOI.SS.UserModel.ITable.FindColumnIndex(System.String)">
  38013. Returns the index of a given named column in the table (names are case insensitive in XSSF).
  38014. Note this list is lazily loaded and cached for performance.
  38015. Changes to the underlying table structure are not reflected in later calls
  38016. unless <code>XSSFTable.UpdateHeaders()</code> is called to reset the cache.
  38017. @param columnHeader the column header name to Get the table column index of
  38018. @return column index corresponding to <code>columnHeader</code>
  38019. </member>
  38020. <member name="P:NPOI.SS.UserModel.ITable.SheetName">
  38021. Returns the sheet name that the table belongs to.
  38022. </member>
  38023. <member name="P:NPOI.SS.UserModel.ITable.IsHasTotalsRow">
  38024. Returns true iff the table has a 'Totals' row
  38025. </member>
  38026. <member name="T:NPOI.SS.UserModel.IAutoFilter">
  38027. Represents autofiltering for the specified worksheet.
  38028. <p>
  38029. Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table.
  38030. For example, you can filter to see only the values that you specify, filter to see the top or bottom values,
  38031. or filter to quickly see duplicate values.
  38032. </p>
  38033. TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells.
  38034. In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add
  38035. corresponding methods to this interface.
  38036. </member>
  38037. <member name="T:NPOI.SS.UserModel.IBorderFormatting">
  38038. <summary>
  38039. High level representation for Border Formatting component
  38040. of Conditional Formatting settings
  38041. </summary>
  38042. </member>
  38043. <member name="T:NPOI.SS.UserModel.BorderStyle">
  38044. <summary>
  38045. The enumeration value indicating the line style of a border in a cell
  38046. </summary>
  38047. </member>
  38048. <member name="F:NPOI.SS.UserModel.BorderStyle.None">
  38049. <summary>
  38050. No border
  38051. </summary>
  38052. </member>
  38053. <member name="F:NPOI.SS.UserModel.BorderStyle.Thin">
  38054. <summary>
  38055. Thin border
  38056. </summary>
  38057. </member>
  38058. <member name="F:NPOI.SS.UserModel.BorderStyle.Medium">
  38059. <summary>
  38060. Medium border
  38061. </summary>
  38062. </member>
  38063. <member name="F:NPOI.SS.UserModel.BorderStyle.Dashed">
  38064. <summary>
  38065. dash border
  38066. </summary>
  38067. </member>
  38068. <member name="F:NPOI.SS.UserModel.BorderStyle.Dotted">
  38069. <summary>
  38070. dot border
  38071. </summary>
  38072. </member>
  38073. <member name="F:NPOI.SS.UserModel.BorderStyle.Thick">
  38074. <summary>
  38075. Thick border
  38076. </summary>
  38077. </member>
  38078. <member name="F:NPOI.SS.UserModel.BorderStyle.Double">
  38079. <summary>
  38080. double-line border
  38081. </summary>
  38082. </member>
  38083. <member name="F:NPOI.SS.UserModel.BorderStyle.Hair">
  38084. <summary>
  38085. hair-line border
  38086. </summary>
  38087. </member>
  38088. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashed">
  38089. <summary>
  38090. Medium dashed border
  38091. </summary>
  38092. </member>
  38093. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDot">
  38094. <summary>
  38095. dash-dot border
  38096. </summary>
  38097. </member>
  38098. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDot">
  38099. <summary>
  38100. medium dash-dot border
  38101. </summary>
  38102. </member>
  38103. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDotDot">
  38104. <summary>
  38105. dash-dot-dot border
  38106. </summary>
  38107. </member>
  38108. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDotDot">
  38109. <summary>
  38110. medium dash-dot-dot border
  38111. </summary>
  38112. </member>
  38113. <member name="F:NPOI.SS.UserModel.BorderStyle.SlantedDashDot">
  38114. <summary>
  38115. slanted dash-dot border
  38116. </summary>
  38117. </member>
  38118. <member name="T:NPOI.SS.UserModel.BuiltinFormats">
  38119. Utility to identify built-in formats. The following is a list of the formats as
  38120. returned by this class.<p/>
  38121. <p/>
  38122. 0, "General"<br/>
  38123. 1, "0"<br/>
  38124. 2, "0.00"<br/>
  38125. 3, "#,##0"<br/>
  38126. 4, "#,##0.00"<br/>
  38127. 5, "$#,##0_);($#,##0)"<br/>
  38128. 6, "$#,##0_);[Red]($#,##0)"<br/>
  38129. 7, "$#,##0.00);($#,##0.00)"<br/>
  38130. 8, "$#,##0.00_);[Red]($#,##0.00)"<br/>
  38131. 9, "0%"<br/>
  38132. 0xa, "0.00%"<br/>
  38133. 0xb, "0.00E+00"<br/>
  38134. 0xc, "# ?/?"<br/>
  38135. 0xd, "# ??/??"<br/>
  38136. 0xe, "m/d/yy"<br/>
  38137. 0xf, "d-mmm-yy"<br/>
  38138. 0x10, "d-mmm"<br/>
  38139. 0x11, "mmm-yy"<br/>
  38140. 0x12, "h:mm AM/PM"<br/>
  38141. 0x13, "h:mm:ss AM/PM"<br/>
  38142. 0x14, "h:mm"<br/>
  38143. 0x15, "h:mm:ss"<br/>
  38144. 0x16, "m/d/yy h:mm"<br/>
  38145. <p/>
  38146. // 0x17 - 0x24 reserved for international and undocumented
  38147. 0x25, "#,##0_);(#,##0)"<br/>
  38148. 0x26, "#,##0_);[Red](#,##0)"<br/>
  38149. 0x27, "#,##0.00_);(#,##0.00)"<br/>
  38150. 0x28, "#,##0.00_);[Red](#,##0.00)"<br/>
  38151. 0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"<br/>
  38152. 0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"<br/>
  38153. 0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"<br/>
  38154. 0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"<br/>
  38155. 0x2d, "mm:ss"<br/>
  38156. 0x2e, "[h]:mm:ss"<br/>
  38157. 0x2f, "mm:ss.0"<br/>
  38158. 0x30, "##0.0E+0"<br/>
  38159. 0x31, "@" - This is text format.<br/>
  38160. 0x31 "text" - Alias for "@"<br/>
  38161. <p/>
  38162. @author Yegor Kozlov
  38163. Modified 6/17/09 by Stanislav Shor - positive formats don't need starting '('
  38164. </member>
  38165. <member name="F:NPOI.SS.UserModel.BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX">
  38166. The first user-defined number format starts at 164.
  38167. </member>
  38168. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetAll">
  38169. @return array of built-in data formats
  38170. </member>
  38171. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.Int32)">
  38172. Get the format string that matches the given format index
  38173. @param index of a built in format
  38174. @return string represented at index of format or <code>null</code> if there is not a built-in format at that index
  38175. </member>
  38176. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.String)">
  38177. Get the format index that matches the given format string.
  38178. <p>
  38179. Automatically converts "text" to excel's format string to represent text.
  38180. </p>
  38181. @param pFmt string matching a built-in format
  38182. @return index of format or -1 if undefined.
  38183. </member>
  38184. <member name="T:NPOI.SS.UserModel.ICell">
  38185. High level representation of a cell in a row of a spreadsheet.
  38186. <p>
  38187. Cells can be numeric, formula-based or string-based (text). The cell type
  38188. specifies this. String cells cannot conatin numbers and numeric cells cannot
  38189. contain strings (at least according to our model). Client apps should do the
  38190. conversions themselves. Formula cells have the formula string, as well as
  38191. the formula result, which can be numeric or string.
  38192. </p>
  38193. <p>
  38194. Cells should have their number (0 based) before being Added to a row.
  38195. </p>
  38196. </member>
  38197. <member name="P:NPOI.SS.UserModel.ICell.ColumnIndex">
  38198. <summary>
  38199. zero-based column index of a column in a sheet.
  38200. </summary>
  38201. </member>
  38202. <member name="P:NPOI.SS.UserModel.ICell.RowIndex">
  38203. <summary>
  38204. zero-based row index of a row in the sheet that contains this cell
  38205. </summary>
  38206. </member>
  38207. <member name="P:NPOI.SS.UserModel.ICell.Sheet">
  38208. <summary>
  38209. the sheet this cell belongs to
  38210. </summary>
  38211. </member>
  38212. <member name="P:NPOI.SS.UserModel.ICell.Row">
  38213. <summary>
  38214. the row this cell belongs to
  38215. </summary>
  38216. </member>
  38217. <member name="P:NPOI.SS.UserModel.ICell.CellType">
  38218. <summary>
  38219. Set the cells type (numeric, formula or string)
  38220. </summary>
  38221. <p>If the cell currently contains a value, the value will
  38222. be converted to match the new type, if possible. Formatting
  38223. is generally lost in the process however.</p>
  38224. <p>If what you want to do is get a String value for your
  38225. numeric cell, <i>stop!</i>. This is not the way to do it.
  38226. Instead, for fetching the string value of a numeric or boolean
  38227. or date cell, use {@link DataFormatter} instead.</p>
  38228. </member>
  38229. <member name="M:NPOI.SS.UserModel.ICell.SetCellType(NPOI.SS.UserModel.CellType)">
  38230. <summary>
  38231. Set the cells type (numeric, formula or string)
  38232. </summary>
  38233. <param name="cellType"></param>
  38234. </member>
  38235. <member name="P:NPOI.SS.UserModel.ICell.CachedFormulaResultType">
  38236. <summary>
  38237. Only valid for formula cells
  38238. </summary>
  38239. </member>
  38240. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Double)">
  38241. <summary>
  38242. Set a numeric value for the cell
  38243. </summary>
  38244. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  38245. precalculated value, for numerics we'll set its value. For other types we will change
  38246. the cell to a numeric cell and set its value.
  38247. </param>
  38248. </member>
  38249. <member name="M:NPOI.SS.UserModel.ICell.SetCellErrorValue(System.Byte)">
  38250. <summary>
  38251. Set a error value for the cell
  38252. </summary>
  38253. <param name="value">the error value to set this cell to. For formulas we'll set the
  38254. precalculated value , for errors we'll set its value. For other types we will change
  38255. the cell to an error cell and set its value.
  38256. </param>
  38257. </member>
  38258. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.DateTime)">
  38259. <summary>
  38260. Converts the supplied date to its equivalent Excel numeric value and Sets that into the cell.
  38261. </summary>
  38262. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  38263. precalculated value, for numerics we'll set its value. For other types we will change
  38264. the cell to a numerics cell and set its value.
  38265. </param>
  38266. </member>
  38267. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  38268. <summary>
  38269. Set a rich string value for the cell.
  38270. </summary>
  38271. <param name="value">value to set the cell to. For formulas we'll set the formula
  38272. string, for String cells we'll set its value. For other types we will
  38273. change the cell to a string cell and set its value.
  38274. If value is null then we will change the cell to a Blank cell.
  38275. </param>
  38276. </member>
  38277. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.String)">
  38278. <summary>
  38279. Set a string value for the cell.
  38280. </summary>
  38281. <param name="value">value to set the cell to. For formulas we'll set the formula
  38282. string, for String cells we'll set its value. For other types we will
  38283. change the cell to a string cell and set its value.
  38284. If value is null then we will change the cell to a blank cell.
  38285. </param>
  38286. </member>
  38287. <member name="M:NPOI.SS.UserModel.ICell.CopyCellTo(System.Int32)">
  38288. <summary>
  38289. Copy the cell to the target index. If the target cell exists, a new cell will be inserted before the existing cell.
  38290. </summary>
  38291. <param name="targetIndex">target index</param>
  38292. <returns>the new copied cell object</returns>
  38293. </member>
  38294. <member name="P:NPOI.SS.UserModel.ICell.CellFormula">
  38295. <summary>
  38296. Return a formula for the cell
  38297. </summary>
  38298. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is not CELL_TYPE_FORMULA </exception>
  38299. </member>
  38300. <member name="M:NPOI.SS.UserModel.ICell.SetCellFormula(System.String)">
  38301. <summary>
  38302. Sets formula for this cell.
  38303. </summary>
  38304. <param name="formula">the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.</param>
  38305. </member>
  38306. <member name="P:NPOI.SS.UserModel.ICell.NumericCellValue">
  38307. <summary>
  38308. Get the value of the cell as a number.
  38309. </summary>
  38310. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  38311. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  38312. </member>
  38313. <member name="P:NPOI.SS.UserModel.ICell.DateCellValue">
  38314. <summary>
  38315. Get the value of the cell as a date.
  38316. </summary>
  38317. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  38318. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  38319. </member>
  38320. <member name="P:NPOI.SS.UserModel.ICell.RichStringCellValue">
  38321. <summary>
  38322. Get the value of the cell RichTextString
  38323. </summary>
  38324. </member>
  38325. <member name="P:NPOI.SS.UserModel.ICell.ErrorCellValue">
  38326. <summary>
  38327. Get the value of the cell as an error code.
  38328. </summary>
  38329. </member>
  38330. <member name="P:NPOI.SS.UserModel.ICell.StringCellValue">
  38331. <summary>
  38332. Get the value of the cell as a string
  38333. </summary>
  38334. </member>
  38335. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Boolean)">
  38336. <summary>
  38337. Set a bool value for the cell
  38338. </summary>
  38339. <param name="value"></param>
  38340. </member>
  38341. <member name="P:NPOI.SS.UserModel.ICell.BooleanCellValue">
  38342. <summary>
  38343. Get the value of the cell as a bool.
  38344. </summary>
  38345. </member>
  38346. <member name="P:NPOI.SS.UserModel.ICell.CellStyle">
  38347. <summary>
  38348. get or set the cell's style.
  38349. If set the style for the cell. The style should be an CellStyle created/retreived from the Workbook.
  38350. To change the style of a cell without affecting other cells that use the same style,
  38351. use CellUtil#setCellStyleProperties
  38352. </summary>
  38353. </member>
  38354. <member name="M:NPOI.SS.UserModel.ICell.SetAsActiveCell">
  38355. <summary>
  38356. Sets this cell as the active cell for the worksheet
  38357. </summary>
  38358. </member>
  38359. <member name="P:NPOI.SS.UserModel.ICell.Address">
  38360. Gets the address of this cell
  38361. @return <code>A1</code> style address of this cell
  38362. @since 3.14beta2
  38363. </member>
  38364. <member name="P:NPOI.SS.UserModel.ICell.CellComment">
  38365. <summary>
  38366. comment associated with this cell
  38367. </summary>
  38368. </member>
  38369. <member name="M:NPOI.SS.UserModel.ICell.RemoveCellComment">
  38370. <summary>
  38371. Removes the comment for this cell, if there is one.
  38372. </summary>
  38373. </member>
  38374. <member name="P:NPOI.SS.UserModel.ICell.Hyperlink">
  38375. <summary>
  38376. hyperlink associated with this cell
  38377. </summary>
  38378. </member>
  38379. <member name="M:NPOI.SS.UserModel.ICell.RemoveHyperlink">
  38380. <summary>
  38381. Removes the hyperlink for this cell, if there is one.
  38382. </summary>
  38383. </member>
  38384. <member name="P:NPOI.SS.UserModel.ICell.ArrayFormulaRange">
  38385. <summary>
  38386. Only valid for array formula cells
  38387. </summary>
  38388. <returns>range of the array formula group that the cell belongs to.</returns>
  38389. </member>
  38390. <member name="P:NPOI.SS.UserModel.ICell.IsPartOfArrayFormulaGroup">
  38391. <summary>
  38392. if this cell is part of group of cells having a common array formula.
  38393. </summary>
  38394. </member>
  38395. <member name="P:NPOI.SS.UserModel.ICellRange`1.Size">
  38396. Gets the number of cells in this range.
  38397. @return <tt>height * width </tt>
  38398. </member>
  38399. <member name="P:NPOI.SS.UserModel.ICellRange`1.ReferenceText">
  38400. @return the text format of this range. Single cell ranges are formatted
  38401. like single cell references (e.g. 'A1' instead of 'A1:A1').
  38402. </member>
  38403. <member name="P:NPOI.SS.UserModel.ICellRange`1.TopLeftCell">
  38404. @return the cell at relative coordinates (0,0). Never <code>null</code>.
  38405. </member>
  38406. <member name="M:NPOI.SS.UserModel.ICellRange`1.GetCell(System.Int32,System.Int32)">
  38407. @param relativeRowIndex must be between <tt>0</tt> and <tt>height-1</tt>
  38408. @param relativeColumnIndex must be between <tt>0</tt> and <tt>width-1</tt>
  38409. @return the cell at the specified coordinates. Never <code>null</code>.
  38410. </member>
  38411. <member name="P:NPOI.SS.UserModel.ICellRange`1.FlattenedCells">
  38412. @return a flattened array of all the cells in this {@link CellRange}
  38413. </member>
  38414. <member name="P:NPOI.SS.UserModel.ICellRange`1.Cells">
  38415. @return a 2-D array of all the cells in this {@link CellRange}. The first
  38416. array dimension is the row index (values <tt>0...height-1</tt>)
  38417. and the second dimension is the column index (values <tt>0...width-1</tt>)
  38418. </member>
  38419. <member name="P:NPOI.SS.UserModel.ICellStyle.ShrinkToFit">
  38420. <summary>
  38421. the Cell should be auto-sized to shrink to fit if the text is too long
  38422. </summary>
  38423. </member>
  38424. <member name="P:NPOI.SS.UserModel.ICellStyle.Index">
  38425. get the index within the Workbook (sequence within the collection of ExtnededFormat objects)
  38426. @return unique index number of the underlying record this style represents (probably you don't care
  38427. unless you're comparing which one is which)
  38428. </member>
  38429. <member name="P:NPOI.SS.UserModel.ICellStyle.DataFormat">
  38430. get the index of the format
  38431. @see DataFormat
  38432. </member>
  38433. <member name="M:NPOI.SS.UserModel.ICellStyle.GetDataFormatString">
  38434. Get the format string
  38435. </member>
  38436. <member name="M:NPOI.SS.UserModel.ICellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  38437. set the font for this style
  38438. @param font a font object Created or retreived from the Workbook object
  38439. @see Workbook#CreateFont()
  38440. @see Workbook#GetFontAt(short)
  38441. </member>
  38442. <member name="P:NPOI.SS.UserModel.ICellStyle.FontIndex">
  38443. Gets the index of the font for this style
  38444. @see Workbook#GetFontAt(short)
  38445. </member>
  38446. <member name="P:NPOI.SS.UserModel.ICellStyle.IsHidden">
  38447. get whether the cell's using this style are to be hidden
  38448. @return hidden - whether the cell using this style should be hidden
  38449. </member>
  38450. <member name="P:NPOI.SS.UserModel.ICellStyle.IsLocked">
  38451. get whether the cell's using this style are to be locked
  38452. @return hidden - whether the cell using this style should be locked
  38453. </member>
  38454. <member name="P:NPOI.SS.UserModel.ICellStyle.Alignment">
  38455. get the type of horizontal alignment for the cell
  38456. @return align - the type of alignment
  38457. @see #ALIGN_GENERAL
  38458. @see #ALIGN_LEFT
  38459. @see #ALIGN_CENTER
  38460. @see #ALIGN_RIGHT
  38461. @see #ALIGN_FILL
  38462. @see #ALIGN_JUSTIFY
  38463. @see #ALIGN_CENTER_SELECTION
  38464. </member>
  38465. <member name="P:NPOI.SS.UserModel.ICellStyle.WrapText">
  38466. get whether the text should be wrapped
  38467. @return wrap text or not
  38468. </member>
  38469. <member name="P:NPOI.SS.UserModel.ICellStyle.VerticalAlignment">
  38470. get the type of vertical alignment for the cell
  38471. @return align the type of alignment
  38472. @see #VERTICAL_TOP
  38473. @see #VERTICAL_CENTER
  38474. @see #VERTICAL_BOTTOM
  38475. @see #VERTICAL_JUSTIFY
  38476. </member>
  38477. <member name="P:NPOI.SS.UserModel.ICellStyle.Rotation">
  38478. get the degree of rotation for the text in the cell
  38479. Note: HSSF uses values from -90 to 90 degrees, whereas XSSF
  38480. uses values from 0 to 180 degrees. The implementations of this method will map between these two value-ranges
  38481. accordingly, however the corresponding getter is returning values in the range mandated by the current type
  38482. of Excel file-format that this CellStyle is applied to.
  38483. @return rotation degrees (between -90 and 90 degrees)
  38484. </member>
  38485. <member name="P:NPOI.SS.UserModel.ICellStyle.Indention">
  38486. get the number of spaces to indent the text in the cell
  38487. @return indent - number of spaces
  38488. </member>
  38489. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderLeft">
  38490. get the type of border to use for the left border of the cell
  38491. @return border type
  38492. @see #BORDER_NONE
  38493. @see #BORDER_THIN
  38494. @see #BORDER_MEDIUM
  38495. @see #BORDER_DASHED
  38496. @see #BORDER_DOTTED
  38497. @see #BORDER_THICK
  38498. @see #BORDER_DOUBLE
  38499. @see #BORDER_HAIR
  38500. @see #BORDER_MEDIUM_DASHED
  38501. @see #BORDER_DASH_DOT
  38502. @see #BORDER_MEDIUM_DASH_DOT
  38503. @see #BORDER_DASH_DOT_DOT
  38504. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38505. @see #BORDER_SLANTED_DASH_DOT
  38506. </member>
  38507. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderRight">
  38508. get the type of border to use for the right border of the cell
  38509. @return border type
  38510. @see #BORDER_NONE
  38511. @see #BORDER_THIN
  38512. @see #BORDER_MEDIUM
  38513. @see #BORDER_DASHED
  38514. @see #BORDER_DOTTED
  38515. @see #BORDER_THICK
  38516. @see #BORDER_DOUBLE
  38517. @see #BORDER_HAIR
  38518. @see #BORDER_MEDIUM_DASHED
  38519. @see #BORDER_DASH_DOT
  38520. @see #BORDER_MEDIUM_DASH_DOT
  38521. @see #BORDER_DASH_DOT_DOT
  38522. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38523. @see #BORDER_SLANTED_DASH_DOT
  38524. </member>
  38525. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderTop">
  38526. get the type of border to use for the top border of the cell
  38527. @return border type
  38528. @see #BORDER_NONE
  38529. @see #BORDER_THIN
  38530. @see #BORDER_MEDIUM
  38531. @see #BORDER_DASHED
  38532. @see #BORDER_DOTTED
  38533. @see #BORDER_THICK
  38534. @see #BORDER_DOUBLE
  38535. @see #BORDER_HAIR
  38536. @see #BORDER_MEDIUM_DASHED
  38537. @see #BORDER_DASH_DOT
  38538. @see #BORDER_MEDIUM_DASH_DOT
  38539. @see #BORDER_DASH_DOT_DOT
  38540. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38541. @see #BORDER_SLANTED_DASH_DOT
  38542. </member>
  38543. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderBottom">
  38544. get the type of border to use for the bottom border of the cell
  38545. @return border type
  38546. @see #BORDER_NONE
  38547. @see #BORDER_THIN
  38548. @see #BORDER_MEDIUM
  38549. @see #BORDER_DASHED
  38550. @see #BORDER_DOTTED
  38551. @see #BORDER_THICK
  38552. @see #BORDER_DOUBLE
  38553. @see #BORDER_HAIR
  38554. @see #BORDER_MEDIUM_DASHED
  38555. @see #BORDER_DASH_DOT
  38556. @see #BORDER_MEDIUM_DASH_DOT
  38557. @see #BORDER_DASH_DOT_DOT
  38558. @see #BORDER_MEDIUM_DASH_DOT_DOT
  38559. @see #BORDER_SLANTED_DASH_DOT
  38560. </member>
  38561. <member name="P:NPOI.SS.UserModel.ICellStyle.LeftBorderColor">
  38562. get the color to use for the left border
  38563. </member>
  38564. <member name="P:NPOI.SS.UserModel.ICellStyle.RightBorderColor">
  38565. get the color to use for the left border
  38566. @return the index of the color defInition
  38567. </member>
  38568. <member name="P:NPOI.SS.UserModel.ICellStyle.TopBorderColor">
  38569. get the color to use for the top border
  38570. @return hhe index of the color defInition
  38571. </member>
  38572. <member name="P:NPOI.SS.UserModel.ICellStyle.BottomBorderColor">
  38573. get the color to use for the left border
  38574. @return the index of the color defInition
  38575. </member>
  38576. <member name="P:NPOI.SS.UserModel.ICellStyle.FillPattern">
  38577. get the fill pattern (??) - set to 1 to fill with foreground color
  38578. @return fill pattern
  38579. </member>
  38580. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColor">
  38581. get the background fill color
  38582. @return fill color
  38583. </member>
  38584. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColor">
  38585. get the foreground fill color
  38586. @return fill color
  38587. </member>
  38588. <member name="M:NPOI.SS.UserModel.ICellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  38589. Clones all the style information from another
  38590. CellStyle, onto this one. This
  38591. CellStyle will then have all the same
  38592. properties as the source, but the two may
  38593. be edited independently.
  38594. Any stylings on this CellStyle will be lost!
  38595. The source CellStyle could be from another
  38596. Workbook if you like. This allows you to
  38597. copy styles from one Workbook to another.
  38598. However, both of the CellStyles will need
  38599. to be of the same type (HSSFCellStyle or
  38600. XSSFCellStyle)
  38601. </member>
  38602. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalColor">
  38603. <summary>
  38604. Gets or sets the color to use for the diagional border
  38605. </summary>
  38606. <value>The index of the color definition.</value>
  38607. </member>
  38608. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalLineStyle">
  38609. <summary>
  38610. Gets or sets the line type to use for the diagional border
  38611. </summary>
  38612. <value>The line type.</value>
  38613. </member>
  38614. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonal">
  38615. <summary>
  38616. Gets or sets the type of diagional border
  38617. </summary>.
  38618. <value>The border diagional type.</value>
  38619. </member>
  38620. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColorColor">
  38621. Gets the color object representing the current
  38622. background fill, resolving indexes using
  38623. the supplied workbook.
  38624. This will work for both indexed and rgb
  38625. defined colors.
  38626. </member>
  38627. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColorColor">
  38628. Gets the color object representing the current
  38629. foreground fill, resolving indexes using
  38630. the supplied workbook.
  38631. This will work for both indexed and rgb
  38632. defined colors.
  38633. </member>
  38634. <member name="T:NPOI.SS.UserModel.CellValue">
  38635. Mimics the 'data view' of a cell. This allows formula Evaluator
  38636. to return a CellValue instead of precasting the value to String
  38637. or Number or bool type.
  38638. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  38639. </member>
  38640. <member name="P:NPOI.SS.UserModel.CellValue.BooleanValue">
  38641. @return Returns the boolValue.
  38642. </member>
  38643. <member name="P:NPOI.SS.UserModel.CellValue.NumberValue">
  38644. @return Returns the numberValue.
  38645. </member>
  38646. <member name="P:NPOI.SS.UserModel.CellValue.StringValue">
  38647. @return Returns the stringValue.
  38648. </member>
  38649. <member name="P:NPOI.SS.UserModel.CellValue.CellType">
  38650. @return Returns the cellType.
  38651. </member>
  38652. <member name="P:NPOI.SS.UserModel.CellValue.ErrorValue">
  38653. @return Returns the errorValue.
  38654. </member>
  38655. <member name="T:NPOI.SS.UserModel.IChart">
  38656. High level representation of a chart.
  38657. @author Roman Kashitsyn
  38658. </member>
  38659. <member name="P:NPOI.SS.UserModel.IChart.ChartDataFactory">
  38660. @return an appropriate ChartDataFactory implementation
  38661. </member>
  38662. <member name="P:NPOI.SS.UserModel.IChart.ChartAxisFactory">
  38663. @return an appropriate ChartAxisFactory implementation
  38664. </member>
  38665. <member name="M:NPOI.SS.UserModel.IChart.GetOrCreateLegend">
  38666. @return chart legend instance
  38667. </member>
  38668. <member name="M:NPOI.SS.UserModel.IChart.DeleteLegend">
  38669. Delete current chart legend.
  38670. </member>
  38671. <member name="M:NPOI.SS.UserModel.IChart.GetAxis">
  38672. @return list of all chart axis
  38673. </member>
  38674. <member name="M:NPOI.SS.UserModel.IChart.Plot(NPOI.SS.UserModel.Charts.IChartData,NPOI.SS.UserModel.Charts.IChartAxis[])">
  38675. Plots specified data on the chart.
  38676. @param data a data to plot
  38677. </member>
  38678. <member name="F:NPOI.SS.UserModel.AnchorType.MoveAndResize">
  38679. Move and Resize With Anchor Cells
  38680. <p>
  38681. Specifies that the current drawing shall move and
  38682. resize to maintain its row and column anchors (i.e. the
  38683. object is anchored to the actual from and to row and column)
  38684. </p>
  38685. </member>
  38686. <member name="F:NPOI.SS.UserModel.AnchorType.MoveDontResize">
  38687. Move With Cells but Do Not Resize
  38688. <p>
  38689. Specifies that the current drawing shall move with its
  38690. row and column (i.e. the object is anchored to the
  38691. actual from row and column), but that the size shall remain absolute.
  38692. </p>
  38693. <p>
  38694. If Additional rows/columns are Added between the from and to locations of the drawing,
  38695. the drawing shall move its to anchors as needed to maintain this same absolute size.
  38696. </p>
  38697. </member>
  38698. <member name="F:NPOI.SS.UserModel.AnchorType.DontMoveAndResize">
  38699. Do Not Move or Resize With Underlying Rows/Columns
  38700. <p>
  38701. Specifies that the current start and end positions shall
  38702. be maintained with respect to the distances from the
  38703. absolute start point of the worksheet.
  38704. </p>
  38705. <p>
  38706. If Additional rows/columns are Added before the
  38707. drawing, the drawing shall move its anchors as needed
  38708. to maintain this same absolute position.
  38709. </p>
  38710. </member>
  38711. <member name="T:NPOI.SS.UserModel.IClientAnchor">
  38712. A client anchor is attached to an excel worksheet. It anchors against a
  38713. top-left and bottom-right cell.
  38714. @author Yegor Kozlov
  38715. </member>
  38716. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col1">
  38717. Returns the column (0 based) of the first cell.
  38718. @return 0-based column of the first cell.
  38719. </member>
  38720. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col2">
  38721. Returns the column (0 based) of the second cell.
  38722. @return 0-based column of the second cell.
  38723. </member>
  38724. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row1">
  38725. Returns the row (0 based) of the first cell.
  38726. @return 0-based row of the first cell.
  38727. </member>
  38728. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row2">
  38729. Returns the row (0 based) of the second cell.
  38730. @return 0-based row of the second cell.
  38731. </member>
  38732. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx1">
  38733. Returns the x coordinate within the first cell
  38734. @return the x coordinate within the first cell
  38735. </member>
  38736. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy1">
  38737. Returns the y coordinate within the first cell
  38738. @return the y coordinate within the first cell
  38739. </member>
  38740. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy2">
  38741. Sets the y coordinate within the second cell
  38742. @return the y coordinate within the second cell
  38743. </member>
  38744. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx2">
  38745. Returns the x coordinate within the second cell
  38746. @return the x coordinate within the second cell
  38747. </member>
  38748. <member name="P:NPOI.SS.UserModel.IClientAnchor.AnchorType">
  38749. s the anchor type
  38750. <p>
  38751. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  38752. </p>
  38753. @return the anchor type
  38754. @see #MOVE_AND_RESIZE
  38755. @see #MOVE_DONT_RESIZE
  38756. @see #DONT_MOVE_AND_RESIZE
  38757. </member>
  38758. <member name="P:NPOI.SS.UserModel.IComment.Visible">
  38759. Sets whether this comment is visible.
  38760. @return <c>true</c> if the comment is visible, <c>false</c> otherwise
  38761. </member>
  38762. <member name="P:NPOI.SS.UserModel.IComment.Address">
  38763. <summary>
  38764. Get or set the address of the cell that this comment is attached to
  38765. </summary>
  38766. </member>
  38767. <member name="M:NPOI.SS.UserModel.IComment.SetAddress(System.Int32,System.Int32)">
  38768. Set the address of the cell that this comment is attached to
  38769. @param row
  38770. @param col
  38771. </member>
  38772. <member name="P:NPOI.SS.UserModel.IComment.Row">
  38773. Return the row of the cell that Contains the comment
  38774. @return the 0-based row of the cell that Contains the comment
  38775. </member>
  38776. <member name="P:NPOI.SS.UserModel.IComment.Column">
  38777. Return the column of the cell that Contains the comment
  38778. @return the 0-based column of the cell that Contains the comment
  38779. </member>
  38780. <member name="P:NPOI.SS.UserModel.IComment.Author">
  38781. Name of the original comment author
  38782. @return the name of the original author of the comment
  38783. </member>
  38784. <member name="P:NPOI.SS.UserModel.IComment.String">
  38785. Fetches the rich text string of the comment
  38786. </member>
  38787. <member name="P:NPOI.SS.UserModel.IComment.ClientAnchor">
  38788. Return defines position of this anchor in the sheet.
  38789. The anchor is the yellow box/balloon that is rendered on top of the sheets
  38790. when the comment is visible.
  38791. To associate a comment with a different cell, use {@link #setAddress}.
  38792. @return defines position of this anchor in the sheet
  38793. </member>
  38794. <member name="T:NPOI.SS.UserModel.ComparisonOperator">
  38795. The conditional format operators used for "Highlight Cells That Contain..." rules.
  38796. <p>
  38797. For example, "highlight cells that begin with "M2" and contain "Mountain Gear".
  38798. </p>
  38799. @author Dmitriy Kumshayev
  38800. @author Yegor Kozlov
  38801. </member>
  38802. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Between">
  38803. 'Between' operator
  38804. </member>
  38805. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotBetween">
  38806. 'Not between' operator
  38807. </member>
  38808. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Equal">
  38809. 'Equal to' operator
  38810. </member>
  38811. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotEqual">
  38812. 'Not equal to' operator
  38813. </member>
  38814. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThan">
  38815. 'Greater than' operator
  38816. </member>
  38817. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThan">
  38818. 'Less than' operator
  38819. </member>
  38820. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThanOrEqual">
  38821. 'Greater than or equal to' operator
  38822. </member>
  38823. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThanOrEqual">
  38824. 'Less than or equal to' operator
  38825. </member>
  38826. <member name="T:NPOI.SS.UserModel.IConditionalFormatting">
  38827. The ConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  38828. The class can be used
  38829. <UL>
  38830. <LI>
  38831. to make a copy ConditionalFormatting Settings.
  38832. </LI>
  38833. For example:
  38834. <PRE>
  38835. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  38836. newSheet.AddConditionalFormatting(cf);
  38837. </PRE>
  38838. <LI>
  38839. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  38840. </LI>
  38841. </UL>
  38842. Use {@link NPOI.HSSF.UserModel.Sheet#getSheetConditionalFormatting()} to Get access to an instance of this class.
  38843. To create a new Conditional Formatting Set use the following approach:
  38844. <PRE>
  38845. // Define a Conditional Formatting rule, which triggers formatting
  38846. // when cell's value is greater or equal than 100.0 and
  38847. // applies patternFormatting defined below.
  38848. ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  38849. ComparisonOperator.GE,
  38850. "100.0", // 1st formula
  38851. null // 2nd formula is not used for comparison operator GE
  38852. );
  38853. // Create pattern with red background
  38854. PatternFormatting patternFmt = rule.CretePatternFormatting();
  38855. patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
  38856. // Define a region Containing first column
  38857. Region [] regions =
  38858. {
  38859. new Region(1,(short)1,-1,(short)1)
  38860. };
  38861. // Apply Conditional Formatting rule defined above to the regions
  38862. sheet.AddConditionalFormatting(regions, rule);
  38863. </PRE>
  38864. @author Dmitriy Kumshayev
  38865. @author Yegor Kozlov
  38866. </member>
  38867. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetFormattingRanges">
  38868. @return array of <c>CellRangeAddress</c>s. Never <code>null</code>
  38869. </member>
  38870. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  38871. Replaces an existing Conditional Formatting rule at position idx.
  38872. Excel allows to create up to 3 Conditional Formatting rules.
  38873. This method can be useful to modify existing Conditional Formatting rules.
  38874. @param idx position of the rule. Should be between 0 and 2.
  38875. @param cfRule - Conditional Formatting rule
  38876. </member>
  38877. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  38878. Add a Conditional Formatting rule.
  38879. Excel allows to create up to 3 Conditional Formatting rules.
  38880. @param cfRule - Conditional Formatting rule
  38881. </member>
  38882. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetRule(System.Int32)">
  38883. @return the Conditional Formatting rule at position idx.
  38884. </member>
  38885. <member name="P:NPOI.SS.UserModel.IConditionalFormatting.NumberOfRules">
  38886. @return number of Conditional Formatting rules.
  38887. </member>
  38888. <member name="T:NPOI.SS.UserModel.IConditionalFormattingRule">
  38889. Represents a description of a conditional formatting rule
  38890. @author Dmitriy Kumshayev
  38891. @author Yegor Kozlov
  38892. </member>
  38893. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateBorderFormatting">
  38894. Create a new border formatting structure if it does not exist,
  38895. otherwise just return existing object.
  38896. @return - border formatting object, never returns <code>null</code>.
  38897. </member>
  38898. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.BorderFormatting">
  38899. @return - border formatting object if defined, <code>null</code> otherwise
  38900. </member>
  38901. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateFontFormatting">
  38902. Create a new font formatting structure if it does not exist,
  38903. otherwise just return existing object.
  38904. @return - font formatting object, never returns <code>null</code>.
  38905. </member>
  38906. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.FontFormatting">
  38907. @return - font formatting object if defined, <code>null</code> otherwise
  38908. </member>
  38909. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreatePatternFormatting">
  38910. Create a new pattern formatting structure if it does not exist,
  38911. otherwise just return existing object.
  38912. @return - pattern formatting object, never returns <code>null</code>.
  38913. </member>
  38914. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.PatternFormatting">
  38915. @return - pattern formatting object if defined, <code>null</code> otherwise
  38916. </member>
  38917. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.DataBarFormatting">
  38918. @return - databar / data-bar formatting object if defined, <code>null</code> otherwise
  38919. </member>
  38920. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.MultiStateFormatting">
  38921. @return - icon / multi-state formatting object if defined, <code>null</code> otherwise
  38922. </member>
  38923. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ColorScaleFormatting">
  38924. @return color scale / color grate formatting object if defined, <code>null</code> otherwise
  38925. </member>
  38926. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ConditionType">
  38927. Type of conditional formatting rule.
  38928. <p>
  38929. MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA}
  38930. </p>
  38931. @return the type of condition
  38932. </member>
  38933. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ComparisonOperation">
  38934. The comparison function used when the type of conditional formatting is Set to
  38935. {@link #CONDITION_TYPE_CELL_VALUE_IS}
  38936. <p>
  38937. MUST be a constant from {@link ComparisonOperator}
  38938. </p>
  38939. @return the conditional format operator
  38940. </member>
  38941. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula1">
  38942. The formula used to Evaluate the first operand for the conditional formatting rule.
  38943. <p>
  38944. If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS},
  38945. this field is the first operand of the comparison.
  38946. If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used
  38947. to determine if the conditional formatting is applied.
  38948. </p>
  38949. <p>
  38950. If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  38951. </p>
  38952. @return the first formula
  38953. </member>
  38954. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula2">
  38955. The formula used to Evaluate the second operand of the comparison when
  38956. comparison type is {@link #CONDITION_TYPE_CELL_VALUE_IS} and operator
  38957. is either {@link ComparisonOperator#BETWEEN} or {@link ComparisonOperator#NOT_BETWEEN}
  38958. @return the second formula
  38959. </member>
  38960. <member name="T:NPOI.SS.UserModel.ICreationHelper">
  38961. An object that handles instantiating concrete
  38962. classes of the various instances one needs for
  38963. HSSF and XSSF.
  38964. Works around a major shortcoming in Java, where we
  38965. can't have static methods on interfaces or abstract
  38966. classes.
  38967. This allows you to get the appropriate class for
  38968. a given interface, without you having to worry
  38969. about if you're dealing with HSSF or XSSF, despite
  38970. Java being quite rubbish.
  38971. </member>
  38972. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateRichTextString(System.String)">
  38973. Creates a new RichTextString instance
  38974. @param text The text to Initialise the RichTextString with
  38975. </member>
  38976. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateDataFormat">
  38977. Creates a new DataFormat instance
  38978. </member>
  38979. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateHyperlink(NPOI.SS.UserModel.HyperlinkType)">
  38980. Creates a new Hyperlink, of the given type
  38981. </member>
  38982. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateFormulaEvaluator">
  38983. Creates FormulaEvaluator - an object that Evaluates formula cells.
  38984. @return a FormulaEvaluator instance
  38985. </member>
  38986. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateExtendedColor">
  38987. Creates a XSSF-style Color object, used for extended sheet
  38988. formattings and conditional formattings
  38989. </member>
  38990. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.String)">
  38991. get the format index that matches the given format string.
  38992. Creates a new format if one is not found. Aliases text to the proper format.
  38993. @param format string matching a built in format
  38994. @return index of format.
  38995. </member>
  38996. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.Int16)">
  38997. get the format string that matches the given format index
  38998. @param index of a format
  38999. @return string represented at index of format or null if there is not a format at that index
  39000. </member>
  39001. <!-- Badly formed XML comment ignored for member "T:NPOI.SS.UserModel.DataFormatter" -->
  39002. <member name="F:NPOI.SS.UserModel.DataFormatter.numPattern">
  39003. Pattern to find a number FormatBase: "0" or "#"
  39004. </member>
  39005. <member name="F:NPOI.SS.UserModel.DataFormatter.amPmPattern">
  39006. Pattern to find "AM/PM" marker
  39007. </member>
  39008. <member name="F:NPOI.SS.UserModel.DataFormatter.localePatternGroup">
  39009. A regex to find patterns like [$$-1009] and [$�-452].
  39010. Note that we don't currently process these into locales
  39011. </member>
  39012. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionPattern">
  39013. A regex to identify a fraction pattern.
  39014. This requires that replaceAll("\\?", "#") has already been called
  39015. </member>
  39016. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionStripper">
  39017. A regex to strip junk out of fraction formats
  39018. </member>
  39019. <member name="F:NPOI.SS.UserModel.DataFormatter.alternateGrouping">
  39020. A regex to detect if an alternate grouping character is used
  39021. in a numeric format
  39022. </member>
  39023. <member name="F:NPOI.SS.UserModel.DataFormatter.invalidDateTimeString">
  39024. Cells formatted with a date or time format and which contain invalid date or time values
  39025. show 255 pound signs ("#").
  39026. </member>
  39027. <member name="F:NPOI.SS.UserModel.DataFormatter.decimalSymbols">
  39028. The decimal symbols of the locale used for formatting values.
  39029. </member>
  39030. <member name="F:NPOI.SS.UserModel.DataFormatter.dateSymbols">
  39031. The date symbols of the locale used for formatting values.
  39032. </member>
  39033. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultDateformat">
  39034. A default date format, if no date format was given
  39035. </member>
  39036. <member name="F:NPOI.SS.UserModel.DataFormatter.generalNumberFormat">
  39037. <em>General</em> FormatBase for whole numbers.
  39038. </member>
  39039. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultNumFormat">
  39040. A default FormatBase to use when a number pattern cannot be Parsed.
  39041. </member>
  39042. <member name="F:NPOI.SS.UserModel.DataFormatter.logger">
  39043. For logging any problems we find
  39044. </member>
  39045. <member name="F:NPOI.SS.UserModel.DataFormatter.localeIsAdapting">
  39046. stores if the locale should change according to {@link LocaleUtil#getUserLocale()}
  39047. </member>
  39048. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Boolean)">
  39049. Creates a formatter using the {@link Locale#getDefault() default locale}.
  39050. @param emulateCSV whether to emulate CSV output.
  39051. </member>
  39052. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo)">
  39053. Creates a formatter using the given locale.
  39054. </member>
  39055. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean)">
  39056. Creates a formatter using the given locale.
  39057. @param emulateCSV whether to emulate CSV output.
  39058. </member>
  39059. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean,System.Boolean)">
  39060. Constructor
  39061. </member>
  39062. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormat(NPOI.SS.UserModel.ICell)">
  39063. Return a FormatBase for the given cell if one exists, otherwise try to
  39064. Create one. This method will return <c>null</c> if the any of the
  39065. following is true:
  39066. <ul>
  39067. <li>the cell's style is null</li>
  39068. <li>the style's data FormatBase string is null or empty</li>
  39069. <li>the FormatBase string cannot be recognized as either a number or date</li>
  39070. </ul>
  39071. @param cell The cell to retrieve a FormatBase for
  39072. @return A FormatBase for the FormatBase String
  39073. </member>
  39074. <member name="M:NPOI.SS.UserModel.DataFormatter.CreateFormat(NPOI.SS.UserModel.ICell)">
  39075. Create and return a FormatBase based on the FormatBase string from a cell's
  39076. style. If the pattern cannot be Parsed, return a default pattern.
  39077. @param cell The Excel cell
  39078. @return A FormatBase representing the excel FormatBase. May return null.
  39079. </member>
  39080. <member name="M:NPOI.SS.UserModel.DataFormatter.GetDefaultFormat(NPOI.SS.UserModel.ICell)">
  39081. Returns a default FormatBase for a cell.
  39082. @param cell The cell
  39083. @return a default FormatBase
  39084. </member>
  39085. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedDateString(NPOI.SS.UserModel.ICell)">
  39086. Returns the Formatted value of an Excel date as a <c>String</c> based
  39087. on the cell's <c>DataFormat</c>. i.e. "Thursday, January 02, 2003"
  39088. , "01/02/2003" , "02-Jan" , etc.
  39089. @param cell The cell
  39090. @return a Formatted date string
  39091. </member>
  39092. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedNumberString(NPOI.SS.UserModel.ICell)">
  39093. Returns the Formatted value of an Excel number as a <c>String</c>
  39094. based on the cell's <c>DataFormat</c>. Supported Formats include
  39095. currency, percents, decimals, phone number, SSN, etc.:
  39096. "61.54%", "$100.00", "(800) 555-1234".
  39097. @param cell The cell
  39098. @return a Formatted number string
  39099. </member>
  39100. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String)">
  39101. Formats the given raw cell value, based on the supplied
  39102. FormatBase index and string, according to excel style rules.
  39103. @see #FormatCellValue(Cell)
  39104. </member>
  39105. <member name="M:NPOI.SS.UserModel.DataFormatter.PerformDateFormatting(System.DateTime,NPOI.SS.Util.FormatBase)">
  39106. Performs Excel-style date formatting, using the
  39107. supplied Date and format
  39108. </member>
  39109. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String,System.Boolean)">
  39110. Formats the given raw cell value, based on the supplied
  39111. format index and string, according to excel style rules.
  39112. @see #formatCellValue(Cell)
  39113. </member>
  39114. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell)">
  39115. Returns the Formatted value of a cell as a <c>String</c> regardless
  39116. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  39117. cell value will be Formatted using a default FormatBase.
  39118. When passed a null or blank cell, this method will return an empty
  39119. String (""). Formulas in formula type cells will not be evaluated.
  39120. @param cell The cell
  39121. @return the Formatted cell value as a String
  39122. </member>
  39123. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFormulaEvaluator)">
  39124. Returns the Formatted value of a cell as a <c>String</c> regardless
  39125. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  39126. cell value will be Formatted using a default FormatBase.
  39127. When passed a null or blank cell, this method will return an empty
  39128. String (""). Formula cells will be evaluated using the given
  39129. {@link HSSFFormulaEvaluator} if the evaluator is non-null. If the
  39130. evaluator is null, then the formula String will be returned. The caller
  39131. is responsible for setting the currentRow on the evaluator
  39132. @param cell The cell (can be null)
  39133. @param evaluator The HSSFFormulaEvaluator (can be null)
  39134. @return a string value of the cell
  39135. </member>
  39136. <member name="M:NPOI.SS.UserModel.DataFormatter.SetDefaultNumberFormat(NPOI.SS.Util.FormatBase)">
  39137. Sets a default number FormatBase to be used when the Excel FormatBase cannot be
  39138. Parsed successfully. <b>Note:</b> This is a fall back for when an error
  39139. occurs while parsing an Excel number FormatBase pattern. This will not
  39140. affect cells with the <em>General</em> FormatBase.
  39141. The value that will be passed to the FormatBase's FormatBase method (specified
  39142. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  39143. numeric cell. Therefore the code in the FormatBase method should expect a
  39144. <c>Number</c> value.
  39145. @param FormatBase A FormatBase instance to be used as a default
  39146. @see java.text.FormatBase#FormatBase
  39147. </member>
  39148. <member name="M:NPOI.SS.UserModel.DataFormatter.AddFormat(System.String,NPOI.SS.Util.FormatBase)">
  39149. Adds a new FormatBase to the available formats.
  39150. The value that will be passed to the FormatBase's FormatBase method (specified
  39151. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  39152. numeric cell. Therefore the code in the FormatBase method should expect a
  39153. <c>Number</c> value.
  39154. @param excelformatStr The data FormatBase string
  39155. @param FormatBase A FormatBase instance
  39156. </member>
  39157. <member name="M:NPOI.SS.UserModel.DataFormatter.Update(System.IObservable{System.Object},System.Object)">
  39158. Update formats when locale has been changed
  39159. @param observable usually this is our own Observable instance
  39160. @param localeObj only reacts on Locale objects
  39161. </member>
  39162. <member name="T:NPOI.SS.UserModel.DataFormatter.CellFormatResultWrapper">
  39163. Workaround until we merge {@link DataFormatter} with {@link CellFormat}.
  39164. Constant, non-cachable wrapper around a {@link CellFormatResult}
  39165. </member>
  39166. <member name="T:NPOI.SS.UserModel.ERRORSTYLE">
  39167. Error style constants for error box
  39168. </member>
  39169. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.STOP">
  39170. STOP style
  39171. </member>
  39172. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.WARNING">
  39173. WARNING style
  39174. </member>
  39175. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.INFO">
  39176. INFO style
  39177. </member>
  39178. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorStyle">
  39179. <summary>
  39180. get or set the error style for error box
  39181. </summary>
  39182. </member>
  39183. <member name="P:NPOI.SS.UserModel.IDataValidation.EmptyCellAllowed">
  39184. <summary>
  39185. Setting this allows an empty object as a valid value. Retrieve the settings for empty cells allowed.
  39186. @return True if this object should treats empty as valid value , false otherwise
  39187. </summary>
  39188. <value><c>true</c> if this object should treats empty as valid value, <c>false</c> otherwise</value>
  39189. </member>
  39190. <member name="P:NPOI.SS.UserModel.IDataValidation.SuppressDropDownArrow">
  39191. <summary>
  39192. Useful for list validation objects .
  39193. Useful only list validation objects . This method always returns false if the object isn't a list validation object
  39194. </summary>
  39195. </member>
  39196. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowPromptBox">
  39197. Sets the behaviour when a cell which belongs to this object is selected
  39198. <value><c>true</c> if an prompt box should be displayed , <c>false</c> otherwise</value>
  39199. </member>
  39200. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowErrorBox">
  39201. Sets the behaviour when an invalid value is entered
  39202. <value><c>true</c> if an error box should be displayed , <c>false</c> otherwise</value>
  39203. </member>
  39204. <member name="M:NPOI.SS.UserModel.IDataValidation.CreatePromptBox(System.String,System.String)">
  39205. Sets the title and text for the prompt box . Prompt box is displayed when
  39206. the user selects a cell which belongs to this validation object . In
  39207. order for a prompt box to be displayed you should also use method
  39208. SetShowPromptBox( bool show )
  39209. @param title The prompt box's title
  39210. @param text The prompt box's text
  39211. </member>
  39212. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxTitle">
  39213. @return Prompt box's title or <code>null</code>
  39214. </member>
  39215. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxText">
  39216. @return Prompt box's text or <code>null</code>
  39217. </member>
  39218. <member name="M:NPOI.SS.UserModel.IDataValidation.CreateErrorBox(System.String,System.String)">
  39219. Sets the title and text for the error box . Error box is displayed when
  39220. the user enters an invalid value int o a cell which belongs to this
  39221. validation object . In order for an error box to be displayed you should
  39222. also use method SetShowErrorBox( bool show )
  39223. @param title The error box's title
  39224. @param text The error box's text
  39225. </member>
  39226. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxTitle">
  39227. @return Error box's title or <code>null</code>
  39228. </member>
  39229. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxText">
  39230. @return Error box's text or <code>null</code>
  39231. </member>
  39232. <member name="M:NPOI.SS.UserModel.IDataValidationConstraint.GetValidationType">
  39233. <summary>
  39234. return data validation type of this constraint
  39235. </summary>
  39236. <returns></returns>
  39237. </member>
  39238. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Operator">
  39239. <summary>
  39240. get or set then comparison operator for this constraint
  39241. </summary>
  39242. </member>
  39243. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.ExplicitListValues">
  39244. <summary>
  39245. If validation type is {@link ValidationType#LIST}
  39246. and <code>formula1</code> was comma-separated literal values rather than a range or named range,
  39247. returns list of literal values.
  39248. Otherwise returns <code>null</code>.
  39249. </summary>
  39250. </member>
  39251. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula1">
  39252. <summary>
  39253. get or set the formula for expression 1. May be <code>null</code>
  39254. </summary>
  39255. </member>
  39256. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula2">
  39257. <summary>
  39258. get or set the formula for expression 2. May be <code>null</code>
  39259. </summary>
  39260. </member>
  39261. <member name="T:NPOI.SS.UserModel.ValidationType">
  39262. ValidationType enum
  39263. </member>
  39264. <member name="F:NPOI.SS.UserModel.ValidationType.ANY">
  39265. 'Any value' type - value not restricted
  39266. </member>
  39267. <member name="F:NPOI.SS.UserModel.ValidationType.INTEGER">
  39268. int ('Whole number') type
  39269. </member>
  39270. <member name="F:NPOI.SS.UserModel.ValidationType.DECIMAL">
  39271. Decimal type
  39272. </member>
  39273. <member name="F:NPOI.SS.UserModel.ValidationType.LIST">
  39274. List type ( combo box type )
  39275. </member>
  39276. <member name="F:NPOI.SS.UserModel.ValidationType.DATE">
  39277. Date type
  39278. </member>
  39279. <member name="F:NPOI.SS.UserModel.ValidationType.TIME">
  39280. Time type
  39281. </member>
  39282. <member name="F:NPOI.SS.UserModel.ValidationType.TEXT_LENGTH">
  39283. String length type
  39284. </member>
  39285. <member name="F:NPOI.SS.UserModel.ValidationType.FORMULA">
  39286. Formula ( 'Custom' ) type
  39287. </member>
  39288. <member name="T:NPOI.SS.UserModel.OperatorType">
  39289. Condition operator enum
  39290. </member>
  39291. <member name="F:NPOI.SS.UserModel.OperatorType.IGNORED">
  39292. default value to supply when the operator type is not used
  39293. </member>
  39294. <member name="T:NPOI.SS.UserModel.IDataValidationHelper">
  39295. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  39296. </member>
  39297. <member name="T:NPOI.SS.UserModel.DateUtil">
  39298. <summary>
  39299. Contains methods for dealing with Excel dates.
  39300. @author Michael Harhen
  39301. @author Glen Stampoultzis (glens at apache.org)
  39302. @author Dan Sherman (dsherman at Isisph.com)
  39303. @author Hack Kampbjorn (hak at 2mba.dk)
  39304. @author Alex Jacoby (ajacoby at gmail.com)
  39305. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  39306. @author Thies Wellpott
  39307. </summary>
  39308. </member>
  39309. <member name="F:NPOI.SS.UserModel.DateUtil.date_ptrn1">
  39310. The following patterns are used in {@link #isADateFormat(int, String)}
  39311. </member>
  39312. <member name="M:NPOI.SS.UserModel.DateUtil.absoluteDay(System.DateTime,System.Boolean)">
  39313. <summary>
  39314. Given a Calendar, return the number of days since 1899/12/31.
  39315. </summary>
  39316. <param name="cal">the date</param>
  39317. <param name="use1904windowing">if set to <c>true</c> [use1904windowing].</param>
  39318. <returns>number of days since 1899/12/31</returns>
  39319. </member>
  39320. <member name="M:NPOI.SS.UserModel.DateUtil.DaysInPriorYears(System.Int32,System.Boolean)">
  39321. <summary>
  39322. Return the number of days in prior years since 1900
  39323. </summary>
  39324. <param name="yr">a year (1900 &lt; yr &gt; 4000).</param>
  39325. <param name="use1904windowing"></param>
  39326. <returns>number of days in years prior to yr</returns>
  39327. </member>
  39328. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime)">
  39329. <summary>
  39330. Given a Date, Converts it into a double representing its internal Excel representation,
  39331. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  39332. </summary>
  39333. <param name="date">Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</param>
  39334. <returns>the Date</returns>
  39335. </member>
  39336. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  39337. <summary>
  39338. Gets the excel date.
  39339. </summary>
  39340. <param name="year">The year.</param>
  39341. <param name="month">The month.</param>
  39342. <param name="day">The day.</param>
  39343. <param name="hour">The hour.</param>
  39344. <param name="minute">The minute.</param>
  39345. <param name="second">The second.</param>
  39346. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  39347. <returns></returns>
  39348. </member>
  39349. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime,System.Boolean)">
  39350. <summary>
  39351. Given a Date, Converts it into a double representing its internal Excel representation,
  39352. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  39353. </summary>
  39354. <param name="date">The date.</param>
  39355. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  39356. <returns>Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</returns>
  39357. </member>
  39358. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double)">
  39359. <summary>
  39360. Given an Excel date with using 1900 date windowing, and converts it to a java.util.Date.
  39361. Excel Dates and Times are stored without any timezone
  39362. information. If you know (through other means) that your file
  39363. uses a different TimeZone to the system default, you can use
  39364. this version of the getJavaDate() method to handle it.
  39365. </summary>
  39366. <param name="date">The Excel date.</param>
  39367. <returns>null if date is not a valid Excel date</returns>
  39368. </member>
  39369. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean)">
  39370. Given an Excel date with either 1900 or 1904 date windowing,
  39371. Converts it to a Date.
  39372. NOTE: If the default <c>TimeZone</c> in Java uses Daylight
  39373. Saving Time then the conversion back to an Excel date may not give
  39374. the same value, that Is the comparison
  39375. <CODE>excelDate == GetExcelDate(GetJavaDate(excelDate,false))</CODE>
  39376. Is not always true. For example if default timezone Is
  39377. <c>Europe/Copenhagen</c>, on 2004-03-28 the minute after
  39378. 01:59 CET Is 03:00 CEST, if the excel date represents a time between
  39379. 02:00 and 03:00 then it Is Converted to past 03:00 summer time
  39380. @param date The Excel date.
  39381. @param use1904windowing true if date uses 1904 windowing,
  39382. or false if using 1900 date windowing.
  39383. @return Java representation of the date, or null if date Is not a valid Excel date
  39384. @see TimeZone
  39385. </member>
  39386. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone)">
  39387. Given an Excel date with either 1900 or 1904 date windowing,
  39388. converts it to a java.util.Date.
  39389. Excel Dates and Times are stored without any timezone
  39390. information. If you know (through other means) that your file
  39391. uses a different TimeZone to the system default, you can use
  39392. this version of the getJavaDate() method to handle it.
  39393. @param date The Excel date.
  39394. @param tz The TimeZone to evaluate the date in
  39395. @param use1904windowing true if date uses 1904 windowing,
  39396. or false if using 1900 date windowing.
  39397. @return Java representation of the date, or null if date is not a valid Excel date
  39398. </member>
  39399. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  39400. Given an Excel date with either 1900 or 1904 date windowing,
  39401. converts it to a java.util.Date.
  39402. Excel Dates and Times are stored without any timezone
  39403. information. If you know (through other means) that your file
  39404. uses a different TimeZone to the system default, you can use
  39405. this version of the getJavaDate() method to handle it.
  39406. @param date The Excel date.
  39407. @param tz The TimeZone to evaluate the date in
  39408. @param use1904windowing true if date uses 1904 windowing,
  39409. or false if using 1900 date windowing.
  39410. @param roundSeconds round to closest second
  39411. @return Java representation of the date, or null if date is not a valid Excel date
  39412. </member>
  39413. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean)">
  39414. Get EXCEL date as Java Calendar with given time zone.
  39415. @param date The Excel date.
  39416. @param use1904windowing true if date uses 1904 windowing,
  39417. or false if using 1900 date windowing.
  39418. @param timeZone The TimeZone to evaluate the date in
  39419. @return Java representation of the date, or null if date is not a valid Excel date
  39420. </member>
  39421. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  39422. <summary>
  39423. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  39424. </summary>
  39425. <param name="date">The Excel date.</param>
  39426. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  39427. <param name="timeZone"></param>
  39428. <param name="roundSeconds"></param>
  39429. <returns>null if date is not a valid Excel date</returns>
  39430. </member>
  39431. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTime(System.String)">
  39432. <summary>
  39433. Converts a string of format "HH:MM" or "HH:MM:SS" to its (Excel) numeric equivalent
  39434. </summary>
  39435. <param name="timeStr">The time STR.</param>
  39436. <returns> a double between 0 and 1 representing the fraction of the day</returns>
  39437. </member>
  39438. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTimeInternal(System.String)">
  39439. <summary>
  39440. Converts the time internal.
  39441. </summary>
  39442. <param name="timeStr">The time STR.</param>
  39443. <returns></returns>
  39444. </member>
  39445. <member name="M:NPOI.SS.UserModel.DateUtil.IsADateFormat(System.Int32,System.String)">
  39446. <summary>
  39447. Given a format ID and its format String, will Check to see if the
  39448. format represents a date format or not.
  39449. Firstly, it will Check to see if the format ID corresponds to an
  39450. internal excel date format (eg most US date formats)
  39451. If not, it will Check to see if the format string only Contains
  39452. date formatting Chars (ymd-/), which covers most
  39453. non US date formats.
  39454. </summary>
  39455. <param name="formatIndex">The index of the format, eg from ExtendedFormatRecord.GetFormatIndex</param>
  39456. <param name="formatString">The format string, eg from FormatRecord.GetFormatString</param>
  39457. <returns>
  39458. <c>true</c> if [is A date format] [the specified format index]; otherwise, <c>false</c>.
  39459. </returns>
  39460. </member>
  39461. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDate(System.String)">
  39462. <summary>
  39463. Converts a string of format "YYYY/MM/DD" to its (Excel) numeric equivalent
  39464. </summary>
  39465. <param name="dateStr">The date STR.</param>
  39466. <returns>a double representing the (integer) number of days since the start of the Excel epoch</returns>
  39467. </member>
  39468. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDateInternal(System.String)">
  39469. <summary>
  39470. Parses the YYYYMMDD date internal.
  39471. </summary>
  39472. <param name="timeStr">The time string.</param>
  39473. <returns></returns>
  39474. </member>
  39475. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32)">
  39476. <summary>
  39477. Parses the int.
  39478. </summary>
  39479. <param name="strVal">The string value.</param>
  39480. <param name="fieldName">Name of the field.</param>
  39481. <param name="rangeMax">The range max.</param>
  39482. <returns></returns>
  39483. </member>
  39484. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32,System.Int32)">
  39485. <summary>
  39486. Parses the int.
  39487. </summary>
  39488. <param name="strVal">The STR val.</param>
  39489. <param name="fieldName">Name of the field.</param>
  39490. <param name="lowerLimit">The lower limit.</param>
  39491. <param name="upperLimit">The upper limit.</param>
  39492. <returns></returns>
  39493. </member>
  39494. <member name="M:NPOI.SS.UserModel.DateUtil.IsInternalDateFormat(System.Int32)">
  39495. <summary>
  39496. Given a format ID this will Check whether the format represents an internal excel date format or not.
  39497. </summary>
  39498. <param name="format">The format.</param>
  39499. </member>
  39500. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellDateFormatted(NPOI.SS.UserModel.ICell)">
  39501. <summary>
  39502. Check if a cell Contains a date
  39503. Since dates are stored internally in Excel as double values
  39504. we infer it Is a date if it Is formatted as such.
  39505. </summary>
  39506. <param name="cell">The cell.</param>
  39507. </member>
  39508. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellInternalDateFormatted(NPOI.SS.UserModel.ICell)">
  39509. <summary>
  39510. Check if a cell contains a date, Checking only for internal excel date formats.
  39511. As Excel stores a great many of its dates in "non-internal" date formats, you will not normally want to use this method.
  39512. </summary>
  39513. <param name="cell">The cell.</param>
  39514. </member>
  39515. <member name="M:NPOI.SS.UserModel.DateUtil.IsValidExcelDate(System.Double)">
  39516. <summary>
  39517. Given a double, Checks if it Is a valid Excel date.
  39518. </summary>
  39519. <param name="value">the double value.</param>
  39520. <returns>
  39521. <c>true</c> if [is valid excel date] [the specified value]; otherwise, <c>false</c>.
  39522. </returns>
  39523. </member>
  39524. <member name="T:NPOI.SS.UserModel.IDrawing">
  39525. @author Yegor Kozlov
  39526. </member>
  39527. <member name="M:NPOI.SS.UserModel.IDrawing.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  39528. Creates a picture.
  39529. @param anchor the client anchor describes how this picture is
  39530. attached to the sheet.
  39531. @param pictureIndex the index of the picture in the workbook collection
  39532. of pictures.
  39533. @return the newly created picture.
  39534. </member>
  39535. <member name="M:NPOI.SS.UserModel.IDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  39536. Creates a comment.
  39537. @param anchor the client anchor describes how this comment is attached
  39538. to the sheet.
  39539. @return the newly created comment.
  39540. </member>
  39541. <member name="M:NPOI.SS.UserModel.IDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  39542. Creates a chart.
  39543. @param anchor the client anchor describes how this chart is attached to
  39544. the sheet.
  39545. @return the newly created chart
  39546. </member>
  39547. <member name="M:NPOI.SS.UserModel.IDrawing.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  39548. Creates a new client anchor and sets the top-left and bottom-right
  39549. coordinates of the anchor.
  39550. @param dx1 the x coordinate in EMU within the first cell.
  39551. @param dy1 the y coordinate in EMU within the first cell.
  39552. @param dx2 the x coordinate in EMU within the second cell.
  39553. @param dy2 the y coordinate in EMU within the second cell.
  39554. @param col1 the column (0 based) of the first cell.
  39555. @param row1 the row (0 based) of the first cell.
  39556. @param col2 the column (0 based) of the second cell.
  39557. @param row2 the row (0 based) of the second cell.
  39558. @return the newly created client anchor
  39559. </member>
  39560. <member name="T:NPOI.SS.UserModel.ExcelStyleDateFormatter">
  39561. A wrapper around a {@link SimpleDateFormat} instance,
  39562. which handles a few Excel-style extensions that
  39563. are not supported by {@link SimpleDateFormat}.
  39564. Currently, the extensions are around the handling
  39565. of elapsed time, eg rendering 1 day 2 hours
  39566. as 26 hours.
  39567. </member>
  39568. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.ProcessFormatPattern(System.String)">
  39569. Takes a format String, and Replaces Excel specific bits
  39570. with our detection sequences
  39571. </member>
  39572. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.SetDateToBeFormatted(System.Double)">
  39573. Used to let us know what the date being
  39574. formatted is, in Excel terms, which we
  39575. may wish to use when handling elapsed
  39576. times.
  39577. </member>
  39578. <member name="F:NPOI.SS.UserModel.FontUnderlineType.None">
  39579. not underlined
  39580. </member>
  39581. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Single">
  39582. single (normal) underline
  39583. </member>
  39584. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Double">
  39585. double underlined
  39586. </member>
  39587. <member name="F:NPOI.SS.UserModel.FontUnderlineType.SingleAccounting">
  39588. accounting style single underline
  39589. </member>
  39590. <member name="F:NPOI.SS.UserModel.FontUnderlineType.DoubleAccounting">
  39591. accounting style double underline
  39592. </member>
  39593. <member name="F:NPOI.SS.UserModel.FontSuperScript.None">
  39594. no type Offsetting (not super or subscript)
  39595. </member>
  39596. <member name="F:NPOI.SS.UserModel.FontSuperScript.Super">
  39597. superscript
  39598. </member>
  39599. <member name="F:NPOI.SS.UserModel.FontSuperScript.Sub">
  39600. subscript
  39601. </member>
  39602. <member name="F:NPOI.SS.UserModel.FontColor.None">
  39603. <summary>
  39604. Allow accessing the Initial value.
  39605. </summary>
  39606. </member>
  39607. <member name="F:NPOI.SS.UserModel.FontColor.Normal">
  39608. normal type of black color.
  39609. </member>
  39610. <member name="F:NPOI.SS.UserModel.FontColor.Red">
  39611. Dark Red color
  39612. </member>
  39613. <member name="F:NPOI.SS.UserModel.FontBoldWeight.None">
  39614. <summary>
  39615. Allow accessing the Initial value.
  39616. </summary>
  39617. </member>
  39618. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Normal">
  39619. Normal boldness (not bold)
  39620. </member>
  39621. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Bold">
  39622. Bold boldness (bold)
  39623. </member>
  39624. <member name="P:NPOI.SS.UserModel.IFont.FontName">
  39625. <summary>
  39626. get the name for the font (i.e. Arial)
  39627. </summary>
  39628. </member>
  39629. <member name="P:NPOI.SS.UserModel.IFont.FontHeight">
  39630. <summary>
  39631. Get the font height in unit's of 1/20th of a point.
  39632. </summary>
  39633. <remarks>
  39634. Maybe you might want to use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  39635. </remarks>
  39636. <see cref="P:NPOI.SS.UserModel.IFont.FontHeightInPoints"/>
  39637. </member>
  39638. <member name="P:NPOI.SS.UserModel.IFont.FontHeightInPoints">
  39639. <summary>
  39640. Get the font height in points.
  39641. </summary>
  39642. <remarks>
  39643. This will return the same font height that is shown in Excel, such as 10 or 14 or 28.
  39644. </remarks>
  39645. <see cref="P:NPOI.SS.UserModel.IFont.FontHeight"/>
  39646. </member>
  39647. <member name="P:NPOI.SS.UserModel.IFont.IsItalic">
  39648. <summary>
  39649. get whether to use italics or not
  39650. </summary>
  39651. </member>
  39652. <member name="P:NPOI.SS.UserModel.IFont.IsStrikeout">
  39653. <summary>
  39654. get whether to use a strikeout horizontal line through the text or not
  39655. </summary>
  39656. </member>
  39657. <member name="P:NPOI.SS.UserModel.IFont.Color">
  39658. get the color for the font
  39659. @return color to use
  39660. @see #COLOR_NORMAL
  39661. @see #COLOR_RED
  39662. @see NPOI.HSSF.usermodel.HSSFPalette#GetColor(short)
  39663. </member>
  39664. <member name="P:NPOI.SS.UserModel.IFont.TypeOffset">
  39665. <summary>
  39666. get type of text underlining to use
  39667. </summary>
  39668. </member>
  39669. <member name="P:NPOI.SS.UserModel.IFont.Underline">
  39670. <summary>
  39671. get type of text underlining to use
  39672. </summary>
  39673. </member>
  39674. <member name="P:NPOI.SS.UserModel.IFont.Charset">
  39675. <summary>
  39676. get character-set to use.
  39677. </summary>
  39678. <value>ANSI_CHARSET,DEFAULT_CHARSET,SYMBOL_CHARSET </value>
  39679. </member>
  39680. <member name="P:NPOI.SS.UserModel.IFont.Index">
  39681. <summary>
  39682. get the index within the Workbook (sequence within the collection of Font objects)
  39683. </summary>
  39684. </member>
  39685. <member name="M:NPOI.SS.UserModel.IFont.CloneStyleFrom(NPOI.SS.UserModel.IFont)">
  39686. <summary>
  39687. Copies the style from another font into this one
  39688. </summary>
  39689. </member>
  39690. <member name="T:NPOI.SS.UserModel.FontCharset">
  39691. Charset represents the basic set of characters associated with a font (that it can display), and
  39692. corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language.
  39693. @author Gisella Bronzetti
  39694. </member>
  39695. <member name="P:NPOI.SS.UserModel.FontCharset.Value">
  39696. Returns value of this charset
  39697. @return value of this charset
  39698. </member>
  39699. <member name="T:NPOI.SS.UserModel.FontFamily">
  39700. The font family this font belongs to. A font family is a set of fonts having common stroke width and serif
  39701. characteristics. The font name overrides when there are conflicting values.
  39702. @author Gisella Bronzetti
  39703. </member>
  39704. <member name="P:NPOI.SS.UserModel.FontFamily.Value">
  39705. Returns index of this font family
  39706. @return index of this font family
  39707. </member>
  39708. <member name="T:NPOI.SS.UserModel.IFontFormatting">
  39709. High level representation for Font Formatting component
  39710. of Conditional Formatting Settings
  39711. @author Dmitriy Kumshayev
  39712. @author Yegor Kozlov
  39713. </member>
  39714. <member name="P:NPOI.SS.UserModel.IFontFormatting.EscapementType">
  39715. <summary>
  39716. get or set the type of super or subscript for the font
  39717. </summary>
  39718. </member>
  39719. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColorIndex">
  39720. <summary>
  39721. get or set font color index
  39722. </summary>
  39723. </member>
  39724. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColor">
  39725. <summary>
  39726. get or set the colour of the font, or null if no colour applied
  39727. </summary>
  39728. </member>
  39729. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontHeight">
  39730. <summary>
  39731. get or set the height of the font in 1/20th point units
  39732. </summary>
  39733. </member>
  39734. <member name="P:NPOI.SS.UserModel.IFontFormatting.UnderlineType">
  39735. <summary>
  39736. get or set the type of underlining for the font
  39737. </summary>
  39738. </member>
  39739. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsBold">
  39740. Get whether the font weight is Set to bold or not
  39741. @return bold - whether the font is bold or not
  39742. </member>
  39743. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsItalic">
  39744. @return true if font style was Set to <i>italic</i>
  39745. </member>
  39746. <member name="M:NPOI.SS.UserModel.IFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  39747. Set font style options.
  39748. @param italic - if true, Set posture style to italic, otherwise to normal
  39749. @param bold if true, Set font weight to bold, otherwise to normal
  39750. </member>
  39751. <member name="M:NPOI.SS.UserModel.IFontFormatting.ResetFontStyle">
  39752. Set font style options to default values (non-italic, non-bold)
  39753. </member>
  39754. <member name="T:NPOI.SS.UserModel.FontScheme">
  39755. Defines the font scheme to which this font belongs.
  39756. When a font defInition is part of a theme defInition, then the font is categorized as either a major or minor font scheme component.
  39757. 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
  39758. theme.
  39759. Usually major fonts are used for styles like headings, and minor fonts are used for body and paragraph text.
  39760. @author Gisella Bronzetti
  39761. </member>
  39762. <member name="T:NPOI.SS.UserModel.IFooter">
  39763. <summary>
  39764. Common defInition of a HSSF or XSSF page footer.
  39765. For a list of all the different fields that can be
  39766. placed into a footer, such as page number,
  39767. bold, underline etc, see
  39768. </summary>
  39769. </member>
  39770. <member name="T:NPOI.SS.UserModel.FormulaErrorEnum">
  39771. Enumerates error values in SpreadsheetML formula calculations.
  39772. See also OOO's excelfileformat.pdf (2.5.6)
  39773. </member>
  39774. <member name="F:NPOI.SS.UserModel.FormulaError.NULL">
  39775. Intended to indicate when two areas are required to intersect, but do not.
  39776. <p>Example:
  39777. In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary
  39778. intersection operator, when a comma was intended. end example]
  39779. </p>
  39780. </member>
  39781. <member name="F:NPOI.SS.UserModel.FormulaError.DIV0">
  39782. Intended to indicate when any number, including zero, is divided by zero.
  39783. Note: However, any error code divided by zero results in that error code.
  39784. </member>
  39785. <member name="F:NPOI.SS.UserModel.FormulaError.VALUE">
  39786. Intended to indicate when an incompatible type argument is passed to a function, or
  39787. an incompatible type operand is used with an operator.
  39788. <p>Example:
  39789. In the case of a function argument, text was expected, but a number was provided
  39790. </p>
  39791. </member>
  39792. <member name="F:NPOI.SS.UserModel.FormulaError.REF">
  39793. Intended to indicate when a cell reference is invalid.
  39794. <p>Example:
  39795. If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted,
  39796. a #REF! error results. If a worksheet does not support 20,001 columns,
  39797. OFFSET(A1,0,20000) will result in a #REF! error.
  39798. </p>
  39799. </member>
  39800. <member name="F:NPOI.SS.UserModel.FormulaError.NUM">
  39801. Intended to indicate when an argument to a function has a compatible type, but has a
  39802. value that is outside the domain over which that function is defined. (This is known as
  39803. a domain error.)
  39804. <p>Example:
  39805. Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
  39806. </p>
  39807. Intended to indicate that the result of a function cannot be represented in a value of
  39808. the specified type, typically due to extreme magnitude. (This is known as a range
  39809. error.)
  39810. <p>Example: FACT(1000) might result in a range error. </p>
  39811. </member>
  39812. <member name="F:NPOI.SS.UserModel.FormulaError.NA">
  39813. Intended to indicate when a designated value is not available.
  39814. <p>Example:
  39815. Some functions, such as SUMX2MY2, perform a series of operations on corresponding
  39816. elements in two arrays. If those arrays do not have the same number of elements, then
  39817. for some elements in the longer array, there are no corresponding elements in the
  39818. shorter one; that is, one or more values in the shorter array are not available.
  39819. </p>
  39820. This error value can be produced by calling the function NA
  39821. </member>
  39822. <member name="F:NPOI.SS.UserModel.FormulaError.CIRCULAR_REF">
  39823. POI specific code to indicate that there is a circular reference
  39824. in the formula
  39825. </member>
  39826. <member name="F:NPOI.SS.UserModel.FormulaError.FUNCTION_NOT_IMPLEMENTED">
  39827. POI specific code to indicate that the funcition required is
  39828. not implemented in POI
  39829. </member>
  39830. <member name="P:NPOI.SS.UserModel.FormulaError.Code">
  39831. @return numeric code of the error
  39832. </member>
  39833. <member name="P:NPOI.SS.UserModel.FormulaError.LongCode">
  39834. @return long (internal) numeric code of the error
  39835. </member>
  39836. <member name="P:NPOI.SS.UserModel.FormulaError.String">
  39837. @return string representation of the error
  39838. </member>
  39839. <member name="T:NPOI.SS.UserModel.IFormulaEvaluator">
  39840. Evaluates formula cells.<p/>
  39841. For performance reasons, this class keeps a cache of all previously calculated intermediate
  39842. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  39843. calls to Evaluate~ methods on this class.
  39844. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  39845. @author Josh Micich
  39846. </member>
  39847. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.ClearAllCachedResultValues">
  39848. Should be called whenever there are Changes to input cells in the Evaluated workbook.
  39849. Failure to call this method after changing cell values will cause incorrect behaviour
  39850. of the Evaluate~ methods of this class
  39851. </member>
  39852. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  39853. Should be called to tell the cell value cache that the specified (value or formula) cell
  39854. has Changed.
  39855. Failure to call this method after changing cell values will cause incorrect behaviour
  39856. of the Evaluate~ methods of this class
  39857. </member>
  39858. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  39859. Should be called to tell the cell value cache that the specified cell has just become a
  39860. formula cell, or the formula text has Changed
  39861. </member>
  39862. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  39863. Should be called to tell the cell value cache that the specified (value or formula) cell
  39864. has changed.
  39865. Failure to call this method after changing cell values will cause incorrect behaviour
  39866. of the evaluate~ methods of this class
  39867. </member>
  39868. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  39869. If cell Contains a formula, the formula is Evaluated and returned,
  39870. else the CellValue simply copies the appropriate cell value from
  39871. the cell and also its cell type. This method should be preferred over
  39872. EvaluateInCell() when the call should not modify the contents of the
  39873. original cell.
  39874. @param cell
  39875. </member>
  39876. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateAll">
  39877. Loops over all cells in all sheets of the associated workbook.
  39878. For cells that contain formulas, their formulas are evaluated,
  39879. and the results are saved. These cells remain as formula cells.
  39880. For cells that do not contain formulas, no changes are made.
  39881. This is a helpful wrapper around looping over all cells, and
  39882. calling evaluateFormulaCell on each one.
  39883. </member>
  39884. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  39885. If cell Contains formula, it Evaluates the formula,
  39886. and saves the result of the formula. The cell
  39887. remains as a formula cell.
  39888. Else if cell does not contain formula, this method leaves
  39889. the cell unChanged.
  39890. Note that the type of the formula result is returned,
  39891. so you know what kind of value is also stored with
  39892. the formula.
  39893. <pre>
  39894. int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell);
  39895. </pre>
  39896. Be aware that your cell will hold both the formula,
  39897. and the result. If you want the cell Replaced with
  39898. the result of the formula, use {@link #EvaluateInCell(Cell)}
  39899. @param cell The cell to Evaluate
  39900. @return The type of the formula result, i.e. -1 if the cell is not a formula,
  39901. or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR
  39902. Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however.
  39903. </member>
  39904. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  39905. If cell Contains formula, it Evaluates the formula, and
  39906. Puts the formula result back into the cell, in place
  39907. of the old formula.
  39908. Else if cell does not contain formula, this method leaves
  39909. the cell unChanged.
  39910. Note that the same instance of Cell is returned to
  39911. allow chained calls like:
  39912. <pre>
  39913. int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType();
  39914. </pre>
  39915. Be aware that your cell value will be Changed to hold the
  39916. result of the formula. If you simply want the formula
  39917. value comPuted for you, use {@link #EvaluateFormulaCell(Cell)}
  39918. @param cell
  39919. </member>
  39920. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.SetupReferencedWorkbooks(System.Collections.Generic.Dictionary{System.String,NPOI.SS.UserModel.IFormulaEvaluator})">
  39921. Sets up the Formula Evaluator to be able to reference and resolve
  39922. links to other workbooks, eg [Test.xls]Sheet1!A1.
  39923. For a workbook referenced as [Test.xls]Sheet1!A1, you should
  39924. supply a map containing the key Test.xls (no square brackets),
  39925. and an open FormulaEvaluator onto that Workbook.
  39926. @param otherWorkbooks Map of workbook names (no square brackets) to an evaluator on that workbook
  39927. </member>
  39928. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.IgnoreMissingWorkbooks">
  39929. Whether to ignore missing references to external workbooks and
  39930. use cached formula results in the main workbook instead.
  39931. <br/>
  39932. In some cases external workbooks referenced by formulas in the main workbook are not available.
  39933. With this method you can control how POI handles such missing references:
  39934. <ul>
  39935. <li>by default ignoreMissingWorkbooks=false and POI throws
  39936. {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  39937. if an external reference cannot be resolved</li>
  39938. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  39939. that already exists in the main workbook</li>
  39940. </ul>
  39941. @param ignore whether to ignore missing references to external workbooks
  39942. </member>
  39943. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.DebugEvaluationOutputForNextEval">
  39944. * Perform detailed output of formula evaluation for next evaluation only?
  39945. * Is for developer use only (also developers using POI for their XLS files).
  39946. * Log-Level WARN is for basic info, INFO for detailed information. These quite
  39947. * high levels are used because you have to explicitly enable this specific logging.
  39948. * @param value whether to perform detailed output
  39949. </member>
  39950. <member name="T:NPOI.SS.UserModel.IHeader">
  39951. <summary>
  39952. Common defInition of a HSSF or XSSF page header.
  39953. For a list of all the different fields that can be
  39954. placed into a header, such as page number,
  39955. bold, underline etc, see
  39956. </summary>
  39957. </member>
  39958. <member name="T:NPOI.SS.UserModel.IHeaderFooter">
  39959. <summary>
  39960. Common interface for NPOI.SS.UserModel.Header and NPOI.SS.UserModel.Footer
  39961. </summary>
  39962. </member>
  39963. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Left">
  39964. <summary>
  39965. Gets or sets the left side of the header or footer.
  39966. </summary>
  39967. <value>The string representing the left side.</value>
  39968. </member>
  39969. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Center">
  39970. <summary>
  39971. Gets or sets the center of the header or footer.
  39972. </summary>
  39973. <value>The string representing the center.</value>
  39974. </member>
  39975. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Right">
  39976. <summary>
  39977. Gets or sets the right side of the header or footer.
  39978. </summary>
  39979. <value>The string representing the right side.</value>
  39980. </member>
  39981. <member name="T:NPOI.SS.UserModel.HorizontalAlignment">
  39982. The enumeration value indicating horizontal alignment of a cell,
  39983. i.e., whether it is aligned general, left, right, horizontally centered, Filled (replicated),
  39984. justified, centered across multiple cells, or distributed.
  39985. </member>
  39986. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.General">
  39987. The horizontal alignment is general-aligned. Text data is left-aligned.
  39988. Numbers, dates, and times are rightaligned. Boolean types are centered.
  39989. Changing the alignment does not change the type of data.
  39990. </member>
  39991. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Left">
  39992. The horizontal alignment is left-aligned, even in Rightto-Left mode.
  39993. Aligns contents at the left edge of the cell. If an indent amount is specified, the contents of
  39994. the cell is indented from the left by the specified number of character spaces. The character spaces are
  39995. based on the default font and font size for the workbook.
  39996. </member>
  39997. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Center">
  39998. The horizontal alignment is centered, meaning the text is centered across the cell.
  39999. </member>
  40000. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Right">
  40001. The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell,
  40002. even in Right-to-Left mode.
  40003. </member>
  40004. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Justify">
  40005. The horizontal alignment is justified (flush left and right).
  40006. For each line of text, aligns each line of the wrapped text in a cell to the right and left
  40007. (except the last line). If no single line of text wraps in the cell, then the text is not justified.
  40008. </member>
  40009. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Fill">
  40010. Indicates that the value of the cell should be Filled
  40011. across the entire width of the cell. If blank cells to the right also have the fill alignment,
  40012. they are also Filled with the value, using a convention similar to centerContinuous.
  40013. <p>
  40014. Additional rules:
  40015. <ol>
  40016. <li>Only whole values can be Appended, not partial values.</li>
  40017. <li>The column will not be widened to 'best fit' the Filled value</li>
  40018. <li>If Appending an Additional occurrence of the value exceeds the boundary of the cell
  40019. left/right edge, don't append the Additional occurrence of the value.</li>
  40020. <li>The display value of the cell is Filled, not the underlying raw number.</li>
  40021. </ol>
  40022. </p>
  40023. </member>
  40024. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.CenterSelection">
  40025. The horizontal alignment is centered across multiple cells.
  40026. The information about how many cells to span is expressed in the Sheet Part,
  40027. in the row of the cell in question. For each cell that is spanned in the alignment,
  40028. a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.
  40029. </member>
  40030. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Distributed">
  40031. Indicates that each 'word' in each line of text inside the cell is evenly distributed
  40032. across the width of the cell, with flush right and left margins.
  40033. <p>
  40034. When there is also an indent value to apply, both the left and right side of the cell
  40035. are pAdded by the indent value.
  40036. </p>
  40037. <p> A 'word' is a set of characters with no space character in them. </p>
  40038. <p> Two lines inside a cell are Separated by a carriage return. </p>
  40039. </member>
  40040. <member name="F:NPOI.SS.UserModel.HyperlinkType.Url">
  40041. <summary>
  40042. Link to an existing file or web page
  40043. </summary>
  40044. </member>
  40045. <member name="F:NPOI.SS.UserModel.HyperlinkType.Document">
  40046. <summary>
  40047. Link to a place in this document
  40048. </summary>
  40049. </member>
  40050. <member name="F:NPOI.SS.UserModel.HyperlinkType.Email">
  40051. <summary>
  40052. Link to an E-mail Address
  40053. </summary>
  40054. </member>
  40055. <member name="F:NPOI.SS.UserModel.HyperlinkType.File">
  40056. <summary>
  40057. Link to a file
  40058. </summary>
  40059. </member>
  40060. <member name="T:NPOI.SS.UserModel.IHyperlink">
  40061. <summary>
  40062. Represents an Excel hyperlink.
  40063. </summary>
  40064. </member>
  40065. <member name="P:NPOI.SS.UserModel.IHyperlink.Address">
  40066. <summary>
  40067. Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  40068. </summary>
  40069. </member>
  40070. <member name="P:NPOI.SS.UserModel.IHyperlink.Label">
  40071. <summary>
  40072. text label for this hyperlink
  40073. </summary>
  40074. </member>
  40075. <member name="P:NPOI.SS.UserModel.IHyperlink.Type">
  40076. <summary>
  40077. the type of this hyperlink
  40078. </summary>
  40079. </member>
  40080. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstRow">
  40081. <summary>
  40082. the row of the first cell that Contains the hyperlink
  40083. </summary>
  40084. </member>
  40085. <member name="P:NPOI.SS.UserModel.IHyperlink.LastRow">
  40086. <summary>
  40087. the row of the last cell that Contains the hyperlink
  40088. </summary>
  40089. </member>
  40090. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstColumn">
  40091. <summary>
  40092. the column of the first cell that Contains the hyperlink
  40093. </summary>
  40094. </member>
  40095. <member name="P:NPOI.SS.UserModel.IHyperlink.LastColumn">
  40096. <summary>
  40097. the column of the last cell that Contains the hyperlink
  40098. </summary>
  40099. </member>
  40100. <member name="T:NPOI.SS.UserModel.IName">
  40101. Represents a defined name for a range of cells.
  40102. A name is a meaningful shorthand that makes it easier to understand the purpose of a
  40103. cell reference, constant or a formula.
  40104. </member>
  40105. <member name="P:NPOI.SS.UserModel.IName.SheetName">
  40106. Get the sheets name which this named range is referenced to
  40107. @return sheet name, which this named range refered to
  40108. </member>
  40109. <member name="P:NPOI.SS.UserModel.IName.NameName">
  40110. Gets the name of the named range
  40111. @return named range name
  40112. </member>
  40113. <member name="P:NPOI.SS.UserModel.IName.RefersToFormula">
  40114. Returns the formula that the name is defined to refer to.
  40115. @return the reference for this name, <code>null</code> if it has not been set yet. Never empty string
  40116. @see #SetRefersToFormula(String)
  40117. </member>
  40118. <member name="P:NPOI.SS.UserModel.IName.IsFunctionName">
  40119. Checks if this name is a function name
  40120. @return true if this name is a function name
  40121. </member>
  40122. <member name="P:NPOI.SS.UserModel.IName.IsDeleted">
  40123. Checks if this name points to a cell that no longer exists
  40124. @return <c>true</c> if the name refers to a deleted cell, <c>false</c> otherwise
  40125. </member>
  40126. <member name="P:NPOI.SS.UserModel.IName.SheetIndex">
  40127. Returns the sheet index this name applies to.
  40128. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  40129. </member>
  40130. <member name="P:NPOI.SS.UserModel.IName.Comment">
  40131. Returns the comment the user provided when the name was Created.
  40132. @return the user comment for this named range
  40133. </member>
  40134. <member name="M:NPOI.SS.UserModel.IName.SetFunction(System.Boolean)">
  40135. Indicates that the defined name refers to a user-defined function.
  40136. This attribute is used when there is an add-in or other code project associated with the file.
  40137. @param value <c>true</c> indicates the name refers to a function.
  40138. </member>
  40139. <member name="T:NPOI.SS.UserModel.PageOrder">
  40140. Specifies printed page order.
  40141. @author Gisella Bronzetti
  40142. </member>
  40143. <member name="F:NPOI.SS.UserModel.PageOrder.DOWN_THEN_OVER">
  40144. Order pages vertically first, then move horizontally.
  40145. </member>
  40146. <member name="F:NPOI.SS.UserModel.PageOrder.OVER_THEN_DOWN">
  40147. Order pages horizontally first, then move vertically
  40148. </member>
  40149. <member name="T:NPOI.SS.UserModel.PaperSize">
  40150. The enumeration value indicating the possible paper size for a sheet
  40151. @author Daniele Montagni
  40152. </member>
  40153. <member name="F:NPOI.SS.UserModel.PaperSize.PRINTER_DEFAULT_PAPERSIZE">
  40154. <summary>
  40155. Allow accessing the Initial value.
  40156. </summary>
  40157. </member>
  40158. <member name="F:NPOI.SS.UserModel.PaperSize.A4_TRANSVERSE_PAPERSIZE">
  40159. <summary>
  40160. A4 Transverse - 210x297 mm
  40161. </summary>
  40162. </member>
  40163. <member name="F:NPOI.SS.UserModel.PaperSize.A4_PLUS_PAPERSIZE">
  40164. <summary>
  40165. A4 Plus - 210x330 mm
  40166. </summary>
  40167. </member>
  40168. <member name="F:NPOI.SS.UserModel.PaperSize.LETTER_ROTATED_PAPERSIZE">
  40169. <summary>
  40170. US Letter Rotated 11 x 8 1/2 in
  40171. </summary>
  40172. </member>
  40173. <member name="F:NPOI.SS.UserModel.PaperSize.A4_ROTATED_PAPERSIZE">
  40174. <summary>
  40175. A4 Rotated - 297x210 mm */
  40176. </summary>
  40177. </member>
  40178. <member name="T:NPOI.SS.UserModel.IPatternFormatting">
  40179. @author Yegor Kozlov
  40180. </member>
  40181. <member name="F:NPOI.SS.UserModel.PictureType.Unknown">
  40182. <summary>
  40183. Allow accessing the Initial value.
  40184. </summary>
  40185. </member>
  40186. <member name="F:NPOI.SS.UserModel.PictureType.EMF">
  40187. Extended windows meta file
  40188. </member>
  40189. <member name="F:NPOI.SS.UserModel.PictureType.WMF">
  40190. Windows Meta File
  40191. </member>
  40192. <member name="F:NPOI.SS.UserModel.PictureType.PICT">
  40193. Mac PICT format
  40194. </member>
  40195. <member name="F:NPOI.SS.UserModel.PictureType.JPEG">
  40196. JPEG format
  40197. </member>
  40198. <member name="F:NPOI.SS.UserModel.PictureType.PNG">
  40199. PNG format
  40200. </member>
  40201. <member name="F:NPOI.SS.UserModel.PictureType.DIB">
  40202. Device independent bitmap
  40203. </member>
  40204. <member name="F:NPOI.SS.UserModel.PictureType.GIF">
  40205. GIF image format
  40206. </member>
  40207. <member name="F:NPOI.SS.UserModel.PictureType.TIFF">
  40208. Tag Image File (.tiff)
  40209. </member>
  40210. <member name="F:NPOI.SS.UserModel.PictureType.EPS">
  40211. Encapsulated Postscript (.eps)
  40212. </member>
  40213. <member name="F:NPOI.SS.UserModel.PictureType.BMP">
  40214. Windows Bitmap (.bmp)
  40215. </member>
  40216. <member name="F:NPOI.SS.UserModel.PictureType.WPG">
  40217. WordPerfect graphics (.wpg)
  40218. </member>
  40219. <member name="T:NPOI.SS.UserModel.IPicture">
  40220. Repersents a picture in a SpreadsheetML document
  40221. @author Yegor Kozlov
  40222. </member>
  40223. <member name="M:NPOI.SS.UserModel.IPicture.Resize">
  40224. Reset the image to the dimension of the embedded image
  40225. @see #resize(double, double)
  40226. </member>
  40227. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double)">
  40228. Resize the image proportionally.
  40229. </member>
  40230. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double,System.Double)">
  40231. Resize the image.
  40232. <p>
  40233. Please note, that this method works correctly only for workbooks
  40234. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  40235. If the default font is changed the resized image can be streched vertically or horizontally.
  40236. </p>
  40237. <p>
  40238. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  40239. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  40240. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  40241. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  40242. </p>
  40243. @param scaleX the amount by which the image width is multiplied relative to the original width.
  40244. @param scaleY the amount by which the image height is multiplied relative to the original height.
  40245. </member>
  40246. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize">
  40247. Calculate the preferred size for this picture.
  40248. @return XSSFClientAnchor with the preferred size for this image
  40249. </member>
  40250. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize(System.Double,System.Double)">
  40251. Calculate the preferred size for this picture.
  40252. @param scaleX the amount by which image width is multiplied relative to the original width.
  40253. @param scaleY the amount by which image height is multiplied relative to the original height.
  40254. @return ClientAnchor with the preferred size for this image
  40255. </member>
  40256. <member name="M:NPOI.SS.UserModel.IPicture.GetImageDimension">
  40257. Return the dimension of the embedded image in pixel
  40258. @return image dimension in pixels
  40259. </member>
  40260. <member name="P:NPOI.SS.UserModel.IPicture.PictureData">
  40261. Return picture data for this picture
  40262. @return picture data for this picture
  40263. </member>
  40264. <member name="P:NPOI.SS.UserModel.IPicture.ClientAnchor">
  40265. @return the anchor that is used by this picture
  40266. </member>
  40267. <member name="P:NPOI.SS.UserModel.IPictureData.Data">
  40268. Gets the picture data.
  40269. @return the picture data.
  40270. </member>
  40271. <member name="M:NPOI.SS.UserModel.IPictureData.SuggestFileExtension">
  40272. Suggests a file extension for this image.
  40273. @return the file extension.
  40274. </member>
  40275. <member name="P:NPOI.SS.UserModel.IPictureData.MimeType">
  40276. Returns the mime type for the image
  40277. </member>
  40278. <member name="P:NPOI.SS.UserModel.IPictureData.PictureType">
  40279. @return the POI internal image type, 0 if unknown image type
  40280. @see Workbook#PICTURE_TYPE_DIB
  40281. @see Workbook#PICTURE_TYPE_EMF
  40282. @see Workbook#PICTURE_TYPE_JPEG
  40283. @see Workbook#PICTURE_TYPE_PICT
  40284. @see Workbook#PICTURE_TYPE_PNG
  40285. @see Workbook#PICTURE_TYPE_WMF
  40286. </member>
  40287. <member name="T:NPOI.SS.UserModel.PrintCellComments">
  40288. These enumerations specify how cell comments shall be displayed for paper printing purposes.
  40289. @author Gisella Bronzetti
  40290. </member>
  40291. <member name="F:NPOI.SS.UserModel.PrintCellComments.NONE">
  40292. Do not print cell comments.
  40293. </member>
  40294. <member name="F:NPOI.SS.UserModel.PrintCellComments.AS_DISPLAYED">
  40295. Print cell comments as displayed.
  40296. </member>
  40297. <member name="F:NPOI.SS.UserModel.PrintCellComments.AT_END">
  40298. Print cell comments at end of document.
  40299. </member>
  40300. <member name="T:NPOI.SS.UserModel.PrintOrientation">
  40301. The enumeration value indicating the print orientation for a sheet.
  40302. @author Gisella Bronzetti
  40303. </member>
  40304. <member name="F:NPOI.SS.UserModel.PrintOrientation.DEFAULT">
  40305. orientation not specified
  40306. </member>
  40307. <member name="F:NPOI.SS.UserModel.PrintOrientation.PORTRAIT">
  40308. portrait orientation
  40309. </member>
  40310. <member name="F:NPOI.SS.UserModel.PrintOrientation.LANDSCAPE">
  40311. landscape orientations
  40312. </member>
  40313. <member name="T:NPOI.SS.UserModel.DisplayCellErrorType">
  40314. <summary>
  40315. Used by HSSFPrintSetup.CellError property
  40316. </summary>
  40317. </member>
  40318. <member name="P:NPOI.SS.UserModel.IPrintSetup.PaperSize">
  40319. Returns the paper size.
  40320. @return paper size
  40321. </member>
  40322. <member name="P:NPOI.SS.UserModel.IPrintSetup.Scale">
  40323. Returns the scale.
  40324. @return scale
  40325. </member>
  40326. <member name="P:NPOI.SS.UserModel.IPrintSetup.PageStart">
  40327. Returns the page start.
  40328. @return page start
  40329. </member>
  40330. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitWidth">
  40331. Returns the number of pages wide to fit sheet in.
  40332. @return number of pages wide to fit sheet in
  40333. </member>
  40334. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitHeight">
  40335. Returns the number of pages high to fit the sheet in.
  40336. @return number of pages high to fit the sheet in
  40337. </member>
  40338. <member name="P:NPOI.SS.UserModel.IPrintSetup.LeftToRight">
  40339. Returns the left to right print order.
  40340. @return left to right print order
  40341. </member>
  40342. <member name="P:NPOI.SS.UserModel.IPrintSetup.Landscape">
  40343. Returns the landscape mode.
  40344. @return landscape mode
  40345. </member>
  40346. <member name="P:NPOI.SS.UserModel.IPrintSetup.ValidSettings">
  40347. Returns the valid Settings.
  40348. @return valid Settings
  40349. </member>
  40350. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoColor">
  40351. Returns the black and white Setting.
  40352. @return black and white Setting
  40353. </member>
  40354. <member name="P:NPOI.SS.UserModel.IPrintSetup.Draft">
  40355. Returns the draft mode.
  40356. @return draft mode
  40357. </member>
  40358. <member name="P:NPOI.SS.UserModel.IPrintSetup.Notes">
  40359. Returns the print notes.
  40360. @return print notes
  40361. </member>
  40362. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoOrientation">
  40363. Returns the no orientation.
  40364. @return no orientation
  40365. </member>
  40366. <member name="P:NPOI.SS.UserModel.IPrintSetup.UsePage">
  40367. Returns the use page numbers.
  40368. @return use page numbers
  40369. </member>
  40370. <member name="P:NPOI.SS.UserModel.IPrintSetup.HResolution">
  40371. Returns the horizontal resolution.
  40372. @return horizontal resolution
  40373. </member>
  40374. <member name="P:NPOI.SS.UserModel.IPrintSetup.VResolution">
  40375. Returns the vertical resolution.
  40376. @return vertical resolution
  40377. </member>
  40378. <member name="P:NPOI.SS.UserModel.IPrintSetup.HeaderMargin">
  40379. Returns the header margin.
  40380. @return header margin
  40381. </member>
  40382. <member name="P:NPOI.SS.UserModel.IPrintSetup.FooterMargin">
  40383. Returns the footer margin.
  40384. @return footer margin
  40385. </member>
  40386. <member name="P:NPOI.SS.UserModel.IPrintSetup.Copies">
  40387. Returns the number of copies.
  40388. @return number of copies
  40389. </member>
  40390. <member name="T:NPOI.SS.UserModel.IRichTextString">
  40391. Rich text unicode string. These strings can have fonts
  40392. applied to arbitary parts of the string.
  40393. @author Glen Stampoultzis (glens at apache.org)
  40394. @author Jason Height (jheight at apache.org)
  40395. </member>
  40396. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  40397. Applies a font to the specified characters of a string.
  40398. @param startIndex The start index to apply the font to (inclusive)
  40399. @param endIndex The end index to apply the font to (exclusive)
  40400. @param fontIndex The font to use.
  40401. </member>
  40402. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  40403. Applies a font to the specified characters of a string.
  40404. @param startIndex The start index to apply the font to (inclusive)
  40405. @param endIndex The end index to apply to font to (exclusive)
  40406. @param font The index of the font to use.
  40407. </member>
  40408. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  40409. Sets the font of the entire string.
  40410. @param font The font to use.
  40411. </member>
  40412. <member name="M:NPOI.SS.UserModel.IRichTextString.ClearFormatting">
  40413. Removes any formatting that may have been applied to the string.
  40414. </member>
  40415. <member name="P:NPOI.SS.UserModel.IRichTextString.String">
  40416. Returns the plain string representation.
  40417. </member>
  40418. <member name="P:NPOI.SS.UserModel.IRichTextString.Length">
  40419. @return the number of characters in the font.
  40420. </member>
  40421. <member name="P:NPOI.SS.UserModel.IRichTextString.NumFormattingRuns">
  40422. @return The number of formatting Runs used.
  40423. </member>
  40424. <member name="M:NPOI.SS.UserModel.IRichTextString.GetIndexOfFormattingRun(System.Int32)">
  40425. The index within the string to which the specified formatting run applies.
  40426. @param index the index of the formatting run
  40427. @return the index within the string.
  40428. </member>
  40429. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int16)">
  40430. Applies the specified font to the entire string.
  40431. @param fontIndex the font to apply.
  40432. </member>
  40433. <member name="T:NPOI.SS.UserModel.MissingCellPolicy">
  40434. Used to specify the different possible policies
  40435. if for the case of null and blank cells
  40436. </member>
  40437. <member name="T:NPOI.SS.UserModel.IRow">
  40438. <summary>
  40439. High level representation of a row of a spreadsheet.
  40440. </summary>
  40441. </member>
  40442. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32)">
  40443. <summary>
  40444. Use this to create new cells within the row and return it.
  40445. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>.
  40446. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  40447. </summary>
  40448. <param name="column">the column number this cell represents</param>
  40449. <returns>Cell a high level representation of the created cell.</returns>
  40450. <throws>
  40451. ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  40452. (255 for *.xls, 1048576 for *.xlsx)
  40453. </throws>
  40454. </member>
  40455. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  40456. <summary>
  40457. Use this to create new cells within the row and return it.
  40458. 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
  40459. either through calling <code>SetCellValue</code> or <code>SetCellType</code>.
  40460. </summary>
  40461. <param name="column">the column number this cell represents</param>
  40462. <param name="type"></param>
  40463. <returns>Cell a high level representation of the created cell.</returns>
  40464. <throws>ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  40465. (255 for *.xls, 1048576 for *.xlsx)
  40466. </throws>
  40467. </member>
  40468. <member name="M:NPOI.SS.UserModel.IRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  40469. <summary>
  40470. Remove the Cell from this row.
  40471. </summary>
  40472. <param name="cell">the cell to remove</param>
  40473. </member>
  40474. <member name="P:NPOI.SS.UserModel.IRow.RowNum">
  40475. <summary>
  40476. Get row number this row represents
  40477. </summary>
  40478. <returns>the row number (0 based)</returns>
  40479. </member>
  40480. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32)">
  40481. <summary>
  40482. Get the cell representing a given column (logical cell) 0-based. If you
  40483. ask for a cell that is not defined....you get a null.
  40484. </summary>
  40485. <param name="cellnum">0 based column number</param>
  40486. <returns>Cell representing that column or null if undefined.</returns>
  40487. <see cref="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)"/>
  40488. </member>
  40489. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  40490. <summary>
  40491. Returns the cell at the given (0 based) index, with the specified {@link NPOI.SS.usermodel.Row.MissingCellPolicy}
  40492. </summary>
  40493. <returns>the cell at the given (0 based) index</returns>
  40494. <throws>ArgumentException if cellnum &lt; 0 or the specified MissingCellPolicy is invalid</throws>
  40495. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK"/>
  40496. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL"/>
  40497. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK"/>
  40498. </member>
  40499. <member name="P:NPOI.SS.UserModel.IRow.FirstCellNum">
  40500. <summary>
  40501. Get the number of the first cell Contained in this row.
  40502. </summary>
  40503. <returns>
  40504. short representing the first logical cell in the row,
  40505. or -1 if the row does not contain any cells.
  40506. </returns>
  40507. </member>
  40508. <member name="P:NPOI.SS.UserModel.IRow.LastCellNum">
  40509. <summary>
  40510. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  40511. happens to be the 1-based column number of the last cell. This value can be used as a
  40512. standard upper bound when iterating over cells:
  40513. <pre>
  40514. short minColIx = row.GetFirstCellNum();
  40515. short maxColIx = row.GetLastCellNum();
  40516. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  40517. Cell cell = row.GetCell(colIx);
  40518. if(cell == null) {
  40519. continue;
  40520. }
  40521. //... do something with cell
  40522. }
  40523. </pre>
  40524. </summary>
  40525. <returns>
  40526. short representing the last logical cell in the row <b>PLUS ONE</b>,
  40527. or -1 if the row does not contain any cells.
  40528. </returns>
  40529. </member>
  40530. <member name="P:NPOI.SS.UserModel.IRow.PhysicalNumberOfCells">
  40531. <summary>
  40532. Gets the number of defined cells (NOT number of cells in the actual row!).
  40533. That is to say if only columns 0,4,5 have values then there would be 3.
  40534. </summary>
  40535. <returns>int representing the number of defined cells in the row.</returns>
  40536. </member>
  40537. <member name="P:NPOI.SS.UserModel.IRow.ZeroHeight">
  40538. <summary>
  40539. Get whether or not to display this row with 0 height
  40540. </summary>
  40541. <returns>zHeight height is zero or not.</returns>
  40542. </member>
  40543. <member name="P:NPOI.SS.UserModel.IRow.Height">
  40544. <summary>
  40545. Get the row's height measured in twips (1/20th of a point).
  40546. If the height is not set, the default worksheet value is returned,
  40547. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  40548. </summary>
  40549. <returns>row height measured in twips (1/20th of a point)</returns>
  40550. </member>
  40551. <member name="P:NPOI.SS.UserModel.IRow.HeightInPoints">
  40552. <summary>
  40553. Returns row height measured in point size.
  40554. If the height is not set, the default worksheet value is returned,
  40555. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  40556. </summary>
  40557. <returns>row height measured in point size
  40558. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  40559. </returns>
  40560. </member>
  40561. <member name="P:NPOI.SS.UserModel.IRow.IsFormatted">
  40562. <summary>
  40563. Is this row formatted? Most aren't, but some rows
  40564. do have whole-row styles. For those that do, you
  40565. can get the formatting from <see cref="P:NPOI.SS.UserModel.IRow.RowStyle"/>
  40566. </summary>
  40567. </member>
  40568. <member name="P:NPOI.SS.UserModel.IRow.Sheet">
  40569. <summary>
  40570. Returns the Sheet this row belongs to
  40571. </summary>
  40572. <returns>the Sheet that owns this row</returns>
  40573. </member>
  40574. <member name="P:NPOI.SS.UserModel.IRow.RowStyle">
  40575. <summary>
  40576. Returns the whole-row cell styles. Most rows won't
  40577. have one of these, so will return null. Call IsFormmated to check first
  40578. </summary>
  40579. <value>The row style.</value>
  40580. </member>
  40581. <member name="M:NPOI.SS.UserModel.IRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  40582. <summary>
  40583. Moves the supplied cell to a new column, which
  40584. must not already have a cell there!
  40585. </summary>
  40586. <param name="cell">The cell to move</param>
  40587. <param name="newColumn">The new column number (0 based)</param>
  40588. </member>
  40589. <member name="M:NPOI.SS.UserModel.IRow.CopyRowTo(System.Int32)">
  40590. <summary>
  40591. Copy the current row to the target row
  40592. </summary>
  40593. <param name="targetIndex">row index of the target row</param>
  40594. <returns>the new copied row object</returns>
  40595. </member>
  40596. <member name="M:NPOI.SS.UserModel.IRow.CopyCell(System.Int32,System.Int32)">
  40597. <summary>
  40598. Copy the source cell to the target cell. If the target cell exists, the new copied cell will be inserted before the existing one
  40599. </summary>
  40600. <param name="sourceIndex">index of the source cell</param>
  40601. <param name="targetIndex">index of the target cell</param>
  40602. <returns>the new copied cell object</returns>
  40603. </member>
  40604. <member name="P:NPOI.SS.UserModel.IRow.Cells">
  40605. <summary>
  40606. Get cells in the row
  40607. </summary>
  40608. </member>
  40609. <member name="P:NPOI.SS.UserModel.IRow.OutlineLevel">
  40610. <summary>
  40611. Returns the rows outline level. Increased as you
  40612. put it into more groups (outlines), reduced as
  40613. you take it out of them.
  40614. </summary>
  40615. </member>
  40616. <member name="T:NPOI.SS.UserModel.ShapeTypes">
  40617. All known types of automatic shapes in DrawingML
  40618. @author Yegor Kozlov
  40619. </member>
  40620. <member name="F:NPOI.SS.UserModel.ShapeTypes.None">
  40621. <summary>
  40622. Allow accessing the Initial value.
  40623. </summary>
  40624. </member>
  40625. <member name="T:NPOI.SS.UserModel.MarginType">
  40626. <summary>
  40627. Indicate the position of the margin. One of left, right, top and bottom.
  40628. </summary>
  40629. </member>
  40630. <member name="F:NPOI.SS.UserModel.MarginType.LeftMargin">
  40631. <summary>
  40632. referes to the left margin
  40633. </summary>
  40634. </member>
  40635. <member name="F:NPOI.SS.UserModel.MarginType.RightMargin">
  40636. <summary>
  40637. referes to the right margin
  40638. </summary>
  40639. </member>
  40640. <member name="F:NPOI.SS.UserModel.MarginType.TopMargin">
  40641. <summary>
  40642. referes to the top margin
  40643. </summary>
  40644. </member>
  40645. <member name="F:NPOI.SS.UserModel.MarginType.BottomMargin">
  40646. <summary>
  40647. referes to the bottom margin
  40648. </summary>
  40649. </member>
  40650. <member name="T:NPOI.SS.UserModel.PanePosition">
  40651. <summary>
  40652. Define the position of the pane. One of lower/right, upper/right, lower/left and upper/left.
  40653. </summary>
  40654. </member>
  40655. <member name="F:NPOI.SS.UserModel.PanePosition.LowerRight">
  40656. <summary>
  40657. referes to the lower/right corner
  40658. </summary>
  40659. </member>
  40660. <member name="F:NPOI.SS.UserModel.PanePosition.UpperRight">
  40661. <summary>
  40662. referes to the upper/right corner
  40663. </summary>
  40664. </member>
  40665. <member name="F:NPOI.SS.UserModel.PanePosition.LowerLeft">
  40666. <summary>
  40667. referes to the lower/left corner
  40668. </summary>
  40669. </member>
  40670. <member name="F:NPOI.SS.UserModel.PanePosition.UpperLeft">
  40671. <summary>
  40672. referes to the upper/left corner
  40673. </summary>
  40674. </member>
  40675. <member name="T:NPOI.SS.UserModel.ISheet">
  40676. <summary>
  40677. High level representation of a Excel worksheet.
  40678. </summary>
  40679. <remarks>
  40680. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  40681. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  40682. contain text, numbers, dates, and formulas. Cells can also be formatted.
  40683. </remarks>
  40684. </member>
  40685. <member name="M:NPOI.SS.UserModel.ISheet.CreateRow(System.Int32)">
  40686. <summary>
  40687. Create a new row within the sheet and return the high level representation
  40688. </summary>
  40689. <param name="rownum">The row number.</param>
  40690. <returns>high level Row object representing a row in the sheet</returns>
  40691. <see>RemoveRow(Row)</see>
  40692. </member>
  40693. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  40694. <summary>
  40695. Remove a row from this sheet. All cells Contained in the row are Removed as well
  40696. </summary>
  40697. <param name="row">a row to Remove.</param>
  40698. </member>
  40699. <member name="M:NPOI.SS.UserModel.ISheet.GetRow(System.Int32)">
  40700. <summary>
  40701. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  40702. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  40703. </summary>
  40704. <param name="rownum">row to get (0-based).</param>
  40705. <returns>the rownumber or null if its not defined on the sheet</returns>
  40706. </member>
  40707. <member name="P:NPOI.SS.UserModel.ISheet.PhysicalNumberOfRows">
  40708. <summary>
  40709. Returns the number of physically defined rows (NOT the number of rows in the sheet)
  40710. </summary>
  40711. <value>the number of physically defined rows in this sheet.</value>
  40712. </member>
  40713. <member name="P:NPOI.SS.UserModel.ISheet.FirstRowNum">
  40714. <summary>
  40715. Gets the first row on the sheet
  40716. </summary>
  40717. <value>the number of the first logical row on the sheet (0-based).</value>
  40718. </member>
  40719. <member name="P:NPOI.SS.UserModel.ISheet.LastRowNum">
  40720. <summary>
  40721. Gets the last row on the sheet
  40722. </summary>
  40723. <value>last row contained n this sheet (0-based)</value>
  40724. </member>
  40725. <member name="P:NPOI.SS.UserModel.ISheet.ForceFormulaRecalculation">
  40726. <summary>
  40727. whether force formula recalculation.
  40728. </summary>
  40729. </member>
  40730. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnHidden(System.Int32,System.Boolean)">
  40731. <summary>
  40732. Get the visibility state for a given column
  40733. </summary>
  40734. <param name="columnIndex">the column to get (0-based)</param>
  40735. <param name="hidden">the visiblity state of the column</param>
  40736. </member>
  40737. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnHidden(System.Int32)">
  40738. <summary>
  40739. Get the hidden state for a given column
  40740. </summary>
  40741. <param name="columnIndex">the column to set (0-based)</param>
  40742. <returns>hidden - <c>false</c> if the column is visible</returns>
  40743. </member>
  40744. <member name="M:NPOI.SS.UserModel.ISheet.CopyRow(System.Int32,System.Int32)">
  40745. <summary>
  40746. Copy the source row to the target row. If the target row exists, the new copied row will be inserted before the existing one
  40747. </summary>
  40748. <param name="sourceIndex">source index</param>
  40749. <param name="targetIndex">target index</param>
  40750. <returns>the new copied row object</returns>
  40751. </member>
  40752. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnWidth(System.Int32,System.Int32)">
  40753. <summary>
  40754. Set the width (in units of 1/256th of a character width)
  40755. </summary>
  40756. <param name="columnIndex">the column to set (0-based)</param>
  40757. <param name="width">the width in units of 1/256th of a character width</param>
  40758. <remarks>
  40759. The maximum column width for an individual cell is 255 characters.
  40760. This value represents the number of characters that can be displayed
  40761. in a cell that is formatted with the standard font.
  40762. </remarks>
  40763. </member>
  40764. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidth(System.Int32)">
  40765. <summary>
  40766. get the width (in units of 1/256th of a character width )
  40767. </summary>
  40768. <param name="columnIndex">the column to get (0-based)</param>
  40769. <returns>the width in units of 1/256th of a character width</returns>
  40770. </member>
  40771. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidthInPixels(System.Int32)">
  40772. <summary>
  40773. get the width in pixel
  40774. </summary>
  40775. <param name="columnIndex"></param>
  40776. <returns></returns>
  40777. <remarks>
  40778. Please note, that this method works correctly only for workbooks
  40779. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  40780. If the default font is changed the column width can be streched
  40781. </remarks>
  40782. </member>
  40783. <member name="P:NPOI.SS.UserModel.ISheet.DefaultColumnWidth">
  40784. <summary>
  40785. Get the default column width for the sheet (if the columns do not define their own width)
  40786. in characters
  40787. </summary>
  40788. <value>default column width measured in characters.</value>
  40789. </member>
  40790. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeight">
  40791. <summary>
  40792. Get the default row height for the sheet (if the rows do not define their own height) in
  40793. twips (1/20 of a point)
  40794. </summary>
  40795. <value>default row height measured in twips (1/20 of a point)</value>
  40796. </member>
  40797. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints">
  40798. <summary>
  40799. Get the default row height for the sheet (if the rows do not define their own height) in
  40800. points.
  40801. </summary>
  40802. <value>The default row height in points.</value>
  40803. </member>
  40804. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnStyle(System.Int32)">
  40805. <summary>
  40806. Returns the CellStyle that applies to the given
  40807. (0 based) column, or null if no style has been
  40808. set for that column
  40809. </summary>
  40810. <param name="column">The column.</param>
  40811. </member>
  40812. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  40813. <summary>
  40814. Adds a merged region of cells (hence those cells form one)
  40815. </summary>
  40816. <param name="region">(rowfrom/colfrom-rowto/colto) to merge.</param>
  40817. <returns>index of this region</returns>
  40818. </member>
  40819. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegionUnsafe(NPOI.SS.Util.CellRangeAddress)">
  40820. <summary>
  40821. Adds a merged region of cells (hence those cells form one).
  40822. Skips validation. It is possible to create overlapping merged regions
  40823. or create a merged region that intersects a multi-cell array formula
  40824. with this formula, which may result in a corrupt workbook.
  40825. To check for merged regions overlapping array formulas or other merged regions
  40826. after addMergedRegionUnsafe has been called, call {@link #validateMergedRegions()}, which runs in O(n^2) time.
  40827. </summary>
  40828. <param name="region">region to merge</param>
  40829. <returns>index of this region</returns>
  40830. <exception cref="T:System.ArgumentException">if region contains fewer than 2 cells</exception>
  40831. </member>
  40832. <member name="M:NPOI.SS.UserModel.ISheet.ValidateMergedRegions">
  40833. <summary>
  40834. Verify that merged regions do not intersect multi-cell array formulas and
  40835. no merged regions intersect another merged region in this sheet.
  40836. </summary>
  40837. <exception cref="!:NPOI.Util.InvalidOperationException">if region intersects with a multi-cell array formula</exception>
  40838. <exception cref="!:NPOI.Util.InvalidOperationException">if at least one region intersects with another merged region in this sheet</exception>
  40839. </member>
  40840. <member name="P:NPOI.SS.UserModel.ISheet.HorizontallyCenter">
  40841. <summary>
  40842. Determine whether printed output for this sheet will be horizontally centered.
  40843. </summary>
  40844. </member>
  40845. <member name="P:NPOI.SS.UserModel.ISheet.VerticallyCenter">
  40846. <summary>
  40847. Determine whether printed output for this sheet will be vertically centered.
  40848. </summary>
  40849. </member>
  40850. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegion(System.Int32)">
  40851. <summary>
  40852. Removes a merged region of cells (hence letting them free)
  40853. </summary>
  40854. <param name="index">index of the region to unmerge</param>
  40855. </member>
  40856. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegions(System.Collections.Generic.IList{System.Int32})">
  40857. <summary>
  40858. Removes a number of merged regions of cells (hence letting them free)
  40859. </summary>
  40860. <param name="indices">A set of the regions to unmerge</param>
  40861. </member>
  40862. <member name="P:NPOI.SS.UserModel.ISheet.NumMergedRegions">
  40863. <summary>
  40864. Returns the number of merged regions
  40865. </summary>
  40866. </member>
  40867. <member name="M:NPOI.SS.UserModel.ISheet.GetMergedRegion(System.Int32)">
  40868. <summary>
  40869. Returns the merged region at the specified index
  40870. </summary>
  40871. <param name="index">The index.</param>
  40872. </member>
  40873. <member name="P:NPOI.SS.UserModel.ISheet.MergedRegions">
  40874. <summary>
  40875. Returns the list of merged regions.
  40876. </summary>
  40877. </member>
  40878. <member name="M:NPOI.SS.UserModel.ISheet.GetRowEnumerator">
  40879. <summary>
  40880. Gets the row enumerator.
  40881. </summary>
  40882. <returns>
  40883. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  40884. be the third row if say for instance the second row is undefined.
  40885. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  40886. if you care which one it is.
  40887. </returns>
  40888. </member>
  40889. <member name="M:NPOI.SS.UserModel.ISheet.GetEnumerator">
  40890. <summary>
  40891. Get the row enumerator
  40892. </summary>
  40893. <returns></returns>
  40894. </member>
  40895. <member name="P:NPOI.SS.UserModel.ISheet.DisplayZeros">
  40896. <summary>
  40897. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  40898. When false, cells with zero value appear blank instead of showing the number zero.
  40899. </summary>
  40900. <value>whether all zero values on the worksheet are displayed.</value>
  40901. </member>
  40902. <member name="P:NPOI.SS.UserModel.ISheet.Autobreaks">
  40903. <summary>
  40904. Gets or sets a value indicating whether the sheet displays Automatic Page Breaks.
  40905. </summary>
  40906. </member>
  40907. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGuts">
  40908. <summary>
  40909. Get whether to display the guts or not,
  40910. </summary>
  40911. <value>default value is true</value>
  40912. </member>
  40913. <member name="P:NPOI.SS.UserModel.ISheet.FitToPage">
  40914. <summary>
  40915. Flag indicating whether the Fit to Page print option is enabled.
  40916. </summary>
  40917. </member>
  40918. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsBelow">
  40919. <summary>
  40920. Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
  40921. When true a summary row is inserted below the detailed data being summarized and a
  40922. new outline level is established on that row.
  40923. When false a summary row is inserted above the detailed data being summarized and a new outline level
  40924. is established on that row.
  40925. </summary>
  40926. <returns><c>true</c> if row summaries appear below detail in the outline</returns>
  40927. </member>
  40928. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsRight">
  40929. <summary>
  40930. Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
  40931. When true a summary column is inserted to the right of the detailed data being summarized
  40932. and a new outline level is established on that column.
  40933. When false a summary column is inserted to the left of the detailed data being
  40934. summarized and a new outline level is established on that column.
  40935. </summary>
  40936. <returns><c>true</c> if col summaries appear right of the detail in the outline</returns>
  40937. </member>
  40938. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintGridlines">
  40939. <summary>
  40940. Gets the flag indicating whether this sheet displays the lines
  40941. between rows and columns to make editing and reading easier.
  40942. </summary>
  40943. <returns><c>true</c> if this sheet displays gridlines.</returns>
  40944. </member>
  40945. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintRowAndColumnHeadings">
  40946. <summary>
  40947. Get or set the flag indicating whether this sheet prints the
  40948. row and column headings when printing.
  40949. return true if this sheet prints row and column headings.
  40950. </summary>
  40951. </member>
  40952. <member name="P:NPOI.SS.UserModel.ISheet.PrintSetup">
  40953. <summary>
  40954. Gets the print Setup object.
  40955. </summary>
  40956. <returns>The user model for the print Setup object.</returns>
  40957. </member>
  40958. <member name="P:NPOI.SS.UserModel.ISheet.Header">
  40959. <summary>
  40960. Gets the user model for the default document header.
  40961. <p/>
  40962. Note that XSSF offers more kinds of document headers than HSSF does
  40963. </summary>
  40964. <returns>the document header. Never <code>null</code></returns>
  40965. </member>
  40966. <member name="P:NPOI.SS.UserModel.ISheet.Footer">
  40967. <summary>
  40968. Gets the user model for the default document footer.
  40969. <p/>
  40970. Note that XSSF offers more kinds of document footers than HSSF does.
  40971. </summary>
  40972. <returns>the document footer. Never <code>null</code></returns>
  40973. </member>
  40974. <member name="M:NPOI.SS.UserModel.ISheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  40975. <summary>
  40976. Gets the size of the margin in inches.
  40977. </summary>
  40978. <param name="margin">which margin to get</param>
  40979. <returns>the size of the margin</returns>
  40980. </member>
  40981. <member name="M:NPOI.SS.UserModel.ISheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  40982. <summary>
  40983. Sets the size of the margin in inches.
  40984. </summary>
  40985. <param name="margin">which margin to get</param>
  40986. <param name="size">the size of the margin</param>
  40987. </member>
  40988. <member name="P:NPOI.SS.UserModel.ISheet.Protect">
  40989. <summary>
  40990. Answer whether protection is enabled or disabled
  40991. </summary>
  40992. <returns>true => protection enabled; false => protection disabled</returns>
  40993. </member>
  40994. <member name="M:NPOI.SS.UserModel.ISheet.ProtectSheet(System.String)">
  40995. <summary>
  40996. Sets the protection enabled as well as the password
  40997. </summary>
  40998. <param name="password">to set for protection. Pass <code>null</code> to remove protection</param>
  40999. </member>
  41000. <member name="P:NPOI.SS.UserModel.ISheet.ScenarioProtect">
  41001. <summary>
  41002. Answer whether scenario protection is enabled or disabled
  41003. </summary>
  41004. <returns>true => protection enabled; false => protection disabled</returns>
  41005. </member>
  41006. <member name="P:NPOI.SS.UserModel.ISheet.TabColorIndex">
  41007. <summary>
  41008. Gets or sets the tab color of the _sheet
  41009. </summary>
  41010. </member>
  41011. <member name="P:NPOI.SS.UserModel.ISheet.DrawingPatriarch">
  41012. <summary>
  41013. Returns the top-level drawing patriach, if there is one.
  41014. This will hold any graphics or charts for the _sheet.
  41015. WARNING - calling this will trigger a parsing of the
  41016. associated escher records. Any that aren't supported
  41017. (such as charts and complex drawing types) will almost
  41018. certainly be lost or corrupted when written out. Only
  41019. use this with simple drawings, otherwise call
  41020. HSSFSheet#CreateDrawingPatriarch() and
  41021. start from scratch!
  41022. </summary>
  41023. <value>The drawing patriarch.</value>
  41024. </member>
  41025. <member name="M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32,System.Int32)">
  41026. <summary>
  41027. Sets the zoom magnication for the sheet. The zoom is expressed as a
  41028. fraction. For example to express a zoom of 75% use 3 for the numerator
  41029. and 4 for the denominator.
  41030. </summary>
  41031. <param name="numerator">The numerator for the zoom magnification.</param>
  41032. <param name="denominator">denominator for the zoom magnification.</param>
  41033. </member>
  41034. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32)" -->
  41035. <member name="P:NPOI.SS.UserModel.ISheet.TopRow">
  41036. <summary>
  41037. The top row in the visible view when the sheet is
  41038. first viewed after opening it in a viewer
  41039. </summary>
  41040. <value>the rownum (0 based) of the top row.</value>
  41041. </member>
  41042. <member name="P:NPOI.SS.UserModel.ISheet.LeftCol">
  41043. <summary>
  41044. The left col in the visible view when the sheet is
  41045. first viewed after opening it in a viewer
  41046. </summary>
  41047. <value>the rownum (0 based) of the top row</value>
  41048. </member>
  41049. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int32,System.Int32)">
  41050. <summary>
  41051. Sets desktop window pane display area, when the file is first opened in a viewer.
  41052. </summary>
  41053. <param name="toprow">the top row to show in desktop window pane</param>
  41054. <param name="leftcol">the left column to show in desktop window pane</param>
  41055. </member>
  41056. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  41057. <summary>
  41058. Shifts rows between startRow and endRow n number of rows.
  41059. If you use a negative number, it will shift rows up.
  41060. Code ensures that rows don't wrap around.
  41061. Calls shiftRows(startRow, endRow, n, false, false);
  41062. Additionally shifts merged regions that are completely defined in these
  41063. rows (ie. merged 2 cells on a row to be shifted).
  41064. </summary>
  41065. <param name="startRow">the row to start shifting</param>
  41066. <param name="endRow">the row to end shifting</param>
  41067. <param name="n">the number of rows to shift</param>
  41068. </member>
  41069. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  41070. <summary>
  41071. Shifts rows between startRow and endRow n number of rows.
  41072. If you use a negative number, it will shift rows up.
  41073. Code ensures that rows don't wrap around
  41074. Additionally shifts merged regions that are completely defined in these
  41075. rows (ie. merged 2 cells on a row to be shifted).
  41076. </summary>
  41077. <param name="startRow">the row to start shifting</param>
  41078. <param name="endRow">the row to end shifting</param>
  41079. <param name="n">the number of rows to shift</param>
  41080. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  41081. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  41082. </member>
  41083. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  41084. <summary>
  41085. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  41086. </summary>
  41087. <param name="colSplit">Horizonatal position of split</param>
  41088. <param name="rowSplit">Vertical position of split</param>
  41089. <param name="leftmostColumn">Top row visible in bottom pane</param>
  41090. <param name="topRow">Left column visible in right pane</param>
  41091. </member>
  41092. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32)">
  41093. <summary>
  41094. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  41095. </summary>
  41096. <param name="colSplit">Horizonatal position of split.</param>
  41097. <param name="rowSplit">Vertical position of split.</param>
  41098. </member>
  41099. <member name="M:NPOI.SS.UserModel.ISheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  41100. <summary>
  41101. Creates a split pane. Any existing freezepane or split pane is overwritten.
  41102. </summary>
  41103. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point)</param>
  41104. <param name="ySplitPos">Vertical position of split (in 1/20th of a point)</param>
  41105. <param name="leftmostColumn">Left column visible in right pane</param>
  41106. <param name="topRow">Top row visible in bottom pane</param>
  41107. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  41108. @see #PANE_LOWER_LEFT
  41109. @see #PANE_LOWER_RIGHT
  41110. @see #PANE_UPPER_LEFT
  41111. @see #PANE_UPPER_RIGHT
  41112. </member>
  41113. <member name="P:NPOI.SS.UserModel.ISheet.PaneInformation">
  41114. <summary>
  41115. Returns the information regarding the currently configured pane (split or freeze)
  41116. </summary>
  41117. <value>if no pane configured returns <c>null</c> else return the pane information.</value>
  41118. </member>
  41119. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGridlines">
  41120. <summary>
  41121. Returns if gridlines are displayed
  41122. </summary>
  41123. </member>
  41124. <member name="P:NPOI.SS.UserModel.ISheet.DisplayFormulas">
  41125. <summary>
  41126. Returns if formulas are displayed
  41127. </summary>
  41128. </member>
  41129. <member name="P:NPOI.SS.UserModel.ISheet.DisplayRowColHeadings">
  41130. <summary>
  41131. Returns if RowColHeadings are displayed.
  41132. </summary>
  41133. </member>
  41134. <member name="P:NPOI.SS.UserModel.ISheet.IsActive">
  41135. <summary>
  41136. Returns if RowColHeadings are displayed.
  41137. </summary>
  41138. </member>
  41139. <member name="M:NPOI.SS.UserModel.ISheet.IsRowBroken(System.Int32)">
  41140. <summary>
  41141. Determines if there is a page break at the indicated row
  41142. </summary>
  41143. <param name="row">The row.</param>
  41144. </member>
  41145. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRowBreak(System.Int32)">
  41146. <summary>
  41147. Removes the page break at the indicated row
  41148. </summary>
  41149. <param name="row">The row index.</param>
  41150. </member>
  41151. <member name="P:NPOI.SS.UserModel.ISheet.RowBreaks">
  41152. <summary>
  41153. Retrieves all the horizontal page breaks
  41154. </summary>
  41155. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  41156. </member>
  41157. <member name="P:NPOI.SS.UserModel.ISheet.ColumnBreaks">
  41158. <summary>
  41159. Retrieves all the vertical page breaks
  41160. </summary>
  41161. <value>all the vertical page breaks, or null if there are no column page breaks.</value>
  41162. </member>
  41163. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  41164. <summary>
  41165. Sets the active cell range.
  41166. </summary>
  41167. <param name="firstRow">The firstrow.</param>
  41168. <param name="lastRow">The lastrow.</param>
  41169. <param name="firstColumn">The firstcolumn.</param>
  41170. <param name="lastColumn">The lastcolumn.</param>
  41171. </member>
  41172. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  41173. <summary>
  41174. Sets the active cell range.
  41175. </summary>
  41176. <param name="cellranges">The cellranges.</param>
  41177. <param name="activeRange">The index of the active range.</param>
  41178. <param name="activeRow">The active row in the active range</param>
  41179. <param name="activeColumn">The active column in the active range</param>
  41180. </member>
  41181. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnBreak(System.Int32)">
  41182. <summary>
  41183. Sets a page break at the indicated column
  41184. </summary>
  41185. <param name="column">The column.</param>
  41186. </member>
  41187. <member name="M:NPOI.SS.UserModel.ISheet.SetRowBreak(System.Int32)">
  41188. <summary>
  41189. Sets the row break.
  41190. </summary>
  41191. <param name="row">The row.</param>
  41192. </member>
  41193. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnBroken(System.Int32)">
  41194. <summary>
  41195. Determines if there is a page break at the indicated column
  41196. </summary>
  41197. <param name="column">The column index.</param>
  41198. </member>
  41199. <member name="M:NPOI.SS.UserModel.ISheet.RemoveColumnBreak(System.Int32)">
  41200. <summary>
  41201. Removes a page break at the indicated column
  41202. </summary>
  41203. <param name="column">The column.</param>
  41204. </member>
  41205. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  41206. <summary>
  41207. Expands or collapses a column group.
  41208. </summary>
  41209. <param name="columnNumber">One of the columns in the group.</param>
  41210. <param name="collapsed">if set to <c>true</c>collapse group.<c>false</c>expand group.</param>
  41211. </member>
  41212. <member name="M:NPOI.SS.UserModel.ISheet.GroupColumn(System.Int32,System.Int32)">
  41213. <summary>
  41214. Create an outline for the provided column range.
  41215. </summary>
  41216. <param name="fromColumn">beginning of the column range.</param>
  41217. <param name="toColumn">end of the column range.</param>
  41218. </member>
  41219. <member name="M:NPOI.SS.UserModel.ISheet.UngroupColumn(System.Int32,System.Int32)">
  41220. <summary>
  41221. Ungroup a range of columns that were previously groupped
  41222. </summary>
  41223. <param name="fromColumn">start column (0-based).</param>
  41224. <param name="toColumn">end column (0-based).</param>
  41225. </member>
  41226. <member name="M:NPOI.SS.UserModel.ISheet.GroupRow(System.Int32,System.Int32)">
  41227. <summary>
  41228. Tie a range of rows toGether so that they can be collapsed or expanded
  41229. </summary>
  41230. <param name="fromRow">start row (0-based)</param>
  41231. <param name="toRow">end row (0-based)</param>
  41232. </member>
  41233. <member name="M:NPOI.SS.UserModel.ISheet.UngroupRow(System.Int32,System.Int32)">
  41234. <summary>
  41235. Ungroup a range of rows that were previously groupped
  41236. </summary>
  41237. <param name="fromRow">start row (0-based)</param>
  41238. <param name="toRow">end row (0-based)</param>
  41239. </member>
  41240. <member name="M:NPOI.SS.UserModel.ISheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  41241. <summary>
  41242. Set view state of a groupped range of rows
  41243. </summary>
  41244. <param name="row">start row of a groupped range of rows (0-based).</param>
  41245. <param name="collapse">whether to expand/collapse the detail rows.</param>
  41246. </member>
  41247. <member name="M:NPOI.SS.UserModel.ISheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  41248. <summary>
  41249. Sets the default column style for a given column. POI will only apply this style to new cells Added to the sheet.
  41250. </summary>
  41251. <param name="column">the column index</param>
  41252. <param name="style">the style to set</param>
  41253. </member>
  41254. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32)">
  41255. <summary>
  41256. Adjusts the column width to fit the contents.
  41257. </summary>
  41258. <param name="column">the column index</param>
  41259. <remarks>
  41260. This process can be relatively slow on large sheets, so this should
  41261. normally only be called once per column, at the end of your
  41262. processing.
  41263. </remarks>
  41264. </member>
  41265. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32,System.Boolean)">
  41266. <summary>
  41267. Adjusts the column width to fit the contents.
  41268. </summary>
  41269. <param name="column">the column index.</param>
  41270. <param name="useMergedCells">whether to use the contents of merged cells when
  41271. calculating the width of the column. Default is to ignore merged cells.</param>
  41272. <remarks>
  41273. This process can be relatively slow on large sheets, so this should
  41274. normally only be called once per column, at the end of your
  41275. processing.
  41276. </remarks>
  41277. </member>
  41278. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(System.Int32,System.Int32)">
  41279. <summary>
  41280. Returns cell comment for the specified row and column
  41281. </summary>
  41282. <param name="row">The row.</param>
  41283. <param name="column">The column.</param>
  41284. </member>
  41285. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(NPOI.SS.Util.CellAddress)">
  41286. <summary>
  41287. Returns cell comment for the specified location
  41288. </summary>
  41289. <param name="ref1">cell location</param>
  41290. <returns>return cell comment or null if not found</returns>
  41291. </member>
  41292. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComments">
  41293. <summary>
  41294. Returns all cell comments on this sheet.
  41295. </summary>
  41296. <returns>return A Dictionary of each Comment in the sheet, keyed on the cell address where the comment is located.</returns>
  41297. </member>
  41298. <member name="M:NPOI.SS.UserModel.ISheet.CreateDrawingPatriarch">
  41299. <summary>
  41300. Creates the top-level drawing patriarch.
  41301. </summary>
  41302. </member>
  41303. <member name="P:NPOI.SS.UserModel.ISheet.Workbook">
  41304. <summary>
  41305. Gets the parent workbook.
  41306. </summary>
  41307. </member>
  41308. <member name="P:NPOI.SS.UserModel.ISheet.SheetName">
  41309. <summary>
  41310. Gets the name of the sheet.
  41311. </summary>
  41312. </member>
  41313. <member name="P:NPOI.SS.UserModel.ISheet.IsSelected">
  41314. <summary>
  41315. Gets or sets a value indicating whether this sheet is currently selected.
  41316. </summary>
  41317. </member>
  41318. <member name="M:NPOI.SS.UserModel.ISheet.SetActive(System.Boolean)">
  41319. <summary>
  41320. Sets whether sheet is selected.
  41321. </summary>
  41322. <param name="value">Whether to select the sheet or deselect the sheet.</param>
  41323. </member>
  41324. <member name="M:NPOI.SS.UserModel.ISheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  41325. <summary>
  41326. Sets array formula to specified region for result.
  41327. </summary>
  41328. <param name="formula">text representation of the formula</param>
  41329. <param name="range">Region of array formula for result</param>
  41330. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  41331. </member>
  41332. <member name="M:NPOI.SS.UserModel.ISheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  41333. <summary>
  41334. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  41335. </summary>
  41336. <param name="cell">any cell within Array Formula range</param>
  41337. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  41338. </member>
  41339. <member name="M:NPOI.SS.UserModel.ISheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  41340. <summary>
  41341. Checks if the provided region is part of the merged regions.
  41342. </summary>
  41343. <param name="mergedRegion">Region searched in the merged regions</param>
  41344. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  41345. </member>
  41346. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidationHelper">
  41347. <summary>
  41348. Create an instance of a DataValidationHelper.
  41349. </summary>
  41350. <returns>Instance of a DataValidationHelper</returns>
  41351. </member>
  41352. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidations">
  41353. <summary>
  41354. Returns the list of DataValidation in the sheet.
  41355. </summary>
  41356. <returns>list of DataValidation in the sheet</returns>
  41357. </member>
  41358. <member name="M:NPOI.SS.UserModel.ISheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  41359. <summary>
  41360. Creates a data validation object
  41361. </summary>
  41362. <param name="dataValidation">The data validation object settings</param>
  41363. </member>
  41364. <member name="M:NPOI.SS.UserModel.ISheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  41365. <summary>
  41366. Enable filtering for a range of cells
  41367. </summary>
  41368. <param name="range">the range of cells to filter</param>
  41369. </member>
  41370. <member name="P:NPOI.SS.UserModel.ISheet.SheetConditionalFormatting">
  41371. <summary>
  41372. The 'Conditional Formatting' facet for this <c>Sheet</c>
  41373. </summary>
  41374. <returns>conditional formatting rule for this sheet</returns>
  41375. </member>
  41376. <member name="P:NPOI.SS.UserModel.ISheet.IsRightToLeft">
  41377. <summary>
  41378. Whether the text is displayed in right-to-left mode in the window
  41379. </summary>
  41380. </member>
  41381. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingRows">
  41382. <summary>
  41383. Get or set the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
  41384. <p/>
  41385. Repeating rows cover a range of contiguous rows, e.g.:
  41386. <pre>
  41387. Sheet1!$1:$1
  41388. Sheet2!$5:$8
  41389. </pre>
  41390. The {@link CellRangeAddress} returned contains a column part which spans
  41391. all columns, and a row part which specifies the contiguous range of
  41392. repeating rows.
  41393. <p/>
  41394. If the Sheet does not have any repeating rows defined, null is returned.
  41395. </summary>
  41396. </member>
  41397. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingColumns">
  41398. <summary>
  41399. Gets or set the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
  41400. <p/>
  41401. Repeating columns cover a range of contiguous columns, e.g.:
  41402. <pre>
  41403. Sheet1!$A:$A
  41404. Sheet2!$C:$F
  41405. </pre>
  41406. The {@link CellRangeAddress} returned contains a row part which spans all
  41407. rows, and a column part which specifies the contiguous range of
  41408. repeating columns.
  41409. <p/>
  41410. If the Sheet does not have any repeating columns defined, null is
  41411. returned.
  41412. </summary>
  41413. </member>
  41414. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String)">
  41415. <summary>
  41416. Copy sheet with a new name
  41417. </summary>
  41418. <param name="Name">new sheet name</param>
  41419. <returns>cloned sheet</returns>
  41420. </member>
  41421. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String,System.Boolean)">
  41422. <summary>
  41423. Copy sheet with a new name
  41424. </summary>
  41425. <param name="Name">new sheet name</param>
  41426. <param name="copyStyle">whether to copy styles</param>
  41427. <returns>cloned sheet</returns>
  41428. </member>
  41429. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnOutlineLevel(System.Int32)">
  41430. <summary>
  41431. Returns the column outline level. Increased as you
  41432. put it into more groups (outlines), reduced as
  41433. you take it out of them.
  41434. </summary>
  41435. <param name="columnIndex"></param>
  41436. <returns></returns>
  41437. </member>
  41438. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlink(System.Int32,System.Int32)">
  41439. <summary>
  41440. Get a Hyperlink in this sheet anchored at row, column
  41441. </summary>
  41442. <param name="row"></param>
  41443. <param name="column"></param>
  41444. <returns>return hyperlink if there is a hyperlink anchored at row, column; otherwise returns null</returns>
  41445. </member>
  41446. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlink(NPOI.SS.Util.CellAddress)">
  41447. <summary>
  41448. Get a Hyperlink in this sheet located in a cell specified by {code addr}
  41449. </summary>
  41450. <param name="addr">The address of the cell containing the hyperlink</param>
  41451. <returns>return hyperlink if there is a hyperlink anchored at {@code addr}; otherwise returns {@code null}</returns>
  41452. </member>
  41453. <member name="M:NPOI.SS.UserModel.ISheet.GetHyperlinkList">
  41454. <summary>
  41455. Get a list of Hyperlinks in this sheet
  41456. </summary>
  41457. <returns>return Hyperlinks for the sheet</returns>
  41458. </member>
  41459. <member name="P:NPOI.SS.UserModel.ISheet.ActiveCell">
  41460. <summary>
  41461. get or set location of the active cell, e.g. <code>A1</code>.
  41462. </summary>
  41463. </member>
  41464. <member name="T:NPOI.SS.UserModel.ISheetConditionalFormatting">
  41465. The 'Conditional Formatting' facet of <c>Sheet</c>
  41466. @author Dmitriy Kumshayev
  41467. @author Yegor Kozlov
  41468. @since 3.8
  41469. </member>
  41470. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  41471. <summary>
  41472. Add a new Conditional Formatting to the sheet.
  41473. </summary>
  41474. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  41475. <param name="rule">the rule to apply</param>
  41476. <returns>index of the newly Created Conditional Formatting object</returns>
  41477. </member>
  41478. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  41479. <summary>
  41480. Add a new Conditional Formatting consisting of two rules.
  41481. </summary>
  41482. <param name="regions"> list of rectangular regions to apply conditional formatting rules</param>
  41483. <param name="rule1">the first rule</param>
  41484. <param name="rule2">the second rule</param>
  41485. <returns>index of the newly Created Conditional Formatting object</returns>
  41486. </member>
  41487. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  41488. <summary>
  41489. Add a new Conditional Formatting Set to the sheet.
  41490. </summary>
  41491. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  41492. <param name="cfRules">Set of up to three conditional formatting rules</param>
  41493. <returns>index of the newly Created Conditional Formatting object</returns>
  41494. </member>
  41495. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  41496. <summary>
  41497. Adds a copy of a ConditionalFormatting object to the sheet
  41498. </summary>
  41499. <param name="cf">the Conditional Formatting to clone</param>
  41500. <returns>index of the new Conditional Formatting object</returns>
  41501. <remarks>
  41502. This method could be used to copy ConditionalFormatting object
  41503. from one sheet to another. For example:
  41504. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  41505. newSheet.AddConditionalFormatting(cf);
  41506. </remarks>
  41507. </member>
  41508. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  41509. A factory method allowing to create a conditional formatting rule
  41510. with a cell comparison operator
  41511. <p>
  41512. The Created conditional formatting rule Compares a cell value
  41513. to a formula calculated result, using the specified operator.
  41514. The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  41515. </p>
  41516. @param comparisonOperation - MUST be a constant value from
  41517. <c>{@link ComparisonOperator}</c>: <p>
  41518. <ul>
  41519. <li>BETWEEN</li>
  41520. <li>NOT_BETWEEN</li>
  41521. <li>EQUAL</li>
  41522. <li>NOT_EQUAL</li>
  41523. <li>GT</li>
  41524. <li>LT</li>
  41525. <li>GE</li>
  41526. <li>LE</li>
  41527. </ul>
  41528. </p>
  41529. @param formula1 - formula for the valued, Compared with the cell
  41530. @param formula2 - second formula (only used with
  41531. {@link ComparisonOperator#BETWEEN}) and {@link ComparisonOperator#NOT_BETWEEN} operations)
  41532. </member>
  41533. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String)">
  41534. <summary>
  41535. Create a conditional formatting rule that Compares a cell value to a formula calculated result, using an operator
  41536. </summary>
  41537. <param name="comparisonOperation">MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN</param>
  41538. <param name="formula">the formula to determine if the conditional formatting is applied</param>
  41539. <returns>a conditional formatting rule</returns>
  41540. </member>
  41541. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  41542. <summary>
  41543. Create a conditional formatting rule based on a Boolean formula.
  41544. When the formula result is true, the cell is highlighted.
  41545. </summary>
  41546. <param name="formula">the formula to Evaluate. MUST be a Boolean function.</param>
  41547. <returns>conditional formatting rule</returns>
  41548. </member>
  41549. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ExtendedColor)" -->
  41550. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.IconSet)" -->
  41551. <!-- Badly formed XML comment ignored for member "M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingColorScaleRule" -->
  41552. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  41553. <summary>
  41554. Gets Conditional Formatting object at a particular index
  41555. </summary>
  41556. <param name="index">0-based index of the Conditional Formatting object to fetch</param>
  41557. <returns>Conditional Formatting object or null if not found</returns>
  41558. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  41559. </member>
  41560. <member name="P:NPOI.SS.UserModel.ISheetConditionalFormatting.NumConditionalFormattings">
  41561. <summary>
  41562. get the number of conditional formats in this sheet
  41563. </summary>
  41564. </member>
  41565. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  41566. <summary>
  41567. Removes a Conditional Formatting object by index
  41568. </summary>
  41569. <param name="index">0-based index of the Conditional Formatting object to remove</param>
  41570. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  41571. </member>
  41572. <member name="P:NPOI.SS.UserModel.ITextbox.String">
  41573. @return the rich text string for this textbox.
  41574. </member>
  41575. <member name="P:NPOI.SS.UserModel.ITextbox.MarginLeft">
  41576. @return Returns the left margin within the textbox.
  41577. </member>
  41578. <member name="P:NPOI.SS.UserModel.ITextbox.MarginRight">
  41579. @return returns the right margin within the textbox.
  41580. </member>
  41581. <member name="P:NPOI.SS.UserModel.ITextbox.MarginTop">
  41582. @return returns the top margin within the textbox.
  41583. </member>
  41584. <member name="P:NPOI.SS.UserModel.ITextbox.MarginBottom">
  41585. s the bottom margin within the textbox.
  41586. </member>
  41587. <member name="T:NPOI.SS.UserModel.VerticalAlignment">
  41588. This enumeration value indicates the type of vertical alignment for a cell, i.e.,
  41589. whether it is aligned top, bottom, vertically centered, justified or distributed.
  41590. </member>
  41591. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Top">
  41592. The vertical alignment is aligned-to-top.
  41593. </member>
  41594. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Center">
  41595. The vertical alignment is centered across the height of the cell.
  41596. </member>
  41597. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Bottom">
  41598. The vertical alignment is aligned-to-bottom.
  41599. </member>
  41600. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Justify">
  41601. <p>
  41602. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  41603. where each line of text inside the cell is evenly distributed across the height of the cell,
  41604. with flush top and bottom margins.
  41605. </p>
  41606. <p>
  41607. When text direction is vertical: similar behavior as horizontal justification.
  41608. The alignment is justified (flush top and bottom in this case). For each line of text, each
  41609. line of the wrapped text in a cell is aligned to the top and bottom (except the last line).
  41610. If no single line of text wraps in the cell, then the text is not justified.
  41611. </p>
  41612. </member>
  41613. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Distributed">
  41614. <p>
  41615. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  41616. where each line of text inside the cell is evenly distributed across the height of the cell,
  41617. with flush top
  41618. </p>
  41619. <p>
  41620. When text direction is vertical: behaves exactly as distributed horizontal alignment.
  41621. The first words in a line of text (appearing at the top of the cell) are flush
  41622. 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,
  41623. and the line of text is distributed evenly from top to bottom.
  41624. </p>
  41625. </member>
  41626. <member name="F:NPOI.SS.UserModel.SheetState.Visible">
  41627. <summary>
  41628. Indicates the sheet is visible.
  41629. </summary>
  41630. </member>
  41631. <member name="F:NPOI.SS.UserModel.SheetState.Hidden">
  41632. <summary>
  41633. Indicates the book window is hidden, but can be shown by the user via the user interface.
  41634. </summary>
  41635. </member>
  41636. <member name="F:NPOI.SS.UserModel.SheetState.VeryHidden">
  41637. <summary>
  41638. Indicates the sheet is hidden and cannot be shown in the user interface (UI).
  41639. </summary>
  41640. <remarks>
  41641. In Excel this state is only available programmatically in VBA:
  41642. ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
  41643. </remarks>
  41644. </member>
  41645. <member name="T:NPOI.SS.UserModel.IWorkbook">
  41646. <summary>
  41647. High level interface of a Excel workbook. This is the first object most users
  41648. will construct whether they are reading or writing a workbook. It is also the
  41649. top level object for creating new sheets/etc.
  41650. This interface is shared between the implementation specific to xls and xlsx.
  41651. This way it is possible to access Excel workbooks stored in both formats.
  41652. </summary>
  41653. </member>
  41654. <member name="P:NPOI.SS.UserModel.IWorkbook.ActiveSheetIndex">
  41655. <summary>
  41656. get the active sheet. The active sheet is is the sheet
  41657. which is currently displayed when the workbook is viewed in Excel.
  41658. </summary>
  41659. </member>
  41660. <member name="P:NPOI.SS.UserModel.IWorkbook.FirstVisibleTab">
  41661. <summary>
  41662. Gets the first tab that is displayed in the list of tabs in excel.
  41663. </summary>
  41664. </member>
  41665. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetOrder(System.String,System.Int32)">
  41666. <summary>
  41667. Sets the order of appearance for a given sheet.
  41668. </summary>
  41669. <param name="sheetname">the name of the sheet to reorder</param>
  41670. <param name="pos">the position that we want to insert the sheet into (0 based)</param>
  41671. </member>
  41672. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSelectedTab(System.Int32)">
  41673. <summary>
  41674. Sets the tab whose data is actually seen when the sheet is opened.
  41675. This may be different from the "selected sheet" since excel seems to
  41676. allow you to show the data of one sheet when another is seen "selected"
  41677. in the tabs (at the bottom).
  41678. </summary>
  41679. <param name="index">the index of the sheet to select (0 based)</param>
  41680. </member>
  41681. <member name="M:NPOI.SS.UserModel.IWorkbook.SetActiveSheet(System.Int32)">
  41682. <summary>
  41683. set the active sheet. The active sheet is is the sheet
  41684. which is currently displayed when the workbook is viewed in Excel.
  41685. </summary>
  41686. <param name="sheetIndex">index of the active sheet (0-based)</param>
  41687. </member>
  41688. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetName(System.Int32)">
  41689. <summary>
  41690. Set the sheet name
  41691. </summary>
  41692. <param name="sheet">sheet number (0 based)</param>
  41693. <returns>Sheet name</returns>
  41694. </member>
  41695. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetName(System.Int32,System.String)">
  41696. <summary>
  41697. Set the sheet name.
  41698. </summary>
  41699. <param name="sheet">sheet number (0 based)</param>
  41700. <param name="name">sheet name</param>
  41701. </member>
  41702. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(System.String)">
  41703. <summary>
  41704. Returns the index of the sheet by its name
  41705. </summary>
  41706. <param name="name">the sheet name</param>
  41707. <returns>index of the sheet (0 based)</returns>
  41708. </member>
  41709. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  41710. <summary>
  41711. Returns the index of the given sheet
  41712. </summary>
  41713. <param name="sheet">the sheet to look up</param>
  41714. <returns>index of the sheet (0 based)</returns>
  41715. </member>
  41716. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet">
  41717. <summary>
  41718. Sreate an Sheet for this Workbook, Adds it to the sheets and returns
  41719. the high level representation. Use this to create new sheets.
  41720. </summary>
  41721. <returns></returns>
  41722. </member>
  41723. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet(System.String)">
  41724. <summary>
  41725. Create an Sheet for this Workbook, Adds it to the sheets and returns
  41726. the high level representation. Use this to create new sheets.
  41727. </summary>
  41728. <param name="sheetname">sheetname to set for the sheet.</param>
  41729. <returns>Sheet representing the new sheet.</returns>
  41730. </member>
  41731. <member name="M:NPOI.SS.UserModel.IWorkbook.CloneSheet(System.Int32)">
  41732. <summary>
  41733. Create an Sheet from an existing sheet in the Workbook.
  41734. </summary>
  41735. <param name="sheetNum"></param>
  41736. <returns></returns>
  41737. </member>
  41738. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfSheets">
  41739. <summary>
  41740. Get the number of spreadsheets in the workbook
  41741. </summary>
  41742. </member>
  41743. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetAt(System.Int32)">
  41744. <summary>
  41745. Get the Sheet object at the given index.
  41746. </summary>
  41747. <param name="index">index of the sheet number (0-based physical &amp; logical)</param>
  41748. <returns>Sheet at the provided index</returns>
  41749. </member>
  41750. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheet(System.String)">
  41751. <summary>
  41752. Get sheet with the given name
  41753. </summary>
  41754. <param name="name">name of the sheet</param>
  41755. <returns>Sheet with the name provided or null if it does not exist</returns>
  41756. </member>
  41757. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveSheetAt(System.Int32)">
  41758. <summary>
  41759. Removes sheet at the given index
  41760. </summary>
  41761. <param name="index"></param>
  41762. </member>
  41763. <member name="M:NPOI.SS.UserModel.IWorkbook.GetEnumerator">
  41764. <summary>
  41765. Enumerate sheets
  41766. </summary>
  41767. <returns></returns>
  41768. </member>
  41769. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateFont">
  41770. <summary>
  41771. Create a new Font and add it to the workbook's font table
  41772. </summary>
  41773. <returns></returns>
  41774. </member>
  41775. <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)">
  41776. <summary>
  41777. Finds a font that matches the one with the supplied attributes
  41778. </summary>
  41779. <param name="boldWeight"></param>
  41780. <param name="color"></param>
  41781. <param name="fontHeight"></param>
  41782. <param name="name"></param>
  41783. <param name="italic"></param>
  41784. <param name="strikeout"></param>
  41785. <param name="typeOffset"></param>
  41786. <param name="underline"></param>
  41787. <returns>the font with the matched attributes or null</returns>
  41788. </member>
  41789. <member name="M:NPOI.SS.UserModel.IWorkbook.FindFont(System.Boolean,System.Int16,System.Int16,System.String,System.Boolean,System.Boolean,NPOI.SS.UserModel.FontSuperScript,NPOI.SS.UserModel.FontUnderlineType)">
  41790. <summary>
  41791. Finds a font that matches the one with the supplied attributes
  41792. </summary>
  41793. <param name="bold"></param>
  41794. <param name="color"></param>
  41795. <param name="fontHeight"></param>
  41796. <param name="name"></param>
  41797. <param name="italic"></param>
  41798. <param name="strikeout"></param>
  41799. <param name="typeOffset"></param>
  41800. <param name="underline"></param>
  41801. <returns>the font with the matched attributes or null</returns>
  41802. </member>
  41803. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfFonts">
  41804. <summary>
  41805. Get the number of fonts in the font table
  41806. </summary>
  41807. </member>
  41808. <member name="M:NPOI.SS.UserModel.IWorkbook.GetFontAt(System.Int16)">
  41809. <summary>
  41810. Get the font at the given index number
  41811. </summary>
  41812. <param name="idx">index number (0-based)</param>
  41813. <returns>font at the index</returns>
  41814. </member>
  41815. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateCellStyle">
  41816. <summary>
  41817. Create a new Cell style and add it to the workbook's style table
  41818. </summary>
  41819. <returns>the new Cell Style object</returns>
  41820. </member>
  41821. <member name="P:NPOI.SS.UserModel.IWorkbook.NumCellStyles">
  41822. <summary>
  41823. Get the number of styles the workbook Contains
  41824. </summary>
  41825. </member>
  41826. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCellStyleAt(System.Int32)">
  41827. <summary>
  41828. Get the cell style object at the given index
  41829. </summary>
  41830. <param name="idx">index within the set of styles (0-based)</param>
  41831. <returns>CellStyle object at the index</returns>
  41832. </member>
  41833. <member name="M:NPOI.SS.UserModel.IWorkbook.Write(System.IO.Stream)">
  41834. <summary>
  41835. Write out this workbook to an OutPutstream.
  41836. </summary>
  41837. <param name="stream">the stream you wish to write to</param>
  41838. </member>
  41839. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfNames">
  41840. <summary>
  41841. the total number of defined names in this workbook
  41842. </summary>
  41843. </member>
  41844. <member name="M:NPOI.SS.UserModel.IWorkbook.GetName(System.String)">
  41845. <summary>
  41846. the defined name with the specified name.
  41847. </summary>
  41848. <param name="name">the name of the defined name</param>
  41849. <returns>the defined name with the specified name. null if not found</returns>
  41850. </member>
  41851. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNames(System.String)">
  41852. <summary>
  41853. Returns all defined names with the given name.
  41854. </summary>
  41855. <param name="name">the name of the defined name</param>
  41856. <returns>a list of the defined names with the specified name. An empty list is returned if none is found.</returns>
  41857. </member>
  41858. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllNames">
  41859. <summary>
  41860. Returns all defined names.
  41861. </summary>
  41862. <returns>a list of the defined names. An empty list is returned if none is found.</returns>
  41863. </member>
  41864. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameAt(System.Int32)">
  41865. <summary>
  41866. the defined name at the specified index
  41867. </summary>
  41868. <param name="nameIndex">position of the named range (0-based)</param>
  41869. <returns></returns>
  41870. </member>
  41871. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateName">
  41872. <summary>
  41873. Creates a new (unInitialised) defined name in this workbook
  41874. </summary>
  41875. <returns>new defined name object</returns>
  41876. </member>
  41877. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameIndex(System.String)">
  41878. <summary>
  41879. Gets the defined name index by name
  41880. </summary>
  41881. <param name="name">the name of the defined name</param>
  41882. <returns>zero based index of the defined name.</returns>
  41883. </member>
  41884. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.Int32)">
  41885. <summary>
  41886. Remove the defined name at the specified index
  41887. </summary>
  41888. <param name="index">named range index (0 based)</param>
  41889. </member>
  41890. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.String)">
  41891. <summary>
  41892. Remove a defined name by name
  41893. </summary>
  41894. <param name="name">the name of the defined name</param>
  41895. </member>
  41896. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(NPOI.SS.UserModel.IName)">
  41897. <summary>
  41898. Remove a defined name
  41899. </summary>
  41900. <param name="name">the name of the defined name</param>
  41901. </member>
  41902. <member name="M:NPOI.SS.UserModel.IWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  41903. <summary>
  41904. Adds the linking required to allow formulas referencing the specified
  41905. external workbook to be added to this one. In order for formulas
  41906. such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the file,
  41907. some linking information must first be recorded. Once a given external
  41908. workbook has been linked, then formulas using it can added. Each workbook
  41909. needs linking only once. <br/>
  41910. This linking only applies for writing formulas.
  41911. To link things for evaluation, see {@link FormulaEvaluator#setupReferencedWorkbooks(java.util.Map)}
  41912. </summary>
  41913. <param name="name">The name the workbook will be referenced as in formulas</param>
  41914. <param name="workbook">The open workbook to fetch the link required information from</param>
  41915. <returns></returns>
  41916. </member>
  41917. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.String)">
  41918. <summary>
  41919. Sets the printarea for the sheet provided
  41920. </summary>
  41921. <param name="sheetIndex">Zero-based sheet index</param>
  41922. <param name="reference">Valid name Reference for the Print Area</param>
  41923. </member>
  41924. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  41925. <summary>
  41926. Sets the printarea for the sheet provided
  41927. </summary>
  41928. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  41929. <param name="startColumn">Column to begin printarea</param>
  41930. <param name="endColumn">Column to end the printarea</param>
  41931. <param name="startRow">Row to begin the printarea</param>
  41932. <param name="endRow">Row to end the printarea</param>
  41933. </member>
  41934. <member name="M:NPOI.SS.UserModel.IWorkbook.GetPrintArea(System.Int32)">
  41935. <summary>
  41936. Retrieves the reference for the printarea of the specified sheet,
  41937. the sheet name is Appended to the reference even if it was not specified.
  41938. </summary>
  41939. <param name="sheetIndex">Zero-based sheet index</param>
  41940. <returns>Null if no print area has been defined</returns>
  41941. </member>
  41942. <member name="M:NPOI.SS.UserModel.IWorkbook.RemovePrintArea(System.Int32)">
  41943. <summary>
  41944. Delete the printarea for the sheet specified
  41945. </summary>
  41946. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  41947. </member>
  41948. <member name="P:NPOI.SS.UserModel.IWorkbook.MissingCellPolicy">
  41949. <summary>
  41950. Retrieves the current policy on what to do when getting missing or blank cells from a row.
  41951. </summary>
  41952. </member>
  41953. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateDataFormat">
  41954. <summary>
  41955. Returns the instance of DataFormat for this workbook.
  41956. </summary>
  41957. <returns>the DataFormat object</returns>
  41958. </member>
  41959. <member name="M:NPOI.SS.UserModel.IWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  41960. <summary>
  41961. Adds a picture to the workbook.
  41962. </summary>
  41963. <param name="pictureData">The bytes of the picture</param>
  41964. <param name="format">The format of the picture.</param>
  41965. <returns>the index to this picture (1 based).</returns>
  41966. </member>
  41967. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllPictures">
  41968. <summary>
  41969. Gets all pictures from the Workbook.
  41970. </summary>
  41971. <returns>the list of pictures (a list of link PictureData objects.)</returns>
  41972. </member>
  41973. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCreationHelper">
  41974. <summary>
  41975. Return an object that handles instantiating concrete classes of
  41976. the various instances one needs for HSSF and XSSF.
  41977. </summary>
  41978. <returns></returns>
  41979. </member>
  41980. <member name="P:NPOI.SS.UserModel.IWorkbook.IsHidden">
  41981. <summary>
  41982. if this workbook is not visible in the GUI
  41983. </summary>
  41984. </member>
  41985. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetHidden(System.Int32)">
  41986. <summary>
  41987. Check whether a sheet is hidden.
  41988. </summary>
  41989. <param name="sheetIx">number of sheet</param>
  41990. <returns>true if sheet is hidden</returns>
  41991. </member>
  41992. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetVeryHidden(System.Int32)">
  41993. Check whether a sheet is very hidden.
  41994. <p>
  41995. This is different from the normal hidden status
  41996. ({@link #isSheetHidden(int)})
  41997. </p>
  41998. @param sheetIx sheet index to check
  41999. @return <code>true</code> if sheet is very hidden
  42000. </member>
  42001. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  42002. Hide or unhide a sheet
  42003. @param sheetIx the sheet index (0-based)
  42004. @param hidden True to mark the sheet as hidden, false otherwise
  42005. </member>
  42006. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  42007. Hide or unhide a sheet.
  42008. <pre>
  42009. 0 = not hidden
  42010. 1 = hidden
  42011. 2 = very hidden.
  42012. </pre>
  42013. @param sheetIx The sheet number
  42014. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  42015. </member>
  42016. <member name="M:NPOI.SS.UserModel.IWorkbook.AddToolPack(NPOI.SS.Formula.UDF.UDFFinder)">
  42017. <summary>
  42018. Register a new toolpack in this workbook.
  42019. </summary>
  42020. <param name="toopack">the toolpack to register</param>
  42021. </member>
  42022. <member name="M:NPOI.SS.UserModel.IWorkbook.IsDate1904">
  42023. <summary>
  42024. Gets a bool value that indicates whether the date systems used in the workbook starts in 1904.
  42025. The default value is false, meaning that the workbook uses the 1900 date system,
  42026. where 1/1/1900 is the first day in the system.
  42027. </summary>
  42028. <returns>True if the date systems used in the workbook starts in 1904</returns>
  42029. </member>
  42030. <member name="P:NPOI.SS.UserModel.IWorkbook.SpreadsheetVersion">
  42031. <summary>
  42032. Returns the spreadsheet version (EXCLE97) of this workbook
  42033. </summary>
  42034. </member>
  42035. <member name="T:NPOI.SS.UserModel.FillPattern">
  42036. The enumeration value indicating the style of fill pattern being used for a cell format.
  42037. </member>
  42038. <member name="F:NPOI.SS.UserModel.FillPattern.NoFill">
  42039. No background
  42040. </member>
  42041. <member name="F:NPOI.SS.UserModel.FillPattern.SolidForeground">
  42042. Solidly Filled
  42043. </member>
  42044. <member name="F:NPOI.SS.UserModel.FillPattern.FineDots">
  42045. Small fine dots
  42046. </member>
  42047. <member name="F:NPOI.SS.UserModel.FillPattern.AltBars">
  42048. Wide dots
  42049. </member>
  42050. <member name="F:NPOI.SS.UserModel.FillPattern.SparseDots">
  42051. Sparse dots
  42052. </member>
  42053. <member name="F:NPOI.SS.UserModel.FillPattern.ThickHorizontalBands">
  42054. Thick horizontal bands
  42055. </member>
  42056. <member name="F:NPOI.SS.UserModel.FillPattern.ThickVerticalBands">
  42057. Thick vertical bands
  42058. </member>
  42059. <member name="F:NPOI.SS.UserModel.FillPattern.ThickBackwardDiagonals">
  42060. Thick backward facing diagonals
  42061. </member>
  42062. <member name="F:NPOI.SS.UserModel.FillPattern.ThickForwardDiagonals">
  42063. Thick forward facing diagonals
  42064. </member>
  42065. <member name="F:NPOI.SS.UserModel.FillPattern.BigSpots">
  42066. Large spots
  42067. </member>
  42068. <member name="F:NPOI.SS.UserModel.FillPattern.Bricks">
  42069. Brick-like layout
  42070. </member>
  42071. <member name="F:NPOI.SS.UserModel.FillPattern.ThinHorizontalBands">
  42072. Thin horizontal bands
  42073. </member>
  42074. <member name="F:NPOI.SS.UserModel.FillPattern.ThinVerticalBands">
  42075. Thin vertical bands
  42076. </member>
  42077. <member name="F:NPOI.SS.UserModel.FillPattern.ThinBackwardDiagonals">
  42078. Thin backward diagonal
  42079. </member>
  42080. <member name="F:NPOI.SS.UserModel.FillPattern.ThinForwardDiagonals">
  42081. Thin forward diagonal
  42082. </member>
  42083. <member name="F:NPOI.SS.UserModel.FillPattern.Squares">
  42084. Squares
  42085. </member>
  42086. <member name="F:NPOI.SS.UserModel.FillPattern.Diamonds">
  42087. Diamonds
  42088. </member>
  42089. <member name="F:NPOI.SS.UserModel.FillPattern.LessDots">
  42090. Less Dots
  42091. </member>
  42092. <member name="F:NPOI.SS.UserModel.FillPattern.LeastDots">
  42093. Least Dots
  42094. </member>
  42095. <member name="T:NPOI.SS.Util.CellRangeUtil">
  42096. Utility class that builds on {@link CellRangeAddress}
  42097. Portions of this class may be moved to {@link CellRangeAddressBase}
  42098. </member>
  42099. <member name="F:NPOI.SS.Util.CellRangeUtil.INSIDE">
  42100. first range is within the second range
  42101. </member>
  42102. <member name="F:NPOI.SS.Util.CellRangeUtil.ENCLOSES">
  42103. first range encloses or is equal to the second
  42104. </member>
  42105. <member name="M:NPOI.SS.Util.CellRangeUtil.Intersect(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  42106. Get the type of intersection between two cell ranges
  42107. @param crB - the specified range
  42108. @return code which reflects how the specified range is related to this range.<br/>
  42109. Possible return codes are:
  42110. NO_INTERSECTION - the specified range is outside of this range;<br/>
  42111. OVERLAP - both ranges partially overlap;<br/>
  42112. INSIDE - the specified range is inside of this one<br/>
  42113. ENCLOSES - the specified range encloses (possibly exactly the same as) this range<br/>
  42114. </member>
  42115. <member name="M:NPOI.SS.Util.CellRangeUtil.MergeCellRanges(NPOI.SS.Util.CellRangeAddress[])">
  42116. Do all possible cell merges between cells of the list so that:
  42117. if a cell range is completely inside of another cell range, it s removed from the list
  42118. if two cells have a shared border, merge them into one bigger cell range
  42119. @param cellRangeList
  42120. @return updated List of cell ranges
  42121. </member>
  42122. <member name="M:NPOI.SS.Util.CellRangeUtil.MergeRanges(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  42123. @return the new range(s) to replace the supplied ones. <c>null</c> if no merge is possible
  42124. </member>
  42125. <member name="M:NPOI.SS.Util.CellRangeUtil.ToArray(System.Collections.ArrayList)">
  42126. **
  42127. </member>
  42128. <member name="M:NPOI.SS.Util.CellRangeUtil.Contains(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  42129. Check if the specified range is located inside of this cell range.
  42130. @param crB
  42131. @return true if this cell range Contains the argument range inside if it's area
  42132. </member>
  42133. <member name="M:NPOI.SS.Util.CellRangeUtil.HasExactSharedBorder(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  42134. Check if the specified cell range has a shared border with the current range.
  42135. @return <c>true</c> if the ranges have a complete shared border (i.e.
  42136. the two ranges toher make a simple rectangular region.
  42137. </member>
  42138. <member name="M:NPOI.SS.Util.CellRangeUtil.CreateEnclosingCellRange(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  42139. Create an enclosing CellRange for the two cell ranges.
  42140. @return enclosing CellRange
  42141. </member>
  42142. <member name="M:NPOI.SS.Util.CellRangeUtil.lt(System.Int32,System.Int32)">
  42143. @return true if a &lt; b
  42144. </member>
  42145. <member name="M:NPOI.SS.Util.CellRangeUtil.le(System.Int32,System.Int32)">
  42146. @return true if a &lt;= b
  42147. </member>
  42148. <member name="M:NPOI.SS.Util.CellRangeUtil.gt(System.Int32,System.Int32)">
  42149. @return true if a > b
  42150. </member>
  42151. <member name="M:NPOI.SS.Util.CellRangeUtil.ge(System.Int32,System.Int32)">
  42152. @return true if a >= b
  42153. </member>
  42154. <member name="T:NPOI.SS.Util.CellAddress">
  42155. <p>This class is a Container for POI usermodel row=0 column=0 cell references.
  42156. It is barely a Container for these two coordinates. The implementation
  42157. of the Comparable interface sorts by "natural" order top left to bottom right.</p>
  42158. <p>Use <tt>CellAddress</tt> when you want to refer to the location of a cell in a sheet
  42159. when the concept of relative/absolute does not apply (such as the anchor location
  42160. of a cell comment). Use {@link CellReference} when the concept of
  42161. relative/absolute does apply (such as a cell reference in a formula).
  42162. <tt>CellAddress</tt>es do not have a concept of "sheet", while <tt>CellReference</tt>s do.</p>
  42163. </member>
  42164. <member name="F:NPOI.SS.Util.CellAddress.A1">
  42165. A constant for references to the first cell in a sheet.
  42166. </member>
  42167. <member name="M:NPOI.SS.Util.CellAddress.#ctor(System.Int32,System.Int32)">
  42168. Create a new CellAddress object.
  42169. @param row Row index (first row is 0)
  42170. @param column Column index (first column is 0)
  42171. </member>
  42172. <member name="M:NPOI.SS.Util.CellAddress.#ctor(System.String)">
  42173. Create a new CellAddress object.
  42174. @param Address a cell Address in A1 format. Address may not contain sheet name or dollar signs.
  42175. (that is, Address is not a cell reference. Use {@link #CellAddress(CellReference)} instead if
  42176. starting with a cell reference.)
  42177. </member>
  42178. <member name="M:NPOI.SS.Util.CellAddress.#ctor(NPOI.SS.Util.CellReference)">
  42179. Create a new CellAddress object.
  42180. @param reference a reference to a cell
  42181. </member>
  42182. <member name="M:NPOI.SS.Util.CellAddress.#ctor(NPOI.SS.UserModel.ICell)">
  42183. Create a new CellAddress object.
  42184. @param cell the Cell to Get the location of
  42185. </member>
  42186. <member name="P:NPOI.SS.Util.CellAddress.Row">
  42187. Get the cell Address row
  42188. @return row
  42189. </member>
  42190. <member name="P:NPOI.SS.Util.CellAddress.Column">
  42191. Get the cell Address column
  42192. @return column
  42193. </member>
  42194. <member name="M:NPOI.SS.Util.CellAddress.CompareTo(NPOI.SS.Util.CellAddress)">
  42195. Compare this CellAddress using the "natural" row-major, column-minor ordering.
  42196. That is, top-left to bottom-right ordering.
  42197. @param other
  42198. @return <ul>
  42199. <li>-1 if this CellAddress is before (above/left) of other</li>
  42200. <li>0 if Addresses are the same</li>
  42201. <li>1 if this CellAddress is After (below/right) of other</li>
  42202. </ul>
  42203. </member>
  42204. <member name="M:NPOI.SS.Util.CellAddress.FormatAsString">
  42205. Same as {@link #ToString()}
  42206. @return A1-style cell Address string representation
  42207. </member>
  42208. <member name="T:NPOI.SS.Util.DataMarker">
  42209. <summary>
  42210. Represents data marker used in charts.
  42211. @author Roman Kashitsyn
  42212. </summary>
  42213. </member>
  42214. <member name="M:NPOI.SS.Util.DataMarker.#ctor(NPOI.SS.UserModel.ISheet,NPOI.SS.Util.CellRangeAddress)">
  42215. <summary>
  42216. constructor
  42217. </summary>
  42218. <param name="sheet">the sheet where data located.</param>
  42219. <param name="range">the range within that sheet.</param>
  42220. </member>
  42221. <member name="P:NPOI.SS.Util.DataMarker.Sheet">
  42222. <summary>
  42223. get or set the sheet marker points to.
  42224. </summary>
  42225. </member>
  42226. <member name="P:NPOI.SS.Util.DataMarker.Range">
  42227. <summary>
  42228. get or set range of the marker.
  42229. </summary>
  42230. </member>
  42231. <member name="M:NPOI.SS.Util.DataMarker.FormatAsString">
  42232. <summary>
  42233. Formats data marker using canonical format, for example
  42234. 'SheetName!$A$1:$A$5'.
  42235. </summary>
  42236. <returns>formatted data marker</returns>
  42237. </member>
  42238. <member name="T:NPOI.SS.Util.DateFormatConverter">
  42239. Convert DateFormat patterns into Excel custom number formats.
  42240. For example, to format a date in excel using the "dd MMMM, yyyy" pattern and Japanese
  42241. locale, use the following code:
  42242. <pre><code>
  42243. // returns "[$-0411]dd MMMM, yyyy;@" where the [$-0411] prefix tells Excel to use the Japanese locale
  42244. String excelFormatPattern = DateFormatConverter.convert(Locale.JAPANESE, "dd MMMM, yyyy");
  42245. CellStyle cellStyle = workbook.createCellStyle();
  42246. DataFormat poiFormat = workbook.createDataFormat();
  42247. cellStyle.setDataFormat(poiFormat.getFormat(excelFormatPattern));
  42248. cell.setCellValue(new Date());
  42249. cell.setCellStyle(cellStyle); // formats date as '2012\u5e743\u670817\u65e5'
  42250. </code></pre>
  42251. </member>
  42252. <member name="T:NPOI.SS.Util.ImageUtils">
  42253. @author Yegor Kozlov
  42254. </member>
  42255. <member name="M:NPOI.SS.Util.ImageUtils.GetImageDimension(System.IO.Stream,NPOI.SS.UserModel.PictureType)">
  42256. Return the dimension of this image
  42257. @param is the stream Containing the image data
  42258. @param type type of the picture: {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_JPEG},
  42259. {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_PNG} or {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_DIB}
  42260. @return image dimension in pixels
  42261. </member>
  42262. <member name="M:NPOI.SS.Util.ImageUtils.GetResolution(System.Drawing.Image)">
  42263. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  42264. Return the the "effective" dpi calculated as <code>25.4/HorizontalPixelSize</code>
  42265. and <code>25.4/VerticalPixelSize</code>. Where 25.4 is the number of mm in inch.
  42266. @return array of two elements: <code>{horisontalPdi, verticalDpi}</code>.
  42267. {96, 96} is the default.
  42268. </member>
  42269. <member name="M:NPOI.SS.Util.ImageUtils.SetPreferredSize(NPOI.SS.UserModel.IPicture,System.Double,System.Double)">
  42270. Calculate and Set the preferred size (anchor) for this picture.
  42271. @param scaleX the amount by which image width is multiplied relative to the original width.
  42272. @param scaleY the amount by which image height is multiplied relative to the original height.
  42273. @return the new Dimensions of the scaled picture in EMUs
  42274. </member>
  42275. <member name="M:NPOI.SS.Util.ImageUtils.GetDimensionFromAnchor(NPOI.SS.UserModel.IPicture)">
  42276. Calculates the dimensions in EMUs for the anchor of the given picture
  42277. @param picture the picture Containing the anchor
  42278. @return the dimensions in EMUs
  42279. </member>
  42280. <member name="F:NPOI.SS.Util.AreaReference.SHEET_NAME_DELIMITER">
  42281. The Char (!) that Separates sheet names from cell references
  42282. </member>
  42283. <member name="F:NPOI.SS.Util.AreaReference.CELL_DELIMITER">
  42284. The Char (:) that Separates the two cell references in a multi-cell area reference
  42285. </member>
  42286. <member name="F:NPOI.SS.Util.AreaReference.SPECIAL_NAME_DELIMITER">
  42287. The Char (') used to quote sheet names when they contain special Chars
  42288. </member>
  42289. <member name="M:NPOI.SS.Util.AreaReference.#ctor(System.String,NPOI.SS.SpreadsheetVersion)">
  42290. Create an area ref from a string representation. Sheet names containing special Chars should be
  42291. delimited and escaped as per normal syntax rules for formulas.<br/>
  42292. The area reference must be contiguous (i.e. represent a single rectangle, not a Union of rectangles)
  42293. </member>
  42294. <member name="M:NPOI.SS.Util.AreaReference.#ctor(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  42295. Creates an area ref from a pair of Cell References.
  42296. </member>
  42297. <member name="M:NPOI.SS.Util.AreaReference.IsContiguous(System.String)">
  42298. is the reference for a contiguous (i.e.
  42299. Unbroken) area, or is it made up of
  42300. several different parts?
  42301. (If it Is, you will need to call
  42302. ....
  42303. </member>
  42304. <member name="M:NPOI.SS.Util.AreaReference.IsWholeColumnReference(NPOI.SS.SpreadsheetVersion,NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  42305. is the reference for a whole-column reference,
  42306. such as C:C or D:G ?
  42307. </member>
  42308. <member name="M:NPOI.SS.Util.AreaReference.GenerateContiguous(System.String)">
  42309. Takes a non-contiguous area reference, and
  42310. returns an array of contiguous area references.
  42311. </member>
  42312. <member name="P:NPOI.SS.Util.AreaReference.IsSingleCell">
  42313. @return <c>false</c> if this area reference involves more than one cell
  42314. </member>
  42315. <member name="P:NPOI.SS.Util.AreaReference.FirstCell">
  42316. @return the first cell reference which defines this area. Usually this cell is in the upper
  42317. left corner of the area (but this is not a requirement).
  42318. </member>
  42319. <member name="P:NPOI.SS.Util.AreaReference.LastCell">
  42320. Note - if this area reference refers to a single cell, the return value of this method will
  42321. be identical to that of <c>GetFirstCell()</c>
  42322. @return the second cell reference which defines this area. For multi-cell areas, this is
  42323. cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner
  42324. of the area (but this is not a requirement).
  42325. </member>
  42326. <member name="M:NPOI.SS.Util.AreaReference.GetAllReferencedCells">
  42327. Returns a reference to every cell covered by this area
  42328. </member>
  42329. <member name="M:NPOI.SS.Util.AreaReference.FormatAsString">
  42330. Example return values:
  42331. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  42332. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  42333. <tr><td>A1:A1</td><td>Single cell area reference without sheet</td></tr>
  42334. <tr><td>A1:$C$1</td><td>Multi-cell area reference without sheet</td></tr>
  42335. <tr><td>Sheet1!A$1:B4</td><td>Standard sheet name</td></tr>
  42336. <tr><td>'O''Brien''s Sales'!B5:C6' </td><td>Sheet name with special Chars</td></tr>
  42337. </table>
  42338. @return the text representation of this area reference as it would appear in a formula.
  42339. </member>
  42340. <member name="M:NPOI.SS.Util.AreaReference.SeparateAreaRefs(System.String)">
  42341. Separates Area refs in two parts and returns them as Separate elements in a String array,
  42342. each qualified with the sheet name (if present)
  42343. @return array with one or two elements. never <c>null</c>
  42344. </member>
  42345. <member name="M:NPOI.SS.Util.CellRangeAddress.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  42346. Creates new cell range. Indexes are zero-based.
  42347. @param firstRow Index of first row
  42348. @param lastRow Index of last row (inclusive), must be equal to or larger than {@code firstRow}
  42349. @param firstCol Index of first column
  42350. @param lastCol Index of last column (inclusive), must be equal to or larger than {@code firstCol}
  42351. </member>
  42352. <member name="M:NPOI.SS.Util.CellRangeAddress.FormatAsString(System.String,System.Boolean)">
  42353. @return the text format of this range using specified sheet name.
  42354. </member>
  42355. <member name="M:NPOI.SS.Util.CellRangeAddress.ValueOf(System.String)">
  42356. <summary>
  42357. Creates a CellRangeAddress from a cell range reference string.
  42358. </summary>
  42359. <param name="reference">
  42360. usually a standard area ref (e.g. "B1:D8"). May be a single
  42361. cell ref (e.g. "B5") in which case the result is a 1 x 1 cell
  42362. range. May also be a whole row range (e.g. "3:5"), or a whole
  42363. column range (e.g. "C:F")
  42364. </param>
  42365. <returns>a CellRangeAddress object</returns>
  42366. </member>
  42367. <member name="T:NPOI.SS.Util.CellRangeAddressBase">
  42368. See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/>
  42369. Common subclass of 8-bit and 16-bit versions
  42370. @author Josh Micich
  42371. </member>
  42372. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Validate(NPOI.SS.SpreadsheetVersion)">
  42373. Validate the range limits against the supplied version of Excel
  42374. @param ssVersion the version of Excel to validate against
  42375. @throws IllegalArgumentException if the range limits are outside of the allowed range
  42376. </member>
  42377. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateRow(System.Int32,NPOI.SS.SpreadsheetVersion)">
  42378. Runs a bounds check for row numbers
  42379. @param row
  42380. </member>
  42381. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateColumn(System.Int32,NPOI.SS.SpreadsheetVersion)">
  42382. Runs a bounds check for column numbers
  42383. @param column
  42384. </member>
  42385. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ContainsRow(System.Int32)">
  42386. Check if the row is in the specified cell range
  42387. @param rowInd the row to check
  42388. @return true if the range contains the row [rowInd]
  42389. </member>
  42390. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ContainsColumn(System.Int32)">
  42391. Check if the column is in the specified cell range
  42392. @param colInd the column to check
  42393. @return true if the range contains the column [colInd]
  42394. </member>
  42395. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Intersects(NPOI.SS.Util.CellRangeAddressBase)">
  42396. <summary>
  42397. Determines whether or not this CellRangeAddress and the specified CellRangeAddress intersect.
  42398. </summary>
  42399. <param name="other">a candidate cell range address to check for intersection with this range</param>
  42400. <returns>returns true if this range and other range have at least 1 cell in common</returns>
  42401. </member>
  42402. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstColumn">
  42403. @return column number for the upper left hand corner
  42404. </member>
  42405. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstRow">
  42406. @return row number for the upper left hand corner
  42407. </member>
  42408. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastColumn">
  42409. @return column number for the lower right hand corner
  42410. </member>
  42411. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastRow">
  42412. @return row number for the lower right hand corner
  42413. </member>
  42414. <member name="P:NPOI.SS.Util.CellRangeAddressBase.NumberOfCells">
  42415. @return the size of the range (number of cells in the area).
  42416. </member>
  42417. <member name="F:NPOI.SS.Util.CellRangeAddressList._list">
  42418. List of <c>CellRangeAddress</c>es. Each structure represents a cell range
  42419. </member>
  42420. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  42421. Convenience constructor for creating a <c>CellRangeAddressList</c> with a single
  42422. <c>CellRangeAddress</c>. Other <c>CellRangeAddress</c>es may be Added later.
  42423. </member>
  42424. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  42425. @param in the RecordInputstream to read the record from
  42426. </member>
  42427. <member name="M:NPOI.SS.Util.CellRangeAddressList.CountRanges">
  42428. Get the number of following ADDR structures. The number of this
  42429. structures is automatically set when reading an Excel file and/or
  42430. increased when you manually Add a new ADDR structure . This is the reason
  42431. there isn't a set method for this field .
  42432. @return number of ADDR structures
  42433. </member>
  42434. <member name="M:NPOI.SS.Util.CellRangeAddressList.AddCellRangeAddress(System.Int32,System.Int32,System.Int32,System.Int32)">
  42435. Add a cell range structure.
  42436. @param firstRow - the upper left hand corner's row
  42437. @param firstCol - the upper left hand corner's col
  42438. @param lastRow - the lower right hand corner's row
  42439. @param lastCol - the lower right hand corner's col
  42440. @return the index of this ADDR structure
  42441. </member>
  42442. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetCellRangeAddress(System.Int32)">
  42443. @return <c>CellRangeAddress</c> at the given index
  42444. </member>
  42445. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetEncodedSize(System.Int32)">
  42446. @return the total size of for the specified number of ranges,
  42447. including the initial 2 byte range count
  42448. </member>
  42449. <member name="F:NPOI.SS.Util.NameType.None">
  42450. <summary>
  42451. Allow accessing the Initial value.
  42452. </summary>
  42453. </member>
  42454. <member name="T:NPOI.SS.Util.CellReference">
  42455. <p>Common conversion functions between Excel style A1, C27 style
  42456. cell references, and POI usermodel style row=0, column=0
  42457. style references. Handles sheet-based and sheet-free references
  42458. as well, eg "Sheet1!A1" and "$B$72"</p>
  42459. <p>Use <tt>CellReference</tt> when the concept of
  42460. relative/absolute does apply (such as a cell reference in a formula).
  42461. Use {@link CellAddress} when you want to refer to the location of a cell in a sheet
  42462. when the concept of relative/absolute does not apply (such as the anchor location
  42463. of a cell comment).
  42464. <tt>CellReference</tt>s have a concept of "sheet", while <tt>CellAddress</tt>es do not.</p>
  42465. </member>
  42466. <member name="F:NPOI.SS.Util.CellReference.ABSOLUTE_REFERENCE_MARKER">
  42467. The character ($) that signifies a row or column value is absolute instead of relative
  42468. </member>
  42469. <member name="F:NPOI.SS.Util.CellReference.SHEET_NAME_DELIMITER">
  42470. The character (!) that Separates sheet names from cell references
  42471. </member>
  42472. <member name="F:NPOI.SS.Util.CellReference.SPECIAL_NAME_DELIMITER">
  42473. The character (') used to quote sheet names when they contain special characters
  42474. </member>
  42475. <member name="F:NPOI.SS.Util.CellReference.CELL_REF_PATTERN">
  42476. Matches a run of one or more letters followed by a run of one or more digits.
  42477. Both the letter and number groups are optional.
  42478. The run of letters is group 1 and the run of digits is group 2.
  42479. Each group may optionally be prefixed with a single '$'.
  42480. </member>
  42481. <member name="F:NPOI.SS.Util.CellReference.STRICTLY_CELL_REF_PATTERN">
  42482. Matches references only where row and column are included.
  42483. Matches a run of one or more letters followed by a run of one or more digits.
  42484. If a reference does not match this pattern, it might match COLUMN_REF_PATTERN or ROW_REF_PATTERN
  42485. References may optionally include a single '$' before each group, but these are excluded from the Matcher.group(int).
  42486. </member>
  42487. <member name="F:NPOI.SS.Util.CellReference.COLUMN_REF_PATTERN">
  42488. Matches a run of one or more letters. The run of letters is group 1.
  42489. References may optionally include a single '$' before the group, but these are excluded from the Matcher.group(int).
  42490. </member>
  42491. <member name="F:NPOI.SS.Util.CellReference.ROW_REF_PATTERN">
  42492. Matches a run of one or more letters. The run of numbers is group 1.
  42493. References may optionally include a single '$' before the group, but these are excluded from the Matcher.group(int).
  42494. </member>
  42495. <member name="F:NPOI.SS.Util.CellReference.NAMED_RANGE_NAME_PATTERN">
  42496. Named range names must start with a letter or underscore. Subsequent characters may include
  42497. digits or dot. (They can even end in dot).
  42498. </member>
  42499. <member name="M:NPOI.SS.Util.CellReference.#ctor(System.String)">
  42500. Create an cell ref from a string representation. Sheet names containing special characters should be
  42501. delimited and escaped as per normal syntax rules for formulas.
  42502. </member>
  42503. <member name="P:NPOI.SS.Util.CellReference.SheetName">
  42504. @return possibly <c>null</c> if this is a 2D reference. Special characters are not
  42505. escaped or delimited
  42506. </member>
  42507. <member name="M:NPOI.SS.Util.CellReference.ConvertColStringToIndex(System.String)">
  42508. takes in a column reference portion of a CellRef and converts it from
  42509. ALPHA-26 number format to 0-based base 10.
  42510. 'A' -> 0
  42511. 'Z' -> 25
  42512. 'AA' -> 26
  42513. 'IV' -> 255
  42514. @return zero based column index
  42515. </member>
  42516. <member name="M:NPOI.SS.Util.CellReference.ConvertNumToColString(System.Int32)">
  42517. Takes in a 0-based base-10 column and returns a ALPHA-26
  42518. representation.
  42519. eg column #3 -> D
  42520. </member>
  42521. <member name="M:NPOI.SS.Util.CellReference.SeparateRefParts(System.String)">
  42522. Separates the row from the columns and returns an array of three Strings. The first element
  42523. is the sheet name. Only the first element may be null. The second element in is the column
  42524. name still in ALPHA-26 number format. The third element is the row.
  42525. </member>
  42526. <member name="M:NPOI.SS.Util.CellReference.FormatAsString">
  42527. Example return values:
  42528. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  42529. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  42530. <tr><td>A1</td><td>Cell reference without sheet</td></tr>
  42531. <tr><td>Sheet1!A1</td><td>Standard sheet name</td></tr>
  42532. <tr><td>'O''Brien''s Sales'!A1'</td><td>Sheet name with special characters</td></tr>
  42533. </table>
  42534. @return the text representation of this cell reference as it would appear in a formula.
  42535. </member>
  42536. <member name="P:NPOI.SS.Util.CellReference.CellRefParts">
  42537. Returns the three parts of the cell reference, the
  42538. Sheet name (or null if none supplied), the 1 based
  42539. row number, and the A based column letter.
  42540. This will not include any markers for absolute
  42541. references, so use {@link #formatAsString()}
  42542. to properly turn references into strings.
  42543. </member>
  42544. <member name="M:NPOI.SS.Util.CellReference.AppendCellReference(System.Text.StringBuilder)">
  42545. Appends cell reference with '$' markers for absolute values as required.
  42546. Sheet name is not included.
  42547. </member>
  42548. <member name="M:NPOI.SS.Util.CellReference.CellReferenceIsWithinRange(System.String,System.String,NPOI.SS.SpreadsheetVersion)">
  42549. Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
  42550. interpreted as a cell reference. Names of that form can be also used for sheets and/or
  42551. named ranges, and in those circumstances, the question of whether the potential cell
  42552. reference is valid (in range) becomes important.
  42553. <p/>
  42554. Note - that the maximum sheet size varies across Excel versions:
  42555. <p/>
  42556. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  42557. summary="Notable cases.">
  42558. <tr><th>Version </th><th>File Format </th>
  42559. <th>Last Column </th><th>Last Row</th></tr>
  42560. <tr><td>97-2003</td><td>BIFF8</td><td>"IV" (2^8)</td><td>65536 (2^14)</td></tr>
  42561. <tr><td>2007</td><td>BIFF12</td><td>"XFD" (2^14)</td><td>1048576 (2^20)</td></tr>
  42562. </table></blockquote>
  42563. POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for
  42564. this method:
  42565. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  42566. summary="Notable cases.">
  42567. <tr><th>Input </th>
  42568. <th>Result </th></tr>
  42569. <tr><td>"A", "1"</td><td>true</td></tr>
  42570. <tr><td>"a", "111"</td><td>true</td></tr>
  42571. <tr><td>"A", "65536"</td><td>true</td></tr>
  42572. <tr><td>"A", "65537"</td><td>false</td></tr>
  42573. <tr><td>"iv", "1"</td><td>true</td></tr>
  42574. <tr><td>"IW", "1"</td><td>false</td></tr>
  42575. <tr><td>"AAA", "1"</td><td>false</td></tr>
  42576. <tr><td>"a", "111"</td><td>true</td></tr>
  42577. <tr><td>"Sheet", "1"</td><td>false</td></tr>
  42578. </table></blockquote>
  42579. @param colStr a string of only letter characters
  42580. @param rowStr a string of only digit characters
  42581. @return <c>true</c> if the row and col parameters are within range of a BIFF8 spreadsheet.
  42582. </member>
  42583. <member name="M:NPOI.SS.Util.CellReference.IsColumnWithnRange(System.String,NPOI.SS.SpreadsheetVersion)">
  42584. @deprecated 3.15 beta 2. Use {@link #isColumnWithinRange}.
  42585. </member>
  42586. <member name="T:NPOI.SS.Util.CellUtil">
  42587. Various utility functions that make working with a cells and rows easier. The various methods
  42588. that deal with style's allow you to create your CellStyles as you need them. When you apply a
  42589. style change to a cell, the code will attempt to see if a style already exists that meets your
  42590. needs. If not, then it will create a new style. This is to prevent creating too many styles.
  42591. there is an upper limit in Excel on the number of styles that can be supported.
  42592. @author Eric Pugh epugh@upstate.com
  42593. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  42594. </member>
  42595. <member name="M:NPOI.SS.Util.CellUtil.GetRow(System.Int32,NPOI.SS.UserModel.ISheet)">
  42596. Get a row from the spreadsheet, and create it if it doesn't exist.
  42597. @param rowIndex The 0 based row number
  42598. @param sheet The sheet that the row is part of.
  42599. @return The row indicated by the rowCounter
  42600. </member>
  42601. <member name="M:NPOI.SS.Util.CellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  42602. Get a specific cell from a row. If the cell doesn't exist, then create it.
  42603. @param row The row that the cell is part of
  42604. @param columnIndex The column index that the cell is in.
  42605. @return The cell indicated by the column.
  42606. </member>
  42607. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.SS.UserModel.ICellStyle)">
  42608. Creates a cell, gives it a value, and applies a style if provided
  42609. @param row the row to create the cell in
  42610. @param column the column index to create the cell in
  42611. @param value The value of the cell
  42612. @param style If the style is not null, then set
  42613. @return A new Cell
  42614. </member>
  42615. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  42616. Create a cell, and give it a value.
  42617. @param row the row to create the cell in
  42618. @param column the column index to create the cell in
  42619. @param value The value of the cell
  42620. @return A new Cell.
  42621. </member>
  42622. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.Int16)">
  42623. Take a cell, and align it.
  42624. @param cell the cell to set the alignment for
  42625. @param workbook The workbook that is being worked with.
  42626. @param align the column alignment to use.
  42627. @see CellStyle for alignment options
  42628. </member>
  42629. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.HorizontalAlignment)">
  42630. Take a cell, and align it.
  42631. This is superior to cell.getCellStyle().setAlignment(align) because
  42632. this method will not modify the CellStyle object that may be referenced
  42633. by multiple cells. Instead, this method will search for existing CellStyles
  42634. that match the desired CellStyle, creating a new CellStyle with the desired
  42635. style if no match exists.
  42636. @param cell the cell to set the alignment for
  42637. @param align the horizontal alignment to use.
  42638. @see HorizontalAlignment for alignment options
  42639. @since POI 3.15 beta 3
  42640. </member>
  42641. <member name="M:NPOI.SS.Util.CellUtil.SetVerticalAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.VerticalAlignment)">
  42642. Take a cell, and vertically align it.
  42643. This is superior to cell.getCellStyle().setVerticalAlignment(align) because
  42644. this method will not modify the CellStyle object that may be referenced
  42645. by multiple cells. Instead, this method will search for existing CellStyles
  42646. that match the desired CellStyle, creating a new CellStyle with the desired
  42647. style if no match exists.
  42648. @param cell the cell to set the alignment for
  42649. @param align the vertical alignment to use.
  42650. @see VerticalAlignment for alignment options
  42651. @since POI 3.15 beta 3
  42652. </member>
  42653. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,NPOI.SS.UserModel.IFont)">
  42654. Take a cell, and apply a font to it
  42655. @param cell the cell to set the alignment for
  42656. @param workbook The workbook that is being worked with.
  42657. @param font The Font that you want to set...
  42658. </member>
  42659. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFont)">
  42660. Take a cell, and apply a font to it
  42661. @param cell the cell to set the alignment for
  42662. @param font The Font that you want to set.
  42663. @throws IllegalArgumentException if <tt>font</tt> and <tt>cell</tt> do not belong to the same workbook
  42664. </member>
  42665. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperties(NPOI.SS.UserModel.ICell,System.Collections.Generic.Dictionary{System.String,System.Object})">
  42666. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  42667. current style plus styles properties in <code>properties</code>. A new style is created if the
  42668. workbook does not contain a matching style.</p>
  42669. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  42670. same style.</p>
  42671. <p>This is necessary because Excel has an upper limit on the number of styles that it supports.</p>
  42672. <p>This function is more efficient than multiple calls to
  42673. {@link #setCellStyleProperty(org.apache.poi.ss.usermodel.Cell, org.apache.poi.ss.usermodel.Workbook, String, Object)}
  42674. if adding multiple cell styles.</p>
  42675. <p>For performance reasons, if this is the only cell in a workbook that uses a cell style,
  42676. this method does NOT remove the old style from the workbook.
  42677. <!-- NOT IMPLEMENTED: Unused styles should be
  42678. pruned from the workbook with [@link #removeUnusedCellStyles(Workbook)] or
  42679. [@link #removeStyleFromWorkbookIfUnused(CellStyle, Workbook)]. -->
  42680. </p>
  42681. @param cell The cell to change the style of
  42682. @param properties The properties to be added to a cell style, as {propertyName: propertyValue}.
  42683. @since POI 3.14 beta 2
  42684. </member>
  42685. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,System.String,System.Object)">
  42686. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  42687. current style plus a single style property <code>propertyName</code> with value
  42688. <code>propertyValue</code>.
  42689. A new style is created if the workbook does not contain a matching style.</p>
  42690. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  42691. same style.</p>
  42692. <p>If setting more than one cell style property on a cell, use
  42693. {@link #setCellStyleProperties(org.apache.poi.ss.usermodel.Cell, Map)},
  42694. which is faster and does not add unnecessary intermediate CellStyles to the workbook.</p>
  42695. @param cell The cell that is to be changed.
  42696. @param propertyName The name of the property that is to be changed.
  42697. @param propertyValue The value of the property that is to be changed.
  42698. </member>
  42699. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.String,System.Object)">
  42700. <p>This method attempts to find an existing CellStyle that matches the <code>cell</code>'s
  42701. current style plus a single style property <code>propertyName</code> with value
  42702. <code>propertyValue</code>.
  42703. A new style is created if the workbook does not contain a matching style.</p>
  42704. <p>Modifies the cell style of <code>cell</code> without affecting other cells that use the
  42705. same style.</p>
  42706. <p>If setting more than one cell style property on a cell, use
  42707. {@link #setCellStyleProperties(Cell, Map)},
  42708. which is faster and does not add unnecessary intermediate CellStyles to the workbook.</p>
  42709. @param workbook The workbook that is being worked with.
  42710. @param propertyName The name of the property that is to be changed.
  42711. @param propertyValue The value of the property that is to be changed.
  42712. @param cell The cell that needs it's style changes
  42713. </member>
  42714. <member name="M:NPOI.SS.Util.CellUtil.PutAll(System.Collections.Generic.Dictionary{System.String,System.Object},System.Collections.Generic.Dictionary{System.String,System.Object})">
  42715. Copies the entries in src to dest, using the preferential data type
  42716. so that maps can be compared for equality
  42717. @param src the property map to copy from (read-only)
  42718. @param dest the property map to copy into
  42719. @since POI 3.15 beta 3
  42720. </member>
  42721. <member name="M:NPOI.SS.Util.CellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  42722. Returns a map containing the format properties of the given cell style.
  42723. The returned map is not tied to <code>style</code>, so subsequent changes
  42724. to <code>style</code> will not modify the map, and changes to the returned
  42725. map will not modify the cell style. The returned map is mutable.
  42726. @param style cell style
  42727. @return map of format properties (String -> Object)
  42728. @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
  42729. </member>
  42730. <member name="M:NPOI.SS.Util.CellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.SS.UserModel.IWorkbook,System.Collections.Generic.Dictionary{System.String,System.Object})">
  42731. Sets the format properties of the given style based on the given map.
  42732. @param style cell style
  42733. @param workbook parent workbook
  42734. @param properties map of format properties (String -> Object)
  42735. @see #getFormatProperties(CellStyle)
  42736. </member>
  42737. <member name="M:NPOI.SS.Util.CellUtil.GetShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  42738. Utility method that returns the named short value form the given map.
  42739. @param properties map of named properties (String -> Object)
  42740. @param name property name
  42741. @return zero if the property does not exist, or is not a {@link Short}.
  42742. </member>
  42743. <member name="M:NPOI.SS.Util.CellUtil.GetInt(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  42744. Utility method that returns the named int value from the given map.
  42745. @param properties map of named properties (String -> Object)
  42746. @param name property name
  42747. @return zero if the property does not exist, or is not a {@link Integer}
  42748. otherwise the property value
  42749. </member>
  42750. <member name="M:NPOI.SS.Util.CellUtil.GetBorderStyle(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  42751. Utility method that returns the named BorderStyle value form the given map.
  42752. @param properties map of named properties (String -> Object)
  42753. @param name property name
  42754. @return Border style if set, otherwise {@link BorderStyle#NONE}
  42755. </member>
  42756. <member name="M:NPOI.SS.Util.CellUtil.GetFillPattern(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  42757. Utility method that returns the named FillPattern value from the given map.
  42758. @param properties map of named properties (String -> Object)
  42759. @param name property name
  42760. @return FillPattern style if set, otherwise {@link FillPattern#NO_FILL}
  42761. @since POI 3.15 beta 3
  42762. </member>
  42763. <member name="M:NPOI.SS.Util.CellUtil.GetHorizontalAlignment(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  42764. Utility method that returns the named HorizontalAlignment value from the given map.
  42765. @param properties map of named properties (String -> Object)
  42766. @param name property name
  42767. @return HorizontalAlignment style if set, otherwise {@link HorizontalAlignment#GENERAL}
  42768. @since POI 3.15 beta 3
  42769. </member>
  42770. <member name="M:NPOI.SS.Util.CellUtil.GetVerticalAlignment(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  42771. Utility method that returns the named VerticalAlignment value from the given map.
  42772. @param properties map of named properties (String -> Object)
  42773. @param name property name
  42774. @return VerticalAlignment style if set, otherwise {@link VerticalAlignment#BOTTOM}
  42775. @since POI 3.15 beta 3
  42776. </member>
  42777. <member name="M:NPOI.SS.Util.CellUtil.GetBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  42778. Utility method that returns the named boolean value form the given map.
  42779. @param properties map of properties (String -> Object)
  42780. @param name property name
  42781. @return false if the property does not exist, or is not a {@link Boolean}.
  42782. </member>
  42783. <member name="M:NPOI.SS.Util.CellUtil.Put(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Object)">
  42784. Utility method that puts the given value to the given map.
  42785. @param properties map of properties (String -> Object)
  42786. @param name property name
  42787. @param value property value
  42788. </member>
  42789. <member name="M:NPOI.SS.Util.CellUtil.PutShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Int16)">
  42790. Utility method that puts the named short value to the given map.
  42791. @param properties map of properties (String -> Object)
  42792. @param name property name
  42793. @param value property value
  42794. </member>
  42795. <member name="M:NPOI.SS.Util.CellUtil.PutEnum(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Enum)">
  42796. Utility method that puts the named short value to the given map.
  42797. @param properties map of properties (String -> Object)
  42798. @param name property name
  42799. @param value property value
  42800. </member>
  42801. <member name="M:NPOI.SS.Util.CellUtil.PutBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Boolean)">
  42802. Utility method that puts the named boolean value to the given map.
  42803. @param properties map of properties (String -> Object)
  42804. @param name property name
  42805. @param value property value
  42806. </member>
  42807. <member name="M:NPOI.SS.Util.CellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  42808. Looks for text in the cell that should be unicode, like an alpha and provides the
  42809. unicode version of it.
  42810. @param cell The cell to check for unicode values
  42811. @return translated to unicode
  42812. </member>
  42813. <member name="T:NPOI.SS.Util.CellWalk.ICellHandler">
  42814. Represents callback for CellWalk traverse method.
  42815. @author Roman Kashitsyn
  42816. </member>
  42817. <member name="M:NPOI.SS.Util.CellWalk.ICellHandler.OnCell(NPOI.SS.UserModel.ICell,NPOI.SS.Util.CellWalk.ICellWalkContext)">
  42818. @param cell current cell
  42819. @param ctx information about invokation context
  42820. </member>
  42821. <member name="T:NPOI.SS.Util.CellWalk.CellWalk">
  42822. Traverse cell range.
  42823. @author Roman Kashitsyn
  42824. </member>
  42825. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.IsTraverseEmptyCells">
  42826. Should we call handler on empty (blank) cells. Default is
  42827. false.
  42828. @return true if handler should be called on empty (blank)
  42829. cells, false otherwise.
  42830. </member>
  42831. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.SetTraverseEmptyCells(System.Boolean)">
  42832. Sets the traverseEmptyCells property.
  42833. @param traverseEmptyCells new property value
  42834. </member>
  42835. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.Traverse(NPOI.SS.Util.CellWalk.ICellHandler)">
  42836. Traverse cell range from top left to bottom right cell.
  42837. @param handler handler to call on each appropriate cell
  42838. </member>
  42839. <member name="T:NPOI.SS.Util.CellWalk.CellWalk.SimpleCellWalkContext">
  42840. Inner class to hold walk context.
  42841. @author Roman Kashitsyn
  42842. </member>
  42843. <member name="T:NPOI.SS.Util.CellWalk.ICellWalkContext">
  42844. @author Roman Kashitsyn
  42845. </member>
  42846. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.OrdinalNumber">
  42847. Returns ordinal number of cell in range. Numeration starts
  42848. from top left cell and ends at bottom right cell. Here is a
  42849. brief example (number in cell is it's ordinal number):
  42850. <table border="1">
  42851. <tbody>
  42852. <tr><td>1</td><td>2</td></tr>
  42853. <tr><td>3</td><td>4</td></tr>
  42854. </tbody>
  42855. </table>
  42856. @return ordinal number of current cell
  42857. </member>
  42858. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.RowNumber">
  42859. Returns number of current row.
  42860. @return number of current row
  42861. </member>
  42862. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.ColumnNumber">
  42863. Returns number of current column.
  42864. @return number of current column
  42865. </member>
  42866. <member name="F:NPOI.SS.Util.ExpandedDouble._significand">
  42867. Always 64 bits long (MSB, bit-63 is '1')
  42868. </member>
  42869. <member name="M:NPOI.SS.Util.ExpandedDouble.NormaliseBaseTen">
  42870. Convert to an equivalent {@link NormalisedDecimal} representation having 15 decimal digits of precision in the
  42871. non-fractional bits of the significand.
  42872. </member>
  42873. <member name="M:NPOI.SS.Util.ExpandedDouble.GetBinaryExponent">
  42874. @return the number of non-fractional bits after the MSB of the significand
  42875. </member>
  42876. <member name="T:NPOI.SS.Util.FormatBase">
  42877. <summary>
  42878. A substitute class for Format class in Java
  42879. </summary>
  42880. </member>
  42881. <member name="T:NPOI.SS.Util.SSNFormat">
  42882. Format class for Excel's SSN Format. This class mimics Excel's built-in
  42883. SSN Formatting.
  42884. @author James May
  42885. </member>
  42886. <member name="M:NPOI.SS.Util.SSNFormat.Format(System.Object,System.Globalization.CultureInfo)">
  42887. Format a number as an SSN
  42888. </member>
  42889. <member name="T:NPOI.SS.Util.ZipPlusFourFormat">
  42890. Format class for Excel Zip + 4 Format. This class mimics Excel's
  42891. built-in Formatting for Zip + 4.
  42892. @author James May
  42893. </member>
  42894. <member name="M:NPOI.SS.Util.ZipPlusFourFormat.Format(System.Object,System.Globalization.CultureInfo)">
  42895. Format a number as Zip + 4
  42896. </member>
  42897. <member name="T:NPOI.SS.Util.PhoneFormat">
  42898. Format class for Excel phone number Format. This class mimics Excel's
  42899. built-in phone number Formatting.
  42900. @author James May
  42901. </member>
  42902. <member name="M:NPOI.SS.Util.PhoneFormat.Format(System.Object,System.Globalization.CultureInfo)">
  42903. Format a number as a phone number
  42904. </member>
  42905. <member name="T:NPOI.SS.Util.ConstantStringFormat">
  42906. Format class that does nothing and always returns a constant string.
  42907. This format is used to simulate Excel's handling of a format string
  42908. of all # when the value is 0. Excel will output "", Java will output "0".
  42909. @see DataFormatter#createFormat(double, int, String)
  42910. </member>
  42911. <member name="F:NPOI.SS.Util.IEEEDouble.BIASED_EXPONENT_SPECIAL_VALUE">
  42912. The value the exponent field Gets for all <i>NaN</i> and <i>InfInity</i> values
  42913. </member>
  42914. <member name="M:NPOI.SS.Util.IEEEDouble.GetBiasedExponent(System.Int64)">
  42915. @param rawBits the 64 bit binary representation of the double value
  42916. @return the top 12 bits (sign and biased exponent value)
  42917. </member>
  42918. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MIN_BASE">
  42919. The minimum value in 'Base-10 normalised form'.<br/>
  42920. When {@link #_binaryExponent} == 46 this is the the minimum {@link #_frac} value
  42921. (10<sup>14</sup>-0.05) * 2^17
  42922. <br/>
  42923. Values between (10<sup>14</sup>-0.05) and 10<sup>14</sup> will be represented as '1'
  42924. followed by 14 zeros.
  42925. Values less than (10<sup>14</sup>-0.05) will get Shifted by one more power of 10
  42926. This frac value rounds to '1' followed by fourteen zeros with an incremented decimal exponent
  42927. </member>
  42928. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MAX_BASE">
  42929. For 'Base-10 normalised form'<br/>
  42930. The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
  42931. (10^15-0.5) * 2^14
  42932. </member>
  42933. <member name="F:NPOI.SS.Util.MutableFPNumber.C_64">
  42934. Width of a long
  42935. </member>
  42936. <member name="F:NPOI.SS.Util.MutableFPNumber.MIN_PRECISION">
  42937. Minimum precision after discarding whole 32-bit words from the significand
  42938. </member>
  42939. <member name="M:NPOI.SS.Util.MutableFPNumber.Rounder.Round(NPOI.Util.BigInteger,System.Int32)">
  42940. @param nBits number of bits to shift right
  42941. </member>
  42942. <member name="T:NPOI.SS.Util.MutableFPNumber.TenPower">
  42943. Holds values for quick multiplication and division by 10
  42944. </member>
  42945. <member name="F:NPOI.SS.Util.NormalisedDecimal.EXPONENT_OFFSET">
  42946. Number of powers of ten Contained in the significand
  42947. </member>
  42948. <member name="F:NPOI.SS.Util.NormalisedDecimal.C_2_POW_19">
  42949. 2<sup>19</sup>
  42950. </member>
  42951. <member name="F:NPOI.SS.Util.NormalisedDecimal.FRAC_HALF">
  42952. the value of {@link #_fractionalPart} that represents 0.5
  42953. </member>
  42954. <member name="F:NPOI.SS.Util.NormalisedDecimal.MAX_REP_WHOLE_PART">
  42955. 10<sup>15</sup>
  42956. </member>
  42957. <member name="M:NPOI.SS.Util.NormalisedDecimal.RoundUnits">
  42958. Rounds at the digit with value 10<sup>decimalExponent</sup>
  42959. </member>
  42960. <member name="F:NPOI.SS.Util.NormalisedDecimal._relativeDecimalExponent">
  42961. The decimal exponent increased by one less than the digit count of {@link #_wholePart}
  42962. </member>
  42963. <member name="F:NPOI.SS.Util.NormalisedDecimal._wholePart">
  42964. The whole part of the significand (typically 15 digits).
  42965. 47-50 bits long (MSB may be anywhere from bit 46 to 49)
  42966. LSB is units bit.
  42967. </member>
  42968. <member name="F:NPOI.SS.Util.NormalisedDecimal._fractionalPart">
  42969. The fractional part of the significand.
  42970. 24 bits (only top 14-17 bits significant): a value between 0x000000 and 0xFFFF80
  42971. </member>
  42972. <member name="M:NPOI.SS.Util.NormalisedDecimal.NormaliseBaseTwo">
  42973. Convert to an equivalent {@link ExpandedDouble} representation (binary frac and exponent).
  42974. The resulting transformed object is easily Converted to a 64 bit IEEE double:
  42975. <ul>
  42976. <li>bits 2-53 of the {@link #GetSignificand()} become the 52 bit 'fraction'.</li>
  42977. <li>{@link #GetBinaryExponent()} is biased by 1023 to give the 'exponent'.</li>
  42978. </ul>
  42979. The sign bit must be obtained from somewhere else.
  42980. @return a new {@link NormalisedDecimal} normalised to base 2 representation.
  42981. </member>
  42982. <member name="M:NPOI.SS.Util.NormalisedDecimal.ComposeFrac">
  42983. @return the significand as a fixed point number (with 24 fraction bits and 47-50 whole bits)
  42984. </member>
  42985. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetSignificantDecimalDigitsLastDigitRounded">
  42986. Rounds the first whole digit position (considers only units digit, not frational part).
  42987. Caller should check total digit count of result to see whether the rounding operation caused
  42988. a carry out of the most significant digit
  42989. </member>
  42990. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetDecimalExponent">
  42991. @return the number of powers of 10 which have been extracted from the significand and binary exponent.
  42992. </member>
  42993. <member name="M:NPOI.SS.Util.NormalisedDecimal.CompareNormalised(NPOI.SS.Util.NormalisedDecimal)">
  42994. assumes both this and other are normalised
  42995. </member>
  42996. <member name="M:NPOI.SS.Util.NumberComparer.Compare(System.Double,System.Double)">
  42997. This class attempts to reproduce Excel's behaviour for comparing numbers. Results are
  42998. mostly the same as those from {@link Double#compare(double, double)} but with some
  42999. rounding. For numbers that are very close, this code converts to a format having 15
  43000. decimal digits of precision and a decimal exponent, before completing the comparison.
  43001. <p/>
  43002. In Excel formula evaluation, expressions like "(0.06-0.01)=0.05" evaluate to "TRUE" even
  43003. though the equivalent java expression is <c>false</c>. In examples like this,
  43004. Excel achieves the effect by having additional logic for comparison operations.
  43005. <p/>
  43006. <p/>
  43007. Note - Excel also gives special treatment to expressions like "0.06-0.01-0.05" which
  43008. evaluates to "0" (in java, rounding anomalies give a result of 6.9E-18). The special
  43009. behaviour here is for different reasons to the example above: If the last operator in a
  43010. cell formula is '+' or '-' and the result is less than 2<sup>50</sup> times smaller than
  43011. first operand, the result is rounded to zero.
  43012. Needless to say, the two rules are not consistent and it is relatively easy to find
  43013. examples that satisfy<br/>
  43014. "A=B" is "TRUE" but "A-B" is not "0"<br/>
  43015. and<br/>
  43016. "A=B" is "FALSE" but "A-B" is "0"<br/>
  43017. <br/>
  43018. This rule (for rounding the result of a final addition or subtraction), has not been
  43019. implemented in POI (as of Jul-2009).
  43020. @return <code>negative, 0, or positive</code> according to the standard Excel comparison
  43021. of values <c>a</c> and <c>b</c>.
  43022. </member>
  43023. <member name="M:NPOI.SS.Util.NumberComparer.CompareSubnormalNumbers(System.Int64,System.Int64,System.Boolean)">
  43024. If both numbers are subnormal, Excel seems to use standard comparison rules
  43025. </member>
  43026. <member name="M:NPOI.SS.Util.NumberComparer.CompareAcrossSubnormalThreshold(System.Int64,System.Int64,System.Boolean)">
  43027. Usually any normal number is greater (in magnitude) than any subnormal number.
  43028. However there are some anomalous cases around the threshold where Excel produces screwy results
  43029. @param isNegative both values are either negative or positive. This parameter affects the sign of the comparison result
  43030. @return usually <code>isNegative ? -1 : +1</code>
  43031. </member>
  43032. <member name="M:NPOI.SS.Util.NumberComparer.ToHex(System.Double)">
  43033. for formatting double values in error messages
  43034. </member>
  43035. <member name="M:NPOI.SS.Util.NumberToTextConverter.ToText(System.Double)">
  43036. Converts the supplied <c>value</c> to the text representation that Excel would give if
  43037. the value were to appear in an unformatted cell, or as a literal number in a formula.<br/>
  43038. Note - the results from this method differ slightly from those of <c>Double.ToString()</c>
  43039. In some special cases Excel behaves quite differently. This function attempts to reproduce
  43040. those results.
  43041. </member>
  43042. <member name="T:NPOI.SS.Util.PaneInformation">
  43043. Holds information regarding a split plane or freeze plane for a sheet.
  43044. </member>
  43045. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_RIGHT">
  43046. Constant for active pane being the lower right
  43047. </member>
  43048. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_RIGHT">
  43049. Constant for active pane being the upper right
  43050. </member>
  43051. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_LEFT">
  43052. Constant for active pane being the lower left
  43053. </member>
  43054. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_LEFT">
  43055. Constant for active pane being the upper left
  43056. </member>
  43057. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitPosition">
  43058. Returns the vertical position of the split.
  43059. @return 0 if there is no vertical spilt,
  43060. or for a freeze pane the number of columns in the TOP pane,
  43061. or for a split plane the position of the split in 1/20th of a point.
  43062. </member>
  43063. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitPosition">
  43064. Returns the horizontal position of the split.
  43065. @return 0 if there is no horizontal spilt,
  43066. or for a freeze pane the number of rows in the LEFT pane,
  43067. or for a split plane the position of the split in 1/20th of a point.
  43068. </member>
  43069. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitTopRow">
  43070. For a horizontal split returns the top row in the BOTTOM pane.
  43071. @return 0 if there is no horizontal split, or the top row of the bottom pane.
  43072. </member>
  43073. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitLeftColumn">
  43074. For a vertical split returns the left column in the RIGHT pane.
  43075. @return 0 if there is no vertical split, or the left column in the RIGHT pane.
  43076. </member>
  43077. <member name="P:NPOI.SS.Util.PaneInformation.ActivePane">
  43078. Returns the active pane
  43079. @see #PANE_LOWER_RIGHT
  43080. @see #PANE_UPPER_RIGHT
  43081. @see #PANE_LOWER_LEFT
  43082. @see #PANE_UPPER_LEFT
  43083. @return the active pane.
  43084. </member>
  43085. <member name="M:NPOI.SS.Util.PaneInformation.IsFreezePane">
  43086. Returns true if this is a Freeze pane, false if it is a split pane.
  43087. </member>
  43088. <member name="T:NPOI.SS.Util.RegionUtil">
  43089. Various utility functions that make working with a region of cells easier.
  43090. @author Eric Pugh epugh@upstate.com
  43091. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  43092. </member>
  43093. <member name="T:NPOI.SS.Util.RegionUtil.CellPropertySetter">
  43094. For setting the same property on many cells to the same value
  43095. </member>
  43096. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderLeft(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43097. Sets the left border for a region of cells by manipulating the cell style of the individual
  43098. cells on the left
  43099. @param border The new border
  43100. @param region The region that should have the border
  43101. @param workbook The workbook that the region is on.
  43102. @param sheet The sheet that the region is on.
  43103. </member>
  43104. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderLeft(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43105. Sets the left border for a region of cells by manipulating the cell style of the individual
  43106. cells on the left
  43107. @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
  43108. @param border The new border
  43109. @param region The region that should have the border
  43110. @param workbook The workbook that the region is on.
  43111. @param sheet The sheet that the region is on.
  43112. </member>
  43113. <member name="M:NPOI.SS.Util.RegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43114. Sets the leftBorderColor attribute of the RegionUtil object
  43115. @param color The color of the border
  43116. @param region The region that should have the border
  43117. @param workbook The workbook that the region is on.
  43118. @param sheet The sheet that the region is on.
  43119. </member>
  43120. <member name="M:NPOI.SS.Util.RegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43121. Sets the left border color for a region of cells by manipulating the cell style of the individual
  43122. cells on the left
  43123. @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
  43124. @param color The color of the border
  43125. @param region The region that should have the border
  43126. @param workbook The workbook that the region is on.
  43127. @param sheet The sheet that the region is on.
  43128. </member>
  43129. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderRight(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43130. Sets the borderRight attribute of the RegionUtil object
  43131. @param border The new border
  43132. @param region The region that should have the border
  43133. @param workbook The workbook that the region is on.
  43134. @param sheet The sheet that the region is on.
  43135. </member>
  43136. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderRight(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43137. Sets the right border for a region of cells by manipulating the cell style of the individual
  43138. cells on the right
  43139. @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
  43140. @param border The new border
  43141. @param region The region that should have the border
  43142. @param workbook The workbook that the region is on.
  43143. @param sheet The sheet that the region is on.
  43144. </member>
  43145. <member name="M:NPOI.SS.Util.RegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43146. Sets the rightBorderColor attribute of the RegionUtil object
  43147. @param color The color of the border
  43148. @param region The region that should have the border
  43149. @param workbook The workbook that the region is on.
  43150. @param sheet The sheet that the region is on.
  43151. </member>
  43152. <member name="M:NPOI.SS.Util.RegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43153. Sets the right border color for a region of cells by manipulating the cell style of the individual
  43154. cells on the right
  43155. @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
  43156. @param color The color of the border
  43157. @param region The region that should have the border
  43158. @param workbook The workbook that the region is on.
  43159. @param sheet The sheet that the region is on.
  43160. </member>
  43161. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderBottom(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43162. Sets the borderBottom attribute of the RegionUtil object
  43163. @param border The new border
  43164. @param region The region that should have the border
  43165. @param workbook The workbook that the region is on.
  43166. @param sheet The sheet that the region is on.
  43167. </member>
  43168. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderBottom(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43169. Sets the bottom border for a region of cells by manipulating the cell style of the individual
  43170. cells on the bottom
  43171. @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
  43172. @param border The new border
  43173. @param region The region that should have the border
  43174. @param workbook The workbook that the region is on.
  43175. @param sheet The sheet that the region is on.
  43176. </member>
  43177. <member name="M:NPOI.SS.Util.RegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43178. Sets the bottomBorderColor attribute of the RegionUtil object
  43179. @param color The color of the border
  43180. @param region The region that should have the border
  43181. @param workbook The workbook that the region is on.
  43182. @param sheet The sheet that the region is on.
  43183. </member>
  43184. <member name="M:NPOI.SS.Util.RegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43185. Sets the bottom border color for a region of cells by manipulating the cell style of the individual
  43186. cells on the bottom
  43187. @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
  43188. @param color The color of the border
  43189. @param region The region that should have the border
  43190. @param workbook The workbook that the region is on.
  43191. @param sheet The sheet that the region is on.
  43192. </member>
  43193. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderTop(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43194. Sets the borderBottom attribute of the RegionUtil object
  43195. @param border The new border
  43196. @param region The region that should have the border
  43197. @param workbook The workbook that the region is on.
  43198. @param sheet The sheet that the region is on.
  43199. </member>
  43200. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderTop(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43201. Sets the top border for a region of cells by manipulating the cell style of the individual
  43202. cells on the top
  43203. @see {@link BorderPropertyTemplate#drawBorders} for improved border functionality
  43204. @param border The new border
  43205. @param region The region that should have the border
  43206. @param workbook The workbook that the region is on.
  43207. @param sheet The sheet that the region is on.
  43208. </member>
  43209. <member name="M:NPOI.SS.Util.RegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  43210. Sets the topBorderColor attribute of the RegionUtil object
  43211. @param color The color of the border
  43212. @param region The region that should have the border
  43213. @param workbook The workbook that the region is on.
  43214. @param sheet The sheet that the region is on.
  43215. </member>
  43216. <member name="M:NPOI.SS.Util.RegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet)">
  43217. Sets the top border color for a region of cells by manipulating the cell style of the individual
  43218. cells on the top
  43219. @see {@link BorderPropertyTemplate#drawBorderColors} for improved border functionality
  43220. @param color The color of the border
  43221. @param region The region that should have the border
  43222. @param workbook The workbook that the region is on.
  43223. @param sheet The sheet that the region is on.
  43224. </member>
  43225. <member name="T:NPOI.SS.Util.SheetBuilder">
  43226. Class {@code SheetBuilder} provides an easy way of building workbook sheets
  43227. from 2D array of Objects. It can be used in test cases to improve code
  43228. readability or in Swing applications with tables.
  43229. @author Roman Kashitsyn
  43230. </member>
  43231. <member name="M:NPOI.SS.Util.SheetBuilder.GetCreateEmptyCells">
  43232. Returns {@code true} if null array elements should be treated as empty
  43233. cells.
  43234. @return {@code true} if null objects should be treated as empty cells
  43235. and {@code false} otherwise
  43236. </member>
  43237. <member name="M:NPOI.SS.Util.SheetBuilder.SetCreateEmptyCells(System.Boolean)">
  43238. Specifies if null array elements should be treated as empty cells.
  43239. @param shouldCreateEmptyCells {@code true} if null array elements should be
  43240. treated as empty cells
  43241. @return {@code this}
  43242. </member>
  43243. <member name="M:NPOI.SS.Util.SheetBuilder.SetSheetName(System.String)">
  43244. Specifies name of the sheet to build. If not specified, default name (provided by
  43245. workbook) will be used instead.
  43246. @param sheetName sheet name to use
  43247. @return {@code this}
  43248. </member>
  43249. <member name="M:NPOI.SS.Util.SheetBuilder.Build">
  43250. Builds sheet from parent workbook and 2D array with cell
  43251. values. Creates rows anyway (even if row contains only null
  43252. cells), creates cells if either corresponding array value is not
  43253. null or createEmptyCells property is true.
  43254. The conversion is performed in the following way:
  43255. <p/>
  43256. <ul>
  43257. <li>Numbers become numeric cells.</li>
  43258. <li><code>java.util.Date</code> or <code>java.util.Calendar</code>
  43259. instances become date cells.</li>
  43260. <li>String with leading '=' char become formulas (leading '='
  43261. will be truncated).</li>
  43262. <li>Other objects become strings via <code>Object.toString()</code>
  43263. method call.</li>
  43264. </ul>
  43265. @return newly created sheet
  43266. </member>
  43267. <member name="M:NPOI.SS.Util.SheetBuilder.SetCellValue(NPOI.SS.UserModel.ICell,System.Object)">
  43268. Sets the cell value using object type information.
  43269. @param cell cell to change
  43270. @param value value to set
  43271. </member>
  43272. <member name="T:NPOI.SS.Util.SheetReferences">
  43273. Holds a collection of Sheet names and their associated
  43274. reference numbers.
  43275. @author Andrew C. Oliver (acoliver at apache dot org)
  43276. </member>
  43277. <member name="T:NPOI.SS.Util.SheetUtil">
  43278. Helper methods for when working with Usermodel sheets
  43279. @author Yegor Kozlov
  43280. </member>
  43281. <member name="F:NPOI.SS.Util.SheetUtil.dummyEvaluator">
  43282. Dummy formula Evaluator that does nothing.
  43283. YK: The only reason of having this class is that
  43284. {@link NPOI.SS.UserModel.DataFormatter#formatCellValue(NPOI.SS.UserModel.Cell)}
  43285. returns formula string for formula cells. Dummy Evaluator Makes it to format the cached formula result.
  43286. See Bugzilla #50021
  43287. </member>
  43288. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWidth(NPOI.SS.UserModel.ICell,System.Int32,NPOI.SS.UserModel.DataFormatter,System.Boolean)">
  43289. Compute width of a single cell
  43290. @param cell the cell whose width is to be calculated
  43291. @param defaultCharWidth the width of a single character
  43292. @param formatter formatter used to prepare the text to be measured
  43293. @param useMergedCells whether to use merged cells
  43294. @return the width in pixels or -1 if cell is empty
  43295. </member>
  43296. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean)">
  43297. Compute width of a column and return the result
  43298. @param sheet the sheet to calculate
  43299. @param column 0-based index of the column
  43300. @param useMergedCells whether to use merged cells
  43301. @return the width in pixels or -1 if all cells are empty
  43302. </member>
  43303. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean,System.Int32,System.Int32)">
  43304. Compute width of a column based on a subset of the rows and return the result
  43305. @param sheet the sheet to calculate
  43306. @param column 0-based index of the column
  43307. @param useMergedCells whether to use merged cells
  43308. @param firstRow 0-based index of the first row to consider (inclusive)
  43309. @param lastRow 0-based index of the last row to consider (inclusive)
  43310. @return the width in pixels or -1 if cell is empty
  43311. </member>
  43312. <member name="M:NPOI.SS.Util.SheetUtil.GetDefaultCharWidth(NPOI.SS.UserModel.IWorkbook)">
  43313. Get default character width
  43314. @param wb the workbook to get the default character width from
  43315. @return default character width
  43316. </member>
  43317. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidthForRow(NPOI.SS.UserModel.IRow,System.Int32,System.Int32,NPOI.SS.UserModel.DataFormatter,System.Boolean)">
  43318. Compute width of a single cell in a row
  43319. Convenience method for {@link getCellWidth}
  43320. @param row the row that contains the cell of interest
  43321. @param column the column number of the cell whose width is to be calculated
  43322. @param defaultCharWidth the width of a single character
  43323. @param formatter formatter used to prepare the text to be measured
  43324. @param useMergedCells whether to use merged cells
  43325. @return the width in pixels or -1 if cell is empty
  43326. </member>
  43327. <member name="M:NPOI.SS.Util.SheetUtil.CanComputeColumnWidth(NPOI.SS.UserModel.IFont)">
  43328. Check if the Fonts are installed correctly so that Java can compute the size of
  43329. columns.
  43330. If a Cell uses a Font which is not available on the operating system then Java may
  43331. fail to return useful Font metrics and thus lead to an auto-computed size of 0.
  43332. This method allows to check if computing the sizes for a given Font will succeed or not.
  43333. @param font The Font that is used in the Cell
  43334. @return true if computing the size for this Font will succeed, false otherwise
  43335. </member>
  43336. <member name="M:NPOI.SS.Util.SheetUtil.IFont2Font(NPOI.SS.UserModel.IFont)">
  43337. <summary>
  43338. Convert HSSFFont to Font.
  43339. </summary>
  43340. <param name="font1">The font.</param>
  43341. <returns></returns>
  43342. </member>
  43343. <member name="M:NPOI.SS.Util.SheetUtil.ContainsCell(NPOI.SS.Util.CellRangeAddress,System.Int32,System.Int32)">
  43344. <summary>
  43345. Check if the cell is in the specified cell range
  43346. </summary>
  43347. <param name="cr">the cell range to check in</param>
  43348. <param name="rowIx">the row to check</param>
  43349. <param name="colIx">the column to check</param>
  43350. <returns>return true if the range contains the cell [rowIx, colIx]</returns>
  43351. </member>
  43352. <member name="M:NPOI.SS.Util.SheetUtil.GetUniqueSheetName(NPOI.SS.UserModel.IWorkbook,System.String)">
  43353. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  43354. @param srcName the original sheet name to
  43355. @return clone sheet name
  43356. </member>
  43357. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWithMerges(NPOI.SS.UserModel.ISheet,System.Int32,System.Int32)">
  43358. Return the cell, taking account of merged regions. Allows you to find the
  43359. cell who's contents are Shown in a given position in the sheet.
  43360. <p>If the cell at the given co-ordinates is a merged cell, this will
  43361. return the primary (top-left) most cell of the merged region.</p>
  43362. <p>If the cell at the given co-ordinates is not in a merged region,
  43363. then will return the cell itself.</p>
  43364. <p>If there is no cell defined at the given co-ordinates, will return
  43365. null.</p>
  43366. </member>
  43367. <member name="T:NPOI.SS.Util.SSCellRange`1">
  43368. For POI internal use only
  43369. @author Josh Micich
  43370. </member>
  43371. <member name="T:NPOI.SS.Util.WorkbookUtil">
  43372. Helper methods for when working with Usermodel Workbooks
  43373. </member>
  43374. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String)">
  43375. Creates a valid sheet name, which is conform to the rules.
  43376. In any case, the result safely can be used for
  43377. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  43378. <br/>
  43379. Rules:
  43380. <ul>
  43381. <li>never null</li>
  43382. <li>minimum length is 1</li>
  43383. <li>maximum length is 31</li>
  43384. <li>doesn't contain special chars: 0x0000, 0x0003, / \ ? * ] [ </li>
  43385. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  43386. </ul>
  43387. Invalid characters are replaced by one space character ' '.
  43388. @param nameProposal can be any string, will be truncated if necessary,
  43389. allowed to be null
  43390. @return a valid string, "empty" if to short, "null" if null
  43391. </member>
  43392. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String,System.Char)">
  43393. Creates a valid sheet name, which is conform to the rules.
  43394. In any case, the result safely can be used for
  43395. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  43396. <br />
  43397. Rules:
  43398. <ul>
  43399. <li>never null</li>
  43400. <li>minimum length is 1</li>
  43401. <li>maximum length is 31</li>
  43402. <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
  43403. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  43404. </ul>
  43405. @param nameProposal can be any string, will be truncated if necessary,
  43406. allowed to be null
  43407. @param replaceChar the char to replace invalid characters.
  43408. @return a valid string, "empty" if to short, "null" if null
  43409. </member>
  43410. <member name="M:NPOI.SS.Util.WorkbookUtil.ValidateSheetName(System.String)">
  43411. Validates sheet name.
  43412. <p>
  43413. The character count <c>MUST</c> be greater than or equal to 1 and less than or equal to 31.
  43414. The string MUST NOT contain the any of the following characters:
  43415. <ul>
  43416. <li> 0x0000 </li>
  43417. <li> 0x0003 </li>
  43418. <li> colon (:) </li>
  43419. <li> backslash (\) </li>
  43420. <li> asterisk (*) </li>
  43421. <li> question mark (?) </li>
  43422. <li> forward slash (/) </li>
  43423. <li> opening square bracket ([) </li>
  43424. <li> closing square bracket (]) </li>
  43425. </ul>
  43426. The string MUST NOT begin or end with the single quote (') character.
  43427. </p>
  43428. @param sheetName the name to validate
  43429. </member>
  43430. <member name="T:NPOI.SS.Extractor.IExcelExtractor">
  43431. Common interface for Excel text extractors, covering
  43432. HSSF and XSSF
  43433. </member>
  43434. <member name="P:NPOI.SS.Extractor.IExcelExtractor.Text">
  43435. Retreives the text contents of the file
  43436. </member>
  43437. <member name="T:NPOI.SS.SpreadsheetVersion">
  43438. This enum allows spReadsheets from multiple Excel versions to be handled by the common code.
  43439. Properties of this enum correspond to attributes of the <i>spReadsheet</i> that are easily
  43440. discernable to the user. It is not intended to deal with low-level issues like file formats.
  43441. <p/>
  43442. @author Josh Micich
  43443. @author Yegor Kozlov
  43444. </member>
  43445. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL97">
  43446. Excel97 format aka BIFF8
  43447. <ul>
  43448. <li>The total number of available columns is 256 (2^8)</li>
  43449. <li>The total number of available rows is 64k (2^16)</li>
  43450. <li>The maximum number of arguments to a function is 30</li>
  43451. <li>Number of conditional format conditions on a cell is 3</li>
  43452. <li>Length of text cell contents is unlimited </li>
  43453. <li>Length of text cell contents is 32767</li>
  43454. </ul>
  43455. </member>
  43456. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL2007">
  43457. Excel2007
  43458. <ul>
  43459. <li>The total number of available columns is 16K (2^14)</li>
  43460. <li>The total number of available rows is 1M (2^20)</li>
  43461. <li>The maximum number of arguments to a function is 255</li>
  43462. <li>Number of conditional format conditions on a cell is unlimited
  43463. (actually limited by available memory in Excel)</li>
  43464. <li>Length of text cell contents is unlimited </li>
  43465. </ul>
  43466. </member>
  43467. <member name="P:NPOI.SS.SpreadsheetVersion.DefaultExtension">
  43468. @return the default file extension of spReadsheet
  43469. </member>
  43470. <member name="P:NPOI.SS.SpreadsheetVersion.MaxRows">
  43471. @return the maximum number of usable rows in each spReadsheet
  43472. </member>
  43473. <member name="P:NPOI.SS.SpreadsheetVersion.LastRowIndex">
  43474. @return the last (maximum) valid row index, equals to <code> GetMaxRows() - 1 </code>
  43475. </member>
  43476. <member name="P:NPOI.SS.SpreadsheetVersion.MaxColumns">
  43477. @return the maximum number of usable columns in each spReadsheet
  43478. </member>
  43479. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnIndex">
  43480. @return the last (maximum) valid column index, equals to <code> GetMaxColumns() - 1 </code>
  43481. </member>
  43482. <member name="P:NPOI.SS.SpreadsheetVersion.MaxFunctionArgs">
  43483. @return the maximum number arguments that can be passed to a multi-arg function (e.g. COUNTIF)
  43484. </member>
  43485. <member name="P:NPOI.SS.SpreadsheetVersion.MaxConditionalFormats">
  43486. @return the maximum number of conditional format conditions on a cell
  43487. </member>
  43488. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnName">
  43489. @return the last valid column index in a ALPHA-26 representation
  43490. (<code>IV</code> or <code>XFD</code>).
  43491. </member>
  43492. <member name="P:NPOI.SS.SpreadsheetVersion.MaxCellStyles">
  43493. @return the maximum number of cell styles per spreadsheet
  43494. </member>
  43495. <member name="P:NPOI.SS.SpreadsheetVersion.MaxTextLength">
  43496. @return the maximum length of a text cell
  43497. </member>
  43498. <member name="T:NPOI.POIDocument">
  43499. <summary>
  43500. This holds the common functionality for all POI
  43501. Document classes.
  43502. Currently, this relates to Document Information Properties
  43503. </summary>
  43504. <remarks>@author Nick Burch</remarks>
  43505. </member>
  43506. <member name="F:NPOI.POIDocument.sInf">
  43507. Holds metadata on our document
  43508. </member>
  43509. <member name="F:NPOI.POIDocument.dsInf">
  43510. Holds further metadata on our document
  43511. </member>
  43512. <member name="F:NPOI.POIDocument.directory">
  43513. The directory that our document lives in
  43514. </member>
  43515. <member name="M:NPOI.POIDocument.SetDirectoryNode(NPOI.POIFS.FileSystem.DirectoryNode)">
  43516. <summary>
  43517. just for test case TestPOIDocumentMain.TestWriteReadProperties
  43518. </summary>
  43519. </member>
  43520. <member name="F:NPOI.POIDocument.initialized">
  43521. For our own logging use
  43522. </member>
  43523. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.OPOIFSFileSystem)">
  43524. Constructs from an old-style OPOIFS
  43525. </member>
  43526. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  43527. <summary>
  43528. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  43529. </summary>
  43530. <param name="fs">The fs.</param>
  43531. </member>
  43532. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  43533. Constructs from the default POIFS
  43534. </member>
  43535. <member name="M:NPOI.POIDocument.CreateInformationProperties">
  43536. Will create whichever of SummaryInformation
  43537. and DocumentSummaryInformation (HPSF) properties
  43538. are not already part of your document.
  43539. This is normally useful when creating a new
  43540. document from scratch.
  43541. If the information properties are already there,
  43542. then nothing will happen.
  43543. </member>
  43544. <member name="P:NPOI.POIDocument.DocumentSummaryInformation">
  43545. <summary>
  43546. Fetch the Document Summary Information of the document
  43547. </summary>
  43548. <value>The document summary information.</value>
  43549. </member>
  43550. <member name="P:NPOI.POIDocument.SummaryInformation">
  43551. <summary>
  43552. Fetch the Summary Information of the document
  43553. </summary>
  43554. <value>The summary information.</value>
  43555. </member>
  43556. <member name="M:NPOI.POIDocument.ReadProperties">
  43557. <summary>
  43558. Find, and Create objects for, the standard
  43559. Documment Information Properties (HPSF).
  43560. If a given property Set is missing or corrupt,
  43561. it will remain null;
  43562. </summary>
  43563. </member>
  43564. <member name="M:NPOI.POIDocument.GetPropertySet(System.String)">
  43565. <summary>
  43566. For a given named property entry, either return it or null if
  43567. if it wasn't found
  43568. </summary>
  43569. <param name="setName">The property to read</param>
  43570. <returns>The value of the given property or null if it wasn't found.</returns>
  43571. <exception cref="T:System.IO.IOException">If retrieving properties fails</exception>
  43572. </member>
  43573. <member name="M:NPOI.POIDocument.GetPropertySet(System.String,NPOI.POIFS.Crypt.EncryptionInfo)">
  43574. <summary>
  43575. For a given named property entry, either return it or null if
  43576. if it wasn't found
  43577. </summary>
  43578. <param name="setName">The property to read</param>
  43579. <param name="encryptionInfo">the encryption descriptor in case of cryptoAPI encryption</param>
  43580. <returns>The value of the given property or null if it wasn't found.</returns>
  43581. <exception cref="T:System.IO.IOException">If retrieving properties fails</exception>
  43582. </member>
  43583. <member name="M:NPOI.POIDocument.WriteProperties">
  43584. Writes out the updated standard Document Information Properties (HPSF)
  43585. into the currently open NPOIFSFileSystem
  43586. TODO Implement in-place update
  43587. @throws IOException if an error when writing to the open
  43588. {@link NPOIFSFileSystem} occurs
  43589. TODO throws exception if open from stream not file
  43590. </member>
  43591. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  43592. <summary>
  43593. Writes out the standard Documment Information Properties (HPSF)
  43594. </summary>
  43595. <param name="outFS">the POIFSFileSystem to Write the properties into</param>
  43596. </member>
  43597. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.Collections.IList)">
  43598. <summary>
  43599. Writes out the standard Documment Information Properties (HPSF)
  43600. </summary>
  43601. <param name="outFS">the POIFSFileSystem to Write the properties into.</param>
  43602. <param name="writtenEntries">a list of POIFS entries to Add the property names too.</param>
  43603. </member>
  43604. <member name="M:NPOI.POIDocument.WritePropertySet(System.String,NPOI.HPSF.PropertySet,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  43605. <summary>
  43606. Writes out a given ProperySet
  43607. </summary>
  43608. <param name="name">the (POIFS Level) name of the property to Write.</param>
  43609. <param name="Set">the PropertySet to Write out.</param>
  43610. <param name="outFS">the POIFSFileSystem to Write the property into.</param>
  43611. </member>
  43612. <member name="M:NPOI.POIDocument.ValidateInPlaceWritePossible">
  43613. Called during a {@link #write()} to ensure that the Document (and
  43614. associated {@link POIFSFileSystem}) was opened in a way compatible
  43615. with an in-place write.
  43616. @ if the document was opened suitably
  43617. </member>
  43618. <!-- Badly formed XML comment ignored for member "M:NPOI.POIDocument.Write" -->
  43619. <member name="M:NPOI.POIDocument.Write(System.IO.FileInfo)">
  43620. Writes the document out to the specified new {@link File}. If the file
  43621. exists, it will be replaced, otherwise a new one will be created
  43622. @param newFile The new File to write to.
  43623. @ thrown on errors writing to the file
  43624. </member>
  43625. <member name="M:NPOI.POIDocument.Write(System.IO.Stream)">
  43626. Writes the document out to the specified output stream. The
  43627. stream is not closed as part of this operation.
  43628. Note - if the Document was opened from a {@link File} rather
  43629. than an {@link InputStream}, you <b>must</b> write out using
  43630. {@link #write()} or to a different File. Overwriting the currently
  43631. open file via an OutputStream isn't possible.
  43632. If {@code stream} is a {@link java.io.FileOutputStream} on a networked drive
  43633. or has a high cost/latency associated with each written byte,
  43634. consider wrapping the OutputStream in a {@link java.io.BufferedOutputStream}
  43635. to improve write performance, or use {@link #write()} / {@link #write(File)}
  43636. if possible.
  43637. @param out The stream to write to.
  43638. @ thrown on errors writing to the stream
  43639. </member>
  43640. <member name="M:NPOI.POIDocument.Close">
  43641. Closes the underlying {@link NPOIFSFileSystem} from which
  43642. the document was read, if any. Has no effect on documents
  43643. opened from an InputStream, or newly created ones.
  43644. Once {@link #close()} has been called, no further operations
  43645. should be called on the document.
  43646. </member>
  43647. <member name="T:NPOI.UnsupportedFileFormatException">
  43648. Base class of all the exceptions that POI throws in the event
  43649. that it's given a file that isn't supported
  43650. </member>
  43651. <member name="T:NPOI.POIOLE2TextExtractor">
  43652. <summary>
  43653. Common Parent for OLE2 based Text Extractors
  43654. of POI Documents, such as .doc, .xls
  43655. You will typically find the implementation of
  43656. a given format's text extractor under NPOI.Format.Extractor
  43657. </summary>
  43658. <remarks>
  43659. @see org.apache.poi.hssf.extractor.ExcelExtractor
  43660. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  43661. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  43662. @see org.apache.poi.hwpf.extractor.WordExtractor
  43663. </remarks>
  43664. </member>
  43665. <member name="F:NPOI.POIOLE2TextExtractor.document">
  43666. The POIDocument that's open
  43667. </member>
  43668. <member name="M:NPOI.POIOLE2TextExtractor.#ctor(NPOI.POIDocument)">
  43669. <summary>
  43670. Creates a new text extractor for the given document
  43671. </summary>
  43672. <param name="document"></param>
  43673. </member>
  43674. <member name="M:NPOI.POIOLE2TextExtractor.#ctor(NPOI.POIOLE2TextExtractor)">
  43675. <summary>
  43676. Creates a new text extractor, using the same document as another
  43677. text extractor. Normally only used by properties extractors.
  43678. </summary>
  43679. <param name="otherExtractor"></param>
  43680. </member>
  43681. <member name="P:NPOI.POIOLE2TextExtractor.DocSummaryInformation">
  43682. <summary>
  43683. Returns the document information metadata for the document
  43684. </summary>
  43685. <value>The doc summary information.</value>
  43686. </member>
  43687. <member name="P:NPOI.POIOLE2TextExtractor.SummaryInformation">
  43688. <summary>
  43689. Returns the summary information metadata for the document
  43690. </summary>
  43691. <value>The summary information.</value>
  43692. </member>
  43693. <member name="P:NPOI.POIOLE2TextExtractor.MetadataTextExtractor">
  43694. <summary>
  43695. Returns an HPSF powered text extractor for the
  43696. document properties metadata, such as title and author.
  43697. </summary>
  43698. <value></value>
  43699. </member>
  43700. <member name="P:NPOI.POIOLE2TextExtractor.Root">
  43701. Return the underlying DirectoryEntry of this document.
  43702. @return the DirectoryEntry that is associated with the POIDocument of this extractor.
  43703. </member>
  43704. <member name="T:NPOI.POITextExtractor">
  43705. <summary>
  43706. Common Parent for Text Extractors
  43707. of POI Documents.
  43708. You will typically find the implementation of
  43709. a given format's text extractor under
  43710. org.apache.poi.[format].extractor .
  43711. </summary>
  43712. @see org.apache.poi.hssf.extractor.ExcelExtractor
  43713. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  43714. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  43715. @see org.apache.poi.hwpf.extractor.WordExtractor
  43716. </member>
  43717. <member name="P:NPOI.POITextExtractor.Text">
  43718. <summary>
  43719. Retrieves all the text from the document.
  43720. How cells, paragraphs etc are separated in the text
  43721. is implementation specific - see the javadocs for
  43722. a specific project for details.
  43723. </summary>
  43724. <value>All the text from the document.</value>
  43725. </member>
  43726. <member name="P:NPOI.POITextExtractor.MetadataTextExtractor">
  43727. <summary>
  43728. Returns another text extractor, which is able to
  43729. output the textual content of the document
  43730. metadata / properties, such as author and title.
  43731. </summary>
  43732. <value>The metadata text extractor.</value>
  43733. </member>
  43734. <member name="M:NPOI.POITextExtractor.SetFilesystem(NPOI.Util.ICloseable)">
  43735. Used to ensure file handle cleanup.
  43736. @param fs filesystem to close
  43737. </member>
  43738. <member name="T:NPOI.WP.UserModel.ICharacterRun">
  43739. This class represents a run of text that share common properties.
  43740. </member>
  43741. <member name="P:NPOI.WP.UserModel.ICharacterRun.FontName">
  43742. <summary>
  43743. Gets the fonts which shall be used to display the text contents of
  43744. this run. Specifies a font which shall be used to format all "normal"
  43745. characters in the run
  43746. </summary>
  43747. </member>
  43748. <member name="P:NPOI.WP.UserModel.ICharacterRun.Text">
  43749. @return The text of the Run, including any tabs/spaces/etc
  43750. </member>
  43751. <member name="T:NPOI.WP.UserModel.IParagraph">
  43752. This class represents a paragraph, made up of one or more
  43753. Runs of text.
  43754. </member>
  43755. <member name="F:RangeType.NUMBER">
  43756. Number / Parameter
  43757. </member>
  43758. <member name="F:RangeType.MIN">
  43759. The minimum value from the range
  43760. </member>
  43761. <member name="F:RangeType.MAX">
  43762. The maximum value from the range
  43763. </member>
  43764. <member name="F:RangeType.PERCENT">
  43765. Percent of the way from the mi to the max value in the range
  43766. </member>
  43767. <member name="F:RangeType.PERCENTILE">
  43768. The minimum value of the cell that is in X percentile of the range
  43769. </member>
  43770. <member name="F:RangeType.FORMULA">
  43771. Formula result
  43772. </member>
  43773. <member name="F:RangeType.id">
  43774. Numeric ID of the type
  43775. </member>
  43776. <member name="F:RangeType.name">
  43777. Name (system) of the type
  43778. </member>
  43779. </members>
  43780. </doc>