NPOI.xml 2.1 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322373233732437325373263732737328373293733037331373323733337334373353733637337373383733937340373413734237343373443734537346373473734837349373503735137352373533735437355373563735737358373593736037361373623736337364373653736637367373683736937370373713737237373373743737537376373773737837379373803738137382373833738437385373863738737388373893739037391373923739337394373953739637397373983739937400374013740237403374043740537406374073740837409374103741137412374133741437415374163741737418374193742037421374223742337424374253742637427374283742937430374313743237433374343743537436374373743837439374403744137442374433744437445374463744737448374493745037451374523745337454374553745637457374583745937460374613746237463374643746537466374673746837469374703747137472374733747437475374763747737478374793748037481374823748337484374853748637487374883748937490374913749237493374943749537496374973749837499375003750137502375033750437505375063750737508375093751037511375123751337514375153751637517375183751937520375213752237523375243752537526375273752837529375303753137532375333753437535375363753737538375393754037541375423754337544375453754637547375483754937550375513755237553375543755537556375573755837559375603756137562375633756437565375663756737568375693757037571375723757337574375753757637577375783757937580375813758237583375843758537586375873758837589375903759137592375933759437595375963759737598375993760037601376023760337604376053760637607376083760937610376113761237613376143761537616376173761837619376203762137622376233762437625376263762737628376293763037631376323763337634376353763637637376383763937640376413764237643376443764537646376473764837649376503765137652376533765437655376563765737658376593766037661376623766337664376653766637667376683766937670376713767237673376743767537676376773767837679376803768137682376833768437685376863768737688376893769037691376923769337694376953769637697376983769937700377013770237703377043770537706377073770837709377103771137712377133771437715377163771737718377193772037721377223772337724377253772637727377283772937730377313773237733377343773537736377373773837739377403774137742377433774437745377463774737748377493775037751377523775337754377553775637757377583775937760377613776237763377643776537766377673776837769377703777137772377733777437775377763777737778377793778037781377823778337784377853778637787377883778937790377913779237793377943779537796377973779837799378003780137802378033780437805378063780737808378093781037811378123781337814378153781637817378183781937820378213782237823378243782537826378273782837829378303783137832378333783437835378363783737838378393784037841378423784337844378453784637847378483784937850378513785237853378543785537856378573785837859378603786137862378633786437865378663786737868378693787037871378723787337874378753787637877378783787937880378813788237883378843788537886378873788837889378903789137892378933789437895378963789737898378993790037901379023790337904379053790637907379083790937910379113791237913379143791537916379173791837919379203792137922379233792437925379263792737928379293793037931379323793337934379353793637937379383793937940379413794237943379443794537946379473794837949379503795137952379533795437955379563795737958379593796037961379623796337964379653796637967379683796937970379713797237973379743797537976379773797837979379803798137982379833798437985379863798737988379893799037991379923799337994379953799637997379983799938000380013800238003380043800538006380073800838009380103801138012380133801438015380163801738018380193802038021380223802338024380253802638027380283802938030380313803238033380343803538036380373803838039380403804138042380433804438045380463804738048380493805038051380523805338054380553805638057380583805938060380613806238063380643806538066380673806838069380703807138072380733807438075380763807738078380793808038081380823808338084380853808638087380883808938090380913809238093380943809538096380973809838099381003810138102381033810438105381063810738108381093811038111381123811338114381153811638117381183811938120381213812238123381243812538126381273812838129381303813138132381333813438135381363813738138381393814038141381423814338144381453814638147381483814938150381513815238153381543815538156381573815838159381603816138162381633816438165381663816738168381693817038171381723817338174381753817638177381783817938180381813818238183381843818538186381873818838189381903819138192381933819438195381963819738198381993820038201382023820338204382053820638207382083820938210382113821238213382143821538216382173821838219382203822138222382233822438225382263822738228382293823038231382323823338234382353823638237382383823938240382413824238243382443824538246382473824838249382503825138252382533825438255382563825738258382593826038261382623826338264382653826638267382683826938270382713827238273382743827538276382773827838279382803828138282382833828438285382863828738288382893829038291382923829338294382953829638297382983829938300383013830238303383043830538306383073830838309383103831138312383133831438315383163831738318383193832038321383223832338324383253832638327383283832938330383313833238333383343833538336383373833838339383403834138342383433834438345383463834738348383493835038351383523835338354383553835638357383583835938360383613836238363383643836538366383673836838369383703837138372383733837438375383763837738378383793838038381383823838338384383853838638387383883838938390383913839238393383943839538396383973839838399384003840138402384033840438405384063840738408384093841038411384123841338414384153841638417384183841938420384213842238423384243842538426384273842838429384303843138432384333843438435384363843738438384393844038441384423844338444384453844638447384483844938450384513845238453384543845538456384573845838459384603846138462384633846438465384663846738468384693847038471384723847338474384753847638477384783847938480384813848238483384843848538486384873848838489384903849138492384933849438495384963849738498384993850038501385023850338504385053850638507385083850938510385113851238513385143851538516385173851838519385203852138522385233852438525385263852738528385293853038531385323853338534385353853638537385383853938540385413854238543385443854538546385473854838549385503855138552385533855438555385563855738558385593856038561385623856338564385653856638567385683856938570385713857238573385743857538576385773857838579385803858138582385833858438585385863858738588385893859038591385923859338594385953859638597385983859938600386013860238603386043860538606386073860838609386103861138612386133861438615386163861738618386193862038621386223862338624386253862638627386283862938630386313863238633386343863538636386373863838639386403864138642386433864438645386463864738648386493865038651386523865338654386553865638657386583865938660386613866238663386643866538666386673866838669386703867138672386733867438675386763867738678386793868038681386823868338684386853868638687386883868938690386913869238693386943869538696386973869838699387003870138702387033870438705387063870738708387093871038711387123871338714387153871638717387183871938720387213872238723387243872538726387273872838729387303873138732387333873438735387363873738738387393874038741387423874338744387453874638747387483874938750387513875238753387543875538756387573875838759387603876138762387633876438765387663876738768387693877038771387723877338774387753877638777387783877938780387813878238783387843878538786387873878838789387903879138792387933879438795387963879738798387993880038801388023880338804388053880638807388083880938810388113881238813388143881538816388173881838819388203882138822388233882438825388263882738828388293883038831388323883338834388353883638837388383883938840388413884238843388443884538846388473884838849388503885138852388533885438855388563885738858388593886038861388623886338864388653886638867388683886938870388713887238873388743887538876388773887838879388803888138882388833888438885388863888738888388893889038891388923889338894388953889638897388983889938900389013890238903389043890538906389073890838909389103891138912389133891438915389163891738918389193892038921389223892338924389253892638927389283892938930389313893238933389343893538936389373893838939389403894138942389433894438945389463894738948389493895038951389523895338954389553895638957389583895938960389613896238963389643896538966389673896838969389703897138972389733897438975389763897738978389793898038981389823898338984389853898638987389883898938990389913899238993389943899538996389973899838999390003900139002390033900439005390063900739008390093901039011390123901339014390153901639017390183901939020390213902239023390243902539026390273902839029390303903139032390333903439035390363903739038390393904039041390423904339044390453904639047390483904939050390513905239053390543905539056390573905839059390603906139062390633906439065390663906739068390693907039071390723907339074390753907639077390783907939080390813908239083390843908539086390873908839089390903909139092390933909439095390963909739098390993910039101391023910339104391053910639107391083910939110391113911239113391143911539116391173911839119391203912139122391233912439125391263912739128391293913039131391323913339134391353913639137391383913939140391413914239143391443914539146391473914839149391503915139152391533915439155391563915739158391593916039161391623916339164391653916639167391683916939170391713917239173391743917539176391773917839179391803918139182391833918439185391863918739188391893919039191391923919339194391953919639197391983919939200392013920239203392043920539206392073920839209392103921139212392133921439215392163921739218392193922039221392223922339224392253922639227392283922939230392313923239233392343923539236392373923839239392403924139242392433924439245392463924739248392493925039251392523925339254392553925639257392583925939260392613926239263392643926539266392673926839269392703927139272392733927439275392763927739278392793928039281392823928339284392853928639287392883928939290392913929239293392943929539296392973929839299393003930139302393033930439305393063930739308393093931039311393123931339314393153931639317393183931939320393213932239323393243932539326393273932839329393303933139332393333933439335393363933739338393393934039341393423934339344393453934639347393483934939350393513935239353393543935539356393573935839359393603936139362393633936439365393663936739368393693937039371393723937339374393753937639377393783937939380393813938239383393843938539386393873938839389393903939139392393933939439395393963939739398393993940039401394023940339404394053940639407394083940939410394113941239413394143941539416394173941839419394203942139422394233942439425394263942739428394293943039431394323943339434394353943639437394383943939440394413944239443394443944539446394473944839449394503945139452394533945439455394563945739458394593946039461394623946339464394653946639467394683946939470394713947239473394743947539476394773947839479394803948139482394833948439485394863948739488394893949039491394923949339494394953949639497394983949939500395013950239503395043950539506395073950839509395103951139512395133951439515395163951739518395193952039521395223952339524395253952639527395283952939530395313953239533395343953539536395373953839539395403954139542395433954439545395463954739548395493955039551395523955339554395553955639557395583955939560395613956239563395643956539566395673956839569395703957139572395733957439575395763957739578395793958039581395823958339584395853958639587395883958939590395913959239593395943959539596395973959839599396003960139602396033960439605396063960739608396093961039611396123961339614396153961639617396183961939620396213962239623396243962539626396273962839629396303963139632396333963439635396363963739638396393964039641396423964339644396453964639647396483964939650396513965239653396543965539656396573965839659396603966139662396633966439665396663966739668396693967039671396723967339674396753967639677396783967939680396813968239683396843968539686396873968839689396903969139692396933969439695396963969739698396993970039701397023970339704397053970639707397083970939710397113971239713397143971539716397173971839719397203972139722397233972439725397263972739728397293973039731397323973339734397353973639737397383973939740397413974239743397443974539746397473974839749397503975139752397533975439755397563975739758397593976039761397623976339764397653976639767397683976939770397713977239773397743977539776397773977839779397803978139782397833978439785397863978739788397893979039791397923979339794397953979639797397983979939800398013980239803398043980539806398073980839809398103981139812398133981439815398163981739818398193982039821398223982339824398253982639827398283982939830398313983239833398343983539836398373983839839398403984139842398433984439845398463984739848398493985039851398523985339854398553985639857398583985939860398613986239863398643986539866398673986839869398703987139872398733987439875398763987739878398793988039881398823988339884398853988639887398883988939890398913989239893398943989539896398973989839899399003990139902399033990439905399063990739908399093991039911399123991339914399153991639917399183991939920399213992239923399243992539926399273992839929399303993139932399333993439935399363993739938399393994039941399423994339944399453994639947399483994939950399513995239953399543995539956399573995839959399603996139962399633996439965399663996739968399693997039971399723997339974399753997639977399783997939980399813998239983399843998539986399873998839989399903999139992399933999439995399963999739998399994000040001400024000340004400054000640007400084000940010400114001240013400144001540016400174001840019400204002140022400234002440025400264002740028400294003040031400324003340034400354003640037400384003940040400414004240043400444004540046400474004840049400504005140052400534005440055400564005740058400594006040061400624006340064400654006640067400684006940070400714007240073400744007540076400774007840079400804008140082400834008440085400864008740088400894009040091400924009340094400954009640097400984009940100401014010240103401044010540106401074010840109401104011140112401134011440115401164011740118401194012040121401224012340124401254012640127401284012940130401314013240133401344013540136401374013840139401404014140142401434014440145401464014740148401494015040151401524015340154401554015640157401584015940160401614016240163401644016540166401674016840169401704017140172401734017440175401764017740178401794018040181401824018340184401854018640187401884018940190401914019240193401944019540196401974019840199402004020140202402034020440205402064020740208402094021040211402124021340214402154021640217402184021940220402214022240223402244022540226402274022840229402304023140232402334023440235402364023740238402394024040241402424024340244402454024640247402484024940250402514025240253402544025540256402574025840259402604026140262402634026440265402664026740268402694027040271402724027340274402754027640277402784027940280402814028240283402844028540286402874028840289402904029140292402934029440295402964029740298402994030040301403024030340304403054030640307403084030940310403114031240313403144031540316403174031840319403204032140322403234032440325403264032740328403294033040331403324033340334403354033640337403384033940340403414034240343403444034540346403474034840349403504035140352403534035440355403564035740358403594036040361403624036340364403654036640367403684036940370403714037240373403744037540376403774037840379403804038140382403834038440385403864038740388403894039040391403924039340394403954039640397403984039940400404014040240403404044040540406404074040840409404104041140412404134041440415404164041740418404194042040421404224042340424404254042640427404284042940430404314043240433404344043540436404374043840439404404044140442404434044440445404464044740448404494045040451404524045340454404554045640457404584045940460404614046240463404644046540466404674046840469404704047140472404734047440475404764047740478404794048040481404824048340484404854048640487404884048940490404914049240493404944049540496404974049840499405004050140502405034050440505405064050740508405094051040511405124051340514405154051640517405184051940520405214052240523405244052540526405274052840529405304053140532405334053440535405364053740538405394054040541405424054340544405454054640547405484054940550405514055240553405544055540556405574055840559405604056140562405634056440565405664056740568405694057040571405724057340574405754057640577405784057940580405814058240583405844058540586405874058840589405904059140592405934059440595405964059740598405994060040601406024060340604406054060640607406084060940610406114061240613406144061540616406174061840619406204062140622406234062440625406264062740628406294063040631406324063340634406354063640637406384063940640406414064240643406444064540646406474064840649406504065140652406534065440655406564065740658406594066040661406624066340664406654066640667406684066940670406714067240673406744067540676406774067840679406804068140682406834068440685406864068740688406894069040691406924069340694406954069640697406984069940700407014070240703407044070540706407074070840709407104071140712407134071440715407164071740718407194072040721407224072340724407254072640727407284072940730407314073240733407344073540736407374073840739407404074140742407434074440745407464074740748407494075040751407524075340754407554075640757407584075940760407614076240763407644076540766407674076840769407704077140772407734077440775407764077740778407794078040781407824078340784407854078640787407884078940790407914079240793407944079540796407974079840799408004080140802408034080440805408064080740808408094081040811408124081340814408154081640817408184081940820408214082240823408244082540826408274082840829408304083140832408334083440835408364083740838408394084040841408424084340844408454084640847408484084940850408514085240853408544085540856408574085840859408604086140862408634086440865408664086740868408694087040871408724087340874408754087640877408784087940880408814088240883408844088540886408874088840889408904089140892408934089440895408964089740898408994090040901409024090340904409054090640907409084090940910409114091240913409144091540916409174091840919409204092140922409234092440925409264092740928409294093040931409324093340934409354093640937409384093940940409414094240943409444094540946409474094840949409504095140952409534095440955409564095740958409594096040961409624096340964409654096640967409684096940970409714097240973409744097540976409774097840979409804098140982409834098440985409864098740988409894099040991409924099340994409954099640997409984099941000410014100241003410044100541006410074100841009410104101141012410134101441015410164101741018410194102041021410224102341024410254102641027410284102941030410314103241033410344103541036410374103841039410404104141042410434104441045410464104741048410494105041051410524105341054410554105641057410584105941060410614106241063410644106541066410674106841069410704107141072410734107441075410764107741078410794108041081410824108341084410854108641087410884108941090410914109241093410944109541096410974109841099411004110141102411034110441105411064110741108411094111041111411124111341114411154111641117411184111941120411214112241123411244112541126411274112841129411304113141132411334113441135411364113741138411394114041141411424114341144411454114641147411484114941150411514115241153411544115541156411574115841159411604116141162411634116441165411664116741168411694117041171411724117341174411754117641177411784117941180411814118241183411844118541186411874118841189411904119141192411934119441195411964119741198411994120041201412024120341204412054120641207412084120941210412114121241213412144121541216412174121841219412204122141222412234122441225412264122741228412294123041231412324123341234412354123641237412384123941240412414124241243412444124541246412474124841249412504125141252412534125441255412564125741258412594126041261412624126341264412654126641267412684126941270412714127241273412744127541276412774127841279412804128141282412834128441285412864128741288412894129041291412924129341294412954129641297412984129941300413014130241303413044130541306413074130841309413104131141312413134131441315413164131741318413194132041321413224132341324413254132641327413284132941330413314133241333413344133541336413374133841339413404134141342413434134441345413464134741348413494135041351413524135341354413554135641357413584135941360413614136241363413644136541366413674136841369413704137141372413734137441375413764137741378413794138041381413824138341384413854138641387413884138941390413914139241393413944139541396413974139841399414004140141402414034140441405414064140741408414094141041411414124141341414414154141641417414184141941420414214142241423414244142541426414274142841429414304143141432414334143441435414364143741438414394144041441414424144341444414454144641447414484144941450414514145241453414544145541456414574145841459414604146141462414634146441465414664146741468414694147041471414724147341474414754147641477414784147941480414814148241483414844148541486414874148841489414904149141492414934149441495414964149741498414994150041501415024150341504415054150641507415084150941510415114151241513415144151541516415174151841519415204152141522415234152441525415264152741528415294153041531415324153341534415354153641537415384153941540415414154241543415444154541546415474154841549415504155141552415534155441555415564155741558415594156041561415624156341564415654156641567415684156941570415714157241573415744157541576415774157841579415804158141582415834158441585415864158741588415894159041591415924159341594415954159641597415984159941600416014160241603416044160541606416074160841609416104161141612416134161441615416164161741618416194162041621416224162341624416254162641627416284162941630416314163241633416344163541636416374163841639416404164141642416434164441645416464164741648416494165041651416524165341654416554165641657416584165941660416614166241663416644166541666416674166841669416704167141672416734167441675416764167741678416794168041681416824168341684416854168641687416884168941690416914169241693416944169541696416974169841699417004170141702417034170441705417064170741708417094171041711417124171341714417154171641717417184171941720417214172241723417244172541726417274172841729417304173141732417334173441735417364173741738417394174041741417424174341744417454174641747417484174941750417514175241753417544175541756417574175841759417604176141762417634176441765417664176741768417694177041771417724177341774417754177641777417784177941780417814178241783417844178541786417874178841789417904179141792417934179441795417964179741798417994180041801418024180341804418054180641807418084180941810418114181241813418144181541816418174181841819418204182141822418234182441825418264182741828418294183041831418324183341834418354183641837418384183941840418414184241843418444184541846418474184841849418504185141852418534185441855418564185741858418594186041861418624186341864418654186641867418684186941870418714187241873418744187541876418774187841879418804188141882418834188441885418864188741888418894189041891418924189341894418954189641897418984189941900419014190241903419044190541906419074190841909419104191141912419134191441915419164191741918419194192041921419224192341924419254192641927419284192941930419314193241933419344193541936419374193841939419404194141942419434194441945419464194741948419494195041951419524195341954419554195641957419584195941960419614196241963419644196541966419674196841969419704197141972419734197441975419764197741978419794198041981419824198341984419854198641987419884198941990419914199241993419944199541996419974199841999420004200142002420034200442005420064200742008420094201042011420124201342014420154201642017420184201942020420214202242023420244202542026420274202842029420304203142032420334203442035420364203742038420394204042041420424204342044420454204642047420484204942050420514205242053420544205542056420574205842059420604206142062420634206442065420664206742068420694207042071420724207342074420754207642077420784207942080420814208242083420844208542086420874208842089420904209142092420934209442095420964209742098420994210042101421024210342104421054210642107421084210942110421114211242113421144211542116421174211842119421204212142122421234212442125421264212742128421294213042131421324213342134421354213642137421384213942140421414214242143421444214542146421474214842149421504215142152421534215442155421564215742158421594216042161421624216342164421654216642167421684216942170421714217242173421744217542176421774217842179421804218142182421834218442185421864218742188421894219042191421924219342194421954219642197421984219942200422014220242203422044220542206422074220842209422104221142212422134221442215422164221742218422194222042221422224222342224422254222642227422284222942230422314223242233422344223542236422374223842239422404224142242422434224442245422464224742248422494225042251422524225342254422554225642257422584225942260422614226242263422644226542266422674226842269422704227142272422734227442275422764227742278422794228042281422824228342284422854228642287422884228942290422914229242293422944229542296422974229842299423004230142302423034230442305423064230742308423094231042311423124231342314423154231642317423184231942320423214232242323423244232542326423274232842329423304233142332423334233442335423364233742338423394234042341423424234342344423454234642347423484234942350423514235242353423544235542356423574235842359423604236142362423634236442365423664236742368423694237042371423724237342374423754237642377423784237942380423814238242383423844238542386423874238842389423904239142392423934239442395423964239742398423994240042401424024240342404424054240642407424084240942410424114241242413424144241542416424174241842419424204242142422424234242442425424264242742428424294243042431424324243342434424354243642437424384243942440424414244242443424444244542446424474244842449424504245142452424534245442455424564245742458424594246042461424624246342464424654246642467424684246942470424714247242473424744247542476424774247842479424804248142482424834248442485424864248742488424894249042491424924249342494424954249642497424984249942500425014250242503425044250542506425074250842509425104251142512425134251442515425164251742518425194252042521425224252342524425254252642527425284252942530425314253242533425344253542536425374253842539425404254142542425434254442545425464254742548425494255042551425524255342554425554255642557425584255942560425614256242563425644256542566425674256842569425704257142572425734257442575425764257742578425794258042581425824258342584425854258642587425884258942590425914259242593425944259542596425974259842599426004260142602426034260442605426064260742608426094261042611426124261342614426154261642617426184261942620426214262242623426244262542626426274262842629426304263142632426334263442635426364263742638426394264042641426424264342644426454264642647426484264942650426514265242653426544265542656426574265842659426604266142662426634266442665426664266742668426694267042671426724267342674426754267642677426784267942680426814268242683426844268542686426874268842689426904269142692426934269442695426964269742698426994270042701427024270342704427054270642707427084270942710427114271242713427144271542716427174271842719427204272142722427234272442725427264272742728427294273042731427324273342734427354273642737427384273942740427414274242743427444274542746427474274842749427504275142752427534275442755427564275742758427594276042761427624276342764427654276642767427684276942770427714277242773427744277542776427774277842779427804278142782427834278442785427864278742788427894279042791427924279342794427954279642797427984279942800428014280242803428044280542806428074280842809428104281142812428134281442815428164281742818428194282042821428224282342824428254282642827428284282942830428314283242833428344283542836428374283842839428404284142842428434284442845428464284742848428494285042851428524285342854428554285642857428584285942860428614286242863428644286542866428674286842869428704287142872428734287442875428764287742878428794288042881428824288342884428854288642887428884288942890428914289242893428944289542896428974289842899429004290142902429034290442905429064290742908429094291042911429124291342914429154291642917429184291942920429214292242923429244292542926429274292842929429304293142932429334293442935429364293742938429394294042941429424294342944429454294642947429484294942950429514295242953429544295542956429574295842959429604296142962429634296442965429664296742968429694297042971429724297342974429754297642977429784297942980429814298242983429844298542986429874298842989429904299142992429934299442995429964299742998429994300043001430024300343004430054300643007430084300943010430114301243013430144301543016430174301843019430204302143022430234302443025430264302743028430294303043031430324303343034430354303643037430384303943040430414304243043430444304543046430474304843049430504305143052430534305443055430564305743058430594306043061430624306343064430654306643067430684306943070430714307243073430744307543076430774307843079430804308143082430834308443085430864308743088430894309043091430924309343094430954309643097430984309943100431014310243103431044310543106431074310843109431104311143112431134311443115431164311743118431194312043121431224312343124431254312643127431284312943130431314313243133431344313543136431374313843139431404314143142431434314443145431464314743148431494315043151431524315343154431554315643157431584315943160431614316243163431644316543166431674316843169431704317143172431734317443175431764317743178431794318043181431824318343184431854318643187431884318943190431914319243193431944319543196431974319843199432004320143202432034320443205432064320743208432094321043211432124321343214432154321643217432184321943220432214322243223432244322543226432274322843229432304323143232432334323443235432364323743238432394324043241432424324343244432454324643247432484324943250432514325243253432544325543256432574325843259432604326143262432634326443265432664326743268432694327043271432724327343274432754327643277432784327943280432814328243283432844328543286432874328843289432904329143292432934329443295432964329743298432994330043301433024330343304433054330643307433084330943310433114331243313433144331543316433174331843319433204332143322433234332443325433264332743328433294333043331433324333343334433354333643337433384333943340433414334243343433444334543346433474334843349433504335143352433534335443355433564335743358433594336043361433624336343364433654336643367433684336943370433714337243373433744337543376433774337843379433804338143382433834338443385433864338743388433894339043391433924339343394433954339643397433984339943400434014340243403434044340543406434074340843409434104341143412434134341443415434164341743418434194342043421434224342343424434254342643427434284342943430434314343243433434344343543436434374343843439434404344143442434434344443445434464344743448434494345043451434524345343454434554345643457434584345943460434614346243463434644346543466434674346843469434704347143472434734347443475434764347743478434794348043481434824348343484434854348643487434884348943490434914349243493434944349543496434974349843499435004350143502435034350443505435064350743508435094351043511435124351343514435154351643517435184351943520435214352243523435244352543526435274352843529435304353143532435334353443535435364353743538435394354043541435424354343544435454354643547435484354943550435514355243553435544355543556435574355843559435604356143562435634356443565435664356743568435694357043571435724357343574435754357643577435784357943580435814358243583435844358543586435874358843589435904359143592435934359443595435964359743598435994360043601436024360343604436054360643607436084360943610436114361243613436144361543616436174361843619436204362143622436234362443625436264362743628436294363043631436324363343634436354363643637436384363943640436414364243643436444364543646436474364843649436504365143652436534365443655436564365743658436594366043661436624366343664436654366643667436684366943670436714367243673436744367543676436774367843679436804368143682436834368443685436864368743688436894369043691436924369343694436954369643697436984369943700437014370243703437044370543706437074370843709437104371143712437134371443715437164371743718437194372043721437224372343724437254372643727437284372943730437314373243733437344373543736437374373843739437404374143742437434374443745437464374743748437494375043751437524375343754437554375643757437584375943760437614376243763437644376543766437674376843769437704377143772437734377443775437764377743778437794378043781437824378343784437854378643787437884378943790437914379243793437944379543796437974379843799438004380143802438034380443805438064380743808438094381043811438124381343814438154381643817438184381943820438214382243823438244382543826438274382843829438304383143832438334383443835438364383743838438394384043841438424384343844438454384643847438484384943850438514385243853438544385543856438574385843859438604386143862438634386443865438664386743868438694387043871438724387343874438754387643877438784387943880438814388243883438844388543886438874388843889438904389143892438934389443895438964389743898438994390043901439024390343904439054390643907439084390943910439114391243913439144391543916439174391843919439204392143922439234392443925439264392743928
  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.DefaultEscherRecordFactory">
  35. <summary>
  36. Generates escher records when provided the byte array containing those records.
  37. @author Glen Stampoultzis
  38. @author Nick Burch (nick at torchbox . com)
  39. </summary>
  40. </member>
  41. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.#ctor">
  42. <summary>
  43. Initializes a new instance of the <see cref="T:NPOI.DDF.DefaultEscherRecordFactory"/> class.
  44. </summary>
  45. </member>
  46. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  47. <summary>
  48. Generates an escher record including the any children contained under that record.
  49. An exception is thrown if the record could not be generated.
  50. </summary>
  51. <param name="data">The byte array containing the records</param>
  52. <param name="offset">The starting offset into the byte array</param>
  53. <returns>The generated escher record</returns>
  54. </member>
  55. <member name="M:NPOI.DDF.DefaultEscherRecordFactory.RecordsToMap(System.Type[])">
  56. <summary>
  57. Converts from a list of classes into a map that Contains the record id as the key and
  58. the Constructor in the value part of the map. It does this by using reflection to look up
  59. the RECORD_ID field then using reflection again to find a reference to the constructor.
  60. </summary>
  61. <param name="records">The records to convert</param>
  62. <returns>The map containing the id/constructor pairs.</returns>
  63. </member>
  64. <member name="T:NPOI.DDF.EscherArrayProperty">
  65. <summary>
  66. Escher array properties are the most wierd construction ever invented
  67. with all sorts of special cases. I'm hopeful I've got them all.
  68. @author Glen Stampoultzis (glens at superlinksoftware.com)
  69. </summary>
  70. </member>
  71. <member name="F:NPOI.DDF.EscherArrayProperty.FIXED_SIZE">
  72. The size of the header that goes at the
  73. start of the array, before the data
  74. </member>
  75. <member name="F:NPOI.DDF.EscherArrayProperty.sizeIncludesHeaderSize">
  76. Normally, the size recorded in the simple data (for the complex
  77. data) includes the size of the header.
  78. There are a few cases when it doesn't though...
  79. </member>
  80. <member name="F:NPOI.DDF.EscherArrayProperty.emptyComplexPart">
  81. When Reading a property from data stream remeber if the complex part is empty and Set this flag.
  82. </member>
  83. <member name="M:NPOI.DDF.EscherArrayProperty.GetElement(System.Int32)">
  84. <summary>
  85. Gets the element.
  86. </summary>
  87. <param name="index">The index.</param>
  88. <returns></returns>
  89. </member>
  90. <member name="M:NPOI.DDF.EscherArrayProperty.SetElement(System.Int32,System.Byte[])">
  91. <summary>
  92. Sets the element.
  93. </summary>
  94. <param name="index">The index.</param>
  95. <param name="element">The element.</param>
  96. </member>
  97. <member name="M:NPOI.DDF.EscherArrayProperty.ToString">
  98. <summary>
  99. Retrieves the string representation for this property.
  100. </summary>
  101. <returns></returns>
  102. </member>
  103. <member name="M:NPOI.DDF.EscherArrayProperty.SetArrayData(System.Byte[],System.Int32)">
  104. <summary>
  105. We have this method because the way in which arrays in escher works
  106. is screwed for seemly arbitary reasons. While most properties are
  107. fairly consistent and have a predictable array size, escher arrays
  108. have special cases.
  109. </summary>
  110. <param name="data">The data array containing the escher array information</param>
  111. <param name="offset">The offset into the array to start Reading from.</param>
  112. <returns>the number of bytes used by this complex property.</returns>
  113. </member>
  114. <member name="M:NPOI.DDF.EscherArrayProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  115. <summary>
  116. Serializes the simple part of this property. ie the first 6 bytes.
  117. Needs special code to handle the case when the size doesn't
  118. include the size of the header block
  119. </summary>
  120. <param name="data"></param>
  121. <param name="pos"></param>
  122. <returns></returns>
  123. </member>
  124. <member name="M:NPOI.DDF.EscherArrayProperty.GetActualSizeOfElements(System.Int16)">
  125. <summary>
  126. Sometimes the element size is stored as a negative number. We
  127. negate it and shift it to Get the real value.
  128. </summary>
  129. <param name="sizeOfElements">The size of elements.</param>
  130. <returns></returns>
  131. </member>
  132. <member name="T:NPOI.DDF.EscherBitmapBlip">
  133. <summary>
  134. @author Glen Stampoultzis
  135. @version $Id: EscherBitmapBlip.java 569827 2007-08-26 15:26:29Z yegor $
  136. </summary>
  137. </member>
  138. <member name="M:NPOI.DDF.EscherBitmapBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  139. <summary>
  140. This method deSerializes the record from a byte array.
  141. </summary>
  142. <param name="data"> The byte array containing the escher record information</param>
  143. <param name="offset">The starting offset into </param>
  144. <param name="recordFactory">May be null since this is not a container record.</param>
  145. <returns>The number of bytes Read from the byte array.</returns>
  146. </member>
  147. <member name="M:NPOI.DDF.EscherBitmapBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  148. <summary>
  149. Serializes the record to an existing byte array.
  150. </summary>
  151. <param name="offset">the offset within the byte array</param>
  152. <param name="data">the data array to Serialize to</param>
  153. <param name="listener">a listener for begin and end serialization events.</param>
  154. <returns>the number of bytes written.</returns>
  155. </member>
  156. <member name="P:NPOI.DDF.EscherBitmapBlip.RecordSize">
  157. <summary>
  158. Returns the number of bytes that are required to Serialize this record.
  159. </summary>
  160. <value> Number of bytes</value>
  161. </member>
  162. <member name="P:NPOI.DDF.EscherBitmapBlip.UID">
  163. <summary>
  164. Gets or sets the UID.
  165. </summary>
  166. <value>The UID.</value>
  167. </member>
  168. <member name="P:NPOI.DDF.EscherBitmapBlip.Marker">
  169. <summary>
  170. Gets or sets the marker.
  171. </summary>
  172. <value>The marker.</value>
  173. </member>
  174. <member name="M:NPOI.DDF.EscherBitmapBlip.ToString">
  175. <summary>
  176. Toes the string.
  177. </summary>
  178. <returns></returns>
  179. </member>
  180. <member name="T:NPOI.DDF.EscherBlipRecord">
  181. <summary>
  182. @author Glen Stampoultzis
  183. @version $Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $
  184. </summary>
  185. </member>
  186. <member name="M:NPOI.DDF.EscherBlipRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  187. <summary>
  188. This method deSerializes the record from a byte array.
  189. </summary>
  190. <param name="data">The byte array containing the escher record information</param>
  191. <param name="offset">The starting offset into </param>
  192. <param name="recordFactory">May be null since this is not a container record.</param>
  193. <returns>The number of bytes Read from the byte array.</returns>
  194. </member>
  195. <member name="M:NPOI.DDF.EscherBlipRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  196. <summary>
  197. Serializes the record to an existing byte array.
  198. </summary>
  199. <param name="offset"> the offset within the byte array</param>
  200. <param name="data">the data array to Serialize to</param>
  201. <param name="listener">a listener for begin and end serialization events.</param>
  202. <returns>the number of bytes written.</returns>
  203. </member>
  204. <member name="P:NPOI.DDF.EscherBlipRecord.RecordSize">
  205. <summary>
  206. Returns the number of bytes that are required to Serialize this record.
  207. </summary>
  208. <value>Number of bytes</value>
  209. </member>
  210. <member name="P:NPOI.DDF.EscherBlipRecord.RecordName">
  211. <summary>
  212. The short name for this record
  213. </summary>
  214. <value></value>
  215. </member>
  216. <member name="P:NPOI.DDF.EscherBlipRecord.PictureData">
  217. <summary>
  218. Gets or sets the picture data.
  219. </summary>
  220. <value>The picture data.</value>
  221. </member>
  222. <member name="M:NPOI.DDF.EscherBlipRecord.ToString">
  223. <summary>
  224. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  225. </summary>
  226. <returns>
  227. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  228. </returns>
  229. </member>
  230. <member name="T:NPOI.DDF.EscherBlipWMFRecord">
  231. <summary>
  232. The blip record is used to hold details about large binary objects that occur in escher such
  233. as JPEG, GIF, PICT and WMF files. The contents of the stream is usually compressed. Inflate
  234. can be used to decompress the data.
  235. @author Glen Stampoultzis
  236. </summary>
  237. </member>
  238. <member name="M:NPOI.DDF.EscherBlipWMFRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  239. <summary>
  240. This method deserializes the record from a byte array.
  241. </summary>
  242. <param name="data">The byte array containing the escher record information</param>
  243. <param name="offset">The starting offset into</param>
  244. <param name="recordFactory">May be null since this is not a container record.</param>
  245. <returns>
  246. The number of bytes Read from the byte array.
  247. </returns>
  248. </member>
  249. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  250. <summary>
  251. This method Serializes this escher record into a byte array.
  252. @param offset
  253. </summary>
  254. <param name="offset">The offset into data to start writing the record data to.</param>
  255. <param name="data">the data array to Serialize to</param>
  256. <param name="listener">a listener for begin and end serialization events.</param>
  257. <returns>the number of bytes written.</returns>
  258. </member>
  259. <member name="P:NPOI.DDF.EscherBlipWMFRecord.RecordSize">
  260. <summary>
  261. Returns the number of bytes that are required to Serialize this record.
  262. </summary>
  263. <value>Number of bytes</value>
  264. </member>
  265. <member name="P:NPOI.DDF.EscherBlipWMFRecord.RecordName">
  266. <summary>
  267. The short name for this record
  268. </summary>
  269. <value></value>
  270. </member>
  271. <member name="P:NPOI.DDF.EscherBlipWMFRecord.SecondaryUID">
  272. <summary>
  273. Gets or sets the secondary UID.
  274. </summary>
  275. <value>The secondary UID.</value>
  276. </member>
  277. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CacheOfSize">
  278. <summary>
  279. Gets or sets the size of the cache of.
  280. </summary>
  281. <value>The size of the cache of.</value>
  282. </member>
  283. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryTop">
  284. <summary>
  285. Gets or sets the top boundary of the metafile drawing commands
  286. </summary>
  287. <value>The boundary top.</value>
  288. </member>
  289. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryLeft">
  290. <summary>
  291. Gets or sets the left boundary of the metafile drawing commands
  292. </summary>
  293. <value>The boundary left.</value>
  294. </member>
  295. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryWidth">
  296. <summary>
  297. Gets or sets the boundary width of the metafile drawing commands
  298. </summary>
  299. <value>The width of the boundary.</value>
  300. </member>
  301. <member name="P:NPOI.DDF.EscherBlipWMFRecord.BoundaryHeight">
  302. <summary>
  303. Gets or sets the boundary height of the metafile drawing commands
  304. </summary>
  305. <value>The height of the boundary.</value>
  306. </member>
  307. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Width">
  308. <summary>
  309. Gets or sets the width of the metafile in EMU's (English Metric Units).
  310. </summary>
  311. <value>The width.</value>
  312. </member>
  313. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Height">
  314. <summary>
  315. Gets or sets the height of the metafile in EMU's (English Metric Units).
  316. </summary>
  317. <value>The height.</value>
  318. </member>
  319. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CacheOfSavedSize">
  320. <summary>
  321. Gets or sets the cache of the saved size
  322. </summary>
  323. <value>the cache of the saved size.</value>
  324. </member>
  325. <member name="P:NPOI.DDF.EscherBlipWMFRecord.CompressionFlag">
  326. <summary>
  327. Is the contents of the blip compressed?
  328. </summary>
  329. <value>The compression flag.</value>
  330. </member>
  331. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Filter">
  332. <summary>
  333. Gets or sets the filter.
  334. </summary>
  335. <value>The filter.</value>
  336. </member>
  337. <member name="P:NPOI.DDF.EscherBlipWMFRecord.Data">
  338. <summary>
  339. Gets or sets The BLIP data
  340. </summary>
  341. <value>The data.</value>
  342. </member>
  343. <member name="M:NPOI.DDF.EscherBlipWMFRecord.ToString">
  344. <summary>
  345. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  346. </summary>
  347. <returns>
  348. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  349. </returns>
  350. </member>
  351. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Compress(System.Byte[])">
  352. <summary>
  353. Compress the contents of the provided array
  354. </summary>
  355. <param name="data">An uncompressed byte array</param>
  356. <returns></returns>
  357. </member>
  358. <member name="M:NPOI.DDF.EscherBlipWMFRecord.Decompress(System.Byte[],System.Int32,System.Int32)">
  359. <summary>
  360. Decompresses the specified data.
  361. </summary>
  362. <param name="data">The compressed byte array.</param>
  363. <param name="pos">The starting position into the byte array.</param>
  364. <param name="Length">The number of compressed bytes to decompress.</param>
  365. <returns>An uncompressed byte array</returns>
  366. </member>
  367. <member name="T:NPOI.DDF.EscherBoolProperty">
  368. <summary>
  369. Represents a bool property. The actual utility of this property is in doubt because many
  370. of the properties marked as bool seem to actually contain special values. In other words
  371. they're not true bools.
  372. @author Glen Stampoultzis
  373. </summary>
  374. </member>
  375. <member name="M:NPOI.DDF.EscherBoolProperty.#ctor(System.Int16,System.Int32)">
  376. <summary>
  377. Create an instance of an escher bool property.
  378. </summary>
  379. <param name="propertyNumber">The property number (or id)</param>
  380. <param name="value">The 32 bit value of this bool property</param>
  381. </member>
  382. <member name="P:NPOI.DDF.EscherBoolProperty.IsTrue">
  383. <summary>
  384. Whether this bool property is true
  385. </summary>
  386. <value><c>true</c> if this instance is true; otherwise, <c>false</c>.</value>
  387. </member>
  388. <member name="P:NPOI.DDF.EscherBoolProperty.IsFalse">
  389. <summary>
  390. Whether this bool property is false
  391. </summary>
  392. <value><c>true</c> if this instance is false; otherwise, <c>false</c>.</value>
  393. </member>
  394. <member name="T:NPOI.DDF.EscherBSERecord">
  395. <summary>
  396. The BSE record is related closely to the EscherBlipRecord and stores
  397. extra information about the blip. A blip record is actually stored inside
  398. the BSE record even though the BSE record isn't actually a container record.
  399. @author Glen Stampoultzis
  400. @see EscherBlipRecord
  401. </summary>
  402. </member>
  403. <member name="M:NPOI.DDF.EscherBSERecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  404. <summary>
  405. This method deSerializes the record from a byte array.
  406. </summary>
  407. <param name="data">The byte array containing the escher record information</param>
  408. <param name="offset">The starting offset into data</param>
  409. <param name="recordFactory">May be null since this is not a container record.</param>
  410. <returns>The number of bytes Read from the byte array.</returns>
  411. </member>
  412. <member name="M:NPOI.DDF.EscherBSERecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  413. <summary>
  414. This method Serializes this escher record into a byte array.
  415. </summary>
  416. <param name="offset">The offset into
  417. data to start writing the record data to</param>
  418. <param name="data">The byte array to Serialize to.</param>
  419. <param name="listener">a listener for begin and end serialization events.</param>
  420. <returns>The number of bytes written.</returns>
  421. </member>
  422. <member name="P:NPOI.DDF.EscherBSERecord.RecordSize">
  423. <summary>
  424. Returns the number of bytes that are required to Serialize this record.
  425. </summary>
  426. <value>Number of bytes</value>
  427. </member>
  428. <member name="P:NPOI.DDF.EscherBSERecord.RecordName">
  429. <summary>
  430. The short name for this record
  431. </summary>
  432. <value></value>
  433. </member>
  434. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeWin32">
  435. <summary>
  436. Gets or sets the expected blip type under windows (failure to match this blip type will result in
  437. Excel converting to this format).
  438. </summary>
  439. <value>The blip type win32.</value>
  440. </member>
  441. <member name="P:NPOI.DDF.EscherBSERecord.BlipTypeMacOS">
  442. <summary>
  443. Gets or sets the expected blip type under MacOS (failure to match this blip type will result in
  444. Excel converting to this format).
  445. </summary>
  446. <value>The blip type mac OS.</value>
  447. </member>
  448. <member name="P:NPOI.DDF.EscherBSERecord.UID">
  449. <summary>
  450. Gets or sets 16 byte MD4 checksum.
  451. </summary>
  452. <value>The UID.</value>
  453. </member>
  454. <member name="P:NPOI.DDF.EscherBSERecord.Tag">
  455. <summary>
  456. Gets or sets the tag. (Unused)
  457. </summary>
  458. <value>The tag.</value>
  459. </member>
  460. <member name="P:NPOI.DDF.EscherBSERecord.Size">
  461. <summary>
  462. Gets or sets Blip size in stream..
  463. </summary>
  464. <value>The size.</value>
  465. </member>
  466. <member name="P:NPOI.DDF.EscherBSERecord.Ref">
  467. <summary>
  468. Gets or sets the reference count of this blip.
  469. </summary>
  470. <value>The ref.</value>
  471. </member>
  472. <member name="P:NPOI.DDF.EscherBSERecord.Offset">
  473. <summary>
  474. Gets or sets the offset in the delay stream..
  475. </summary>
  476. <value>The offset.</value>
  477. </member>
  478. <member name="P:NPOI.DDF.EscherBSERecord.Usage">
  479. <summary>
  480. Defines the way this blip is used.
  481. </summary>
  482. <value>The usage.</value>
  483. </member>
  484. <member name="P:NPOI.DDF.EscherBSERecord.Name">
  485. <summary>
  486. Gets or sets the blip name.
  487. </summary>
  488. <value>The name.</value>
  489. </member>
  490. <member name="P:NPOI.DDF.EscherBSERecord.Unused2">
  491. <summary>
  492. Gets or sets the unused2.
  493. </summary>
  494. <value>The unused2.</value>
  495. </member>
  496. <member name="P:NPOI.DDF.EscherBSERecord.Unused3">
  497. <summary>
  498. Gets or sets the unused3.
  499. </summary>
  500. <value>The unused3.</value>
  501. </member>
  502. <member name="P:NPOI.DDF.EscherBSERecord.BlipRecord">
  503. <summary>
  504. Gets or sets the blip record.
  505. </summary>
  506. <value>The blip record.</value>
  507. </member>
  508. <member name="P:NPOI.DDF.EscherBSERecord.RemainingData">
  509. <summary>
  510. Gets or sets any remaining data in this record.
  511. </summary>
  512. <value>The remaining data.</value>
  513. </member>
  514. <member name="M:NPOI.DDF.EscherBSERecord.ToString">
  515. <summary>
  516. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  517. </summary>
  518. <returns>
  519. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  520. </returns>
  521. </member>
  522. <member name="M:NPOI.DDF.EscherBSERecord.GetBlipType(System.Byte)">
  523. <summary>
  524. Retrieve the string representation given a blip id.
  525. </summary>
  526. <param name="b">The b.</param>
  527. <returns></returns>
  528. </member>
  529. <member name="T:NPOI.DDF.EscherChildAnchorRecord">
  530. <summary>
  531. The escher child achor record is used to specify the position of a shape under an
  532. existing group. The first level of shape records use a EscherClientAnchor record instead.
  533. @author Glen Stampoultzis
  534. </summary>
  535. </member>
  536. <member name="M:NPOI.DDF.EscherChildAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  537. <summary>
  538. This method deSerializes the record from a byte array.
  539. </summary>
  540. <param name="data">The byte array containing the escher record information</param>
  541. <param name="offset">The starting offset into data</param>
  542. <param name="recordFactory">May be null since this is not a container record.</param>
  543. <returns>The number of bytes Read from the byte array.</returns>
  544. </member>
  545. <member name="M:NPOI.DDF.EscherChildAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  546. <summary>
  547. This method Serializes this escher record into a byte array.
  548. </summary>
  549. <param name="offset">The offset into data to start writing the record data to.</param>
  550. <param name="data">The byte array to Serialize to.</param>
  551. <param name="listener">a listener for begin and end serialization events.</param>
  552. <returns>The number of bytes written.</returns>
  553. </member>
  554. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordSize">
  555. <summary>
  556. Returns the number of bytes that are required to Serialize this record.
  557. </summary>
  558. <value>Number of bytes</value>
  559. </member>
  560. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordId">
  561. <summary>
  562. The record id for the EscherChildAnchorRecord.
  563. </summary>
  564. <value></value>
  565. </member>
  566. <member name="P:NPOI.DDF.EscherChildAnchorRecord.RecordName">
  567. <summary>
  568. The short name for this record
  569. </summary>
  570. <value></value>
  571. </member>
  572. <member name="M:NPOI.DDF.EscherChildAnchorRecord.ToString">
  573. <summary>
  574. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  575. </summary>
  576. <returns>
  577. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  578. </returns>
  579. </member>
  580. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx1">
  581. <summary>
  582. Gets or sets offset within the parent coordinate space for the top left point.
  583. </summary>
  584. <value>The DX1.</value>
  585. </member>
  586. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy1">
  587. <summary>
  588. Gets or sets the offset within the parent coordinate space for the top left point.
  589. </summary>
  590. <value>The dy1.</value>
  591. </member>
  592. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dx2">
  593. <summary>
  594. Gets or sets the offset within the parent coordinate space for the bottom right point.
  595. </summary>
  596. <value>The DX2.</value>
  597. </member>
  598. <member name="P:NPOI.DDF.EscherChildAnchorRecord.Dy2">
  599. <summary>
  600. Gets or sets the offset within the parent coordinate space for the bottom right point.
  601. </summary>
  602. <value>The dy2.</value>
  603. </member>
  604. <member name="T:NPOI.DDF.EscherClientAnchorRecord">
  605. <summary>
  606. The escher client anchor specifies which rows and cells the shape is bound to as well as
  607. the offsets within those cells. Each cell is 1024 units wide by 256 units long regardless
  608. of the actual size of the cell. The EscherClientAnchorRecord only applies to the top-most
  609. shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords.
  610. @author Glen Stampoultzis
  611. </summary>
  612. </member>
  613. <member name="F:NPOI.DDF.EscherClientAnchorRecord.field_1_flag">
  614. bit[0] - fMove (1 bit): A bit that specifies whether the shape will be kept intact when the cells are moved.
  615. bit[1] - fSize (1 bit): A bit that specifies whether the shape will be kept intact when the cells are resized. If fMove is 1, the value MUST be 1.
  616. bit[2-4] - reserved, MUST be 0 and MUST be ignored
  617. bit[5-15]- Undefined and MUST be ignored.
  618. it can take values: 0, 2, 3
  619. </member>
  620. <member name="M:NPOI.DDF.EscherClientAnchorRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  621. <summary>
  622. This method deSerializes the record from a byte array.
  623. </summary>
  624. <param name="data">The byte array containing the escher record information</param>
  625. <param name="offset">The starting offset into data</param>
  626. <param name="recordFactory">May be null since this is not a container record.</param>
  627. <returns>The number of bytes Read from the byte array.</returns>
  628. </member>
  629. <member name="M:NPOI.DDF.EscherClientAnchorRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  630. <summary>
  631. This method Serializes this escher record into a byte array.
  632. </summary>
  633. <param name="offset">The offset into data to start writing the record data to.</param>
  634. <param name="data">The byte array to Serialize to.</param>
  635. <param name="listener">a listener for begin and end serialization events.</param>
  636. <returns>The number of bytes written.</returns>
  637. </member>
  638. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordSize">
  639. <summary>
  640. Returns the number of bytes that are required to Serialize this record.
  641. </summary>
  642. <value>Number of bytes</value>
  643. </member>
  644. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordId">
  645. <summary>
  646. The record id for this record.
  647. </summary>
  648. <value></value>
  649. </member>
  650. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RecordName">
  651. <summary>
  652. The short name for this record
  653. </summary>
  654. <value></value>
  655. </member>
  656. <member name="M:NPOI.DDF.EscherClientAnchorRecord.ToString">
  657. <summary>
  658. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  659. </summary>
  660. <returns>
  661. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  662. </returns>
  663. </member>
  664. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Flag">
  665. <summary>
  666. Gets or sets the flag.
  667. </summary>
  668. <value>0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.</value>
  669. </member>
  670. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col1">
  671. <summary>
  672. Gets or sets The column number for the top-left position. 0 based.
  673. </summary>
  674. <value>The col1.</value>
  675. </member>
  676. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx1">
  677. <summary>
  678. Gets or sets The x offset within the top-left cell. Range is from 0 to 1023.
  679. </summary>
  680. <value>The DX1.</value>
  681. </member>
  682. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row1">
  683. <summary>
  684. Gets or sets The row number for the top-left corner of the shape.
  685. </summary>
  686. <value>The row1.</value>
  687. </member>
  688. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy1">
  689. <summary>
  690. Gets or sets The y offset within the top-left corner of the current shape.
  691. </summary>
  692. <value>The dy1.</value>
  693. </member>
  694. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Col2">
  695. <summary>
  696. Gets or sets The column of the bottom right corner of this shape.
  697. </summary>
  698. <value>The col2.</value>
  699. </member>
  700. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dx2">
  701. <summary>
  702. Gets or sets The x offset withing the cell for the bottom-right corner of this shape.
  703. </summary>
  704. <value>The DX2.</value>
  705. </member>
  706. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Row2">
  707. <summary>
  708. Gets or sets The row number for the bottom-right corner of the current shape.
  709. </summary>
  710. <value>The row2.</value>
  711. </member>
  712. <member name="P:NPOI.DDF.EscherClientAnchorRecord.Dy2">
  713. <summary>
  714. Gets or sets The y offset withing the cell for the bottom-right corner of this shape.
  715. </summary>
  716. <value>The dy2.</value>
  717. </member>
  718. <member name="P:NPOI.DDF.EscherClientAnchorRecord.RemainingData">
  719. <summary>
  720. Gets or sets the remaining data.
  721. </summary>
  722. <value>The remaining data.</value>
  723. </member>
  724. <member name="T:NPOI.DDF.EscherClientDataRecord">
  725. <summary>
  726. The EscherClientDataRecord is used to store client specific data about the position of a
  727. shape within a container.
  728. @author Glen Stampoultzis
  729. </summary>
  730. </member>
  731. <member name="M:NPOI.DDF.EscherClientDataRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  732. <summary>
  733. This method deSerializes the record from a byte array.
  734. </summary>
  735. <param name="data">The byte array containing the escher record information</param>
  736. <param name="offset">The starting offset into data</param>
  737. <param name="recordFactory">May be null since this is not a container record.</param>
  738. <returns>The number of bytes Read from the byte array.</returns>
  739. </member>
  740. <member name="M:NPOI.DDF.EscherClientDataRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  741. This method Serializes this escher record into a byte array.
  742. @param offset The offset into <c>data</c> to start writing the record data to.
  743. @param data The byte array to Serialize to.
  744. @param listener A listener to retrieve start and end callbacks. Use a <c>NullEscherSerailizationListener</c> to ignore these events.
  745. @return The number of bytes written.
  746. @see NullEscherSerializationListener
  747. </member>
  748. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordSize">
  749. Returns the number of bytes that are required to Serialize this record.
  750. @return Number of bytes
  751. </member>
  752. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordId">
  753. Returns the identifier of this record.
  754. </member>
  755. <member name="P:NPOI.DDF.EscherClientDataRecord.RecordName">
  756. The short name for this record
  757. </member>
  758. <member name="M:NPOI.DDF.EscherClientDataRecord.ToString">
  759. Returns the string representation of this record.
  760. </member>
  761. <member name="P:NPOI.DDF.EscherClientDataRecord.RemainingData">
  762. Any data recording this record.
  763. </member>
  764. <member name="T:NPOI.DDF.SysIndexProcedure">
  765. The following enum specifies values that indicate special procedural properties that
  766. are used to modify the color components of another color. These values are combined with
  767. those of the {@link SysIndexSource} enum or with a user-specified color.
  768. The first six values are mutually exclusive.
  769. </member>
  770. <member name="T:NPOI.DDF.EscherColorRef">
  771. An OfficeArtCOLORREF structure entry which also handles color extension opid data
  772. </member>
  773. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexSource">
  774. @return {@link SysIndexSource} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  775. </member>
  776. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexProcedure">
  777. Return the {@link SysIndexProcedure} - for invert flag use {@link #getSysIndexInvert()}
  778. @return {@link SysIndexProcedure} if {@link #hasSysIndexFlag()} is {@code true}, otherwise null
  779. </member>
  780. <member name="M:NPOI.DDF.EscherColorRef.GetSysIndexInvert">
  781. @return 0 for no invert flag, 1 for {@link SysIndexProcedure#INVERT_AFTER} and
  782. 2 for {@link SysIndexProcedure#INVERT_HIGHBIT_AFTER}
  783. </member>
  784. <member name="M:NPOI.DDF.EscherColorRef.GetSchemeIndex">
  785. @return index of the scheme color or -1 if {@link #hasSchemeIndexFlag()} is {@code false}
  786. @see NPOI.HSLF.Record.ColorSchemeAtom#getColor(int)
  787. </member>
  788. <member name="M:NPOI.DDF.EscherColorRef.GetPaletteIndex">
  789. @return index of current palette (color) or -1 if {@link #hasPaletteIndexFlag()} is {@code false}
  790. </member>
  791. <member name="T:NPOI.DDF.EscherComplexProperty">
  792. <summary>
  793. A complex property differs from a simple property in that the data can not fit inside a 32 bit
  794. integer. See the specification for more detailed information regarding exactly what is
  795. stored here.
  796. @author Glen Stampoultzis
  797. </summary>
  798. </member>
  799. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Byte[])">
  800. <summary>
  801. Create a complex property using the property id and a byte array containing the complex
  802. data value.
  803. </summary>
  804. <param name="id"> The id consists of the property number, a flag indicating whether this is a blip id and a flag
  805. indicating that this is a complex property.</param>
  806. <param name="complexData">The value of this property.</param>
  807. </member>
  808. <member name="M:NPOI.DDF.EscherComplexProperty.#ctor(System.Int16,System.Boolean,System.Byte[])">
  809. <summary>
  810. Create a complex property using the property number, a flag to indicate whether this is a
  811. blip reference and the complex property data.
  812. </summary>
  813. <param name="propertyNumber">The property number.</param>
  814. <param name="isBlipId">Whether this is a blip id. Should be false.</param>
  815. <param name="complexData">The value of this complex property.</param>
  816. </member>
  817. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  818. <summary>
  819. Serializes the simple part of this property. ie the first 6 bytes.
  820. </summary>
  821. <param name="data"></param>
  822. <param name="pos"></param>
  823. <returns></returns>
  824. </member>
  825. <member name="M:NPOI.DDF.EscherComplexProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  826. <summary>
  827. Serializes the complex part of this property
  828. </summary>
  829. <param name="data">The data array to Serialize to</param>
  830. <param name="pos">The offset within data to start serializing to.</param>
  831. <returns>The number of bytes Serialized.</returns>
  832. </member>
  833. <member name="P:NPOI.DDF.EscherComplexProperty.ComplexData">
  834. <summary>
  835. Gets the complex data.
  836. </summary>
  837. <value>The complex data.</value>
  838. </member>
  839. <member name="M:NPOI.DDF.EscherComplexProperty.Equals(System.Object)">
  840. <summary>
  841. Determine whether this property is equal to another property.
  842. </summary>
  843. <param name="o">The object to compare to.</param>
  844. <returns>True if the objects are equal.</returns>
  845. </member>
  846. <member name="P:NPOI.DDF.EscherComplexProperty.PropertySize">
  847. <summary>
  848. Caclulates the number of bytes required to Serialize this property.
  849. </summary>
  850. <value>Number of bytes</value>
  851. </member>
  852. <member name="M:NPOI.DDF.EscherComplexProperty.GetHashCode">
  853. <summary>
  854. Serves as a hash function for a particular type.
  855. </summary>
  856. <returns>
  857. A hash code for the current <see cref="T:System.Object"/>.
  858. </returns>
  859. </member>
  860. <member name="M:NPOI.DDF.EscherComplexProperty.ToString">
  861. <summary>
  862. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  863. </summary>
  864. <returns>
  865. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  866. </returns>
  867. </member>
  868. <member name="T:NPOI.DDF.EscherContainerRecord">
  869. <summary>
  870. Escher container records store other escher records as children.
  871. The container records themselves never store any information beyond
  872. the standard header used by all escher records. This one record is
  873. used to represent many different types of records.
  874. @author Glen Stampoultzis
  875. </summary>
  876. </member>
  877. <member name="F:NPOI.DDF.EscherContainerRecord._remainingLength">
  878. in case if document contains any charts we have such document structure:
  879. BOF
  880. ...
  881. DrawingRecord
  882. ...
  883. ObjRecord|TxtObjRecord
  884. ...
  885. EOF
  886. ...
  887. BOF(Chart begin)
  888. ...
  889. DrawingRecord
  890. ...
  891. ObjRecord|TxtObjRecord
  892. ...
  893. EOF
  894. So, when we call EscherAggregate.createAggregate() we have not all needed data.
  895. When we got warning "WARNING: " + bytesRemaining + " bytes remaining but no space left"
  896. we should save value of bytesRemaining
  897. and add it to container size when we serialize it
  898. </member>
  899. <member name="M:NPOI.DDF.EscherContainerRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  900. <summary>
  901. The contract of this method is to deSerialize an escher record including
  902. it's children.
  903. </summary>
  904. <param name="data">The byte array containing the Serialized escher
  905. records.</param>
  906. <param name="offset">The offset into the byte array.</param>
  907. <param name="recordFactory">A factory for creating new escher records</param>
  908. <returns>The number of bytes written.</returns>
  909. </member>
  910. <member name="M:NPOI.DDF.EscherContainerRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  911. <summary>
  912. Serializes to an existing byte array without serialization listener.
  913. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  914. </summary>
  915. <param name="offset">the offset within the data byte array.</param>
  916. <param name="data"> the data array to Serialize to.</param>
  917. <param name="listener">a listener for begin and end serialization events.</param>
  918. <returns>The number of bytes written.</returns>
  919. </member>
  920. <member name="P:NPOI.DDF.EscherContainerRecord.RecordSize">
  921. <summary>
  922. Subclasses should effeciently return the number of bytes required to
  923. Serialize the record.
  924. </summary>
  925. <value>number of bytes</value>
  926. </member>
  927. <member name="M:NPOI.DDF.EscherContainerRecord.HasChildOfType(System.Int16)">
  928. <summary>
  929. Do any of our (top level) children have the
  930. given recordId?
  931. </summary>
  932. <param name="recordId">The record id.</param>
  933. <returns>
  934. <c>true</c> if [has child of type] [the specified record id]; otherwise, <c>false</c>.
  935. </returns>
  936. </member>
  937. <member name="P:NPOI.DDF.EscherContainerRecord.ChildRecords">
  938. <summary>
  939. Returns a list of all the child (escher) records
  940. of the container.
  941. </summary>
  942. <value></value>
  943. </member>
  944. <member name="P:NPOI.DDF.EscherContainerRecord.ChildContainers">
  945. <summary>
  946. Returns all of our children which are also
  947. EscherContainers (may be 0, 1, or vary rarely
  948. 2 or 3)
  949. </summary>
  950. <value>The child containers.</value>
  951. </member>
  952. <member name="P:NPOI.DDF.EscherContainerRecord.RecordName">
  953. <summary>
  954. Subclasses should return the short name for this escher record.
  955. </summary>
  956. <value></value>
  957. </member>
  958. <member name="M:NPOI.DDF.EscherContainerRecord.Display(System.Int32)">
  959. <summary>
  960. The display methods allows escher variables to print the record names
  961. according to their hierarchy.
  962. </summary>
  963. <param name="indent">The current indent level.</param>
  964. </member>
  965. <member name="M:NPOI.DDF.EscherContainerRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  966. <summary>
  967. Adds the child record.
  968. </summary>
  969. <param name="record">The record.</param>
  970. </member>
  971. <member name="M:NPOI.DDF.EscherContainerRecord.ToString">
  972. <summary>
  973. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  974. </summary>
  975. <returns>
  976. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  977. </returns>
  978. </member>
  979. <member name="M:NPOI.DDF.EscherContainerRecord.GetChildById(System.Int16)">
  980. <summary>
  981. Gets the child by id.
  982. </summary>
  983. <param name="recordId">The record id.</param>
  984. <returns></returns>
  985. </member>
  986. <member name="M:NPOI.DDF.EscherContainerRecord.GetRecordsById(System.Int16,System.Collections.ArrayList@)">
  987. <summary>
  988. Recursively find records with the specified record ID
  989. </summary>
  990. <param name="recordId"></param>
  991. <param name="out1">list to store found records</param>
  992. </member>
  993. <member name="T:NPOI.DDF.EscherDggRecord">
  994. <summary>
  995. This record defines the drawing groups used for a particular sheet.
  996. </summary>
  997. </member>
  998. <member name="M:NPOI.DDF.EscherDggRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  999. <summary>
  1000. This method deSerializes the record from a byte array.
  1001. </summary>
  1002. <param name="data">The byte array containing the escher record information</param>
  1003. <param name="offset">The starting offset into data</param>
  1004. <param name="recordFactory">May be null since this is not a container record.</param>
  1005. <returns>The number of bytes Read from the byte array.</returns>
  1006. </member>
  1007. <member name="M:NPOI.DDF.EscherDggRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1008. <summary>
  1009. This method Serializes this escher record into a byte array.
  1010. </summary>
  1011. <param name="offset">The offset into data to start writing the record data to.</param>
  1012. <param name="data">The byte array to Serialize to.</param>
  1013. <param name="listener">a listener for begin and end serialization events.</param>
  1014. <returns>The number of bytes written.</returns>
  1015. </member>
  1016. <member name="P:NPOI.DDF.EscherDggRecord.RecordSize">
  1017. <summary>
  1018. Returns the number of bytes that are required to Serialize this record.
  1019. </summary>
  1020. <value>Number of bytes</value>
  1021. </member>
  1022. <member name="P:NPOI.DDF.EscherDggRecord.RecordId">
  1023. <summary>
  1024. Return the current record id.
  1025. </summary>
  1026. <value>The 16 bit record id.</value>
  1027. </member>
  1028. <member name="P:NPOI.DDF.EscherDggRecord.RecordName">
  1029. <summary>
  1030. The short name for this record
  1031. </summary>
  1032. <value></value>
  1033. </member>
  1034. <member name="M:NPOI.DDF.EscherDggRecord.ToString">
  1035. <summary>
  1036. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1037. </summary>
  1038. <returns>
  1039. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1040. </returns>
  1041. </member>
  1042. <member name="P:NPOI.DDF.EscherDggRecord.ShapeIdMax">
  1043. <summary>
  1044. Gets or sets the shape id max.
  1045. </summary>
  1046. <value>The shape id max.</value>
  1047. </member>
  1048. <member name="P:NPOI.DDF.EscherDggRecord.NumIdClusters">
  1049. <summary>
  1050. Gets the Number of id clusters + 1
  1051. </summary>
  1052. <value>The num id clusters.</value>
  1053. </member>
  1054. <member name="P:NPOI.DDF.EscherDggRecord.NumShapesSaved">
  1055. <summary>
  1056. Gets or sets the num shapes saved.
  1057. </summary>
  1058. <value>The num shapes saved.</value>
  1059. </member>
  1060. <member name="P:NPOI.DDF.EscherDggRecord.DrawingsSaved">
  1061. <summary>
  1062. Gets or sets the drawings saved.
  1063. </summary>
  1064. <value>The drawings saved.</value>
  1065. </member>
  1066. <member name="P:NPOI.DDF.EscherDggRecord.MaxDrawingGroupId">
  1067. <summary>
  1068. Gets or sets the max drawing group id.
  1069. </summary>
  1070. <value>The max drawing group id.</value>
  1071. </member>
  1072. <member name="P:NPOI.DDF.EscherDggRecord.FileIdClusters">
  1073. <summary>
  1074. Gets or sets the file id clusters.
  1075. </summary>
  1076. <value>The file id clusters.</value>
  1077. </member>
  1078. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32)">
  1079. <summary>
  1080. Adds the cluster.
  1081. </summary>
  1082. <param name="dgId">The dg id.</param>
  1083. <param name="numShapedUsed">The num shaped used.</param>
  1084. </member>
  1085. <member name="M:NPOI.DDF.EscherDggRecord.AddCluster(System.Int32,System.Int32,System.Boolean)">
  1086. <summary>
  1087. Adds the cluster.
  1088. </summary>
  1089. <param name="dgId">id of the drawing group (stored in the record options)</param>
  1090. <param name="numShapedUsed">initial value of the numShapedUsed field</param>
  1091. <param name="sort">if set to <c>true</c> if true then sort clusters by drawing group id.(
  1092. In Excel the clusters are sorted but in PPT they are not).</param>
  1093. </member>
  1094. <member name="T:NPOI.DDF.EscherDgRecord">
  1095. <summary>
  1096. This record simply holds the number of shapes in the drawing group and the
  1097. last shape id used for this drawing group.
  1098. @author Glen Stampoultzis
  1099. </summary>
  1100. </member>
  1101. <member name="M:NPOI.DDF.EscherDgRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1102. <summary>
  1103. This method deSerializes the record from a byte array.
  1104. </summary>
  1105. <param name="data">The byte array containing the escher record information</param>
  1106. <param name="offset">The starting offset into data</param>
  1107. <param name="recordFactory">May be null since this is not a container record.</param>
  1108. <returns>The number of bytes Read from the byte array.</returns>
  1109. </member>
  1110. <member name="M:NPOI.DDF.EscherDgRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1111. <summary>
  1112. This method Serializes this escher record into a byte array.
  1113. </summary>
  1114. <param name="offset"> The offset into data to start writing the record data to.</param>
  1115. <param name="data"> The byte array to Serialize to.</param>
  1116. <returns>The number of bytes written.</returns>
  1117. <param name="listener">a listener for begin and end serialization events.</param>
  1118. </member>
  1119. <member name="P:NPOI.DDF.EscherDgRecord.RecordSize">
  1120. <summary>
  1121. Returns the number of bytes that are required to Serialize this record.
  1122. </summary>
  1123. <value>Number of bytes</value>
  1124. </member>
  1125. <member name="P:NPOI.DDF.EscherDgRecord.RecordId">
  1126. <summary>
  1127. Return the current record id.
  1128. </summary>
  1129. <value>The 16 bit record id.</value>
  1130. </member>
  1131. <member name="P:NPOI.DDF.EscherDgRecord.RecordName">
  1132. <summary>
  1133. The short name for this record
  1134. </summary>
  1135. <value></value>
  1136. </member>
  1137. <member name="M:NPOI.DDF.EscherDgRecord.ToString">
  1138. <summary>
  1139. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1140. </summary>
  1141. <returns>
  1142. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1143. </returns>
  1144. </member>
  1145. <member name="P:NPOI.DDF.EscherDgRecord.NumShapes">
  1146. <summary>
  1147. Gets or sets The number of shapes in this drawing group.
  1148. </summary>
  1149. <value>The num shapes.</value>
  1150. </member>
  1151. <member name="P:NPOI.DDF.EscherDgRecord.LastMSOSPID">
  1152. <summary>
  1153. Gets or sets The last shape id used in this drawing group.
  1154. </summary>
  1155. <value>The last MSOSPID.</value>
  1156. </member>
  1157. <member name="P:NPOI.DDF.EscherDgRecord.DrawingGroupId">
  1158. <summary>
  1159. Gets the drawing group id for this record. This is encoded in the
  1160. instance part of the option record.
  1161. </summary>
  1162. <value>The drawing group id.</value>
  1163. </member>
  1164. <member name="M:NPOI.DDF.EscherDgRecord.IncrementShapeCount">
  1165. <summary>
  1166. Increments the shape count.
  1167. </summary>
  1168. </member>
  1169. <member name="T:NPOI.DDF.EscherDump">
  1170. <summary>
  1171. Used to dump the contents of escher records to a PrintStream.
  1172. @author Glen Stampoultzis (glens at apache.org)
  1173. </summary>
  1174. </member>
  1175. <member name="M:NPOI.DDF.EscherDump.Dump(System.Byte[],System.Int32,System.Int32)">
  1176. <summary>
  1177. Decodes the escher stream from a byte array and dumps the results to
  1178. a print stream.
  1179. </summary>
  1180. <param name="data">The data array containing the escher records.</param>
  1181. <param name="offset">The starting offset within the data array.</param>
  1182. <param name="size">The number of bytes to Read.</param>
  1183. </member>
  1184. <member name="M:NPOI.DDF.EscherDump.DumpOld(System.Int64,System.IO.Stream)">
  1185. <summary>
  1186. This version of dump is a translation from the open office escher dump routine.
  1187. </summary>
  1188. <param name="maxLength">The number of bytes to Read</param>
  1189. <param name="in1">An input stream to Read from.</param>
  1190. </member>
  1191. <member name="M:NPOI.DDF.EscherDump.PropertyName(System.Int16)">
  1192. <summary>
  1193. Returns a property name given a property id. This is used only by the
  1194. old escher dump routine.
  1195. </summary>
  1196. <param name="propertyId">The property number for the name</param>
  1197. <returns>A descriptive name.</returns>
  1198. </member>
  1199. <member name="M:NPOI.DDF.EscherDump.GetBlipType(System.Byte)">
  1200. <summary>
  1201. Returns the blip description given a blip id.
  1202. </summary>
  1203. <param name="b">blip id</param>
  1204. <returns> A description.</returns>
  1205. </member>
  1206. <member name="M:NPOI.DDF.EscherDump.Dec1616(System.Int32)">
  1207. <summary>
  1208. Straight conversion from OO. Converts a type of float.
  1209. </summary>
  1210. <param name="n32">The N32.</param>
  1211. <returns></returns>
  1212. </member>
  1213. <member name="M:NPOI.DDF.EscherDump.OutHex(System.Int32,System.IO.Stream)">
  1214. <summary>
  1215. Dumps out a hex value by Reading from a input stream.
  1216. </summary>
  1217. <param name="bytes">How many bytes this hex value consists of.</param>
  1218. <param name="in1">The stream to Read the hex value from.</param>
  1219. </member>
  1220. <member name="M:NPOI.DDF.EscherDump.Dump(System.Int32,System.Byte[])">
  1221. <summary>
  1222. Dumps the specified record size.
  1223. </summary>
  1224. <param name="recordSize">Size of the record.</param>
  1225. <param name="data">The data.</param>
  1226. </member>
  1227. <member name="T:NPOI.DDF.EscherMetafileBlip">
  1228. <summary>
  1229. @author Daniel Noll
  1230. </summary>
  1231. </member>
  1232. <member name="F:NPOI.DDF.EscherMetafileBlip.SIGNATURE_EMF">
  1233. BLIP signatures as defined in the escher spec
  1234. </member>
  1235. <member name="F:NPOI.DDF.EscherMetafileBlip.field_2_UID">
  1236. The primary UID is only saved to disk if (blip_instance ^ blip_signature == 1)
  1237. </member>
  1238. <member name="M:NPOI.DDF.EscherMetafileBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1239. <summary>
  1240. This method deSerializes the record from a byte array.
  1241. </summary>
  1242. <param name="data">The byte array containing the escher record information</param>
  1243. <param name="offset">The starting offset into</param>
  1244. <param name="recordFactory">May be null since this is not a container record.</param>
  1245. <returns>
  1246. The number of bytes Read from the byte array.
  1247. </returns>
  1248. </member>
  1249. <member name="M:NPOI.DDF.EscherMetafileBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1250. <summary>
  1251. Serializes the record to an existing byte array.
  1252. </summary>
  1253. <param name="offset">the offset within the byte array</param>
  1254. <param name="data">the data array to Serialize to</param>
  1255. <param name="listener">a listener for begin and end serialization events.</param>
  1256. <returns>the number of bytes written.</returns>
  1257. </member>
  1258. <member name="M:NPOI.DDF.EscherMetafileBlip.InflatePictureData(System.Byte[])">
  1259. <summary>
  1260. Decompresses the provided data, returning the inflated result.
  1261. </summary>
  1262. <param name="data">the deflated picture data.</param>
  1263. <returns>the inflated picture data.</returns>
  1264. </member>
  1265. <member name="P:NPOI.DDF.EscherMetafileBlip.RecordSize">
  1266. <summary>
  1267. Returns the number of bytes that are required to Serialize this record.
  1268. </summary>
  1269. <value>Number of bytes</value>
  1270. </member>
  1271. <member name="P:NPOI.DDF.EscherMetafileBlip.UID">
  1272. <summary>
  1273. Gets or sets the UID.
  1274. </summary>
  1275. <value>The UID.</value>
  1276. </member>
  1277. <member name="P:NPOI.DDF.EscherMetafileBlip.PrimaryUID">
  1278. <summary>
  1279. Gets or sets the primary UID.
  1280. </summary>
  1281. <value>The primary UID.</value>
  1282. </member>
  1283. <member name="P:NPOI.DDF.EscherMetafileBlip.UncompressedSize">
  1284. <summary>
  1285. Gets or sets the size of the uncompressed.
  1286. </summary>
  1287. <value>The size of the uncompressed.</value>
  1288. </member>
  1289. <member name="P:NPOI.DDF.EscherMetafileBlip.Bounds">
  1290. <summary>
  1291. Gets or sets the bounds.
  1292. </summary>
  1293. <value>The bounds.</value>
  1294. </member>
  1295. <member name="P:NPOI.DDF.EscherMetafileBlip.SizeEMU">
  1296. <summary>
  1297. Gets or sets the size EMU.
  1298. </summary>
  1299. <value>The size EMU.</value>
  1300. </member>
  1301. <member name="P:NPOI.DDF.EscherMetafileBlip.CompressedSize">
  1302. <summary>
  1303. Gets or sets the size of the compressed.
  1304. </summary>
  1305. <value>The size of the compressed.</value>
  1306. </member>
  1307. <member name="P:NPOI.DDF.EscherMetafileBlip.IsCompressed">
  1308. <summary>
  1309. Gets or sets a value indicating whether this instance is compressed.
  1310. </summary>
  1311. <value>
  1312. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  1313. </value>
  1314. </member>
  1315. <member name="M:NPOI.DDF.EscherMetafileBlip.ToString">
  1316. <summary>
  1317. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1318. </summary>
  1319. <returns>
  1320. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1321. </returns>
  1322. </member>
  1323. <member name="P:NPOI.DDF.EscherMetafileBlip.Signature">
  1324. <summary>
  1325. Return the blip signature
  1326. </summary>
  1327. <value>the blip signature</value>
  1328. </member>
  1329. <member name="T:NPOI.DDF.EscherOptRecord">
  1330. <summary>
  1331. The opt record is used to store property values for a shape. It is the key to determining
  1332. the attributes of a shape. Properties can be of two types: simple or complex. Simple types
  1333. are fixed Length. Complex properties are variable Length.
  1334. @author Glen Stampoultzis
  1335. </summary>
  1336. </member>
  1337. <member name="P:NPOI.DDF.EscherOptRecord.Options">
  1338. <summary>
  1339. Automatically recalculate the correct option
  1340. </summary>
  1341. <value></value>
  1342. </member>
  1343. <member name="P:NPOI.DDF.EscherOptRecord.RecordName">
  1344. <summary>
  1345. The short name for this record
  1346. </summary>
  1347. <value></value>
  1348. </member>
  1349. <member name="T:NPOI.DDF.EscherPictBlip">
  1350. <summary>
  1351. @author Daniel Noll
  1352. </summary>
  1353. </member>
  1354. <member name="M:NPOI.DDF.EscherPictBlip.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1355. <summary>
  1356. This method deSerializes the record from a byte array.
  1357. </summary>
  1358. <param name="data">The byte array containing the escher record information</param>
  1359. <param name="offset">The starting offset into</param>
  1360. <param name="recordFactory">May be null since this is not a container record.</param>
  1361. <returns>
  1362. The number of bytes Read from the byte array.
  1363. </returns>
  1364. </member>
  1365. <member name="M:NPOI.DDF.EscherPictBlip.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1366. <summary>
  1367. Serializes the record to an existing byte array.
  1368. </summary>
  1369. <param name="offset">the offset within the byte array</param>
  1370. <param name="data">the data array to Serialize to</param>
  1371. <param name="listener">a listener for begin and end serialization events.</param>
  1372. <returns>the number of bytes written.</returns>
  1373. </member>
  1374. <member name="M:NPOI.DDF.EscherPictBlip.InflatePictureData(System.Byte[])">
  1375. <summary>
  1376. Decompresses the provided data, returning the inflated result.
  1377. </summary>
  1378. <param name="data">the deflated picture data.</param>
  1379. <returns>the inflated picture data.</returns>
  1380. </member>
  1381. <member name="P:NPOI.DDF.EscherPictBlip.RecordSize">
  1382. <summary>
  1383. Returns the number of bytes that are required to Serialize this record.
  1384. </summary>
  1385. <value>Number of bytes</value>
  1386. </member>
  1387. <member name="P:NPOI.DDF.EscherPictBlip.UID">
  1388. <summary>
  1389. Gets or sets the UID.
  1390. </summary>
  1391. <value>The UID.</value>
  1392. </member>
  1393. <member name="P:NPOI.DDF.EscherPictBlip.UncompressedSize">
  1394. <summary>
  1395. Gets or sets the size of the uncompressed.
  1396. </summary>
  1397. <value>The size of the uncompressed.</value>
  1398. </member>
  1399. <member name="P:NPOI.DDF.EscherPictBlip.Bounds">
  1400. <summary>
  1401. Gets or sets the bounds.
  1402. </summary>
  1403. <value>The bounds.</value>
  1404. </member>
  1405. <member name="P:NPOI.DDF.EscherPictBlip.SizeEMU">
  1406. <summary>
  1407. Gets or sets the size EMU.
  1408. </summary>
  1409. <value>The size EMU.</value>
  1410. </member>
  1411. <member name="P:NPOI.DDF.EscherPictBlip.CompressedSize">
  1412. <summary>
  1413. Gets or sets the size of the compressed.
  1414. </summary>
  1415. <value>The size of the compressed.</value>
  1416. </member>
  1417. <member name="P:NPOI.DDF.EscherPictBlip.IsCompressed">
  1418. <summary>
  1419. Gets a value indicating whether this instance is compressed.
  1420. </summary>
  1421. <value>
  1422. <c>true</c> if this instance is compressed; otherwise, <c>false</c>.
  1423. </value>
  1424. </member>
  1425. <member name="M:NPOI.DDF.EscherPictBlip.ToString">
  1426. <summary>
  1427. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1428. </summary>
  1429. <returns>
  1430. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1431. </returns>
  1432. </member>
  1433. <member name="T:NPOI.DDF.EscherProperties">
  1434. <summary>
  1435. Provides a list of all known escher properties including the description and
  1436. type.
  1437. @author Glen Stampoultzis (glens at apache.org)
  1438. </summary>
  1439. </member>
  1440. <member name="M:NPOI.DDF.EscherProperties.InitProps">
  1441. <summary>
  1442. Inits the props.
  1443. </summary>
  1444. </member>
  1445. <member name="M:NPOI.DDF.EscherProperties.AddProp(System.Int32,NPOI.DDF.EscherPropertyMetaData)">
  1446. <summary>
  1447. Adds the prop.
  1448. </summary>
  1449. <param name="s">The s.</param>
  1450. <param name="data">The data.</param>
  1451. </member>
  1452. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String,System.Byte)">
  1453. <summary>
  1454. Gets the data.
  1455. </summary>
  1456. <param name="propName">Name of the prop.</param>
  1457. <param name="type">The type.</param>
  1458. <returns></returns>
  1459. </member>
  1460. <member name="M:NPOI.DDF.EscherProperties.GetData(System.String)">
  1461. <summary>
  1462. Gets the data.
  1463. </summary>
  1464. <param name="propName">Name of the prop.</param>
  1465. <returns></returns>
  1466. </member>
  1467. <member name="M:NPOI.DDF.EscherProperties.GetPropertyName(System.Int16)">
  1468. <summary>
  1469. Gets the name of the property.
  1470. </summary>
  1471. <param name="propertyId">The property id.</param>
  1472. <returns></returns>
  1473. </member>
  1474. <member name="M:NPOI.DDF.EscherProperties.GetPropertyType(System.Int16)">
  1475. <summary>
  1476. Gets the type of the property.
  1477. </summary>
  1478. <param name="propertyId">The property id.</param>
  1479. <returns></returns>
  1480. </member>
  1481. <member name="T:NPOI.DDF.EscherProperty">
  1482. <summary>
  1483. This is the abstract base class for all escher properties.
  1484. @see EscherOptRecord
  1485. @author Glen Stampoultzis (glens at apache.org)
  1486. </summary>
  1487. </member>
  1488. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16)">
  1489. <summary>
  1490. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.
  1491. </summary>
  1492. <param name="id">The id is distinct from the actual property number. The id includes the property number the blip id
  1493. flag and an indicator whether the property is complex or not.</param>
  1494. </member>
  1495. <member name="M:NPOI.DDF.EscherProperty.#ctor(System.Int16,System.Boolean,System.Boolean)">
  1496. <summary>
  1497. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherProperty"/> class.The three parameters are combined to form a property
  1498. id.
  1499. </summary>
  1500. <param name="propertyNumber">The property number.</param>
  1501. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1502. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1503. </member>
  1504. <member name="P:NPOI.DDF.EscherProperty.Id">
  1505. <summary>
  1506. Gets the id.
  1507. </summary>
  1508. <value>The id.</value>
  1509. </member>
  1510. <member name="P:NPOI.DDF.EscherProperty.PropertyNumber">
  1511. <summary>
  1512. Gets the property number.
  1513. </summary>
  1514. <value>The property number.</value>
  1515. </member>
  1516. <member name="P:NPOI.DDF.EscherProperty.IsComplex">
  1517. <summary>
  1518. Gets a value indicating whether this instance is complex.
  1519. </summary>
  1520. <value>
  1521. <c>true</c> if this instance is complex; otherwise, <c>false</c>.
  1522. </value>
  1523. </member>
  1524. <member name="P:NPOI.DDF.EscherProperty.IsBlipId">
  1525. <summary>
  1526. Gets a value indicating whether this instance is blip id.
  1527. </summary>
  1528. <value>
  1529. <c>true</c> if this instance is blip id; otherwise, <c>false</c>.
  1530. </value>
  1531. </member>
  1532. <member name="P:NPOI.DDF.EscherProperty.Name">
  1533. <summary>
  1534. Gets the name.
  1535. </summary>
  1536. <value>The name.</value>
  1537. </member>
  1538. <member name="P:NPOI.DDF.EscherProperty.PropertySize">
  1539. <summary>
  1540. Most properties are just 6 bytes in Length. Override this if we're
  1541. dealing with complex properties.
  1542. </summary>
  1543. <value>The size of the property.</value>
  1544. </member>
  1545. <member name="M:NPOI.DDF.EscherProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1546. <summary>
  1547. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1548. The fixed Length part is Serialized first.
  1549. </summary>
  1550. <param name="data">The data.</param>
  1551. <param name="pos">The pos.</param>
  1552. <returns></returns>
  1553. </member>
  1554. <member name="M:NPOI.DDF.EscherProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1555. <summary>
  1556. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1557. The fixed Length part is Serialized first.
  1558. </summary>
  1559. <param name="data">The data.</param>
  1560. <param name="pos">The pos.</param>
  1561. <returns></returns>
  1562. </member>
  1563. <member name="T:NPOI.DDF.EscherPropertyFactory">
  1564. <summary>
  1565. Generates a property given a reference into the byte array storing that property.
  1566. @author Glen Stampoultzis
  1567. </summary>
  1568. </member>
  1569. <member name="M:NPOI.DDF.EscherPropertyFactory.CreateProperties(System.Byte[],System.Int32,System.Int16)">
  1570. <summary>
  1571. Create new properties from a byte array.
  1572. </summary>
  1573. <param name="data">The byte array containing the property</param>
  1574. <param name="offset">The starting offset into the byte array</param>
  1575. <param name="numProperties">The new properties</param>
  1576. <returns></returns>
  1577. </member>
  1578. <member name="T:NPOI.DDF.EscherPropertyMetaData">
  1579. <summary>
  1580. This class stores the type and description of an escher property.
  1581. @author Glen Stampoultzis (glens at apache.org)
  1582. </summary>
  1583. </member>
  1584. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String)">
  1585. <summary>
  1586. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1587. </summary>
  1588. <param name="description">The description of the escher property.</param>
  1589. </member>
  1590. <member name="M:NPOI.DDF.EscherPropertyMetaData.#ctor(System.String,System.Byte)">
  1591. <summary>
  1592. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherPropertyMetaData"/> class.
  1593. </summary>
  1594. <param name="description">The description of the escher property.</param>
  1595. <param name="type">The type of the property.</param>
  1596. </member>
  1597. <member name="P:NPOI.DDF.EscherPropertyMetaData.Description">
  1598. <summary>
  1599. Gets the description.
  1600. </summary>
  1601. <value>The description.</value>
  1602. </member>
  1603. <member name="P:NPOI.DDF.EscherPropertyMetaData.Type">
  1604. <summary>
  1605. Gets the type.
  1606. </summary>
  1607. <value>The type.</value>
  1608. </member>
  1609. <member name="T:NPOI.DDF.EscherRecord">
  1610. <summary>
  1611. The base abstract record from which all escher records are defined. Subclasses will need
  1612. to define methods for serialization/deserialization and for determining the record size.
  1613. @author Glen Stampoultzis
  1614. </summary>
  1615. </member>
  1616. <member name="M:NPOI.DDF.EscherRecord.#ctor">
  1617. <summary>
  1618. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRecord"/> class.
  1619. </summary>
  1620. </member>
  1621. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],NPOI.DDF.IEscherRecordFactory)">
  1622. <summary>
  1623. Delegates to FillFields(byte[], int, EscherRecordFactory)
  1624. </summary>
  1625. <param name="data">The data.</param>
  1626. <param name="f">The f.</param>
  1627. <returns></returns>
  1628. </member>
  1629. <member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1630. <summary>
  1631. The contract of this method is to deSerialize an escher record including
  1632. it's children.
  1633. </summary>
  1634. <param name="data">The byte array containing the Serialized escher
  1635. records.</param>
  1636. <param name="offset">The offset into the byte array.</param>
  1637. <param name="recordFactory">A factory for creating new escher records.</param>
  1638. <returns>The number of bytes written.</returns>
  1639. </member>
  1640. <member name="M:NPOI.DDF.EscherRecord.ReadHeader(System.Byte[],System.Int32)">
  1641. <summary>
  1642. Reads the 8 byte header information and populates the
  1643. <c>options</c>
  1644. and
  1645. <c>recordId</c>
  1646. records.
  1647. </summary>
  1648. <param name="data">the byte array to Read from</param>
  1649. <param name="offset">the offset to start Reading from</param>
  1650. <returns>the number of bytes remaining in this record. This</returns>
  1651. </member>
  1652. <member name="M:NPOI.DDF.EscherRecord.ReadInstance(System.Byte[],System.Int32)">
  1653. <summary>
  1654. Read the options field from header and return instance part of it.
  1655. </summary>
  1656. <param name="data">the byte array to read from</param>
  1657. <param name="offset">the offset to start reading from</param>
  1658. <returns>value of instance part of options field</returns>
  1659. </member>
  1660. <member name="P:NPOI.DDF.EscherRecord.IsContainerRecord">
  1661. <summary>
  1662. Determine whether this is a container record by inspecting the option
  1663. field.
  1664. </summary>
  1665. <value>
  1666. <c>true</c> if this instance is container record; otherwise, <c>false</c>.
  1667. </value>
  1668. </member>
  1669. <member name="P:NPOI.DDF.EscherRecord.Options">
  1670. <summary>
  1671. Gets or sets the options field for this record. All records have one
  1672. </summary>
  1673. <value>The options.</value>
  1674. </member>
  1675. <member name="M:NPOI.DDF.EscherRecord.Serialize">
  1676. <summary>
  1677. Serializes to a new byte array. This is done by delegating to
  1678. Serialize(int, byte[]);
  1679. </summary>
  1680. <returns>the Serialized record.</returns>
  1681. </member>
  1682. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[])">
  1683. <summary>
  1684. Serializes to an existing byte array without serialization listener.
  1685. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  1686. </summary>
  1687. <param name="offset">the offset within the data byte array.</param>
  1688. <param name="data">the data array to Serialize to.</param>
  1689. <returns>The number of bytes written.</returns>
  1690. </member>
  1691. <member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1692. <summary>
  1693. Serializes the record to an existing byte array.
  1694. </summary>
  1695. <param name="offset">the offset within the byte array.</param>
  1696. <param name="data">the offset within the byte array</param>
  1697. <param name="listener">a listener for begin and end serialization events. This.
  1698. is useful because the serialization is
  1699. hierarchical/recursive and sometimes you need to be able
  1700. break into that.
  1701. </param>
  1702. <returns></returns>
  1703. </member>
  1704. <member name="P:NPOI.DDF.EscherRecord.RecordSize">
  1705. <summary>
  1706. Subclasses should effeciently return the number of bytes required to
  1707. Serialize the record.
  1708. </summary>
  1709. <value>number of bytes</value>
  1710. </member>
  1711. <member name="P:NPOI.DDF.EscherRecord.RecordId">
  1712. <summary>
  1713. Return the current record id.
  1714. </summary>
  1715. <value>The 16 bit record id.</value>
  1716. </member>
  1717. <member name="P:NPOI.DDF.EscherRecord.ChildRecords">
  1718. <summary>
  1719. Gets or sets the child records.
  1720. </summary>
  1721. <value>Returns the children of this record. By default this will
  1722. be an empty list. EscherCotainerRecord is the only record that may contain children.</value>
  1723. </member>
  1724. <member name="M:NPOI.DDF.EscherRecord.Clone">
  1725. <summary>
  1726. Creates a new object that is a copy of the current instance.
  1727. </summary>
  1728. <returns>
  1729. A new object that is a copy of this instance.
  1730. </returns>
  1731. </member>
  1732. <member name="M:NPOI.DDF.EscherRecord.GetChild(System.Int32)">
  1733. <summary>
  1734. Returns the indexed child record.
  1735. </summary>
  1736. <param name="index">The index.</param>
  1737. <returns></returns>
  1738. </member>
  1739. <member name="M:NPOI.DDF.EscherRecord.Display(System.Int32)">
  1740. <summary>
  1741. The display methods allows escher variables to print the record names
  1742. according to their hierarchy.
  1743. </summary>
  1744. <param name="indent">The current indent level.</param>
  1745. </member>
  1746. <member name="P:NPOI.DDF.EscherRecord.RecordName">
  1747. <summary>
  1748. Gets the name of the record.
  1749. </summary>
  1750. <value>The name of the record.</value>
  1751. </member>
  1752. <member name="T:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader">
  1753. <summary>
  1754. This class Reads the standard escher header.
  1755. </summary>
  1756. </member>
  1757. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ReadHeader(System.Byte[],System.Int32)">
  1758. <summary>
  1759. Reads the header.
  1760. </summary>
  1761. <param name="data">The data.</param>
  1762. <param name="offset">The off set.</param>
  1763. <returns></returns>
  1764. </member>
  1765. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.Options">
  1766. <summary>
  1767. Gets the options.
  1768. </summary>
  1769. <value>The options.</value>
  1770. </member>
  1771. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RecordId">
  1772. <summary>
  1773. Gets the record id.
  1774. </summary>
  1775. <value>The record id.</value>
  1776. </member>
  1777. <member name="P:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.RemainingBytes">
  1778. <summary>
  1779. Gets the remaining bytes.
  1780. </summary>
  1781. <value>The remaining bytes.</value>
  1782. </member>
  1783. <member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ToString">
  1784. <summary>
  1785. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1786. </summary>
  1787. <returns>
  1788. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1789. </returns>
  1790. </member>
  1791. <member name="P:NPOI.DDF.EscherRecord.Instance">
  1792. <summary>
  1793. Get or set the instance part of the option record.
  1794. </summary>
  1795. </member>
  1796. <member name="P:NPOI.DDF.EscherRecord.Version">
  1797. <summary>
  1798. Get or set the version part of the option record.
  1799. </summary>
  1800. </member>
  1801. <member name="M:NPOI.DDF.EscherRecord.ToXml(System.String)">
  1802. @param tab - each children must be a right of his parent
  1803. @return xml representation of this record
  1804. </member>
  1805. <member name="T:NPOI.DDF.IEscherRecordFactory">
  1806. <summary>
  1807. The escher record factory interface allows for the creation of escher
  1808. records from a pointer into a data array.
  1809. @author Glen Stampoultzis (glens at apache.org)
  1810. </summary>
  1811. </member>
  1812. <member name="M:NPOI.DDF.IEscherRecordFactory.CreateRecord(System.Byte[],System.Int32)">
  1813. <summary>
  1814. Create a new escher record from the data provided. Does not attempt
  1815. to Fill the contents of the record however.
  1816. </summary>
  1817. <param name="data">The data.</param>
  1818. <param name="offset">The off set.</param>
  1819. <returns></returns>
  1820. </member>
  1821. <member name="T:NPOI.DDF.EscherRGBProperty">
  1822. <summary>
  1823. A color property.
  1824. @author Glen Stampoultzis (glens at apache.org)
  1825. </summary>
  1826. </member>
  1827. <member name="M:NPOI.DDF.EscherRGBProperty.#ctor(System.Int16,System.Int32)">
  1828. <summary>
  1829. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRGBProperty"/> class.
  1830. </summary>
  1831. <param name="propertyNumber">The property number.</param>
  1832. <param name="rgbColor">Color of the RGB.</param>
  1833. </member>
  1834. <member name="P:NPOI.DDF.EscherRGBProperty.RgbColor">
  1835. <summary>
  1836. Gets the color of the RGB.
  1837. </summary>
  1838. <value>The color of the RGB.</value>
  1839. </member>
  1840. <member name="P:NPOI.DDF.EscherRGBProperty.Red">
  1841. <summary>
  1842. Gets the red.
  1843. </summary>
  1844. <value>The red.</value>
  1845. </member>
  1846. <member name="P:NPOI.DDF.EscherRGBProperty.Green">
  1847. <summary>
  1848. Gets the green.
  1849. </summary>
  1850. <value>The green.</value>
  1851. </member>
  1852. <member name="P:NPOI.DDF.EscherRGBProperty.Blue">
  1853. <summary>
  1854. Gets the blue.
  1855. </summary>
  1856. <value>The blue.</value>
  1857. </member>
  1858. <member name="T:NPOI.DDF.EscherSerializationListener">
  1859. Interface for listening to escher serialization events.
  1860. @author Glen Stampoultzis (glens at apache.org)
  1861. </member>
  1862. <member name="M:NPOI.DDF.EscherSerializationListener.BeforeRecordSerialize(System.Int32,System.Int16,NPOI.DDF.EscherRecord)">
  1863. Fired before a given escher record is Serialized.
  1864. @param offset The position in the data array at which the record will be Serialized.
  1865. @param recordId The id of the record about to be Serialized.
  1866. </member>
  1867. <member name="M:NPOI.DDF.EscherSerializationListener.AfterRecordSerialize(System.Int32,System.Int16,System.Int32,NPOI.DDF.EscherRecord)">
  1868. Fired after a record has been Serialized.
  1869. @param offset The position of the end of the Serialized record + 1
  1870. @param recordId The id of the record about to be Serialized
  1871. @param size The number of bytes written for this record. If it is a container
  1872. record then this will include the size of any included records.
  1873. </member>
  1874. <member name="T:NPOI.DDF.EscherShapePathProperty">
  1875. <summary>
  1876. Defines the constants for the various possible shape paths.
  1877. @author Glen Stampoultzis (glens at apache.org)
  1878. </summary>
  1879. </member>
  1880. <member name="M:NPOI.DDF.EscherShapePathProperty.#ctor(System.Int16,System.Int32)">
  1881. <summary>
  1882. Initializes a new instance of the <see cref="T:NPOI.DDF.EscherShapePathProperty"/> class.
  1883. </summary>
  1884. <param name="propertyNumber">The property number.</param>
  1885. <param name="shapePath">The shape path.</param>
  1886. </member>
  1887. <member name="T:NPOI.DDF.EscherSimpleProperty">
  1888. <summary>
  1889. A simple property is of fixed Length and as a property number in Addition
  1890. to a 32-bit value. Properties that can't be stored in only 32-bits are
  1891. stored as EscherComplexProperty objects.
  1892. @author Glen Stampoultzis (glens at apache.org)
  1893. </summary>
  1894. </member>
  1895. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Int32)">
  1896. <summary>
  1897. The id is distinct from the actual property number. The id includes the property number the blip id
  1898. flag and an indicator whether the property is complex or not.
  1899. </summary>
  1900. <param name="id">The id.</param>
  1901. <param name="propertyValue">The property value.</param>
  1902. </member>
  1903. <member name="M:NPOI.DDF.EscherSimpleProperty.#ctor(System.Int16,System.Boolean,System.Boolean,System.Int32)">
  1904. <summary>
  1905. Constructs a new escher property. The three parameters are combined to form a property
  1906. id.
  1907. </summary>
  1908. <param name="propertyNumber">The property number.</param>
  1909. <param name="isComplex">if set to <c>true</c> [is complex].</param>
  1910. <param name="isBlipId">if set to <c>true</c> [is blip id].</param>
  1911. <param name="propertyValue">The property value.</param>
  1912. </member>
  1913. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeSimplePart(System.Byte[],System.Int32)">
  1914. <summary>
  1915. Serialize the simple part of the escher record.
  1916. </summary>
  1917. <param name="data">The data.</param>
  1918. <param name="offset">The off set.</param>
  1919. <returns>the number of bytes Serialized.</returns>
  1920. </member>
  1921. <member name="M:NPOI.DDF.EscherSimpleProperty.SerializeComplexPart(System.Byte[],System.Int32)">
  1922. <summary>
  1923. Escher properties consist of a simple fixed Length part and a complex variable Length part.
  1924. The fixed Length part is Serialized first.
  1925. </summary>
  1926. <param name="data"></param>
  1927. <param name="pos"></param>
  1928. <returns></returns>
  1929. </member>
  1930. <member name="P:NPOI.DDF.EscherSimpleProperty.PropertyValue">
  1931. <summary>
  1932. Return the 32 bit value of this property.
  1933. </summary>
  1934. <value>The property value.</value>
  1935. </member>
  1936. <member name="M:NPOI.DDF.EscherSimpleProperty.Equals(System.Object)">
  1937. <summary>
  1938. Returns true if one escher property is equal to another.
  1939. </summary>
  1940. <param name="o">The o.</param>
  1941. <returns></returns>
  1942. </member>
  1943. <member name="M:NPOI.DDF.EscherSimpleProperty.GetHashCode">
  1944. <summary>
  1945. Serves as a hash function for a particular type.
  1946. </summary>
  1947. <returns>
  1948. A hash code for the current <see cref="T:System.Object"/>.
  1949. </returns>
  1950. </member>
  1951. <member name="M:NPOI.DDF.EscherSimpleProperty.ToString">
  1952. <summary>
  1953. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1954. </summary>
  1955. <returns>
  1956. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  1957. </returns>
  1958. </member>
  1959. <member name="T:NPOI.DDF.EscherSpgrRecord">
  1960. <summary>
  1961. The spgr record defines information about a shape group. Groups in escher
  1962. are simply another form of shape that you can't physically see.
  1963. @author Glen Stampoultzis (glens at apache.org)
  1964. </summary>
  1965. </member>
  1966. <member name="M:NPOI.DDF.EscherSpgrRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  1967. <summary>
  1968. This method deSerializes the record from a byte array.
  1969. </summary>
  1970. <param name="data">The byte array containing the escher record information</param>
  1971. <param name="offset">The starting offset into data</param>
  1972. <param name="recordFactory">May be null since this is not a container record.</param>
  1973. <returns>The number of bytes Read from the byte array.</returns>
  1974. </member>
  1975. <member name="M:NPOI.DDF.EscherSpgrRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  1976. <summary>
  1977. This method Serializes this escher record into a byte array
  1978. </summary>
  1979. <param name="offset">The offset into data
  1980. to start writing the record data to.</param>
  1981. <param name="data">The byte array to Serialize to.</param>
  1982. <param name="listener">a listener for begin and end serialization events.</param>
  1983. <returns>The number of bytes written.</returns>
  1984. </member>
  1985. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordSize">
  1986. <summary>
  1987. Returns the number of bytes that are required to Serialize this record.
  1988. </summary>
  1989. <value>Number of bytes</value>
  1990. </member>
  1991. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordId">
  1992. <summary>
  1993. Return the current record id.
  1994. </summary>
  1995. <value>The 16 bit identifier of this shape group record.</value>
  1996. </member>
  1997. <member name="P:NPOI.DDF.EscherSpgrRecord.RecordName">
  1998. <summary>
  1999. The short name for this record
  2000. </summary>
  2001. <value></value>
  2002. </member>
  2003. <member name="M:NPOI.DDF.EscherSpgrRecord.ToString">
  2004. <summary>
  2005. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2006. </summary>
  2007. <returns>
  2008. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2009. </returns>
  2010. </member>
  2011. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX1">
  2012. <summary>
  2013. Gets or sets the starting top-left coordinate of child records.
  2014. </summary>
  2015. <value>The rect x1.</value>
  2016. </member>
  2017. <member name="P:NPOI.DDF.EscherSpgrRecord.RectX2">
  2018. <summary>
  2019. Gets or sets the starting bottom-right coordinate of child records.
  2020. </summary>
  2021. <value>The rect x2.</value>
  2022. </member>
  2023. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY1">
  2024. <summary>
  2025. Gets or sets the starting top-left coordinate of child records.
  2026. </summary>
  2027. <value>The rect y1.</value>
  2028. </member>
  2029. <member name="P:NPOI.DDF.EscherSpgrRecord.RectY2">
  2030. <summary>
  2031. Gets or sets the starting bottom-right coordinate of child records.
  2032. </summary>
  2033. <value>The rect y2.</value>
  2034. </member>
  2035. <member name="T:NPOI.DDF.EscherSplitMenuColorsRecord">
  2036. <summary>
  2037. A list of the most recently used colours for the drawings contained in
  2038. this document.
  2039. @author Glen Stampoultzis (glens at apache.org)
  2040. </summary>
  2041. </member>
  2042. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2043. <summary>
  2044. This method deSerializes the record from a byte array.
  2045. </summary>
  2046. <param name="data">The byte array containing the escher record information</param>
  2047. <param name="offset">The starting offset into data</param>
  2048. <param name="recordFactory">May be null since this is not a container record.</param>
  2049. <returns>The number of bytes Read from the byte array.</returns>
  2050. </member>
  2051. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2052. <summary>
  2053. This method Serializes this escher record into a byte array
  2054. </summary>
  2055. <param name="offset">The offset into data
  2056. to start writing the record data to.</param>
  2057. <param name="data">The byte array to Serialize to.</param>
  2058. <param name="listener">a listener for begin and end serialization events.</param>
  2059. <returns>The number of bytes written.</returns>
  2060. </member>
  2061. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordSize">
  2062. <summary>
  2063. Returns the number of bytes that are required to Serialize this record.
  2064. </summary>
  2065. <value>number of bytes</value>
  2066. </member>
  2067. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordId">
  2068. <summary>
  2069. Return the current record id.
  2070. </summary>
  2071. <value>the 16 bit identifer for this record.</value>
  2072. </member>
  2073. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.RecordName">
  2074. <summary>
  2075. Gets the short name for this record
  2076. </summary>
  2077. <value>The name of the record.</value>
  2078. </member>
  2079. <member name="M:NPOI.DDF.EscherSplitMenuColorsRecord.ToString">
  2080. <summary>
  2081. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2082. </summary>
  2083. <returns>
  2084. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2085. </returns>
  2086. @return a string representation of this record.
  2087. </member>
  2088. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color1">
  2089. <summary>
  2090. Gets or sets the color1.
  2091. </summary>
  2092. <value>The color1.</value>
  2093. </member>
  2094. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color2">
  2095. <summary>
  2096. Gets or sets the color2.
  2097. </summary>
  2098. <value>The color2.</value>
  2099. </member>
  2100. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color3">
  2101. <summary>
  2102. Gets or sets the color3.
  2103. </summary>
  2104. <value>The color3.</value>
  2105. </member>
  2106. <member name="P:NPOI.DDF.EscherSplitMenuColorsRecord.Color4">
  2107. <summary>
  2108. Gets or sets the color4.
  2109. </summary>
  2110. <value>The color4.</value>
  2111. </member>
  2112. <member name="T:NPOI.DDF.EscherSpRecord">
  2113. <summary>
  2114. ToGether the the EscherOptRecord this record defines some of the basic
  2115. properties of a shape.
  2116. @author Glen Stampoultzis (glens at apache.org)
  2117. </summary>
  2118. </member>
  2119. <member name="M:NPOI.DDF.EscherSpRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2120. <summary>
  2121. The contract of this method is to deSerialize an escher record including
  2122. it's children.
  2123. </summary>
  2124. <param name="data">The byte array containing the Serialized escher
  2125. records.</param>
  2126. <param name="offset">The offset into the byte array.</param>
  2127. <param name="recordFactory">A factory for creating new escher records</param>
  2128. <returns>The number of bytes written.</returns>
  2129. </member>
  2130. <member name="M:NPOI.DDF.EscherSpRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2131. <summary>
  2132. Serializes to an existing byte array without serialization listener.
  2133. This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
  2134. </summary>
  2135. <param name="offset">the offset within the data byte array.</param>
  2136. <param name="data"> the data array to Serialize to.</param>
  2137. <param name="listener">a listener for begin and end serialization events.</param>
  2138. <returns>The number of bytes written.</returns>
  2139. </member>
  2140. <member name="P:NPOI.DDF.EscherSpRecord.RecordSize">
  2141. <summary>
  2142. Returns the number of bytes that are required to Serialize this record.
  2143. </summary>
  2144. <value>Number of bytes</value>
  2145. </member>
  2146. <member name="P:NPOI.DDF.EscherSpRecord.RecordId">
  2147. <summary>
  2148. @return the 16 bit identifier for this record.
  2149. </summary>
  2150. <value></value>
  2151. </member>
  2152. <member name="P:NPOI.DDF.EscherSpRecord.RecordName">
  2153. <summary>
  2154. The short name for this record
  2155. </summary>
  2156. <value></value>
  2157. </member>
  2158. <member name="M:NPOI.DDF.EscherSpRecord.ToString">
  2159. <summary>
  2160. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2161. </summary>
  2162. <returns>
  2163. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2164. </returns>
  2165. </member>
  2166. <member name="M:NPOI.DDF.EscherSpRecord.DecodeFlags(System.Int32)">
  2167. <summary>
  2168. Converts the shape flags into a more descriptive name.
  2169. </summary>
  2170. <param name="flags">The flags.</param>
  2171. <returns></returns>
  2172. </member>
  2173. <member name="P:NPOI.DDF.EscherSpRecord.ShapeId">
  2174. <summary>
  2175. Gets or sets A number that identifies this shape
  2176. </summary>
  2177. <value>The shape id.</value>
  2178. </member>
  2179. <member name="P:NPOI.DDF.EscherSpRecord.Flags">
  2180. <summary>
  2181. The flags that apply to this shape.
  2182. </summary>
  2183. <value>The flags.</value>
  2184. </member>
  2185. <member name="P:NPOI.DDF.EscherSpRecord.ShapeType">
  2186. <summary>
  2187. Get or set shape type. Must be one of MSOSPT values (see [MS-ODRAW] for details).
  2188. </summary>
  2189. </member>
  2190. <member name="T:NPOI.DDF.EscherTertiaryOptRecord">
  2191. "The OfficeArtTertiaryFOPT record specifies a table of OfficeArtRGFOPTE properties, as defined in section 2.3.1."
  2192. -- [MS-ODRAW] -- v20110608; Office Drawing Binary File Format
  2193. @author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
  2194. </member>
  2195. <member name="T:NPOI.DDF.EscherTextboxRecord">
  2196. <summary>
  2197. Holds data from the parent application. Most commonly used to store
  2198. text in the format of the parent application, rather than in
  2199. Escher format. We don't attempt to understand the contents, since
  2200. they will be in the parent's format, not Escher format.
  2201. @author Glen Stampoultzis (glens at apache.org)
  2202. @author Nick Burch (nick at torchbox dot com)
  2203. </summary>
  2204. </member>
  2205. <member name="F:NPOI.DDF.EscherTextboxRecord._thedata">
  2206. The data for this record not including the the 8 byte header
  2207. </member>
  2208. <member name="M:NPOI.DDF.EscherTextboxRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2209. This method deserializes the record from a byte array.
  2210. @param data The byte array containing the escher record information
  2211. @param offset The starting offset into <c>data</c>.
  2212. @param recordFactory May be null since this is not a container record.
  2213. @return The number of bytes Read from the byte array.
  2214. </member>
  2215. <member name="M:NPOI.DDF.EscherTextboxRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2216. <summary>
  2217. Writes this record and any contained records to the supplied byte
  2218. </summary>
  2219. <param name="offset"></param>
  2220. <param name="data"></param>
  2221. <param name="listener">a listener for begin and end serialization events.</param>
  2222. <returns>the number of bytes written.</returns>
  2223. </member>
  2224. <member name="P:NPOI.DDF.EscherTextboxRecord.Data">
  2225. <summary>
  2226. Returns any extra data associated with this record. In practice excel
  2227. does not seem to put anything here, but with PowerPoint this will
  2228. contain the bytes that make up a TextHeaderAtom followed by a
  2229. TextBytesAtom/TextCharsAtom
  2230. </summary>
  2231. <value>The data.</value>
  2232. </member>
  2233. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[],System.Int32,System.Int32)">
  2234. <summary>
  2235. Sets the extra data (in the parent application's format) to be
  2236. contained by the record. Used when the parent application changes
  2237. the contents.
  2238. </summary>
  2239. <param name="b">The b.</param>
  2240. <param name="start">The start.</param>
  2241. <param name="length">The length.</param>
  2242. </member>
  2243. <member name="M:NPOI.DDF.EscherTextboxRecord.SetData(System.Byte[])">
  2244. <summary>
  2245. Sets the data.
  2246. </summary>
  2247. <param name="b">The b.</param>
  2248. </member>
  2249. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordSize">
  2250. <summary>
  2251. Returns the number of bytes that are required to serialize this record.
  2252. </summary>
  2253. <value>Number of bytes</value>
  2254. </member>
  2255. <member name="P:NPOI.DDF.EscherTextboxRecord.RecordName">
  2256. <summary>
  2257. The short name for this record
  2258. </summary>
  2259. <value></value>
  2260. </member>
  2261. <member name="M:NPOI.DDF.EscherTextboxRecord.ToString">
  2262. <summary>
  2263. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2264. </summary>
  2265. <returns>
  2266. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2267. </returns>
  2268. </member>
  2269. <member name="T:NPOI.DDF.UnknownEscherRecord">
  2270. <summary>
  2271. This record is used whenever a escher record is encountered that
  2272. we do not explicitly support.
  2273. @author Glen Stampoultzis (glens at apache.org)
  2274. </summary>
  2275. </member>
  2276. <member name="F:NPOI.DDF.UnknownEscherRecord._thedata">
  2277. The data for this record not including the the 8 byte header
  2278. </member>
  2279. <member name="M:NPOI.DDF.UnknownEscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
  2280. <summary>
  2281. This method deSerializes the record from a byte array.
  2282. </summary>
  2283. <param name="data"> The byte array containing the escher record information</param>
  2284. <param name="offset">The starting offset into data </param>
  2285. <param name="recordFactory">May be null since this is not a container record.</param>
  2286. <returns>The number of bytes Read from the byte array.</returns>
  2287. </member>
  2288. <member name="M:NPOI.DDF.UnknownEscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
  2289. <summary>
  2290. Writes this record and any contained records to the supplied byte
  2291. array.
  2292. </summary>
  2293. <param name="offset"></param>
  2294. <param name="data"></param>
  2295. <param name="listener">a listener for begin and end serialization events.</param>
  2296. <returns>the number of bytes written.</returns>
  2297. </member>
  2298. <member name="P:NPOI.DDF.UnknownEscherRecord.Data">
  2299. <summary>
  2300. Gets the data.
  2301. </summary>
  2302. <value>The data.</value>
  2303. </member>
  2304. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordSize">
  2305. <summary>
  2306. Returns the number of bytes that are required to Serialize this record.
  2307. </summary>
  2308. <value>Number of bytes</value>
  2309. </member>
  2310. <member name="P:NPOI.DDF.UnknownEscherRecord.ChildRecords">
  2311. <summary>
  2312. Returns the children of this record. By default this will
  2313. be an empty list. EscherCotainerRecord is the only record
  2314. that may contain children.
  2315. </summary>
  2316. <value></value>
  2317. </member>
  2318. <member name="P:NPOI.DDF.UnknownEscherRecord.RecordName">
  2319. <summary>
  2320. The short name for this record
  2321. </summary>
  2322. <value></value>
  2323. </member>
  2324. <member name="M:NPOI.DDF.UnknownEscherRecord.ToString">
  2325. <summary>
  2326. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2327. </summary>
  2328. <returns>
  2329. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  2330. </returns>
  2331. </member>
  2332. <member name="M:NPOI.DDF.UnknownEscherRecord.AddChildRecord(NPOI.DDF.EscherRecord)">
  2333. <summary>
  2334. Adds the child record.
  2335. </summary>
  2336. <param name="childRecord">The child record.</param>
  2337. </member>
  2338. <member name="T:NPOI.HPSF.Constants">
  2339. <summary>
  2340. Defines constants of general use.
  2341. @author Rainer Klute klute@rainer-klute.de
  2342. @since 2004-06-20
  2343. </summary>
  2344. </member>
  2345. <member name="F:NPOI.HPSF.Constants.None">
  2346. <summary>
  2347. Allow accessing the Initial value.
  2348. </summary>
  2349. </member>
  2350. <member name="F:NPOI.HPSF.Constants.CP_037">
  2351. Codepage 037, a special case
  2352. </member>
  2353. <member name="F:NPOI.HPSF.Constants.CP_SJIS">
  2354. Codepage for SJIS
  2355. </member>
  2356. <member name="F:NPOI.HPSF.Constants.CP_GBK">
  2357. Codepage for GBK, aka MS936
  2358. </member>
  2359. <member name="F:NPOI.HPSF.Constants.CP_MS949">
  2360. Codepage for MS949
  2361. </member>
  2362. <member name="F:NPOI.HPSF.Constants.CP_UTF16">
  2363. Codepage for UTF-16
  2364. </member>
  2365. <member name="F:NPOI.HPSF.Constants.CP_UTF16_BE">
  2366. Codepage for UTF-16 big-endian
  2367. </member>
  2368. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1250">
  2369. Codepage for Windows 1250
  2370. </member>
  2371. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1251">
  2372. Codepage for Windows 1251
  2373. </member>
  2374. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1252">
  2375. Codepage for Windows 1252
  2376. </member>
  2377. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1253">
  2378. Codepage for Windows 1253
  2379. </member>
  2380. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1254">
  2381. Codepage for Windows 1254
  2382. </member>
  2383. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1255">
  2384. Codepage for Windows 1255
  2385. </member>
  2386. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1256">
  2387. Codepage for Windows 1256
  2388. </member>
  2389. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1257">
  2390. Codepage for Windows 1257
  2391. </member>
  2392. <member name="F:NPOI.HPSF.Constants.CP_WINDOWS_1258">
  2393. Codepage for Windows 1258
  2394. </member>
  2395. <member name="F:NPOI.HPSF.Constants.CP_JOHAB">
  2396. Codepage for Johab
  2397. </member>
  2398. <member name="F:NPOI.HPSF.Constants.CP_MAC_ROMAN">
  2399. Codepage for Macintosh Roman (Java: MacRoman)
  2400. </member>
  2401. <member name="F:NPOI.HPSF.Constants.CP_MAC_JAPAN">
  2402. Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  2403. cp943)
  2404. </member>
  2405. <member name="F:NPOI.HPSF.Constants.CP_MAC_CHINESE_TRADITIONAL">
  2406. Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  2407. MS950, or cp937)
  2408. </member>
  2409. <member name="F:NPOI.HPSF.Constants.CP_MAC_KOREAN">
  2410. Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  2411. cp949)
  2412. </member>
  2413. <member name="F:NPOI.HPSF.Constants.CP_MAC_ARABIC">
  2414. Codepage for Macintosh Arabic (Java: MacArabic)
  2415. </member>
  2416. <member name="F:NPOI.HPSF.Constants.CP_MAC_HEBREW">
  2417. Codepage for Macintosh Hebrew (Java: MacHebrew)
  2418. </member>
  2419. <member name="F:NPOI.HPSF.Constants.CP_MAC_GREEK">
  2420. Codepage for Macintosh Greek (Java: MacGreek)
  2421. </member>
  2422. <member name="F:NPOI.HPSF.Constants.CP_MAC_CYRILLIC">
  2423. Codepage for Macintosh Cyrillic (Java: MacCyrillic)
  2424. </member>
  2425. <member name="F:NPOI.HPSF.Constants.CP_MAC_CHINESE_SIMPLE">
  2426. Codepage for Macintosh Chinese Simplified (Java: unknown - use
  2427. EUC_CN, ISO2022_CN_GB, MS936 or cp935)
  2428. </member>
  2429. <member name="F:NPOI.HPSF.Constants.CP_MAC_ROMANIA">
  2430. Codepage for Macintosh Romanian (Java: MacRomania)
  2431. </member>
  2432. <member name="F:NPOI.HPSF.Constants.CP_MAC_UKRAINE">
  2433. Codepage for Macintosh Ukrainian (Java: MacUkraine)
  2434. </member>
  2435. <member name="F:NPOI.HPSF.Constants.CP_MAC_THAI">
  2436. Codepage for Macintosh Thai (Java: MacThai)
  2437. </member>
  2438. <member name="F:NPOI.HPSF.Constants.CP_MAC_CENTRAL_EUROPE">
  2439. Codepage for Macintosh Central Europe (Latin-2)
  2440. (Java: MacCentralEurope)
  2441. </member>
  2442. <member name="F:NPOI.HPSF.Constants.CP_MAC_ICELAND">
  2443. Codepage for Macintosh Iceland (Java: MacIceland)
  2444. </member>
  2445. <member name="F:NPOI.HPSF.Constants.CP_MAC_TURKISH">
  2446. Codepage for Macintosh Turkish (Java: MacTurkish)
  2447. </member>
  2448. <member name="F:NPOI.HPSF.Constants.CP_MAC_CROATIAN">
  2449. Codepage for Macintosh Croatian (Java: MacCroatian)
  2450. </member>
  2451. <member name="F:NPOI.HPSF.Constants.CP_US_ACSII">
  2452. Codepage for US-ASCII
  2453. </member>
  2454. <member name="F:NPOI.HPSF.Constants.CP_KOI8_R">
  2455. Codepage for KOI8-R
  2456. </member>
  2457. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_1">
  2458. Codepage for ISO-8859-1
  2459. </member>
  2460. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_2">
  2461. Codepage for ISO-8859-2
  2462. </member>
  2463. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_3">
  2464. Codepage for ISO-8859-3
  2465. </member>
  2466. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_4">
  2467. Codepage for ISO-8859-4
  2468. </member>
  2469. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_5">
  2470. Codepage for ISO-8859-5
  2471. </member>
  2472. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_6">
  2473. Codepage for ISO-8859-6
  2474. </member>
  2475. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_7">
  2476. Codepage for ISO-8859-7
  2477. </member>
  2478. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_8">
  2479. Codepage for ISO-8859-8
  2480. </member>
  2481. <member name="F:NPOI.HPSF.Constants.CP_ISO_8859_9">
  2482. Codepage for ISO-8859-9
  2483. </member>
  2484. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP1">
  2485. Codepage for ISO-2022-JP
  2486. </member>
  2487. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP2">
  2488. Another codepage for ISO-2022-JP
  2489. </member>
  2490. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_JP3">
  2491. Yet another codepage for ISO-2022-JP
  2492. </member>
  2493. <member name="F:NPOI.HPSF.Constants.CP_ISO_2022_KR">
  2494. Codepage for ISO-2022-KR
  2495. </member>
  2496. <member name="F:NPOI.HPSF.Constants.CP_EUC_JP">
  2497. Codepage for EUC-JP
  2498. </member>
  2499. <member name="F:NPOI.HPSF.Constants.CP_EUC_KR">
  2500. Codepage for EUC-KR
  2501. </member>
  2502. <member name="F:NPOI.HPSF.Constants.CP_GB2312">
  2503. Codepage for GB2312
  2504. </member>
  2505. <member name="F:NPOI.HPSF.Constants.CP_GB18030">
  2506. Codepage for GB18030
  2507. </member>
  2508. <member name="F:NPOI.HPSF.Constants.CP_US_ASCII2">
  2509. Another codepage for US-ASCII
  2510. </member>
  2511. <member name="F:NPOI.HPSF.Constants.CP_UTF8">
  2512. Codepage for UTF-8
  2513. </member>
  2514. <member name="F:NPOI.HPSF.Constants.CP_UNICODE">
  2515. Codepage for Unicode
  2516. </member>
  2517. <member name="T:NPOI.HPSF.CustomProperties">
  2518. <summary>
  2519. Maintains the instances of {@link CustomProperty} that belong To a
  2520. {@link DocumentSummaryInformation}. The class maintains the names of the
  2521. custom properties in a dictionary. It implements the {@link Map} interface
  2522. and by this provides a simplified view on custom properties: A property's
  2523. name is the key that maps To a typed value. This implementation hides
  2524. property IDs from the developer and regards the property names as keys To
  2525. typed values.
  2526. While this class provides a simple API To custom properties, it ignores
  2527. the fact that not names, but IDs are the real keys To properties. Under the
  2528. hood this class maintains a 1:1 relationship between IDs and names. Therefore
  2529. you should not use this class To process property Sets with several IDs
  2530. mapping To the same name or with properties without a name: the result will
  2531. contain only a subSet of the original properties. If you really need To deal
  2532. such property Sets, use HPSF's low-level access methods.
  2533. An application can call the {@link #isPure} method To check whether a
  2534. property Set parsed by {@link CustomProperties} is still pure (i.e.
  2535. unmodified) or whether one or more properties have been dropped.
  2536. This class is not thRead-safe; concurrent access To instances of this
  2537. class must be syncronized.
  2538. @author Rainer Klute
  2539. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2540. @since 2006-02-09
  2541. </summary>
  2542. </member>
  2543. <member name="F:NPOI.HPSF.CustomProperties.dictionaryIDToName">
  2544. Maps property IDs To property names.
  2545. </member>
  2546. <member name="F:NPOI.HPSF.CustomProperties.dictionaryNameToID">
  2547. Maps property names To property IDs.
  2548. </member>
  2549. <member name="F:NPOI.HPSF.CustomProperties.isPure">
  2550. Tells whether this object is pure or not.
  2551. </member>
  2552. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,NPOI.HPSF.CustomProperty)">
  2553. <summary>
  2554. Puts a {@link CustomProperty} into this map. It is assumed that the
  2555. {@link CustomProperty} alReady has a valid ID. Otherwise use
  2556. {@link #Put(CustomProperty)}.
  2557. </summary>
  2558. <param name="name">The name.</param>
  2559. <param name="cp">The custom property.</param>
  2560. <returns></returns>
  2561. </member>
  2562. <member name="M:NPOI.HPSF.CustomProperties.KeySet">
  2563. Returns a set of all the names of our
  2564. custom properties. Equivalent to
  2565. {@link #nameSet()}
  2566. </member>
  2567. <member name="M:NPOI.HPSF.CustomProperties.NameSet">
  2568. Returns a set of all the names of our
  2569. custom properties
  2570. </member>
  2571. <member name="M:NPOI.HPSF.CustomProperties.IdSet">
  2572. Returns a set of all the IDs of our
  2573. custom properties
  2574. </member>
  2575. <member name="M:NPOI.HPSF.CustomProperties.Put(NPOI.HPSF.CustomProperty)">
  2576. <summary>
  2577. Puts a {@link CustomProperty} that has not yet a valid ID into this
  2578. map. The method will allocate a suitable ID for the custom property:
  2579. <ul>
  2580. <li>If there is alReady a property with the same name, take the ID
  2581. of that property.</li>
  2582. <li>Otherwise Find the highest ID and use its value plus one.</li>
  2583. </ul>
  2584. </summary>
  2585. <param name="customProperty">The custom property.</param>
  2586. <returns>If the was alReady a property with the same name, the</returns>
  2587. </member>
  2588. <member name="M:NPOI.HPSF.CustomProperties.Remove(System.String)">
  2589. <summary>
  2590. Removes a custom property.
  2591. </summary>
  2592. <param name="name">The name of the custom property To Remove</param>
  2593. <returns>The Removed property or
  2594. <c>null</c>
  2595. if the specified property was not found.</returns>
  2596. </member>
  2597. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.String)">
  2598. <summary>
  2599. Adds a named string property.
  2600. </summary>
  2601. <param name="name">The property's name.</param>
  2602. <param name="value">The property's value.</param>
  2603. <returns>the property that was stored under the specified name before, or
  2604. <c>null</c>
  2605. if there was no such property before.</returns>
  2606. </member>
  2607. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int64)">
  2608. <summary>
  2609. Adds a named long property
  2610. </summary>
  2611. <param name="name">The property's name.</param>
  2612. <param name="value">The property's value.</param>
  2613. <returns>the property that was stored under the specified name before, or
  2614. <c>null</c>
  2615. if there was no such property before.</returns>
  2616. </member>
  2617. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Double)">
  2618. <summary>
  2619. Adds a named double property.
  2620. </summary>
  2621. <param name="name">The property's name.</param>
  2622. <param name="value">The property's value.</param>
  2623. <returns>the property that was stored under the specified name before, or
  2624. <c>null</c>
  2625. if there was no such property before.</returns>
  2626. </member>
  2627. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Int32)">
  2628. <summary>
  2629. Adds a named integer property.
  2630. </summary>
  2631. <param name="name">The property's name.</param>
  2632. <param name="value">The property's value.</param>
  2633. <returns>the property that was stored under the specified name before, or
  2634. <c>null</c>
  2635. if there was no such property before.</returns>
  2636. </member>
  2637. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.Boolean)">
  2638. <summary>
  2639. Adds a named bool property.
  2640. </summary>
  2641. <param name="name">The property's name.</param>
  2642. <param name="value">The property's value.</param>
  2643. <returns>the property that was stored under the specified name before, or
  2644. <c>null</c>
  2645. if there was no such property before.</returns>
  2646. </member>
  2647. <member name="M:NPOI.HPSF.CustomProperties.Put(System.String,System.DateTime)">
  2648. <summary>
  2649. Adds a named date property.
  2650. </summary>
  2651. <param name="name">The property's name.</param>
  2652. <param name="value">The property's value.</param>
  2653. <returns>the property that was stored under the specified name before, or
  2654. <c>null</c>
  2655. if there was no such property before.</returns>
  2656. </member>
  2657. <member name="P:NPOI.HPSF.CustomProperties.Item(System.String)">
  2658. <summary>
  2659. Gets the <see cref="T:System.Object"/> with the specified name.
  2660. </summary>
  2661. <value>the value or
  2662. <c>null</c>
  2663. if a value with the specified
  2664. name is not found in the custom properties.</value>
  2665. </member>
  2666. <member name="M:NPOI.HPSF.CustomProperties.ContainsKey(System.Object)">
  2667. Checks against both String Name and Long ID
  2668. </member>
  2669. <member name="M:NPOI.HPSF.CustomProperties.ContainsValue(System.Object)">
  2670. Checks against both the property, and its values.
  2671. </member>
  2672. <member name="P:NPOI.HPSF.CustomProperties.Dictionary">
  2673. <summary>
  2674. Gets the dictionary which Contains IDs and names of the named custom
  2675. properties.
  2676. </summary>
  2677. <value>The dictionary.</value>
  2678. </member>
  2679. <member name="P:NPOI.HPSF.CustomProperties.Codepage">
  2680. <summary>
  2681. Gets or sets the codepage.
  2682. </summary>
  2683. <value>The codepage.</value>
  2684. </member>
  2685. <member name="P:NPOI.HPSF.CustomProperties.IsPure">
  2686. <summary>
  2687. Tells whether this {@link CustomProperties} instance is pure or one or
  2688. more properties of the underlying low-level property Set has been
  2689. dropped.
  2690. </summary>
  2691. <value><c>true</c> if this instance is pure; otherwise, <c>false</c>.</value>
  2692. </member>
  2693. <member name="T:NPOI.HPSF.CustomProperty">
  2694. <summary>
  2695. This class represents custum properties in the document summary
  2696. information stream. The difference To normal properties is that custom
  2697. properties have an optional name. If the name is not <c>null</c> it
  2698. will be maintained in the section's dictionary.
  2699. @author Rainer Klute
  2700. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  2701. @since 2006-02-09
  2702. </summary>
  2703. </member>
  2704. <member name="M:NPOI.HPSF.CustomProperty.#ctor">
  2705. <summary>
  2706. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2707. </summary>
  2708. </member>
  2709. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property)">
  2710. <summary>
  2711. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2712. </summary>
  2713. <param name="property">the property To copy</param>
  2714. </member>
  2715. <member name="M:NPOI.HPSF.CustomProperty.#ctor(NPOI.HPSF.Property,System.String)">
  2716. <summary>
  2717. Initializes a new instance of the <see cref="T:NPOI.HPSF.CustomProperty"/> class.
  2718. </summary>
  2719. <param name="property">This property's attributes are copied To the new custom
  2720. property.</param>
  2721. <param name="name">The new custom property's name.</param>
  2722. </member>
  2723. <member name="P:NPOI.HPSF.CustomProperty.Name">
  2724. <summary>
  2725. Gets or sets the property's name.
  2726. </summary>
  2727. <value>the property's name.</value>
  2728. </member>
  2729. <member name="M:NPOI.HPSF.CustomProperty.EqualsContents(System.Object)">
  2730. <summary>
  2731. Compares two custom properties for equality. The method returns
  2732. <c>true</c> if all attributes of the two custom properties are
  2733. equal.
  2734. </summary>
  2735. <param name="o">The custom property To Compare with.</param>
  2736. <returns><c>true</c>
  2737. if both custom properties are equal, else
  2738. <c>false</c></returns>
  2739. </member>
  2740. <member name="M:NPOI.HPSF.CustomProperty.GetHashCode">
  2741. <summary>
  2742. </summary>
  2743. <returns></returns>
  2744. @see Object#GetHashCode()
  2745. </member>
  2746. <member name="T:NPOI.HPSF.DocumentSummaryInformation">
  2747. <summary>
  2748. Convenience class representing a DocumentSummary Information stream in a
  2749. Microsoft Office document.
  2750. @author Rainer Klute
  2751. klute@rainer-klute.de
  2752. @author Drew Varner (Drew.Varner cloSeto sc.edu)
  2753. @author robert_flaherty@hyperion.com
  2754. @since 2002-02-09
  2755. </summary>
  2756. </member>
  2757. <member name="F:NPOI.HPSF.DocumentSummaryInformation.DEFAULT_STREAM_NAME">
  2758. The document name a document summary information stream
  2759. usually has in a POIFS filesystem.
  2760. </member>
  2761. <member name="M:NPOI.HPSF.DocumentSummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  2762. <summary>
  2763. Initializes a new instance of the <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> class.
  2764. </summary>
  2765. <param name="ps">A property Set which should be Created from a
  2766. document summary information stream.</param>
  2767. </member>
  2768. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Category">
  2769. <summary>
  2770. Gets or sets the category.
  2771. </summary>
  2772. <value>The category value</value>
  2773. </member>
  2774. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCategory">
  2775. <summary>
  2776. Removes the category.
  2777. </summary>
  2778. </member>
  2779. <member name="P:NPOI.HPSF.DocumentSummaryInformation.PresentationFormat">
  2780. <summary>
  2781. Gets or sets the presentation format (or null).
  2782. </summary>
  2783. <value>The presentation format value</value>
  2784. </member>
  2785. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemovePresentationFormat">
  2786. <summary>
  2787. Removes the presentation format.
  2788. </summary>
  2789. </member>
  2790. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ByteCount">
  2791. <summary>
  2792. Gets or sets the byte count or 0 if the {@link
  2793. DocumentSummaryInformation} does not contain a byte count.
  2794. </summary>
  2795. <value>The byteCount value</value>
  2796. </member>
  2797. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveByteCount">
  2798. <summary>
  2799. Removes the byte count.
  2800. </summary>
  2801. </member>
  2802. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LineCount">
  2803. <summary>
  2804. Gets or sets the line count or 0 if the {@link
  2805. DocumentSummaryInformation} does not contain a line count.
  2806. </summary>
  2807. <value>The line count value.</value>
  2808. </member>
  2809. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLineCount">
  2810. <summary>
  2811. Removes the line count.
  2812. </summary>
  2813. </member>
  2814. <member name="P:NPOI.HPSF.DocumentSummaryInformation.ParCount">
  2815. <summary>
  2816. Gets or sets the par count or 0 if the {@link
  2817. DocumentSummaryInformation} does not contain a par count.
  2818. </summary>
  2819. <value>The par count value</value>
  2820. </member>
  2821. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveParCount">
  2822. <summary>
  2823. Removes the par count.
  2824. </summary>
  2825. </member>
  2826. <member name="P:NPOI.HPSF.DocumentSummaryInformation.SlideCount">
  2827. <summary>
  2828. Gets or sets the slide count or 0 if the {@link
  2829. DocumentSummaryInformation} does not contain a slide count.
  2830. </summary>
  2831. <value>The slide count value</value>
  2832. </member>
  2833. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveSlideCount">
  2834. <summary>
  2835. Removes the slide count.
  2836. </summary>
  2837. </member>
  2838. <member name="P:NPOI.HPSF.DocumentSummaryInformation.NoteCount">
  2839. <summary>
  2840. Gets or sets the note count or 0 if the {@link
  2841. DocumentSummaryInformation} does not contain a note count
  2842. </summary>
  2843. <value>The note count value</value>
  2844. </member>
  2845. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveNoteCount">
  2846. <summary>
  2847. Removes the note count.
  2848. </summary>
  2849. </member>
  2850. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HiddenCount">
  2851. <summary>
  2852. Gets or sets the hidden count or 0 if the {@link
  2853. DocumentSummaryInformation} does not contain a hidden
  2854. count.
  2855. </summary>
  2856. <value>The hidden count value.</value>
  2857. </member>
  2858. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHiddenCount">
  2859. <summary>
  2860. Removes the hidden count.
  2861. </summary>
  2862. </member>
  2863. <member name="P:NPOI.HPSF.DocumentSummaryInformation.MMClipCount">
  2864. <summary>
  2865. Returns the mmclip count or 0 if the {@link
  2866. DocumentSummaryInformation} does not contain a mmclip
  2867. count.
  2868. </summary>
  2869. <value>The mmclip count value.</value>
  2870. </member>
  2871. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveMMClipCount">
  2872. <summary>
  2873. Removes the MMClip count.
  2874. </summary>
  2875. </member>
  2876. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Scale">
  2877. <summary>
  2878. Gets or sets a value indicating whether this <see cref="T:NPOI.HPSF.DocumentSummaryInformation"/> is scale.
  2879. </summary>
  2880. <value><c>true</c> if cropping is desired; otherwise, <c>false</c>.</value>
  2881. </member>
  2882. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveScale">
  2883. <summary>
  2884. Removes the scale.
  2885. </summary>
  2886. </member>
  2887. <member name="P:NPOI.HPSF.DocumentSummaryInformation.HeadingPair">
  2888. <summary>
  2889. Gets or sets the heading pair (or null)
  2890. </summary>
  2891. <value>The heading pair value.</value>
  2892. </member>
  2893. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveHeadingPair">
  2894. <summary>
  2895. Removes the heading pair.
  2896. </summary>
  2897. </member>
  2898. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Docparts">
  2899. <summary>
  2900. Gets or sets the doc parts.
  2901. </summary>
  2902. <value>The doc parts value</value>
  2903. </member>
  2904. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveDocparts">
  2905. <summary>
  2906. Removes the doc parts.
  2907. </summary>
  2908. </member>
  2909. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Manager">
  2910. <summary>
  2911. Gets or sets the manager (or <c>null</c>).
  2912. </summary>
  2913. <value>The manager value</value>
  2914. </member>
  2915. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveManager">
  2916. <summary>
  2917. Removes the manager.
  2918. </summary>
  2919. </member>
  2920. <member name="P:NPOI.HPSF.DocumentSummaryInformation.Company">
  2921. <summary>
  2922. Gets or sets the company (or <c>null</c>).
  2923. </summary>
  2924. <value>The company value</value>
  2925. </member>
  2926. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCompany">
  2927. <summary>
  2928. Removes the company.
  2929. </summary>
  2930. </member>
  2931. <member name="P:NPOI.HPSF.DocumentSummaryInformation.LinksDirty">
  2932. <summary>
  2933. Gets or sets a value indicating whether [links dirty].
  2934. </summary>
  2935. <value><c>true</c> if the custom links are dirty.; otherwise, <c>false</c>.</value>
  2936. </member>
  2937. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveLinksDirty">
  2938. <summary>
  2939. Removes the links dirty.
  2940. </summary>
  2941. </member>
  2942. <member name="P:NPOI.HPSF.DocumentSummaryInformation.CustomProperties">
  2943. <summary>
  2944. Gets or sets the custom properties.
  2945. </summary>
  2946. <value>The custom properties.</value>
  2947. </member>
  2948. <member name="M:NPOI.HPSF.DocumentSummaryInformation.EnsureSection2">
  2949. <summary>
  2950. Creates section 2 if it is not alReady present.
  2951. </summary>
  2952. </member>
  2953. <member name="M:NPOI.HPSF.DocumentSummaryInformation.RemoveCustomProperties">
  2954. <summary>
  2955. Removes the custom properties.
  2956. </summary>
  2957. </member>
  2958. <member name="T:NPOI.HPSF.Extractor.HPSFPropertiesExtractor">
  2959. <summary>
  2960. Extracts all of the HPSF properties, both
  2961. build in and custom, returning them in
  2962. textual form.
  2963. </summary>
  2964. </member>
  2965. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.DocumentSummaryInformationText">
  2966. <summary>
  2967. Gets the document summary information text.
  2968. </summary>
  2969. <value>The document summary information text.</value>
  2970. </member>
  2971. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.SummaryInformationText">
  2972. <summary>
  2973. Gets the summary information text.
  2974. </summary>
  2975. <value>The summary information text.</value>
  2976. </member>
  2977. <member name="M:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.GetPropertiesText(NPOI.HPSF.SpecialPropertySet)">
  2978. <summary>
  2979. Gets the properties text.
  2980. </summary>
  2981. <param name="ps">The ps.</param>
  2982. <returns></returns>
  2983. </member>
  2984. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.Text">
  2985. <summary>
  2986. Return the text of all the properties defined in
  2987. the document.
  2988. </summary>
  2989. <value>All the text from the document.</value>
  2990. </member>
  2991. <member name="P:NPOI.HPSF.Extractor.HPSFPropertiesExtractor.MetadataTextExtractor">
  2992. <summary>
  2993. Returns another text extractor, which is able to
  2994. output the textual content of the document
  2995. metadata / properties, such as author and title.
  2996. </summary>
  2997. <value>The metadata text extractor.</value>
  2998. </member>
  2999. <member name="T:NPOI.HPSF.HPSFException">
  3000. <summary>
  3001. This exception is the superclass of all other checked exceptions thrown
  3002. in this package. It supports a nested "reason" throwable, i.e. an exception
  3003. that caused this one To be thrown.
  3004. @author Rainer Klute
  3005. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3006. @since 2002-02-09
  3007. </summary>
  3008. </member>
  3009. <member name="M:NPOI.HPSF.HPSFException.#ctor">
  3010. <summary>
  3011. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  3012. </summary>
  3013. </member>
  3014. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String)">
  3015. <summary>
  3016. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  3017. </summary>
  3018. <param name="msg">The message string.</param>
  3019. </member>
  3020. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.Exception)">
  3021. <summary>
  3022. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  3023. </summary>
  3024. <param name="reason">The reason, i.e. a throwable that indirectly
  3025. caused this exception.</param>
  3026. </member>
  3027. <member name="M:NPOI.HPSF.HPSFException.#ctor(System.String,System.Exception)">
  3028. <summary>
  3029. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFException"/> class.
  3030. </summary>
  3031. <param name="msg">The message string.</param>
  3032. <param name="reason">The reason, i.e. a throwable that indirectly
  3033. caused this exception.</param>
  3034. </member>
  3035. <member name="P:NPOI.HPSF.HPSFException.Reason">
  3036. <summary>
  3037. Returns the {@link Exception} that caused this exception To
  3038. be thrown or null if there was no such {@link
  3039. Exception}.
  3040. </summary>
  3041. <value>The reason.</value>
  3042. </member>
  3043. <member name="T:NPOI.HPSF.HPSFPropertiesOnlyDocument">
  3044. A version of {@link POIDocument} which allows access to the
  3045. HPSF Properties, but no other document contents.
  3046. Normally used when you want to read or alter the Document Properties,
  3047. without affecting the rest of the file
  3048. </member>
  3049. <member name="M:NPOI.HPSF.HPSFPropertiesOnlyDocument.Write(System.IO.Stream)">
  3050. Write out, with any properties changes, but nothing else
  3051. </member>
  3052. <member name="T:NPOI.HPSF.HPSFRuntimeException">
  3053. <summary>
  3054. This exception is the superclass of all other unchecked
  3055. exceptions thrown in this package. It supports a nested "reason"
  3056. throwable, i.e. an exception that caused this one To be thrown.
  3057. @author Rainer Klute
  3058. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3059. @since 2002-02-09
  3060. </summary>
  3061. </member>
  3062. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor">
  3063. <summary>
  3064. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  3065. </summary>
  3066. </member>
  3067. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String)">
  3068. <summary>
  3069. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  3070. </summary>
  3071. <param name="msg">The message string.</param>
  3072. </member>
  3073. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.Exception)">
  3074. <summary>
  3075. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  3076. </summary>
  3077. <param name="reason">The reason, i.e. a throwable that indirectly
  3078. caused this exception.</param>
  3079. </member>
  3080. <member name="M:NPOI.HPSF.HPSFRuntimeException.#ctor(System.String,System.Exception)">
  3081. <summary>
  3082. Initializes a new instance of the <see cref="T:NPOI.HPSF.HPSFRuntimeException"/> class.
  3083. </summary>
  3084. <param name="msg">The message string.</param>
  3085. <param name="reason">The reason, i.e. a throwable that indirectly
  3086. caused this exception.</param>
  3087. </member>
  3088. <member name="T:NPOI.HPSF.IllegalPropertySetDataException">
  3089. <summary>
  3090. This exception is thrown when there is an illegal value Set in a
  3091. {@link PropertySet}. For example, a {@link Variant#VT_BOOL} must
  3092. have a value of <c>-1 (true)</c> or <c>0 (false)</c>.
  3093. Any other value would trigger this exception. It supports a nested
  3094. "reason" throwable, i.e. an exception that caused this one To be
  3095. thrown.
  3096. @author Drew Varner(Drew.Varner atDomain sc.edu)
  3097. @since 2002-05-26
  3098. </summary>
  3099. </member>
  3100. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor">
  3101. <summary>
  3102. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  3103. </summary>
  3104. </member>
  3105. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String)">
  3106. <summary>
  3107. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  3108. </summary>
  3109. <param name="msg">The exception's message string</param>
  3110. </member>
  3111. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.Exception)">
  3112. <summary>
  3113. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  3114. </summary>
  3115. <param name="reason">This exception's underlying reason</param>
  3116. </member>
  3117. <member name="M:NPOI.HPSF.IllegalPropertySetDataException.#ctor(System.String,System.Exception)">
  3118. <summary>
  3119. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalPropertySetDataException"/> class.
  3120. </summary>
  3121. <param name="msg"> The exception's message string</param>
  3122. <param name="reason">This exception's underlying reason</param>
  3123. </member>
  3124. <member name="T:NPOI.HPSF.IllegalVariantTypeException">
  3125. <summary>
  3126. This exception is thrown if HPSF encounters a variant type that is illegal
  3127. in the current context.
  3128. @author Rainer Klute
  3129. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3130. @since 2004-06-21
  3131. </summary>
  3132. </member>
  3133. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  3134. <summary>
  3135. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  3136. </summary>
  3137. <param name="variantType">The unsupported variant type</param>
  3138. <param name="value">The value</param>
  3139. <param name="msg">A message string</param>
  3140. </member>
  3141. <member name="M:NPOI.HPSF.IllegalVariantTypeException.#ctor(System.Int64,System.Object)">
  3142. <summary>
  3143. Initializes a new instance of the <see cref="T:NPOI.HPSF.IllegalVariantTypeException"/> class.
  3144. </summary>
  3145. <param name="variantType">The unsupported variant type</param>
  3146. <param name="value">The value.</param>
  3147. </member>
  3148. <member name="T:NPOI.HPSF.MarkUnsupportedException">
  3149. <summary>
  3150. This exception is thrown if an {@link java.io.InputStream} does
  3151. not support the {@link java.io.InputStream#mark} operation.
  3152. @author Rainer Klute
  3153. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3154. @since 2002-02-09
  3155. </summary>
  3156. </member>
  3157. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor">
  3158. <summary>
  3159. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3160. </summary>
  3161. </member>
  3162. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String)">
  3163. <summary>
  3164. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3165. </summary>
  3166. <param name="msg">The exception's message string.</param>
  3167. </member>
  3168. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.Exception)">
  3169. <summary>
  3170. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3171. </summary>
  3172. <param name="reason">This exception's underlying reason.</param>
  3173. </member>
  3174. <member name="M:NPOI.HPSF.MarkUnsupportedException.#ctor(System.String,System.Exception)">
  3175. <summary>
  3176. Initializes a new instance of the <see cref="T:NPOI.HPSF.MarkUnsupportedException"/> class.
  3177. </summary>
  3178. <param name="msg">The exception's message string</param>
  3179. <param name="reason">This exception's underlying reason</param>
  3180. </member>
  3181. <member name="T:NPOI.HPSF.MissingSectionException">
  3182. <summary>
  3183. This exception is thrown if one of the {@link PropertySet}'s
  3184. convenience methods does not Find a required {@link Section}.
  3185. The constructors of this class are analogous To those of its
  3186. superclass and documented there.
  3187. @author Rainer Klute
  3188. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3189. @since 2006-02-08
  3190. </summary>
  3191. </member>
  3192. <member name="M:NPOI.HPSF.MissingSectionException.#ctor">
  3193. <summary>
  3194. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3195. </summary>
  3196. </member>
  3197. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String)">
  3198. <summary>
  3199. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3200. </summary>
  3201. <param name="msg">The exception's message string</param>
  3202. </member>
  3203. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.Exception)">
  3204. <summary>
  3205. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3206. </summary>
  3207. <param name="reason">This exception's underlying reason.</param>
  3208. </member>
  3209. <member name="M:NPOI.HPSF.MissingSectionException.#ctor(System.String,System.Exception)">
  3210. <summary>
  3211. Initializes a new instance of the <see cref="T:NPOI.HPSF.MissingSectionException"/> class.
  3212. </summary>
  3213. <param name="msg">The exception's message string</param>
  3214. <param name="reason">This exception's underlying reason</param>
  3215. </member>
  3216. <member name="T:NPOI.HPSF.MutableProperty">
  3217. <summary>
  3218. Adds writing capability To the {@link Property} class.
  3219. Please be aware that this class' functionality will be merged into the
  3220. {@link Property} class at a later time, so the API will Change.
  3221. @author Rainer Klute
  3222. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3223. @since 2003-08-03
  3224. </summary>
  3225. </member>
  3226. <member name="M:NPOI.HPSF.MutableProperty.#ctor">
  3227. <summary>
  3228. Creates an empty property. It must be Filled using the Set method To
  3229. be usable.
  3230. </summary>
  3231. </member>
  3232. <member name="M:NPOI.HPSF.MutableProperty.#ctor(NPOI.HPSF.Property)">
  3233. <summary>
  3234. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableProperty"/> class.
  3235. </summary>
  3236. <param name="p">The property To copy.</param>
  3237. </member>
  3238. <member name="M:NPOI.HPSF.MutableProperty.Write(System.IO.Stream,System.Int32)">
  3239. <summary>
  3240. Writes the property To an output stream.
  3241. </summary>
  3242. <param name="out1">The output stream To Write To.</param>
  3243. <param name="codepage">The codepage To use for writing non-wide strings</param>
  3244. <returns>the number of bytes written To the stream</returns>
  3245. </member>
  3246. <member name="T:NPOI.HPSF.MutablePropertySet">
  3247. <summary>
  3248. Adds writing support To the {@link PropertySet} class.
  3249. Please be aware that this class' functionality will be merged into the
  3250. {@link PropertySet} class at a later time, so the API will Change.
  3251. @author Rainer Klute
  3252. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3253. @since 2003-02-19
  3254. </summary>
  3255. </member>
  3256. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor">
  3257. <summary>
  3258. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  3259. Its primary task is To initialize the immutable field with their proper
  3260. values. It also Sets fields that might Change To reasonable defaults.
  3261. </summary>
  3262. </member>
  3263. <member name="M:NPOI.HPSF.MutablePropertySet.#ctor(NPOI.HPSF.PropertySet)">
  3264. <summary>
  3265. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutablePropertySet"/> class.
  3266. All nested elements, i.e.<c>Section</c>s and <c>Property</c> instances, will be their
  3267. mutable counterparts in the new <c>MutablePropertySet</c>.
  3268. </summary>
  3269. <param name="ps">The property Set To copy</param>
  3270. </member>
  3271. <member name="F:NPOI.HPSF.MutablePropertySet.OFFSET_HEADER">
  3272. The Length of the property Set stream header.
  3273. </member>
  3274. <member name="P:NPOI.HPSF.MutablePropertySet.ByteOrder">
  3275. <summary>
  3276. Gets or sets the "byteOrder" property.
  3277. </summary>
  3278. <value>the byteOrder value To Set</value>
  3279. </member>
  3280. <member name="P:NPOI.HPSF.MutablePropertySet.Format">
  3281. <summary>
  3282. Gets or sets the "format" property.
  3283. </summary>
  3284. <value>the format value To Set</value>
  3285. </member>
  3286. <member name="P:NPOI.HPSF.MutablePropertySet.OSVersion">
  3287. <summary>
  3288. Gets or sets the "osVersion" property
  3289. </summary>
  3290. <value>the osVersion value To Set.</value>
  3291. </member>
  3292. <member name="P:NPOI.HPSF.MutablePropertySet.ClassID">
  3293. <summary>
  3294. Gets or sets the property Set stream's low-level "class ID"
  3295. </summary>
  3296. <value>The property Set stream's low-level "class ID" field.</value>
  3297. </member>
  3298. <member name="M:NPOI.HPSF.MutablePropertySet.ClearSections">
  3299. <summary>
  3300. Removes all sections from this property Set.
  3301. </summary>
  3302. </member>
  3303. <member name="M:NPOI.HPSF.MutablePropertySet.AddSection(NPOI.HPSF.Section)">
  3304. <summary>
  3305. Adds a section To this property Set.
  3306. </summary>
  3307. <param name="section">section The {@link Section} To Add. It will be Appended
  3308. after any sections that are alReady present in the property Set
  3309. and thus become the last section.</param>
  3310. </member>
  3311. <member name="M:NPOI.HPSF.MutablePropertySet.Write(System.IO.Stream)">
  3312. <summary>
  3313. Writes the property Set To an output stream.
  3314. </summary>
  3315. <param name="out1">the output stream To Write the section To</param>
  3316. </member>
  3317. <member name="M:NPOI.HPSF.MutablePropertySet.ToInputStream">
  3318. <summary>
  3319. Returns the contents of this property set stream as an input stream.
  3320. The latter can be used for example to write the property set into a POIFS
  3321. document. The input stream represents a snapshot of the property set.
  3322. If the latter is modified while the input stream is still being
  3323. read, the modifications will not be reflected in the input stream but in
  3324. the {@link MutablePropertySet} only.
  3325. </summary>
  3326. <returns>the contents of this property set stream</returns>
  3327. </member>
  3328. <member name="M:NPOI.HPSF.MutablePropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  3329. <summary>
  3330. Writes a property Set To a document in a POI filesystem directory
  3331. </summary>
  3332. <param name="dir">The directory in the POI filesystem To Write the document To.</param>
  3333. <param name="name">The document's name. If there is alReady a document with the
  3334. same name in the directory the latter will be overwritten.</param>
  3335. </member>
  3336. <member name="T:NPOI.HPSF.MutableSection">
  3337. <summary>
  3338. Adds writing capability To the {@link Section} class.
  3339. Please be aware that this class' functionality will be merged into the
  3340. {@link Section} class at a later time, so the API will Change.
  3341. @since 2002-02-20
  3342. </summary>
  3343. </member>
  3344. <member name="F:NPOI.HPSF.MutableSection.dirty">
  3345. If the "dirty" flag is true, the section's size must be
  3346. (re-)calculated before the section is written.
  3347. </member>
  3348. <member name="F:NPOI.HPSF.MutableSection.preprops">
  3349. List To assemble the properties. Unfortunately a wrong
  3350. decision has been taken when specifying the "properties" field
  3351. as an Property[]. It should have been a {@link java.util.List}.
  3352. </member>
  3353. <member name="F:NPOI.HPSF.MutableSection.sectionBytes">
  3354. Contains the bytes making out the section. This byte array is
  3355. established when the section's size is calculated and can be reused
  3356. later. It is valid only if the "dirty" flag is false.
  3357. </member>
  3358. <member name="M:NPOI.HPSF.MutableSection.#ctor">
  3359. <summary>
  3360. Initializes a new instance of the <see cref="T:NPOI.HPSF.MutableSection"/> class.
  3361. </summary>
  3362. </member>
  3363. <member name="M:NPOI.HPSF.MutableSection.#ctor(NPOI.HPSF.Section)">
  3364. <summary>
  3365. Constructs a <c>MutableSection</c> by doing a deep copy of an
  3366. existing <c>Section</c>. All nested <c>Property</c>
  3367. instances, will be their mutable counterparts in the new
  3368. <c>MutableSection</c>.
  3369. </summary>
  3370. <param name="s">The section Set To copy</param>
  3371. </member>
  3372. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(NPOI.Util.ClassID)">
  3373. <summary>
  3374. Sets the section's format ID.
  3375. </summary>
  3376. <param name="formatID">The section's format ID</param>
  3377. </member>
  3378. <member name="M:NPOI.HPSF.MutableSection.SetFormatID(System.Byte[])">
  3379. <summary>
  3380. Sets the section's format ID.
  3381. </summary>
  3382. <param name="formatID">The section's format ID as a byte array. It components
  3383. are in big-endian format.</param>
  3384. </member>
  3385. <member name="M:NPOI.HPSF.MutableSection.SetProperties(NPOI.HPSF.Property[])">
  3386. <summary>
  3387. Sets this section's properties. Any former values are overwritten.
  3388. </summary>
  3389. <param name="properties">This section's new properties.</param>
  3390. </member>
  3391. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.String)">
  3392. <summary>
  3393. Sets the string value of the property with the specified ID.
  3394. </summary>
  3395. <param name="id">The property's ID</param>
  3396. <param name="value">The property's value. It will be written as a Unicode
  3397. string.</param>
  3398. </member>
  3399. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int32)">
  3400. <summary>
  3401. Sets the int value of the property with the specified ID.
  3402. </summary>
  3403. <param name="id">The property's ID</param>
  3404. <param name="value">The property's value.</param>
  3405. </member>
  3406. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64)">
  3407. <summary>
  3408. Sets the long value of the property with the specified ID.
  3409. </summary>
  3410. <param name="id">The property's ID</param>
  3411. <param name="value">The property's value.</param>
  3412. </member>
  3413. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Boolean)">
  3414. <summary>
  3415. Sets the bool value of the property with the specified ID.
  3416. </summary>
  3417. <param name="id">The property's ID</param>
  3418. <param name="value">The property's value.</param>
  3419. </member>
  3420. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Int64,System.Object)">
  3421. <summary>
  3422. Sets the value and the variant type of the property with the
  3423. specified ID. If a property with this ID is not yet present in
  3424. the section, it will be Added. An alReady present property with
  3425. the specified ID will be overwritten. A default mapping will be
  3426. used To choose the property's type.
  3427. </summary>
  3428. <param name="id">The property's ID.</param>
  3429. <param name="variantType">The property's variant type.</param>
  3430. <param name="value">The property's value.</param>
  3431. </member>
  3432. <member name="M:NPOI.HPSF.MutableSection.SetProperty(NPOI.HPSF.Property)">
  3433. <summary>
  3434. Sets the property.
  3435. </summary>
  3436. <param name="p">The property To be Set.</param>
  3437. </member>
  3438. <member name="M:NPOI.HPSF.MutableSection.RemoveProperty(System.Int64)">
  3439. <summary>
  3440. Removes the property.
  3441. </summary>
  3442. <param name="id">The ID of the property To be Removed</param>
  3443. </member>
  3444. <member name="M:NPOI.HPSF.MutableSection.SetPropertyBooleanValue(System.Int32,System.Boolean)">
  3445. <summary>
  3446. Sets the value of the bool property with the specified
  3447. ID.
  3448. </summary>
  3449. <param name="id">The property's ID</param>
  3450. <param name="value">The property's value</param>
  3451. </member>
  3452. <member name="P:NPOI.HPSF.MutableSection.Size">
  3453. <summary>
  3454. Returns the section's size in bytes.
  3455. </summary>
  3456. <value>The section's size in bytes.</value>
  3457. </member>
  3458. <member name="M:NPOI.HPSF.MutableSection.CalcSize">
  3459. <summary>
  3460. Calculates the section's size. It is the sum of the Lengths of the
  3461. section's header (8), the properties list (16 times the number of
  3462. properties) and the properties themselves.
  3463. </summary>
  3464. <returns>the section's Length in bytes.</returns>
  3465. </member>
  3466. <member name="M:NPOI.HPSF.MutableSection.Write(System.IO.Stream)">
  3467. <summary>
  3468. Writes this section into an output stream.
  3469. Internally this is done by writing into three byte array output
  3470. streams: one for the properties, one for the property list and one for
  3471. the section as such. The two former are Appended To the latter when they
  3472. have received all their data.
  3473. </summary>
  3474. <param name="out1">The stream To Write into.</param>
  3475. <returns>The number of bytes written, i.e. the section's size.</returns>
  3476. </member>
  3477. <member name="M:NPOI.HPSF.MutableSection.WriteDictionary(System.IO.Stream,System.Collections.IDictionary,System.Int32)">
  3478. <summary>
  3479. Writes the section's dictionary
  3480. </summary>
  3481. <param name="out1">The output stream To Write To.</param>
  3482. <param name="dictionary">The dictionary.</param>
  3483. <param name="codepage">The codepage to be used to Write the dictionary items.</param>
  3484. <returns>The number of bytes written</returns>
  3485. <remarks>
  3486. see MSDN KB: http://msdn.microsoft.com/en-us/library/aa380065(VS.85).aspx
  3487. </remarks>
  3488. </member>
  3489. <member name="P:NPOI.HPSF.MutableSection.PropertyCount">
  3490. <summary>
  3491. OverWrites the base class' method To cope with a redundancy:
  3492. the property count is maintained in a separate member variable, but
  3493. shouldn't.
  3494. </summary>
  3495. <value>The number of properties in this section.</value>
  3496. </member>
  3497. <member name="P:NPOI.HPSF.MutableSection.Properties">
  3498. <summary>
  3499. Returns this section's properties.
  3500. </summary>
  3501. <value>This section's properties.</value>
  3502. </member>
  3503. <member name="M:NPOI.HPSF.MutableSection.EnsureProperties">
  3504. <summary>
  3505. Ensures the properties.
  3506. </summary>
  3507. </member>
  3508. <member name="M:NPOI.HPSF.MutableSection.GetProperty(System.Int64)">
  3509. <summary>
  3510. Gets a property.
  3511. </summary>
  3512. <param name="id">The ID of the property To Get</param>
  3513. <returns>The property or null if there is no such property</returns>
  3514. </member>
  3515. <member name="P:NPOI.HPSF.MutableSection.Dictionary">
  3516. <summary>
  3517. Sets the section's dictionary. All keys in the dictionary must be
  3518. {@link java.lang.long} instances, all values must be
  3519. {@link java.lang.String}s. This method overWrites the properties with IDs
  3520. 0 and 1 since they are reserved for the dictionary and the dictionary's
  3521. codepage. Setting these properties explicitly might have surprising
  3522. effects. An application should never do this but always use this
  3523. method.
  3524. </summary>
  3525. <value>
  3526. the dictionary
  3527. </value>
  3528. </member>
  3529. <member name="M:NPOI.HPSF.MutableSection.SetProperty(System.Int32,System.Object)">
  3530. <summary>
  3531. Sets the property.
  3532. </summary>
  3533. <param name="id">The property ID.</param>
  3534. <param name="value">The property's value. The value's class must be one of those
  3535. supported by HPSF.</param>
  3536. </member>
  3537. <member name="M:NPOI.HPSF.MutableSection.Clear">
  3538. <summary>
  3539. Removes all properties from the section including 0 (dictionary) and
  3540. 1 (codepage).
  3541. </summary>
  3542. </member>
  3543. <member name="P:NPOI.HPSF.MutableSection.Codepage">
  3544. <summary>
  3545. Gets the section's codepage, if any.
  3546. </summary>
  3547. <value>The section's codepage if one is defined, else -1.</value>
  3548. </member>
  3549. <member name="T:NPOI.HPSF.NoFormatIDException">
  3550. <summary>
  3551. This exception is thrown if a {@link MutablePropertySet} is To be written
  3552. but does not have a formatID Set (see {@link
  3553. MutableSection#SetFormatID(ClassID)} or
  3554. {@link org.apache.poi.hpsf.MutableSection#SetFormatID(byte[])}.
  3555. @author Rainer Klute
  3556. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3557. @since 2002-09-03
  3558. </summary>
  3559. </member>
  3560. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor">
  3561. <summary>
  3562. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3563. </summary>
  3564. </member>
  3565. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String)">
  3566. <summary>
  3567. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3568. </summary>
  3569. <param name="msg">The exception's message string</param>
  3570. </member>
  3571. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.Exception)">
  3572. <summary>
  3573. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3574. </summary>
  3575. <param name="reason">This exception's underlying reason</param>
  3576. </member>
  3577. <member name="M:NPOI.HPSF.NoFormatIDException.#ctor(System.String,System.Exception)">
  3578. <summary>
  3579. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoFormatIDException"/> class.
  3580. </summary>
  3581. <param name="msg">The exception's message string</param>
  3582. <param name="reason">This exception's underlying reason</param>
  3583. </member>
  3584. <member name="T:NPOI.HPSF.NoPropertySetStreamException">
  3585. <summary>
  3586. This exception is thrown if a format error in a property Set stream Is
  3587. detected or when the input data do not constitute a property Set stream.
  3588. The constructors of this class are analogous To those of its superclass
  3589. and are documented there.
  3590. @author Rainer Klute
  3591. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3592. @since 2002-02-09
  3593. </summary>
  3594. </member>
  3595. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor">
  3596. <summary>
  3597. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3598. </summary>
  3599. </member>
  3600. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String)">
  3601. <summary>
  3602. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3603. </summary>
  3604. <param name="msg">The exception's message string</param>
  3605. </member>
  3606. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.Exception)">
  3607. <summary>
  3608. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3609. </summary>
  3610. <param name="reason">This exception's underlying reason</param>
  3611. </member>
  3612. <member name="M:NPOI.HPSF.NoPropertySetStreamException.#ctor(System.String,System.Exception)">
  3613. <summary>
  3614. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoPropertySetStreamException"/> class.
  3615. </summary>
  3616. <param name="msg">The exception's message string</param>
  3617. <param name="reason">This exception's underlying reason</param>
  3618. </member>
  3619. <member name="T:NPOI.HPSF.NoSingleSectionException">
  3620. <summary>
  3621. This exception is thrown if one of the {@link PropertySet}'s
  3622. convenience methods that require a single {@link Section} is called
  3623. and the {@link PropertySet} does not contain exactly one {@link
  3624. Section}.
  3625. The constructors of this class are analogous To those of its
  3626. superclass and documented there.
  3627. @author Rainer Klute
  3628. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3629. @since 2002-02-09
  3630. </summary>
  3631. </member>
  3632. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor">
  3633. <summary>
  3634. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3635. </summary>
  3636. </member>
  3637. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String)">
  3638. <summary>
  3639. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3640. </summary>
  3641. <param name="msg">The exception's message string</param>
  3642. </member>
  3643. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.Exception)">
  3644. <summary>
  3645. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3646. </summary>
  3647. <param name="reason">This exception's underlying reason</param>
  3648. </member>
  3649. <member name="M:NPOI.HPSF.NoSingleSectionException.#ctor(System.String,System.Exception)">
  3650. <summary>
  3651. Initializes a new instance of the <see cref="T:NPOI.HPSF.NoSingleSectionException"/> class.
  3652. </summary>
  3653. <param name="msg">The exception's message string</param>
  3654. <param name="reason">This exception's underlying reason</param>
  3655. </member>
  3656. <member name="T:NPOI.HPSF.Property">
  3657. <summary>
  3658. A property in a {@link Section} of a {@link PropertySet}.
  3659. The property's ID gives the property a meaning
  3660. in the context of its {@link Section}. Each {@link Section} spans
  3661. its own name space of property IDs.
  3662. The property's type determines how its
  3663. value is interpreted. For example, if the type Is
  3664. {@link Variant#VT_LPSTR} (byte string), the value consists of a
  3665. DWord telling how many bytes the string Contains. The bytes follow
  3666. immediately, including any null bytes that terminate the
  3667. string. The type {@link Variant#VT_I4} denotes a four-byte integer
  3668. value, {@link Variant#VT_FILETIME} some DateTime and time (of a
  3669. file).
  3670. Please note that not all {@link Variant} types yet. This might Change
  3671. over time but largely depends on your feedback so that the POI team knows
  3672. which variant types are really needed. So please feel free To submit error
  3673. reports or patches for the types you need.
  3674. Microsoft documentation:
  3675. <a href="http://msdn.microsoft.com/library/en-us/stg/stg/property_Set_display_name_dictionary.asp?frame=true">
  3676. Property Set Display Name Dictionary</a>
  3677. .
  3678. @author Rainer Klute
  3679. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3680. @author Drew Varner (Drew.Varner InAndAround sc.edu)
  3681. @see Section
  3682. @see Variant
  3683. @since 2002-02-09
  3684. </summary>
  3685. </member>
  3686. <member name="F:NPOI.HPSF.Property.id">
  3687. The property's ID.
  3688. </member>
  3689. <member name="P:NPOI.HPSF.Property.ID">
  3690. Returns the property's ID.
  3691. @return The ID value
  3692. </member>
  3693. <member name="F:NPOI.HPSF.Property.type">
  3694. The property's type.
  3695. </member>
  3696. <member name="P:NPOI.HPSF.Property.Type">
  3697. Returns the property's type.
  3698. @return The type value
  3699. </member>
  3700. <member name="F:NPOI.HPSF.Property.value">
  3701. The property's value.
  3702. </member>
  3703. <member name="P:NPOI.HPSF.Property.Value">
  3704. <summary>
  3705. Gets the property's value.
  3706. </summary>
  3707. <value>The property's value</value>
  3708. </member>
  3709. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Int64,System.Object)">
  3710. <summary>
  3711. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3712. </summary>
  3713. <param name="id">the property's ID.</param>
  3714. <param name="type">the property's type, see {@link Variant}.</param>
  3715. <param name="value">the property's value. Only certain types are allowed, see
  3716. {@link Variant}.</param>
  3717. </member>
  3718. <member name="M:NPOI.HPSF.Property.#ctor(System.Int64,System.Byte[],System.Int64,System.Int32,System.Int32)">
  3719. <summary>
  3720. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3721. </summary>
  3722. <param name="id">The property's ID.</param>
  3723. <param name="src">The bytes the property Set stream consists of.</param>
  3724. <param name="offset">The property's type/value pair's offset in the
  3725. section.</param>
  3726. <param name="Length">The property's type/value pair's Length in bytes.</param>
  3727. <param name="codepage">The section's and thus the property's
  3728. codepage. It is needed only when Reading string values</param>
  3729. </member>
  3730. <member name="M:NPOI.HPSF.Property.#ctor">
  3731. <summary>
  3732. Initializes a new instance of the <see cref="T:NPOI.HPSF.Property"/> class.
  3733. </summary>
  3734. </member>
  3735. <member name="M:NPOI.HPSF.Property.ReadDictionary(System.Byte[],System.Int64,System.Int32,System.Int32)">
  3736. <summary>
  3737. Reads the dictionary.
  3738. </summary>
  3739. <param name="src">The byte array containing the bytes making out the dictionary.</param>
  3740. <param name="offset">At this offset within src the dictionary starts.</param>
  3741. <param name="Length">The dictionary Contains at most this many bytes.</param>
  3742. <param name="codepage">The codepage of the string values.</param>
  3743. <returns>The dictonary</returns>
  3744. </member>
  3745. <member name="P:NPOI.HPSF.Property.Count">
  3746. <summary>
  3747. Gets the property's size in bytes. This is always a multiple of
  3748. 4.
  3749. </summary>
  3750. <value>the property's size in bytes</value>
  3751. </member>
  3752. <member name="M:NPOI.HPSF.Property.Equals(System.Object)">
  3753. <summary>
  3754. Compares two properties.
  3755. Please beware that a property with
  3756. ID == 0 is a special case: It does not have a type, and its value is the
  3757. section's dictionary. Another special case are strings: Two properties
  3758. may have the different types Variant.VT_LPSTR and Variant.VT_LPWSTR;
  3759. </summary>
  3760. <param name="o">The o.</param>
  3761. <returns></returns>
  3762. </member>
  3763. <member name="M:NPOI.HPSF.Property.TypesAreEqual(System.Int64,System.Int64)">
  3764. <summary>
  3765. Typeses the are equal.
  3766. </summary>
  3767. <param name="t1">The t1.</param>
  3768. <param name="t2">The t2.</param>
  3769. <returns></returns>
  3770. </member>
  3771. <member name="M:NPOI.HPSF.Property.GetHashCode">
  3772. <summary>
  3773. Serves as a hash function for a particular type.
  3774. </summary>
  3775. <returns>
  3776. A hash code for the current <see cref="T:System.Object"/>.
  3777. </returns>
  3778. </member>
  3779. <member name="M:NPOI.HPSF.Property.ToString">
  3780. <summary>
  3781. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3782. </summary>
  3783. <returns>
  3784. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  3785. </returns>
  3786. </member>
  3787. <member name="T:NPOI.HPSF.PropertySet">
  3788. <summary>
  3789. Represents a property Set in the Horrible Property Set Format
  3790. (HPSF). These are usually metadata of a Microsoft Office
  3791. document.
  3792. An application that wants To access these metadata should Create
  3793. an instance of this class or one of its subclasses by calling the
  3794. factory method {@link PropertySetFactory#Create} and then retrieve
  3795. the information its needs by calling appropriate methods.
  3796. {@link PropertySetFactory#Create} does its work by calling one
  3797. of the constructors {@link PropertySet#PropertySet(InputStream)} or
  3798. {@link PropertySet#PropertySet(byte[])}. If the constructor's
  3799. argument is not in the Horrible Property Set Format, i.e. not a
  3800. property Set stream, or if any other error occurs, an appropriate
  3801. exception is thrown.
  3802. A {@link PropertySet} has a list of {@link Section}s, and each
  3803. {@link Section} has a {@link Property} array. Use {@link
  3804. #GetSections} To retrieve the {@link Section}s, then call {@link
  3805. Section#GetProperties} for each {@link Section} To Get hold of the
  3806. {@link Property} arrays. Since the vast majority of {@link
  3807. PropertySet}s Contains only a single {@link Section}, the
  3808. convenience method {@link #GetProperties} returns the properties of
  3809. a {@link PropertySet}'s {@link Section} (throwing a {@link
  3810. NoSingleSectionException} if the {@link PropertySet} Contains more
  3811. (or less) than exactly one {@link Section}).
  3812. @author Rainer Klute
  3813. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  3814. @author Drew Varner (Drew.Varner hanginIn sc.edu)
  3815. @since 2002-02-09
  3816. </summary>
  3817. </member>
  3818. <member name="F:NPOI.HPSF.PropertySet.BYTE_ORDER_ASSERTION">
  3819. The "byteOrder" field must equal this value.
  3820. </member>
  3821. <member name="F:NPOI.HPSF.PropertySet.byteOrder">
  3822. Specifies this {@link PropertySet}'s byte order. See the
  3823. HPFS documentation for details!
  3824. </member>
  3825. <member name="P:NPOI.HPSF.PropertySet.ByteOrder">
  3826. <summary>
  3827. Gets or sets the property Set stream's low-level "byte order"
  3828. field. It is always <c>0xFFFE</c>
  3829. </summary>
  3830. <value>The property Set stream's low-level "byte order" field..</value>
  3831. </member>
  3832. <member name="F:NPOI.HPSF.PropertySet.FORMAT_ASSERTION">
  3833. The "format" field must equal this value.
  3834. </member>
  3835. <member name="F:NPOI.HPSF.PropertySet.format">
  3836. Specifies this {@link PropertySet}'s format. See the HPFS
  3837. documentation for details!
  3838. </member>
  3839. <member name="P:NPOI.HPSF.PropertySet.Format">
  3840. <summary>
  3841. Gets or sets the property Set stream's low-level "format"
  3842. field. It is always <c>0x0000</c>
  3843. </summary>
  3844. <value>The property Set stream's low-level "format" field.</value>
  3845. </member>
  3846. <member name="F:NPOI.HPSF.PropertySet.osVersion">
  3847. Specifies the version of the operating system that Created
  3848. this {@link PropertySet}. See the HPFS documentation for
  3849. details!
  3850. </member>
  3851. <member name="F:NPOI.HPSF.PropertySet.OS_WIN16">
  3852. If the OS version field holds this value the property Set stream Was
  3853. Created on a 16-bit Windows system.
  3854. </member>
  3855. <member name="F:NPOI.HPSF.PropertySet.OS_MACINTOSH">
  3856. If the OS version field holds this value the property Set stream Was
  3857. Created on a Macintosh system.
  3858. </member>
  3859. <member name="F:NPOI.HPSF.PropertySet.OS_WIN32">
  3860. If the OS version field holds this value the property Set stream Was
  3861. Created on a 32-bit Windows system.
  3862. </member>
  3863. <member name="P:NPOI.HPSF.PropertySet.OSVersion">
  3864. <summary>
  3865. Returns the property Set stream's low-level "OS version"
  3866. field.
  3867. </summary>
  3868. <value>The property Set stream's low-level "OS version" field.</value>
  3869. </member>
  3870. <member name="F:NPOI.HPSF.PropertySet.classID">
  3871. Specifies this {@link PropertySet}'s "classID" field. See
  3872. the HPFS documentation for details!
  3873. </member>
  3874. <member name="P:NPOI.HPSF.PropertySet.ClassID">
  3875. <summary>
  3876. Gets or sets the property Set stream's low-level "class ID"
  3877. </summary>
  3878. <value>The property Set stream's low-level "class ID" field.</value>
  3879. </member>
  3880. <member name="P:NPOI.HPSF.PropertySet.SectionCount">
  3881. <summary>
  3882. Returns the number of {@link Section}s in the property
  3883. Set.
  3884. </summary>
  3885. <value>The number of {@link Section}s in the property Set.</value>
  3886. </member>
  3887. <member name="F:NPOI.HPSF.PropertySet.sections">
  3888. The sections in this {@link PropertySet}.
  3889. </member>
  3890. <member name="P:NPOI.HPSF.PropertySet.Sections">
  3891. <summary>
  3892. Returns the {@link Section}s in the property Set.
  3893. </summary>
  3894. <value>{@link Section}s in the property Set.</value>
  3895. </member>
  3896. <member name="M:NPOI.HPSF.PropertySet.#ctor">
  3897. <summary>
  3898. Creates an empty (uninitialized) {@link PropertySet}
  3899. Please note: For the time being this
  3900. constructor is protected since it is used for internal purposes
  3901. only, but expect it To become public once the property Set's
  3902. writing functionality is implemented.
  3903. </summary>
  3904. </member>
  3905. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.IO.Stream)">
  3906. <summary>
  3907. Creates a {@link PropertySet} instance from an {@link
  3908. InputStream} in the Horrible Property Set Format.
  3909. The constructor Reads the first few bytes from the stream
  3910. and determines whether it is really a property Set stream. If
  3911. it Is, it parses the rest of the stream. If it is not, it
  3912. Resets the stream To its beginning in order To let other
  3913. components mess around with the data and throws an
  3914. exception.
  3915. </summary>
  3916. <param name="stream">Holds the data making out the property Set
  3917. stream.</param>
  3918. </member>
  3919. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[],System.Int32,System.Int32)">
  3920. <summary>
  3921. Creates a {@link PropertySet} instance from a byte array
  3922. that represents a stream in the Horrible Property Set
  3923. Format.
  3924. </summary>
  3925. <param name="stream">The byte array holding the stream data.</param>
  3926. <param name="offset">The offset in stream where the stream data begin.
  3927. If the stream data begin with the first byte in the
  3928. array, the offset is 0.</param>
  3929. <param name="Length"> The Length of the stream data.</param>
  3930. </member>
  3931. <member name="M:NPOI.HPSF.PropertySet.#ctor(System.Byte[])">
  3932. <summary>
  3933. Creates a {@link PropertySet} instance from a byte array
  3934. that represents a stream in the Horrible Property Set
  3935. Format.
  3936. </summary>
  3937. <param name="stream">The byte array holding the stream data. The
  3938. complete byte array contents is the stream data.</param>
  3939. </member>
  3940. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.IO.Stream)">
  3941. <summary>
  3942. Checks whether an {@link InputStream} is in the Horrible
  3943. Property Set Format.
  3944. </summary>
  3945. <param name="stream">The {@link InputStream} To check. In order To
  3946. perform the check, the method Reads the first bytes from the
  3947. stream. After Reading, the stream is Reset To the position it
  3948. had before Reading. The {@link InputStream} must support the
  3949. {@link InputStream#mark} method.</param>
  3950. <returns>
  3951. <c>true</c> if the stream is a property Set
  3952. stream; otherwise, <c>false</c>.
  3953. </returns>
  3954. </member>
  3955. <member name="M:NPOI.HPSF.PropertySet.IsPropertySetStream(System.Byte[],System.Int32,System.Int32)">
  3956. <summary>
  3957. Checks whether a byte array is in the Horrible Property Set
  3958. Format.
  3959. </summary>
  3960. <param name="src">The byte array To check.</param>
  3961. <param name="offset">The offset in the byte array.</param>
  3962. <param name="Length">The significant number of bytes in the byte
  3963. array. Only this number of bytes will be checked.</param>
  3964. <returns>
  3965. <c>true</c> if the byte array is a property Set
  3966. stream; otherwise, <c>false</c>.
  3967. </returns>
  3968. </member>
  3969. <member name="M:NPOI.HPSF.PropertySet.init(System.Byte[],System.Int32,System.Int32)">
  3970. <summary>
  3971. Initializes this {@link PropertySet} instance from a byte
  3972. array. The method assumes that it has been checked alReady that
  3973. the byte array indeed represents a property Set stream. It does
  3974. no more checks on its own.
  3975. </summary>
  3976. <param name="src">Byte array containing the property Set stream</param>
  3977. <param name="offset">The property Set stream starts at this offset</param>
  3978. <param name="Length">Length of the property Set stream.</param>
  3979. </member>
  3980. <member name="P:NPOI.HPSF.PropertySet.IsSummaryInformation">
  3981. <summary>
  3982. Checks whether this {@link PropertySet} represents a Summary
  3983. Information.
  3984. </summary>
  3985. <value>
  3986. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  3987. Information; otherwise, <c>false</c>.
  3988. </value>
  3989. </member>
  3990. <member name="P:NPOI.HPSF.PropertySet.IsDocumentSummaryInformation">
  3991. <summary>
  3992. Gets a value indicating whether this instance is document summary information.
  3993. </summary>
  3994. <value>
  3995. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  3996. </value>
  3997. Checks whether this {@link PropertySet} is a Document
  3998. Summary Information.
  3999. @return
  4000. <c>true</c>
  4001. if this {@link PropertySet}
  4002. represents a Document Summary Information, else
  4003. <c>false</c>
  4004. </member>
  4005. <member name="P:NPOI.HPSF.PropertySet.Properties">
  4006. <summary>
  4007. Convenience method returning the {@link Property} array
  4008. contained in this property Set. It is a shortcut for Getting
  4009. the {@link PropertySet}'s {@link Section}s list and then
  4010. Getting the {@link Property} array from the first {@link
  4011. Section}.
  4012. </summary>
  4013. <value>The properties of the only {@link Section} of this
  4014. {@link PropertySet}.</value>
  4015. </member>
  4016. <member name="M:NPOI.HPSF.PropertySet.GetProperty(System.Int32)">
  4017. <summary>
  4018. Convenience method returning the value of the property with
  4019. the specified ID. If the property is not available,
  4020. <c>null</c> is returned and a subsequent call To {@link
  4021. #WasNull} will return <c>true</c> .
  4022. </summary>
  4023. <param name="id">The property ID</param>
  4024. <returns>The property value</returns>
  4025. </member>
  4026. <member name="M:NPOI.HPSF.PropertySet.GetPropertyBooleanValue(System.Int32)">
  4027. <summary>
  4028. Convenience method returning the value of a bool property
  4029. with the specified ID. If the property is not available,
  4030. <c>false</c> is returned. A subsequent call To {@link
  4031. #WasNull} will return <c>true</c> To let the caller
  4032. distinguish that case from a real property value of
  4033. <c>false</c>.
  4034. </summary>
  4035. <param name="id">The property ID</param>
  4036. <returns>The property value</returns>
  4037. </member>
  4038. <member name="M:NPOI.HPSF.PropertySet.GetPropertyIntValue(System.Int32)">
  4039. <summary>
  4040. Convenience method returning the value of the numeric
  4041. property with the specified ID. If the property is not
  4042. available, 0 is returned. A subsequent call To {@link #WasNull}
  4043. will return <c>true</c> To let the caller distinguish
  4044. that case from a real property value of 0.
  4045. </summary>
  4046. <param name="id">The property ID</param>
  4047. <returns>The propertyIntValue value</returns>
  4048. </member>
  4049. <member name="P:NPOI.HPSF.PropertySet.WasNull">
  4050. <summary>
  4051. Checks whether the property which the last call To {@link
  4052. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4053. Was available or not. This information might be important for
  4054. callers of {@link #GetPropertyIntValue} since the latter
  4055. returns 0 if the property does not exist. Using {@link
  4056. #WasNull}, the caller can distiguish this case from a
  4057. property's real value of 0.
  4058. </summary>
  4059. <value><c>true</c> if the last call To {@link
  4060. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4061. property that Was not available; otherwise, <c>false</c>.</value>
  4062. </member>
  4063. <member name="P:NPOI.HPSF.PropertySet.FirstSection">
  4064. <summary>
  4065. Gets the first section.
  4066. </summary>
  4067. <value>The first section.</value>
  4068. </member>
  4069. <member name="P:NPOI.HPSF.PropertySet.SingleSection">
  4070. <summary>
  4071. If the {@link PropertySet} has only a single section this
  4072. method returns it.
  4073. </summary>
  4074. <value>The singleSection value</value>
  4075. </member>
  4076. <member name="M:NPOI.HPSF.PropertySet.Equals(System.Object)">
  4077. <summary>
  4078. Returns <c>true</c> if the <c>PropertySet</c> is equal
  4079. To the specified parameter, else <c>false</c>.
  4080. </summary>
  4081. <param name="o">the object To Compare this
  4082. <c>PropertySet</c>
  4083. with</param>
  4084. <returns><c>true</c>
  4085. if the objects are equal,
  4086. <c>false</c>
  4087. if not</returns>
  4088. </member>
  4089. <member name="M:NPOI.HPSF.PropertySet.GetHashCode">
  4090. <summary>
  4091. Serves as a hash function for a particular type.
  4092. </summary>
  4093. <returns>
  4094. A hash code for the current <see cref="T:System.Object"/>.
  4095. </returns>
  4096. </member>
  4097. <member name="M:NPOI.HPSF.PropertySet.ToString">
  4098. <summary>
  4099. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4100. </summary>
  4101. <returns>
  4102. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4103. </returns>
  4104. </member>
  4105. <member name="T:NPOI.HPSF.PropertySetFactory">
  4106. <summary>
  4107. Factory class To Create instances of {@link SummaryInformation},
  4108. {@link DocumentSummaryInformation} and {@link PropertySet}.
  4109. @author Rainer Klute
  4110. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4111. @since 2002-02-09
  4112. </summary>
  4113. </member>
  4114. <member name="M:NPOI.HPSF.PropertySetFactory.Create(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  4115. <p>Creates the most specific {@link PropertySet} from an entry
  4116. in the specified POIFS Directory. This is preferrably a {@link
  4117. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  4118. the specified entry does not contain a property Set stream, an
  4119. exception is thrown. If no entry is found with the given name,
  4120. an exception is thrown.</p>
  4121. @param dir The directory to find the PropertySet in
  4122. @param name The name of the entry Containing the PropertySet
  4123. @return The Created {@link PropertySet}.
  4124. @if there is no entry with that name
  4125. @if the stream does not
  4126. contain a property Set.
  4127. @if some I/O problem occurs.
  4128. @exception EncoderFallbackException if the specified codepage is not
  4129. supported.
  4130. </member>
  4131. <member name="M:NPOI.HPSF.PropertySetFactory.Create(System.IO.Stream)">
  4132. <summary>
  4133. Creates the most specific {@link PropertySet} from an {@link
  4134. InputStream}. This is preferrably a {@link
  4135. DocumentSummaryInformation} or a {@link SummaryInformation}. If
  4136. the specified {@link InputStream} does not contain a property
  4137. Set stream, an exception is thrown and the {@link InputStream}
  4138. is repositioned at its beginning.
  4139. </summary>
  4140. <param name="stream">Contains the property set stream's data.</param>
  4141. <returns>The Created {@link PropertySet}.</returns>
  4142. </member>
  4143. <member name="M:NPOI.HPSF.PropertySetFactory.CreateSummaryInformation">
  4144. <summary>
  4145. Creates a new summary information
  4146. </summary>
  4147. <returns>the new summary information.</returns>
  4148. </member>
  4149. <member name="M:NPOI.HPSF.PropertySetFactory.CreateDocumentSummaryInformation">
  4150. <summary>
  4151. Creates a new document summary information.
  4152. </summary>
  4153. <returns>the new document summary information.</returns>
  4154. </member>
  4155. <member name="T:NPOI.HPSF.ReadingNotSupportedException">
  4156. <summary>
  4157. This exception is thrown when HPSF tries To Read a (yet) unsupported
  4158. variant type.
  4159. @see WritingNotSupportedException
  4160. @see UnsupportedVariantTypeException
  4161. @author Rainer Klute
  4162. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4163. @since 2003-08-08
  4164. </summary>
  4165. </member>
  4166. <member name="M:NPOI.HPSF.ReadingNotSupportedException.#ctor(System.Int64,System.Object)">
  4167. <summary>
  4168. Initializes a new instance of the <see cref="T:NPOI.HPSF.ReadingNotSupportedException"/> class.
  4169. </summary>
  4170. <param name="variantType">The unsupported variant type</param>
  4171. <param name="value">The value who's variant type is not yet supported</param>
  4172. </member>
  4173. <member name="T:NPOI.HPSF.Section">
  4174. <summary>
  4175. Represents a section in a {@link PropertySet}.
  4176. @author Rainer Klute
  4177. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4178. @author Drew Varner (Drew.Varner allUpIn sc.edu)
  4179. @since 2002-02-09
  4180. </summary>
  4181. </member>
  4182. <member name="F:NPOI.HPSF.Section.dictionary">
  4183. Maps property IDs To section-private PID strings. These
  4184. strings can be found in the property with ID 0.
  4185. </member>
  4186. <member name="F:NPOI.HPSF.Section.formatID">
  4187. The section's format ID, {@link #GetFormatID}.
  4188. </member>
  4189. <member name="P:NPOI.HPSF.Section.FormatID">
  4190. <summary>
  4191. Returns the format ID. The format ID is the "type" of the
  4192. section. For example, if the format ID of the first {@link
  4193. Section} Contains the bytes specified by
  4194. <c>org.apache.poi.hpsf.wellknown.SectionIDMap.SUMMARY_INFORMATION_ID</c>
  4195. the section (and thus the property Set) is a SummaryInformation.
  4196. </summary>
  4197. <value>The format ID.</value>
  4198. </member>
  4199. <member name="P:NPOI.HPSF.Section.OffSet">
  4200. <summary>
  4201. Gets the offset of the section in the stream.
  4202. </summary>
  4203. <value>The offset of the section in the stream</value>
  4204. </member>
  4205. <member name="P:NPOI.HPSF.Section.Size">
  4206. <summary>
  4207. Returns the section's size in bytes.
  4208. </summary>
  4209. <value>The section's size in bytes.</value>
  4210. </member>
  4211. <member name="P:NPOI.HPSF.Section.PropertyCount">
  4212. <summary>
  4213. Returns the number of properties in this section.
  4214. </summary>
  4215. <value>The number of properties in this section.</value>
  4216. </member>
  4217. <member name="P:NPOI.HPSF.Section.Properties">
  4218. <summary>
  4219. Returns this section's properties.
  4220. </summary>
  4221. <value>This section's properties.</value>
  4222. </member>
  4223. <member name="M:NPOI.HPSF.Section.#ctor">
  4224. <summary>
  4225. Creates an empty and uninitialized {@link Section}.
  4226. </summary>
  4227. </member>
  4228. <member name="M:NPOI.HPSF.Section.#ctor(System.Byte[],System.Int32)">
  4229. <summary>
  4230. Creates a {@link Section} instance from a byte array.
  4231. </summary>
  4232. <param name="src">Contains the complete property Set stream.</param>
  4233. <param name="offset">The position in the stream that points To the
  4234. section's format ID.</param>
  4235. </member>
  4236. <member name="T:NPOI.HPSF.Section.PropertyListEntry">
  4237. Represents an entry in the property list and holds a property's ID and
  4238. its offset from the section's beginning.
  4239. </member>
  4240. <member name="M:NPOI.HPSF.Section.PropertyListEntry.CompareTo(System.Object)">
  4241. Compares this {@link PropertyListEntry} with another one by their
  4242. offsets. A {@link PropertyListEntry} is "smaller" than another one if
  4243. its offset from the section's begin is smaller.
  4244. @see Comparable#CompareTo(java.lang.Object)
  4245. </member>
  4246. <member name="M:NPOI.HPSF.Section.GetProperty(System.Int64)">
  4247. Returns the value of the property with the specified ID. If
  4248. the property is not available, <c>null</c> is returned
  4249. and a subsequent call To {@link #wasNull} will return
  4250. <c>true</c>.
  4251. @param id The property's ID
  4252. @return The property's value
  4253. </member>
  4254. <member name="M:NPOI.HPSF.Section.GetPropertyIntValue(System.Int64)">
  4255. Returns the value of the numeric property with the specified
  4256. ID. If the property is not available, 0 is returned. A
  4257. subsequent call To {@link #wasNull} will return
  4258. <c>true</c> To let the caller distinguish that case from
  4259. a real property value of 0.
  4260. @param id The property's ID
  4261. @return The property's value
  4262. </member>
  4263. <member name="M:NPOI.HPSF.Section.GetPropertyBooleanValue(System.Int32)">
  4264. Returns the value of the bool property with the specified
  4265. ID. If the property is not available, <c>false</c> Is
  4266. returned. A subsequent call To {@link #wasNull} will return
  4267. <c>true</c> To let the caller distinguish that case from
  4268. a real property value of <c>false</c>.
  4269. @param id The property's ID
  4270. @return The property's value
  4271. </member>
  4272. <member name="F:NPOI.HPSF.Section.wasNull">
  4273. This member is <c>true</c> if the last call To {@link
  4274. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4275. property that was not available, else <c>false</c>.
  4276. </member>
  4277. <member name="P:NPOI.HPSF.Section.WasNull">
  4278. <summary>
  4279. Checks whether the property which the last call To {@link
  4280. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4281. was available or not. This information might be important for
  4282. callers of {@link #GetPropertyIntValue} since the latter
  4283. returns 0 if the property does not exist. Using {@link
  4284. #wasNull} the caller can distiguish this case from a property's
  4285. real value of 0.
  4286. </summary>
  4287. <value><c>true</c> if the last call To {@link
  4288. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4289. property that was not available; otherwise, <c>false</c>.</value>
  4290. </member>
  4291. <member name="M:NPOI.HPSF.Section.GetPIDString(System.Int64)">
  4292. <summary>
  4293. Returns the PID string associated with a property ID. The ID
  4294. is first looked up in the {@link Section}'s private
  4295. dictionary. If it is not found there, the method calls {@link
  4296. SectionIDMap#GetPIDString}.
  4297. </summary>
  4298. <param name="pid">The property ID.</param>
  4299. <returns>The property ID's string value</returns>
  4300. </member>
  4301. <member name="M:NPOI.HPSF.Section.Equals(System.Object)">
  4302. Checks whether this section is equal To another object. The result Is
  4303. <c>false</c> if one of the the following conditions holds:
  4304. <ul>
  4305. <li>The other object is not a {@link Section}.</li>
  4306. <li>The format IDs of the two sections are not equal.</li>
  4307. <li>The sections have a different number of properties. However,
  4308. properties with ID 1 (codepage) are not counted.</li>
  4309. <li>The other object is not a {@link Section}.</li>
  4310. <li>The properties have different values. The order of the properties
  4311. is irrelevant.</li>
  4312. </ul>
  4313. @param o The object To Compare this section with
  4314. @return <c>true</c> if the objects are equal, <c>false</c> if
  4315. not
  4316. </member>
  4317. <member name="M:NPOI.HPSF.Section.Remove(NPOI.HPSF.Property[],System.Int32)">
  4318. <summary>
  4319. Removes a field from a property array. The resulting array Is
  4320. compactified and returned.
  4321. </summary>
  4322. <param name="pa">The property array.</param>
  4323. <param name="i">The index of the field To be Removed.</param>
  4324. <returns>the compactified array.</returns>
  4325. </member>
  4326. <member name="M:NPOI.HPSF.Section.GetHashCode">
  4327. <summary>
  4328. Serves as a hash function for a particular type.
  4329. </summary>
  4330. <returns>
  4331. A hash code for the current <see cref="T:System.Object"/>.
  4332. </returns>
  4333. </member>
  4334. <member name="M:NPOI.HPSF.Section.ToString">
  4335. <summary>
  4336. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4337. </summary>
  4338. <returns>
  4339. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4340. </returns>
  4341. </member>
  4342. <member name="P:NPOI.HPSF.Section.Dictionary">
  4343. <summary>
  4344. Gets the section's dictionary. A dictionary allows an application To
  4345. use human-Readable property names instead of numeric property IDs. It
  4346. Contains mappings from property IDs To their associated string
  4347. values. The dictionary is stored as the property with ID 0. The codepage
  4348. for the strings in the dictionary is defined by property with ID 1.
  4349. </summary>
  4350. <value>the dictionary or null
  4351. if the section does not have
  4352. a dictionary.</value>
  4353. </member>
  4354. <member name="P:NPOI.HPSF.Section.Codepage">
  4355. <summary>
  4356. Gets the section's codepage, if any.
  4357. </summary>
  4358. <value>The section's codepage if one is defined, else -1.</value>
  4359. </member>
  4360. <member name="T:NPOI.HPSF.SpecialPropertySet">
  4361. <summary>
  4362. Abstract superclass for the convenience classes {@link
  4363. SummaryInformation} and {@link DocumentSummaryInformation}.
  4364. The motivation behind this class is quite nasty if you look
  4365. behind the scenes, but it serves the application programmer well by
  4366. providing him with the easy-to-use {@link SummaryInformation} and
  4367. {@link DocumentSummaryInformation} classes. When parsing the data a
  4368. property Set stream consists of (possibly coming from an {@link
  4369. java.io.Stream}) we want To Read and process each byte only
  4370. once. Since we don't know in advance which kind of property Set we
  4371. have, we can expect only the most general {@link
  4372. PropertySet}. Creating a special subclass should be as easy as
  4373. calling the special subclass' constructor and pass the general
  4374. {@link PropertySet} in. To make things easy internally, the special
  4375. class just holds a reference To the general {@link PropertySet} and
  4376. delegates all method calls To it.
  4377. A cleaner implementation would have been like this: The {@link
  4378. PropertySetFactory} parses the stream data into some internal
  4379. object first. Then it Finds out whether the stream is a {@link
  4380. SummaryInformation}, a {@link DocumentSummaryInformation} or a
  4381. general {@link PropertySet}. However, the current implementation
  4382. went the other way round historically: the convenience classes came
  4383. only late To my mind.
  4384. @author Rainer Klute
  4385. klute@rainer-klute.de
  4386. @since 2002-02-09
  4387. </summary>
  4388. </member>
  4389. <member name="P:NPOI.HPSF.SpecialPropertySet.PropertySetIDMap">
  4390. The id to name mapping of the properties
  4391. in this set.
  4392. </member>
  4393. <member name="F:NPOI.HPSF.SpecialPropertySet.delegate1">
  4394. The "real" property Set <c>SpecialPropertySet</c>
  4395. delegates To.
  4396. </member>
  4397. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.PropertySet)">
  4398. <summary>
  4399. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  4400. </summary>
  4401. <param name="ps">The property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  4402. </member>
  4403. <member name="M:NPOI.HPSF.SpecialPropertySet.#ctor(NPOI.HPSF.MutablePropertySet)">
  4404. <summary>
  4405. Initializes a new instance of the <see cref="T:NPOI.HPSF.SpecialPropertySet"/> class.
  4406. </summary>
  4407. <param name="ps">The mutable property Set To be encapsulated by the <c>SpecialPropertySet</c></param>
  4408. </member>
  4409. <member name="P:NPOI.HPSF.SpecialPropertySet.ByteOrder">
  4410. <summary>
  4411. gets or sets the "byteOrder" property.
  4412. </summary>
  4413. <value>the byteOrder value To Set</value>
  4414. </member>
  4415. <member name="P:NPOI.HPSF.SpecialPropertySet.Format">
  4416. <summary>
  4417. gets or sets the "format" property
  4418. </summary>
  4419. <value>the format value To Set</value>
  4420. </member>
  4421. <member name="P:NPOI.HPSF.SpecialPropertySet.ClassID">
  4422. <summary>
  4423. gets or sets the property Set stream's low-level "class ID"
  4424. field.
  4425. </summary>
  4426. <value>The property Set stream's low-level "class ID" field</value>
  4427. </member>
  4428. <member name="P:NPOI.HPSF.SpecialPropertySet.SectionCount">
  4429. <summary>
  4430. Returns the number of {@link Section}s in the property
  4431. Set.
  4432. </summary>
  4433. <value>The number of {@link Section}s in the property Set.</value>
  4434. </member>
  4435. <member name="P:NPOI.HPSF.SpecialPropertySet.IsSummaryInformation">
  4436. <summary>
  4437. Checks whether this {@link PropertySet} represents a Summary
  4438. Information.
  4439. </summary>
  4440. <value>
  4441. <c>true</c> Checks whether this {@link PropertySet} represents a Summary
  4442. Information; otherwise, <c>false</c>.
  4443. </value>
  4444. </member>
  4445. <member name="P:NPOI.HPSF.SpecialPropertySet.IsDocumentSummaryInformation">
  4446. <summary>
  4447. Gets a value indicating whether this instance is document summary information.
  4448. </summary>
  4449. <value>
  4450. <c>true</c> if this instance is document summary information; otherwise, <c>false</c>.
  4451. </value>
  4452. Checks whether this {@link PropertySet} is a Document
  4453. Summary Information.
  4454. @return
  4455. <c>true</c>
  4456. if this {@link PropertySet}
  4457. represents a Document Summary Information, else
  4458. <c>false</c>
  4459. </member>
  4460. <member name="P:NPOI.HPSF.SpecialPropertySet.FirstSection">
  4461. <summary>
  4462. Gets the PropertySet's first section.
  4463. </summary>
  4464. <value>The {@link PropertySet}'s first section.</value>
  4465. </member>
  4466. <member name="M:NPOI.HPSF.SpecialPropertySet.AddSection(NPOI.HPSF.Section)">
  4467. <summary>
  4468. Adds a section To this property set.
  4469. </summary>
  4470. <param name="section">The {@link Section} To Add. It will be Appended
  4471. after any sections that are alReady present in the property Set
  4472. and thus become the last section.</param>
  4473. </member>
  4474. <member name="M:NPOI.HPSF.SpecialPropertySet.ClearSections">
  4475. <summary>
  4476. Removes all sections from this property Set.
  4477. </summary>
  4478. </member>
  4479. <member name="P:NPOI.HPSF.SpecialPropertySet.OSVersion">
  4480. <summary>
  4481. gets or sets the "osVersion" property
  4482. </summary>
  4483. <value> the osVersion value To Set</value>
  4484. </member>
  4485. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  4486. <summary>
  4487. Writes a property Set To a document in a POI filesystem directory.
  4488. </summary>
  4489. <param name="dir">The directory in the POI filesystem To Write the document To</param>
  4490. <param name="name">The document's name. If there is alReady a document with the
  4491. same name in the directory the latter will be overwritten.</param>
  4492. </member>
  4493. <member name="M:NPOI.HPSF.SpecialPropertySet.Write(System.IO.Stream)">
  4494. <summary>
  4495. Writes the property Set To an output stream.
  4496. </summary>
  4497. <param name="out1">the output stream To Write the section To</param>
  4498. </member>
  4499. <member name="M:NPOI.HPSF.SpecialPropertySet.Equals(System.Object)">
  4500. <summary>
  4501. Returns <c>true</c> if the <c>PropertySet</c> is equal
  4502. To the specified parameter, else <c>false</c>.
  4503. </summary>
  4504. <param name="o">the object To Compare this
  4505. <c>PropertySet</c>
  4506. with</param>
  4507. <returns>
  4508. <c>true</c>
  4509. if the objects are equal,
  4510. <c>false</c>
  4511. if not
  4512. </returns>
  4513. </member>
  4514. <member name="P:NPOI.HPSF.SpecialPropertySet.Properties">
  4515. <summary>
  4516. Convenience method returning the {@link Property} array
  4517. contained in this property Set. It is a shortcut for Getting
  4518. the {@link PropertySet}'s {@link Section}s list and then
  4519. Getting the {@link Property} array from the first {@link
  4520. Section}.
  4521. </summary>
  4522. <value>
  4523. The properties of the only {@link Section} of this
  4524. {@link PropertySet}.
  4525. </value>
  4526. </member>
  4527. <member name="M:NPOI.HPSF.SpecialPropertySet.GetProperty(System.Int32)">
  4528. <summary>
  4529. Convenience method returning the value of the property with
  4530. the specified ID. If the property is not available,
  4531. <c>null</c> is returned and a subsequent call To {@link
  4532. #WasNull} will return <c>true</c> .
  4533. </summary>
  4534. <param name="id">The property ID</param>
  4535. <returns>The property value</returns>
  4536. </member>
  4537. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyBooleanValue(System.Int32)">
  4538. <summary>
  4539. Convenience method returning the value of a bool property
  4540. with the specified ID. If the property is not available,
  4541. <c>false</c> is returned. A subsequent call To {@link
  4542. #WasNull} will return <c>true</c> To let the caller
  4543. distinguish that case from a real property value of
  4544. <c>false</c>.
  4545. </summary>
  4546. <param name="id">The property ID</param>
  4547. <returns>The property value</returns>
  4548. </member>
  4549. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyIntValue(System.Int32)">
  4550. <summary>
  4551. Convenience method returning the value of the numeric
  4552. property with the specified ID. If the property is not
  4553. available, 0 is returned. A subsequent call To {@link #WasNull}
  4554. will return <c>true</c> To let the caller distinguish
  4555. that case from a real property value of 0.
  4556. </summary>
  4557. <param name="id">The property ID</param>
  4558. <returns>The propertyIntValue value</returns>
  4559. </member>
  4560. <member name="M:NPOI.HPSF.SpecialPropertySet.GetPropertyStringValue(System.Int32)">
  4561. Fetches the property with the given ID, then does its
  4562. best to return it as a String
  4563. @return The property as a String, or null if unavailable
  4564. </member>
  4565. <member name="M:NPOI.HPSF.SpecialPropertySet.GetHashCode">
  4566. <summary>
  4567. Serves as a hash function for a particular type.
  4568. </summary>
  4569. <returns>
  4570. A hash code for the current <see cref="T:System.Object"/>.
  4571. </returns>
  4572. </member>
  4573. <member name="M:NPOI.HPSF.SpecialPropertySet.ToString">
  4574. <summary>
  4575. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4576. </summary>
  4577. <returns>
  4578. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  4579. </returns>
  4580. </member>
  4581. <member name="P:NPOI.HPSF.SpecialPropertySet.WasNull">
  4582. <summary>
  4583. Checks whether the property which the last call To {@link
  4584. #GetPropertyIntValue} or {@link #GetProperty} tried To access
  4585. Was available or not. This information might be important for
  4586. callers of {@link #GetPropertyIntValue} since the latter
  4587. returns 0 if the property does not exist. Using {@link
  4588. #WasNull}, the caller can distiguish this case from a
  4589. property's real value of 0.
  4590. </summary>
  4591. <value>
  4592. <c>true</c> if the last call To {@link
  4593. #GetPropertyIntValue} or {@link #GetProperty} tried To access a
  4594. property that Was not available; otherwise, <c>false</c>.
  4595. </value>
  4596. </member>
  4597. <member name="T:NPOI.HPSF.SummaryInformation">
  4598. <summary>
  4599. Convenience class representing a Summary Information stream in a
  4600. Microsoft Office document.
  4601. @author Rainer Klute
  4602. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4603. @see DocumentSummaryInformation
  4604. @since 2002-02-09
  4605. </summary>
  4606. </member>
  4607. <member name="F:NPOI.HPSF.SummaryInformation.DEFAULT_STREAM_NAME">
  4608. The document name a summary information stream usually has in a POIFS
  4609. filesystem.
  4610. </member>
  4611. <member name="M:NPOI.HPSF.SummaryInformation.#ctor(NPOI.HPSF.PropertySet)">
  4612. <summary>
  4613. Initializes a new instance of the <see cref="T:NPOI.HPSF.SummaryInformation"/> class.
  4614. </summary>
  4615. <param name="ps">A property Set which should be Created from a summary
  4616. information stream.</param>
  4617. </member>
  4618. <member name="P:NPOI.HPSF.SummaryInformation.Title">
  4619. <summary>
  4620. Gets or sets the title.
  4621. </summary>
  4622. <value>The title.</value>
  4623. </member>
  4624. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTitle">
  4625. <summary>
  4626. Removes the title.
  4627. </summary>
  4628. </member>
  4629. <member name="P:NPOI.HPSF.SummaryInformation.Subject">
  4630. <summary>
  4631. Gets or sets the subject.
  4632. </summary>
  4633. <value>The subject.</value>
  4634. </member>
  4635. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSubject">
  4636. <summary>
  4637. Removes the subject.
  4638. </summary>
  4639. </member>
  4640. <member name="P:NPOI.HPSF.SummaryInformation.Author">
  4641. <summary>
  4642. Gets or sets the author.
  4643. </summary>
  4644. <value>The author.</value>
  4645. </member>
  4646. <member name="M:NPOI.HPSF.SummaryInformation.RemoveAuthor">
  4647. <summary>
  4648. Removes the author.
  4649. </summary>
  4650. </member>
  4651. <member name="P:NPOI.HPSF.SummaryInformation.Keywords">
  4652. <summary>
  4653. Gets or sets the keywords.
  4654. </summary>
  4655. <value>The keywords.</value>
  4656. </member>
  4657. <member name="M:NPOI.HPSF.SummaryInformation.RemoveKeywords">
  4658. <summary>
  4659. Removes the keywords.
  4660. </summary>
  4661. </member>
  4662. <member name="P:NPOI.HPSF.SummaryInformation.Comments">
  4663. <summary>
  4664. Gets or sets the comments.
  4665. </summary>
  4666. <value>The comments.</value>
  4667. </member>
  4668. <member name="M:NPOI.HPSF.SummaryInformation.RemoveComments">
  4669. <summary>
  4670. Removes the comments.
  4671. </summary>
  4672. </member>
  4673. <member name="P:NPOI.HPSF.SummaryInformation.Template">
  4674. <summary>
  4675. Gets or sets the template.
  4676. </summary>
  4677. <value>The template.</value>
  4678. </member>
  4679. <member name="M:NPOI.HPSF.SummaryInformation.RemoveTemplate">
  4680. <summary>
  4681. Removes the template.
  4682. </summary>
  4683. </member>
  4684. <member name="P:NPOI.HPSF.SummaryInformation.LastAuthor">
  4685. <summary>
  4686. Gets or sets the last author.
  4687. </summary>
  4688. <value>The last author.</value>
  4689. </member>
  4690. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastAuthor">
  4691. <summary>
  4692. Removes the last author.
  4693. </summary>
  4694. </member>
  4695. <member name="P:NPOI.HPSF.SummaryInformation.RevNumber">
  4696. <summary>
  4697. Gets or sets the rev number.
  4698. </summary>
  4699. <value>The rev number.</value>
  4700. </member>
  4701. <member name="M:NPOI.HPSF.SummaryInformation.RemoveRevNumber">
  4702. <summary>
  4703. Removes the rev number.
  4704. </summary>
  4705. </member>
  4706. <member name="P:NPOI.HPSF.SummaryInformation.EditTime">
  4707. <summary>
  4708. Returns the Total time spent in editing the document (or 0).
  4709. </summary>
  4710. <value>The Total time spent in editing the document or 0 if the {@link
  4711. SummaryInformation} does not contain this information.</value>
  4712. </member>
  4713. <member name="M:NPOI.HPSF.SummaryInformation.RemoveEditTime">
  4714. <summary>
  4715. Removes the edit time.
  4716. </summary>
  4717. </member>
  4718. <member name="P:NPOI.HPSF.SummaryInformation.LastPrinted">
  4719. <summary>
  4720. Gets or sets the last printed time
  4721. </summary>
  4722. <value>The last printed time</value>
  4723. Returns the last printed time (or <c>null</c>).
  4724. </member>
  4725. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastPrinted">
  4726. <summary>
  4727. Removes the last printed.
  4728. </summary>
  4729. </member>
  4730. <member name="P:NPOI.HPSF.SummaryInformation.CreateDateTime">
  4731. <summary>
  4732. Gets or sets the create date time.
  4733. </summary>
  4734. <value>The create date time.</value>
  4735. </member>
  4736. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCreateDateTime">
  4737. <summary>
  4738. Removes the create date time.
  4739. </summary>
  4740. </member>
  4741. <member name="P:NPOI.HPSF.SummaryInformation.LastSaveDateTime">
  4742. <summary>
  4743. Gets or sets the last save date time.
  4744. </summary>
  4745. <value>The last save date time.</value>
  4746. </member>
  4747. <member name="M:NPOI.HPSF.SummaryInformation.RemoveLastSaveDateTime">
  4748. <summary>
  4749. Removes the last save date time.
  4750. </summary>
  4751. </member>
  4752. <member name="P:NPOI.HPSF.SummaryInformation.PageCount">
  4753. <summary>
  4754. Gets or sets the page count or 0 if the {@link SummaryInformation} does
  4755. not contain a page count.
  4756. </summary>
  4757. <value>The page count or 0 if the {@link SummaryInformation} does not
  4758. contain a page count.</value>
  4759. </member>
  4760. <member name="M:NPOI.HPSF.SummaryInformation.RemovePageCount">
  4761. <summary>
  4762. Removes the page count.
  4763. </summary>
  4764. </member>
  4765. <member name="P:NPOI.HPSF.SummaryInformation.WordCount">
  4766. <summary>
  4767. Gets or sets the word count or 0 if the {@link SummaryInformation} does
  4768. not contain a word count.
  4769. </summary>
  4770. <value>The word count.</value>
  4771. </member>
  4772. <member name="M:NPOI.HPSF.SummaryInformation.RemoveWordCount">
  4773. <summary>
  4774. Removes the word count.
  4775. </summary>
  4776. </member>
  4777. <member name="P:NPOI.HPSF.SummaryInformation.CharCount">
  4778. <summary>
  4779. Gets or sets the character count or 0 if the {@link SummaryInformation}
  4780. does not contain a char count.
  4781. </summary>
  4782. <value>The character count.</value>
  4783. </member>
  4784. <member name="M:NPOI.HPSF.SummaryInformation.RemoveCharCount">
  4785. <summary>
  4786. Removes the char count.
  4787. </summary>
  4788. </member>
  4789. <member name="P:NPOI.HPSF.SummaryInformation.Thumbnail">
  4790. <summary>
  4791. Gets or sets the thumbnail (or <c>null</c>) <strong>when this
  4792. method is implemented. Please note that the return type is likely To
  4793. Change!</strong>
  4794. <strong>Hint To developers:</strong> Drew Varner &lt;Drew.Varner
  4795. -at- sc.edu&gt; said that this is an image in WMF or Clipboard (BMP?)
  4796. format. However, we won't do any conversion into any image type but
  4797. instead just return a byte array.
  4798. </summary>
  4799. <value>The thumbnail.</value>
  4800. </member>
  4801. <member name="M:NPOI.HPSF.SummaryInformation.RemoveThumbnail">
  4802. <summary>
  4803. Removes the thumbnail.
  4804. </summary>
  4805. </member>
  4806. <member name="P:NPOI.HPSF.SummaryInformation.ApplicationName">
  4807. <summary>
  4808. Gets or sets the name of the application.
  4809. </summary>
  4810. <value>The name of the application.</value>
  4811. </member>
  4812. <member name="M:NPOI.HPSF.SummaryInformation.RemoveApplicationName">
  4813. <summary>
  4814. Removes the name of the application.
  4815. </summary>
  4816. </member>
  4817. <member name="P:NPOI.HPSF.SummaryInformation.Security">
  4818. <summary>
  4819. Gets or sets a security code which is one of the following values:
  4820. <ul>
  4821. <li>0 if the {@link SummaryInformation} does not contain a
  4822. security field or if there is no security on the document. Use
  4823. {@link PropertySet#wasNull()} To distinguish between the two
  4824. cases!</li>
  4825. <li>1 if the document is password protected</li>
  4826. <li>2 if the document is Read-only recommended</li>
  4827. <li>4 if the document is Read-only enforced</li>
  4828. <li>8 if the document is locked for annotations</li>
  4829. </ul>
  4830. </summary>
  4831. <value>The security code</value>
  4832. </member>
  4833. <member name="M:NPOI.HPSF.SummaryInformation.RemoveSecurity">
  4834. <summary>
  4835. Removes the security code.
  4836. </summary>
  4837. </member>
  4838. <member name="T:NPOI.HPSF.Thumbnail">
  4839. <summary>
  4840. Class To manipulate data in the Clipboard Variant (Variant#VT_CF VT_CF) format.
  4841. @author Drew Varner (Drew.Varner inOrAround sc.edu)
  4842. @since 2002-04-29
  4843. </summary>
  4844. </member>
  4845. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CFTAG">
  4846. <summary>
  4847. OffSet in bytes where the Clipboard Format Tag starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4848. </summary>
  4849. </member>
  4850. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_CF">
  4851. <summary>
  4852. OffSet in bytes where the Clipboard Format starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4853. </summary>
  4854. <remarks>This is only valid if the Clipboard Format Tag is CFTAG_WINDOWS</remarks>
  4855. </member>
  4856. <member name="F:NPOI.HPSF.Thumbnail.OFFSet_WMFDATA">
  4857. <summary>
  4858. OffSet in bytes where the Windows Metafile (WMF) image data starts in the <c>byte[]</c> returned by SummaryInformation#GetThumbnail()
  4859. There is only WMF data at this point in the
  4860. <c>byte[]</c> if the Clipboard Format Tag is
  4861. CFTAG_WINDOWS and the Clipboard Format is
  4862. CF_METAFILEPICT.
  4863. </summary>
  4864. <remarks>Note: The <c>byte[]</c> that starts at
  4865. <c>OFFSet_WMFDATA</c> and ends at
  4866. <c>GetThumbnail().Length - 1</c> forms a complete WMF
  4867. image. It can be saved To disk with a <c>.wmf</c> file
  4868. type and Read using a WMF-capable image viewer.</remarks>
  4869. </member>
  4870. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_WINDOWS">
  4871. <summary>
  4872. Clipboard Format Tag - Windows clipboard format
  4873. </summary>
  4874. <remarks>A <c>DWORD</c> indicating a built-in Windows clipboard format value</remarks>
  4875. </member>
  4876. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_MACINTOSH">
  4877. <summary>
  4878. Clipboard Format Tag - Macintosh clipboard format
  4879. </summary>
  4880. <remarks>A <c>DWORD</c> indicating a Macintosh clipboard format value</remarks>
  4881. </member>
  4882. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_FMTID">
  4883. <summary>
  4884. Clipboard Format Tag - Format ID
  4885. </summary>
  4886. <remarks>A GUID containing a format identifier (FMTID). This is rarely used.</remarks>
  4887. </member>
  4888. <member name="F:NPOI.HPSF.Thumbnail.CFTAG_NODATA">
  4889. <summary>
  4890. Clipboard Format Tag - No Data
  4891. </summary>
  4892. <remarks>A <c>DWORD</c> indicating No data. This is rarely used.</remarks>
  4893. </member>
  4894. <member name="F:NPOI.HPSF.Thumbnail.CF_METAFILEPICT">
  4895. <summary>
  4896. Clipboard Format - Windows metafile format. This is the recommended way To store thumbnails in Property Streams.
  4897. </summary>
  4898. <remarks>Note:This is not the same format used in
  4899. regular WMF images. The clipboard version of this format has an
  4900. extra clipboard-specific header.</remarks>
  4901. </member>
  4902. <member name="F:NPOI.HPSF.Thumbnail.CF_DIB">
  4903. <summary>
  4904. Clipboard Format - Device Independent Bitmap
  4905. </summary>
  4906. </member>
  4907. <member name="F:NPOI.HPSF.Thumbnail.CF_ENHMETAFILE">
  4908. <summary>
  4909. Clipboard Format - Enhanced Windows metafile format
  4910. </summary>
  4911. </member>
  4912. <member name="F:NPOI.HPSF.Thumbnail.CF_BITMAP">
  4913. <summary>
  4914. Clipboard Format - Bitmap
  4915. </summary>
  4916. <remarks>see msdn.microsoft.com/library/en-us/dnw98bk/html/clipboardoperations.asp</remarks>
  4917. </member>
  4918. <member name="F:NPOI.HPSF.Thumbnail.thumbnailData">
  4919. A <c>byte[]</c> To hold a thumbnail image in (
  4920. Variant#VT_CF VT_CF) format.
  4921. </member>
  4922. <member name="M:NPOI.HPSF.Thumbnail.#ctor">
  4923. <summary>
  4924. Default Constructor. If you use it then one you'll have To Add
  4925. the thumbnail <c>byte[]</c> from {@link
  4926. SummaryInformation#GetThumbnail()} To do any useful
  4927. manipulations, otherwise you'll Get a
  4928. <c>NullPointerException</c>.
  4929. </summary>
  4930. </member>
  4931. <member name="M:NPOI.HPSF.Thumbnail.#ctor(System.Byte[])">
  4932. <summary>
  4933. Initializes a new instance of the <see cref="T:NPOI.HPSF.Thumbnail"/> class.
  4934. </summary>
  4935. <param name="thumbnailData">The thumbnail data.</param>
  4936. </member>
  4937. <member name="P:NPOI.HPSF.Thumbnail.ThumbnailData">
  4938. <summary>
  4939. Gets or sets the thumbnail as a <c>byte[]</c> in {@link
  4940. Variant#VT_CF VT_CF} format.
  4941. </summary>
  4942. <value>The thumbnail value</value>
  4943. </member>
  4944. <member name="P:NPOI.HPSF.Thumbnail.ClipboardFormatTag">
  4945. <summary>
  4946. Returns an <c>int</c> representing the Clipboard
  4947. Format Tag
  4948. Possible return values are:
  4949. <ul>
  4950. <li>{@link #CFTAG_WINDOWS CFTAG_WINDOWS}</li>
  4951. <li>{@link #CFTAG_MACINTOSH CFTAG_MACINTOSH}</li>
  4952. <li>{@link #CFTAG_FMTID CFTAG_FMTID}</li>
  4953. <li>{@link #CFTAG_NODATA CFTAG_NODATA}</li>
  4954. </ul>
  4955. </summary>
  4956. <returns>A flag indicating the Clipboard Format Tag</returns>
  4957. </member>
  4958. <member name="M:NPOI.HPSF.Thumbnail.GetClipboardFormat">
  4959. <summary>
  4960. Returns an <c>int</c> representing the Clipboard
  4961. Format
  4962. Will throw an exception if the Thumbnail's Clipboard Format
  4963. Tag is not {@link Thumbnail#CFTAG_WINDOWS CFTAG_WINDOWS}.
  4964. Possible return values are:
  4965. <ul>
  4966. <li>{@link #CF_METAFILEPICT CF_METAFILEPICT}</li>
  4967. <li>{@link #CF_DIB CF_DIB}</li>
  4968. <li>{@link #CF_ENHMETAFILE CF_ENHMETAFILE}</li>
  4969. <li>{@link #CF_BITMAP CF_BITMAP}</li>
  4970. </ul>
  4971. </summary>
  4972. <returns>a flag indicating the Clipboard Format</returns>
  4973. </member>
  4974. <member name="M:NPOI.HPSF.Thumbnail.GetThumbnailAsWMF">
  4975. <summary>
  4976. Returns the Thumbnail as a <c>byte[]</c> of WMF data
  4977. if the Thumbnail's Clipboard Format Tag is {@link
  4978. #CFTAG_WINDOWS CFTAG_WINDOWS} and its Clipboard Format is
  4979. {@link #CF_METAFILEPICT CF_METAFILEPICT}
  4980. This
  4981. <c>byte[]</c> is in the traditional WMF file, not the
  4982. clipboard-specific version with special headers.
  4983. See <a href="http://www.wvware.com/caolan/ora-wmf.html" tarGet="_blank">http://www.wvware.com/caolan/ora-wmf.html</a>
  4984. for more information on the WMF image format.
  4985. @return A WMF image of the Thumbnail
  4986. @throws HPSFException if the Thumbnail isn't CFTAG_WINDOWS and
  4987. CF_METAFILEPICT
  4988. </summary>
  4989. <returns></returns>
  4990. </member>
  4991. <member name="T:NPOI.HPSF.TypeWriter">
  4992. <summary>
  4993. Class for writing little-endian data and more.
  4994. @author Rainer Klute
  4995. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  4996. @since 2003-02-20
  4997. </summary>
  4998. </member>
  4999. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int16)">
  5000. <summary>
  5001. Writes a two-byte value (short) To an output stream.
  5002. </summary>
  5003. <param name="out1">The stream To Write To..</param>
  5004. <param name="n">The number of bytes that have been written.</param>
  5005. <returns></returns>
  5006. </member>
  5007. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int32)">
  5008. Writes a four-byte value To an output stream.
  5009. @param out The stream To Write To.
  5010. @param n The value To Write.
  5011. @exception IOException if an I/O error occurs
  5012. @return The number of bytes written To the output stream.
  5013. </member>
  5014. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.UInt32)">
  5015. Writes a four-byte value To an output stream.
  5016. @param out The stream To Write To.
  5017. @param n The value To Write.
  5018. @exception IOException if an I/O error occurs
  5019. @return The number of bytes written To the output stream.
  5020. </member>
  5021. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Int64)">
  5022. Writes a eight-byte value To an output stream.
  5023. @param out The stream To Write To.
  5024. @param n The value To Write.
  5025. @exception IOException if an I/O error occurs
  5026. @return The number of bytes written To the output stream.
  5027. </member>
  5028. <member name="M:NPOI.HPSF.TypeWriter.WriteUShortToStream(System.IO.Stream,System.Int32)">
  5029. Writes an unsigned two-byte value To an output stream.
  5030. @param out The stream To Write To
  5031. @param n The value To Write
  5032. @exception IOException if an I/O error occurs
  5033. </member>
  5034. <member name="M:NPOI.HPSF.TypeWriter.WriteUIntToStream(System.IO.Stream,System.UInt32)">
  5035. Writes an unsigned four-byte value To an output stream.
  5036. @param out The stream To Write To.
  5037. @param n The value To Write.
  5038. @return The number of bytes that have been written To the output stream.
  5039. @exception IOException if an I/O error occurs
  5040. </member>
  5041. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.Util.ClassID)">
  5042. Writes a 16-byte {@link ClassID} To an output stream.
  5043. @param out The stream To Write To
  5044. @param n The value To Write
  5045. @return The number of bytes written
  5046. @exception IOException if an I/O error occurs
  5047. </member>
  5048. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,NPOI.HPSF.Property[],System.Int32)">
  5049. Writes an array of {@link Property} instances To an output stream
  5050. according To the Horrible Property Format.
  5051. @param out The stream To Write To
  5052. @param properties The array To Write To the stream
  5053. @param codepage The codepage number To use for writing strings
  5054. @exception IOException if an I/O error occurs
  5055. @throws UnsupportedVariantTypeException if HPSF does not support some
  5056. variant type.
  5057. </member>
  5058. <member name="M:NPOI.HPSF.TypeWriter.WriteToStream(System.IO.Stream,System.Double)">
  5059. Writes a double value value To an output stream.
  5060. @param out The stream To Write To.
  5061. @param n The value To Write.
  5062. @exception IOException if an I/O error occurs
  5063. @return The number of bytes written To the output stream.
  5064. </member>
  5065. <member name="T:NPOI.HPSF.UnexpectedPropertySetTypeException">
  5066. <summary>
  5067. This exception is thrown if a certain type of property Set Is
  5068. expected (e.g. a Document Summary Information) but the provided
  5069. property Set is not of that type.
  5070. The constructors of this class are analogous To those of its
  5071. superclass and documented there.
  5072. @author Rainer Klute
  5073. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5074. @since 2002-02-09
  5075. </summary>
  5076. </member>
  5077. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor">
  5078. <summary>
  5079. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  5080. </summary>
  5081. </member>
  5082. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String)">
  5083. <summary>
  5084. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  5085. </summary>
  5086. <param name="msg">The message string.</param>
  5087. </member>
  5088. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.Exception)">
  5089. <summary>
  5090. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  5091. </summary>
  5092. <param name="reason">The reason, i.e. a throwable that indirectly
  5093. caused this exception.</param>
  5094. </member>
  5095. <member name="M:NPOI.HPSF.UnexpectedPropertySetTypeException.#ctor(System.String,System.Exception)">
  5096. <summary>
  5097. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnexpectedPropertySetTypeException"/> class.
  5098. </summary>
  5099. <param name="msg">The message string.</param>
  5100. <param name="reason">The reason, i.e. a throwable that indirectly
  5101. caused this exception.</param>
  5102. </member>
  5103. <member name="M:NPOI.HPSF.UnicodeString.validLength(System.Int32,System.Byte[],System.Int32)">
  5104. Checks to see if the specified length seems valid,
  5105. given the amount of data available still to read,
  5106. and the requirement that the string be NULL-terminated
  5107. </member>
  5108. <member name="T:NPOI.HPSF.UnsupportedEncodingException">
  5109. The Character Encoding is not supported.
  5110. @author Asmus Freytag
  5111. @since JDK1.1
  5112. </member>
  5113. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor">
  5114. Constructs an UnsupportedEncodingException without a detail message.
  5115. </member>
  5116. <member name="M:NPOI.HPSF.UnsupportedEncodingException.#ctor(System.String)">
  5117. Constructs an UnsupportedEncodingException with a detail message.
  5118. @param s Describes the reason for the exception.
  5119. </member>
  5120. <member name="T:NPOI.HPSF.UnsupportedVariantTypeException">
  5121. <summary>
  5122. This exception is thrown if HPSF encounters a variant type that isn't
  5123. supported yet. Although a variant type is unsupported the value can still be
  5124. retrieved using the {@link VariantTypeException#GetValue} method.
  5125. Obviously this class should disappear some day.
  5126. @author Rainer Klute
  5127. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5128. @since 2003-08-05
  5129. </summary>
  5130. </member>
  5131. <member name="M:NPOI.HPSF.UnsupportedVariantTypeException.#ctor(System.Int64,System.Object)">
  5132. <summary>
  5133. Initializes a new instance of the <see cref="T:NPOI.HPSF.UnsupportedVariantTypeException"/> class.
  5134. </summary>
  5135. <param name="variantType">The unsupported variant type</param>
  5136. <param name="value">The value who's variant type is not yet supported</param>
  5137. </member>
  5138. <member name="T:NPOI.HPSF.Util">
  5139. <summary>
  5140. Provides various static utility methods.
  5141. @author Rainer Klute (klute@rainer-klute.de)
  5142. @since 2002-02-09
  5143. </summary>
  5144. </member>
  5145. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  5146. <summary>
  5147. Copies a part of a byte array into another byte array.
  5148. </summary>
  5149. <param name="src">The source byte array.</param>
  5150. <param name="srcOffSet">OffSet in the source byte array.</param>
  5151. <param name="Length">The number of bytes To Copy.</param>
  5152. <param name="dst">The destination byte array.</param>
  5153. <param name="dstOffSet">OffSet in the destination byte array.</param>
  5154. </member>
  5155. <member name="M:NPOI.HPSF.Util.Cat(System.Byte[][])">
  5156. <summary>
  5157. Concatenates the contents of several byte arrays into a
  5158. single one.
  5159. </summary>
  5160. <param name="byteArrays">The byte arrays To be conCatened.</param>
  5161. <returns>A new byte array containing the conCatenated byte arrays.</returns>
  5162. </member>
  5163. <member name="M:NPOI.HPSF.Util.Copy(System.Byte[],System.Int32,System.Int32)">
  5164. <summary>
  5165. Copies bytes from a source byte array into a new byte
  5166. array.
  5167. </summary>
  5168. <param name="src">Copy from this byte array.</param>
  5169. <param name="offset">Start Copying here.</param>
  5170. <param name="Length">Copy this many bytes.</param>
  5171. <returns>The new byte array. Its Length is number of copied bytes.</returns>
  5172. </member>
  5173. <member name="F:NPOI.HPSF.Util.EPOCH_DIFF">
  5174. The difference between the Windows epoch (1601-01-01
  5175. 00:00:00) and the Unix epoch (1970-01-01 00:00:00) in
  5176. milliseconds: 11644473600000L. (Use your favorite spReadsheet
  5177. program To verify the correctness of this value. By the way,
  5178. did you notice that you can tell from the epochs which
  5179. operating system is the modern one? :-))
  5180. </member>
  5181. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int32,System.Int32)">
  5182. <summary>
  5183. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  5184. FILETIME structure holds a DateTime and time associated with a
  5185. file. The structure identifies a 64-bit integer specifying the
  5186. number of 100-nanosecond intervals which have passed since
  5187. January 1, 1601. This 64-bit value is split into the two double
  5188. words stored in the structure.
  5189. </summary>
  5190. <param name="high">The higher double word of the FILETIME structure.</param>
  5191. <param name="low">The lower double word of the FILETIME structure.</param>
  5192. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  5193. </member>
  5194. <member name="M:NPOI.HPSF.Util.FiletimeToDate(System.Int64)">
  5195. <summary>
  5196. Converts a Windows FILETIME into a {@link DateTime}. The Windows
  5197. FILETIME structure holds a DateTime and time associated with a
  5198. file. The structure identifies a 64-bit integer specifying the
  5199. number of 100-nanosecond intervals which have passed since
  5200. January 1, 1601.
  5201. </summary>
  5202. <param name="filetime">The filetime To Convert.</param>
  5203. <returns>The Windows FILETIME as a {@link DateTime}.</returns>
  5204. </member>
  5205. <member name="M:NPOI.HPSF.Util.DateToFileTime(System.DateTime)">
  5206. <summary>
  5207. Converts a {@link DateTime} into a filetime.
  5208. </summary>
  5209. <param name="dateTime">The DateTime To be Converted</param>
  5210. <returns>The filetime</returns>
  5211. </member>
  5212. <member name="M:NPOI.HPSF.Util.AreEqual(System.Collections.IList,System.Collections.IList)">
  5213. <summary>
  5214. Compares To object arrays with regarding the objects' order. For
  5215. example, [1, 2, 3] and [2, 1, 3] are equal.
  5216. </summary>
  5217. <param name="c1">The first object array.</param>
  5218. <param name="c2">The second object array.</param>
  5219. <returns><c>true</c>
  5220. if the object arrays are equal,
  5221. <c>false</c>
  5222. if they are not.</returns>
  5223. </member>
  5224. <member name="M:NPOI.HPSF.Util.internalEquals(System.Collections.IList,System.Collections.IList)">
  5225. <summary>
  5226. Internals the equals.
  5227. </summary>
  5228. <param name="c1">The c1.</param>
  5229. <param name="c2">The c2.</param>
  5230. <returns></returns>
  5231. </member>
  5232. <member name="M:NPOI.HPSF.Util.Pad4(System.Byte[])">
  5233. <summary>
  5234. Pads a byte array with 0x00 bytes so that its Length is a multiple of
  5235. 4.
  5236. </summary>
  5237. <param name="ba">The byte array To pad.</param>
  5238. <returns>The padded byte array.</returns>
  5239. </member>
  5240. <member name="M:NPOI.HPSF.Util.Pad4(System.Char[])">
  5241. <summary>
  5242. Pads a character array with 0x0000 characters so that its Length is a
  5243. multiple of 4.
  5244. </summary>
  5245. <param name="ca">The character array To pad.</param>
  5246. <returns>The padded character array.</returns>
  5247. </member>
  5248. <member name="M:NPOI.HPSF.Util.Pad4(System.String)">
  5249. <summary>
  5250. Pads a string with 0x0000 characters so that its Length is a
  5251. multiple of 4.
  5252. </summary>
  5253. <param name="s">The string To pad.</param>
  5254. <returns> The padded string as a character array.</returns>
  5255. </member>
  5256. <member name="T:NPOI.HPSF.Variant">
  5257. <summary>
  5258. The <em>Variant</em> types as defined by Microsoft's COM. I
  5259. found this information in <a href="http://www.marin.clara.net/COM/variant_type_definitions.htm">
  5260. http://www.marin.clara.net/COM/variant_type_definitions.htm</a>.
  5261. In the variant types descriptions the following shortcuts are
  5262. used: <strong> [V]</strong> - may appear in a VARIANT,
  5263. <strong>[T]</strong> - may appear in a TYPEDESC,
  5264. <strong>[P]</strong> - may appear in an OLE property Set,
  5265. <strong>[S]</strong> - may appear in a Safe Array.
  5266. @author Rainer Klute (klute@rainer-klute.de)
  5267. @since 2002-02-09
  5268. </summary>
  5269. </member>
  5270. <member name="F:NPOI.HPSF.Variant.VT_EMPTY">
  5271. [V][P] Nothing, i.e. not a single byte of data.
  5272. </member>
  5273. <member name="F:NPOI.HPSF.Variant.VT_NULL">
  5274. [V][P] SQL style Null.
  5275. </member>
  5276. <member name="F:NPOI.HPSF.Variant.VT_I2">
  5277. [V][T][P][S] 2 byte signed int.
  5278. </member>
  5279. <member name="F:NPOI.HPSF.Variant.VT_I4">
  5280. [V][T][P][S] 4 byte signed int.
  5281. </member>
  5282. <member name="F:NPOI.HPSF.Variant.VT_R4">
  5283. [V][T][P][S] 4 byte real.
  5284. </member>
  5285. <member name="F:NPOI.HPSF.Variant.VT_R8">
  5286. [V][T][P][S] 8 byte real.
  5287. </member>
  5288. <member name="F:NPOI.HPSF.Variant.VT_CY">
  5289. [V][T][P][S] currency. <span style="background-color:
  5290. #ffff00">How long is this? How is it To be
  5291. interpreted?</span>
  5292. </member>
  5293. <member name="F:NPOI.HPSF.Variant.VT_DATE">
  5294. [V][T][P][S] DateTime. <span style="background-color:
  5295. #ffff00">How long is this? How is it To be
  5296. interpreted?</span>
  5297. </member>
  5298. <member name="F:NPOI.HPSF.Variant.VT_BSTR">
  5299. [V][T][P][S] OLE Automation string. <span
  5300. style="background-color: #ffff00">How long is this? How is it
  5301. To be interpreted?</span>
  5302. </member>
  5303. <member name="F:NPOI.HPSF.Variant.VT_DISPATCH">
  5304. [V][T][P][S] IDispatch *. <span style="background-color:
  5305. #ffff00">How long is this? How is it To be
  5306. interpreted?</span>
  5307. </member>
  5308. <member name="F:NPOI.HPSF.Variant.VT_ERROR">
  5309. [V][T][S] SCODE. <span style="background-color: #ffff00">How
  5310. long is this? How is it To be interpreted?</span>
  5311. </member>
  5312. <member name="F:NPOI.HPSF.Variant.VT_BOOL">
  5313. [V][T][P][S] True=-1, False=0.
  5314. </member>
  5315. <member name="F:NPOI.HPSF.Variant.VT_VARIANT">
  5316. [V][T][P][S] VARIANT *. <span style="background-color:
  5317. #ffff00">How long is this? How is it To be
  5318. interpreted?</span>
  5319. </member>
  5320. <member name="F:NPOI.HPSF.Variant.VT_UNKNOWN">
  5321. [V][T][S] IUnknown *. <span style="background-color:
  5322. #ffff00">How long is this? How is it To be
  5323. interpreted?</span>
  5324. </member>
  5325. <member name="F:NPOI.HPSF.Variant.VT_DECIMAL">
  5326. [V][T][S] 16 byte fixed point.
  5327. </member>
  5328. <member name="F:NPOI.HPSF.Variant.VT_I1">
  5329. [T] signed char.
  5330. </member>
  5331. <member name="F:NPOI.HPSF.Variant.VT_UI1">
  5332. [V][T][P][S] unsigned char.
  5333. </member>
  5334. <member name="F:NPOI.HPSF.Variant.VT_UI2">
  5335. [T][P] unsigned short.
  5336. </member>
  5337. <member name="F:NPOI.HPSF.Variant.VT_UI4">
  5338. [T][P] unsigned int.
  5339. </member>
  5340. <member name="F:NPOI.HPSF.Variant.VT_I8">
  5341. [T][P] signed 64-bit int.
  5342. </member>
  5343. <member name="F:NPOI.HPSF.Variant.VT_UI8">
  5344. [T][P] unsigned 64-bit int.
  5345. </member>
  5346. <member name="F:NPOI.HPSF.Variant.VT_INT">
  5347. [T] signed machine int.
  5348. </member>
  5349. <member name="F:NPOI.HPSF.Variant.VT_UINT">
  5350. [T] unsigned machine int.
  5351. </member>
  5352. <member name="F:NPOI.HPSF.Variant.VT_VOID">
  5353. [T] C style void.
  5354. </member>
  5355. <member name="F:NPOI.HPSF.Variant.VT_HRESULT">
  5356. [T] Standard return type. <span style="background-color:
  5357. #ffff00">How long is this? How is it To be
  5358. interpreted?</span>
  5359. </member>
  5360. <member name="F:NPOI.HPSF.Variant.VT_PTR">
  5361. [T] pointer type. <span style="background-color:
  5362. #ffff00">How long is this? How is it To be
  5363. interpreted?</span>
  5364. </member>
  5365. <member name="F:NPOI.HPSF.Variant.VT_SAFEARRAY">
  5366. [T] (use VT_ARRAY in VARIANT).
  5367. </member>
  5368. <member name="F:NPOI.HPSF.Variant.VT_CARRAY">
  5369. [T] C style array. <span style="background-color:
  5370. #ffff00">How long is this? How is it To be
  5371. interpreted?</span>
  5372. </member>
  5373. <member name="F:NPOI.HPSF.Variant.VT_USERDEFINED">
  5374. [T] user defined type. <span style="background-color:
  5375. #ffff00">How long is this? How is it To be
  5376. interpreted?</span>
  5377. </member>
  5378. <member name="F:NPOI.HPSF.Variant.VT_LPSTR">
  5379. [T][P] null terminated string.
  5380. </member>
  5381. <member name="F:NPOI.HPSF.Variant.VT_LPWSTR">
  5382. [T][P] wide (Unicode) null terminated string.
  5383. </member>
  5384. <member name="F:NPOI.HPSF.Variant.VT_FILETIME">
  5385. [P] FILETIME. The FILETIME structure holds a DateTime and time
  5386. associated with a file. The structure identifies a 64-bit
  5387. integer specifying the number of 100-nanosecond intervals which
  5388. have passed since January 1, 1601. This 64-bit value is split
  5389. into the two dwords stored in the structure.
  5390. </member>
  5391. <member name="F:NPOI.HPSF.Variant.VT_BLOB">
  5392. [P] Length prefixed bytes.
  5393. </member>
  5394. <member name="F:NPOI.HPSF.Variant.VT_STREAM">
  5395. [P] Name of the stream follows.
  5396. </member>
  5397. <member name="F:NPOI.HPSF.Variant.VT_STORAGE">
  5398. [P] Name of the storage follows.
  5399. </member>
  5400. <member name="F:NPOI.HPSF.Variant.VT_STREAMED_OBJECT">
  5401. [P] Stream Contains an object. <span
  5402. style="background-color: #ffff00"> How long is this? How is it
  5403. To be interpreted?</span>
  5404. </member>
  5405. <member name="F:NPOI.HPSF.Variant.VT_STORED_OBJECT">
  5406. [P] Storage Contains an object. <span
  5407. style="background-color: #ffff00"> How long is this? How is it
  5408. To be interpreted?</span>
  5409. </member>
  5410. <member name="F:NPOI.HPSF.Variant.VT_BLOB_OBJECT">
  5411. [P] Blob Contains an object. <span style="background-color:
  5412. #ffff00">How long is this? How is it To be
  5413. interpreted?</span>
  5414. </member>
  5415. <member name="F:NPOI.HPSF.Variant.VT_CF">
  5416. [P] Clipboard format. <span style="background-color:
  5417. #ffff00">How long is this? How is it To be
  5418. interpreted?</span>
  5419. </member>
  5420. <member name="F:NPOI.HPSF.Variant.VT_CLSID">
  5421. [P] A Class ID.
  5422. It consists of a 32 bit unsigned integer indicating the size
  5423. of the structure, a 32 bit signed integer indicating (Clipboard
  5424. Format Tag) indicating the type of data that it Contains, and
  5425. then a byte array containing the data.
  5426. The valid Clipboard Format Tags are:
  5427. <ul>
  5428. <li>{@link Thumbnail#CFTAG_WINDOWS}</li>
  5429. <li>{@link Thumbnail#CFTAG_MACINTOSH}</li>
  5430. <li>{@link Thumbnail#CFTAG_NODATA}</li>
  5431. <li>{@link Thumbnail#CFTAG_FMTID}</li>
  5432. </ul>
  5433. <pre>typedef struct tagCLIPDATA {
  5434. // cbSize is the size of the buffer pointed To
  5435. // by pClipData, plus sizeof(ulClipFmt)
  5436. ULONG cbSize;
  5437. long ulClipFmt;
  5438. BYTE* pClipData;
  5439. } CLIPDATA;</pre>
  5440. See <a
  5441. href="msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp"
  5442. tarGet="_blank">
  5443. msdn.microsoft.com/library/en-us/com/stgrstrc_0uwk.asp</a>.
  5444. </member>
  5445. <member name="F:NPOI.HPSF.Variant.VT_VERSIONED_STREAM">
  5446. "MUST be a VersionedStream. The storage representing the (non-simple)
  5447. property set MUST have a stream element with the name in the StreamName
  5448. field." -- [MS-OLEPS] -- v20110920; Object Linking and Embedding (OLE)
  5449. Property Set Data Structures; page 24 / 63
  5450. </member>
  5451. <member name="F:NPOI.HPSF.Variant.VT_VECTOR">
  5452. [P] simple counted array. <span style="background-color:
  5453. #ffff00">How long is this? How is it To be
  5454. interpreted?</span>
  5455. </member>
  5456. <member name="F:NPOI.HPSF.Variant.VT_ARRAY">
  5457. [V] SAFEARRAY*. <span style="background-color: #ffff00">How
  5458. long is this? How is it To be interpreted?</span>
  5459. </member>
  5460. <member name="F:NPOI.HPSF.Variant.VT_BYREF">
  5461. [V] void* for local use. <span style="background-color:
  5462. #ffff00">How long is this? How is it To be
  5463. interpreted?</span>
  5464. </member>
  5465. <member name="F:NPOI.HPSF.Variant.VT_RESERVED">
  5466. FIXME (3): Document this!
  5467. </member>
  5468. <member name="F:NPOI.HPSF.Variant.VT_ILLEGAL">
  5469. FIXME (3): Document this!
  5470. </member>
  5471. <member name="F:NPOI.HPSF.Variant.VT_ILLEGALMASKED">
  5472. FIXME (3): Document this!
  5473. </member>
  5474. <member name="F:NPOI.HPSF.Variant.VT_TYPEMASK">
  5475. FIXME (3): Document this!
  5476. </member>
  5477. <member name="F:NPOI.HPSF.Variant.numberToName">
  5478. Maps the numbers denoting the variant types To their corresponding
  5479. variant type names.
  5480. </member>
  5481. <member name="F:NPOI.HPSF.Variant.Length_UNKNOWN">
  5482. Denotes a variant type with a Length that is unknown To HPSF yet.
  5483. </member>
  5484. <member name="F:NPOI.HPSF.Variant.Length_VARIABLE">
  5485. Denotes a variant type with a variable Length.
  5486. </member>
  5487. <member name="F:NPOI.HPSF.Variant.Length_0">
  5488. Denotes a variant type with a Length of 0 bytes.
  5489. </member>
  5490. <member name="F:NPOI.HPSF.Variant.Length_2">
  5491. Denotes a variant type with a Length of 2 bytes.
  5492. </member>
  5493. <member name="F:NPOI.HPSF.Variant.Length_4">
  5494. Denotes a variant type with a Length of 4 bytes.
  5495. </member>
  5496. <member name="F:NPOI.HPSF.Variant.Length_8">
  5497. Denotes a variant type with a Length of 8 bytes.
  5498. </member>
  5499. <member name="M:NPOI.HPSF.Variant.GetVariantName(System.Int64)">
  5500. <summary>
  5501. Returns the variant type name associated with a variant type
  5502. number.
  5503. </summary>
  5504. <param name="variantType">The variant type number.</param>
  5505. <returns>The variant type name or the string "unknown variant type"</returns>
  5506. </member>
  5507. <member name="M:NPOI.HPSF.Variant.GetVariantLength(System.Int64)">
  5508. <summary>
  5509. Returns a variant type's Length.
  5510. </summary>
  5511. <param name="variantType">The variant type number.</param>
  5512. <returns>The Length of the variant type's data in bytes. If the Length Is
  5513. variable, i.e. the Length of a string, -1 is returned. If HPSF does not
  5514. know the Length, -2 is returned. The latter usually indicates an
  5515. unsupported variant type.</returns>
  5516. </member>
  5517. <member name="T:NPOI.HPSF.VariantSupport">
  5518. <summary>
  5519. Supports Reading and writing of variant data.
  5520. <strong>FIXME (3):</strong>
  5521. Reading and writing should be made more
  5522. uniform than it is now. The following items should be resolved:
  5523. Reading requires a Length parameter that is 4 byte greater than the
  5524. actual data, because the variant type field is included.
  5525. Reading Reads from a byte array while writing Writes To an byte array
  5526. output stream.
  5527. @author Rainer Klute
  5528. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5529. @since 2003-08-08
  5530. </summary>
  5531. </member>
  5532. <member name="P:NPOI.HPSF.VariantSupport.IsLogUnsupportedTypes">
  5533. <summary>
  5534. Checks whether logging of unsupported variant types warning is turned
  5535. on or off.
  5536. </summary>
  5537. <value>
  5538. <c>true</c> if logging is turned on; otherwise, <c>false</c>.
  5539. </value>
  5540. </member>
  5541. <member name="F:NPOI.HPSF.VariantSupport.unsupportedMessage">
  5542. Keeps a list of the variant types an "unsupported" message has alReady
  5543. been issued for.
  5544. </member>
  5545. <member name="M:NPOI.HPSF.VariantSupport.WriteUnsupportedTypeMessage(NPOI.HPSF.UnsupportedVariantTypeException)">
  5546. <summary>
  5547. Writes a warning To System.err that a variant type Is
  5548. unsupported by HPSF. Such a warning is written only once for each variant
  5549. type. Log messages can be turned on or off by
  5550. </summary>
  5551. <param name="ex">The exception To log</param>
  5552. </member>
  5553. <member name="F:NPOI.HPSF.VariantSupport.SUPPORTED_TYPES">
  5554. HPSF is able To Read these {@link Variant} types.
  5555. </member>
  5556. <member name="M:NPOI.HPSF.VariantSupport.IsSupportedType(System.Int32)">
  5557. <summary>
  5558. Checks whether HPSF supports the specified variant type. Unsupported
  5559. types should be implemented included in the {@link #SUPPORTED_TYPES}
  5560. array.
  5561. </summary>
  5562. <param name="variantType">the variant type To check</param>
  5563. <returns>
  5564. <c>true</c> if HPFS supports this type,otherwise, <c>false</c>.
  5565. </returns>
  5566. </member>
  5567. <member name="M:NPOI.HPSF.VariantSupport.Read(System.Byte[],System.Int32,System.Int32,System.Int64,System.Int32)">
  5568. <summary>
  5569. Reads a variant type from a byte array
  5570. </summary>
  5571. <param name="src">The byte array</param>
  5572. <param name="offset">The offset in the byte array where the variant starts</param>
  5573. <param name="length">The Length of the variant including the variant type field</param>
  5574. <param name="type">The variant type To Read</param>
  5575. <param name="codepage">The codepage To use for non-wide strings</param>
  5576. <returns>A Java object that corresponds best To the variant field. For
  5577. example, a VT_I4 is returned as a {@link long}, a VT_LPSTR as a
  5578. {@link String}.</returns>
  5579. </member>
  5580. <member name="M:NPOI.HPSF.VariantSupport.CodepageToEncoding(System.Int32)">
  5581. <p>Turns a codepage number into the equivalent character encoding's
  5582. name.</p>
  5583. @param codepage The codepage number
  5584. @return The character encoding's name. If the codepage number is 65001,
  5585. the encoding name is "UTF-8". All other positive numbers are mapped to
  5586. "cp" followed by the number, e.g. if the codepage number is 1252 the
  5587. returned character encoding name will be "cp1252".
  5588. @exception UnsupportedEncodingException if the specified codepage is
  5589. less than zero.
  5590. </member>
  5591. <member name="M:NPOI.HPSF.VariantSupport.Write(System.IO.Stream,System.Int64,System.Object,System.Int32)">
  5592. <summary>
  5593. Writes a variant value To an output stream. This method ensures that
  5594. always a multiple of 4 bytes is written.
  5595. If the codepage is UTF-16, which is encouraged, strings
  5596. <strong>must</strong> always be written as {@link Variant#VT_LPWSTR}
  5597. strings, not as {@link Variant#VT_LPSTR} strings. This method ensure this
  5598. by Converting strings appropriately, if needed.
  5599. </summary>
  5600. <param name="out1">The stream To Write the value To.</param>
  5601. <param name="type">The variant's type.</param>
  5602. <param name="value">The variant's value.</param>
  5603. <param name="codepage">The codepage To use To Write non-wide strings</param>
  5604. <returns>The number of entities that have been written. In many cases an
  5605. "entity" is a byte but this is not always the case.</returns>
  5606. </member>
  5607. <member name="T:NPOI.HPSF.VariantTypeException">
  5608. <summary>
  5609. This exception is thrown if HPSF encounters a problem with a variant type.
  5610. Concrete subclasses specifiy the problem further.
  5611. @author Rainer Klute
  5612. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5613. @since 2004-06-21
  5614. </summary>
  5615. </member>
  5616. <member name="M:NPOI.HPSF.VariantTypeException.#ctor(System.Int64,System.Object,System.String)">
  5617. <summary>
  5618. Initializes a new instance of the <see cref="T:NPOI.HPSF.VariantTypeException"/> class.
  5619. </summary>
  5620. <param name="variantType">The variant type causing the problem</param>
  5621. <param name="value">The value who's variant type causes the problem</param>
  5622. <param name="msg">A message text describing the problem</param>
  5623. </member>
  5624. <member name="P:NPOI.HPSF.VariantTypeException.VariantType">
  5625. <summary>
  5626. Gets the offending variant type
  5627. </summary>
  5628. <value>the offending variant type.</value>
  5629. </member>
  5630. <member name="P:NPOI.HPSF.VariantTypeException.Value">
  5631. <summary>
  5632. Returns the value who's variant type caused the problem.
  5633. </summary>
  5634. <value>the value who's variant type caused the problem.</value>
  5635. </member>
  5636. <member name="T:NPOI.HPSF.Wellknown.PropertyIDMap">
  5637. <summary>
  5638. This is a dictionary which maps property ID values To property
  5639. ID strings.
  5640. The methods {@link #GetSummaryInformationProperties} and {@link
  5641. #GetDocumentSummaryInformationProperties} return singleton {@link
  5642. PropertyIDMap}s. An application that wants To extend these maps
  5643. should treat them as unmodifiable, copy them and modifiy the
  5644. copies.
  5645. @author Rainer Klute
  5646. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5647. @since 2002-02-09
  5648. </summary>
  5649. </member>
  5650. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TITLE">
  5651. ID of the property that denotes the document's title
  5652. </member>
  5653. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SUBJECT">
  5654. ID of the property that denotes the document's subject
  5655. </member>
  5656. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_AUTHOR">
  5657. ID of the property that denotes the document's author
  5658. </member>
  5659. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_KEYWORDS">
  5660. ID of the property that denotes the document's keywords
  5661. </member>
  5662. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMMENTS">
  5663. ID of the property that denotes the document's comments
  5664. </member>
  5665. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_TEMPLATE">
  5666. ID of the property that denotes the document's template
  5667. </member>
  5668. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTAUTHOR">
  5669. ID of the property that denotes the document's last author
  5670. </member>
  5671. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_REVNUMBER">
  5672. ID of the property that denotes the document's revision number
  5673. </member>
  5674. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_EDITTIME">
  5675. ID of the property that denotes the document's edit time
  5676. </member>
  5677. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTPRINTED">
  5678. ID of the property that denotes the DateTime and time the document was
  5679. last printed
  5680. </member>
  5681. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_Create_DTM">
  5682. ID of the property that denotes the DateTime and time the document was
  5683. Created.
  5684. </member>
  5685. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LASTSAVE_DTM">
  5686. ID of the property that denotes the DateTime and time the document was
  5687. saved
  5688. </member>
  5689. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PAGECOUNT">
  5690. ID of the property that denotes the number of pages in the
  5691. document
  5692. </member>
  5693. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_WORDCOUNT">
  5694. ID of the property that denotes the number of words in the
  5695. document
  5696. </member>
  5697. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CHARCOUNT">
  5698. ID of the property that denotes the number of characters in the
  5699. document
  5700. </member>
  5701. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_THUMBNAIL">
  5702. ID of the property that denotes the document's thumbnail
  5703. </member>
  5704. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_APPNAME">
  5705. ID of the property that denotes the application that Created the
  5706. document
  5707. </member>
  5708. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SECURITY">
  5709. ID of the property that denotes whether Read/Write access To the
  5710. document is allowed or whether is should be opened as Read-only. It can
  5711. have the following values:
  5712. <table>
  5713. <tbody>
  5714. <tr>
  5715. <th>Value</th>
  5716. <th>Description</th>
  5717. </tr>
  5718. <tr>
  5719. <th>0</th>
  5720. <th>No restriction</th>
  5721. </tr>
  5722. <tr>
  5723. <th>2</th>
  5724. <th>Read-only recommended</th>
  5725. </tr>
  5726. <tr>
  5727. <th>4</th>
  5728. <th>Read-only enforced</th>
  5729. </tr>
  5730. </tbody>
  5731. </table>
  5732. </member>
  5733. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DICTIONARY">
  5734. The entry is a dictionary.
  5735. </member>
  5736. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CODEPAGE">
  5737. The entry denotes a code page.
  5738. </member>
  5739. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_CATEGORY">
  5740. The entry is a string denoting the category the file belongs
  5741. To, e.g. review, memo, etc. This is useful To Find documents of
  5742. same type.
  5743. </member>
  5744. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PRESFORMAT">
  5745. TarGet format for power point presentation, e.g. 35mm,
  5746. printer, video etc.
  5747. </member>
  5748. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_BYTECOUNT">
  5749. Number of bytes.
  5750. </member>
  5751. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINECOUNT">
  5752. Number of lines.
  5753. </member>
  5754. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_PARCOUNT">
  5755. Number of paragraphs.
  5756. </member>
  5757. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SLIDECOUNT">
  5758. Number of slides in a power point presentation.
  5759. </member>
  5760. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_NOTECOUNT">
  5761. Number of slides with notes.
  5762. </member>
  5763. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HIDDENCOUNT">
  5764. Number of hidden slides.
  5765. </member>
  5766. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MMCLIPCOUNT">
  5767. Number of multimedia clips, e.g. sound or video.
  5768. </member>
  5769. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_SCALE">
  5770. This entry is Set To -1 when scaling of the thumbnail Is
  5771. desired. Otherwise the thumbnail should be cropped.
  5772. </member>
  5773. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_HEADINGPAIR">
  5774. This entry denotes an internally used property. It is a
  5775. vector of variants consisting of pairs of a string (VT_LPSTR)
  5776. and a number (VT_I4). The string is a heading name, and the
  5777. number tells how many document parts are under that
  5778. heading.
  5779. </member>
  5780. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_DOCPARTS">
  5781. This entry Contains the names of document parts (word: names
  5782. of the documents in the master document, excel: sheet names,
  5783. power point: slide titles, binder: document names).
  5784. </member>
  5785. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MANAGER">
  5786. This entry Contains the name of the project manager.
  5787. </member>
  5788. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_COMPANY">
  5789. This entry Contains the company name.
  5790. </member>
  5791. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_LINKSDIRTY">
  5792. If this entry is -1 the links are dirty and should be
  5793. re-evaluated.
  5794. </member>
  5795. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.PID_MAX">
  5796. The highest well-known property ID. Applications are free To use higher values for custom purposes.
  5797. </member>
  5798. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.summaryInformationProperties">
  5799. Contains the summary information property ID values and
  5800. associated strings. See the overall HPSF documentation for
  5801. details!
  5802. </member>
  5803. <member name="F:NPOI.HPSF.Wellknown.PropertyIDMap.documentSummaryInformationProperties">
  5804. Contains the summary information property ID values and
  5805. associated strings. See the overall HPSF documentation for
  5806. details!
  5807. </member>
  5808. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Int32,System.Single)">
  5809. <summary>
  5810. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5811. </summary>
  5812. <param name="initialCapacity">initialCapacity The initial capacity as defined for
  5813. {@link HashMap}</param>
  5814. <param name="loadFactor">The load factor as defined for {@link HashMap}</param>
  5815. </member>
  5816. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.#ctor(System.Collections.IDictionary)">
  5817. <summary>
  5818. Initializes a new instance of the <see cref="T:NPOI.HPSF.Wellknown.PropertyIDMap"/> class.
  5819. </summary>
  5820. <param name="map">The instance To be Created is backed by this map.</param>
  5821. </member>
  5822. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Put(System.Int64,System.String)">
  5823. <summary>
  5824. Puts a ID string for an ID into the {@link
  5825. PropertyIDMap}.
  5826. </summary>
  5827. <param name="id">The ID string.</param>
  5828. <param name="idString">The id string.</param>
  5829. <returns>As specified by the {@link java.util.Map} interface, this method
  5830. returns the previous value associated with the specified id</returns>
  5831. </member>
  5832. <member name="M:NPOI.HPSF.Wellknown.PropertyIDMap.Get(System.Int64)">
  5833. <summary>
  5834. Gets the ID string for an ID from the {@link
  5835. PropertyIDMap}.
  5836. </summary>
  5837. <param name="id">The ID.</param>
  5838. <returns>The ID string associated with id</returns>
  5839. </member>
  5840. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.SummaryInformationProperties">
  5841. <summary>
  5842. Gets the Summary Information properties singleton
  5843. </summary>
  5844. <returns></returns>
  5845. </member>
  5846. <member name="P:NPOI.HPSF.Wellknown.PropertyIDMap.DocumentSummaryInformationProperties">
  5847. <summary>
  5848. Gets the Document Summary Information properties
  5849. singleton.
  5850. </summary>
  5851. <returns>The Document Summary Information properties singleton.</returns>
  5852. </member>
  5853. <member name="T:NPOI.HPSF.Wellknown.SectionIDMap">
  5854. <summary>
  5855. Maps section format IDs To {@link PropertyIDMap}s. It Is
  5856. initialized with two well-known section format IDs: those of the
  5857. <c>\005SummaryInformation</c> stream and the
  5858. <c>\005DocumentSummaryInformation</c> stream.
  5859. If you have a section format ID you can use it as a key To query
  5860. this map. If you Get a {@link PropertyIDMap} returned your section
  5861. is well-known and you can query the {@link PropertyIDMap} for PID
  5862. strings. If you Get back <c>null</c> you are on your own.
  5863. This {@link java.util.Map} expects the byte arrays of section format IDs
  5864. as keys. A key maps To a {@link PropertyIDMap} describing the
  5865. property IDs in sections with the specified section format ID.
  5866. @author Rainer Klute (klute@rainer-klute.de)
  5867. @since 2002-02-09
  5868. </summary>
  5869. </member>
  5870. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.SUMMARY_INFORMATION_ID">
  5871. The SummaryInformation's section's format ID.
  5872. </member>
  5873. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.DOCUMENT_SUMMARY_INFORMATION_ID1">
  5874. The DocumentSummaryInformation's first and second sections' format
  5875. ID.
  5876. </member>
  5877. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.UNDEFINED">
  5878. A property without a known name is described by this string.
  5879. </member>
  5880. <member name="F:NPOI.HPSF.Wellknown.SectionIDMap.defaultMap">
  5881. The default section ID map. It maps section format IDs To
  5882. {@link PropertyIDMap}s.
  5883. </member>
  5884. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetInstance">
  5885. <summary>
  5886. Returns the singleton instance of the default {@link
  5887. SectionIDMap}.
  5888. </summary>
  5889. <returns>The instance value</returns>
  5890. </member>
  5891. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.GetPIDString(System.Byte[],System.Int64)">
  5892. <summary>
  5893. Returns the property ID string that is associated with a
  5894. given property ID in a section format ID's namespace.
  5895. </summary>
  5896. <param name="sectionFormatID">Each section format ID has its own name
  5897. space of property ID strings and thus must be specified.</param>
  5898. <param name="pid">The property ID</param>
  5899. <returns>The well-known property ID string associated with the
  5900. property ID pid in the name space spanned by sectionFormatID If the pid
  5901. sectionFormatID combination is not well-known, the
  5902. string "[undefined]" is returned.
  5903. </returns>
  5904. </member>
  5905. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Byte[])">
  5906. <summary>
  5907. Returns the {@link PropertyIDMap} for a given section format
  5908. ID.
  5909. </summary>
  5910. <param name="sectionFormatID">The section format ID.</param>
  5911. <returns>the property ID map</returns>
  5912. </member>
  5913. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Get(System.Object)">
  5914. <summary>
  5915. Returns the {@link PropertyIDMap} for a given section format
  5916. ID.
  5917. </summary>
  5918. <param name="sectionFormatID">A section format ID as a
  5919. <c>byte[]</c></param>
  5920. <returns>the property ID map</returns>
  5921. </member>
  5922. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Byte[],NPOI.HPSF.Wellknown.PropertyIDMap)">
  5923. <summary>
  5924. Associates a section format ID with a {@link
  5925. PropertyIDMap}.
  5926. </summary>
  5927. <param name="sectionFormatID">the section format ID</param>
  5928. <param name="propertyIDMap">The property ID map.</param>
  5929. <returns></returns>
  5930. </member>
  5931. <member name="M:NPOI.HPSF.Wellknown.SectionIDMap.Put(System.Object,System.Object)">
  5932. <summary>
  5933. Puts the specified key.
  5934. </summary>
  5935. <param name="key">This parameter remains undocumented since the method Is
  5936. deprecated.</param>
  5937. <param name="value">This parameter remains undocumented since the method Is
  5938. deprecated.</param>
  5939. <returns>The return value remains undocumented since the method Is
  5940. deprecated.</returns>
  5941. </member>
  5942. <member name="T:NPOI.HPSF.WritingNotSupportedException">
  5943. <summary>
  5944. This exception is thrown when trying To Write a (yet) unsupported variant
  5945. type.
  5946. @see ReadingNotSupportedException
  5947. @see UnsupportedVariantTypeException
  5948. @author Rainer Klute
  5949. <a href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
  5950. @since 2003-08-08
  5951. </summary>
  5952. </member>
  5953. <member name="M:NPOI.HPSF.WritingNotSupportedException.#ctor(System.Int64,System.Object)">
  5954. <summary>
  5955. Initializes a new instance of the <see cref="T:NPOI.HPSF.WritingNotSupportedException"/> class.
  5956. </summary>
  5957. <param name="variantType">The unsupported variant type.</param>
  5958. <param name="value">The value</param>
  5959. </member>
  5960. <member name="T:NPOI.HSSF.EventModel.IERFListener">
  5961. An ERFListener Is registered with the EventRecordFactory.
  5962. An ERFListener listens for Records coming from the stream
  5963. via the EventRecordFactory
  5964. @see EventRecordFactory
  5965. @author Andrew C. Oliver acoliver@apache.org
  5966. </member>
  5967. <member name="M:NPOI.HSSF.EventModel.IERFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  5968. Process a Record. This method Is called by the
  5969. EventRecordFactory when a record Is returned.
  5970. @return bool specifying whether the effort was a success.
  5971. </member>
  5972. <member name="T:NPOI.HSSF.EventModel.EventRecordFactory">
  5973. Event-based record factory. As opposed to RecordFactory
  5974. this refactored version throws record events as it comes
  5975. accross the records. I throws the "lazily" one record behind
  5976. to ensure that ContinueRecords are Processed first.
  5977. @author Andrew C. Oliver (acoliver@apache.org) - probably to blame for the bugs (so yank his chain on the list)
  5978. @author Marc Johnson (mjohnson at apache dot org) - methods taken from RecordFactory
  5979. @author Glen Stampoultzis (glens at apache.org) - methods taken from RecordFactory
  5980. @author Csaba Nagy (ncsaba at yahoo dot com)
  5981. </member>
  5982. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.#ctor(NPOI.HSSF.EventModel.IERFListener,System.Collections.ArrayList)">
  5983. Create an EventRecordFactory
  5984. @param abortable specifies whether the return from the listener
  5985. handler functions are obeyed. False means they are ignored. True
  5986. means the event loop exits on error.
  5987. </member>
  5988. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecord(NPOI.HSSF.Record.Record)">
  5989. sends the record event to all registered listeners.
  5990. @param record the record to be thrown.
  5991. @return <c>false</c> to abort. This aborts
  5992. out of the event loop should the listener return false
  5993. </member>
  5994. <member name="M:NPOI.HSSF.EventModel.EventRecordFactory.ProcessRecords(System.IO.Stream)">
  5995. Create an array of records from an input stream
  5996. @param in the InputStream from which the records will be
  5997. obtained
  5998. @exception RecordFormatException on error Processing the
  5999. InputStream
  6000. </member>
  6001. <member name="T:NPOI.HSSF.EventUserModel.AbortableHSSFListener">
  6002. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  6003. a listener supporting this interface and register it with the HSSFRequest (associating
  6004. it with Record SID's).
  6005. @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
  6006. @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  6007. @see org.apache.poi.hssf.eventusermodel.HSSFUserException
  6008. @author Carey Sublette (careysub@earthling.net)
  6009. </member>
  6010. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6011. This method, inherited from HSSFListener Is implemented as a stub.
  6012. It Is never called by HSSFEventFActory or HSSFRequest.
  6013. </member>
  6014. <member name="M:NPOI.HSSF.EventUserModel.AbortableHSSFListener.AbortableProcessRecord(NPOI.HSSF.Record.Record)">
  6015. Process an HSSF Record. Called when a record occurs in an HSSF file.
  6016. Provides two options for halting the Processing of the HSSF file.
  6017. The return value provides a means of non-error termination with a
  6018. user-defined result code. A value of zero must be returned to
  6019. continue Processing, any other value will halt Processing by
  6020. <c>HSSFEventFactory</c> with the code being passed back by
  6021. its abortable Process events methods.
  6022. Error termination can be done by throwing the HSSFUserException.
  6023. Note that HSSFEventFactory will not call the inherited Process
  6024. @return result code of zero for continued Processing.
  6025. @throws HSSFUserException User code can throw this to abort
  6026. file Processing by HSSFEventFactory and return diagnostic information.
  6027. </member>
  6028. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.DummyRecordBase">
  6029. </member>
  6030. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord">
  6031. A dummy record to indicate that we've now had the last
  6032. cell record for this row.
  6033. </member>
  6034. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.Row">
  6035. Returns the (0 based) number of the row we are
  6036. currently working on.
  6037. </member>
  6038. <member name="P:NPOI.HSSF.EventUserModel.DummyRecord.LastCellOfRowDummyRecord.LastColumnNumber">
  6039. Returns the (0 based) number of the last column
  6040. seen for this row. You should have alReady been
  6041. called with that record.
  6042. This Is -1 in the case of there being no columns
  6043. for the row.
  6044. </member>
  6045. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingCellDummyRecord">
  6046. A dummy record for when we're missing a cell in a row,
  6047. but still want to trigger something
  6048. </member>
  6049. <member name="T:NPOI.HSSF.EventUserModel.DummyRecord.MissingRowDummyRecord">
  6050. A dummy record for when we're missing a row, but still
  6051. want to trigger something
  6052. </member>
  6053. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder">
  6054. <summary>
  6055. When working with the EventUserModel, if you want to
  6056. Process formulas, you need an instance of
  6057. Workbook to pass to a HSSFWorkbook,
  6058. to finally give to HSSFFormulaParser,
  6059. and this will build you stub ones.
  6060. Since you're working with the EventUserModel, you
  6061. wouldn't want to Get a full Workbook and
  6062. HSSFWorkbook, as they would eat too much memory.
  6063. Instead, you should collect a few key records as they
  6064. go past, then call this once you have them to build a
  6065. stub Workbook, and from that a stub
  6066. HSSFWorkbook, to use with the HSSFFormulaParser.
  6067. The records you should collect are:
  6068. ExternSheetRecord
  6069. BoundSheetRecord
  6070. You should probably also collect SSTRecord,
  6071. but it's not required to pass this in.
  6072. To help, this class includes a HSSFListener wrapper
  6073. that will do the collecting for you.
  6074. </summary>
  6075. </member>
  6076. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[],NPOI.HSSF.Record.SSTRecord)">
  6077. <summary>
  6078. Creates a stub Workbook from the supplied records,
  6079. suitable for use with the {@link HSSFFormulaParser}
  6080. </summary>
  6081. <param name="externs">The ExternSheetRecords in your file</param>
  6082. <param name="bounds">The BoundSheetRecords in your file</param>
  6083. <param name="sst">TThe SSTRecord in your file.</param>
  6084. <returns>A stub Workbook suitable for use with HSSFFormulaParser</returns>
  6085. </member>
  6086. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.CreateStubWorkbook(NPOI.HSSF.Record.ExternSheetRecord[],NPOI.HSSF.Record.BoundSheetRecord[])">
  6087. <summary>
  6088. Creates a stub workbook from the supplied records,
  6089. suitable for use with the HSSFFormulaParser
  6090. </summary>
  6091. <param name="externs">The ExternSheetRecords in your file</param>
  6092. <param name="bounds">A stub Workbook suitable for use with HSSFFormulaParser</param>
  6093. <returns>A stub Workbook suitable for use with {@link HSSFFormulaParser}</returns>
  6094. </member>
  6095. <member name="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener">
  6096. <summary>
  6097. A wrapping HSSFListener which will collect
  6098. BoundSheetRecords and {@link ExternSheetRecord}s as
  6099. they go past, so you can Create a Stub {@link Workbook} from
  6100. them once required.
  6101. </summary>
  6102. </member>
  6103. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  6104. <summary>
  6105. Initializes a new instance of the <see cref="T:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener"/> class.
  6106. </summary>
  6107. <param name="childListener">The child listener.</param>
  6108. </member>
  6109. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetBoundSheetRecords">
  6110. <summary>
  6111. Gets the bound sheet records.
  6112. </summary>
  6113. <returns></returns>
  6114. </member>
  6115. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetExternSheetRecords">
  6116. <summary>
  6117. Gets the extern sheet records.
  6118. </summary>
  6119. <returns></returns>
  6120. </member>
  6121. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetSSTRecord">
  6122. <summary>
  6123. Gets the SST record.
  6124. </summary>
  6125. <returns></returns>
  6126. </member>
  6127. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubHSSFWorkbook">
  6128. <summary>
  6129. Gets the stub HSSF workbook.
  6130. </summary>
  6131. <returns></returns>
  6132. </member>
  6133. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.GetStubWorkbook">
  6134. <summary>
  6135. Gets the stub workbook.
  6136. </summary>
  6137. <returns></returns>
  6138. </member>
  6139. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6140. <summary>
  6141. Process this record ourselves, and then
  6142. pass it on to our child listener
  6143. </summary>
  6144. <param name="record">The record.</param>
  6145. </member>
  6146. <member name="M:NPOI.HSSF.EventUserModel.EventWorkbookBuilder.SheetRecordCollectingListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  6147. <summary>
  6148. Process the record ourselves, but do not
  6149. pass it on to the child Listener.
  6150. </summary>
  6151. <param name="record">The record.</param>
  6152. </member>
  6153. <member name="T:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener">
  6154. A proxy HSSFListener that keeps track of the document
  6155. formatting records, and provides an easy way to look
  6156. up the format strings used by cells from their ids.
  6157. </member>
  6158. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6159. Process this record ourselves, and then
  6160. pass it on to our child listener
  6161. </member>
  6162. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.ProcessRecordInternally(NPOI.HSSF.Record.Record)">
  6163. Process the record ourselves, but do not
  6164. pass it on to the child Listener.
  6165. @param record
  6166. </member>
  6167. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface)">
  6168. Formats the given numeric of date Cell's contents
  6169. as a String, in as close as we can to the way
  6170. that Excel would do so.
  6171. Uses the various format records to manage this.
  6172. TODO - move this to a central class in such a
  6173. way that hssf.usermodel can make use of it too
  6174. </member>
  6175. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(System.Int32)">
  6176. Returns the format string, eg $##.##, for the
  6177. given number format index.
  6178. </member>
  6179. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatString(NPOI.HSSF.Record.CellValueRecordInterface)">
  6180. Returns the format string, eg $##.##, used
  6181. by your cell
  6182. </member>
  6183. <member name="M:NPOI.HSSF.EventUserModel.FormatTrackingHSSFListener.GetFormatIndex(NPOI.HSSF.Record.CellValueRecordInterface)">
  6184. Returns the index of the format string, used by your cell,
  6185. or -1 if none found
  6186. </member>
  6187. <member name="T:NPOI.HSSF.EventUserModel.HSSFEventFactory">
  6188. <summary>
  6189. Low level event based HSSF Reader. Pass either a DocumentInputStream to
  6190. Process events along with a request object or pass a POIFS POIFSFileSystem to
  6191. ProcessWorkbookEvents along with a request.
  6192. This will cause your file to be Processed a record at a time. Each record with
  6193. a static id matching one that you have registed in your HSSFRequest will be passed
  6194. to your associated HSSFListener.
  6195. @author Andrew C. Oliver (acoliver at apache dot org)
  6196. @author Carey Sublette (careysub@earthling.net)
  6197. </summary>
  6198. </member>
  6199. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.#ctor">
  6200. <summary>
  6201. Creates a new instance of HSSFEventFactory
  6202. </summary>
  6203. </member>
  6204. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6205. <summary>
  6206. Processes a file into essentially record events.
  6207. </summary>
  6208. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6209. <param name="fs">a POIFS filesystem containing your workbook</param>
  6210. </member>
  6211. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessWorkbookEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6212. <summary>
  6213. Processes a file into essentially record events.
  6214. </summary>
  6215. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6216. <param name="fs">a POIFS filesystem containing your workbook</param>
  6217. <returns>numeric user-specified result code.</returns>
  6218. </member>
  6219. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.ProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  6220. <summary>
  6221. Processes a DocumentInputStream into essentially Record events.
  6222. If an
  6223. <c>AbortableHSSFListener</c>
  6224. causes a halt to Processing during this call
  6225. the method will return just as with
  6226. <c>abortableProcessEvents</c>
  6227. , but no
  6228. user code or
  6229. <c>HSSFUserException</c>
  6230. will be passed back.
  6231. </summary>
  6232. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6233. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  6234. </member>
  6235. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.AbortableProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,System.IO.Stream)">
  6236. <summary>
  6237. Processes a DocumentInputStream into essentially Record events.
  6238. </summary>
  6239. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6240. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  6241. <returns>numeric user-specified result code.</returns>
  6242. </member>
  6243. <member name="M:NPOI.HSSF.EventUserModel.HSSFEventFactory.GenericProcessEvents(NPOI.HSSF.EventUserModel.HSSFRequest,NPOI.HSSF.Record.RecordInputStream)">
  6244. <summary>
  6245. Processes a DocumentInputStream into essentially Record events.
  6246. </summary>
  6247. <param name="req">an Instance of HSSFRequest which has your registered listeners</param>
  6248. <param name="in1">a DocumentInputStream obtained from POIFS's POIFSFileSystem object</param>
  6249. <returns>numeric user-specified result code.</returns>
  6250. </member>
  6251. <member name="T:NPOI.HSSF.EventUserModel.IHSSFListener">
  6252. <summary>
  6253. Interface for use with the HSSFRequest and HSSFEventFactory. Users should Create
  6254. a listener supporting this interface and register it with the HSSFRequest (associating
  6255. it with Record SID's).
  6256. @author acoliver@apache.org
  6257. </summary>
  6258. </member>
  6259. <member name="M:NPOI.HSSF.EventUserModel.IHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6260. <summary>
  6261. Process an HSSF Record. Called when a record occurs in an HSSF file.
  6262. </summary>
  6263. <param name="record">The record.</param>
  6264. </member>
  6265. <member name="T:NPOI.HSSF.EventUserModel.HSSFRecordStream">
  6266. <summary>
  6267. A stream based way to Get at complete records, with
  6268. as low a memory footprint as possible.
  6269. This handles Reading from a RecordInputStream, turning
  6270. the data into full records, Processing continue records
  6271. etc.
  6272. Most users should use HSSFEventFactory
  6273. HSSFListener and have new records pushed to
  6274. them, but this does allow for a "pull" style of coding.
  6275. </summary>
  6276. </member>
  6277. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.hitEOS">
  6278. Have we run out of records on the stream?
  6279. </member>
  6280. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.complete">
  6281. Have we returned all the records there are?
  6282. </member>
  6283. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.bonusRecords">
  6284. Sometimes we end up with a bunch of
  6285. records. When we do, these should
  6286. be returned before the next normal
  6287. record Processing occurs (i.e. before
  6288. we Check for continue records and
  6289. return rec)
  6290. </member>
  6291. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.rec">
  6292. The next record to return, which may need to have its
  6293. continue records passed to it before we do
  6294. </member>
  6295. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastRec">
  6296. The most recent record that we gave to the user
  6297. </member>
  6298. <member name="F:NPOI.HSSF.EventUserModel.HSSFRecordStream.lastDrawingRecord">
  6299. The most recent DrawingRecord seen
  6300. </member>
  6301. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.NextRecord">
  6302. <summary>
  6303. Returns the next (complete) record from the
  6304. stream, or null if there are no more.
  6305. </summary>
  6306. <returns></returns>
  6307. </member>
  6308. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetBonusRecord">
  6309. <summary>
  6310. If there are any "bonus" records, that should
  6311. be returned before Processing new ones,
  6312. grabs the next and returns it.
  6313. If not, returns null;
  6314. </summary>
  6315. <returns></returns>
  6316. </member>
  6317. <member name="M:NPOI.HSSF.EventUserModel.HSSFRecordStream.GetNextRecord">
  6318. <summary>
  6319. Returns the next available record, or null if
  6320. this pass didn't return a record that's
  6321. suitable for returning (eg was a continue record).
  6322. </summary>
  6323. <returns></returns>
  6324. </member>
  6325. <member name="T:NPOI.HSSF.EventUserModel.HSSFRequest">
  6326. <summary>
  6327. An HSSFRequest object should be constructed registering an instance or multiple
  6328. instances of HSSFListener with each Record.sid you wish to listen for.
  6329. @author Andrew C. Oliver (acoliver at apache dot org)
  6330. @author Carey Sublette (careysub@earthling.net)
  6331. </summary>
  6332. </member>
  6333. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.#ctor">
  6334. <summary>
  6335. Creates a new instance of HSSFRequest
  6336. </summary>
  6337. </member>
  6338. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListener(NPOI.HSSF.EventUserModel.IHSSFListener,System.Int16)">
  6339. <summary>
  6340. Add an event listener for a particular record type. The trick Is you have to know
  6341. what the records are for or just start with our examples and build on them. Alternatively,
  6342. you CAN call AddListenerForAllRecords and you'll recieve ALL record events in one listener,
  6343. but if you like to squeeze every last byte of efficiency out of life you my not like this.
  6344. (its sure as heck what I plan to do)
  6345. </summary>
  6346. <param name="lsnr">for the event</param>
  6347. <param name="sid">identifier for the record type this Is the .sid static member on the individual records</param>
  6348. </member>
  6349. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.AddListenerForAllRecords(NPOI.HSSF.EventUserModel.IHSSFListener)">
  6350. <summary>
  6351. This Is the equivilent of calling AddListener(myListener, sid) for EVERY
  6352. record in the org.apache.poi.hssf.record package. This Is for lazy
  6353. people like me. You can call this more than once with more than one listener, but
  6354. that seems like a bad thing to do from a practice-perspective Unless you have a
  6355. compelling reason to do so (like maybe you send the event two places or log it or
  6356. something?).
  6357. </summary>
  6358. <param name="lsnr">a single listener to associate with ALL records</param>
  6359. </member>
  6360. <member name="M:NPOI.HSSF.EventUserModel.HSSFRequest.ProcessRecord(NPOI.HSSF.Record.Record)">
  6361. <summary>
  6362. Called by HSSFEventFactory, passes the Record to each listener associated with
  6363. a record.sid.
  6364. Exception and return value Added 2002-04-19 by Carey Sublette
  6365. </summary>
  6366. <param name="rec">The record.</param>
  6367. <returns>numeric user-specified result code. If zero continue Processing.</returns>
  6368. </member>
  6369. <member name="T:NPOI.HSSF.EventUserModel.HSSFUserException">
  6370. <summary>
  6371. This exception Is provided as a way for API users to throw
  6372. exceptions from their event handling code. By doing so they
  6373. abort file Processing by the HSSFEventFactory and by
  6374. catching it from outside the HSSFEventFactory.ProcessEvents
  6375. method they can diagnose the cause for the abort.
  6376. The HSSFUserException supports a nested "reason"
  6377. throwable, i.e. an exception that caused this one to be thrown.
  6378. The HSSF package does not itself throw any of these
  6379. exceptions.
  6380. </summary>
  6381. <remarks>
  6382. @author Rainer Klute (klute@rainer-klute.de)
  6383. @author Carey Sublette (careysub@earthling.net)
  6384. </remarks>
  6385. </member>
  6386. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor">
  6387. <summary>
  6388. Creates a new HSSFUserException
  6389. </summary>
  6390. </member>
  6391. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String)">
  6392. <summary>
  6393. Creates a new HSSFUserException with a message
  6394. string.
  6395. </summary>
  6396. <param name="msg">The MSG.</param>
  6397. </member>
  6398. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.Exception)">
  6399. <summary>
  6400. Creates a new HSSFUserException with a reason.
  6401. </summary>
  6402. <param name="reason">The reason.</param>
  6403. </member>
  6404. <member name="M:NPOI.HSSF.EventUserModel.HSSFUserException.#ctor(System.String,System.Exception)">
  6405. <summary>
  6406. Creates a new HSSFUserException with a message string
  6407. and a reason.
  6408. </summary>
  6409. <param name="msg">The MSG.</param>
  6410. <param name="reason">The reason.</param>
  6411. </member>
  6412. <member name="T:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener">
  6413. <summary>
  6414. A HSSFListener which tracks rows and columns, and will
  6415. trigger your HSSFListener for all rows and cells,
  6416. even the ones that aren't actually stored in the file.
  6417. This allows your code to have a more "Excel" like
  6418. view of the data in the file, and not have to worry
  6419. (as much) about if a particular row/cell Is in the
  6420. file, or was skipped from being written as it was
  6421. blank.
  6422. </summary>
  6423. </member>
  6424. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.#ctor(NPOI.HSSF.EventUserModel.IHSSFListener)">
  6425. <summary>
  6426. Constructs a new MissingRecordAwareHSSFListener, which
  6427. will fire ProcessRecord on the supplied child
  6428. HSSFListener for all Records, and missing records.
  6429. </summary>
  6430. <param name="listener">The HSSFListener to pass records on to</param>
  6431. </member>
  6432. <member name="M:NPOI.HSSF.EventUserModel.MissingRecordAwareHSSFListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6433. <summary>
  6434. Process an HSSF Record. Called when a record occurs in an HSSF file.
  6435. </summary>
  6436. <param name="record"></param>
  6437. </member>
  6438. <member name="T:NPOI.HSSF.Extractor.EventBasedExcelExtractor">
  6439. <summary>
  6440. A text extractor for Excel files, that is based
  6441. on the hssf eventusermodel api.
  6442. It will typically use less memory than
  6443. ExcelExtractor, but may not provide
  6444. the same richness of formatting.
  6445. Returns the textual content of the file, suitable for
  6446. indexing by something like Lucene, but not really
  6447. intended for display to the user.
  6448. </summary>
  6449. </member>
  6450. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.DocSummaryInformation">
  6451. <summary>
  6452. Would return the document information metadata for the document,
  6453. if we supported it
  6454. </summary>
  6455. <value>The doc summary information.</value>
  6456. </member>
  6457. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.SummaryInformation">
  6458. <summary>
  6459. Would return the summary information metadata for the document,
  6460. if we supported it
  6461. </summary>
  6462. <value>The summary information.</value>
  6463. </member>
  6464. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.IncludeSheetNames">
  6465. <summary>
  6466. Should sheet names be included? Default is true
  6467. </summary>
  6468. <value>if set to <c>true</c> [include sheet names].</value>
  6469. </member>
  6470. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.FormulasNotResults">
  6471. <summary>
  6472. Should we return the formula itself, and not
  6473. the result it produces? Default is false
  6474. </summary>
  6475. <value>if set to <c>true</c> [formulas not results].</value>
  6476. </member>
  6477. <member name="P:NPOI.HSSF.Extractor.EventBasedExcelExtractor.Text">
  6478. <summary>
  6479. Retreives the text contents of the file
  6480. </summary>
  6481. <value>All the text from the document.</value>
  6482. </member>
  6483. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TriggerExtraction">
  6484. <summary>
  6485. Triggers the extraction.
  6486. </summary>
  6487. <returns></returns>
  6488. </member>
  6489. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.ProcessRecord(NPOI.HSSF.Record.Record)">
  6490. <summary>
  6491. Process an HSSF Record. Called when a record occurs in an HSSF file.
  6492. </summary>
  6493. <param name="record"></param>
  6494. </member>
  6495. <member name="M:NPOI.HSSF.Extractor.EventBasedExcelExtractor.TextListener.FormatNumberDateCell(NPOI.HSSF.Record.CellValueRecordInterface,System.Double)">
  6496. <summary>
  6497. Formats a number or date cell, be that a real number, or the
  6498. answer to a formula
  6499. </summary>
  6500. <param name="cell">The cell.</param>
  6501. <param name="value">The value.</param>
  6502. <returns></returns>
  6503. </member>
  6504. <member name="T:NPOI.HSSF.Extractor.ExcelExtractor">
  6505. <summary>
  6506. A text extractor for Excel files.
  6507. Returns the textual content of the file, suitable for
  6508. indexing by something like Lucene, but not really
  6509. intended for display to the user.
  6510. </summary>
  6511. </member>
  6512. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  6513. <summary>
  6514. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  6515. </summary>
  6516. <param name="wb">The wb.</param>
  6517. </member>
  6518. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  6519. <summary>
  6520. Initializes a new instance of the <see cref="T:NPOI.HSSF.Extractor.ExcelExtractor"/> class.
  6521. </summary>
  6522. <param name="fs">The fs.</param>
  6523. </member>
  6524. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeHeaderFooter">
  6525. <summary>
  6526. Should header and footer be included? Default is true
  6527. </summary>
  6528. </member>
  6529. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeSheetNames">
  6530. <summary>
  6531. Should sheet names be included? Default is true
  6532. </summary>
  6533. <value>if set to <c>true</c> [include sheet names].</value>
  6534. </member>
  6535. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.FormulasNotResults">
  6536. <summary>
  6537. Should we return the formula itself, and not
  6538. the result it produces? Default is false
  6539. </summary>
  6540. <value>if set to <c>true</c> [formulas not results].</value>
  6541. </member>
  6542. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeCellComments">
  6543. <summary>
  6544. Should cell comments be included? Default is false
  6545. </summary>
  6546. <value>if set to <c>true</c> [include cell comments].</value>
  6547. </member>
  6548. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.IncludeBlankCells">
  6549. <summary>
  6550. Should blank cells be output? Default is to only
  6551. output cells that are present in the file and are
  6552. non-blank.
  6553. </summary>
  6554. <value>if set to <c>true</c> [include blank cells].</value>
  6555. </member>
  6556. <member name="P:NPOI.HSSF.Extractor.ExcelExtractor.Text">
  6557. <summary>
  6558. Retreives the text contents of the file
  6559. </summary>
  6560. <value>All the text from the document.</value>
  6561. </member>
  6562. <member name="M:NPOI.HSSF.Extractor.ExcelExtractor.ExtractHeaderFooter(NPOI.SS.UserModel.IHeaderFooter)">
  6563. <summary>
  6564. Extracts the header footer.
  6565. </summary>
  6566. <param name="hf">The header or footer</param>
  6567. <returns></returns>
  6568. </member>
  6569. <member name="T:NPOI.HSSF.Extractor.OldExcelExtractor">
  6570. A text extractor for old Excel files, which are too old for
  6571. HSSFWorkbook to handle. This includes Excel 95, and very old
  6572. (pre-OLE2) Excel files, such as Excel 4 files.
  6573. <p>
  6574. Returns much (but not all) of the textual content of the file,
  6575. suitable for indexing by something like Apache Lucene, or used
  6576. by Apache Tika, but not really intended for display to the user.
  6577. </p>
  6578. </member>
  6579. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.BiffVersion">
  6580. The Biff version, largely corresponding to the Excel version
  6581. </member>
  6582. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.FileType">
  6583. The kind of the file, one of {@link BOFRecord#TYPE_WORKSHEET},
  6584. {@link BOFRecord#TYPE_CHART}, {@link BOFRecord#TYPE_EXCEL_4_MACRO}
  6585. or {@link BOFRecord#TYPE_WORKSPACE_FILE}
  6586. </member>
  6587. <member name="P:NPOI.HSSF.Extractor.OldExcelExtractor.Text">
  6588. Retrieves the text contents of the file, as best we can
  6589. for these old file formats
  6590. </member>
  6591. <member name="T:NPOI.HSSF.Model.AbstractShape">
  6592. <summary>
  6593. An abstract shape Is the lowlevel model for a shape.
  6594. @author Glen Stampoultzis (glens at apache.org)
  6595. </summary>
  6596. </member>
  6597. <member name="M:NPOI.HSSF.Model.AbstractShape.CreateShape(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  6598. <summary>
  6599. Create a new shape object used to Create the escher records.
  6600. </summary>
  6601. <param name="hssfShape">The simple shape this Is based on.</param>
  6602. <param name="shapeId">The shape id.</param>
  6603. <returns></returns>
  6604. </member>
  6605. <member name="P:NPOI.HSSF.Model.AbstractShape.SpContainer">
  6606. <summary>
  6607. The shape container and it's children that can represent this
  6608. shape.
  6609. </summary>
  6610. <value>The sp container.</value>
  6611. </member>
  6612. <member name="P:NPOI.HSSF.Model.AbstractShape.ObjRecord">
  6613. <summary>
  6614. The object record that Is associated with this shape.
  6615. </summary>
  6616. <value>The obj record.</value>
  6617. </member>
  6618. <member name="M:NPOI.HSSF.Model.AbstractShape.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  6619. <summary>
  6620. Creates an escher anchor record from a HSSFAnchor.
  6621. </summary>
  6622. <param name="userAnchor">The high level anchor to Convert.</param>
  6623. <returns>An escher anchor record.</returns>
  6624. </member>
  6625. <member name="M:NPOI.HSSF.Model.AbstractShape.AddStandardOptions(NPOI.HSSF.UserModel.HSSFShape,NPOI.DDF.EscherOptRecord)">
  6626. <summary>
  6627. Add standard properties to the opt record. These properties effect
  6628. all records.
  6629. </summary>
  6630. <param name="shape">The user model shape.</param>
  6631. <param name="opt">The opt record to Add the properties to.</param>
  6632. <returns>The number of options Added.</returns>
  6633. </member>
  6634. <member name="M:NPOI.HSSF.Model.AbstractShape.GetCmoObjectId(System.Int32)">
  6635. <summary>
  6636. Generate id for the CommonObjectDataSubRecord that stands behind this shape
  6637. </summary>
  6638. <param name="shapeId">shape id as generated by drawing manager</param>
  6639. <returns>object id that will be assigned to the Obj record</returns>
  6640. </member>
  6641. <member name="M:NPOI.HSSF.Model.ComboboxShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  6642. Creates the low evel records for a combobox.
  6643. @param hssfShape The highlevel shape.
  6644. @param shapeId The shape id to use for this shape.
  6645. </member>
  6646. <member name="M:NPOI.HSSF.Model.ComboboxShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  6647. Creates the low level OBJ record for this shape.
  6648. </member>
  6649. <member name="M:NPOI.HSSF.Model.ComboboxShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  6650. Generates the escher shape records for this shape.
  6651. </member>
  6652. <member name="T:NPOI.HSSF.Model.CommentShape">
  6653. <summary>
  6654. Represents a cell comment.
  6655. This class Converts highlevel model data from HSSFComment
  6656. to low-level records.
  6657. @author Yegor Kozlov
  6658. </summary>
  6659. </member>
  6660. <member name="M:NPOI.HSSF.Model.CommentShape.#ctor(NPOI.HSSF.UserModel.HSSFComment,System.Int32)">
  6661. <summary>
  6662. Creates the low-level records for a comment.
  6663. </summary>
  6664. <param name="hssfShape">The highlevel shape.</param>
  6665. <param name="shapeId">The shape id to use for this shape.</param>
  6666. </member>
  6667. <member name="M:NPOI.HSSF.Model.CommentShape.CreateNoteRecord(NPOI.HSSF.UserModel.HSSFComment,System.Int32)">
  6668. <summary>
  6669. Creates the low level NoteRecord
  6670. which holds the comment attributes.
  6671. </summary>
  6672. <param name="shape">The shape.</param>
  6673. <param name="shapeId">The shape id.</param>
  6674. <returns></returns>
  6675. </member>
  6676. <member name="M:NPOI.HSSF.Model.CommentShape.AddStandardOptions(NPOI.HSSF.UserModel.HSSFShape,NPOI.DDF.EscherOptRecord)">
  6677. <summary>
  6678. Sets standard escher options for a comment.
  6679. This method is responsible for Setting default background,
  6680. shading and other comment properties.
  6681. </summary>
  6682. <param name="shape">The highlevel shape.</param>
  6683. <param name="opt">The escher records holding the proerties</param>
  6684. <returns>The number of escher options added</returns>
  6685. </member>
  6686. <member name="P:NPOI.HSSF.Model.CommentShape.NoteRecord">
  6687. <summary>
  6688. Gets the NoteRecord holding the comment attributes
  6689. </summary>
  6690. <value>The NoteRecord</value>
  6691. </member>
  6692. <member name="M:NPOI.HSSF.Model.ConvertAnchor.CreateAnchor(NPOI.HSSF.UserModel.HSSFAnchor)">
  6693. <summary>
  6694. Creates the anchor.
  6695. </summary>
  6696. <param name="userAnchor">The user anchor.</param>
  6697. <returns></returns>
  6698. </member>
  6699. <member name="T:NPOI.HSSF.Model.DrawingManager">
  6700. Provides utilities to manage drawing Groups.
  6701. @author Glen Stampoultzis (glens at apache.org)
  6702. </member>
  6703. <member name="M:NPOI.HSSF.Model.DrawingManager.AllocateShapeId(System.Int16)">
  6704. Allocates new shape id for the new drawing Group id.
  6705. @return a new shape id.
  6706. </member>
  6707. <member name="T:NPOI.HSSF.Model.DrawingManager2">
  6708. <summary>
  6709. Provides utilities to manage drawing Groups.
  6710. </summary>
  6711. <remarks>
  6712. Glen Stampoultzis (glens at apache.org)
  6713. </remarks>
  6714. </member>
  6715. <member name="M:NPOI.HSSF.Model.DrawingManager2.ClearDrawingGroups">
  6716. <summary>
  6717. Clears the cached list of drawing Groups
  6718. </summary>
  6719. </member>
  6720. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16)">
  6721. <summary>
  6722. Allocates new shape id for the new drawing Group id.
  6723. </summary>
  6724. <param name="drawingGroupId"></param>
  6725. <returns>a new shape id.</returns>
  6726. </member>
  6727. <member name="M:NPOI.HSSF.Model.DrawingManager2.AllocateShapeId(System.Int16,NPOI.DDF.EscherDgRecord)">
  6728. <summary>
  6729. Allocates new shape id for the new drawing group id.
  6730. </summary>
  6731. <param name="drawingGroupId"></param>
  6732. <param name="dg"></param>
  6733. <returns>a new shape id.</returns>
  6734. </member>
  6735. <member name="M:NPOI.HSSF.Model.DrawingManager2.FindNewDrawingGroupId">
  6736. <summary>
  6737. Finds the next available (1 based) drawing Group id
  6738. </summary>
  6739. <returns></returns>
  6740. </member>
  6741. <member name="T:NPOI.HSSF.Model.HSSFFormulaParser">
  6742. HSSF wrapper for the {@link FormulaParser} and {@link FormulaRenderer}
  6743. @author Josh Micich
  6744. </member>
  6745. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  6746. Convenience method for parsing cell formulas. see {@link #parse(String, HSSFWorkbook, int)}
  6747. </member>
  6748. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType)">
  6749. @param formulaType a constant from {@link FormulaType}
  6750. @return the parsed formula tokens
  6751. </member>
  6752. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.Parse(System.String,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  6753. @param formula the formula to parse
  6754. @param workbook the parent workbook
  6755. @param formulaType a constant from {@link FormulaType}
  6756. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  6757. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  6758. the scope of the name will be ignored and the parser will match named ranges only by name
  6759. @return the parsed formula tokens
  6760. </member>
  6761. <member name="M:NPOI.HSSF.Model.HSSFFormulaParser.ToFormulaString(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  6762. Static method to convert an array of {@link Ptg}s in RPN order
  6763. to a human readable string format in infix mode.
  6764. @param book used for defined names and 3D references
  6765. @param ptgs must not be <c>null</c>
  6766. @return a human readable String
  6767. </member>
  6768. <member name="M:NPOI.HSSF.Model.InternalChart.GetMargin(NPOI.SS.UserModel.MarginType)">
  6769. Gets the size of the margin in inches.
  6770. @param margin which margin to Get
  6771. @return the size of the margin
  6772. </member>
  6773. <member name="M:NPOI.HSSF.Model.InternalChart.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  6774. Sets the size of the margin in inches.
  6775. @param margin which margin to Get
  6776. @param size the size of the margin
  6777. </member>
  6778. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleSERIESDATA(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6779. <summary>
  6780. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  6781. </summary>
  6782. <param name="records"></param>
  6783. </member>
  6784. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleAXES">
  6785. <summary>
  6786. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  6787. </summary>
  6788. </member>
  6789. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleAXISPARENT(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6790. <summary>
  6791. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  6792. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar / RadarArea / Surf)
  6793. CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat) *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  6794. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  6795. </summary>
  6796. <param name="records"></param>
  6797. </member>
  6798. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleDFTTEXT(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6799. <summary>
  6800. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  6801. </summary>
  6802. <param name="records"></param>
  6803. </member>
  6804. <member name="M:NPOI.HSSF.Model.InternalChart.CreateRuleATTACHEDLABEL(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  6805. <summary>
  6806. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  6807. </summary>
  6808. </member>
  6809. <member name="T:NPOI.HSSF.Model.InternalSheet">
  6810. <summary>
  6811. Low level model implementation of a Sheet (one workbook Contains many sheets)
  6812. This file Contains the low level binary records starting at the sheets BOF and
  6813. ending with the sheets EOF. Use HSSFSheet for a high level representation.
  6814. The structures of the highlevel API use references to this to perform most of their
  6815. operations. Its probably Unwise to use these low level structures directly Unless you
  6816. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  6817. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  6818. before even attempting to use this.
  6819. </summary>
  6820. <remarks>
  6821. @author Andrew C. Oliver (acoliver at apache dot org)
  6822. @author Glen Stampoultzis (glens at apache.org)
  6823. @author Shawn Laubach (slaubach at apache dot org) Gridlines, Headers, Footers, PrintSetup, and Setting Default Column Styles
  6824. @author Jason Height (jheight at chariot dot net dot au) Clone support. DBCell and Index Record writing support
  6825. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  6826. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little)
  6827. </remarks>
  6828. </member>
  6829. <member name="F:NPOI.HSSF.Model.InternalSheet._mergedCellsTable">
  6830. java object always present, but if empty no BIFF records are written
  6831. </member>
  6832. <member name="F:NPOI.HSSF.Model.InternalSheet._dimensions">
  6833. the DimensionsRecord is always present
  6834. </member>
  6835. <member name="F:NPOI.HSSF.Model.InternalSheet._isUncalced">
  6836. Add an UncalcedRecord if not true indicating formulas have not been calculated
  6837. </member>
  6838. <member name="M:NPOI.HSSF.Model.InternalSheet.CloneSheet">
  6839. <summary>
  6840. Clones the low level records of this sheet and returns the new sheet instance.
  6841. This method is implemented by Adding methods for deep cloning to all records that
  6842. can be Added to a sheet. The Record object does not implement Cloneable.
  6843. When Adding a new record, implement a public Clone method if and only if the record
  6844. belongs to a sheet.
  6845. </summary>
  6846. <returns></returns>
  6847. </member>
  6848. <member name="M:NPOI.HSSF.Model.InternalSheet.GetValueRecords">
  6849. <summary>
  6850. get the NEXT value record (from LOC). The first record that is a value record
  6851. (starting at LOC) will be returned.
  6852. This method is "loc" sensitive. Meaning you need to set LOC to where you
  6853. want it to start searching. If you don't know do this: setLoc(getDimsLoc).
  6854. When adding several rows you can just start at the last one by leaving loc
  6855. at what this sets it to. For this method, set loc to dimsloc to start with,
  6856. subsequent calls will return values in (physical) sequence or NULL when you get to the end.
  6857. </summary>
  6858. <returns>the next value record or NULL if there are no more</returns>
  6859. </member>
  6860. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet(NPOI.HSSF.Model.RecordStream)">
  6861. <summary>
  6862. Creates the sheet.
  6863. </summary>
  6864. <param name="rs">The stream.</param>
  6865. <returns></returns>
  6866. </member>
  6867. <member name="M:NPOI.HSSF.Model.InternalSheet.#ctor(NPOI.HSSF.Model.RecordStream)">
  6868. <summary>
  6869. Initializes a new instance of the <see cref="T:NPOI.HSSF.Model.InternalSheet"/> class.
  6870. </summary>
  6871. <param name="rs">The stream.</param>
  6872. </member>
  6873. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSheet">
  6874. <summary>
  6875. Creates a sheet with all the usual records minus values and the "index"
  6876. record (not required). Sets the location pointer to where the first value
  6877. records should go. Use this to Create a sheet from "scratch".
  6878. </summary>
  6879. <returns>Sheet object with all values Set to defaults</returns>
  6880. </member>
  6881. <member name="M:NPOI.HSSF.Model.InternalSheet.AddMergedRegion(System.Int32,System.Int32,System.Int32,System.Int32)">
  6882. <summary>
  6883. Adds the merged region.
  6884. </summary>
  6885. <param name="rowFrom">the row index From </param>
  6886. <param name="colFrom">The column index From.</param>
  6887. <param name="rowTo">The row index To</param>
  6888. <param name="colTo">The column To.</param>
  6889. <returns></returns>
  6890. </member>
  6891. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveMergedRegion(System.Int32)">
  6892. <summary>
  6893. Removes the merged region.
  6894. </summary>
  6895. <param name="index">The index.</param>
  6896. </member>
  6897. <member name="P:NPOI.HSSF.Model.InternalSheet.ColumnInfos">
  6898. <summary>
  6899. Gets the column infos.
  6900. </summary>
  6901. <value>The column infos.</value>
  6902. </member>
  6903. <member name="M:NPOI.HSSF.Model.InternalSheet.GetMergedRegionAt(System.Int32)">
  6904. <summary>
  6905. Gets the merged region at.
  6906. </summary>
  6907. <param name="index">The index.</param>
  6908. <returns></returns>
  6909. </member>
  6910. <member name="P:NPOI.HSSF.Model.InternalSheet.NumMergedRegions">
  6911. <summary>
  6912. Gets the number of merged regions.
  6913. </summary>
  6914. <value>The number merged regions.</value>
  6915. </member>
  6916. <member name="P:NPOI.HSSF.Model.InternalSheet.NumConditionalFormattings">
  6917. <summary>
  6918. Gets the number of conditional formattings.
  6919. </summary>
  6920. <value>The number of conditional formattings.</value>
  6921. </member>
  6922. <member name="M:NPOI.HSSF.Model.InternalSheet.SetDimensions(System.Int32,System.Int16,System.Int32,System.Int16)">
  6923. <summary>
  6924. Per an earlier reported bug in working with Andy Khan's excel Read library. This
  6925. Sets the values in the sheet's DimensionsRecord object to be correct. Excel doesn't
  6926. really care, but we want to play nice with other libraries.
  6927. </summary>
  6928. <param name="firstrow">The first row.</param>
  6929. <param name="firstcol">The first column.</param>
  6930. <param name="lastrow">The last row.</param>
  6931. <param name="lastcol">The last column.</param>
  6932. </member>
  6933. <member name="P:NPOI.HSSF.Model.InternalSheet.PreOffset">
  6934. <summary>
  6935. Gets or Sets the preoffset when using DBCELL records (currently Unused) - this Is
  6936. the position of this sheet within the whole file.
  6937. </summary>
  6938. <value>the offset of the sheet's BOF within the file.</value>
  6939. </member>
  6940. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRow(System.Int32)">
  6941. <summary>
  6942. Create a row record. (does not Add it to the records contained in this sheet)
  6943. </summary>
  6944. <param name="row">row number</param>
  6945. <returns>RowRecord Created for the passed in row number</returns>
  6946. </member>
  6947. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateLabelSST(System.Int32,System.Int16,System.Int32)">
  6948. <summary>
  6949. Create a LABELSST Record (does not Add it to the records contained in this sheet)
  6950. </summary>
  6951. <param name="row">the row the LabelSST Is a member of</param>
  6952. <param name="col">the column the LabelSST defines</param>
  6953. <param name="index">the index of the string within the SST (use workbook AddSSTString method)</param>
  6954. <returns>LabelSSTRecord newly Created containing your SST Index, row,col.</returns>
  6955. </member>
  6956. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateNumber(System.Int32,System.Int16,System.Double)">
  6957. <summary>
  6958. Create a NUMBER Record (does not Add it to the records contained in this sheet)
  6959. </summary>
  6960. <param name="row">the row the NumberRecord is a member of</param>
  6961. <param name="col">the column the NumberRecord defines</param>
  6962. <param name="value">value for the number record</param>
  6963. <returns>NumberRecord for that row, col containing that value as Added to the sheet</returns>
  6964. </member>
  6965. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBlank(System.Int32,System.Int16)">
  6966. <summary>
  6967. Create a BLANK record (does not Add it to the records contained in this sheet)
  6968. </summary>
  6969. <param name="row">the row the BlankRecord is a member of</param>
  6970. <param name="col">the column the BlankRecord is a member of</param>
  6971. <returns></returns>
  6972. </member>
  6973. <member name="M:NPOI.HSSF.Model.InternalSheet.AddValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  6974. <summary>
  6975. Adds a value record to the sheet's contained binary records
  6976. (i.e. LabelSSTRecord or NumberRecord).
  6977. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  6978. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  6979. When Adding several rows you can just start at the last one by leaving loc
  6980. at what this Sets it to.
  6981. </summary>
  6982. <param name="row">the row to Add the cell value to</param>
  6983. <param name="col">the cell value record itself.</param>
  6984. </member>
  6985. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveValueRecord(System.Int32,NPOI.HSSF.Record.CellValueRecordInterface)">
  6986. <summary>
  6987. Remove a value record from the records array.
  6988. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  6989. </summary>
  6990. <param name="row">the row of the value record you wish to Remove</param>
  6991. <param name="col">a record supporting the CellValueRecordInterface.</param>
  6992. </member>
  6993. <member name="M:NPOI.HSSF.Model.InternalSheet.ReplaceValueRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  6994. <summary>
  6995. Replace a value record from the records array.
  6996. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  6997. </summary>
  6998. <param name="newval">a record supporting the CellValueRecordInterface. this will Replace
  6999. the cell value with the same row and column. If there Isn't one, one will
  7000. be Added.</param>
  7001. </member>
  7002. <member name="M:NPOI.HSSF.Model.InternalSheet.AddRow(NPOI.HSSF.Record.RowRecord)">
  7003. <summary>
  7004. Adds a row record to the sheet
  7005. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  7006. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  7007. When Adding several rows you can just start at the last one by leaving loc
  7008. at what this Sets it to.
  7009. </summary>
  7010. <param name="row">the row record to be Added</param>
  7011. </member>
  7012. <member name="M:NPOI.HSSF.Model.InternalSheet.RemoveRow(NPOI.HSSF.Record.RowRecord)">
  7013. <summary>
  7014. Removes a row record
  7015. This method is not loc sensitive, it Resets loc to = dimsloc so no worries.
  7016. </summary>
  7017. <param name="row">the row record to Remove</param>
  7018. </member>
  7019. <member name="P:NPOI.HSSF.Model.InternalSheet.NextRow">
  7020. <summary>
  7021. Get the NEXT RowRecord (from LOC). The first record that is a Row record
  7022. (starting at LOC) will be returned.
  7023. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  7024. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  7025. When Adding several rows you can just start at the last one by leaving loc
  7026. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  7027. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  7028. </summary>
  7029. <value>RowRecord representing the next row record or NULL if there are no more</value>
  7030. </member>
  7031. <member name="M:NPOI.HSSF.Model.InternalSheet.GetRow(System.Int32)">
  7032. <summary>
  7033. Get the NEXT (from LOC) RowRecord where rownumber matches the given rownum.
  7034. The first record that is a Row record (starting at LOC) that has the
  7035. same rownum as the given rownum will be returned.
  7036. This method is "loc" sensitive. Meaning you need to Set LOC to where you
  7037. want it to start searching. If you don't know do this: SetLoc(GetDimsLoc).
  7038. When Adding several rows you can just start at the last one by leaving loc
  7039. at what this Sets it to. For this method, Set loc to dimsloc to start with.
  7040. subsequent calls will return rows in (physical) sequence or NULL when you Get to the end.
  7041. </summary>
  7042. <param name="rownum">which row to return (careful with LOC)</param>
  7043. <returns>RowRecord representing the next row record or NULL if there are no more</returns>
  7044. </member>
  7045. <member name="P:NPOI.HSSF.Model.InternalSheet.PageSettings">
  7046. <summary>
  7047. Gets the page settings.
  7048. </summary>
  7049. <returns></returns>
  7050. </member>
  7051. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateBOF">
  7052. <summary>
  7053. Creates the BOF record
  7054. </summary>
  7055. <returns>record containing a BOFRecord</returns>
  7056. </member>
  7057. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIndex">
  7058. <summary>
  7059. Creates the Index record - not currently used
  7060. </summary>
  7061. <returns>record containing a IndexRecord</returns>
  7062. </member>
  7063. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcMode">
  7064. <summary>
  7065. Creates the CalcMode record and Sets it to 1 (automatic formula caculation)
  7066. </summary>
  7067. <returns>record containing a CalcModeRecord</returns>
  7068. </member>
  7069. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateCalcCount">
  7070. <summary>
  7071. Creates the CalcCount record and Sets it to 0x64 (default number of iterations)
  7072. </summary>
  7073. <returns>record containing a CalcCountRecord</returns>
  7074. </member>
  7075. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateRefMode">
  7076. <summary>
  7077. Creates the RefMode record and Sets it to A1 Mode (default reference mode)
  7078. </summary>
  7079. <returns>record containing a RefModeRecord</returns>
  7080. </member>
  7081. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateIteration">
  7082. <summary>
  7083. Creates the Iteration record and Sets it to false (don't iteratively calculate formulas)
  7084. </summary>
  7085. <returns>record containing a IterationRecord</returns>
  7086. </member>
  7087. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDelta">
  7088. <summary>
  7089. Creates the Delta record and Sets it to 0.0010 (default accuracy)
  7090. </summary>
  7091. <returns>record containing a DeltaRecord</returns>
  7092. </member>
  7093. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSaveRecalc">
  7094. <summary>
  7095. Creates the SaveRecalc record and Sets it to true (recalculate before saving)
  7096. </summary>
  7097. <returns>record containing a SaveRecalcRecord</returns>
  7098. </member>
  7099. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintHeaders">
  7100. <summary>
  7101. Creates the PrintHeaders record and Sets it to false (we don't Create headers yet so why print them)
  7102. </summary>
  7103. <returns>record containing a PrintHeadersRecord</returns>
  7104. </member>
  7105. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintGridlines">
  7106. <summary>
  7107. Creates the PrintGridlines record and Sets it to false (that makes for ugly sheets). As far as I can
  7108. tell this does the same thing as the GridsetRecord
  7109. </summary>
  7110. <returns>record containing a PrintGridlinesRecord</returns>
  7111. </member>
  7112. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGridset">
  7113. <summary>
  7114. Creates the GridSet record and Sets it to true (user has mucked with the gridlines)
  7115. </summary>
  7116. <returns>record containing a GridsetRecord</returns>
  7117. </member>
  7118. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateGuts">
  7119. <summary>
  7120. Creates the Guts record and Sets leftrow/topcol guttter and rowlevelmax/collevelmax to 0
  7121. </summary>
  7122. <returns>record containing a GutsRecordRecord</returns>
  7123. </member>
  7124. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultRowHeight">
  7125. <summary>
  7126. Creates the DefaultRowHeight Record and Sets its options to 0 and rowheight to 0xff
  7127. </summary>
  7128. <see cref="T:NPOI.HSSF.Record.DefaultRowHeightRecord"/>
  7129. <see cref="T:NPOI.HSSF.Record.Record"/>
  7130. <returns>record containing a DefaultRowHeightRecord</returns>
  7131. </member>
  7132. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWSBool">
  7133. Creates the WSBoolRecord and Sets its values to defaults
  7134. @see org.apache.poi.hssf.record.WSBoolRecord
  7135. @see org.apache.poi.hssf.record.Record
  7136. @return record containing a WSBoolRecord
  7137. </member>
  7138. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateHCenter">
  7139. Creates the HCenter Record and Sets it to false (don't horizontally center)
  7140. @see org.apache.poi.hssf.record.HCenterRecord
  7141. @see org.apache.poi.hssf.record.Record
  7142. @return record containing a HCenterRecord
  7143. </member>
  7144. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateVCenter">
  7145. Creates the VCenter Record and Sets it to false (don't horizontally center)
  7146. @see org.apache.poi.hssf.record.VCenterRecord
  7147. @see org.apache.poi.hssf.record.Record
  7148. @return record containing a VCenterRecord
  7149. </member>
  7150. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePrintSetup">
  7151. Creates the PrintSetup Record and Sets it to defaults and marks it invalid
  7152. @see org.apache.poi.hssf.record.PrintSetupRecord
  7153. @see org.apache.poi.hssf.record.Record
  7154. @return record containing a PrintSetupRecord
  7155. </member>
  7156. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDefaultColWidth">
  7157. Creates the DefaultColWidth Record and Sets it to 8
  7158. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  7159. @see org.apache.poi.hssf.record.Record
  7160. @return record containing a DefaultColWidthRecord
  7161. </member>
  7162. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultColumnWidth">
  7163. Get the default column width for the sheet (if the columns do not define their own width)
  7164. @return default column width
  7165. </member>
  7166. <member name="P:NPOI.HSSF.Model.InternalSheet.DefaultRowHeight">
  7167. Get the default row height for the sheet (if the rows do not define their own height)
  7168. @return default row height
  7169. </member>
  7170. <member name="M:NPOI.HSSF.Model.InternalSheet.GetColumnWidth(System.Int32)">
  7171. Get the width of a given column in Units of 1/256th of a Char width
  7172. @param column index
  7173. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  7174. @see org.apache.poi.hssf.record.ColumnInfoRecord
  7175. @see #SetColumnWidth(short,short)
  7176. @return column width in Units of 1/256th of a Char width
  7177. </member>
  7178. <member name="M:NPOI.HSSF.Model.InternalSheet.GetXFIndexForColAt(System.Int16)">
  7179. Get the index to the ExtendedFormatRecord "associated" with
  7180. the column at specified 0-based index. (In this case, an
  7181. ExtendedFormatRecord index is actually associated with a
  7182. ColumnInfoRecord which spans 1 or more columns)
  7183. <br/>
  7184. Returns the index to the default ExtendedFormatRecord (0xF)
  7185. if no ColumnInfoRecord exists that includes the column
  7186. index specified.
  7187. @param column
  7188. @return index of ExtendedFormatRecord associated with
  7189. ColumnInfoRecord that includes the column index or the
  7190. index of the default ExtendedFormatRecord (0xF)
  7191. </member>
  7192. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnWidth(System.Int32,System.Int32)">
  7193. Set the width for a given column in 1/256th of a Char width Units
  7194. @param column - the column number
  7195. @param width (in Units of 1/256th of a Char width)
  7196. </member>
  7197. <member name="M:NPOI.HSSF.Model.InternalSheet.IsColumnHidden(System.Int32)">
  7198. Get the hidden property for a given column.
  7199. @param column index
  7200. @see org.apache.poi.hssf.record.DefaultColWidthRecord
  7201. @see org.apache.poi.hssf.record.ColumnInfoRecord
  7202. @see #SetColumnHidden(short,bool)
  7203. @return whether the column is hidden or not.
  7204. </member>
  7205. <member name="M:NPOI.HSSF.Model.InternalSheet.SetColumnHidden(System.Int32,System.Boolean)">
  7206. Get the hidden property for a given column.
  7207. @param column - the column number
  7208. @param hidden - whether the column is hidden or not
  7209. </member>
  7210. <member name="M:NPOI.HSSF.Model.InternalSheet.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  7211. Creates an outline Group for the specified columns.
  7212. @param fromColumn Group from this column (inclusive)
  7213. @param toColumn Group to this column (inclusive)
  7214. @param indent if true the Group will be indented by one level,
  7215. if false indenting will be Removed by one level.
  7216. </member>
  7217. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateDimensions">
  7218. Creates the Dimensions Record and Sets it to bogus values (you should Set this yourself
  7219. or let the high level API do it for you)
  7220. @see org.apache.poi.hssf.record.DimensionsRecord
  7221. @see org.apache.poi.hssf.record.Record
  7222. @return record containing a DimensionsRecord
  7223. </member>
  7224. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateWindowTwo">
  7225. Creates the WindowTwo Record and Sets it to:
  7226. options = 0x6b6
  7227. toprow = 0
  7228. leftcol = 0
  7229. headercolor = 0x40
  7230. pagebreakzoom = 0x0
  7231. normalzoom = 0x0
  7232. @see org.apache.poi.hssf.record.WindowTwoRecord
  7233. @see org.apache.poi.hssf.record.Record
  7234. @return record containing a WindowTwoRecord
  7235. </member>
  7236. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSelection">
  7237. <summary>
  7238. Creates the Selection record and Sets it to nothing selected
  7239. </summary>
  7240. <returns>record containing a SelectionRecord</returns>
  7241. </member>
  7242. <member name="P:NPOI.HSSF.Model.InternalSheet.TopRow">
  7243. <summary>
  7244. Gets or sets the top row.
  7245. </summary>
  7246. <value>The top row.</value>
  7247. </member>
  7248. <member name="P:NPOI.HSSF.Model.InternalSheet.LeftCol">
  7249. <summary>
  7250. Gets or sets the left col.
  7251. </summary>
  7252. <value>The left col.</value>
  7253. </member>
  7254. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCell(System.Int32,System.Int32)">
  7255. <summary>
  7256. Sets the active cell.
  7257. </summary>
  7258. <param name="row">The row.</param>
  7259. <param name="column">The column.</param>
  7260. </member>
  7261. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  7262. <summary>
  7263. Sets the active cell range.
  7264. </summary>
  7265. <param name="firstRow">The firstrow.</param>
  7266. <param name="lastRow">The lastrow.</param>
  7267. <param name="firstColumn">The firstcolumn.</param>
  7268. <param name="lastColumn">The lastcolumn.</param>
  7269. </member>
  7270. <member name="M:NPOI.HSSF.Model.InternalSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  7271. <summary>
  7272. Sets the active cell range.
  7273. </summary>
  7274. <param name="cellranges">The cellranges.</param>
  7275. <param name="activeRange">The index of the active range.</param>
  7276. <param name="activeRow">The active row in the active range</param>
  7277. <param name="activeColumn">The active column in the active range</param>
  7278. </member>
  7279. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellRow">
  7280. <summary>
  7281. Returns the active row
  7282. </summary>
  7283. <value>the active row index</value>
  7284. @see org.apache.poi.hssf.record.SelectionRecord
  7285. </member>
  7286. <member name="P:NPOI.HSSF.Model.InternalSheet.ActiveCellCol">
  7287. <summary>
  7288. Gets the active cell col.
  7289. </summary>
  7290. <value>the active column index</value>
  7291. @see org.apache.poi.hssf.record.SelectionRecord
  7292. </member>
  7293. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateEOF">
  7294. <summary>
  7295. Creates the EOF record
  7296. </summary>
  7297. <returns>record containing a EOFRecord</returns>
  7298. </member>
  7299. <member name="P:NPOI.HSSF.Model.InternalSheet.GridsetRecord">
  7300. <summary>
  7301. Gets the gridset record for this sheet.
  7302. </summary>
  7303. <value>The gridset record.</value>
  7304. </member>
  7305. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordBySid(System.Int16)">
  7306. <summary>
  7307. Returns the first occurance of a record matching a particular sid.
  7308. </summary>
  7309. <param name="sid">The sid.</param>
  7310. <returns></returns>
  7311. </member>
  7312. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSCLRecord(NPOI.HSSF.Record.SCLRecord)">
  7313. <summary>
  7314. Sets the SCL record or Creates it in the correct place if it does not
  7315. already exist.
  7316. </summary>
  7317. <param name="sclRecord">The record to set.</param>
  7318. </member>
  7319. <member name="M:NPOI.HSSF.Model.InternalSheet.FindFirstRecordLocBySid(System.Int16)">
  7320. Finds the first occurance of a record matching a particular sid and
  7321. returns it's position.
  7322. @param sid the sid to search for
  7323. @return the record position of the matching record or -1 if no match
  7324. is made.
  7325. </member>
  7326. <member name="P:NPOI.HSSF.Model.InternalSheet.Header">
  7327. <summary>
  7328. Gets or sets the header.
  7329. </summary>
  7330. <value>the HeaderRecord.</value>
  7331. </member>
  7332. <member name="P:NPOI.HSSF.Model.InternalSheet.IsAutoTabColor">
  7333. <summary>
  7334. Gets or sets a value indicating whether this instance is auto tab color.
  7335. </summary>
  7336. <value>
  7337. <c>true</c> if this instance is auto tab color; otherwise, <c>false</c>.
  7338. </value>
  7339. </member>
  7340. <member name="P:NPOI.HSSF.Model.InternalSheet.Footer">
  7341. <summary>
  7342. Gets or sets the footer.
  7343. </summary>
  7344. <value>FooterRecord for the sheet.</value>
  7345. </member>
  7346. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintSetup">
  7347. Returns the PrintSetupRecord.
  7348. @return PrintSetupRecord for the sheet.
  7349. </member>
  7350. <member name="P:NPOI.HSSF.Model.InternalSheet.IsGridsPrinted">
  7351. @return <c>true</c> if gridlines are printed
  7352. </member>
  7353. <member name="P:NPOI.HSSF.Model.InternalSheet.PrintGridlines">
  7354. Returns the PrintGridlinesRecord.
  7355. @return PrintGridlinesRecord for the sheet.
  7356. </member>
  7357. <member name="M:NPOI.HSSF.Model.InternalSheet.SetSelected(System.Boolean)">
  7358. Sets whether the sheet is selected
  7359. @param sel True to select the sheet, false otherwise.
  7360. </member>
  7361. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  7362. Creates a split (freezepane). Any existing freezepane or split pane Is overwritten.
  7363. @param colSplit Horizonatal position of split.
  7364. @param rowSplit Vertical position of split.
  7365. @param topRow Top row visible in bottom pane
  7366. @param leftmostColumn Left column visible in right pane.
  7367. </member>
  7368. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  7369. Creates a split pane. Any existing freezepane or split pane is overwritten.
  7370. @param xSplitPos Horizonatal position of split (in 1/20th of a point).
  7371. @param ySplitPos Vertical position of split (in 1/20th of a point).
  7372. @param topRow Top row visible in bottom pane
  7373. @param leftmostColumn Left column visible in right pane.
  7374. @param activePane Active pane. One of: PANE_LOWER_RIGHT,
  7375. PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT
  7376. @see #PANE_LOWER_LEFT
  7377. @see #PANE_LOWER_RIGHT
  7378. @see #PANE_UPPER_LEFT
  7379. @see #PANE_UPPER_RIGHT
  7380. </member>
  7381. <member name="P:NPOI.HSSF.Model.InternalSheet.PaneInformation">
  7382. Returns the information regarding the currently configured pane (split or freeze).
  7383. @return null if no pane configured, or the pane information.
  7384. </member>
  7385. <member name="M:NPOI.HSSF.Model.InternalSheet.CreatePassword">
  7386. creates a Password record with password set to 00.
  7387. </member>
  7388. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateProtect">
  7389. creates a Protect record with protect set to false.
  7390. </member>
  7391. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateObjectProtect">
  7392. Creates an ObjectProtect record with protect Set to false.
  7393. @see org.apache.poi.hssf.record.ObjectProtectRecord
  7394. @see org.apache.poi.hssf.record.Record
  7395. @return an ObjectProtectRecord
  7396. </member>
  7397. <member name="M:NPOI.HSSF.Model.InternalSheet.CreateScenarioProtect">
  7398. Creates a ScenarioProtect record with protect Set to false.
  7399. @see org.apache.poi.hssf.record.ScenarioProtectRecord
  7400. @see org.apache.poi.hssf.record.Record
  7401. @return a ScenarioProtectRecord
  7402. </member>
  7403. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayGridlines">
  7404. Returns if gridlines are Displayed.
  7405. @return whether gridlines are Displayed
  7406. </member>
  7407. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayFormulas">
  7408. Returns if formulas are Displayed.
  7409. @return whether formulas are Displayed
  7410. </member>
  7411. <member name="P:NPOI.HSSF.Model.InternalSheet.DisplayRowColHeadings">
  7412. Returns if RowColHeadings are Displayed.
  7413. @return whether RowColHeadings are Displayed
  7414. </member>
  7415. <member name="P:NPOI.HSSF.Model.InternalSheet.IsUncalced">
  7416. @return whether an Uncalced record must be Inserted or not at generation
  7417. </member>
  7418. <member name="M:NPOI.HSSF.Model.InternalSheet.AggregateDrawingRecords(NPOI.HSSF.Model.DrawingManager2,System.Boolean)">
  7419. <summary>
  7420. Finds the DrawingRecord for our sheet, and attaches it to the DrawingManager (which knows about
  7421. the overall DrawingGroup for our workbook).
  7422. If requested, will Create a new DrawRecord if none currently exist
  7423. </summary>
  7424. <param name="drawingManager">The DrawingManager2 for our workbook</param>
  7425. <param name="CreateIfMissing">Should one be Created if missing?</param>
  7426. <returns>location of EscherAggregate record. if no EscherAggregate record is found return -1</returns>
  7427. </member>
  7428. <member name="M:NPOI.HSSF.Model.InternalSheet.Preserialize">
  7429. Perform any work necessary before the sheet is about to be Serialized.
  7430. For instance the escher aggregates size needs to be calculated before
  7431. serialization so that the dgg record (which occurs first) can be written.
  7432. </member>
  7433. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int16,System.Int16,System.Int32)">
  7434. Shifts all the page breaks in the range "count" number of rows/columns
  7435. @param breaks The page record to be Shifted
  7436. @param start Starting "main" value to Shift breaks
  7437. @param stop Ending "main" value to Shift breaks
  7438. @param count number of Units (rows/columns) to Shift by
  7439. </member>
  7440. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  7441. Shifts the horizontal page breaks for the indicated count
  7442. @param startingRow
  7443. @param endingRow
  7444. @param count
  7445. </member>
  7446. <member name="M:NPOI.HSSF.Model.InternalSheet.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  7447. Shifts the vertical page breaks for the indicated count
  7448. @param startingCol
  7449. @param endingCol
  7450. @param count
  7451. </member>
  7452. <member name="M:NPOI.HSSF.Model.InternalSheet.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  7453. Updates formulas in cells and conditional formats due to moving of cells
  7454. @param externSheetIndex the externSheet index of this sheet
  7455. </member>
  7456. <member name="M:NPOI.HSSF.Model.InternalSheet.GetSizeOfInitialSheetRecords(System.Int32)">
  7457. 'initial sheet records' are between INDEX and the 'Row Blocks'
  7458. @param bofRecordIndex index of record after which INDEX record is to be placed
  7459. @return count of bytes from end of INDEX record to first ROW record.
  7460. </member>
  7461. <member name="M:NPOI.HSSF.Model.InternalSheet.GetNoteRecords">
  7462. Get the {@link NoteRecord}s (related to cell comments) for this sheet
  7463. @return never <code>null</code>, typically empty array
  7464. </member>
  7465. <member name="T:NPOI.HSSF.Model.InternalWorkbook">
  7466. Low level model implementation of a Workbook. Provides creational methods
  7467. for Settings and objects contained in the workbook object.
  7468. This file Contains the low level binary records starting at the workbook's BOF and
  7469. ending with the workbook's EOF. Use HSSFWorkbook for a high level representation.
  7470. The structures of the highlevel API use references to this to perform most of their
  7471. operations. Its probably Unwise to use these low level structures directly Unless you
  7472. really know what you're doing. I recommend you Read the Microsoft Excel 97 Developer's
  7473. Kit (Microsoft Press) and the documentation at http://sc.openoffice.org/excelfileformat.pdf
  7474. before even attempting to use this.
  7475. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  7476. @author Sergei Kozello (sergeikozello at mail.ru)
  7477. @author Shawn Laubach (slaubach at apache dot org) (Data Formats)
  7478. @author Andrew C. Oliver (acoliver at apache dot org)
  7479. @author Brian Sanders (bsanders at risklabs dot com) - custom palette
  7480. @author Dan Sherman (dsherman at Isisph.com)
  7481. @author Glen Stampoultzis (glens at apache.org)
  7482. @see org.apache.poi.hssf.usermodel.HSSFWorkbook
  7483. @version 1.0-pre
  7484. </member>
  7485. <member name="F:NPOI.HSSF.Model.InternalWorkbook.MAX_SENSITIVE_SHEET_NAME_LEN">
  7486. Excel silently truncates long sheet names to 31 chars.
  7487. This constant is used to ensure uniqueness in the first 31 chars
  7488. </member>
  7489. <member name="F:NPOI.HSSF.Model.InternalWorkbook.CODEPAGE">
  7490. constant used to Set the "codepage" wherever "codepage" is Set in records
  7491. (which is duplciated in more than one record)
  7492. </member>
  7493. <member name="F:NPOI.HSSF.Model.InternalWorkbook.records">
  7494. this Contains the Worksheet record objects
  7495. </member>
  7496. <member name="F:NPOI.HSSF.Model.InternalWorkbook.sst">
  7497. this Contains a reference to the SSTRecord so that new stings can be Added
  7498. to it.
  7499. </member>
  7500. <member name="F:NPOI.HSSF.Model.InternalWorkbook.boundsheets">
  7501. holds the "boundsheet" records (aka bundlesheet) so that they can have their
  7502. reference to their "BOF" marker
  7503. </member>
  7504. <member name="M:NPOI.HSSF.Model.InternalWorkbook.#ctor">
  7505. Creates new Workbook with no intitialization --useless right now
  7506. @see #CreateWorkbook(List)
  7507. </member>
  7508. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook(System.Collections.Generic.List{NPOI.HSSF.Record.Record})">
  7509. Read support for low level
  7510. API. Pass in an array of Record objects, A Workbook
  7511. object is constructed and passed back with all of its initialization Set
  7512. to the passed in records and references to those records held. Unlike Sheet
  7513. workbook does not use an offset (its assumed to be 0) since its first in a file.
  7514. If you need an offset then construct a new array with a 0 offset or Write your
  7515. own ;-p.
  7516. @param recs an array of Record objects
  7517. @return Workbook object
  7518. </member>
  7519. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameCommentRecord(NPOI.HSSF.Record.NameRecord)">
  7520. gets the name comment record
  7521. @param nameRecord name record who's comment is required.
  7522. @return name comment record or <code>null</code> if there isn't one for the given name.
  7523. </member>
  7524. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWorkbook">
  7525. Creates an empty workbook object with three blank sheets and all the empty
  7526. fields. Use this to Create a workbook from scratch.
  7527. </member>
  7528. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSpecificBuiltinRecord(System.Byte,System.Int32)">
  7529. Retrieves the Builtin NameRecord that matches the name and index
  7530. There shouldn't be too many names to make the sequential search too slow
  7531. @param name byte representation of the builtin name to match
  7532. @param sheetIndex Index to match
  7533. @return null if no builtin NameRecord matches
  7534. </member>
  7535. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveBuiltinRecord(System.Byte,System.Int32)">
  7536. Removes the specified Builtin NameRecord that matches the name and index
  7537. @param name byte representation of the builtin to match
  7538. @param sheetIndex zero-based sheet reference
  7539. </member>
  7540. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontRecordAt(System.Int32)">
  7541. Gets the font record at the given index in the font table. Remember
  7542. "There is No Four" (someone at M$ must have gone to Rocky Horror one too
  7543. many times)
  7544. @param idx the index to look at (0 or greater but NOT 4)
  7545. @return FontRecord located at the given index
  7546. </member>
  7547. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateNewFont">
  7548. Creates a new font record and Adds it to the "font table". This causes the
  7549. boundsheets to move down one, extended formats to move down (so this function moves
  7550. those pointers as well)
  7551. @return FontRecord that was just Created
  7552. </member>
  7553. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CloneDrawings(NPOI.HSSF.Model.InternalSheet)">
  7554. Check if the cloned sheet has drawings. If yes, then allocate a new drawing group ID and
  7555. re-generate shape IDs
  7556. @param sheet the cloned sheet
  7557. </member>
  7558. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumberOfFontRecords">
  7559. Gets the number of font records
  7560. @return number of font records in the "font table"
  7561. </member>
  7562. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetBof(System.Int32,System.Int32)">
  7563. Sets the BOF for a given sheet
  7564. @param sheetnum the number of the sheet to Set the positing of the bof for
  7565. @param pos the actual bof position
  7566. </member>
  7567. <member name="P:NPOI.HSSF.Model.InternalWorkbook.BackupRecord">
  7568. Returns the position of the backup record.
  7569. </member>
  7570. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String)">
  7571. Sets the name for a given sheet. If the boundsheet record doesn't exist and
  7572. its only one more than we have, go ahead and Create it. If its > 1 more than
  7573. we have, except
  7574. @param sheetnum the sheet number (0 based)
  7575. @param sheetname the name for the sheet
  7576. </member>
  7577. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ContainsSheetName(System.String,System.Int32)">
  7578. Determines whether a workbook Contains the provided sheet name.
  7579. @param name the name to test (case insensitive match)
  7580. @param excludeSheetIdx the sheet to exclude from the Check or -1 to include all sheets in the Check.
  7581. @return true if the sheet Contains the name, false otherwise.
  7582. </member>
  7583. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetName(System.Int32,System.String,System.Int16)">
  7584. Sets the name for a given sheet forcing the encoding. This is STILL A BAD IDEA.
  7585. Poi now automatically detects Unicode
  7586. @deprecated 3-Jan-06 Simply use SetSheetNam e(int sheetnum, String sheetname)
  7587. @param sheetnum the sheet number (0 based)
  7588. @param sheetname the name for the sheet
  7589. </member>
  7590. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetOrder(System.String,System.Int32)">
  7591. Sets the order of appearance for a given sheet.
  7592. @param sheetname the name of the sheet to reorder
  7593. @param pos the position that we want to Insert the sheet into (0 based)
  7594. </member>
  7595. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetName(System.Int32)">
  7596. Gets the name for a given sheet.
  7597. @param sheetnum the sheet number (0 based)
  7598. @return sheetname the name for the sheet
  7599. </member>
  7600. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetHidden(System.Int32)">
  7601. Gets the hidden flag for a given sheet.
  7602. @param sheetnum the sheet number (0 based)
  7603. @return True if sheet is hidden
  7604. </member>
  7605. <member name="M:NPOI.HSSF.Model.InternalWorkbook.IsSheetVeryHidden(System.Int32)">
  7606. Gets the hidden flag for a given sheet.
  7607. Note that a sheet could instead be
  7608. set to be very hidden, which is different
  7609. ({@link #isSheetVeryHidden(int)})
  7610. @param sheetnum the sheet number (0 based)
  7611. @return True if sheet is hidden
  7612. </member>
  7613. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Boolean)">
  7614. Hide or Unhide a sheet
  7615. @param sheetnum The sheet number
  7616. @param hidden True to mark the sheet as hidden, false otherwise
  7617. </member>
  7618. <member name="M:NPOI.HSSF.Model.InternalWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  7619. Hide or unhide a sheet.
  7620. 0 = not hidden
  7621. 1 = hidden
  7622. 2 = very hidden.
  7623. @param sheetnum The sheet number
  7624. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  7625. </member>
  7626. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSheetIndex(System.String)">
  7627. Get the sheet's index
  7628. @param name sheet name
  7629. @return sheet index or -1 if it was not found.
  7630. </member>
  7631. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckSheets(System.Int32)">
  7632. if we're trying to Address one more sheet than we have, go ahead and Add it! if we're
  7633. trying to Address >1 more than we have throw an exception!
  7634. </member>
  7635. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FixTabIdRecord">
  7636. <summary>
  7637. make the tabid record look like the current situation.
  7638. </summary>
  7639. <returns>number of bytes written in the TabIdRecord</returns>
  7640. </member>
  7641. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumSheets">
  7642. returns the number of boundsheet objects contained in this workbook.
  7643. @return number of BoundSheet records
  7644. </member>
  7645. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumExFormats">
  7646. Get the number of ExtendedFormat records contained in this workbook.
  7647. @return int count of ExtendedFormat records
  7648. </member>
  7649. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFontIndex(NPOI.HSSF.Record.FontRecord)">
  7650. Retrieves the index of the given font
  7651. </member>
  7652. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetStyleRecord(System.Int32)">
  7653. Returns the StyleRecord for the given
  7654. xfIndex, or null if that ExtendedFormat doesn't
  7655. have a Style set.
  7656. </member>
  7657. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetExFormatAt(System.Int32)">
  7658. Gets the ExtendedFormatRecord at the given 0-based index
  7659. @param index of the Extended format record (0-based)
  7660. @return ExtendedFormatRecord at the given index
  7661. </member>
  7662. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCellXF">
  7663. Creates a new Cell-type Extneded Format Record and Adds it to the end of
  7664. ExtendedFormatRecords collection
  7665. @return ExtendedFormatRecord that was Created
  7666. </member>
  7667. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddSSTString(NPOI.HSSF.Record.UnicodeString)">
  7668. Adds a string to the SST table and returns its index (if its a duplicate
  7669. just returns its index and update the counts) ASSUMES compressed Unicode
  7670. (meaning 8bit)
  7671. @param string the string to be Added to the SSTRecord
  7672. @return index of the string within the SSTRecord
  7673. </member>
  7674. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetSSTString(System.Int32)">
  7675. given an index into the SST table, this function returns the corresponding String value
  7676. @return String containing the SST String
  7677. </member>
  7678. <member name="M:NPOI.HSSF.Model.InternalWorkbook.InsertSST">
  7679. use this function to Add a Shared String Table to an existing sheet (say
  7680. generated by a different java api) without an sst....
  7681. @see #CreateSST()
  7682. @see org.apache.poi.hssf.record.SSTRecord
  7683. </member>
  7684. <member name="M:NPOI.HSSF.Model.InternalWorkbook.Serialize(System.Int32,System.Byte[])">
  7685. Serializes all records int the worksheet section into a big byte array. Use
  7686. this to Write the Workbook out.
  7687. @param offset of the data to be written
  7688. @param data array of bytes to Write this to
  7689. </member>
  7690. <member name="M:NPOI.HSSF.Model.InternalWorkbook.PreSerialize">
  7691. Perform any work necessary before the workbook is about to be serialized.
  7692. Include in it ant code that modifies the workbook record stream and affects its size.
  7693. </member>
  7694. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBOF">
  7695. Creates the BOF record
  7696. @see org.apache.poi.hssf.record.BOFRecord
  7697. @see org.apache.poi.hssf.record.Record
  7698. @return record containing a BOFRecord
  7699. </member>
  7700. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceHdr">
  7701. Creates the InterfaceHdr record
  7702. @see org.apache.poi.hssf.record.InterfaceHdrRecord
  7703. @see org.apache.poi.hssf.record.Record
  7704. @return record containing a InterfaceHdrRecord
  7705. </member>
  7706. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateMMS">
  7707. Creates an MMS record
  7708. @see org.apache.poi.hssf.record.MMSRecord
  7709. @see org.apache.poi.hssf.record.Record
  7710. @return record containing a MMSRecord
  7711. </member>
  7712. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateInterfaceEnd">
  7713. Creates the InterfaceEnd record
  7714. @see org.apache.poi.hssf.record.InterfaceEndRecord
  7715. @see org.apache.poi.hssf.record.Record
  7716. @return record containing a InterfaceEndRecord
  7717. </member>
  7718. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWriteAccess">
  7719. Creates the WriteAccess record containing the logged in user's name
  7720. @see org.apache.poi.hssf.record.WriteAccessRecord
  7721. @see org.apache.poi.hssf.record.Record
  7722. @return record containing a WriteAccessRecord
  7723. </member>
  7724. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCodepage">
  7725. Creates the Codepage record containing the constant stored in CODEPAGE
  7726. @see org.apache.poi.hssf.record.CodepageRecord
  7727. @see org.apache.poi.hssf.record.Record
  7728. @return record containing a CodepageRecord
  7729. </member>
  7730. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDSF">
  7731. Creates the DSF record containing a 0 since HSSF can't even Create Dual Stream Files
  7732. @see org.apache.poi.hssf.record.DSFRecord
  7733. @see org.apache.poi.hssf.record.Record
  7734. @return record containing a DSFRecord
  7735. </member>
  7736. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateTabId">
  7737. Creates the TabId record containing an array of 0,1,2. This release of HSSF
  7738. always has the default three sheets, no less, no more.
  7739. @see org.apache.poi.hssf.record.TabIdRecord
  7740. @see org.apache.poi.hssf.record.Record
  7741. @return record containing a TabIdRecord
  7742. </member>
  7743. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFnGroupCount">
  7744. Creates the FnGroupCount record containing the Magic number constant of 14.
  7745. @see org.apache.poi.hssf.record.FnGroupCountRecord
  7746. @see org.apache.poi.hssf.record.Record
  7747. @return record containing a FnGroupCountRecord
  7748. </member>
  7749. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowProtect">
  7750. Creates the WindowProtect record with protect Set to false.
  7751. @see org.apache.poi.hssf.record.WindowProtectRecord
  7752. @see org.apache.poi.hssf.record.Record
  7753. @return record containing a WindowProtectRecord
  7754. </member>
  7755. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtect">
  7756. Creates the Protect record with protect Set to false.
  7757. @see org.apache.poi.hssf.record.ProtectRecord
  7758. @see org.apache.poi.hssf.record.Record
  7759. @return record containing a ProtectRecord
  7760. </member>
  7761. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePassword">
  7762. Creates the Password record with password Set to 0.
  7763. @see org.apache.poi.hssf.record.PasswordRecord
  7764. @see org.apache.poi.hssf.record.Record
  7765. @return record containing a PasswordRecord
  7766. </member>
  7767. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateProtectionRev4">
  7768. Creates the ProtectionRev4 record with protect Set to false.
  7769. @see org.apache.poi.hssf.record.ProtectionRev4Record
  7770. @see org.apache.poi.hssf.record.Record
  7771. @return record containing a ProtectionRev4Record
  7772. </member>
  7773. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePasswordRev4">
  7774. Creates the PasswordRev4 record with password Set to 0.
  7775. @see org.apache.poi.hssf.record.PasswordRev4Record
  7776. @see org.apache.poi.hssf.record.Record
  7777. @return record containing a PasswordRev4Record
  7778. </member>
  7779. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateWindowOne">
  7780. Creates the WindowOne record with the following magic values:
  7781. horizontal hold - 0x168
  7782. vertical hold - 0x10e
  7783. width - 0x3a5c
  7784. height - 0x23be
  7785. options - 0x38
  7786. selected tab - 0
  7787. Displayed tab - 0
  7788. num selected tab- 0
  7789. tab width ratio - 0x258
  7790. @see org.apache.poi.hssf.record.WindowOneRecord
  7791. @see org.apache.poi.hssf.record.Record
  7792. @return record containing a WindowOneRecord
  7793. </member>
  7794. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBackup">
  7795. Creates the Backup record with backup Set to 0. (loose the data, who cares)
  7796. @see org.apache.poi.hssf.record.BackupRecord
  7797. @see org.apache.poi.hssf.record.Record
  7798. @return record containing a BackupRecord
  7799. </member>
  7800. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateHideObj">
  7801. Creates the HideObj record with hide object Set to 0. (don't hide)
  7802. @see org.apache.poi.hssf.record.HideObjRecord
  7803. @see org.apache.poi.hssf.record.Record
  7804. @return record containing a HideObjRecord
  7805. </member>
  7806. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDateWindow1904">
  7807. Creates the DateWindow1904 record with windowing Set to 0. (don't window)
  7808. @see org.apache.poi.hssf.record.DateWindow1904Record
  7809. @see org.apache.poi.hssf.record.Record
  7810. @return record containing a DateWindow1904Record
  7811. </member>
  7812. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePrecision">
  7813. Creates the Precision record with precision Set to true. (full precision)
  7814. @see org.apache.poi.hssf.record.PrecisionRecord
  7815. @see org.apache.poi.hssf.record.Record
  7816. @return record containing a PrecisionRecord
  7817. </member>
  7818. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateRefreshAll">
  7819. Creates the RefreshAll record with refreshAll Set to true. (refresh all calcs)
  7820. @see org.apache.poi.hssf.record.RefreshAllRecord
  7821. @see org.apache.poi.hssf.record.Record
  7822. @return record containing a RefreshAllRecord
  7823. </member>
  7824. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBookBool">
  7825. Creates the BookBool record with saveLinkValues Set to 0. (don't save link values)
  7826. @see org.apache.poi.hssf.record.BookBoolRecord
  7827. @see org.apache.poi.hssf.record.Record
  7828. @return record containing a BookBoolRecord
  7829. </member>
  7830. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFont">
  7831. Creates a Font record with the following magic values:
  7832. fontheight = 0xc8
  7833. attributes = 0x0
  7834. color palette index = 0x7fff
  7835. bold weight = 0x190
  7836. Font Name Length = 5
  7837. Font Name = Arial
  7838. @see org.apache.poi.hssf.record.FontRecord
  7839. @see org.apache.poi.hssf.record.Record
  7840. @return record containing a FontRecord
  7841. </member>
  7842. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat(System.Int32)">
  7843. Creates an ExtendedFormatRecord object
  7844. @param id the number of the extended format record to Create (meaning its position in
  7845. a file as MS Excel would Create it.)
  7846. @return record containing an ExtendedFormatRecord
  7847. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  7848. @see org.apache.poi.hssf.record.Record
  7849. </member>
  7850. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedFormat">
  7851. Creates an default cell type ExtendedFormatRecord object.
  7852. @return ExtendedFormatRecord with intial defaults (cell-type)
  7853. </member>
  7854. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyleRecord(System.Int32)">
  7855. Creates a new StyleRecord, for the given Extended
  7856. Format index, and adds it onto the end of the
  7857. records collection
  7858. </member>
  7859. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateStyle(System.Int32)">
  7860. Creates a StyleRecord object
  7861. @param id the number of the style record to Create (meaning its position in
  7862. a file as MS Excel would Create it.
  7863. @return record containing a StyleRecord
  7864. @see org.apache.poi.hssf.record.StyleRecord
  7865. @see org.apache.poi.hssf.record.Record
  7866. </member>
  7867. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreatePalette">
  7868. Creates a palette record initialized to the default palette
  7869. @return a PaletteRecord instance populated with the default colors
  7870. @see org.apache.poi.hssf.record.PaletteRecord
  7871. </member>
  7872. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateUseSelFS">
  7873. Creates the UseSelFS object with the use natural language flag Set to 0 (false)
  7874. @return record containing a UseSelFSRecord
  7875. @see org.apache.poi.hssf.record.UseSelFSRecord
  7876. @see org.apache.poi.hssf.record.Record
  7877. </member>
  7878. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBoundSheet(System.Int32)">
  7879. Create a "bound sheet" or "bundlesheet" (depending who you ask) record
  7880. Always Sets the sheet's bof to 0. You'll need to Set that yourself.
  7881. @param id either sheet 0,1 or 2.
  7882. @return record containing a BoundSheetRecord
  7883. @see org.apache.poi.hssf.record.BoundSheetRecord
  7884. @see org.apache.poi.hssf.record.Record
  7885. </member>
  7886. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateCountry">
  7887. Creates the Country record with the default country Set to 1
  7888. and current country Set to 7 in case of russian locale ("ru_RU") and 1 otherwise
  7889. @return record containing a CountryRecord
  7890. @see org.apache.poi.hssf.record.CountryRecord
  7891. @see org.apache.poi.hssf.record.Record
  7892. </member>
  7893. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateExtendedSST">
  7894. Creates the ExtendedSST record with numstrings per bucket Set to 0x8. HSSF
  7895. doesn't yet know what to do with this thing, but we Create it with nothing in
  7896. it hardly just to make Excel happy and our sheets look like Excel's
  7897. @return record containing an ExtSSTRecord
  7898. @see org.apache.poi.hssf.record.ExtSSTRecord
  7899. @see org.apache.poi.hssf.record.Record
  7900. </member>
  7901. <member name="P:NPOI.HSSF.Model.InternalWorkbook.OrCreateLinkTable">
  7902. lazy initialization
  7903. Note - creating the link table causes creation of 1 EXTERNALBOOK and 1 EXTERNALSHEET record
  7904. </member>
  7905. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindSheetFirstNameFromExternSheet(System.Int32)">
  7906. Finds the first sheet name by his extern sheet index
  7907. @param externSheetIndex extern sheet index
  7908. @return first sheet name.
  7909. </member>
  7910. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFirstSheetIndexFromExternSheetIndex(System.Int32)">
  7911. Finds the (first) sheet index for a particular external sheet number.
  7912. @param externSheetNumber The external sheet number to convert
  7913. @return The index to the sheet found.
  7914. </member>
  7915. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetLastSheetIndexFromExternSheetIndex(System.Int32)">
  7916. Finds the last sheet index for a particular external sheet number,
  7917. which may be the same as the first (except for multi-sheet references)
  7918. @param externSheetNumber The external sheet number to convert
  7919. @return The index to the sheet found.
  7920. </member>
  7921. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CheckExternSheet(System.Int32)">
  7922. Returns the extern sheet number for specific sheet number.
  7923. If this sheet doesn't exist in extern sheet, add it
  7924. @param sheetNumber local sheet number
  7925. @return index to extern sheet
  7926. </member>
  7927. <member name="M:NPOI.HSSF.Model.InternalWorkbook.checkExternSheet(System.Int32,System.Int32)">
  7928. Returns the extern sheet number for specific range of sheets.
  7929. If this sheet range doesn't exist in extern sheet, add it
  7930. @param firstSheetNumber first local sheet number
  7931. @param lastSheetNumber last local sheet number
  7932. @return index to extern sheet
  7933. </member>
  7934. <member name="P:NPOI.HSSF.Model.InternalWorkbook.NumNames">
  7935. Gets the total number of names
  7936. @return number of names
  7937. </member>
  7938. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameXPtg(System.String,System.Int32,NPOI.SS.Formula.Udf.UDFFinder)">
  7939. @param name the name of an external function, typically a name of a UDF
  7940. @param sheetRefIndex the sheet ref index, or -1 if not known
  7941. @param udf locator of user-defiend functions to resolve names of VBA and Add-In functions
  7942. @return the external name or null
  7943. </member>
  7944. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetNameRecord(System.Int32)">
  7945. Gets the name record
  7946. @param index name index
  7947. @return name record
  7948. </member>
  7949. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateName">
  7950. Creates new name
  7951. @return new name record
  7952. </member>
  7953. <member name="M:NPOI.HSSF.Model.InternalWorkbook.AddName(NPOI.HSSF.Record.NameRecord)">
  7954. Creates new name
  7955. @return new name record
  7956. </member>
  7957. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateBuiltInName(System.Byte,System.Int32)">
  7958. Generates a NameRecord to represent a built-in region
  7959. @return a new NameRecord Unless the index is invalid
  7960. </member>
  7961. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveName(System.Int32)">
  7962. Removes the name
  7963. @param namenum name index
  7964. </member>
  7965. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNameCommentRecordCache(NPOI.HSSF.Record.NameCommentRecord)">
  7966. If a {@link NameCommentRecord} is added or the name it references
  7967. is renamed, then this will update the lookup cache for it.
  7968. </member>
  7969. <member name="M:NPOI.HSSF.Model.InternalWorkbook.GetFormat(System.String,System.Boolean)">
  7970. Returns a format index that matches the passed in format. It does not tie into HSSFDataFormat.
  7971. @param format the format string
  7972. @param CreateIfNotFound Creates a new format if format not found
  7973. @return the format id of a format that matches or -1 if none found and CreateIfNotFound
  7974. </member>
  7975. <member name="P:NPOI.HSSF.Model.InternalWorkbook.Formats">
  7976. Returns the list of FormatRecords in the workbook.
  7977. @return ArrayList of FormatRecords in the notebook
  7978. </member>
  7979. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.String)">
  7980. Creates a FormatRecord, Inserts it, and returns the index code.
  7981. @param format the format string
  7982. @return the index code of the format record.
  7983. @see org.apache.poi.hssf.record.FormatRecord
  7984. @see org.apache.poi.hssf.record.Record
  7985. </member>
  7986. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateFormat(System.Int32)">
  7987. Creates a FormatRecord object
  7988. @param id the number of the format record to create (meaning its position in
  7989. a file as M$ Excel would create it.)
  7990. </member>
  7991. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordBySid(System.Int16)">
  7992. Returns the first occurance of a record matching a particular sid.
  7993. </member>
  7994. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindFirstRecordLocBySid(System.Int16)">
  7995. Returns the index of a record matching a particular sid.
  7996. @param sid The sid of the record to match
  7997. @return The index of -1 if no match made.
  7998. </member>
  7999. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindNextRecordBySid(System.Int16,System.Int32)">
  8000. Returns the next occurance of a record matching a particular sid.
  8001. </member>
  8002. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsUsing1904DateWindowing">
  8003. Whether date windowing is based on 1/2/1904 or 1/1/1900.
  8004. Some versions of Excel (Mac) can save workbooks using 1904 date windowing.
  8005. @return true if using 1904 date windowing
  8006. </member>
  8007. <member name="P:NPOI.HSSF.Model.InternalWorkbook.CustomPalette">
  8008. Returns the custom palette in use for this workbook; if a custom palette record
  8009. does not exist, then it is Created.
  8010. </member>
  8011. <member name="M:NPOI.HSSF.Model.InternalWorkbook.FindDrawingGroup">
  8012. Finds the primary drawing Group, if one already exists
  8013. </member>
  8014. <member name="M:NPOI.HSSF.Model.InternalWorkbook.CreateDrawingGroup">
  8015. Creates a primary drawing Group record. If it already
  8016. exists then it's modified.
  8017. </member>
  8018. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveFontRecord(NPOI.HSSF.Record.FontRecord)">
  8019. Removes the given font record from the
  8020. file's list. This will make all
  8021. subsequent font indicies drop by one,
  8022. so you'll need to update those yourself!
  8023. </member>
  8024. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(NPOI.HSSF.Record.ExtendedFormatRecord)">
  8025. Removes the given ExtendedFormatRecord record from the
  8026. file's list. This will make all
  8027. subsequent font indicies drop by one,
  8028. so you'll need to update those yourself!
  8029. </member>
  8030. <member name="M:NPOI.HSSF.Model.InternalWorkbook.RemoveExFormatRecord(System.Int32)">
  8031. <summary>
  8032. Removes ExtendedFormatRecord record with given index from the file's list. This will make all
  8033. subsequent font indicies drop by one,so you'll need to update those yourself!
  8034. </summary>
  8035. <param name="index">index of the Extended format record (0-based)</param>
  8036. </member>
  8037. <member name="P:NPOI.HSSF.Model.InternalWorkbook.IsWriteProtected">
  8038. is the workbook protected with a password (not encrypted)?
  8039. </member>
  8040. <member name="M:NPOI.HSSF.Model.InternalWorkbook.WriteProtectWorkbook(System.String,System.String)">
  8041. protect a workbook with a password (not encypted, just Sets Writeprotect
  8042. flags and the password.
  8043. @param password to Set
  8044. </member>
  8045. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UnwriteProtectWorkbook">
  8046. Removes the Write protect flag
  8047. </member>
  8048. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  8049. @param reFindex Index to REF entry in EXTERNSHEET record in the Link Table
  8050. @param definedNameIndex zero-based to DEFINEDNAME or EXTERNALNAME record
  8051. @return the string representation of the defined or external name
  8052. </member>
  8053. <member name="M:NPOI.HSSF.Model.InternalWorkbook.UpdateNamesAfterCellShift(NPOI.SS.Formula.FormulaShifter)">
  8054. Updates named ranges due to moving of cells
  8055. </member>
  8056. <member name="P:NPOI.HSSF.Model.InternalWorkbook.RecalcId">
  8057. Get or create RecalcIdRecord
  8058. @see org.apache.poi.hssf.usermodel.HSSFWorkbook#setForceFormulaRecalculation(boolean)
  8059. </member>
  8060. <member name="M:NPOI.HSSF.Model.InternalWorkbook.ChangeExternalReference(System.String,System.String)">
  8061. Changes an external referenced file to another file.
  8062. A formular in Excel which refers a cell in another file is saved in two parts:
  8063. The referenced file is stored in an reference table. the row/cell information is saved separate.
  8064. This method invokation will only change the reference in the lookup-table itself.
  8065. @param oldUrl The old URL to search for and which is to be replaced
  8066. @param newUrl The URL replacement
  8067. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  8068. </member>
  8069. <member name="T:NPOI.HSSF.Model.LineShape">
  8070. <summary>
  8071. Represents a line shape and Creates all the line specific low level records.
  8072. @author Glen Stampoultzis (glens at apache.org)
  8073. </summary>
  8074. </member>
  8075. <member name="M:NPOI.HSSF.Model.LineShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  8076. <summary>
  8077. Creates the line shape from the highlevel user shape. All low level
  8078. records are Created at this point.
  8079. </summary>
  8080. <param name="hssfShape">The user model shape</param>
  8081. <param name="shapeId">The identifier to use for this shape.</param>
  8082. </member>
  8083. <member name="M:NPOI.HSSF.Model.LineShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  8084. <summary>
  8085. Creates the lowerlevel escher records for this shape.
  8086. </summary>
  8087. <param name="hssfShape">The HSSF shape.</param>
  8088. <param name="shapeId">The shape id.</param>
  8089. <returns></returns>
  8090. </member>
  8091. <member name="M:NPOI.HSSF.Model.LineShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  8092. <summary>
  8093. Creates the low level OBJ record for this shape.
  8094. </summary>
  8095. <param name="hssfShape">The HSSF shape.</param>
  8096. <param name="shapeId">The shape id.</param>
  8097. <returns></returns>
  8098. </member>
  8099. <member name="P:NPOI.HSSF.Model.LineShape.SpContainer">
  8100. <summary>
  8101. The shape container and it's children that can represent this
  8102. shape.
  8103. </summary>
  8104. <value></value>
  8105. </member>
  8106. <member name="P:NPOI.HSSF.Model.LineShape.ObjRecord">
  8107. <summary>
  8108. The object record that is associated with this shape.
  8109. </summary>
  8110. <value></value>
  8111. </member>
  8112. <member name="T:NPOI.HSSF.Model.LinkTable">
  8113. Link Table (OOO pdf reference: 4.10.3 ) <p/>
  8114. The main data of all types of references is stored in the Link Table inside the Workbook Globals
  8115. Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any
  8116. references in the document.
  8117. <p/>
  8118. In BIFF8 the Link Table consists of
  8119. <ul>
  8120. <li>zero or more EXTERNALBOOK Blocks<p/>
  8121. each consisting of
  8122. <ul>
  8123. <li>exactly one EXTERNALBOOK (0x01AE) record</li>
  8124. <li>zero or more EXTERNALNAME (0x0023) records</li>
  8125. <li>zero or more CRN Blocks<p/>
  8126. each consisting of
  8127. <ul>
  8128. <li>exactly one XCT (0x0059)record</li>
  8129. <li>zero or more CRN (0x005A) records (documentation says one or more)</li>
  8130. </ul>
  8131. </li>
  8132. </ul>
  8133. </li>
  8134. <li>zero or one EXTERNSHEET (0x0017) record</li>
  8135. <li>zero or more DEFINEDNAME (0x0018) records</li>
  8136. </ul>
  8137. @author Josh Micich
  8138. </member>
  8139. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor">
  8140. Create a new block for registering add-in functions
  8141. @see org.apache.poi.hssf.model.LinkTable#addNameXPtg(String)
  8142. </member>
  8143. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.String,System.String[])">
  8144. Create a new block for external references.
  8145. </member>
  8146. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.#ctor(System.Int32)">
  8147. Create a new block for internal references. It is called when constructing a new LinkTable.
  8148. @see org.apache.poi.hssf.model.LinkTable#LinkTable(int, WorkbookRecordList)
  8149. </member>
  8150. <member name="M:NPOI.HSSF.Model.LinkTable.ExternalBookBlock.GetIndexOfName(System.String)">
  8151. Performs case-insensitive search
  8152. @return -1 if not found
  8153. </member>
  8154. <member name="P:NPOI.HSSF.Model.LinkTable.RecordCount">
  8155. TODO - would not be required if calling code used RecordStream or similar
  8156. </member>
  8157. <member name="M:NPOI.HSSF.Model.LinkTable.GetFirstInternalSheetIndexForExtIndex(System.Int32)">
  8158. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  8159. @return -1 if the reference is to an external book
  8160. </member>
  8161. <member name="M:NPOI.HSSF.Model.LinkTable.GetLastInternalSheetIndexForExtIndex(System.Int32)">
  8162. @param extRefIndex as from a {@link Ref3DPtg} or {@link Area3DPtg}
  8163. @return -1 if the reference is to an external book
  8164. </member>
  8165. <member name="M:NPOI.HSSF.Model.LinkTable.GetNameXPtg(System.String,System.Int32)">
  8166. Finds the external name definition for the given name,
  8167. optionally restricted by externsheet index, and returns
  8168. (if found) as a NameXPtg.
  8169. @param sheetRefIndex The Extern Sheet Index to look for, or -1 if any
  8170. </member>
  8171. <member name="M:NPOI.HSSF.Model.LinkTable.AddNameXPtg(System.String)">
  8172. Register an external name in this workbook
  8173. @param name the name to register
  8174. @return a NameXPtg describing this name
  8175. </member>
  8176. <member name="M:NPOI.HSSF.Model.LinkTable.FindFirstRecordLocBySid(System.Int16)">
  8177. copied from Workbook
  8178. </member>
  8179. <member name="M:NPOI.HSSF.Model.LinkTable.ChangeExternalReference(System.String,System.String)">
  8180. Changes an external referenced file to another file.
  8181. A formular in Excel which refers a cell in another file is saved in two parts:
  8182. The referenced file is stored in an reference table. the row/cell information is saved separate.
  8183. This method invokation will only change the reference in the lookup-table itself.
  8184. @param oldUrl The old URL to search for and which is to be replaced
  8185. @param newUrl The URL replacement
  8186. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  8187. </member>
  8188. <member name="T:NPOI.HSSF.Model.ParseNode">
  8189. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  8190. token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  8191. <c>Ptg</c> is non-atomic.
  8192. @author Josh Micich
  8193. </member>
  8194. <member name="M:NPOI.HSSF.Model.ParseNode.ToTokenArray(NPOI.HSSF.Model.ParseNode)">
  8195. <summary>
  8196. Collects the array of Ptg
  8197. tokens for the specified tree.
  8198. </summary>
  8199. <param name="rootNode">The root node.</param>
  8200. <returns></returns>
  8201. </member>
  8202. <member name="M:NPOI.HSSF.Model.ParseNode.CollectIfPtgs(NPOI.HSSF.Model.ParseNode.TokenCollector)">
  8203. <summary>
  8204. The IF() function Gets marked up with two or three tAttr tokens.
  8205. Similar logic will be required for CHOOSE() when it is supported
  8206. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  8207. </summary>
  8208. <param name="temp">The temp.</param>
  8209. </member>
  8210. <member name="T:NPOI.HSSF.Model.PictureShape">
  8211. <summary>
  8212. Represents a picture shape and Creates all specific low level records.
  8213. @author Glen Stampoultzis (glens at apache.org)
  8214. </summary>
  8215. </member>
  8216. <member name="M:NPOI.HSSF.Model.PictureShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  8217. <summary>
  8218. Creates the line shape from the highlevel user shape. All low level
  8219. records are Created at this point.
  8220. </summary>
  8221. <param name="hssfShape">The user model shape.</param>
  8222. <param name="shapeId">The identifier to use for this shape.</param>
  8223. </member>
  8224. <member name="M:NPOI.HSSF.Model.PictureShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  8225. <summary>
  8226. Creates the lowerlevel escher records for this shape.
  8227. </summary>
  8228. <param name="hssfShape">The HSSF shape.</param>
  8229. <param name="shapeId">The shape id.</param>
  8230. <returns></returns>
  8231. </member>
  8232. <member name="M:NPOI.HSSF.Model.PictureShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  8233. <summary>
  8234. Creates the low level OBJ record for this shape.
  8235. </summary>
  8236. <param name="hssfShape">The HSSFShape.</param>
  8237. <param name="shapeId">The shape id.</param>
  8238. <returns></returns>
  8239. </member>
  8240. <member name="P:NPOI.HSSF.Model.PictureShape.SpContainer">
  8241. <summary>
  8242. The shape container and it's children that can represent this
  8243. shape.
  8244. </summary>
  8245. <value></value>
  8246. </member>
  8247. <member name="P:NPOI.HSSF.Model.PictureShape.ObjRecord">
  8248. <summary>
  8249. The object record that is associated with this shape.
  8250. </summary>
  8251. <value></value>
  8252. </member>
  8253. <member name="M:NPOI.HSSF.Model.PolygonShape.#ctor(NPOI.HSSF.UserModel.HSSFPolygon,System.Int32)">
  8254. <summary>
  8255. Creates the low evel records for an polygon.
  8256. </summary>
  8257. <param name="hssfShape">The highlevel shape.</param>
  8258. <param name="shapeId">The shape id to use for this shape.</param>
  8259. </member>
  8260. <member name="M:NPOI.HSSF.Model.PolygonShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFPolygon,System.Int32)">
  8261. <summary>
  8262. Creates the lowerlevel escher records for this shape.
  8263. </summary>
  8264. <param name="hssfShape">The HSSF shape.</param>
  8265. <param name="shapeId">The shape id.</param>
  8266. <returns></returns>
  8267. </member>
  8268. <member name="M:NPOI.HSSF.Model.PolygonShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  8269. <summary>
  8270. Creates the lowerlevel OBJ records for this shape.
  8271. </summary>
  8272. <param name="hssfShape">The HSSF shape.</param>
  8273. <param name="shapeId">The shape id.</param>
  8274. <returns></returns>
  8275. </member>
  8276. <member name="P:NPOI.HSSF.Model.PolygonShape.SpContainer">
  8277. <summary>
  8278. The shape container and it's children that can represent this
  8279. shape.
  8280. </summary>
  8281. <value></value>
  8282. </member>
  8283. <member name="P:NPOI.HSSF.Model.PolygonShape.ObjRecord">
  8284. <summary>
  8285. The object record that is associated with this shape.
  8286. </summary>
  8287. <value></value>
  8288. </member>
  8289. <member name="T:NPOI.HSSF.Model.RecordOrderer">
  8290. Finds correct insert positions for records in workbook streams<p/>
  8291. See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream'
  8292. @author Josh Micich
  8293. </member>
  8294. <member name="M:NPOI.HSSF.Model.RecordOrderer.AddNewSheetRecord(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},NPOI.HSSF.Record.RecordBase)">
  8295. Adds the specified new record in the correct place in sheet records list
  8296. </member>
  8297. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetWorksheetProtectionBlockInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  8298. <summary>
  8299. Finds the index where the protection block should be inserted
  8300. </summary>
  8301. <param name="records">the records for this sheet</param>
  8302. <returns></returns>
  8303. <remark>
  8304. + BOF
  8305. o INDEX
  8306. o Calculation Settings Block
  8307. o PRINTHEADERS
  8308. o PRINTGRIDLINES
  8309. o GRIDSET
  8310. o GUTS
  8311. o DEFAULTROWHEIGHT
  8312. o SHEETPR
  8313. o Page Settings Block
  8314. o Worksheet Protection Block
  8315. o DEFCOLWIDTH
  8316. oo COLINFO
  8317. o SORT
  8318. + DIMENSION
  8319. </remark>
  8320. </member>
  8321. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsProtectionSubsequentRecord(System.Object)">
  8322. <summary>
  8323. These records may occur between the 'Worksheet Protection Block' and DIMENSION:
  8324. </summary>
  8325. <param name="rb"></param>
  8326. <returns></returns>
  8327. <remarks>
  8328. o DEFCOLWIDTH
  8329. oo COLINFO
  8330. o SORT
  8331. </remarks>
  8332. </member>
  8333. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindInsertPosForNewCondFormatTable(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  8334. <summary>
  8335. Find correct position to add new CFHeader record
  8336. </summary>
  8337. <param name="records"></param>
  8338. <returns></returns>
  8339. </member>
  8340. <member name="M:NPOI.HSSF.Model.RecordOrderer.FindDataValidationTableInsertPos(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  8341. Finds the index where the sheet validations header record should be inserted
  8342. @param records the records for this sheet
  8343. + WINDOW2
  8344. o SCL
  8345. o PANE
  8346. oo SELECTION
  8347. o STANDARDWIDTH
  8348. oo MERGEDCELLS
  8349. o LABELRANGES
  8350. o PHONETICPR
  8351. o Conditional Formatting Table
  8352. o Hyperlink Table
  8353. o Data Validity Table
  8354. o SHEETLAYOUT
  8355. o SHEETPROTECTION
  8356. o RANGEPROTECTION
  8357. + EOF
  8358. </member>
  8359. <member name="M:NPOI.HSSF.Model.RecordOrderer.GetDimensionsIndex(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  8360. DIMENSIONS record is always present
  8361. </member>
  8362. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsEndOfRowBlock(System.Int32)">
  8363. <summary>
  8364. if the specified record ID terminates a sequence of Row block records
  8365. It is assumed that at least one row or cell value record has been found prior to the current
  8366. record
  8367. </summary>
  8368. <param name="sid"></param>
  8369. <returns></returns>
  8370. </member>
  8371. <member name="M:NPOI.HSSF.Model.RecordOrderer.IsRowBlockRecord(System.Int32)">
  8372. <summary>
  8373. Whether the specified record id normally appears in the row blocks section of the sheet records
  8374. </summary>
  8375. <param name="sid"></param>
  8376. <returns></returns>
  8377. </member>
  8378. <member name="T:NPOI.HSSF.Model.RecordStream">
  8379. <summary>
  8380. Simplifies iteration over a sequence of Record objects.
  8381. @author Josh Micich
  8382. </summary>
  8383. </member>
  8384. <member name="M:NPOI.HSSF.Model.RecordStream.HasNext">
  8385. <summary>
  8386. Determines whether this instance has next.
  8387. </summary>
  8388. <returns>
  8389. <c>true</c> if this instance has next; otherwise, <c>false</c>.
  8390. </returns>
  8391. </member>
  8392. <member name="M:NPOI.HSSF.Model.RecordStream.GetNext">
  8393. <summary>
  8394. Gets the next record
  8395. </summary>
  8396. <returns></returns>
  8397. </member>
  8398. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextSid">
  8399. <summary>
  8400. Peeks the next sid.
  8401. </summary>
  8402. <returns>-1 if at end of records</returns>
  8403. </member>
  8404. <member name="M:NPOI.HSSF.Model.RecordStream.PeekNextClass">
  8405. <summary>
  8406. Peeks the next class.
  8407. </summary>
  8408. <returns>the class of the next Record.return null if this stream Is exhausted.</returns>
  8409. </member>
  8410. <member name="T:NPOI.HSSF.Model.RowBlocksReader">
  8411. Segregates the 'Row Blocks' section of a single sheet into plain row/cell records and
  8412. shared formula records.
  8413. @author Josh Micich
  8414. </member>
  8415. <member name="M:NPOI.HSSF.Model.RowBlocksReader.#ctor(NPOI.HSSF.Model.RecordStream)">
  8416. Also collects any loose MergeCellRecords and puts them in the supplied
  8417. mergedCellsTable
  8418. </member>
  8419. <member name="P:NPOI.HSSF.Model.RowBlocksReader.LooseMergedCells">
  8420. Some unconventional apps place {@link MergeCellsRecord}s within the row block. They
  8421. actually should be in the {@link MergedCellsTable} which is much later (see bug 45699).
  8422. @return any loose <c>MergeCellsRecord</c>s found
  8423. </member>
  8424. <member name="P:NPOI.HSSF.Model.RowBlocksReader.PlainRecordStream">
  8425. @return a {@link RecordStream} containing all the non-{@link SharedFormulaRecord}
  8426. non-{@link ArrayRecord} and non-{@link TableRecord} Records.
  8427. </member>
  8428. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.#ctor(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  8429. <summary>
  8430. Creates the low evel records for an oval.
  8431. </summary>
  8432. <param name="hssfShape">The highlevel shape.</param>
  8433. <param name="shapeId">The shape id to use for this shape.</param>
  8434. </member>
  8435. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFSimpleShape,System.Int32)">
  8436. <summary>
  8437. Creates the lowerlevel escher records for this shape.
  8438. </summary>
  8439. <param name="hssfShape">The HSSF shape.</param>
  8440. <param name="shapeId">The shape id.</param>
  8441. <returns></returns>
  8442. </member>
  8443. <member name="M:NPOI.HSSF.Model.SimpleFilledShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFShape,System.Int32)">
  8444. <summary>
  8445. Creates the lowerlevel OBJ records for this shape.
  8446. </summary>
  8447. <param name="hssfShape">The HSSF shape.</param>
  8448. <param name="shapeId">The shape id.</param>
  8449. <returns></returns>
  8450. </member>
  8451. <member name="P:NPOI.HSSF.Model.SimpleFilledShape.SpContainer">
  8452. <summary>
  8453. The shape container and it's children that can represent this
  8454. shape.
  8455. </summary>
  8456. <value></value>
  8457. </member>
  8458. <member name="P:NPOI.HSSF.Model.SimpleFilledShape.ObjRecord">
  8459. <summary>
  8460. The object record that is associated with this shape.
  8461. </summary>
  8462. <value></value>
  8463. </member>
  8464. <member name="T:NPOI.HSSF.Model.TextboxShape">
  8465. <summary>
  8466. Represents an textbox shape and Converts between the highlevel records
  8467. and lowlevel records for an oval.
  8468. @author Glen Stampoultzis (glens at apache.org)
  8469. </summary>
  8470. </member>
  8471. <member name="M:NPOI.HSSF.Model.TextboxShape.#ctor(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  8472. <summary>
  8473. Creates the low evel records for a textbox.
  8474. </summary>
  8475. <param name="hssfShape">The highlevel shape.</param>
  8476. <param name="shapeId">The shape id to use for this shape.</param>
  8477. </member>
  8478. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateObjRecord(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  8479. <summary>
  8480. Creates the lowerlevel OBJ records for this shape.
  8481. </summary>
  8482. <param name="hssfShape">The HSSF shape.</param>
  8483. <param name="shapeId">The shape id.</param>
  8484. <returns></returns>
  8485. </member>
  8486. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateSpContainer(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  8487. <summary>
  8488. Creates the lowerlevel escher records for this shape.
  8489. </summary>
  8490. <param name="hssfShape">The HSSF shape.</param>
  8491. <param name="shapeId">The shape id.</param>
  8492. <returns></returns>
  8493. </member>
  8494. <member name="M:NPOI.HSSF.Model.TextboxShape.CreateTextObjectRecord(NPOI.HSSF.UserModel.HSSFTextbox,System.Int32)">
  8495. <summary>
  8496. Textboxes also have an extra TXO record associated with them that most
  8497. other shapes dont have.
  8498. </summary>
  8499. <param name="hssfShape">The HSSF shape.</param>
  8500. <param name="shapeId">The shape id.</param>
  8501. <returns></returns>
  8502. </member>
  8503. <member name="P:NPOI.HSSF.Model.TextboxShape.SpContainer">
  8504. <summary>
  8505. The shape container and it's children that can represent this
  8506. shape.
  8507. </summary>
  8508. <value></value>
  8509. </member>
  8510. <member name="P:NPOI.HSSF.Model.TextboxShape.ObjRecord">
  8511. <summary>
  8512. The object record that is associated with this shape.
  8513. </summary>
  8514. <value></value>
  8515. </member>
  8516. <member name="P:NPOI.HSSF.Model.TextboxShape.TextObjectRecord">
  8517. <summary>
  8518. The TextObject record that is associated with this shape.
  8519. </summary>
  8520. <value></value>
  8521. </member>
  8522. <member name="P:NPOI.HSSF.Model.TextboxShape.EscherTextbox">
  8523. <summary>
  8524. Gets the EscherTextbox record.
  8525. </summary>
  8526. <value>The EscherTextbox record.</value>
  8527. </member>
  8528. <member name="T:NPOI.HSSF.Model.WorkbookRecordList">
  8529. <summary>
  8530. List for records in Workbook
  8531. </summary>
  8532. </member>
  8533. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Records">
  8534. <summary>
  8535. Gets or sets the records.
  8536. </summary>
  8537. <value>The records.</value>
  8538. </member>
  8539. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Count">
  8540. <summary>
  8541. Gets the count.
  8542. </summary>
  8543. <value>The count.</value>
  8544. </member>
  8545. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Item(System.Int32)">
  8546. <summary>
  8547. Gets the <see cref="T:NPOI.HSSF.Record.Record"/> at the specified index.
  8548. </summary>
  8549. <value></value>
  8550. </member>
  8551. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Add(System.Int32,NPOI.HSSF.Record.Record)">
  8552. <summary>
  8553. Adds the specified pos.
  8554. </summary>
  8555. <param name="pos">The pos.</param>
  8556. <param name="r">The r.</param>
  8557. </member>
  8558. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(NPOI.HSSF.Record.Record)">
  8559. <summary>
  8560. Removes the specified record.
  8561. </summary>
  8562. <param name="record">The record.</param>
  8563. </member>
  8564. <member name="M:NPOI.HSSF.Model.WorkbookRecordList.Remove(System.Int32)">
  8565. <summary>
  8566. Removes the specified position.
  8567. </summary>
  8568. <param name="pos">The position.</param>
  8569. </member>
  8570. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Protpos">
  8571. <summary>
  8572. Gets or sets the protpos.
  8573. </summary>
  8574. <value>The protpos.</value>
  8575. </member>
  8576. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Bspos">
  8577. <summary>
  8578. Gets or sets the bspos.
  8579. </summary>
  8580. <value>The bspos.</value>
  8581. </member>
  8582. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Tabpos">
  8583. <summary>
  8584. Gets or sets the tabpos.
  8585. </summary>
  8586. <value>The tabpos.</value>
  8587. </member>
  8588. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Fontpos">
  8589. <summary>
  8590. Gets or sets the fontpos.
  8591. </summary>
  8592. <value>The fontpos.</value>
  8593. </member>
  8594. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Xfpos">
  8595. <summary>
  8596. Gets or sets the xfpos.
  8597. </summary>
  8598. <value>The xfpos.</value>
  8599. </member>
  8600. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Backuppos">
  8601. <summary>
  8602. Gets or sets the backuppos.
  8603. </summary>
  8604. <value>The backuppos.</value>
  8605. </member>
  8606. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Palettepos">
  8607. <summary>
  8608. Gets or sets the palettepos.
  8609. </summary>
  8610. <value>The palettepos.</value>
  8611. </member>
  8612. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Namepos">
  8613. <summary>
  8614. Gets or sets the namepos.
  8615. </summary>
  8616. <value>The namepos.</value>
  8617. </member>
  8618. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.Supbookpos">
  8619. <summary>
  8620. Gets or sets the supbookpos.
  8621. </summary>
  8622. <value>The supbookpos.</value>
  8623. </member>
  8624. <member name="P:NPOI.HSSF.Model.WorkbookRecordList.ExternsheetPos">
  8625. <summary>
  8626. Gets or sets the externsheet pos.
  8627. </summary>
  8628. <value>The externsheet pos.</value>
  8629. </member>
  8630. <member name="T:NPOI.HSSF.Record.AbstractEscherHolderRecord">
  8631. The escher container record is used to hold escher records. It is abstract and
  8632. must be subclassed for maximum benefit.
  8633. @author Glen Stampoultzis (glens at apache.org)
  8634. @author Michael Zalewski (zalewski at optonline.net)
  8635. </member>
  8636. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  8637. Constructs a Bar record and Sets its fields appropriately.
  8638. @param in the RecordInputstream to Read the record from
  8639. </member>
  8640. <member name="P:NPOI.HSSF.Record.AbstractEscherHolderRecord.RecordSize">
  8641. Size of record (including 4 byte header)
  8642. </member>
  8643. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.AddEscherRecord(System.Int32,NPOI.DDF.EscherRecord)">
  8644. Clone the current record, via a call to serialise
  8645. it, and another to Create a new record from the
  8646. bytes.
  8647. May only be used for classes which don't have
  8648. internal counts / ids in them. For those which
  8649. do, a full record-aware serialise is needed, which
  8650. allocates new ids / counts as needed.
  8651. </member>
  8652. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.GetEscherContainer">
  8653. If we have a EscherContainerRecord as one of our
  8654. children (and most top level escher holders do),
  8655. then return that.
  8656. </member>
  8657. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.FindFirstWithId(System.Int16)">
  8658. Descends into all our children, returning the
  8659. first EscherRecord with the given id, or null
  8660. if none found
  8661. </member>
  8662. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Join(NPOI.HSSF.Record.AbstractEscherHolderRecord)">
  8663. Big drawing Group records are split but it's easier to deal with them
  8664. as a whole Group so we need to join them toGether.
  8665. </member>
  8666. <member name="M:NPOI.HSSF.Record.AbstractEscherHolderRecord.Decode">
  8667. Convert raw data to escher records.
  8668. </member>
  8669. <member name="T:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate">
  8670. <summary>
  8671. </summary>
  8672. CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord
  8673. and number of up to three CFRuleRecord records toGether to simplify
  8674. access to them.
  8675. @author Dmitriy Kumshayev
  8676. </member>
  8677. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.MAX_97_2003_CONDTIONAL_FORMAT_RULES">
  8678. Excel allows up to 3 conditional formating rules
  8679. </member>
  8680. <member name="F:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.rules">
  8681. List of CFRuleRecord objects
  8682. </member>
  8683. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(NPOI.HSSF.Model.RecordStream)">
  8684. <summary>
  8685. Create CFRecordsAggregate from a list of CF Records
  8686. </summary>
  8687. <param name="rs">list of Record objects</param>
  8688. </member>
  8689. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CreateCFAggregate(System.Collections.IList,System.Int32)">
  8690. <summary>
  8691. Create CFRecordsAggregate from a list of CF Records
  8692. </summary>
  8693. <param name="recs">list of Record objects</param>
  8694. <param name="pOffset">position of CFHeaderRecord object in the list of Record objects</param>
  8695. </member>
  8696. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.CloneCFAggregate">
  8697. <summary>
  8698. Create a deep Clone of the record
  8699. </summary>
  8700. </member>
  8701. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  8702. <summary>
  8703. called by the class that is responsible for writing this sucker.
  8704. Subclasses should implement this so that their data is passed back in a
  8705. byte array.
  8706. </summary>
  8707. <param name="offset">The offset to begin writing at</param>
  8708. <param name="data">The data byte array containing instance data</param>
  8709. <returns> number of bytes written</returns>
  8710. </member>
  8711. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.UpdateFormulasAfterCellShift(NPOI.SS.Formula.FormulaShifter,System.Int32)">
  8712. @return <c>false</c> if this whole {@link CFHeaderRecord} / {@link CFRuleRecord}s should be deleted
  8713. </member>
  8714. <member name="M:NPOI.HSSF.Record.Aggregates.CFRecordsAggregate.ToString">
  8715. @return sum of sizes of all aggregated records
  8716. </member>
  8717. <member name="T:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate">
  8718. Manages the all the records associated with a chart sub-stream.<br/>
  8719. Includes the Initial {@link BOFRecord} and {@link EOFRecord}.
  8720. @author Josh Micich
  8721. </member>
  8722. <member name="F:NPOI.HSSF.Record.Aggregates.ChartSubstreamRecordAggregate._recs">
  8723. All the records between BOF and EOF
  8724. </member>
  8725. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AttachedLabelAggregate">
  8726. <summary>
  8727. ATTACHEDLABEL = Text Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  8728. AI = BRAI [SeriesText]
  8729. </summary>
  8730. </member>
  8731. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxesAggregate">
  8732. <summary>
  8733. AXES = [IVAXIS DVAXIS [SERIESAXIS] / DVAXIS DVAXIS] *3ATTACHEDLABEL [PlotArea FRAME]
  8734. </summary>
  8735. </member>
  8736. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AxisParentAggregate">
  8737. <summary>
  8738. AXISPARENT = AxisParent Begin Pos [AXES] 1*4CRT End
  8739. </summary>
  8740. </member>
  8741. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXMAggregate">
  8742. <summary>
  8743. AXM = YMult StartObject ATTACHEDLABEL EndObject
  8744. </summary>
  8745. </member>
  8746. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.AXSAggregate">
  8747. <summary>
  8748. AXS = [IFmtRecord] [Tick] [FontX] *4(AxisLine LineFormat) [AreaFormat]
  8749. [GELFRAME] *4SHAPEPROPS [TextPropsStream *ContinueFrt12]
  8750. </summary>
  8751. </member>
  8752. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartFormatsAggregate">
  8753. <summary>
  8754. CHARTFOMATS = Chart Begin *2FONTLIST Scl PlotGrowth [FRAME] *SERIESFORMAT *SS ShtProps
  8755. *2DFTTEXT AxesUsed 1*2AXISPARENT [CrtLayout12A] [DAT] *ATTACHEDLABEL [CRTMLFRT]
  8756. *([DataLabExt StartObject] ATTACHEDLABEL [EndObject]) [TEXTPROPS] *2CRTMLFRT End
  8757. </summary>
  8758. </member>
  8759. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate">
  8760. <summary>
  8761. CHARTSHEET = BOF CHARTSHEETCONTENT
  8762. CHARTSHEETCONTENT = [WriteProtect] [SheetExt] [WebPub] *HFPicture PAGESETUP PrintSize
  8763. [HeaderFooter] [BACKGROUND] *Fbi *Fbi2 [ClrtClient] [PROTECTION] [Palette] [SXViewLink]
  8764. [PivotChartBits] [SBaseRef] [MsoDrawingGroup] OBJECTS Units CHARTFOMATS SERIESDATA
  8765. *WINDOW *CUSTOMVIEW [CodeName] [CRTMLFRT] EOF
  8766. </summary>
  8767. </member>
  8768. <member name="F:NPOI.HSSF.Record.Aggregates.Chart.ChartSheetAggregate._recs">
  8769. All the records between BOF and EOF
  8770. </member>
  8771. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CRTAggregate">
  8772. <summary>
  8773. CRT = ChartFormat Begin (Bar / Line / (BopPop [BopPopCustom]) / Pie / Area / Scatter / Radar /
  8774. RadarArea / Surf) CrtLink [SeriesList] [Chart3d] [LD] [2DROPBAR] *4(CrtLine LineFormat)
  8775. *2DFTTEXT [DataLabExtContents] [SS] *4SHAPEPROPS End
  8776. </summary>
  8777. </member>
  8778. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.CrtMlFrtAggregate">
  8779. <summary>
  8780. CRTMLFRT = CrtMlFrt *CrtMlFrtContinue
  8781. </summary>
  8782. </member>
  8783. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DatAggregate">
  8784. <summary>
  8785. DAT = Dat Begin LD End
  8786. </summary>
  8787. </member>
  8788. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DFTTextAggregate">
  8789. <summary>
  8790. DFTTEXT = [DataLabExt StartObject] DefaultText ATTACHEDLABEL [EndObject]
  8791. </summary>
  8792. </member>
  8793. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DropBarAggregate">
  8794. <summary>
  8795. DROPBAR = DropBar Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  8796. </summary>
  8797. </member>
  8798. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.DVAxisAggregate">
  8799. <summary>
  8800. DVAXIS = Axis Begin [ValueRange] [AXM] AXS [CRTMLFRT] End
  8801. </summary>
  8802. </member>
  8803. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FontListAggregate">
  8804. <summary>
  8805. FONTLIST = FrtFontList StartObject *(Font [Fbi]) EndObject
  8806. </summary>
  8807. </member>
  8808. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.FrameAggregate">
  8809. <summary>
  8810. FRAME = Frame Begin LineFormat AreaFormat [GELFRAME] [SHAPEPROPS] End
  8811. </summary>
  8812. </member>
  8813. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.GelFrameAggregate">
  8814. <summary>
  8815. GELFRAME = 1*2GelFrame *Continue [PICF]
  8816. PICF = Begin PicF End
  8817. </summary>
  8818. </member>
  8819. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.IVAxisAggregate">
  8820. <summary>
  8821. IVAXIS = Axis Begin [CatSerRange] AxcExt [CatLab] AXS [CRTMLFRT] End
  8822. </summary>
  8823. </member>
  8824. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.LDAggregate">
  8825. <summary>
  8826. LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End
  8827. </summary>
  8828. </member>
  8829. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesAxisAggregate">
  8830. <summary>
  8831. SERIESAXIS = Axis Begin [CatSerRange] AXS [CRTMLFRT] End
  8832. </summary>
  8833. </member>
  8834. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesDataAggregate">
  8835. <summary>
  8836. SERIESDATA = Dimensions 3(SIIndex *(Number / BoolErr / Blank / Label))
  8837. </summary>
  8838. </member>
  8839. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate">
  8840. <summary>
  8841. SERIESFORMAT = Series Begin 4AI *SS (SerToCrt / (SerParent (SerAuxTrend / SerAuxErrBar)))
  8842. *(LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]) End
  8843. </summary>
  8844. </member>
  8845. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SeriesFormatAggregate.LegendExceptionAggregate">
  8846. <summary>
  8847. LegendException [Begin ATTACHEDLABEL [TEXTPROPS] End]
  8848. </summary>
  8849. </member>
  8850. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.ShapePropsAggregate">
  8851. <summary>
  8852. SHAPEPROPS = ShapePropsStream *ContinueFrt12
  8853. </summary>
  8854. </member>
  8855. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.SSAggregate">
  8856. <summary>
  8857. SS = DataFormat Begin [Chart3DBarShape] [LineFormat AreaFormat PieFormat] [SerFmt]
  8858. [GELFRAME] [MarkerFormat] [AttachedLabel] *2SHAPEPROPS [CRTMLFRT] End
  8859. </summary>
  8860. </member>
  8861. <member name="T:NPOI.HSSF.Record.Aggregates.Chart.TextPropsAggregate">
  8862. <summary>
  8863. TEXTPROPS = (RichTextStream / TextPropsStream) *ContinueFrt12
  8864. </summary>
  8865. </member>
  8866. <member name="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate">
  8867. <summary>
  8868. @author Glen Stampoultzis
  8869. </summary>
  8870. </member>
  8871. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor">
  8872. <summary>
  8873. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  8874. </summary>
  8875. </member>
  8876. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream)">
  8877. <summary>
  8878. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate"/> class.
  8879. </summary>
  8880. <param name="rs">The rs.</param>
  8881. </member>
  8882. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Sid">
  8883. It's an aggregate... just made something up
  8884. </member>
  8885. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.NumColumns">
  8886. <summary>
  8887. Gets the num columns.
  8888. </summary>
  8889. <value>The num columns.</value>
  8890. </member>
  8891. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.RecordSize">
  8892. <summary>
  8893. Gets the size of the record.
  8894. </summary>
  8895. <value>The size of the record.</value>
  8896. </member>
  8897. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Clone">
  8898. Performs a deep Clone of the record
  8899. </member>
  8900. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(NPOI.HSSF.Record.ColumnInfoRecord)">
  8901. <summary>
  8902. Inserts a column into the aggregate (at the end of the list).
  8903. </summary>
  8904. <param name="col">The column.</param>
  8905. </member>
  8906. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.InsertColumn(System.Int32,NPOI.HSSF.Record.ColumnInfoRecord)">
  8907. <summary>
  8908. Inserts a column into the aggregate (at the position specified
  8909. by index
  8910. </summary>
  8911. <param name="idx">The index.</param>
  8912. <param name="col">The columninfo.</param>
  8913. </member>
  8914. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.Serialize(System.Int32,System.Byte[])">
  8915. <summary>
  8916. called by the class that is responsible for writing this sucker.
  8917. Subclasses should implement this so that their data is passed back in a
  8918. byte array.
  8919. </summary>
  8920. <param name="offset">offset to begin writing at</param>
  8921. <param name="data">byte array containing instance data</param>
  8922. <returns>number of bytes written</returns>
  8923. </member>
  8924. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  8925. <summary>
  8926. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  8927. that they should be written to file. Implementors may or may not return the actual
  8928. Records being used to manage POI's internal implementation. Callers should not
  8929. assume either way, and therefore only attempt to modify those Records after cloning
  8930. </summary>
  8931. <param name="rv"></param>
  8932. </member>
  8933. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindStartOfColumnOutlineGroup(System.Int32)">
  8934. <summary>
  8935. Finds the start of column outline group.
  8936. </summary>
  8937. <param name="idx">The idx.</param>
  8938. <returns></returns>
  8939. </member>
  8940. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindEndOfColumnOutlineGroup(System.Int32)">
  8941. <summary>
  8942. Finds the end of column outline group.
  8943. </summary>
  8944. <param name="idx">The idx.</param>
  8945. <returns></returns>
  8946. </member>
  8947. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GetColInfo(System.Int32)">
  8948. <summary>
  8949. Gets the col info.
  8950. </summary>
  8951. <param name="idx">The idx.</param>
  8952. <returns></returns>
  8953. </member>
  8954. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupCollapsed(System.Int32)">
  8955. <summary>
  8956. Determines whether [is column group collapsed] [the specified idx].
  8957. </summary>
  8958. <param name="idx">The idx.</param>
  8959. <returns>
  8960. <c>true</c> if [is column group collapsed] [the specified idx]; otherwise, <c>false</c>.
  8961. </returns>
  8962. </member>
  8963. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.IsColumnGroupHiddenByParent(System.Int32)">
  8964. <summary>
  8965. Determines whether [is column group hidden by parent] [the specified idx].
  8966. </summary>
  8967. <param name="idx">The idx.</param>
  8968. <returns>
  8969. <c>true</c> if [is column group hidden by parent] [the specified idx]; otherwise, <c>false</c>.
  8970. </returns>
  8971. </member>
  8972. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColumn(System.Int32)">
  8973. <summary>
  8974. Collapses the column.
  8975. </summary>
  8976. <param name="columnNumber">The column number.</param>
  8977. </member>
  8978. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.ExpandColumn(System.Int32)">
  8979. <summary>
  8980. Expands the column.
  8981. </summary>
  8982. <param name="columnNumber">The column number.</param>
  8983. </member>
  8984. <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})">
  8985. Sets all non null fields into the <c>ci</c> parameter.
  8986. </member>
  8987. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.AttemptMergeColInfoRecords(System.Int32)">
  8988. <summary>
  8989. Attempts to merge the col info record at the specified index
  8990. with either or both of its neighbours
  8991. </summary>
  8992. <param name="colInfoIx">The col info ix.</param>
  8993. </member>
  8994. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MergeColInfoRecords(NPOI.HSSF.Record.ColumnInfoRecord,NPOI.HSSF.Record.ColumnInfoRecord)">
  8995. merges two column info records (if they are adjacent and have the same formatting, etc)
  8996. @return <c>false</c> if the two column records could not be merged
  8997. </member>
  8998. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetGroupHidden(System.Int32,System.Int32,System.Boolean)">
  8999. <summary>
  9000. Sets all adjacent columns of the same outline level to the specified hidden status.
  9001. </summary>
  9002. <param name="pIdx">the col info index of the start of the outline group.</param>
  9003. <param name="level">The level.</param>
  9004. <param name="hidden">The hidden.</param>
  9005. <returns>the column index of the last column in the outline group</returns>
  9006. </member>
  9007. <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})">
  9008. <summary>
  9009. Sets the column.
  9010. </summary>
  9011. <param name="targetColumnIx">The target column ix.</param>
  9012. <param name="xfIndex">Index of the xf.</param>
  9013. <param name="width">The width.</param>
  9014. <param name="level">The level.</param>
  9015. <param name="hidden">The hidden.</param>
  9016. <param name="collapsed">The collapsed.</param>
  9017. </member>
  9018. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.SetColumnInfoFields(NPOI.HSSF.Record.ColumnInfoRecord,System.Int16,System.Int16,System.Int32,System.Boolean,System.Boolean)">
  9019. Sets all non null fields into the <c>ci</c> parameter.
  9020. </member>
  9021. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.CollapseColInfoRecords(System.Int32)">
  9022. <summary>
  9023. Collapses the col info records.
  9024. </summary>
  9025. <param name="columnIdx">The column index.</param>
  9026. </member>
  9027. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.GroupColumnRange(System.Int32,System.Int32,System.Boolean)">
  9028. <summary>
  9029. Creates an outline Group for the specified columns.
  9030. </summary>
  9031. <param name="fromColumnIx">Group from this column (inclusive)</param>
  9032. <param name="toColumnIx">Group to this column (inclusive)</param>
  9033. <param name="indent">if true the Group will be indented by one level;if false indenting will be Removed by one level.</param>
  9034. </member>
  9035. <member name="M:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.FindColumnInfo(System.Int32)">
  9036. <summary>
  9037. Finds the ColumnInfoRecord
  9038. which contains the specified columnIndex
  9039. </summary>
  9040. <param name="columnIndex">index of the column (not the index of the ColumnInfoRecord)</param>
  9041. <returns> /// <c>null</c>
  9042. if no column info found for the specified column
  9043. </returns>
  9044. </member>
  9045. <member name="P:NPOI.HSSF.Record.Aggregates.ColumnInfoRecordsAggregate.MaxOutlineLevel">
  9046. <summary>
  9047. Gets the max outline level.
  9048. </summary>
  9049. <value>The max outline level.</value>
  9050. </member>
  9051. <member name="T:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable">
  9052. Holds all the conditional formatting for a workbook sheet.<p/>
  9053. See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'
  9054. @author Josh Micich
  9055. </member>
  9056. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.#ctor">
  9057. Creates an empty ConditionalFormattingTable
  9058. </member>
  9059. <member name="M:NPOI.HSSF.Record.Aggregates.ConditionalFormattingTable.Add(NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  9060. @return index of the newly added CF header aggregate
  9061. </member>
  9062. <member name="T:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate">
  9063. Manages the all the records associated with a 'Custom View Settings' sub-stream.<br/>
  9064. Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB).
  9065. @author Josh Micich
  9066. </member>
  9067. <member name="F:NPOI.HSSF.Record.Aggregates.CustomViewSettingsRecordAggregate._recs">
  9068. All the records between BOF and EOF
  9069. </member>
  9070. <member name="T:NPOI.HSSF.Record.Aggregates.DataValidityTable">
  9071. <summary>
  9072. Manages the DVALRecord and DVRecords for a single sheet
  9073. See OOO excelfileformat.pdf section 4.14
  9074. @author Josh Micich
  9075. </summary>
  9076. </member>
  9077. <member name="F:NPOI.HSSF.Record.Aggregates.DataValidityTable._validationList">
  9078. The list of data validations for the current sheet.
  9079. Note - this may be empty (contrary to OOO documentation)
  9080. </member>
  9081. <member name="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate">
  9082. <summary>
  9083. The formula record aggregate is used to join toGether the formula record and it's
  9084. (optional) string record and (optional) Shared Formula Record (template Reads, excel optimization).
  9085. @author Glen Stampoultzis (glens at apache.org)
  9086. </summary>
  9087. </member>
  9088. <member name="F:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate._stringRecord">
  9089. caches the calculated result of the formula
  9090. </member>
  9091. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.#ctor(NPOI.HSSF.Record.FormulaRecord,NPOI.HSSF.Record.StringRecord,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  9092. <summary>
  9093. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate"/> class.
  9094. </summary>
  9095. <param name="formulaRec">The formula rec.</param>
  9096. <param name="stringRec">The string rec.</param>
  9097. <param name="svm">The SVM.</param>
  9098. </member>
  9099. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.NotifyFormulaChanging">
  9100. Should be called by any code which is either deleting this formula cell, or changing
  9101. its type. This method gives the aggregate a chance to unlink any shared formula
  9102. that may be involved with this cell formula.
  9103. </member>
  9104. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Serialize(System.Int32,System.Byte[])">
  9105. <summary>
  9106. called by the class that is responsible for writing this sucker.
  9107. Subclasses should implement this so that their data is passed back in a
  9108. byte array.
  9109. </summary>
  9110. <param name="offset">offset to begin writing at</param>
  9111. <param name="data">byte array containing instance data.</param>
  9112. <returns>number of bytes written</returns>
  9113. </member>
  9114. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  9115. <summary>
  9116. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  9117. that they should be written to file. Implementors may or may not return the actual
  9118. {@link Record}s being used to manage POI's internal implementation. Callers should not
  9119. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  9120. </summary>
  9121. <param name="rv"></param>
  9122. </member>
  9123. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RecordSize">
  9124. <summary>
  9125. Get the current Serialized size of the record. Should include the sid and recLength (4 bytes).
  9126. </summary>
  9127. <value>The size of the record.</value>
  9128. </member>
  9129. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Sid">
  9130. <summary>
  9131. return the non static version of the id for this record.
  9132. </summary>
  9133. <value>The sid.</value>
  9134. </member>
  9135. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  9136. <summary>
  9137. Sometimes the shared formula flag "seems" to be erroneously set (because the corresponding
  9138. SharedFormulaRecord does not exist). Normally this would leave no way of determining
  9139. the Ptg tokens for the formula. However as it turns out in these
  9140. cases, Excel encodes the unshared Ptg tokens in the right place (inside the FormulaRecord).
  9141. So the the only thing that needs to be done is to ignore the erroneous
  9142. shared formula flag.
  9143. This method may also be used for setting breakpoints to help diagnose issues regarding the
  9144. abnormally-set 'shared formula' flags.
  9145. </summary>
  9146. <param name="formula">The formula.</param>
  9147. </member>
  9148. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.FormulaRecord">
  9149. <summary>
  9150. Gets or sets the formula record.
  9151. </summary>
  9152. <value>The formula record.</value>
  9153. </member>
  9154. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringRecord">
  9155. <summary>
  9156. Gets or sets the string record.
  9157. </summary>
  9158. <value>The string record.</value>
  9159. </member>
  9160. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.Equals(System.Object)">
  9161. <summary>
  9162. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  9163. </summary>
  9164. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  9165. <returns>
  9166. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  9167. </returns>
  9168. <exception cref="T:System.NullReferenceException">
  9169. The <paramref name="obj"/> parameter is null.
  9170. </exception>
  9171. </member>
  9172. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.ToString">
  9173. <summary>
  9174. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  9175. </summary>
  9176. <returns>
  9177. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  9178. </returns>
  9179. </member>
  9180. <member name="P:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.StringValue">
  9181. <summary>
  9182. Gets the string value.
  9183. </summary>
  9184. <value>The string value.</value>
  9185. </member>
  9186. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedStringResult(System.String)">
  9187. <summary>
  9188. Sets the cached string result.
  9189. </summary>
  9190. <param name="value">The value.</param>
  9191. </member>
  9192. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedBooleanResult(System.Boolean)">
  9193. <summary>
  9194. Sets the cached boolean result.
  9195. </summary>
  9196. <param name="value">if set to <c>true</c> [value].</param>
  9197. </member>
  9198. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetCachedErrorResult(System.Int32)">
  9199. <summary>
  9200. Sets the cached error result.
  9201. </summary>
  9202. <param name="errorCode">The error code.</param>
  9203. </member>
  9204. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.SetParsedExpression(NPOI.SS.Formula.PTG.Ptg[])">
  9205. Also checks for a related shared formula and unlinks it if found
  9206. </member>
  9207. <member name="M:NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate.RemoveArrayFormula(System.Int32,System.Int32)">
  9208. Removes an array formula
  9209. @return the range of the array formula containing the specified cell. Never <code>null</code>
  9210. </member>
  9211. <member name="T:NPOI.HSSF.Record.Aggregates.MergedCellsTable">
  9212. @author Josh Micich
  9213. </member>
  9214. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.#ctor">
  9215. <summary>
  9216. Creates an empty aggregate
  9217. </summary>
  9218. </member>
  9219. <member name="M:NPOI.HSSF.Record.Aggregates.MergedCellsTable.Read(NPOI.HSSF.Model.RecordStream)">
  9220. Reads zero or more consecutive {@link MergeCellsRecord}s
  9221. @param rs
  9222. </member>
  9223. <member name="T:NPOI.HSSF.Record.Aggregates.PageSettingsBlock">
  9224. Groups the page settings records for a worksheet.<p/>
  9225. See OOO excelfileformat.pdf sec 4.4 'Page Settings Block'
  9226. @author Josh Micich
  9227. </member>
  9228. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.#ctor">
  9229. Creates a PageSettingsBlock with default settings
  9230. </member>
  9231. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsComponentRecord(System.Int32)">
  9232. @return <c>true</c> if the specified Record sid is one belonging to the
  9233. 'Page Settings Block'.
  9234. </member>
  9235. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetColumnBreak(System.Int32,System.Int32,System.Int32)">
  9236. Sets a page break at the indicated column
  9237. </member>
  9238. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveColumnBreak(System.Int32)">
  9239. Removes a page break at the indicated column
  9240. </member>
  9241. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateHCenter">
  9242. Creates the HCenter Record and sets it to false (don't horizontally center)
  9243. </member>
  9244. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreateVCenter">
  9245. Creates the VCenter Record and sets it to false (don't horizontally center)
  9246. </member>
  9247. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.CreatePrintSetup">
  9248. Creates the PrintSetup Record and sets it to defaults and marks it invalid
  9249. @see org.apache.poi.hssf.record.PrintSetupRecord
  9250. @see org.apache.poi.hssf.record.Record
  9251. @return record containing a PrintSetupRecord
  9252. </member>
  9253. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Header">
  9254. Returns the HeaderRecord.
  9255. @return HeaderRecord for the sheet.
  9256. </member>
  9257. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.Footer">
  9258. Returns the FooterRecord.
  9259. @return FooterRecord for the sheet.
  9260. </member>
  9261. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.PrintSetup">
  9262. Returns the PrintSetupRecord.
  9263. @return PrintSetupRecord for the sheet.
  9264. </member>
  9265. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.GetMargin(NPOI.SS.UserModel.MarginType)">
  9266. Gets the size of the margin in inches.
  9267. @param margin which margin to Get
  9268. @return the size of the margin
  9269. </member>
  9270. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  9271. Sets the size of the margin in inches.
  9272. @param margin which margin to Get
  9273. @param size the size of the margin
  9274. </member>
  9275. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftBreaks(NPOI.HSSF.Record.PageBreakRecord,System.Int32,System.Int32,System.Int32)">
  9276. Shifts all the page breaks in the range "count" number of rows/columns
  9277. @param breaks The page record to be shifted
  9278. @param start Starting "main" value to shift breaks
  9279. @param stop Ending "main" value to shift breaks
  9280. @param count number of units (rows/columns) to shift by
  9281. </member>
  9282. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.SetRowBreak(System.Int32,System.Int16,System.Int16)">
  9283. Sets a page break at the indicated row
  9284. @param row
  9285. </member>
  9286. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RemoveRowBreak(System.Int32)">
  9287. Removes a page break at the indicated row
  9288. @param row
  9289. </member>
  9290. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsRowBroken(System.Int32)">
  9291. Queries if the specified row has a page break
  9292. @param row
  9293. @return true if the specified row has a page break
  9294. </member>
  9295. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.IsColumnBroken(System.Int32)">
  9296. Queries if the specified column has a page break
  9297. @return <c>true</c> if the specified column has a page break
  9298. </member>
  9299. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftRowBreaks(System.Int32,System.Int32,System.Int32)">
  9300. Shifts the horizontal page breaks for the indicated count
  9301. @param startingRow
  9302. @param endingRow
  9303. @param count
  9304. </member>
  9305. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ShiftColumnBreaks(System.Int16,System.Int16,System.Int16)">
  9306. Shifts the vertical page breaks for the indicated count
  9307. @param startingCol
  9308. @param endingCol
  9309. @param count
  9310. </member>
  9311. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.RowBreaks">
  9312. @return all the horizontal page breaks, never <c>null</c>
  9313. </member>
  9314. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumRowBreaks">
  9315. @return the number of row page breaks
  9316. </member>
  9317. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.ColumnBreaks">
  9318. @return all the column page breaks, never <c>null</c>
  9319. </member>
  9320. <member name="P:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.NumColumnBreaks">
  9321. @return the number of column page breaks
  9322. </member>
  9323. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateHeaderFooter(NPOI.HSSF.Record.HeaderFooterRecord)">
  9324. <summary>
  9325. HEADERFOOTER is new in 2007. Some apps seem to have scattered this record long after
  9326. the PageSettingsBlock where it belongs.
  9327. </summary>
  9328. <param name="rec"></param>
  9329. </member>
  9330. <member name="M:NPOI.HSSF.Record.Aggregates.PageSettingsBlock.AddLateRecords(NPOI.HSSF.Model.RecordStream)">
  9331. <summary>
  9332. This method reads PageSettingsBlock records from the supplied RecordStream until the first non-PageSettingsBlock record is encountered.
  9333. As each record is read, it is incorporated into this PageSettingsBlock.
  9334. </summary>
  9335. <param name="rs"></param>
  9336. </member>
  9337. <member name="F:NPOI.HSSF.Record.Aggregates.PLSAggregate._plsContinues">
  9338. holds any continue records found after the PLS record.<br/>
  9339. This would not be required if PLS was properly interpreted.
  9340. Currently, PLS is an {@link UnknownRecord} and does not automatically
  9341. include any trailing {@link ContinueRecord}s.
  9342. </member>
  9343. <member name="M:NPOI.HSSF.Record.Aggregates.RecordVisitor.VisitRecord(NPOI.HSSF.Record.Record)">
  9344. Implementors may call non-mutating methods on Record r.
  9345. @param r must not be <c>null</c>
  9346. </member>
  9347. <member name="T:NPOI.HSSF.Record.Aggregates.RecordAggregate">
  9348. <c>RecordAggregate</c>s are groups of of BIFF <c>Record</c>s that are typically stored
  9349. together and/or updated together. Workbook / Sheet records are typically stored in a sequential
  9350. list, which does not provide much structure to coordinate updates.
  9351. @author Josh Micich
  9352. </member>
  9353. <member name="M:NPOI.HSSF.Record.Aggregates.RecordAggregate.VisitContainedRecords(NPOI.HSSF.Record.Aggregates.RecordVisitor)">
  9354. Visit each of the atomic BIFF records contained in this {@link RecordAggregate} in the order
  9355. that they should be written to file. Implementors may or may not return the actual
  9356. {@link Record}s being used to manage POI's internal implementation. Callers should not
  9357. assume either way, and therefore only attempt to modify those {@link Record}s after cloning
  9358. </member>
  9359. <member name="T:NPOI.HSSF.Record.Aggregates.PositionTrackingVisitor">
  9360. A wrapper for {@link RecordVisitor} which accumulates the sizes of all
  9361. records visited.
  9362. </member>
  9363. <member name="T:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate">
  9364. @author andy
  9365. @author Jason Height (jheight at chariot dot net dot au)
  9366. </member>
  9367. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor">
  9368. Creates a new instance of ValueRecordsAggregate
  9369. </member>
  9370. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.#ctor(NPOI.HSSF.Model.RecordStream,NPOI.HSSF.Record.Aggregates.SharedValueManager)">
  9371. @param rs record stream with all {@link SharedFormulaRecord}
  9372. {@link ArrayRecord}, {@link TableRecord} {@link MergeCellsRecord} Records removed
  9373. </member>
  9374. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.AddUnknownRecord(NPOI.HSSF.Record.Record)">
  9375. Handles UnknownRecords which appear within the row/cell records
  9376. </member>
  9377. <member name="P:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.RowBlockCount">
  9378. Returns the number of row blocks.
  9379. <p/>The row blocks are goupings of rows that contain the DBCell record
  9380. after them
  9381. </member>
  9382. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetRowCountForBlock(System.Int32)">
  9383. Returns the number of physical rows within a block
  9384. </member>
  9385. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetStartRowNumberForBlock(System.Int32)">
  9386. Returns the physical row number of the first row in a block
  9387. </member>
  9388. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.GetEndRowNumberForBlock(System.Int32)">
  9389. Returns the physical row number of the end row in a block
  9390. </member>
  9391. <member name="M:NPOI.HSSF.Record.Aggregates.RowRecordsAggregate.CreateRow(System.Int32)">
  9392. Create a row record.
  9393. @param row number
  9394. @return RowRecord Created for the passed in row number
  9395. @see org.apache.poi.hssf.record.RowRecord
  9396. </member>
  9397. <member name="T:NPOI.HSSF.Record.Aggregates.SharedValueManager">
  9398. <summary>
  9399. Manages various auxiliary records while constructing a RowRecordsAggregate
  9400. @author Josh Micich
  9401. </summary>
  9402. </member>
  9403. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup._firstCell">
  9404. Coordinates of the first cell having a formula that uses this shared formula.
  9405. This is often <i>but not always</i> the top left cell in the range covered by
  9406. {@link #_sfr}
  9407. </member>
  9408. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.SharedFormulaGroup.IsFirstCell(System.Int32,System.Int32)">
  9409. Note - the 'first cell' of a shared formula group is not always the top-left cell
  9410. of the enclosing range.
  9411. @return <c>true</c> if the specified coordinates correspond to the 'first cell'
  9412. of this shared formula group.
  9413. </member>
  9414. <member name="F:NPOI.HSSF.Record.Aggregates.SharedValueManager._groupsCache">
  9415. cached for optimization purposes
  9416. </member>
  9417. <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})">
  9418. @param firstCells
  9419. @param recs list of sheet records (possibly Contains records for other parts of the Excel file)
  9420. @param startIx index of first row/cell record for current sheet
  9421. @param endIx one past index of last row/cell record for current sheet. It is important
  9422. that this code does not inadvertently collect <c>SharedFormulaRecord</c>s from any other
  9423. sheet (which could happen if endIx is chosen poorly). (see bug 44449)
  9424. </member>
  9425. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.LinkSharedFormulaRecord(NPOI.SS.Util.CellReference,NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  9426. @param firstCell as extracted from the {@link ExpPtg} from the cell's formula.
  9427. @return never <code>null</code>
  9428. </member>
  9429. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetRecordForFirstCell(NPOI.HSSF.Record.Aggregates.FormulaRecordAggregate)">
  9430. Gets the {@link SharedValueRecordBase} record if it should be encoded immediately after the
  9431. formula record Contained in the specified {@link FormulaRecordAggregate} agg. Note - the
  9432. shared value record always appears after the first formula record in the group. For arrays
  9433. and tables the first formula is always the in the top left cell. However, since shared
  9434. formula groups can be sparse and/or overlap, the first formula may not actually be in the
  9435. top left cell.
  9436. @return the SHRFMLA, TABLE or ARRAY record for the formula cell, if it is the first cell of
  9437. a table or array region. <code>null</code> if the formula cell is not shared/array/table,
  9438. or if the specified formula is not the the first in the group.
  9439. </member>
  9440. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.Unlink(NPOI.HSSF.Record.SharedFormulaRecord)">
  9441. Converts all {@link FormulaRecord}s handled by <c>sharedFormulaRecord</c>
  9442. to plain unshared formulas
  9443. </member>
  9444. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.AddArrayRecord(NPOI.HSSF.Record.ArrayRecord)">
  9445. Add specified Array Record.
  9446. </member>
  9447. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.RemoveArrayFormula(System.Int32,System.Int32)">
  9448. Removes the {@link ArrayRecord} for the cell group containing the specified cell.
  9449. The caller should clear (set blank) all cells in the returned range.
  9450. @return the range of the array formula which was just removed. Never <code>null</code>.
  9451. </member>
  9452. <member name="M:NPOI.HSSF.Record.Aggregates.SharedValueManager.GetArrayRecord(System.Int32,System.Int32)">
  9453. @return the shared ArrayRecord identified by (firstRow, firstColumn). never <code>null</code>.
  9454. </member>
  9455. <member name="T:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate">
  9456. Aggregate value records toGether. Things are easier to handle that way.
  9457. @author andy
  9458. @author Glen Stampoultzis (glens at apache.org)
  9459. @author Jason Height (jheight at chariot dot net dot au)
  9460. </member>
  9461. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.#ctor">
  9462. Creates a new instance of ValueRecordsAggregate
  9463. </member>
  9464. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.HandleMissingSharedFormulaRecord(NPOI.HSSF.Record.FormulaRecord)">
  9465. Sometimes the shared formula flag "seems" to be erroneously Set, in which case there is no
  9466. call to <c>SharedFormulaRecord.ConvertSharedFormulaRecord</c> and hence the
  9467. <c>ParsedExpression</c> field of this <c>FormulaRecord</c> will not Get updated.<br/>
  9468. As it turns out, this is not a problem, because in these circumstances, the existing value
  9469. for <c>ParsedExpression</c> is perfectly OK.<p/>
  9470. This method may also be used for Setting breakpoints to help diagnose Issues regarding the
  9471. abnormally-Set 'shared formula' flags.
  9472. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).<p/>
  9473. The method currently does nothing but do not delete it without Finding a nice home for this
  9474. comment.
  9475. </member>
  9476. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.GetRowCellBlockSize(System.Int32,System.Int32)">
  9477. Tallies a count of the size of the cell records
  9478. that are attached to the rows in the range specified.
  9479. </member>
  9480. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.RowHasCells(System.Int32)">
  9481. Returns true if the row has cells attached to it
  9482. </member>
  9483. <member name="M:NPOI.HSSF.Record.Aggregates.ValueRecordsAggregate.SerializeCellRow(System.Int32,System.Int32,System.Byte[])">
  9484. Serializes the cells that are allocated to a certain row range
  9485. </member>
  9486. <member name="T:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock">
  9487. Groups the sheet protection records for a worksheet.
  9488. <p/>
  9489. See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook
  9490. (BIFF5-BIFF8)'
  9491. @author Josh Micich
  9492. </member>
  9493. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.#ctor">
  9494. Creates an empty WorksheetProtectionBlock
  9495. </member>
  9496. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.IsComponentRecord(System.Int32)">
  9497. @return <c>true</c> if the specified Record sid is one belonging to
  9498. the 'Page Settings Block'.
  9499. </member>
  9500. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.AddRecords(NPOI.HSSF.Model.RecordStream)">
  9501. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream
  9502. until the first non-WorksheetProtectionBlock record is encountered. As each record is Read,
  9503. it is incorporated into this WorksheetProtectionBlock.
  9504. <p/>
  9505. As per the OOO documentation, the protection block records can be expected to be written
  9506. toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009)
  9507. didn't do this. Workbooks with sheet protection Created by those earlier POI versions
  9508. seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files
  9509. with non continuous worksheet protection blocks.
  9510. <p/>
  9511. <b>Note</b> - when POI Writes out this WorksheetProtectionBlock, the records will always be
  9512. written in one consolidated block (in the standard ordering) regardless of how scattered the
  9513. records were when they were originally Read.
  9514. </member>
  9515. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Protect">
  9516. <summary>
  9517. the ProtectRecord. If one is not contained in the sheet, then one is created.
  9518. </summary>
  9519. </member>
  9520. <member name="P:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.Password">
  9521. <summary>
  9522. the PasswordRecord. If one is not Contained in the sheet, then one is Created.
  9523. </summary>
  9524. </member>
  9525. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.ProtectSheet(System.String,System.Boolean,System.Boolean)">
  9526. <summary>
  9527. protect a spreadsheet with a password (not encrypted, just sets protect flags and the password.)
  9528. </summary>
  9529. <param name="password">password to set;Pass <code>null</code> to remove all protection</param>
  9530. <param name="shouldProtectObjects">shouldProtectObjects are protected</param>
  9531. <param name="shouldProtectScenarios">shouldProtectScenarios are protected</param>
  9532. </member>
  9533. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateObjectProtect">
  9534. <summary>
  9535. Creates an ObjectProtect record with protect set to false.
  9536. </summary>
  9537. <returns></returns>
  9538. </member>
  9539. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreateScenarioProtect">
  9540. <summary>
  9541. Creates a ScenarioProtect record with protect set to false.
  9542. </summary>
  9543. <returns></returns>
  9544. </member>
  9545. <member name="M:NPOI.HSSF.Record.Aggregates.WorksheetProtectionBlock.CreatePassword">
  9546. <summary>
  9547. Creates a Password record with password set to 0x0000.
  9548. </summary>
  9549. <returns></returns>
  9550. </member>
  9551. <member name="T:NPOI.HSSF.Record.ArrayRecord">
  9552. ARRAY (0x0221)<p/>
  9553. Treated in a similar way to SharedFormulaRecord
  9554. @author Josh Micich
  9555. </member>
  9556. <member name="T:NPOI.HSSF.Record.AutoFilter.DOPERRecord">
  9557. <summary>
  9558. DOPER Structure for AutoFilter record
  9559. </summary>
  9560. <remarks>author: Tony Qu</remarks>
  9561. </member>
  9562. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.RK">
  9563. <summary>
  9564. get or set the RK record
  9565. </summary>
  9566. </member>
  9567. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.LengthOfString">
  9568. <summary>
  9569. Gets or sets Length of the string (the string is stored in the rgch field that follows the DOPER structures)
  9570. </summary>
  9571. </member>
  9572. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsBooleanValue">
  9573. <summary>
  9574. Whether the bBoolErr field contains a Boolean value
  9575. </summary>
  9576. </member>
  9577. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.IsErrorValue">
  9578. <summary>
  9579. Whether the bBoolErr field contains a Error value
  9580. </summary>
  9581. </member>
  9582. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.BooleanValue">
  9583. <summary>
  9584. Get or sets the boolean value
  9585. </summary>
  9586. </member>
  9587. <member name="P:NPOI.HSSF.Record.AutoFilter.DOPERRecord.ErrorValue">
  9588. <summary>
  9589. Get or sets the boolean value
  9590. </summary>
  9591. </member>
  9592. <member name="T:NPOI.HSSF.Record.BackupRecord">
  9593. Title: Backup Record
  9594. Description: bool specifying whether
  9595. the GUI should store a backup of the file.
  9596. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9597. @author Andrew C. Oliver (acoliver at apache dot org)
  9598. @version 2.0-pre
  9599. </member>
  9600. <member name="M:NPOI.HSSF.Record.BackupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9601. Constructs a BackupRecord and Sets its fields appropriately
  9602. @param in the RecordInputstream to Read the record from
  9603. </member>
  9604. <member name="P:NPOI.HSSF.Record.BackupRecord.Backup">
  9605. Get the backup flag
  9606. @return short 0/1 (off/on)
  9607. </member>
  9608. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadRecordSID">
  9609. Read an unsigned short from the stream without decrypting
  9610. </member>
  9611. <member name="M:NPOI.HSSF.Record.BiffHeaderInput.ReadDataSize">
  9612. Read an unsigned short from the stream without decrypting
  9613. </member>
  9614. <member name="T:NPOI.HSSF.Record.BlankRecord">
  9615. Title: Blank cell record
  9616. Description: Represents a column in a row with no value but with styling.
  9617. REFERENCE: PG 287 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9618. @author Andrew C. Oliver (acoliver at apache dot org)
  9619. @author Jason Height (jheight at chariot dot net dot au)
  9620. @version 2.0-pre
  9621. </member>
  9622. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor">
  9623. Creates a new instance of BlankRecord
  9624. </member>
  9625. <member name="M:NPOI.HSSF.Record.BlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9626. Constructs a BlankRecord and Sets its fields appropriately
  9627. @param in the RecordInputstream to Read the record from
  9628. </member>
  9629. <member name="P:NPOI.HSSF.Record.BlankRecord.Row">
  9630. Get the row this cell occurs on
  9631. @return the row
  9632. </member>
  9633. <member name="P:NPOI.HSSF.Record.BlankRecord.Column">
  9634. Get the column this cell defines within the row
  9635. @return the column
  9636. </member>
  9637. <member name="P:NPOI.HSSF.Record.BlankRecord.XFIndex">
  9638. Set the index of the extended format record to style this cell with
  9639. @param xf - the 0-based index of the extended format
  9640. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  9641. </member>
  9642. <member name="P:NPOI.HSSF.Record.BlankRecord.Sid">
  9643. return the non static version of the id for this record.
  9644. </member>
  9645. <member name="M:NPOI.HSSF.Record.BlankRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9646. called by the class that is responsible for writing this sucker.
  9647. Subclasses should implement this so that their data is passed back in a
  9648. byte array.
  9649. @return byte array containing instance data
  9650. </member>
  9651. <member name="T:NPOI.HSSF.Record.BOFRecord">
  9652. Title: Beginning Of File
  9653. Description: Somewhat of a misnomer, its used for the beginning of a Set of
  9654. records that have a particular pupose or subject.
  9655. Used in sheets and workbooks.
  9656. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9657. @author Andrew C. Oliver
  9658. @author Jason Height (jheight at chariot dot net dot au)
  9659. @version 2.0-pre
  9660. </member>
  9661. <member name="F:NPOI.HSSF.Record.BOFRecord.sid">
  9662. for BIFF8 files the BOF is 0x809. For earlier versions see
  9663. {@link #biff2_sid} {@link #biff3_sid} {@link #biff4_sid}
  9664. {@link #biff5_sid}
  9665. </member>
  9666. <member name="F:NPOI.HSSF.Record.BOFRecord.VERSION">
  9667. suggested default (0x06 - BIFF8)
  9668. </member>
  9669. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD">
  9670. suggested default 0x10d3
  9671. </member>
  9672. <member name="F:NPOI.HSSF.Record.BOFRecord.BUILD_YEAR">
  9673. suggested default 0x07CC (1996)
  9674. </member>
  9675. <member name="F:NPOI.HSSF.Record.BOFRecord.HISTORY_MASK">
  9676. suggested default for a normal sheet (0x41)
  9677. </member>
  9678. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor">
  9679. Constructs an empty BOFRecord with no fields Set.
  9680. </member>
  9681. <member name="M:NPOI.HSSF.Record.BOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9682. Constructs a BOFRecord and Sets its fields appropriately
  9683. @param in the RecordInputstream to Read the record from
  9684. </member>
  9685. <member name="P:NPOI.HSSF.Record.BOFRecord.Version">
  9686. Version number - for BIFF8 should be 0x06
  9687. @see #VERSION
  9688. @param version version to be Set
  9689. </member>
  9690. <member name="P:NPOI.HSSF.Record.BOFRecord.HistoryBitMask">
  9691. Set the history bit mask (not very useful)
  9692. @see #HISTORY_MASK
  9693. @param bitmask bitmask to Set for the history
  9694. </member>
  9695. <member name="P:NPOI.HSSF.Record.BOFRecord.RequiredVersion">
  9696. Set the minimum version required to Read this file
  9697. @see #VERSION
  9698. @param version version to Set
  9699. </member>
  9700. <member name="P:NPOI.HSSF.Record.BOFRecord.Type">
  9701. type of object this marks
  9702. @see #TYPE_WORKBOOK
  9703. @see #TYPE_VB_MODULE
  9704. @see #TYPE_WORKSHEET
  9705. @see #TYPE_CHART
  9706. @see #TYPE_EXCEL_4_MACRO
  9707. @see #TYPE_WORKSPACE_FILE
  9708. @return short type of object
  9709. </member>
  9710. <member name="P:NPOI.HSSF.Record.BOFRecord.Build">
  9711. Get the build that wrote this file
  9712. @see #BUILD
  9713. @return short build number of the generator of this file
  9714. </member>
  9715. <member name="P:NPOI.HSSF.Record.BOFRecord.BuildYear">
  9716. Year of the build that wrote this file
  9717. @see #BUILD_YEAR
  9718. @return short build year of the generator of this file
  9719. </member>
  9720. <member name="T:NPOI.HSSF.Record.BookBoolRecord">
  9721. Title: Save External Links record (BookBool)
  9722. Description: Contains a flag specifying whether the Gui should save externally
  9723. linked values from other workbooks.
  9724. REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9725. @author Andrew C. Oliver (acoliver at apache dot org)
  9726. @version 2.0-pre
  9727. </member>
  9728. <member name="M:NPOI.HSSF.Record.BookBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9729. Constructs a BookBoolRecord and Sets its fields appropriately
  9730. @param in the RecordInputstream to Read the record from
  9731. </member>
  9732. <member name="P:NPOI.HSSF.Record.BookBoolRecord.SaveLinkValues">
  9733. Get the save ext links flag
  9734. @return short 0/1 (off/on)
  9735. </member>
  9736. <member name="T:NPOI.HSSF.Record.BoolErrRecord">
  9737. Creates new BoolErrRecord.
  9738. REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9739. @author Michael P. Harhen
  9740. @author Jason Height (jheight at chariot dot net dot au)
  9741. @version 2.0-pre
  9742. </member>
  9743. <member name="F:NPOI.HSSF.Record.BoolErrRecord._isError">
  9744. If <code>true</code>, this record represents an error cell value, otherwise this record represents a boolean cell value
  9745. </member>
  9746. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor">
  9747. Creates new BoolErrRecord
  9748. </member>
  9749. <member name="M:NPOI.HSSF.Record.BoolErrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9750. Constructs a BoolErr record and Sets its fields appropriately.
  9751. @param in the RecordInputstream to Read the record from
  9752. </member>
  9753. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Boolean)">
  9754. Set the bool value for the cell
  9755. @param value representing the bool value
  9756. </member>
  9757. <member name="M:NPOI.HSSF.Record.BoolErrRecord.SetValue(System.Byte)">
  9758. Set the error value for the cell
  9759. @param value error representing the error value
  9760. this value can only be 0,7,15,23,29,36 or 42
  9761. see bugzilla bug 16560 for an explanation
  9762. </member>
  9763. <member name="P:NPOI.HSSF.Record.BoolErrRecord.BooleanValue">
  9764. Get the value for the cell
  9765. @return bool representing the bool value
  9766. </member>
  9767. <member name="P:NPOI.HSSF.Record.BoolErrRecord.ErrorValue">
  9768. Get the error value for the cell
  9769. @return byte representing the error value
  9770. </member>
  9771. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsBoolean">
  9772. Indicates whether the call holds a boolean value
  9773. @return boolean true if the cell holds a boolean value
  9774. </member>
  9775. <member name="P:NPOI.HSSF.Record.BoolErrRecord.IsError">
  9776. Indicates whether the call holds an error value
  9777. @return bool true if the cell holds an error value
  9778. </member>
  9779. <member name="T:NPOI.HSSF.Record.BottomMarginRecord">
  9780. Record for the bottom margin.
  9781. NOTE: This source was automatically generated.
  9782. @author Shawn Laubach (slaubach at apache dot org)
  9783. </member>
  9784. <member name="M:NPOI.HSSF.Record.BottomMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9785. Constructs a BottomMargin record and Sets its fields appropriately.
  9786. @param in the RecordInputstream to Read the record from
  9787. </member>
  9788. <member name="P:NPOI.HSSF.Record.BottomMarginRecord.Margin">
  9789. Get the margin field for the BottomMargin record.
  9790. </member>
  9791. <member name="T:NPOI.HSSF.Record.BoundSheetRecord">
  9792. Title: Bound Sheet Record (aka BundleSheet)
  9793. Description: Defines a sheet within a workbook. Basically stores the sheetname
  9794. and tells where the Beginning of file record Is within the HSSF
  9795. file.
  9796. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9797. @author Andrew C. Oliver (acoliver at apache dot org)
  9798. @author Sergei Kozello (sergeikozello at mail.ru)
  9799. </member>
  9800. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9801. Constructs a BoundSheetRecord and Sets its fields appropriately
  9802. @param in the RecordInputstream to Read the record from
  9803. </member>
  9804. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.PositionOfBof">
  9805. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  9806. @return offset in bytes
  9807. </member>
  9808. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.IsVeryHidden">
  9809. Is the sheet very hidden? Different from (normal) hidden
  9810. </member>
  9811. <member name="P:NPOI.HSSF.Record.BoundSheetRecord.Sheetname">
  9812. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  9813. @return sheetname the name of the sheet
  9814. </member>
  9815. <member name="M:NPOI.HSSF.Record.BoundSheetRecord.OrderByBofPosition(System.Collections.Generic.List{NPOI.HSSF.Record.BoundSheetRecord})">
  9816. Converts a List of {@link BoundSheetRecord}s to an array and sorts by the position of their
  9817. BOFs.
  9818. </member>
  9819. <member name="T:NPOI.HSSF.Record.CalcCountRecord">
  9820. Title: Calc Count Record
  9821. Description: Specifies the maximum times the gui should perform a formula
  9822. recalculation. For instance: in the case a formula includes
  9823. cells that are themselves a result of a formula and a value
  9824. Changes. This Is essentially a failsafe against an infinate
  9825. loop in the event the formulas are not independant.
  9826. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9827. @author Andrew C. Oliver (acoliver at apache dot org)
  9828. @author Jason Height (jheight at chariot dot net dot au)
  9829. @version 2.0-pre
  9830. @see org.apache.poi.hssf.record.CalcModeRecord
  9831. </member>
  9832. <member name="M:NPOI.HSSF.Record.CalcCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9833. Constructs a CalcCountRecord and Sets its fields appropriately
  9834. @param in the RecordInputstream to Read the record from
  9835. </member>
  9836. <member name="P:NPOI.HSSF.Record.CalcCountRecord.Iterations">
  9837. Get the number of iterations to perform
  9838. @return iterations
  9839. </member>
  9840. <member name="T:NPOI.HSSF.Record.CalcModeRecord">
  9841. Title: Calc Mode Record
  9842. Description: Tells the gui whether to calculate formulas
  9843. automatically, manually or automatically
  9844. except for tables.
  9845. REFERENCE: PG 292 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  9846. @author Andrew C. Oliver (acoliver at apache dot org)
  9847. @author Jason Height (jheight at chariot dot net dot au)
  9848. @version 2.0-pre
  9849. @see org.apache.poi.hssf.record.CalcCountRecord
  9850. </member>
  9851. <member name="F:NPOI.HSSF.Record.CalcModeRecord.MANUAL">
  9852. manually calculate formulas (0)
  9853. </member>
  9854. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC">
  9855. automatically calculate formulas (1)
  9856. </member>
  9857. <member name="F:NPOI.HSSF.Record.CalcModeRecord.AUTOMATIC_EXCEPT_TABLES">
  9858. automatically calculate formulas except for tables (-1)
  9859. </member>
  9860. <member name="M:NPOI.HSSF.Record.CalcModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9861. Constructs a CalcModeRecord and Sets its fields appropriately
  9862. @param in the RecordInputstream to Read the record from
  9863. </member>
  9864. <member name="M:NPOI.HSSF.Record.CalcModeRecord.SetCalcMode(System.Int16)">
  9865. Set the calc mode flag for formulas
  9866. @see #MANUAL
  9867. @see #AUTOMATIC
  9868. @see #AUTOMATIC_EXCEPT_TABLES
  9869. @param calcmode one of the three flags above
  9870. </member>
  9871. <member name="M:NPOI.HSSF.Record.CalcModeRecord.GetCalcMode">
  9872. Get the calc mode flag for formulas
  9873. @see #MANUAL
  9874. @see #AUTOMATIC
  9875. @see #AUTOMATIC_EXCEPT_TABLES
  9876. @return calcmode one of the three flags above
  9877. </member>
  9878. <member name="P:NPOI.HSSF.Record.CellRecord.XFIndex">
  9879. get the index to the ExtendedFormat
  9880. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  9881. @return index to the XF record
  9882. </member>
  9883. <member name="M:NPOI.HSSF.Record.CellRecord.AppendValueText(System.Text.StringBuilder)">
  9884. Append specific debug info (used by {@link #toString()} for the value
  9885. contained in this record. Trailing new-line should not be Appended
  9886. (superclass does that).
  9887. </member>
  9888. <member name="P:NPOI.HSSF.Record.CellRecord.RecordName">
  9889. Gets the debug info BIFF record type name (used by {@link #toString()}.
  9890. </member>
  9891. <member name="M:NPOI.HSSF.Record.CellRecord.SerializeValue(NPOI.Util.ILittleEndianOutput)">
  9892. writes out the value data for this cell record
  9893. </member>
  9894. <member name="P:NPOI.HSSF.Record.CellRecord.ValueDataSize">
  9895. @return the size (in bytes) of the value data for this cell record
  9896. </member>
  9897. <member name="T:NPOI.HSSF.Record.CellValueRecordInterface">
  9898. The cell value record interface Is implemented by all classes of type Record that
  9899. contain cell values. It allows the containing sheet to move through them and Compare
  9900. them.
  9901. @author Andrew C. Oliver (acoliver at apache dot org)
  9902. @author Jason Height (jheight at chariot dot net dot au)
  9903. @see org.apache.poi.hssf.model.Sheet
  9904. @see org.apache.poi.hssf.record.Record
  9905. @see org.apache.poi.hssf.record.RecordFactory
  9906. </member>
  9907. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Row">
  9908. Get the row this cell occurs on
  9909. @return the row
  9910. </member>
  9911. <member name="P:NPOI.HSSF.Record.CellValueRecordInterface.Column">
  9912. Get the column this cell defines within the row
  9913. @return the column
  9914. </member>
  9915. <member name="T:NPOI.HSSF.Record.CFHeaderRecord">
  9916. Conditional Formatting Header record (CFHEADER)
  9917. @author Dmitriy Kumshayev
  9918. </member>
  9919. <member name="M:NPOI.HSSF.Record.CFHeaderRecord.#ctor">
  9920. Creates new CFHeaderRecord
  9921. </member>
  9922. <member name="T:NPOI.HSSF.Record.CFRuleRecord">
  9923. Conditional Formatting Rule Record.
  9924. @author Dmitriy Kumshayev
  9925. </member>
  9926. <member name="M:NPOI.HSSF.Record.CFRuleRecord.#ctor(System.Byte,NPOI.SS.UserModel.ComparisonOperator)">
  9927. Creates new CFRuleRecord
  9928. </member>
  9929. <member name="P:NPOI.HSSF.Record.CFRuleRecord.ParsedExpression1">
  9930. get the stack of the 1st expression as a list
  9931. @return list of tokens (casts stack to a list and returns it!)
  9932. this method can return null is we are unable to create Ptgs from
  9933. existing excel file
  9934. callers should check for null!
  9935. </member>
  9936. <member name="P:NPOI.HSSF.Record.CFRuleRecord.ParsedExpression2">
  9937. get the stack of the 2nd expression as a list
  9938. @return list of tokens (casts stack to a list and returns it!)
  9939. this method can return null is we are unable to create Ptgs from
  9940. existing excel file
  9941. callers should check for null!
  9942. </member>
  9943. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFWorkbook,System.String)">
  9944. Creates a new comparison operation rule
  9945. </member>
  9946. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  9947. Creates a new comparison operation rule
  9948. </member>
  9949. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Create(NPOI.HSSF.UserModel.HSSFSheet,System.Byte,System.String,System.String)">
  9950. Creates a new comparison operation rule
  9951. </member>
  9952. <member name="P:NPOI.HSSF.Record.CFRuleRecord.Options">
  9953. Get the option flags
  9954. @return bit mask
  9955. </member>
  9956. <member name="M:NPOI.HSSF.Record.CFRuleRecord.GetFormulaSize(NPOI.SS.Formula.Formula)">
  9957. @param ptgs may be <c>null</c>
  9958. @return encoded size of the formula
  9959. </member>
  9960. <member name="M:NPOI.HSSF.Record.CFRuleRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  9961. called by the class that Is responsible for writing this sucker.
  9962. Subclasses should implement this so that their data Is passed back in a
  9963. byte array.
  9964. @param offset to begin writing at
  9965. @param data byte array containing instance data
  9966. @return number of bytes written
  9967. </member>
  9968. <member name="M:NPOI.HSSF.Record.CFRuleRecord.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFWorkbook)">
  9969. TODO - Parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea
  9970. this call will produce the wrong results if the formula Contains any cell references
  9971. One approach might be to apply the inverse of SharedFormulaRecord.ConvertSharedFormulas(Stack, int, int)
  9972. Note - two extra parameters (rowIx &amp;colIx) will be required. They probably come from one of the Region objects.
  9973. @return <c>null</c> if <c>formula</c> was null.
  9974. </member>
  9975. <member name="M:NPOI.HSSF.Record.CFRuleRecord.ParseFormula(System.String,NPOI.HSSF.UserModel.HSSFSheet)">
  9976. TODO - parse conditional format formulas properly i.e. produce tRefN and tAreaN instead of tRef and tArea
  9977. this call will produce the wrong results if the formula contains any cell references
  9978. One approach might be to apply the inverse of SharedFormulaRecord.convertSharedFormulas(Stack, int, int)
  9979. Note - two extra parameters (rowIx &amp; colIx) will be required. They probably come from one of the Region objects.
  9980. @return <code>null</code> if <c>formula</c> was null.
  9981. </member>
  9982. <member name="T:NPOI.HSSF.Record.CF.BorderFormatting">
  9983. Border Formatting Block of the Conditional Formatting Rule Record.
  9984. @author Dmitriy Kumshayev
  9985. </member>
  9986. <member name="M:NPOI.HSSF.Record.CF.BorderFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  9987. Creates new FontFormatting
  9988. </member>
  9989. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderLeft">
  9990. <summary>
  9991. Get the type of border to use for the left border of the cell
  9992. </summary>
  9993. </member>
  9994. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderRight">
  9995. <summary>
  9996. Get the type of border to use for the right border of the cell
  9997. </summary>
  9998. </member>
  9999. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderTop">
  10000. <summary>
  10001. Get the type of border to use for the top border of the cell
  10002. </summary>
  10003. </member>
  10004. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderBottom">
  10005. <summary>
  10006. Get the type of border to use for the bottom border of the cell
  10007. </summary>
  10008. </member>
  10009. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BorderDiagonal">
  10010. <summary>
  10011. Get the type of border to use for the diagonal border of the cell
  10012. </summary>
  10013. </member>
  10014. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.LeftBorderColor">
  10015. <summary>
  10016. Get the color to use for the left border
  10017. </summary>
  10018. </member>
  10019. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.RightBorderColor">
  10020. <summary>
  10021. Get the color to use for the right border
  10022. </summary>
  10023. </member>
  10024. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.TopBorderColor">
  10025. <summary>
  10026. Get the color to use for the top border
  10027. </summary>
  10028. </member>
  10029. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.BottomBorderColor">
  10030. <summary>
  10031. Get the color to use for the bottom border
  10032. </summary>
  10033. </member>
  10034. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.DiagonalBorderColor">
  10035. <summary>
  10036. Get the color to use for the diagonal border
  10037. </summary>
  10038. </member>
  10039. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsForwardDiagonalOn">
  10040. <summary>
  10041. true if forward diagonal is on
  10042. </summary>
  10043. </member>
  10044. <member name="P:NPOI.HSSF.Record.CF.BorderFormatting.IsBackwardDiagonalOn">
  10045. <summary>
  10046. true if backward diagonal Is on
  10047. </summary>
  10048. </member>
  10049. <member name="T:NPOI.HSSF.Record.CF.CellRangeUtil">
  10050. @author Dmitriy Kumshayev
  10051. </member>
  10052. <member name="F:NPOI.HSSF.Record.CF.CellRangeUtil.INSIDE">
  10053. first range is within the second range
  10054. </member>
  10055. <member name="F:NPOI.HSSF.Record.CF.CellRangeUtil.ENCLOSES">
  10056. first range encloses or is equal to the second
  10057. </member>
  10058. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.Intersect(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  10059. Intersect this range with the specified range.
  10060. @param crB - the specified range
  10061. @return code which reflects how the specified range is related to this range.<br/>
  10062. Possible return codes are:
  10063. NO_INTERSECTION - the specified range is outside of this range;<br/>
  10064. OVERLAP - both ranges partially overlap;<br/>
  10065. INSIDE - the specified range is inside of this one<br/>
  10066. ENCLOSES - the specified range encloses (possibly exactly the same as) this range<br/>
  10067. </member>
  10068. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.MergeCellRanges(NPOI.SS.Util.CellRangeAddress[])">
  10069. Do all possible cell merges between cells of the list so that:
  10070. if a cell range is completely inside of another cell range, it s removed from the list
  10071. if two cells have a shared border, merge them into one bigger cell range
  10072. @param cellRangeList
  10073. @return updated List of cell ranges
  10074. </member>
  10075. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.MergeRanges(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  10076. @return the new range(s) to replace the supplied ones. <c>null</c> if no merge is possible
  10077. </member>
  10078. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.ToArray(System.Collections.ArrayList)">
  10079. **
  10080. </member>
  10081. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.Contains(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  10082. Check if the specified range is located inside of this cell range.
  10083. @param crB
  10084. @return true if this cell range Contains the argument range inside if it's area
  10085. </member>
  10086. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.HasExactSharedBorder(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  10087. Check if the specified cell range has a shared border with the current range.
  10088. @return <c>true</c> if the ranges have a complete shared border (i.e.
  10089. the two ranges toher make a simple rectangular region.
  10090. </member>
  10091. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.CreateEnclosingCellRange(NPOI.SS.Util.CellRangeAddress,NPOI.SS.Util.CellRangeAddress)">
  10092. Create an enclosing CellRange for the two cell ranges.
  10093. @return enclosing CellRange
  10094. </member>
  10095. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.lt(System.Int32,System.Int32)">
  10096. @return true if a &lt; b
  10097. </member>
  10098. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.le(System.Int32,System.Int32)">
  10099. @return true if a &lt;= b
  10100. </member>
  10101. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.gt(System.Int32,System.Int32)">
  10102. @return true if a > b
  10103. </member>
  10104. <member name="M:NPOI.HSSF.Record.CF.CellRangeUtil.ge(System.Int32,System.Int32)">
  10105. @return true if a >= b
  10106. </member>
  10107. <member name="T:NPOI.HSSF.Record.CF.FontFormatting">
  10108. Font Formatting Block of the Conditional Formatting Rule Record.
  10109. @author Dmitriy Kumshayev
  10110. </member>
  10111. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_NORMAL">
  10112. Normal boldness (not bold)
  10113. </member>
  10114. <member name="F:NPOI.HSSF.Record.CF.FontFormatting.FONT_WEIGHT_BOLD">
  10115. Bold boldness (bold)
  10116. </member>
  10117. <member name="M:NPOI.HSSF.Record.CF.FontFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10118. Creates new FontFormatting
  10119. </member>
  10120. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontHeight">
  10121. Gets the height of the font in 1/20th point Units
  10122. @return fontheight (in points/20); or -1 if not modified
  10123. </member>
  10124. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsItalic">
  10125. Get whether the font Is to be italics or not
  10126. @return italics - whether the font Is italics or not
  10127. @see #GetAttributes()
  10128. </member>
  10129. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsStruckout">
  10130. Get whether the font Is to be stricken out or not
  10131. @return strike - whether the font Is stricken out or not
  10132. @see #GetAttributes()
  10133. </member>
  10134. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.FontWeight">
  10135. <summary>
  10136. Get or set the font weight for this font (100-1000dec or 0x64-0x3e8).
  10137. Default Is 0x190 for normal and 0x2bc for bold
  10138. </summary>
  10139. </member>
  10140. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.IsBold">
  10141. <summary>
  10142. Get or set whether the font weight is set to bold or not
  10143. </summary>
  10144. </member>
  10145. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.EscapementType">
  10146. Get the type of base or subscript for the font
  10147. @return base or subscript option
  10148. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_NONE
  10149. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUPER
  10150. @see org.apache.poi.hssf.usermodel.HSSFFontFormatting#SS_SUB
  10151. </member>
  10152. <member name="P:NPOI.HSSF.Record.CF.FontFormatting.UnderlineType">
  10153. Get the type of Underlining for the font
  10154. @return font Underlining type
  10155. </member>
  10156. <member name="T:NPOI.HSSF.Record.CF.PatternFormatting">
  10157. Pattern Formatting Block of the Conditional Formatting Rule Record.
  10158. @author Dmitriy Kumshayev
  10159. </member>
  10160. <member name="M:NPOI.HSSF.Record.CF.PatternFormatting.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10161. Creates new FontFormatting
  10162. </member>
  10163. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillPattern">
  10164. Get the Fill pattern
  10165. @return Fill pattern
  10166. </member>
  10167. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillBackgroundColor">
  10168. Get the background Fill color
  10169. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  10170. @return Fill color
  10171. </member>
  10172. <member name="P:NPOI.HSSF.Record.CF.PatternFormatting.FillForegroundColor">
  10173. Get the foreground Fill color
  10174. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  10175. @return Fill color
  10176. </member>
  10177. <member name="T:NPOI.HSSF.Record.Chart.AlRunsRecord">
  10178. <summary>
  10179. The AlRuns record specifies Rich Text Formatting within chart
  10180. titles (section 2.2.3.3), trendline (section 2.2.3.12), and
  10181. data labels (section 2.2.3.11).
  10182. </summary>
  10183. </member>
  10184. <member name="T:NPOI.HSSF.Record.Chart.AreaFormatRecord">
  10185. * The area format record is used to define the colours and patterns for an area.
  10186. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10187. * Remove the record in src/records/definitions.
  10188. * @author Glen Stampoultzis (glens at apache.org)
  10189. </member>
  10190. <member name="M:NPOI.HSSF.Record.Chart.AreaFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10191. Constructs a AreaFormat record and s its fields appropriately.
  10192. @param in the RecordInputstream to Read the record from
  10193. </member>
  10194. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.DataSize">
  10195. Size of record (exluding 4 byte header)
  10196. </member>
  10197. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForegroundColor">
  10198. the foreground color field for the AreaFormat record.
  10199. </member>
  10200. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackgroundColor">
  10201. the background color field for the AreaFormat record.
  10202. </member>
  10203. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.Pattern">
  10204. the pattern field for the AreaFormat record.
  10205. </member>
  10206. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.FormatFlags">
  10207. the format flags field for the AreaFormat record.
  10208. </member>
  10209. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.ForecolorIndex">
  10210. the forecolor index field for the AreaFormat record.
  10211. </member>
  10212. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.BackcolorIndex">
  10213. the backcolor index field for the AreaFormat record.
  10214. </member>
  10215. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsAutomatic">
  10216. automatic formatting
  10217. @return the automatic field value.
  10218. </member>
  10219. <member name="P:NPOI.HSSF.Record.Chart.AreaFormatRecord.IsInvert">
  10220. swap foreground and background colours when data is negative
  10221. @return the invert field value.
  10222. </member>
  10223. <member name="T:NPOI.HSSF.Record.Chart.AreaRecord">
  10224. * The area record is used to define a area chart.
  10225. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10226. * Remove the record in src/records/definitions.
  10227. * @author Glen Stampoultzis (glens at apache.org)
  10228. </member>
  10229. <member name="M:NPOI.HSSF.Record.Chart.AreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10230. Constructs a Area record and s its fields appropriately.
  10231. @param in the RecordInputstream to Read the record from
  10232. </member>
  10233. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.DataSize">
  10234. Size of record (exluding 4 byte header)
  10235. </member>
  10236. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.FormatFlags">
  10237. the format flags field for the Area record.
  10238. </member>
  10239. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsStacked">
  10240. series is stacked
  10241. @return the stacked field value.
  10242. </member>
  10243. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsDisplayAsPercentage">
  10244. results Displayed as percentages
  10245. @return the Display as percentage field value.
  10246. </member>
  10247. <member name="P:NPOI.HSSF.Record.Chart.AreaRecord.IsShadow">
  10248. Display a shadow for the chart
  10249. @return the shadow field value.
  10250. </member>
  10251. <member name="T:NPOI.HSSF.Record.Chart.AttachedLabelRecord">
  10252. * The series label record defines the type of label associated with the data format record.
  10253. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10254. * Remove the record in src/records/definitions.
  10255. * @author Glen Stampoultzis (glens at apache.org)
  10256. </member>
  10257. <member name="M:NPOI.HSSF.Record.Chart.AttachedLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10258. Constructs a SeriesLabels record and Sets its fields appropriately.
  10259. @param in the RecordInputstream to Read the record from
  10260. </member>
  10261. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.DataSize">
  10262. Size of record (exluding 4 byte header)
  10263. </member>
  10264. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.FormatFlags">
  10265. Get the format flags field for the SeriesLabels record.
  10266. </member>
  10267. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowActual">
  10268. show actual value of the data point
  10269. @return the show actual field value.
  10270. </member>
  10271. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowPercent">
  10272. show value as percentage of total (pie charts only)
  10273. @return the show percent field value.
  10274. </member>
  10275. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsLabelAsPercentage">
  10276. show category label/value as percentage (pie charts only)
  10277. @return the label as percentage field value.
  10278. </member>
  10279. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsSmoothedLine">
  10280. show smooth line
  10281. @return the smoothed line field value.
  10282. </member>
  10283. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowLabel">
  10284. Display category label
  10285. @return the show label field value.
  10286. </member>
  10287. <member name="P:NPOI.HSSF.Record.Chart.AttachedLabelRecord.IsShowBubbleSizes">
  10288. ??
  10289. @return the show bubble sizes field value.
  10290. </member>
  10291. <member name="T:NPOI.HSSF.Record.Chart.AxcExtRecord">
  10292. <summary>
  10293. The AxcExt record specifies additional extension properties of a date axis (section 2.2.3.6),
  10294. along with a CatSerRange record (section 2.4.39).
  10295. </summary>
  10296. </member>
  10297. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorInterval">
  10298. <summary>
  10299. specifies the interval at which the major tick marks are displayed on the axis (section 2.2.3.6),
  10300. in the unit defined by duMajor.
  10301. </summary>
  10302. </member>
  10303. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MajorUnit">
  10304. <summary>
  10305. 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).
  10306. If fDateAxis is set to 0, MUST be ignored.
  10307. </summary>
  10308. </member>
  10309. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.MinorInterval">
  10310. <summary>
  10311. specifies the interval at which the minor tick marks are displayed on the axis (section 2.2.3.6),
  10312. in a unit defined by duMinor.
  10313. </summary>
  10314. </member>
  10315. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.BaseUnit">
  10316. <summary>
  10317. specifies the smallest unit of time used by the axis (section 2.2.3.6).
  10318. </summary>
  10319. </member>
  10320. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.CrossDate">
  10321. <summary>
  10322. specifies at which date, as a date in the date system specified by the Date1904 record (section 2.4.77),
  10323. in the units defined by duBase, the value axis (section 2.2.3.6) crosses this axis (section 2.2.3.6).
  10324. </summary>
  10325. </member>
  10326. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMin">
  10327. <summary>
  10328. specifies whether MinimumDate is calculated automatically.
  10329. </summary>
  10330. </member>
  10331. <member name="P:NPOI.HSSF.Record.Chart.AxcExtRecord.IsAutoMax">
  10332. <summary>
  10333. specifies whether MaximumDate is calculated automatically.
  10334. </summary>
  10335. </member>
  10336. <member name="T:NPOI.HSSF.Record.Chart.AxesUsedRecord">
  10337. * The number of axes used on a chart.
  10338. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10339. * Remove the record in src/records/definitions.
  10340. * @author Glen Stampoultzis (glens at apache.org)
  10341. </member>
  10342. <member name="M:NPOI.HSSF.Record.Chart.AxesUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10343. Constructs a AxisUsed record and Sets its fields appropriately.
  10344. @param in the RecordInputstream to Read the record from
  10345. </member>
  10346. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.DataSize">
  10347. Size of record (exluding 4 byte header)
  10348. </member>
  10349. <member name="P:NPOI.HSSF.Record.Chart.AxesUsedRecord.NumAxis">
  10350. Get the num axis field for the AxisUsed record.
  10351. </member>
  10352. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.AxisLine">
  10353. <summary>
  10354. The axis (section 2.2.3.6) line itself.
  10355. </summary>
  10356. </member>
  10357. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MajorGridLine">
  10358. <summary>
  10359. The major gridlines along the axis
  10360. </summary>
  10361. </member>
  10362. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.MinorGridLine">
  10363. <summary>
  10364. The minor gridlines along the axis
  10365. </summary>
  10366. </member>
  10367. <member name="F:NPOI.HSSF.Record.Chart.AxisLineType.WallsOrFloorOf3D">
  10368. <summary>
  10369. The walls or floor of a 3-D chart
  10370. </summary>
  10371. </member>
  10372. <member name="T:NPOI.HSSF.Record.Chart.AxisLineFormatRecord">
  10373. <summary>
  10374. The AxisLine record specifies which part of the axis (section 2.2.3.6) is
  10375. specified by the LineFormat record (section 2.4.156) that follows.
  10376. Excel Binary File Format (.xls) Structure Specification
  10377. </summary>
  10378. </member>
  10379. <member name="M:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10380. Constructs a AxisLineFormat record and Sets its fields appropriately.
  10381. @param in the RecordInputstream to Read the record from
  10382. </member>
  10383. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.DataSize">
  10384. Size of record (exluding 4 byte header)
  10385. </member>
  10386. <member name="P:NPOI.HSSF.Record.Chart.AxisLineFormatRecord.AxisType">
  10387. <summary>
  10388. </summary>
  10389. </member>
  10390. <member name="T:NPOI.HSSF.Record.Chart.AxisParentRecord">
  10391. * The axis size and location
  10392. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10393. * Remove the record in src/records/definitions.
  10394. * @author Glen Stampoultzis (glens at apache.org)
  10395. </member>
  10396. <member name="M:NPOI.HSSF.Record.Chart.AxisParentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10397. Constructs a AxisParent record and s its fields appropriately.
  10398. @param in the RecordInputstream to Read the record from
  10399. </member>
  10400. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.DataSize">
  10401. Size of record (exluding 4 byte header)
  10402. </member>
  10403. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.AxisType">
  10404. the axis type field for the AxisParent record.
  10405. @return One of
  10406. AXIS_TYPE_MAIN
  10407. AXIS_TYPE_SECONDARY
  10408. </member>
  10409. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.X">
  10410. the x field for the AxisParent record.
  10411. </member>
  10412. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Y">
  10413. the y field for the AxisParent record.
  10414. </member>
  10415. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Width">
  10416. the width field for the AxisParent record.
  10417. </member>
  10418. <member name="P:NPOI.HSSF.Record.Chart.AxisParentRecord.Height">
  10419. the height field for the AxisParent record.
  10420. </member>
  10421. <member name="T:NPOI.HSSF.Record.Chart.AxisRecord">
  10422. * The axis record defines the type of an axis.
  10423. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10424. * Remove the record in src/records/definitions.
  10425. * @author Glen Stampoultzis (glens at apache.org)
  10426. </member>
  10427. <member name="M:NPOI.HSSF.Record.Chart.AxisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10428. Constructs a Axis record and Sets its fields appropriately.
  10429. @param in the RecordInputstream to Read the record from
  10430. </member>
  10431. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.DataSize">
  10432. Size of record (exluding 4 byte header)
  10433. </member>
  10434. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.AxisType">
  10435. Get the axis type field for the Axis record.
  10436. @return One of
  10437. AXIS_TYPE_CATEGORY_OR_X_AXIS
  10438. AXIS_TYPE_VALUE_AXIS
  10439. AXIS_TYPE_SERIES_AXIS
  10440. </member>
  10441. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved1">
  10442. Get the reserved1 field for the Axis record.
  10443. </member>
  10444. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved2">
  10445. Get the reserved2 field for the Axis record.
  10446. </member>
  10447. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved3">
  10448. Get the reserved3 field for the Axis record.
  10449. </member>
  10450. <member name="P:NPOI.HSSF.Record.Chart.AxisRecord.Reserved4">
  10451. Get the reserved4 field for the Axis record.
  10452. </member>
  10453. <member name="T:NPOI.HSSF.Record.Chart.AxisUsedRecord">
  10454. * The number of axes used on a chart.
  10455. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10456. * Remove the record in src/records/definitions.
  10457. * @author Glen Stampoultzis (glens at apache.org)
  10458. </member>
  10459. <member name="M:NPOI.HSSF.Record.Chart.AxisUsedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10460. Constructs a AxisUsed record and Sets its fields appropriately.
  10461. @param in the RecordInputstream to Read the record from
  10462. </member>
  10463. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.DataSize">
  10464. Size of record (exluding 4 byte header)
  10465. </member>
  10466. <member name="P:NPOI.HSSF.Record.Chart.AxisUsedRecord.NumAxis">
  10467. Get the num axis field for the AxisUsed record.
  10468. </member>
  10469. <member name="T:NPOI.HSSF.Record.Chart.BarRecord">
  10470. * The bar record is used to define a bar chart.
  10471. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10472. * Remove the record in src/records/definitions.
  10473. * @author Glen Stampoultzis (glens at apache.org)
  10474. </member>
  10475. <member name="M:NPOI.HSSF.Record.Chart.BarRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10476. Constructs a Bar record and s its fields appropriately.
  10477. @param in the RecordInputstream to Read the record from
  10478. </member>
  10479. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.DataSize">
  10480. Size of record (exluding 4 byte header)
  10481. </member>
  10482. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.BarSpace">
  10483. the bar space field for the Bar record.
  10484. </member>
  10485. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.CategorySpace">
  10486. the category space field for the Bar record.
  10487. </member>
  10488. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.FormatFlags">
  10489. the format flags field for the Bar record.
  10490. </member>
  10491. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsHorizontal">
  10492. true to Display horizontal bar charts, false for vertical
  10493. @return the horizontal field value.
  10494. </member>
  10495. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsStacked">
  10496. stack Displayed values
  10497. @return the stacked field value.
  10498. </member>
  10499. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsDisplayAsPercentage">
  10500. Display chart values as a percentage
  10501. @return the Display as percentage field value.
  10502. </member>
  10503. <member name="P:NPOI.HSSF.Record.Chart.BarRecord.IsShadow">
  10504. Display a shadow for the chart
  10505. @return the shadow field value.
  10506. </member>
  10507. <member name="T:NPOI.HSSF.Record.Chart.BeginRecord">
  10508. The begin record defines the start of a block of records for a (grpahing
  10509. data object. This record is matched with a corresponding EndRecord.
  10510. @see EndRecord
  10511. @author Glen Stampoultzis (glens at apache.org)
  10512. </member>
  10513. <member name="M:NPOI.HSSF.Record.Chart.BeginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10514. Constructs a BeginRecord record and Sets its fields appropriately.
  10515. @param in the RecordInputstream to Read the record from
  10516. </member>
  10517. <member name="T:NPOI.HSSF.Record.Chart.BopPopCustomRecord">
  10518. <summary>
  10519. The BopPopCustom record specifies which data points in the series are contained
  10520. in the secondary bar/pie instead of the primary pie. MUST follow a BopPop record
  10521. that has its split field set to Custom (0x0003).
  10522. </summary>
  10523. <remarks>
  10524. author: Antony liu (antony.apollo at gmail.com)
  10525. </remarks>
  10526. </member>
  10527. <member name="T:NPOI.HSSF.Record.Chart.BopPopRecord">
  10528. <summary>
  10529. The BopPop record specifies that the chart group is a bar of pie chart group or
  10530. a pie of pie chart group and specifies the chart group attributes.
  10531. </summary>
  10532. <remarks>
  10533. author: Antony liu (antony.apollo at gmail.com)
  10534. </remarks>
  10535. </member>
  10536. <member name="T:NPOI.HSSF.Record.Chart.BRAIRecord">
  10537. <summary>
  10538. The BRAI record specifies a reference to data in a sheet (1) that is used by a part of a series,
  10539. legend entry, trendline or error bars.
  10540. </summary>
  10541. </member>
  10542. <member name="F:NPOI.HSSF.Record.Chart.BRAIRecord.field_5_formulaOfLink">
  10543. <summary>
  10544. A ChartParsedFormula structure that specifies the formula (section 2.2.2) that specifies the reference.
  10545. </summary>
  10546. </member>
  10547. <member name="M:NPOI.HSSF.Record.Chart.BRAIRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10548. Constructs a LinkedData record and Sets its fields appropriately.
  10549. @param in the RecordInputstream to Read the record from
  10550. </member>
  10551. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.DataSize">
  10552. Size of record (exluding 4 byte header)
  10553. </member>
  10554. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.LinkType">
  10555. <summary>
  10556. specifies the part of the series, trendline, or error bars the referenced data specifies.
  10557. </summary>
  10558. </member>
  10559. <member name="P:NPOI.HSSF.Record.Chart.BRAIRecord.IndexNumberFmtRecord">
  10560. <summary>
  10561. specifies the number format to use for the data.
  10562. </summary>
  10563. </member>
  10564. <member name="T:NPOI.HSSF.Record.Chart.CatLabRecord">
  10565. CATLAB - Category Labels (0x0856)<br/>
  10566. @author Patrick Cheng
  10567. </member>
  10568. <member name="T:NPOI.HSSF.Record.Chart.CatSerRangeRecord">
  10569. <summary>
  10570. specifies the properties of a category (3) axis, a date axis, or a series axis.
  10571. </summary>
  10572. </member>
  10573. <member name="M:NPOI.HSSF.Record.Chart.CatSerRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10574. Constructs a CategorySeriesAxis record and Sets its fields appropriately.
  10575. @param in the RecordInputstream to Read the record from
  10576. </member>
  10577. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.DataSize">
  10578. Size of record (exluding 4 byte header)
  10579. </member>
  10580. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.CrossPoint">
  10581. <summary>
  10582. specifies where the value axis crosses this axis, based on the following table.
  10583. If fMaxCross is set to 1, the value this field MUST be ignored.
  10584. Category (3) axis This field specifies the category (3) at which the value axis crosses.
  10585. For example, if this field is 2, the value axis crosses this axis at the second category (3)
  10586. on this axis. MUST be greater than or equal to 1 and less than or equal to 31999.
  10587. Series axis MUST be 0.
  10588. Date axis catCross MUST be equal to the value given by the following formula:
  10589. catCross = catCrossDate – catMin + 1
  10590. Where catCrossDate is the catCrossDate field of the AxcExt record
  10591. and catMin is the catMin field of the AxcExt record.
  10592. </summary>
  10593. </member>
  10594. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.LabelInterval">
  10595. <summary>
  10596. specifies the interval between axis labels on this axis. MUST be greater than or equal to 1 and
  10597. less than or equal to 31999. MUST be ignored for a date axis.
  10598. </summary>
  10599. </member>
  10600. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.MarkInterval">
  10601. <summary>
  10602. specifies the interval at which major tick marks and minor tick marks are displayed on the axis.
  10603. Major tick marks and minor tick marks that would have been visible are hidden unless they are
  10604. located at a multiple of this field.
  10605. </summary>
  10606. </member>
  10607. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsBetween">
  10608. <summary>
  10609. specifies whether the value axis crosses this axis between major tick marks. MUST be a value from to following table:
  10610. 0 The value axis crosses this axis on a major tick mark.
  10611. 1 The value axis crosses this axis between major tick marks.
  10612. </summary>
  10613. </member>
  10614. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsMaxCross">
  10615. <summary>
  10616. specifies whether the value axis crosses this axis at the last category (3), the last series,
  10617. or the maximum date. MUST be a value from the following table:
  10618. 0 The value axis crosses this axis at the value specified by catCross.
  10619. 1 The value axis crosses this axis at the last category (3), the last series, or the maximum date.
  10620. </summary>
  10621. </member>
  10622. <member name="P:NPOI.HSSF.Record.Chart.CatSerRangeRecord.IsReverse">
  10623. <summary>
  10624. specifies whether the axis is displayed in reverse order. MUST be a value from the following table:
  10625. 0 The axis is displayed in order.
  10626. 1 The axis is display in reverse order.
  10627. </summary>
  10628. </member>
  10629. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Riser">
  10630. <summary>
  10631. the shape of the base of the data points in a bar or column chart group.
  10632. MUST be a value from the following table
  10633. 0x00 The base of the data point is a rectangle.
  10634. 0x01 The base of the data point is an ellipse.
  10635. </summary>
  10636. </member>
  10637. <member name="P:NPOI.HSSF.Record.Chart.Chart3DBarShapeRecord.Taper">
  10638. <summary>
  10639. how the data points in a bar or column chart group taper from base to tip.
  10640. MUST be a value from the following
  10641. 0x00 The data points of the bar or column chart group do not taper.
  10642. The shape at the maximum value of the data point is the same as the shape at the base.:
  10643. 0x01 The data points of the bar or column chart group taper to a point at the maximum value of each data point.
  10644. 0x02 The data points of the bar or column chart group taper towards a projected point at the position of
  10645. the maximum value of all of the data points in the chart group, but are clipped at the value of each data point.
  10646. </summary>
  10647. </member>
  10648. <member name="T:NPOI.HSSF.Record.Chart.Chart3dRecord">
  10649. <summary>
  10650. The Chart3d record specifies that the plot area of the chart group is rendered in a 3-D scene
  10651. and also specifies the attributes of the 3-D plot area. The preceding chart group type MUST be
  10652. of type bar, pie, line, area, or surface.
  10653. </summary>
  10654. <remarks>
  10655. author: Antony liu (antony.apollo at gmail.com)
  10656. </remarks>
  10657. </member>
  10658. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Rotation">
  10659. <summary>
  10660. A signed integer that specifies the clockwise rotation, in degrees, of the 3-D plot area
  10661. around a vertical line through the center of the 3-D plot area. MUST be greater than or
  10662. equal to 0 and MUST be less than or equal to 360.
  10663. </summary>
  10664. </member>
  10665. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Elev">
  10666. <summary>
  10667. A signed integer that specifies the rotation, in degrees, of the 3-D plot area around
  10668. a horizontal line through the center of the 3-D plot area.MUST be greater than or equal
  10669. to -90 and MUST be less than or equal to 90.
  10670. </summary>
  10671. </member>
  10672. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Dist">
  10673. <summary>
  10674. A signed integer that specifies the field of view angle for the 3-D plot area.
  10675. MUST be greater than or equal to zero and less than 200.
  10676. </summary>
  10677. </member>
  10678. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Height">
  10679. <summary>
  10680. If fNotPieChart is 0, then this is an unsigned integer that specifies the thickness of the pie for a pie chart group.
  10681. 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.
  10682. </summary>
  10683. </member>
  10684. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Depth">
  10685. <summary>
  10686. A signed integer that specifies the depth of the 3-D plot area as a percentage of its width.
  10687. MUST be greater than or equal to 1 and less than or equal to 2000.
  10688. </summary>
  10689. </member>
  10690. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Gap">
  10691. <summary>
  10692. An unsigned integer that specifies the width of the gap between the series and the front and
  10693. back edges of the 3-D plot area as a percentage of the data point depth divided by 2.
  10694. If fCluster is not 1 and chart group type is not a bar then pcGap also specifies distance
  10695. between adjacent series as a percentage of the data point depth. MUST be less than or equal to 500.
  10696. </summary>
  10697. </member>
  10698. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsPerspective">
  10699. <summary>
  10700. A bit that specifies whether the 3-D plot area is rendered with a vanishing point.
  10701. If fNotPieChart is 0 the value MUST be 0. If fNotPieChart is 1 then the value
  10702. MUST be a value from the following
  10703. true Perspective vanishing point applied based on value of pcDist.
  10704. false No vanishing point applied.
  10705. </summary>
  10706. </member>
  10707. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsCluster">
  10708. <summary>
  10709. specifies whether data points are clustered together in a bar chart group.
  10710. If chart group type is not bar or pie, value MUST be ignored. If chart group type is pie,
  10711. value MUST be 0. If chart group type is bar, then the value MUST be a value from the following
  10712. true Data points are clustered.
  10713. false Data points are not clustered.
  10714. </summary>
  10715. </member>
  10716. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.Is3DScaling">
  10717. <summary>
  10718. A bit that specifies whether the height of the 3-D plot area is automatically determined.
  10719. If fNotPieChart is 0 then this MUST be 0. If fNotPieChart is 1 then the value MUST be a value from the following table:
  10720. false The value of pcHeight is used to determine the height of the 3-D plot area
  10721. true The height of the 3-D plot area is automatically determined
  10722. </summary>
  10723. </member>
  10724. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsNotPieChart">
  10725. <summary>
  10726. A bit that specifies whether the chart group type is pie. MUST be a value from the following :
  10727. false Chart group type MUST be pie.
  10728. true Chart group type MUST not be pie.
  10729. </summary>
  10730. </member>
  10731. <member name="P:NPOI.HSSF.Record.Chart.Chart3dRecord.IsWalls2D">
  10732. <summary>
  10733. Whether the walls are rendered in 2-D. If fPerspective is 1 then this MUST be ignored.
  10734. If the chart group type is not bar, area or pie this MUST be ignored.
  10735. If the chart group is of type bar and fCluster is 0, then this MUST be ignored.
  10736. If the chart group type is pie this MUST be 0 and MUST be ignored.
  10737. If the chart group type is bar or area, then the value MUST be a value from the following
  10738. false Chart walls and floor are rendered in 3D.
  10739. true Chart walls are rendered in 2D and the chart floor is not rendered.
  10740. </summary>
  10741. </member>
  10742. <member name="T:NPOI.HSSF.Record.Chart.ChartEndBlockRecord">
  10743. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  10744. @author Patrick Cheng
  10745. </member>
  10746. <member name="T:NPOI.HSSF.Record.Chart.ChartEndObjectRecord">
  10747. ENDOBJECT - Chart Future Record Type End Object (0x0855)<br/>
  10748. @author Patrick Cheng
  10749. </member>
  10750. <member name="T:NPOI.HSSF.Record.Chart.ChartFRTInfoRecord">
  10751. <summary>
  10752. The ChartFrtInfo record specifies the versions of the application that originally created and last saved the file.
  10753. </summary>
  10754. </member>
  10755. <member name="T:NPOI.HSSF.Record.Chart.ChartRecord">
  10756. * The chart record is used to define the location and size of a chart.
  10757. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  10758. * Remove the record in src/records/definitions.
  10759. * @author Glen Stampoultzis (glens at apache.org)
  10760. </member>
  10761. <member name="M:NPOI.HSSF.Record.Chart.ChartRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  10762. Constructs a Chart record and Sets its fields appropriately.
  10763. @param in the RecordInputstream to Read the record from
  10764. </member>
  10765. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.DataSize">
  10766. Size of record (exluding 4 byte header)
  10767. </member>
  10768. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.X">
  10769. Get the x field for the Chart record.
  10770. </member>
  10771. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Y">
  10772. Get the y field for the Chart record.
  10773. </member>
  10774. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Width">
  10775. Get the width field for the Chart record.
  10776. </member>
  10777. <member name="P:NPOI.HSSF.Record.Chart.ChartRecord.Height">
  10778. Get the height field for the Chart record.
  10779. </member>
  10780. <member name="T:NPOI.HSSF.Record.Chart.ChartStartBlockRecord">
  10781. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  10782. @author Patrick Cheng
  10783. </member>
  10784. <member name="T:NPOI.HSSF.Record.Chart.ChartStartObjectRecord">
  10785. STARTOBJECT - Chart Future Record Type Start Object (0x0854)<br/>
  10786. @author Patrick Cheng
  10787. </member>
  10788. <member name="T:NPOI.HSSF.Record.Chart.ChartTitleFormatRecord">
  10789. Describes the formatting runs associated with a chart title.
  10790. </member>
  10791. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12ARecord">
  10792. <summary>
  10793. The CrtLayout12A record specifies layout information for a plot area.
  10794. </summary>
  10795. <remarks>
  10796. author: Antony liu (antony.apollo at gmail.com)
  10797. </remarks>
  10798. </member>
  10799. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.IsLayoutTargetInner">
  10800. <summary>
  10801. specifies the type of plot area for the layout target.
  10802. false Outer plot area - The bounding rectangle that includes the axis labels, axis titles, data table (2) and plot area of the chart.
  10803. true Inner plot area – The rectangle bounded by the chart axes.
  10804. </summary>
  10805. </member>
  10806. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.CheckSum">
  10807. <summary>
  10808. specifies the checksum
  10809. </summary>
  10810. </member>
  10811. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XTL">
  10812. <summary>
  10813. specifies the horizontal offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  10814. </summary>
  10815. </member>
  10816. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YTL">
  10817. <summary>
  10818. specifies the vertical offset of the plot area’s upper-left corner, relative to the upper-left corner of the chart area
  10819. </summary>
  10820. </member>
  10821. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XBR">
  10822. <summary>
  10823. specifies the width of the plot area
  10824. </summary>
  10825. </member>
  10826. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YBR">
  10827. <summary>
  10828. specifies the height of the plot area
  10829. </summary>
  10830. </member>
  10831. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.XMode">
  10832. <summary>
  10833. A CrtLayout12Mode structure that specifies the meaning of x.
  10834. </summary>
  10835. </member>
  10836. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.YMode">
  10837. <summary>
  10838. A CrtLayout12Mode structure that specifies the meaning of y.
  10839. </summary>
  10840. </member>
  10841. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.WidthMode">
  10842. <summary>
  10843. A CrtLayout12Mode structure that specifies the meaning of dx.
  10844. </summary>
  10845. </member>
  10846. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.HeightMode">
  10847. <summary>
  10848. A CrtLayout12Mode structure that specifies the meaning of dy.
  10849. </summary>
  10850. </member>
  10851. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.X">
  10852. <summary>
  10853. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  10854. </summary>
  10855. </member>
  10856. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.Y">
  10857. <summary>
  10858. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  10859. </summary>
  10860. </member>
  10861. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DX">
  10862. <summary>
  10863. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  10864. </summary>
  10865. </member>
  10866. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12ARecord.DY">
  10867. <summary>
  10868. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  10869. </summary>
  10870. </member>
  10871. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Mode">
  10872. <summary>
  10873. The CrtLayout12Mode specifies a layout mode. Each layout mode specifies a different
  10874. meaning of the x, y, dx, and dy fields of CrtLayout12 and CrtLayout12A.
  10875. </summary>
  10876. </member>
  10877. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MAUTO">
  10878. <summary>
  10879. Position and dimension (2) are determined by the application. x, y, dx and dy MUST be ignored.
  10880. </summary>
  10881. </member>
  10882. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MFACTOR">
  10883. <summary>
  10884. x and y specify the offset of the top left corner, relative to its default position,
  10885. as a fraction of the chart area. MUST be greater than or equal to -1.0 and MUST be
  10886. less than or equal to 1.0. dx and dy specify the width and height, as a fraction of
  10887. the chart area, MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  10888. </summary>
  10889. </member>
  10890. <member name="F:NPOI.HSSF.Record.Chart.CrtLayout12Mode.L12MEDGE">
  10891. <summary>
  10892. x and y specify the offset of the upper-left corner; dx and dy specify the offset of the bottom-right corner.
  10893. x, y, dx and dy are specified relative to the upper-left corner of the chart area as a fraction of the chart area.
  10894. x, y, dx and dy MUST be greater than or equal to 0.0, and MUST be less than or equal to 1.0.
  10895. </summary>
  10896. </member>
  10897. <member name="T:NPOI.HSSF.Record.Chart.CrtLayout12Record">
  10898. <summary>
  10899. The CrtLayout12 record specifies the layout information for attached label, when contained
  10900. in the sequence of records that conforms to the ATTACHEDLABEL rule,
  10901. or legend, when contained in the sequence of records that conforms to the LD rule.
  10902. </summary>
  10903. </member>
  10904. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.AutoLayoutType">
  10905. <summary>
  10906. automatic layout type of the legend.
  10907. MUST be ignored when this record is in the sequence of records that conforms to the ATTACHEDLABEL rule.
  10908. MUST be a value from the following table:
  10909. 0x0 Align to the bottom
  10910. 0x1 Align to top right corner
  10911. 0x2 Align to the top
  10912. 0x3 Align to the right
  10913. 0x4 Align to the left
  10914. </summary>
  10915. </member>
  10916. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.CheckSum">
  10917. <summary>
  10918. specifies the checksum of the values in the order as follows,
  10919. </summary>
  10920. </member>
  10921. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.XMode">
  10922. <summary>
  10923. A CrtLayout12Mode structure that specifies the meaning of x.
  10924. </summary>
  10925. </member>
  10926. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.YMode">
  10927. <summary>
  10928. A CrtLayout12Mode structure that specifies the meaning of y.
  10929. </summary>
  10930. </member>
  10931. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.WidthMode">
  10932. <summary>
  10933. A CrtLayout12Mode structure that specifies the meaning of dx.
  10934. </summary>
  10935. </member>
  10936. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.HeightMode">
  10937. <summary>
  10938. A CrtLayout12Mode structure that specifies the meaning of dy.
  10939. </summary>
  10940. </member>
  10941. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.X">
  10942. <summary>
  10943. An Xnum (section 2.5.342) value that specifies a horizontal offset. The meaning is determined by wXMode.
  10944. </summary>
  10945. </member>
  10946. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.Y">
  10947. <summary>
  10948. An Xnum value that specifies a vertical offset. The meaning is determined by wYMode.
  10949. </summary>
  10950. </member>
  10951. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DX">
  10952. <summary>
  10953. An Xnum value that specifies a width or an horizontal offset. The meaning is determined by wWidthMode.
  10954. </summary>
  10955. </member>
  10956. <member name="P:NPOI.HSSF.Record.Chart.CrtLayout12Record.DY">
  10957. <summary>
  10958. An Xnum value that specifies a height or an vertical offset. The meaning is determined by wHeightMode.
  10959. </summary>
  10960. </member>
  10961. <member name="T:NPOI.HSSF.Record.Chart.CrtLineRecord">
  10962. <summary>
  10963. The CrtLine record specifies the presence of drop lines, high-low lines, series lines
  10964. or leader lines on the chart group. This record is followed by a LineFormat record
  10965. which specifies the format of the lines.
  10966. </summary>
  10967. <remarks>
  10968. author: Antony liu (antony.apollo at gmail.com)
  10969. </remarks>
  10970. </member>
  10971. <member name="T:NPOI.HSSF.Record.Chart.CrtLinkRecord">
  10972. <summary>
  10973. The CrtLink record is written but unused.
  10974. </summary>
  10975. </member>
  10976. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtContinueRecord">
  10977. <summary>
  10978. The CrtMlFrtContinue record specifies additional data for a CrtMlFrt record, as specified in the CrtMlFrt record.
  10979. </summary>
  10980. <remarks>
  10981. author: Antony liu (antony.apollo at gmail.com)
  10982. </remarks>
  10983. </member>
  10984. <member name="T:NPOI.HSSF.Record.Chart.CrtMlFrtRecord">
  10985. <summary>
  10986. The CrtMlFrt record specifies additional properties for chart elements, as specified by
  10987. the Chart Sheet Substream ABNF. These properties complement the record to which they
  10988. correspond, and are stored as a structure chain defined in XmlTkChain. An application
  10989. can ignore this record without loss of functionality, except for the additional properties.
  10990. If this record is longer than 8224 bytes, it MUST be split into several records. The first
  10991. section of the data appears in this record and subsequent sections appear in one or more
  10992. CrtMlFrtContinue records that follow this record.
  10993. </summary>
  10994. <remarks>
  10995. author: Antony liu (antony.apollo at gmail.com)
  10996. </remarks>
  10997. </member>
  10998. <member name="T:NPOI.HSSF.Record.Chart.DataFormatRecord">
  10999. * The data format record is used to index into a series.
  11000. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11001. * Remove the record in src/records/definitions.
  11002. * @author Glen Stampoultzis (glens at apache.org)
  11003. </member>
  11004. <member name="M:NPOI.HSSF.Record.Chart.DataFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11005. Constructs a DataFormat record and Sets its fields appropriately.
  11006. @param in the RecordInputstream to Read the record from
  11007. </member>
  11008. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.DataSize">
  11009. Size of record (exluding 4 byte header)
  11010. </member>
  11011. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.PointNumber">
  11012. Get the point number field for the DataFormat record.
  11013. </member>
  11014. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesIndex">
  11015. Get the series index field for the DataFormat record.
  11016. </member>
  11017. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.SeriesNumber">
  11018. Get the series number field for the DataFormat record.
  11019. </member>
  11020. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.FormatFlags">
  11021. Get the format flags field for the DataFormat record.
  11022. </member>
  11023. <member name="P:NPOI.HSSF.Record.Chart.DataFormatRecord.UseExcel4Colors">
  11024. Set true to use excel 4 colors.
  11025. @return the use excel 4 colors field value.
  11026. </member>
  11027. <member name="T:NPOI.HSSF.Record.Chart.DataLabelExtensionRecord">
  11028. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  11029. @author Patrick Cheng
  11030. </member>
  11031. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtContentsRecord">
  11032. <summary>
  11033. The DataLabExtContents record specifies the contents of an extended data label.
  11034. </summary>
  11035. </member>
  11036. <member name="T:NPOI.HSSF.Record.Chart.DataLabExtRecord">
  11037. DATALABEXT - Chart Data Label Extension (0x086A) <br/>
  11038. @author Patrick Cheng
  11039. </member>
  11040. <member name="T:NPOI.HSSF.Record.Chart.DatRecord">
  11041. * The dat record is used to store options for the chart.
  11042. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11043. * Remove the record in src/records/definitions.
  11044. * @author Glen Stampoultzis (glens at apache.org)
  11045. </member>
  11046. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11047. Constructs a Dat record and Sets its fields appropriately.
  11048. @param in the RecordInputstream to Read the record from
  11049. </member>
  11050. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.DataSize">
  11051. Size of record (exluding 4 byte header)
  11052. </member>
  11053. <member name="P:NPOI.HSSF.Record.Chart.DatRecord.Options">
  11054. Get the options field for the Dat record.
  11055. </member>
  11056. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetHorizontalBorder(System.Boolean)">
  11057. Sets the horizontal border field value.
  11058. has a horizontal border
  11059. </member>
  11060. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsHorizontalBorder">
  11061. has a horizontal border
  11062. @return the horizontal border field value.
  11063. </member>
  11064. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetVerticalBorder(System.Boolean)">
  11065. Sets the vertical border field value.
  11066. has vertical border
  11067. </member>
  11068. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsVerticalBorder">
  11069. has vertical border
  11070. @return the vertical border field value.
  11071. </member>
  11072. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetBorder(System.Boolean)">
  11073. Sets the border field value.
  11074. data table has a border
  11075. </member>
  11076. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsBorder">
  11077. data table has a border
  11078. @return the border field value.
  11079. </member>
  11080. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.SetShowSeriesKey(System.Boolean)">
  11081. Sets the show series key field value.
  11082. shows the series key
  11083. </member>
  11084. <member name="M:NPOI.HSSF.Record.Chart.DatRecord.IsShowSeriesKey">
  11085. shows the series key
  11086. @return the show series key field value.
  11087. </member>
  11088. <member name="T:NPOI.HSSF.Record.Chart.TextFormatInfo">
  11089. <summary>
  11090. specifies the text elements that are formatted using the position and appearance information
  11091. specified by the Text record immediately following this record.
  11092. </summary>
  11093. </member>
  11094. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueNotSet">
  11095. <summary>
  11096. Format all Text records in the chart group where fShowPercent is equal to 0 or fShowValue is equal to 0.
  11097. </summary>
  11098. </member>
  11099. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.ShowPercentOrValueSet">
  11100. <summary>
  11101. Format all Text records in the chart group where fShowPercent is equal to 1 or fShowValue is equal to 1.
  11102. </summary>
  11103. </member>
  11104. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleNotSet">
  11105. <summary>
  11106. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 0.
  11107. </summary>
  11108. </member>
  11109. <member name="F:NPOI.HSSF.Record.Chart.TextFormatInfo.FontScaleSet">
  11110. <summary>
  11111. Format all Text records in the chart where the value of fScaled of the associated FontInfo structure is equal to 1.
  11112. </summary>
  11113. </member>
  11114. <member name="T:NPOI.HSSF.Record.Chart.DefaultTextRecord">
  11115. <summary>
  11116. specifies the text elements that are formatted using the information specified by
  11117. the Text record immediately following this record.
  11118. </summary>
  11119. </member>
  11120. <member name="M:NPOI.HSSF.Record.Chart.DefaultTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11121. Constructs a DefaultDataLabelTextProperties record and Sets its fields appropriately.
  11122. @param in the RecordInputstream to Read the record from
  11123. </member>
  11124. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.DataSize">
  11125. Size of record (exluding 4 byte header)
  11126. </member>
  11127. <member name="P:NPOI.HSSF.Record.Chart.DefaultTextRecord.FormatType">
  11128. <summary>
  11129. specifies the text elements that are formatted using the position and appearance
  11130. information specified by the Text record immediately following this record.
  11131. </summary>
  11132. </member>
  11133. <member name="T:NPOI.HSSF.Record.Chart.DropBarRecord">
  11134. <summary>
  11135. The DropBar record specifies the attributes of the up bars or the down bars between multiple
  11136. series of a line chart group and specifies the beginning of a collection of records as
  11137. defined by the Chart Sheet Substream ABNF. The first of these collections in the line chart
  11138. group specifies the attributes of the up bars. The second specifies the attributes of the
  11139. down bars. If this record exists, then the chart group type MUST be line and the field cSer
  11140. in the record SeriesList MUST be greater than 1.
  11141. </summary>
  11142. <remarks>
  11143. author: Antony liu (antony.apollo at gmail.com)
  11144. </remarks>
  11145. </member>
  11146. <member name="T:NPOI.HSSF.Record.Chart.EndBlockRecord">
  11147. ENDBLOCK - Chart Future Record Type End Block (0x0853)<br/>
  11148. @author Patrick Cheng
  11149. </member>
  11150. <member name="T:NPOI.HSSF.Record.Chart.EndRecord">
  11151. The end record defines the end of a block of records for a (Graphing)
  11152. data object. This record is matched with a corresponding BeginRecord.
  11153. @see BeginRecord
  11154. @author Glen Stampoultzis (glens at apache.org)
  11155. </member>
  11156. <member name="M:NPOI.HSSF.Record.Chart.EndRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11157. Constructs a EndRecord record and Sets its fields appropriately.
  11158. @param in the RecordInputstream to Read the record from
  11159. </member>
  11160. <member name="T:NPOI.HSSF.Record.Chart.Fbi2Record">
  11161. <summary>
  11162. The Fbi2 record specifies the font information at the time the scalable font is added to the chart.
  11163. </summary>
  11164. <remarks>
  11165. author: Antony liu (antony.apollo at gmail.com)
  11166. </remarks>
  11167. </member>
  11168. <member name="T:NPOI.HSSF.Record.Chart.FbiRecord">
  11169. <summary>
  11170. The Fbi record specifies the font information at the time the scalable font is added to the chart.
  11171. </summary>
  11172. </member>
  11173. <member name="M:NPOI.HSSF.Record.Chart.FbiRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11174. Constructs a FontBasis record and Sets its fields appropriately.
  11175. @param in the RecordInputstream to Read the record from
  11176. </member>
  11177. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.DataSize">
  11178. Size of record (exluding 4 byte header)
  11179. </member>
  11180. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.XBasis">
  11181. Get the x Basis field for the FontBasis record.
  11182. </member>
  11183. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.YBasis">
  11184. Get the y Basis field for the FontBasis record.
  11185. </member>
  11186. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.HeightBasis">
  11187. Get the height basis field for the FontBasis record.
  11188. </member>
  11189. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.Scale">
  11190. Get the scale field for the FontBasis record.
  11191. </member>
  11192. <member name="P:NPOI.HSSF.Record.Chart.FbiRecord.IndexToFontTable">
  11193. Get the index to font table field for the FontBasis record.
  11194. </member>
  11195. <member name="T:NPOI.HSSF.Record.Chart.FontBasisRecord">
  11196. * The font basis record stores various font metrics.
  11197. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11198. * Remove the record in src/records/definitions.
  11199. * @author Glen Stampoultzis (glens at apache.org)
  11200. </member>
  11201. <member name="M:NPOI.HSSF.Record.Chart.FontBasisRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11202. Constructs a FontBasis record and Sets its fields appropriately.
  11203. @param in the RecordInputstream to Read the record from
  11204. </member>
  11205. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.DataSize">
  11206. Size of record (exluding 4 byte header)
  11207. </member>
  11208. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.XBasis">
  11209. Get the x Basis field for the FontBasis record.
  11210. </member>
  11211. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.YBasis">
  11212. Get the y Basis field for the FontBasis record.
  11213. </member>
  11214. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.HeightBasis">
  11215. Get the height basis field for the FontBasis record.
  11216. </member>
  11217. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.Scale">
  11218. Get the scale field for the FontBasis record.
  11219. </member>
  11220. <member name="P:NPOI.HSSF.Record.Chart.FontBasisRecord.IndexToFontTable">
  11221. Get the index to font table field for the FontBasis record.
  11222. </member>
  11223. <member name="T:NPOI.HSSF.Record.Chart.FontXRecord">
  11224. <summary>
  11225. The FontX record specifies the font for a given text element.
  11226. The Font record referenced by iFont can exist in this chart sheet substream or the workbook.
  11227. </summary>
  11228. </member>
  11229. <member name="M:NPOI.HSSF.Record.Chart.FontXRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11230. Constructs a FontIndex record and Sets its fields appropriately.
  11231. @param in the RecordInputstream to Read the record from
  11232. </member>
  11233. <member name="P:NPOI.HSSF.Record.Chart.FontXRecord.DataSize">
  11234. Size of record (exluding 4 byte header)
  11235. </member>
  11236. <member name="P:NPOI.HSSF.Record.Chart.FontXRecord.FontIndex">
  11237. <summary>
  11238. specifies the font to use for subsequent records.
  11239. This font can either be the default font of the chart, part of the collection of Font records following
  11240. the FrtFontList record, or part of the collection of Font records in the globals substream.
  11241. If iFont is 0x0000, this record specifies the default font of the chart.
  11242. If iFont is less than or equal to the number of Font records in the globals substream,
  11243. iFont is a one-based index to a Font record in the globals substream.
  11244. Otherwise iFont is a one-based index into the collection of Font records in this chart sheet substream
  11245. where the index is equal to iFont – n, where n is the number of Font records in the globals substream.
  11246. </summary>
  11247. </member>
  11248. <member name="T:NPOI.HSSF.Record.Chart.FrameRecord">
  11249. * The frame record indicates whether there is a border around the Displayed text of a chart.
  11250. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11251. * Remove the record in src/records/definitions.
  11252. * @author Glen Stampoultzis (glens at apache.org)
  11253. </member>
  11254. <member name="M:NPOI.HSSF.Record.Chart.FrameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11255. Constructs a Frame record and Sets its fields appropriately.
  11256. @param in the RecordInputstream to Read the record from
  11257. </member>
  11258. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.DataSize">
  11259. Size of record (exluding 4 byte header)
  11260. </member>
  11261. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.BorderType">
  11262. Get the border type field for the Frame record.
  11263. @return One of
  11264. BORDER_TYPE_REGULAR
  11265. BORDER_TYPE_SHADOW
  11266. </member>
  11267. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.Options">
  11268. Get the options field for the Frame record.
  11269. </member>
  11270. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoSize">
  11271. excel calculates the size automatically if true
  11272. @return the auto size field value.
  11273. </member>
  11274. <member name="P:NPOI.HSSF.Record.Chart.FrameRecord.IsAutoPosition">
  11275. excel calculates the position automatically
  11276. @return the auto position field value.
  11277. </member>
  11278. <member name="T:NPOI.HSSF.Record.Chart.FrtFontListRecord">
  11279. <summary>
  11280. The FrtFontList record specifies font information used on the chart and specifies the
  11281. beginning of a collection of Font records as defined by the Chart Sheet Substream ABNF.
  11282. </summary>
  11283. <remarks>
  11284. author: Antony liu (antony.apollo at gmail.com)
  11285. </remarks>
  11286. </member>
  11287. <member name="T:NPOI.HSSF.Record.Chart.GelFrameRecord">
  11288. <summary>
  11289. specifies the properties of a fill pattern for parts of a chart.
  11290. </summary>
  11291. <remarks>
  11292. author: Antony liu (antony.apollo at gmail.com)
  11293. </remarks>
  11294. </member>
  11295. <member name="T:NPOI.HSSF.Record.Chart.IFmtRecordRecord">
  11296. <summary>
  11297. The IFmtRecord record specifies the number format to use for the text on an axis.
  11298. </summary>
  11299. </member>
  11300. <member name="M:NPOI.HSSF.Record.Chart.IFmtRecordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11301. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  11302. @param in the RecordInputstream to Read the record from
  11303. </member>
  11304. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.DataSize">
  11305. Size of record (exluding 4 byte header)
  11306. </member>
  11307. <member name="P:NPOI.HSSF.Record.Chart.IFmtRecordRecord.FormatIndex">
  11308. Get the format index field for the NumberFormatIndex record.
  11309. </member>
  11310. <member name="T:NPOI.HSSF.Record.Chart.LegendExceptionRecord">
  11311. <summary>
  11312. The LegendException record specifies information about a legend entry which was
  11313. changed from the default legend entry settings, and specifies the beginning of
  11314. a collection of records as defined by the Chart Sheet Substream ABNF.
  11315. The collection of records specifies legend entry formatting. On a chart where
  11316. the legend contains legend entries for the series and trendlines, as defined
  11317. in the legend overview, there MUST be zero instances or one instance of this
  11318. record in the sequence of records that conform to the SERIESFORMAT rule.
  11319. </summary>
  11320. <remarks>
  11321. author: Antony liu (antony.apollo at gmail.com)
  11322. </remarks>
  11323. </member>
  11324. <member name="T:NPOI.HSSF.Record.Chart.LegendRecord">
  11325. * Defines a legend for a chart.
  11326. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11327. * Remove the record in src/records/definitions.
  11328. * @author Andrew C. Oliver (acoliver at apache.org)
  11329. </member>
  11330. <member name="M:NPOI.HSSF.Record.Chart.LegendRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11331. Constructs a Legend record and Sets its fields appropriately.
  11332. @param in the RecordInputstream to Read the record from
  11333. </member>
  11334. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.DataSize">
  11335. Size of record (exluding 4 byte header)
  11336. </member>
  11337. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XAxisUpperLeft">
  11338. Get the x axis upper left field for the Legend record.
  11339. </member>
  11340. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YAxisUpperLeft">
  11341. Get the y axis upper left field for the Legend record.
  11342. </member>
  11343. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.XSize">
  11344. Get the x size field for the Legend record.
  11345. </member>
  11346. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.YSize">
  11347. Get the y size field for the Legend record.
  11348. </member>
  11349. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Type">
  11350. Get the type field for the Legend record.
  11351. @return One of
  11352. TYPE_BOTTOM
  11353. TYPE_CORNER
  11354. TYPE_TOP
  11355. TYPE_RIGHT
  11356. TYPE_LEFT
  11357. TYPE_UNDOCKED
  11358. </member>
  11359. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Spacing">
  11360. Get the spacing field for the Legend record.
  11361. @return One of
  11362. SPACING_CLOSE
  11363. SPACING_MEDIUM
  11364. SPACING_OPEN
  11365. </member>
  11366. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.Options">
  11367. Get the options field for the Legend record.
  11368. </member>
  11369. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoPosition">
  11370. automatic positioning (1=docked)
  11371. @return the auto position field value.
  11372. </member>
  11373. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoSeries">
  11374. excel 5 only (true)
  11375. @return the auto series field value.
  11376. </member>
  11377. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoXPositioning">
  11378. position of legend on the x axis is automatic
  11379. @return the auto x positioning field value.
  11380. </member>
  11381. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsAutoYPositioning">
  11382. position of legend on the y axis is automatic
  11383. @return the auto y positioning field value.
  11384. </member>
  11385. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsVertical">
  11386. vertical or horizontal legend (1 or 0 respectively). Always 0 if not automatic.
  11387. @return the vertical field value.
  11388. </member>
  11389. <member name="P:NPOI.HSSF.Record.Chart.LegendRecord.IsDataTable">
  11390. 1 if chart Contains data table
  11391. @return the data table field value.
  11392. </member>
  11393. <member name="T:NPOI.HSSF.Record.Chart.LineFormatRecord">
  11394. * Describes a line format record. The line format record controls how a line on a chart appears.
  11395. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11396. * Remove the record in src/records/definitions.
  11397. * @author Glen Stampoultzis (glens at apache.org)
  11398. </member>
  11399. <member name="M:NPOI.HSSF.Record.Chart.LineFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11400. Constructs a LineFormat record and Sets its fields appropriately.
  11401. @param in the RecordInputstream to Read the record from
  11402. </member>
  11403. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.DataSize">
  11404. Size of record (exluding 4 byte header)
  11405. </member>
  11406. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LineColor">
  11407. Get the line color field for the LineFormat record.
  11408. </member>
  11409. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.LinePattern">
  11410. Get the line pattern field for the LineFormat record.
  11411. @return One of
  11412. LINE_PATTERN_SOLID
  11413. LINE_PATTERN_DASH
  11414. LINE_PATTERN_DOT
  11415. LINE_PATTERN_DASH_DOT
  11416. LINE_PATTERN_DASH_DOT_DOT
  11417. LINE_PATTERN_NONE
  11418. LINE_PATTERN_DARK_GRAY_PATTERN
  11419. LINE_PATTERN_MEDIUM_GRAY_PATTERN
  11420. LINE_PATTERN_LIGHT_GRAY_PATTERN
  11421. </member>
  11422. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Weight">
  11423. Get the weight field for the LineFormat record.
  11424. specifies the thickness of the line.
  11425. @return One of
  11426. WEIGHT_HAIRLINE
  11427. WEIGHT_NARROW
  11428. WEIGHT_MEDIUM
  11429. WEIGHT_WIDE
  11430. </member>
  11431. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.Format">
  11432. Get the format field for the LineFormat record.
  11433. </member>
  11434. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.ColourPaletteIndex">
  11435. Get the colour palette index field for the LineFormat record.
  11436. </member>
  11437. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsAuto">
  11438. automatic format
  11439. @return the auto field value.
  11440. </member>
  11441. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsDrawTicks">
  11442. draw tick marks
  11443. @return the draw ticks field value.
  11444. </member>
  11445. <member name="P:NPOI.HSSF.Record.Chart.LineFormatRecord.IsUnknown">
  11446. book marks this as reserved = 0 but it seems to do something
  11447. @return the Unknown field value.
  11448. </member>
  11449. <member name="T:NPOI.HSSF.Record.Chart.MarkerFormatRecord">
  11450. <summary>
  11451. specifies the color, size, and shape of the associated data markers that appear on line, radar,
  11452. and scatter chart groups. The associated data markers are specified by the preceding DataFormat record.
  11453. </summary>
  11454. <remarks>
  11455. author: Antony liu (antony.apollo at gmail.com)
  11456. </remarks>
  11457. </member>
  11458. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBFore">
  11459. <summary>
  11460. the border color of the data marker.
  11461. </summary>
  11462. </member>
  11463. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.RGBBack">
  11464. <summary>
  11465. the interior color of the data marker.
  11466. </summary>
  11467. </member>
  11468. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.DataMarkerType">
  11469. <summary>
  11470. the type of data marker.
  11471. </summary>
  11472. </member>
  11473. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Auto">
  11474. <summary>
  11475. whether the data marker is automatically generated.
  11476. false The data marker is not automatically generated.
  11477. true The data marker type, size, and color are automatically generated and the values are set accordingly in this record.
  11478. </summary>
  11479. </member>
  11480. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowInt">
  11481. <summary>
  11482. whether to show the data marker interior.
  11483. false The data marker interior is shown.
  11484. true The data marker interior is not shown.
  11485. </summary>
  11486. </member>
  11487. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.NotShowBorder">
  11488. <summary>
  11489. whether to show the data marker border.
  11490. false The data marker border is shown.
  11491. true The data marker border is not shown.
  11492. </summary>
  11493. </member>
  11494. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvFore">
  11495. <summary>
  11496. the border color of the data marker.
  11497. </summary>
  11498. </member>
  11499. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.IcvBack">
  11500. <summary>
  11501. the interior color of the data marker.
  11502. </summary>
  11503. </member>
  11504. <member name="P:NPOI.HSSF.Record.Chart.MarkerFormatRecord.Size">
  11505. <summary>
  11506. specifies the size in twips of the data marker.
  11507. </summary>
  11508. </member>
  11509. <member name="T:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord">
  11510. * The number format index record indexes format table. This applies to an axis.
  11511. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11512. * Remove the record in src/records/definitions.
  11513. * @author Glen Stampoultzis (glens at apache.org)
  11514. </member>
  11515. <member name="M:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11516. Constructs a NumberFormatIndex record and Sets its fields appropriately.
  11517. @param in the RecordInputstream to Read the record from
  11518. </member>
  11519. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.DataSize">
  11520. Size of record (exluding 4 byte header)
  11521. </member>
  11522. <member name="P:NPOI.HSSF.Record.Chart.NumberFormatIndexRecord.FormatIndex">
  11523. Get the format index field for the NumberFormatIndex record.
  11524. </member>
  11525. <member name="T:NPOI.HSSF.Record.Chart.ObjectLinkRecord">
  11526. * Links text to an object on the chart or identifies it as the title.
  11527. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11528. * Remove the record in src/records/definitions.
  11529. * @author Andrew C. Oliver (acoliver at apache.org)
  11530. </member>
  11531. <member name="M:NPOI.HSSF.Record.Chart.ObjectLinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11532. Constructs a ObjectLink record and Sets its fields appropriately.
  11533. @param in the RecordInputstream to Read the record from
  11534. </member>
  11535. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.DataSize">
  11536. Size of record (exluding 4 byte header)
  11537. </member>
  11538. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.AnchorId">
  11539. Get the anchor id field for the ObjectLink record.
  11540. @return One of
  11541. ANCHOR_ID_CHART_TITLE
  11542. ANCHOR_ID_Y_AXIS
  11543. ANCHOR_ID_X_AXIS
  11544. ANCHOR_ID_SERIES_OR_POINT
  11545. ANCHOR_ID_Z_AXIS
  11546. </member>
  11547. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link1">
  11548. Get the link 1 field for the ObjectLink record.
  11549. </member>
  11550. <member name="P:NPOI.HSSF.Record.Chart.ObjectLinkRecord.Link2">
  11551. Get the link 2 field for the ObjectLink record.
  11552. </member>
  11553. <member name="T:NPOI.HSSF.Record.Chart.PicFRecord">
  11554. <summary>
  11555. The PicF record specifies the layout of a picture that is attached to a picture-filled chart element.
  11556. </summary>
  11557. <remarks>
  11558. author: Antony liu (antony.apollo at gmail.com)
  11559. </remarks>
  11560. </member>
  11561. <member name="T:NPOI.HSSF.Record.Chart.PieFormatRecord">
  11562. <summary>
  11563. The PieFormat record specifies the distance of a data point or data points in a series from the center of one of the following:
  11564. The plot area for a doughnut or pie chart group.
  11565. The primary pie in a pie of pie or bar of pie chart group.
  11566. The secondary bar/pie of a pie of pie chart group.
  11567. </summary>
  11568. <remarks>
  11569. author: Antony liu (antony.apollo at gmail.com)
  11570. </remarks>
  11571. </member>
  11572. <member name="P:NPOI.HSSF.Record.Chart.PieFormatRecord.Explode">
  11573. <summary>
  11574. 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:
  11575. The plot area for a doughnut or pie chart group.
  11576. The primary pie in a pie of pie or bar of pie chart group.
  11577. The secondary bar/pie of a pie of pie chart group.
  11578. </summary>
  11579. </member>
  11580. <member name="T:NPOI.HSSF.Record.Chart.PieRecord">
  11581. <summary>
  11582. The Pie record specifies that the chart group is a pie chart group or
  11583. a doughnut chart group, and specifies the chart group attributes.
  11584. </summary>
  11585. <remarks>
  11586. author: Antony liu (antony.apollo at gmail.com)
  11587. </remarks>
  11588. </member>
  11589. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Start">
  11590. <summary>
  11591. An unsigned integer that specifies the starting angle of the first data point,
  11592. clockwise from the top of the circle. MUST be less than or equal to 360.
  11593. </summary>
  11594. </member>
  11595. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.Dount">
  11596. <summary>
  11597. An unsigned integer that specifies the size of the center hole in a doughnut chart group
  11598. as a percentage of the plot area size. MUST be a value from the following table:
  11599. 0 Pie chart group.
  11600. 10 to 90 Doughnut chart group.
  11601. </summary>
  11602. </member>
  11603. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.HasShadow">
  11604. <summary>
  11605. A bit that specifies whether one data point or more data points in the chart group have shadows.
  11606. </summary>
  11607. </member>
  11608. <member name="P:NPOI.HSSF.Record.Chart.PieRecord.ShowLdrLines">
  11609. <summary>
  11610. A bit that specifies whether the leader lines to the data labels are shown.
  11611. </summary>
  11612. </member>
  11613. <member name="T:NPOI.HSSF.Record.Chart.PlotAreaRecord">
  11614. * preceeds and identifies a frame as belonging to the plot area.
  11615. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11616. * Remove the record in src/records/definitions.
  11617. * @author Andrew C. Oliver (acoliver at apache.org)
  11618. </member>
  11619. <member name="M:NPOI.HSSF.Record.Chart.PlotAreaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11620. Constructs a PlotArea record and Sets its fields appropriately.
  11621. @param in the RecordInputstream to Read the record from
  11622. </member>
  11623. <member name="P:NPOI.HSSF.Record.Chart.PlotAreaRecord.DataSize">
  11624. Size of record (exluding 4 byte header)
  11625. </member>
  11626. <member name="T:NPOI.HSSF.Record.Chart.PlotGrowthRecord">
  11627. * The plot growth record specifies the scaling factors used when a font is scaled.
  11628. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11629. * Remove the record in src/records/definitions.
  11630. * @author Glen Stampoultzis (glens at apache.org)
  11631. </member>
  11632. <member name="M:NPOI.HSSF.Record.Chart.PlotGrowthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11633. Constructs a PlotGrowth record and Sets its fields appropriately.
  11634. @param in the RecordInputstream to Read the record from
  11635. </member>
  11636. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.DataSize">
  11637. Size of record (exluding 4 byte header)
  11638. </member>
  11639. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.HorizontalScale">
  11640. Get the horizontalScale field for the PlotGrowth record.
  11641. </member>
  11642. <member name="P:NPOI.HSSF.Record.Chart.PlotGrowthRecord.VerticalScale">
  11643. Get the verticalScale field for the PlotGrowth record.
  11644. </member>
  11645. <member name="T:NPOI.HSSF.Record.Chart.PositionMode">
  11646. <summary>
  11647. pecifies positioning mode for position information saved in a Pos record.
  11648. </summary>
  11649. </member>
  11650. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDFX">
  11651. <summary>
  11652. Relative position to the chart, in points.
  11653. </summary>
  11654. </member>
  11655. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDABS">
  11656. <summary>
  11657. Absolute width and height in points. It can only be applied to the mdBotRt field of Pos.
  11658. </summary>
  11659. </member>
  11660. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDPARENT">
  11661. <summary>
  11662. Owner of Pos determines how to interpret the position data.
  11663. </summary>
  11664. </member>
  11665. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDKTH">
  11666. <summary>
  11667. Offset to default position, in 1/1000th of the plot area size.
  11668. </summary>
  11669. </member>
  11670. <member name="F:NPOI.HSSF.Record.Chart.PositionMode.MDCHART">
  11671. <summary>
  11672. Relative position to the chart, in SPRC.
  11673. </summary>
  11674. </member>
  11675. <member name="T:NPOI.HSSF.Record.Chart.PosRecord">
  11676. <summary>
  11677. specifies the size and position for a legend, an attached label, or the plot area, as specified by the primary axis group.
  11678. </summary>
  11679. </member>
  11680. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MDTopLt">
  11681. <summary>
  11682. specifies the positioning mode for the upper-left corner of a legend, an attached label, or the plot area.
  11683. </summary>
  11684. </member>
  11685. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.MdBotRt">
  11686. <summary>
  11687. specifies the positioning mode for the lower-right corner of a legend, an attached label, or the plot area
  11688. </summary>
  11689. </member>
  11690. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X1">
  11691. <summary>
  11692. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11693. </summary>
  11694. </member>
  11695. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.X2">
  11696. <summary>
  11697. specifies a width. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11698. </summary>
  11699. </member>
  11700. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y1">
  11701. <summary>
  11702. specifies a position. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11703. </summary>
  11704. </member>
  11705. <member name="P:NPOI.HSSF.Record.Chart.PosRecord.Y2">
  11706. <summary>
  11707. specifies a height. The meaning is specified in the earlier table showing the valid combinations mdTopLt and mdBotRt by type.
  11708. </summary>
  11709. </member>
  11710. <member name="T:NPOI.HSSF.Record.Chart.RadarAreaRecord">
  11711. <summary>
  11712. The RadarArea record specifies that the chart group is a filled radar chart group and specifies the chart group attributes.
  11713. </summary>
  11714. <remarks>
  11715. author: Antony liu (antony.apollo at gmail.com)
  11716. </remarks>
  11717. </member>
  11718. <member name="T:NPOI.HSSF.Record.Chart.RadarRecord">
  11719. <summary>
  11720. The Radar record specifies that the chart group is a radar chart group and specifies the chart group attributes.
  11721. </summary>
  11722. <remarks>
  11723. author: Antony liu (antony.apollo at gmail.com)
  11724. </remarks>
  11725. </member>
  11726. <member name="T:NPOI.HSSF.Record.Chart.RichTextStreamRecord">
  11727. <summary>
  11728. The RichTextStream record specifies additional text properties for the text in
  11729. the entire chart, text in the current legend, text in the current legend entry,
  11730. or text in the attached label. These text properties are a superset of the
  11731. properties stored in the Text, Font, FontX, BRAI, and ObjectLink records based
  11732. on the following table, as specified by the Chart Sheet Substream ABNF. In each
  11733. case, the associated Font record is specified by the associated FontX record.
  11734. </summary>
  11735. <remarks>
  11736. author: Antony liu (antony.apollo at gmail.com)
  11737. </remarks>
  11738. </member>
  11739. <member name="T:NPOI.HSSF.Record.Chart.ScatterRecord">
  11740. <summary>
  11741. The Scatter record specifies that the chart group is a scatter chart group or
  11742. a bubble chart group, and specifies the chart group attributes.
  11743. </summary>
  11744. <remarks>
  11745. author: Antony liu (antony.apollo at gmail.com)
  11746. </remarks>
  11747. </member>
  11748. <member name="T:NPOI.HSSF.Record.Chart.SerAuxErrBarRecord">
  11749. <summary>
  11750. The SerAuxErrBar record specifies properties of an error bar.
  11751. </summary>
  11752. <remarks>
  11753. author: Antony liu (antony.apollo at gmail.com)
  11754. </remarks>
  11755. </member>
  11756. <member name="T:NPOI.HSSF.Record.Chart.SerAuxTrendRecord">
  11757. <summary>
  11758. The SerAuxTrend record specifies a trendline.
  11759. </summary>
  11760. <remarks>
  11761. author: Antony liu (antony.apollo at gmail.com)
  11762. </remarks>
  11763. </member>
  11764. <member name="T:NPOI.HSSF.Record.Chart.SerFmtRecord">
  11765. <summary>
  11766. The SerFmt record specifies properties of the associated data points, data markers,
  11767. or lines of the series. The associated data points, data markers, or lines of the
  11768. series are specified by the preceding DataFormat record. If this record is not
  11769. present in the sequence of records that conforms to the SS rule of the Chart Sheet
  11770. Substream ABNF, then the properties of the associated data points, data markers,
  11771. or lines of the series are specified by the default values of the fields of this record.
  11772. </summary>
  11773. <remarks>
  11774. author: Antony liu (antony.apollo at gmail.com)
  11775. </remarks>
  11776. </member>
  11777. <member name="T:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord">
  11778. * The series chart Group index record stores the index to the CHARTFORMAT record (0 based).
  11779. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11780. * Remove the record in src/records/definitions.
  11781. * @author Glen Stampoultzis (glens at apache.org)
  11782. </member>
  11783. <member name="M:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11784. Constructs a SeriesChartGroupIndex 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.Chart.SeriesChartGroupIndexRecord.DataSize">
  11788. Size of record (exluding 4 byte header)
  11789. </member>
  11790. <member name="P:NPOI.HSSF.Record.Chart.SeriesChartGroupIndexRecord.ChartGroupIndex">
  11791. Get the chart Group index field for the SeriesChartGroupIndex record.
  11792. </member>
  11793. <member name="T:NPOI.HSSF.Record.Chart.SeriesIndexRecord">
  11794. * links a series to its position in the series list.
  11795. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11796. * Remove the record in src/records/definitions.
  11797. * @author Andrew C. Oliver (acoliver at apache.org)
  11798. </member>
  11799. <member name="M:NPOI.HSSF.Record.Chart.SeriesIndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11800. Constructs a SeriesIndex 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.Chart.SeriesIndexRecord.DataSize">
  11804. Size of record (exluding 4 byte header)
  11805. </member>
  11806. <member name="P:NPOI.HSSF.Record.Chart.SeriesIndexRecord.Index">
  11807. Get the index field for the SeriesIndex record.
  11808. </member>
  11809. <member name="T:NPOI.HSSF.Record.Chart.SeriesLabelsRecord">
  11810. * The series label record defines the type of label associated with the data format record.
  11811. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11812. * Remove the record in src/records/definitions.
  11813. * @author Glen Stampoultzis (glens at apache.org)
  11814. </member>
  11815. <member name="M:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11816. Constructs a SeriesLabels record and Sets its fields appropriately.
  11817. @param in the RecordInputstream to Read the record from
  11818. </member>
  11819. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.DataSize">
  11820. Size of record (exluding 4 byte header)
  11821. </member>
  11822. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.FormatFlags">
  11823. Get the format flags field for the SeriesLabels record.
  11824. </member>
  11825. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowActual">
  11826. show actual value of the data point
  11827. @return the show actual field value.
  11828. </member>
  11829. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowPercent">
  11830. show value as percentage of total (pie charts only)
  11831. @return the show percent field value.
  11832. </member>
  11833. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsLabelAsPercentage">
  11834. show category label/value as percentage (pie charts only)
  11835. @return the label as percentage field value.
  11836. </member>
  11837. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsSmoothedLine">
  11838. show smooth line
  11839. @return the smoothed line field value.
  11840. </member>
  11841. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowLabel">
  11842. Display category label
  11843. @return the show label field value.
  11844. </member>
  11845. <member name="P:NPOI.HSSF.Record.Chart.SeriesLabelsRecord.IsShowBubbleSizes">
  11846. ??
  11847. @return the show bubble sizes field value.
  11848. </member>
  11849. <member name="T:NPOI.HSSF.Record.Chart.SeriesListRecord">
  11850. * The series list record defines the series Displayed as an overlay to the main chart record.
  11851. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11852. * Remove the record in src/records/definitions.
  11853. * @author Glen Stampoultzis (glens at apache.org)
  11854. </member>
  11855. <member name="M:NPOI.HSSF.Record.Chart.SeriesListRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11856. Constructs a SeriesList record and Sets its fields appropriately.
  11857. @param in the RecordInputstream to Read the record from
  11858. </member>
  11859. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.DataSize">
  11860. Size of record (exluding 4 byte header)
  11861. </member>
  11862. <member name="P:NPOI.HSSF.Record.Chart.SeriesListRecord.SeriesNumbers">
  11863. Get the series numbers field for the SeriesList record.
  11864. </member>
  11865. <member name="T:NPOI.HSSF.Record.Chart.SeriesRecord">
  11866. * The series record describes the overall data for a series.
  11867. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11868. * Remove the record in src/records/definitions.
  11869. * @author Glen Stampoultzis (glens at apache.org)
  11870. </member>
  11871. <member name="M:NPOI.HSSF.Record.Chart.SeriesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11872. Constructs a Series record and Sets its fields appropriately.
  11873. @param in the RecordInputstream to Read the record from
  11874. </member>
  11875. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.DataSize">
  11876. Size of record (exluding 4 byte header)
  11877. </member>
  11878. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.CategoryDataType">
  11879. Get the category data type field for the Series record.
  11880. @return One of
  11881. CATEGORY_DATA_TYPE_DATES
  11882. CATEGORY_DATA_TYPE_NUMERIC
  11883. CATEGORY_DATA_TYPE_SEQUENCE
  11884. CATEGORY_DATA_TYPE_TEXT
  11885. </member>
  11886. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.ValuesDataType">
  11887. Get the values data type field for the Series record.
  11888. @return One of
  11889. VALUES_DATA_TYPE_DATES
  11890. VALUES_DATA_TYPE_NUMERIC
  11891. VALUES_DATA_TYPE_SEQUENCE
  11892. VALUES_DATA_TYPE_TEXT
  11893. </member>
  11894. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumCategories">
  11895. Get the num categories field for the Series record.
  11896. </member>
  11897. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumValues">
  11898. Get the num values field for the Series record.
  11899. </member>
  11900. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.BubbleSeriesType">
  11901. Get the bubble series type field for the Series record.
  11902. @return One of
  11903. BUBBLE_SERIES_TYPE_DATES
  11904. BUBBLE_SERIES_TYPE_NUMERIC
  11905. BUBBLE_SERIES_TYPE_SEQUENCE
  11906. BUBBLE_SERIES_TYPE_TEXT
  11907. </member>
  11908. <member name="P:NPOI.HSSF.Record.Chart.SeriesRecord.NumBubbleValues">
  11909. Get the num bubble values field for the Series record.
  11910. </member>
  11911. <member name="T:NPOI.HSSF.Record.Chart.SeriesTextRecord">
  11912. * Defines a series name
  11913. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11914. * Remove the record in src/records/definitions.
  11915. * @author Andrew C. Oliver (acoliver at apache.org)
  11916. </member>
  11917. <member name="F:NPOI.HSSF.Record.Chart.SeriesTextRecord.MAX_LEN">
  11918. the actual text cannot be longer than 255 characters
  11919. </member>
  11920. <member name="M:NPOI.HSSF.Record.Chart.SeriesTextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11921. Constructs a SeriesText record and Sets its fields appropriately.
  11922. @param in the RecordInputstream to Read the record from
  11923. </member>
  11924. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.DataSize">
  11925. Size of record (exluding 4 byte header)
  11926. </member>
  11927. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Id">
  11928. Get the id field for the SeriesText record.
  11929. </member>
  11930. <member name="P:NPOI.HSSF.Record.Chart.SeriesTextRecord.Text">
  11931. Get the text field for the SeriesText record.
  11932. </member>
  11933. <member name="T:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord">
  11934. * 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)
  11935. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11936. * Remove the record in src/records/definitions.
  11937. * @author Andrew C. Oliver (acoliver at apache.org)
  11938. </member>
  11939. <member name="M:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11940. Constructs a SeriesToChartGroup record and Sets its fields appropriately.
  11941. @param in the RecordInputstream to Read the record from
  11942. </member>
  11943. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.DataSize">
  11944. Size of record (exluding 4 byte header)
  11945. </member>
  11946. <member name="P:NPOI.HSSF.Record.Chart.SeriesToChartGroupRecord.ChartGroupIndex">
  11947. Get the chart Group index field for the SeriesToChartGroup record.
  11948. </member>
  11949. <member name="T:NPOI.HSSF.Record.Chart.SerParentRecord">
  11950. <summary>
  11951. The SerParent record specifies the series to which the current trendline or error bar corresponds.
  11952. </summary>
  11953. <remarks>
  11954. author: Antony liu (antony.apollo at gmail.com)
  11955. </remarks>
  11956. </member>
  11957. <member name="T:NPOI.HSSF.Record.Chart.SerToCrtRecord">
  11958. <summary>
  11959. The SerToCrt record specifies the chart group for the current series.
  11960. </summary>
  11961. </member>
  11962. <member name="M:NPOI.HSSF.Record.Chart.SerToCrtRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11963. Constructs a SeriesChartGroupIndex record and Sets its fields appropriately.
  11964. @param in the RecordInputstream to Read the record from
  11965. </member>
  11966. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.DataSize">
  11967. Size of record (exluding 4 byte header)
  11968. </member>
  11969. <member name="P:NPOI.HSSF.Record.Chart.SerToCrtRecord.ChartGroupIndex">
  11970. Get the chart Group index field for the SeriesChartGroupIndex record.
  11971. </member>
  11972. <member name="T:NPOI.HSSF.Record.Chart.ShapePropsStreamRecord">
  11973. <summary>
  11974. The ShapePropsStream record specifies the shape formatting properties for chart elements.
  11975. These shape formatting properties are a superset of the properties stored in the LineFormat,
  11976. AreaFormat, MarkerFormat, and GelFrame records. They are stored in the rgb field, which is an
  11977. XML stream (section 2.1.7.22), as defined in [ECMA-376] Part 4, section 5.7.2.198.
  11978. </summary>
  11979. <remarks>
  11980. author: Antony liu (antony.apollo at gmail.com)
  11981. </remarks>
  11982. </member>
  11983. <member name="T:NPOI.HSSF.Record.Chart.ShtPropsRecord">
  11984. * Describes a chart sheet properties record.
  11985. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  11986. * Remove the record in src/records/definitions.
  11987. * @author Glen Stampoultzis (glens at apache.org)
  11988. <summary>
  11989. specifies properties of a chart as defined by the Chart Sheet Substream ABNF
  11990. </summary>
  11991. </member>
  11992. <member name="M:NPOI.HSSF.Record.Chart.ShtPropsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  11993. Constructs a SheetProperties record and Sets its fields appropriately.
  11994. @param in the RecordInputstream to Read the record from
  11995. </member>
  11996. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.DataSize">
  11997. Size of record (exluding 4 byte header)
  11998. </member>
  11999. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Flags">
  12000. Get the flags field for the SheetProperties record.
  12001. </member>
  12002. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.Blank">
  12003. Get the empty field for the SheetProperties record.
  12004. @return One of
  12005. EMPTY_NOT_PLOTTED
  12006. EMPTY_ZERO
  12007. EMPTY_INTERPOLATED
  12008. <summary>
  12009. specifies how the empty cells are plotted be a value from the following table:
  12010. 0x00 Empty cells are not plotted.
  12011. 0x01 Empty cells are plotted as zero.
  12012. 0x02 Empty cells are plotted as interpolated.
  12013. </summary>
  12014. </member>
  12015. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManSerAlloc">
  12016. <summary>
  12017. whether series are automatically allocated for the chart.
  12018. </summary>
  12019. </member>
  12020. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsPlotVisibleOnly">
  12021. <summary>
  12022. whether to plot visible cells only.
  12023. </summary>
  12024. </member>
  12025. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsNotSizeWithWindow">
  12026. <summary>
  12027. whether to size the chart with the window.
  12028. </summary>
  12029. </member>
  12030. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsManPlotArea">
  12031. <summary>
  12032. If fAlwaysAutoPlotArea is 1, then this field MUST be 1.
  12033. If fAlwaysAutoPlotArea is 0, then this field MUST be ignored.
  12034. </summary>
  12035. </member>
  12036. <member name="P:NPOI.HSSF.Record.Chart.ShtPropsRecord.IsAlwaysAutoPlotArea">
  12037. <summary>
  12038. specifies whether the default plot area dimension (2) is used.
  12039. 0 Use the default plot area dimension (2) regardless of the Pos record information.
  12040. 1 Use the plot area dimension (2) of the Pos record; and fManPlotArea MUST be 1.
  12041. </summary>
  12042. </member>
  12043. <member name="T:NPOI.HSSF.Record.Chart.StartBlockRecord">
  12044. STARTBLOCK - Chart Future Record Type Start Block (0x0852)<br/>
  12045. @author Patrick Cheng
  12046. </member>
  12047. <member name="T:NPOI.HSSF.Record.Chart.SurfRecord">
  12048. <summary>
  12049. The Surf record specifies that the chart group is a surface chart group and specifies the chart group attributes.
  12050. </summary>
  12051. <remarks>
  12052. author: Antony liu (antony.apollo at gmail.com)
  12053. </remarks>
  12054. </member>
  12055. <member name="T:NPOI.HSSF.Record.Chart.TextPropsStreamRecord">
  12056. <summary>
  12057. The RichTextStream record specifies additional text properties for the text
  12058. in the entire chart, text in the current legend, text in the current legend
  12059. entry, or text in the attached label. These text properties are a superset
  12060. of the properties stored in the Text, Font, FontX, BRAI, and ObjectLink records
  12061. based on the following table, as specified by the Chart Sheet Substream ABNF.
  12062. In each case, the associated Font record is specified by the associated FontX record.
  12063. </summary>
  12064. <remarks>
  12065. author: Antony liu (antony.apollo at gmail.com)
  12066. </remarks>
  12067. </member>
  12068. <member name="T:NPOI.HSSF.Record.Chart.ValueRangeRecord">
  12069. * The value range record defines the range of the value axis.
  12070. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  12071. * Remove the record in src/records/definitions.
  12072. * @author Glen Stampoultzis (glens at apache.org)
  12073. </member>
  12074. <member name="M:NPOI.HSSF.Record.Chart.ValueRangeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12075. Constructs a ValueRange record and Sets its fields appropriately.
  12076. @param in the RecordInputstream to Read the record from
  12077. </member>
  12078. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.DataSize">
  12079. Size of record (exluding 4 byte header)
  12080. </member>
  12081. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinimumAxisValue">
  12082. Get the minimum axis value field for the ValueRange record.
  12083. </member>
  12084. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MaximumAxisValue">
  12085. Get the maximum axis value field for the ValueRange record.
  12086. </member>
  12087. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MajorIncrement">
  12088. Get the major increment field for the ValueRange record.
  12089. </member>
  12090. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.MinorIncrement">
  12091. Get the minor increment field for the ValueRange record.
  12092. </member>
  12093. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.CategoryAxisCross">
  12094. Get the category axis cross field for the ValueRange record.
  12095. </member>
  12096. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.Options">
  12097. Get the options field for the ValueRange record.
  12098. </member>
  12099. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinimum">
  12100. automatic minimum value selected
  12101. @return the automatic minimum field value.
  12102. </member>
  12103. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMaximum">
  12104. automatic maximum value selected
  12105. @return the automatic maximum field value.
  12106. </member>
  12107. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMajor">
  12108. automatic major Unit selected
  12109. @return the automatic major field value.
  12110. </member>
  12111. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticMinor">
  12112. automatic minor Unit selected
  12113. @return the automatic minor field value.
  12114. </member>
  12115. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsAutomaticCategoryCrossing">
  12116. category crossing point is automatically selected
  12117. @return the automatic category crossing field value.
  12118. </member>
  12119. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsLogarithmicScale">
  12120. use logarithmic scale
  12121. @return the logarithmic scale field value.
  12122. </member>
  12123. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsValuesInReverse">
  12124. values are reverses in graph
  12125. @return the values in reverse field value.
  12126. </member>
  12127. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsCrossCategoryAxisAtMaximum">
  12128. category axis to cross at maximum value
  12129. @return the cross category axis at maximum field value.
  12130. </member>
  12131. <member name="P:NPOI.HSSF.Record.Chart.ValueRangeRecord.IsReserved">
  12132. reserved, must equal 1 (excel dev. guide says otherwise)
  12133. @return the reserved field value.
  12134. </member>
  12135. <member name="T:NPOI.HSSF.Record.Chart.YMultRecord">
  12136. <summary>
  12137. The YMult record specifies properties of the value multiplier for a value axis and
  12138. that specifies the beginning of a collection of records as defined by the Chart Sheet
  12139. substream ABNF. The collection of records specifies a display units label.
  12140. </summary>
  12141. <remarks>
  12142. author: Antony liu (antony.apollo at gmail.com)
  12143. </remarks>
  12144. </member>
  12145. <member name="T:NPOI.HSSF.Record.ChartFormatRecord">
  12146. Class ChartFormatRecord
  12147. @author Glen Stampoultzis (glens at apache.org)
  12148. @version %I%, %G%
  12149. </member>
  12150. <member name="M:NPOI.HSSF.Record.ChartFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12151. Constructs a ChartFormatRecord record and Sets its fields appropriately.
  12152. @param in the RecordInputstream to Read the record from
  12153. </member>
  12154. <member name="T:NPOI.HSSF.Record.TextRecord">
  12155. <summary>
  12156. Section [2.4.324]. The Text record specifies the properties of an attached label and specifies the beginning of
  12157. a collection of records as defined by the chart sheet substream ABNF. This collection of records specifies an attached label.
  12158. </summary>
  12159. </member>
  12160. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_LEFT">
  12161. <summary>
  12162. Left-alignment if iReadingOrder specifies left-to-right reading order; otherwise, right-alignment
  12163. </summary>
  12164. </member>
  12165. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_CENTER">
  12166. <summary>
  12167. Center-alignment
  12168. </summary>
  12169. </member>
  12170. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_BOTTOM">
  12171. <summary>
  12172. Right-alignment if iReadingOrder specifies left-to-right reading order; otherwise, left-alignment
  12173. </summary>
  12174. </member>
  12175. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_JUSTIFY">
  12176. <summary>
  12177. Justify-alignment
  12178. </summary>
  12179. </member>
  12180. <member name="F:NPOI.HSSF.Record.TextRecord.HORIZONTAL_ALIGNMENT_DISTRIBUTED">
  12181. <summary>
  12182. distributed alignment
  12183. </summary>
  12184. </member>
  12185. <member name="F:NPOI.HSSF.Record.TextRecord.VERTICAL_ALIGNMENT_DISTRIBUTED">
  12186. <summary>
  12187. distributed alignment
  12188. </summary>
  12189. </member>
  12190. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_TRANSPARENT">
  12191. <summary>
  12192. Transparent background
  12193. </summary>
  12194. </member>
  12195. <member name="F:NPOI.HSSF.Record.TextRecord.DISPLAY_MODE_OPAQUE">
  12196. <summary>
  12197. Opaque background
  12198. </summary>
  12199. </member>
  12200. <member name="M:NPOI.HSSF.Record.TextRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12201. Constructs a Text record and Sets its fields appropriately.
  12202. @param in the RecordInputstream to Read the record from
  12203. </member>
  12204. <member name="P:NPOI.HSSF.Record.TextRecord.DataSize">
  12205. Size of record (exluding 4 byte header)
  12206. </member>
  12207. <member name="P:NPOI.HSSF.Record.TextRecord.HorizontalAlignment">
  12208. Get the horizontal alignment field for the Text record.
  12209. @return One of
  12210. HORIZONTAL_ALIGNMENT_LEFT
  12211. HORIZONTAL_ALIGNMENT_CENTER
  12212. HORIZONTAL_ALIGNMENT_BOTTOM
  12213. HORIZONTAL_ALIGNMENT_JUSTIFY
  12214. </member>
  12215. <member name="P:NPOI.HSSF.Record.TextRecord.VerticalAlignment">
  12216. Get the vertical alignment field for the Text record.
  12217. @return One of
  12218. VERTICAL_ALIGNMENT_TOP
  12219. VERTICAL_ALIGNMENT_CENTER
  12220. VERTICAL_ALIGNMENT_BOTTOM
  12221. VERTICAL_ALIGNMENT_JUSTIFY
  12222. </member>
  12223. <member name="P:NPOI.HSSF.Record.TextRecord.DisplayMode">
  12224. Get the Display mode field for the Text record.
  12225. @return One of
  12226. DISPLAY_MODE_TRANSPARENT
  12227. DISPLAY_MODE_OPAQUE
  12228. </member>
  12229. <member name="P:NPOI.HSSF.Record.TextRecord.RgbColor">
  12230. Get the rgbColor field for the Text record.
  12231. </member>
  12232. <member name="P:NPOI.HSSF.Record.TextRecord.X">
  12233. Get the x field for the Text record.
  12234. </member>
  12235. <member name="P:NPOI.HSSF.Record.TextRecord.Y">
  12236. Get the y field for the Text record.
  12237. </member>
  12238. <member name="P:NPOI.HSSF.Record.TextRecord.Width">
  12239. Set the width field for the Text record.
  12240. </member>
  12241. <member name="P:NPOI.HSSF.Record.TextRecord.Height">
  12242. Get the height field for the Text record.
  12243. </member>
  12244. <member name="P:NPOI.HSSF.Record.TextRecord.Options1">
  12245. Get the options1 field for the Text record.
  12246. </member>
  12247. <member name="P:NPOI.HSSF.Record.TextRecord.IndexOfColorValue">
  12248. Get the index of color value field for the Text record.
  12249. </member>
  12250. <member name="P:NPOI.HSSF.Record.TextRecord.Options2">
  12251. Get the options2 field for the Text record.
  12252. </member>
  12253. <member name="P:NPOI.HSSF.Record.TextRecord.TextRotation">
  12254. Get the text rotation field for the Text record.
  12255. </member>
  12256. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoColor">
  12257. true = automaticly selected colour, false = user-selected
  12258. @return the auto color field value.
  12259. </member>
  12260. <member name="P:NPOI.HSSF.Record.TextRecord.ShowKey">
  12261. true = draw legend
  12262. @return the show key field value.
  12263. </member>
  12264. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValue">
  12265. false = text is category label
  12266. @return the show value field value.
  12267. </member>
  12268. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoGeneratedText">
  12269. @return the auto generated text field value.
  12270. </member>
  12271. <member name="P:NPOI.HSSF.Record.TextRecord.IsGenerated">
  12272. @return the generated field value.
  12273. </member>
  12274. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoLabelDeleted">
  12275. @return the auto label deleted field value.
  12276. </member>
  12277. <member name="P:NPOI.HSSF.Record.TextRecord.IsAutoBackground">
  12278. @return the auto background field value.
  12279. </member>
  12280. <member name="P:NPOI.HSSF.Record.TextRecord.ShowCategoryLabelAsPercentage">
  12281. @return the show category label as percentage field value.
  12282. </member>
  12283. <member name="P:NPOI.HSSF.Record.TextRecord.ShowValueAsPercentage">
  12284. @return the show value as percentage field value.
  12285. </member>
  12286. <member name="P:NPOI.HSSF.Record.TextRecord.ShowBubbleSizes">
  12287. @return the show bubble sizes field value.
  12288. </member>
  12289. <member name="P:NPOI.HSSF.Record.TextRecord.ShowLabel">
  12290. @return the show label field value.
  12291. </member>
  12292. <member name="P:NPOI.HSSF.Record.TextRecord.DataLabelPlacement">
  12293. @return the data label placement field value.
  12294. </member>
  12295. <member name="T:NPOI.HSSF.Record.TickRecord">
  12296. * The Tick record defines how tick marks and label positioning/formatting
  12297. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  12298. * Remove the record in src/records/definitions.
  12299. * @author Andrew C. Oliver(acoliver at apache.org)
  12300. </member>
  12301. <member name="M:NPOI.HSSF.Record.TickRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12302. Constructs a Tick record and Sets its fields appropriately.
  12303. @param in the RecordInputstream to Read the record from
  12304. </member>
  12305. <member name="P:NPOI.HSSF.Record.TickRecord.DataSize">
  12306. Size of record (exluding 4 byte header)
  12307. </member>
  12308. <member name="P:NPOI.HSSF.Record.TickRecord.MajorTickType">
  12309. Get the major tick type field for the Tick record.
  12310. </member>
  12311. <member name="P:NPOI.HSSF.Record.TickRecord.MinorTickType">
  12312. Get the minor tick type field for the Tick record.
  12313. </member>
  12314. <member name="P:NPOI.HSSF.Record.TickRecord.LabelPosition">
  12315. Get the label position field for the Tick record.
  12316. </member>
  12317. <member name="P:NPOI.HSSF.Record.TickRecord.Background">
  12318. Get the background field for the Tick record.
  12319. </member>
  12320. <member name="P:NPOI.HSSF.Record.TickRecord.LabelColorRgb">
  12321. Get the label color rgb field for the Tick record.
  12322. </member>
  12323. <member name="P:NPOI.HSSF.Record.TickRecord.Zero1">
  12324. Get the zero 1 field for the Tick record.
  12325. </member>
  12326. <member name="P:NPOI.HSSF.Record.TickRecord.Zero2">
  12327. Get the zero 2 field for the Tick record.
  12328. </member>
  12329. <member name="P:NPOI.HSSF.Record.TickRecord.Options">
  12330. Get the options field for the Tick record.
  12331. </member>
  12332. <member name="P:NPOI.HSSF.Record.TickRecord.TickColor">
  12333. Get the tick color field for the Tick record.
  12334. </member>
  12335. <member name="P:NPOI.HSSF.Record.TickRecord.Zero3">
  12336. Get the zero 3 field for the Tick record.
  12337. </member>
  12338. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextColor">
  12339. use the quote Unquote automatic color for text
  12340. @return the auto text color field value.
  12341. </member>
  12342. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutoTextBackground">
  12343. use the quote Unquote automatic color for text background
  12344. @return the auto text background field value.
  12345. </member>
  12346. <member name="P:NPOI.HSSF.Record.TickRecord.Rotation">
  12347. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)
  12348. @return the rotation field value.
  12349. </member>
  12350. <member name="P:NPOI.HSSF.Record.TickRecord.IsAutorotate">
  12351. automatically rotate the text
  12352. @return the autorotate field value.
  12353. </member>
  12354. <member name="T:NPOI.HSSF.Record.UnitsRecord">
  12355. * The Units record describes Units.
  12356. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  12357. * Remove the record in src/records/definitions.
  12358. * @author Glen Stampoultzis (glens at apache.org)
  12359. </member>
  12360. <member name="M:NPOI.HSSF.Record.UnitsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12361. Constructs a Units record and Sets its fields appropriately.
  12362. @param in the RecordInputstream to Read the record from
  12363. </member>
  12364. <member name="P:NPOI.HSSF.Record.UnitsRecord.DataSize">
  12365. Size of record (exluding 4 byte header)
  12366. </member>
  12367. <member name="P:NPOI.HSSF.Record.UnitsRecord.Units">
  12368. Get the Units field for the Units record.
  12369. </member>
  12370. <member name="T:NPOI.HSSF.Record.CodepageRecord">
  12371. Title: Codepage Record
  12372. <p>Description: the default characterset. for the workbook</p>
  12373. <p>REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)</p>
  12374. <p>Use {@link CodePageUtil} to turn these values into Java code pages
  12375. to encode/decode strings.</p>
  12376. @version 2.0-pre
  12377. </member>
  12378. <member name="F:NPOI.HSSF.Record.CodepageRecord.CODEPAGE">
  12379. Excel 97+ (Biff 8) should always store strings as UTF-16LE or
  12380. compressed versions of that. As such, this should always be
  12381. 0x4b0 = UTF_16, except for files coming from older versions.
  12382. </member>
  12383. <member name="M:NPOI.HSSF.Record.CodepageRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12384. Constructs a CodepageRecord and Sets its fields appropriately
  12385. @param in the RecordInputstream to Read the record from
  12386. </member>
  12387. <member name="P:NPOI.HSSF.Record.CodepageRecord.Codepage">
  12388. Get the codepage for this workbook
  12389. @see #CODEPAGE
  12390. @return codepage - the codepage to Set
  12391. </member>
  12392. <member name="T:NPOI.HSSF.Record.ColumnInfoRecord">
  12393. Title: COLINFO Record<p/>
  12394. Description: Defines with width and formatting for a range of columns<p/>
  12395. REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  12396. @author Andrew C. Oliver (acoliver at apache dot org)
  12397. @version 2.0-pre
  12398. </member>
  12399. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12400. Constructs a ColumnInfo record and Sets its fields appropriately
  12401. @param in the RecordInputstream to Read the record from
  12402. </member>
  12403. <member name="M:NPOI.HSSF.Record.ColumnInfoRecord.FormatMatches(NPOI.HSSF.Record.ColumnInfoRecord)">
  12404. @return true if the format, options and column width match
  12405. </member>
  12406. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.FirstColumn">
  12407. Get the first column this record defines formatting info for
  12408. @return the first column index (0-based)
  12409. </member>
  12410. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.LastColumn">
  12411. Get the last column this record defines formatting info for
  12412. @return the last column index (0-based)
  12413. </member>
  12414. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.ColumnWidth">
  12415. Get the columns' width in 1/256 of a Char width
  12416. @return column width
  12417. </member>
  12418. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.XFIndex">
  12419. Get the columns' default format info
  12420. @return the extended format index
  12421. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  12422. </member>
  12423. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.Options">
  12424. Get the options bitfield - use the bitSetters instead
  12425. @return the bitfield raw value
  12426. </member>
  12427. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsHidden">
  12428. Get whether or not these cells are hidden
  12429. @return whether the cells are hidden.
  12430. @see #SetOptions(short)
  12431. </member>
  12432. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.OutlineLevel">
  12433. Get the outline level for the cells
  12434. @see #SetOptions(short)
  12435. @return outline level for the cells
  12436. </member>
  12437. <member name="P:NPOI.HSSF.Record.ColumnInfoRecord.IsCollapsed">
  12438. Get whether the cells are collapsed
  12439. @return wether the cells are collapsed
  12440. @see #SetOptions(short)
  12441. </member>
  12442. <member name="T:NPOI.HSSF.Record.Common.FeatFormulaErr2">
  12443. FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part
  12444. This record part specifies Formula Evaluation &amp; Error Ignoring data
  12445. for a sheet, stored as part of a Shared Feature. It can be found in
  12446. records such as {@link FeatRecord}.
  12447. For the full meanings of the flags, see pages 669 and 670
  12448. of the Excel binary file format documentation.
  12449. </member>
  12450. <member name="F:NPOI.HSSF.Record.Common.FeatFormulaErr2.errorCheck">
  12451. What errors we should ignore
  12452. </member>
  12453. <member name="T:NPOI.HSSF.Record.Common.FeatProtection">
  12454. Title: FeatProtection (Protection Shared Feature) common record part
  12455. This record part specifies Protection data for a sheet, stored
  12456. as part of a Shared Feature. It can be found in records such
  12457. as {@link FeatRecord}
  12458. </member>
  12459. <member name="F:NPOI.HSSF.Record.Common.FeatProtection.passwordVerifier">
  12460. 0 means no password. Otherwise indicates the
  12461. password verifier algorithm (same kind as
  12462. {@link PasswordRecord} and
  12463. {@link PasswordRev4Record})
  12464. </member>
  12465. <member name="T:NPOI.HSSF.Record.Common.FeatSmartTag">
  12466. Title: FeatSmartTag (Smart Tag Shared Feature) common record part
  12467. This record part specifies Smart Tag data for a sheet, stored as part
  12468. of a Shared Feature. It can be found in records such as {@link FeatRecord}.
  12469. It is made up of a hash, and a Set of Factoid Data that Makes up
  12470. the smart tags.
  12471. For more details, see page 669 of the Excel binary file
  12472. format documentation.
  12473. </member>
  12474. <member name="T:NPOI.HSSF.Record.Common.FtrHeader">
  12475. Title: FtrHeader (Future Record Header) common record part
  12476. This record part specifies a header for a Ftr (Future)
  12477. style record, which includes extra attributes above and
  12478. beyond those of a traditional record.
  12479. </member>
  12480. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.recordType">
  12481. This MUST match the type on the Containing record
  12482. </member>
  12483. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.grbitFrt">
  12484. This is a FrtFlags
  12485. </member>
  12486. <member name="F:NPOI.HSSF.Record.Common.FtrHeader.reserved">
  12487. MUST be 8 bytes and all zero
  12488. </member>
  12489. <member name="T:NPOI.HSSF.Record.Common.SharedFeature">
  12490. Common Interface for all Shared Features
  12491. </member>
  12492. <member name="T:NPOI.HSSF.Record.UnicodeString">
  12493. Title: Unicode String<p/>
  12494. Description: Unicode String - just standard fields that are in several records.
  12495. It is considered more desirable then repeating it in all of them.<p/>
  12496. This is often called a XLUnicodeRichExtendedString in MS documentation.<p/>
  12497. REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  12498. REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214
  12499. </member>
  12500. <member name="P:NPOI.HSSF.Record.UnicodeString.ExtRst.DataSize">
  12501. Returns our size, excluding our
  12502. 4 byte header
  12503. </member>
  12504. <member name="M:NPOI.HSSF.Record.UnicodeString.Equals(System.Object)">
  12505. Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand
  12506. rich text fields yet it's difficult to make a sound comparison.
  12507. @param o The object to Compare.
  12508. @return true if the object is actually Equal.
  12509. </member>
  12510. <member name="M:NPOI.HSSF.Record.UnicodeString.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12511. construct a unicode string record and fill its fields, ID is ignored
  12512. @param in the RecordInputstream to read the record from
  12513. </member>
  12514. <member name="P:NPOI.HSSF.Record.UnicodeString.CharCount">
  12515. get the number of characters in the string,
  12516. as an un-wrapped int
  12517. @return number of characters
  12518. </member>
  12519. <member name="P:NPOI.HSSF.Record.UnicodeString.OptionFlags">
  12520. Get the option flags which among other things return if this is a 16-bit or
  12521. 8 bit string
  12522. @return optionflags bitmask
  12523. </member>
  12524. <member name="P:NPOI.HSSF.Record.UnicodeString.String">
  12525. @return the actual string this Contains as a java String object
  12526. </member>
  12527. <member name="M:NPOI.HSSF.Record.UnicodeString.AddFormatRun(NPOI.HSSF.Record.UnicodeString.FormatRun)">
  12528. Adds a font run to the formatted string.
  12529. If a font run exists at the current charcter location, then it is
  12530. Replaced with the font run to be Added.
  12531. </member>
  12532. <member name="M:NPOI.HSSF.Record.UnicodeString.SwapFontUse(System.Int16,System.Int16)">
  12533. Swaps all use in the string of one font index
  12534. for use of a different font index.
  12535. Normally only called when fonts have been
  12536. Removed / re-ordered
  12537. </member>
  12538. <member name="M:NPOI.HSSF.Record.UnicodeString.ToString">
  12539. unlike the real records we return the same as "getString()" rather than debug info
  12540. @see #getDebugInfo()
  12541. @return String value of the record
  12542. </member>
  12543. <member name="M:NPOI.HSSF.Record.UnicodeString.GetDebugInfo">
  12544. return a character representation of the fields of this record
  12545. @return String of output for biffviewer etc.
  12546. </member>
  12547. <member name="M:NPOI.HSSF.Record.UnicodeString.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  12548. Serialises out the String. There are special rules
  12549. about where we can and can't split onto
  12550. Continue records.
  12551. </member>
  12552. <member name="T:NPOI.HSSF.Record.ContinueFrt12Record">
  12553. <summary>
  12554. The ContinueFrt12 record specifies a continuation of the data in a preceding Future Record
  12555. Type record that has data longer than 8,224 bytes. Such records are split into several records.
  12556. The first section of the data appears in the base record and subsequent sections appear in
  12557. one or more ContinueFrt12 records that appear after the base record. The preceding base record
  12558. MUST contain a FrtRefHeader or a FrtHeader field.
  12559. </summary>
  12560. <remarks>
  12561. author: Antony liu (antony.apollo at gmail.com)
  12562. </remarks>
  12563. </member>
  12564. <member name="T:NPOI.HSSF.Record.ContinueRecord">
  12565. Title: Continue Record - Helper class used primarily for SST Records
  12566. Description: handles overflow for prior record in the input
  12567. stream; content Is tailored to that prior record
  12568. @author Marc Johnson (mjohnson at apache dot org)
  12569. @author Andrew C. Oliver (acoliver at apache dot org)
  12570. @author Csaba Nagy (ncsaba at yahoo dot com)
  12571. @version 2.0-pre
  12572. </member>
  12573. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor">
  12574. default constructor
  12575. </member>
  12576. <member name="M:NPOI.HSSF.Record.ContinueRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12577. Main constructor -- kinda dummy because we don't validate or fill fields
  12578. @param in the RecordInputstream to Read the record from
  12579. </member>
  12580. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[])">
  12581. Writes the full encoding of a Continue record without making an instance
  12582. </member>
  12583. <member name="M:NPOI.HSSF.Record.ContinueRecord.Write(System.Byte[],System.Int32,System.Nullable{System.Byte},System.Byte[],System.Int32,System.Int32)">
  12584. @param initialDataByte (optional - often used for unicode flag).
  12585. If supplied, this will be written before srcData
  12586. @return the total number of bytes written
  12587. </member>
  12588. <member name="P:NPOI.HSSF.Record.ContinueRecord.Data">
  12589. Get the data for continuation
  12590. @return byte array containing all of the continued data
  12591. </member>
  12592. <member name="M:NPOI.HSSF.Record.ContinueRecord.ToString">
  12593. Debugging toString
  12594. @return string representation
  12595. </member>
  12596. <member name="M:NPOI.HSSF.Record.ContinueRecord.Clone">
  12597. Clone this record.
  12598. </member>
  12599. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecord">
  12600. Common superclass of all records that can produce {@link ContinueRecord}s while being Serialized.
  12601. @author Josh Micich
  12602. </member>
  12603. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  12604. Serializes this record's content to the supplied data output.<br/>
  12605. The standard BIFF header (ushort sid, ushort size) has been handled by the superclass, so
  12606. only BIFF data should be written by this method. Simple data types can be written with the
  12607. standard {@link LittleEndianOutput} methods. Methods from {@link ContinuableRecordOutput}
  12608. can be used to Serialize strings (with {@link ContinueRecord}s being written as required).
  12609. If necessary, implementors can explicitly start {@link ContinueRecord}s (regardless of the
  12610. amount of remaining space).
  12611. @param out a data output stream
  12612. </member>
  12613. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecord.RecordSize">
  12614. @return the total Length of the encoded record(s)
  12615. (Note - if any {@link ContinueRecord} is required, this result includes the
  12616. size of those too)
  12617. </member>
  12618. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordInput">
  12619. A decorated {@link RecordInputStream} that can read primitive data types
  12620. (short, int, long, etc.) spanned across a {@link ContinueRecord } boundary.
  12621. <p>
  12622. Most records construct themselves from {@link RecordInputStream}.
  12623. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary,
  12624. however, it is not always so.
  12625. </p>
  12626. Two attachments to <a href="https://issues.apache.org/bugzilla/Show_bug.cgi?id=50779">Bugzilla 50779</a>
  12627. demonstrate that a CONTINUE break can appear right in between two bytes of a unicode character
  12628. or between two bytes of a <code>short</code>. The problematic portion of the data is
  12629. in a Asian Phonetic Settings Block (ExtRst) of a UnicodeString.
  12630. <p>
  12631. {@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a
  12632. "Not enough data (1) to read requested (2) bytes" exception. The <code>ContinuableRecordInput</code>
  12633. class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.
  12634. </p>
  12635. <p>
  12636. YK: For now (March 2011) this class is only used to read
  12637. @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.
  12638. </p>
  12639. @author Yegor Kozlov
  12640. </member>
  12641. <member name="T:NPOI.HSSF.Record.Cont.ContinuableRecordOutput">
  12642. An augmented {@link LittleEndianOutput} used for serialization of {@link ContinuableRecord}s.
  12643. This class keeps track of how much remaining space is available in the current BIFF record and
  12644. can start new {@link ContinueRecord}s as required.
  12645. @author Josh Micich
  12646. </member>
  12647. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.TotalSize">
  12648. @return total number of bytes written so far (including all BIFF headers)
  12649. </member>
  12650. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.Terminate">
  12651. Terminates the last record (also updates its 'ushort size' field)
  12652. </member>
  12653. <member name="P:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.AvailableSpace">
  12654. @return number of remaining bytes of space in current record
  12655. </member>
  12656. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteContinue">
  12657. Terminates the current record and starts a new {@link ContinueRecord} (regardless
  12658. of how much space is still available in the current record).
  12659. </member>
  12660. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteStringData(System.String)">
  12661. Writes the 'optionFlags' byte and encoded character data of a unicode string. This includes:
  12662. <ul>
  12663. <li>byte optionFlags</li>
  12664. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  12665. </ul>
  12666. Notes:
  12667. <ul>
  12668. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  12669. of <c>text</c></li>
  12670. <li>The string options flag is never separated (by a {@link ContinueRecord}) from the
  12671. first chunk of character data it refers to.</li>
  12672. <li>The 'ushort Length' field is assumed to have been explicitly written earlier. Hence,
  12673. there may be an intervening {@link ContinueRecord}</li>
  12674. </ul>
  12675. </member>
  12676. <member name="M:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.WriteString(System.String,System.Int32,System.Int32)">
  12677. Writes a unicode string complete with header and character data. This includes:
  12678. <ul>
  12679. <li>ushort Length</li>
  12680. <li>byte optionFlags</li>
  12681. <li>ushort numberOfRichTextRuns (optional)</li>
  12682. <li>ushort extendedDataSize (optional)</li>
  12683. <li>encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)</li>
  12684. </ul>
  12685. The following bits of the 'optionFlags' byte will be set as appropriate:
  12686. <table border='1'>
  12687. <tr><th>Mask</th><th>Description</th></tr>
  12688. <tr><td>0x01</td><td>is16bitEncoded</td></tr>
  12689. <tr><td>0x04</td><td>hasExtendedData</td></tr>
  12690. <tr><td>0x08</td><td>isRichText</td></tr>
  12691. </table>
  12692. Notes:
  12693. <ul>
  12694. <li>The value of the 'is16bitEncoded' flag is determined by the actual character data
  12695. of <c>text</c></li>
  12696. <li>The string header fields are never separated (by a {@link ContinueRecord}) from the
  12697. first chunk of character data (i.e. the first character is always encoded in the same
  12698. record as the string header).</li>
  12699. </ul>
  12700. </member>
  12701. <member name="F:NPOI.HSSF.Record.Cont.ContinuableRecordOutput.NOPOutput">
  12702. **
  12703. </member>
  12704. <member name="T:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput">
  12705. Allows the writing of BIFF records when the 'ushort size' header field is not known in advance.
  12706. When the client is finished writing data, it calls {@link #terminate()}, at which point this
  12707. class updates the 'ushort size' with its value.
  12708. @author Josh Micich
  12709. </member>
  12710. <member name="F:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput._dataSizeOutput">
  12711. for writing the 'ushort size' field once its value is known
  12712. </member>
  12713. <member name="P:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.TotalSize">
  12714. includes 4 byte header
  12715. </member>
  12716. <member name="M:NPOI.HSSF.Record.Cont.UnknownLengthRecordOutput.Terminate">
  12717. Finishes writing the current record and updates 'ushort size' field.<br/>
  12718. After this method is called, only {@link #getTotalSize()} may be called.
  12719. </member>
  12720. <member name="T:NPOI.HSSF.Record.CountryRecord">
  12721. Title: Country Record (aka WIN.INI country)
  12722. Description: used for localization. Currently HSSF always Sets this to 1
  12723. and it seems to work fine even in Germany. (es geht's auch fuer Deutschland)
  12724. REFERENCE: PG 298 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12725. @author Andrew C. Oliver (acoliver at apache dot org)
  12726. @version 2.0-pre
  12727. </member>
  12728. <member name="M:NPOI.HSSF.Record.CountryRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12729. Constructs a CountryRecord and Sets its fields appropriately
  12730. @param in the RecordInputstream to Read the record from
  12731. </member>
  12732. <member name="P:NPOI.HSSF.Record.CountryRecord.DefaultCountry">
  12733. Gets the default country
  12734. @return country ID (1 = US)
  12735. </member>
  12736. <member name="P:NPOI.HSSF.Record.CountryRecord.CurrentCountry">
  12737. Gets the current country
  12738. @return country ID (1 = US)
  12739. </member>
  12740. <member name="T:NPOI.HSSF.Record.CRNCountRecord">
  12741. XCT ?CRN Count
  12742. REFERENCE: 5.114
  12743. @author Josh Micich
  12744. </member>
  12745. <member name="P:NPOI.HSSF.Record.CRNCountRecord.Sid">
  12746. return the non static version of the id for this record.
  12747. </member>
  12748. <member name="T:NPOI.HSSF.Record.CRNRecord">
  12749. Title: CRN
  12750. Description: This record stores the contents of an external cell or cell range
  12751. REFERENCE: 5.23
  12752. @author josh micich
  12753. </member>
  12754. <member name="P:NPOI.HSSF.Record.CRNRecord.Sid">
  12755. return the non static version of the id for this record.
  12756. </member>
  12757. <member name="T:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream">
  12758. @author Josh Micich
  12759. </member>
  12760. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadRecordSID">
  12761. Reads an unsigned short value without decrypting
  12762. </member>
  12763. <member name="M:NPOI.HSSF.Record.Crypto.Biff8DecryptingStream.ReadDataSize">
  12764. Reads an unsigned short value without decrypting
  12765. </member>
  12766. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Create(System.Byte[])">
  12767. Create using the default password and a specified docId
  12768. @param docId 16 bytes
  12769. </member>
  12770. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.Validate(System.Byte[],System.Byte[])">
  12771. @return <c>true</c> if the keyDigest is compatible with the specified saltData and saltHash
  12772. </member>
  12773. <member name="M:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CreateRC4(System.Int32)">
  12774. The {@link RC4} instance needs to be Changed every 1024 bytes.
  12775. @param keyBlockNo used to seed the newly Created {@link RC4}
  12776. </member>
  12777. <member name="F:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey._userPasswordTLS">
  12778. Stores the BIFF8 encryption/decryption password for the current thread. This has been done
  12779. using a {@link ThreadLocal} in order to avoid further overloading the various public APIs
  12780. (e.g. {@link HSSFWorkbook}) that need this functionality.
  12781. </member>
  12782. <member name="P:NPOI.HSSF.Record.Crypto.Biff8EncryptionKey.CurrentUserPassword">
  12783. @return the BIFF8 encryption/decryption password for the current thread.
  12784. <code>null</code> if it is currently unSet.
  12785. </member>
  12786. <member name="T:NPOI.HSSF.Record.Crypto.Biff8RC4">
  12787. Used for both encrypting and decrypting BIFF8 streams. The internal
  12788. {@link RC4} instance is renewed (re-keyed) every 1024 bytes.
  12789. @author Josh Micich
  12790. </member>
  12791. <member name="F:NPOI.HSSF.Record.Crypto.Biff8RC4._streamPos">
  12792. This field is used to keep track of when to change the {@link RC4}
  12793. instance. The change occurs every 1024 bytes. Every byte passed over is
  12794. counted.
  12795. </member>
  12796. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.IsNeverEncryptedRecord(System.Int32)">
  12797. TODO: Additionally, the lbPlyPos (position_of_BOF) field of the BoundSheet8 record MUST NOT be encrypted.
  12798. @return <c>true</c> if record type specified by <c>sid</c> is never encrypted
  12799. </member>
  12800. <member name="M:NPOI.HSSF.Record.Crypto.Biff8RC4.SkipTwoBytes">
  12801. Used when BIFF header fields (sid, size) are being Read. The internal
  12802. {@link RC4} instance must step even when unencrypted bytes are read
  12803. </member>
  12804. <member name="T:NPOI.HSSF.Record.Crypto.RC4">
  12805. Simple implementation of the alleged RC4 algorithm.
  12806. Inspired by <A HREF="http://en.wikipedia.org/wiki/RC4">wikipedia's RC4 article</A>
  12807. @author Josh Micich
  12808. </member>
  12809. <member name="P:NPOI.HSSF.Record.CustomField.Size">
  12810. @return The size of this field in bytes. This operation Is not valid
  12811. Until after the call to <c>FillField()</c>
  12812. </member>
  12813. <member name="M:NPOI.HSSF.Record.CustomField.FillField(NPOI.HSSF.Record.RecordInputStream)">
  12814. Populates this fields data from the byte array passed in1.
  12815. @param in the RecordInputstream to Read the record from
  12816. </member>
  12817. <member name="M:NPOI.HSSF.Record.CustomField.ToString(System.Text.StringBuilder)">
  12818. Appends the string representation of this field to the supplied
  12819. StringBuilder.
  12820. @param str The string buffer to Append to.
  12821. </member>
  12822. <member name="M:NPOI.HSSF.Record.CustomField.SerializeField(System.Int32,System.Byte[])">
  12823. Converts this field to it's byte array form.
  12824. @param offset The offset into the byte array to start writing to.
  12825. @param data The data array to Write to.
  12826. @return The number of bytes written.
  12827. </member>
  12828. <member name="T:NPOI.HSSF.Record.DateWindow1904Record">
  12829. Title: Date Window 1904 Flag record
  12830. Description: Flag specifying whether 1904 date windowing Is used.
  12831. (tick toc tick toc...BOOM!)
  12832. REFERENCE: PG 280 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12833. @author Andrew C. Oliver (acoliver at apache dot org)
  12834. @version 2.0-pre
  12835. </member>
  12836. <member name="M:NPOI.HSSF.Record.DateWindow1904Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12837. Constructs a DateWindow1904 record and Sets its fields appropriately.
  12838. @param in the RecordInputstream to Read the record from
  12839. </member>
  12840. <member name="P:NPOI.HSSF.Record.DateWindow1904Record.Windowing">
  12841. Gets whether or not to use 1904 date windowing (which means you'll be screwed in 2004)
  12842. @return window flag - 0/1 (false,true)
  12843. </member>
  12844. <member name="T:NPOI.HSSF.Record.DBCellRecord">
  12845. Title: DBCell Record
  12846. Description: Used by Excel and other MS apps to quickly Find rows in the sheets.
  12847. REFERENCE: PG 299/440 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12848. @author Andrew C. Oliver (acoliver at apache dot org)
  12849. @author Jason Height
  12850. @version 2.0-pre
  12851. </member>
  12852. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12853. Constructs a DBCellRecord and Sets its fields appropriately
  12854. @param in the RecordInputstream to Read the record from
  12855. </member>
  12856. <member name="M:NPOI.HSSF.Record.DBCellRecord.#ctor(System.Int32,System.Int16[])">
  12857. offset from the start of this DBCellRecord to the start of the first cell in
  12858. the next DBCell block.
  12859. </member>
  12860. <member name="P:NPOI.HSSF.Record.DBCellRecord.RowOffset">
  12861. Gets offset from the start of this DBCellRecord to the start of the first cell in
  12862. the next DBCell block.
  12863. @return rowoffset to the start of the first cell in the next DBCell block
  12864. </member>
  12865. <member name="M:NPOI.HSSF.Record.DBCellRecord.GetCellOffsetAt(System.Int32)">
  12866. return the cell offset in the array
  12867. @param index of the cell offset to retrieve
  12868. @return celloffset from the celloffset array
  12869. </member>
  12870. <member name="P:NPOI.HSSF.Record.DBCellRecord.NumCellOffsets">
  12871. Get the number of cell offsets in the celloffset array
  12872. @return number of cell offsets
  12873. </member>
  12874. <member name="M:NPOI.HSSF.Record.DBCellRecord.CalculateSizeOfRecords(System.Int32,System.Int32)">
  12875. @returns the size of the Group of <c>DBCellRecord</c>s needed to encode
  12876. the specified number of blocks and rows
  12877. </member>
  12878. <member name="T:NPOI.HSSF.Record.DConRefRecord">
  12879. DConRef records specify a range in a workbook (internal or external) that serves as a data source
  12880. for pivot tables or data consolidation.
  12881. Represents a <code>DConRef</code> Structure
  12882. <a href="http://msdn.microsoft.com/en-us/library/dd923854(office.12).aspx">[MS-XLS s.
  12883. 2.4.86]</a>, and the contained <code>DConFile</code> structure
  12884. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  12885. [MS-XLS s. 2.5.69]</a>. This in turn contains a <code>XLUnicodeStringNoCch</code>
  12886. <a href="http://msdn.microsoft.com/en-us/library/dd910585(office.12).aspx">
  12887. [MS-XLS s. 2.5.296]</a>.
  12888. <pre>
  12889. _______________________________
  12890. | DConRef |
  12891. (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  12892. | ref |cch| stFile | un|
  12893. +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
  12894. |
  12895. _________|_____________________
  12896. |DConFile / XLUnicodeStringNoCch|
  12897. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  12898. (bits) |h| reserved | rgb |
  12899. +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
  12900. </pre>
  12901. Where
  12902. <ul>
  12903. <li><code>DConFile.h = 0x00</code> if the characters in<code>rgb</code> are single byte, and
  12904. <code>DConFile.h = 0x01</code> if they are double byte. <br/>
  12905. If they are double byte, then<br/>
  12906. <ul>
  12907. <li> If it exists, the length of <code>DConRef.un = 2</code>. Otherwise it is 1.</li>
  12908. <li> The length of <code>DConFile.rgb = (2 * DConRef.cch)</code>. Otherwise it is equal to
  12909. <code>DConRef.cch</code></li>.
  12910. </ul>
  12911. </li>
  12912. <li><code>DConRef.rgb</code> starts with <code>0x01</code> if it is an external reference,
  12913. and with <code>0x02</code> if it is a self-reference.</li>
  12914. </ul>
  12915. At the moment this class is read-only.
  12916. @author Niklas Rehfeld
  12917. </member>
  12918. <member name="F:NPOI.HSSF.Record.DConRefRecord.sid">
  12919. The id of the record type,
  12920. <code>sid = {@value}</code>
  12921. </member>
  12922. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstRow">
  12923. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12924. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12925. [MS XLS s.2.5.211]</a>
  12926. </member>
  12927. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastRow">
  12928. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12929. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12930. [MS XLS s.2.5.211]</a>
  12931. </member>
  12932. <member name="F:NPOI.HSSF.Record.DConRefRecord.firstCol">
  12933. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12934. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12935. [MS XLS s.2.5.211]</a>
  12936. </member>
  12937. <member name="F:NPOI.HSSF.Record.DConRefRecord.lastCol">
  12938. A RefU structure specifying the range of cells if this record is part of an SXTBL.
  12939. <a href="http://msdn.microsoft.com/en-us/library/dd920420(office.12).aspx">
  12940. [MS XLS s.2.5.211]</a>
  12941. </member>
  12942. <member name="F:NPOI.HSSF.Record.DConRefRecord.charCount">
  12943. the number of chars in the link
  12944. </member>
  12945. <member name="F:NPOI.HSSF.Record.DConRefRecord.charType">
  12946. the type of characters (single or double byte)
  12947. </member>
  12948. <member name="F:NPOI.HSSF.Record.DConRefRecord.path">
  12949. The link's path string. This is the <code>rgb</code> field of a
  12950. <code>XLUnicodeStringNoCch</code>. Therefore it will contain at least one leading special
  12951. character (0x01 or 0x02) and probably other ones.<p/>
  12952. @see <a href="http://msdn.microsoft.com/en-us/library/dd923491(office.12).aspx">
  12953. DConFile [MS-XLS s. 2.5.77]</a> and
  12954. <a href="http://msdn.microsoft.com/en-us/library/dd950157(office.12).aspx">
  12955. VirtualPath [MS-XLS s. 2.5.69]</a>
  12956. <p/>
  12957. </member>
  12958. <member name="F:NPOI.HSSF.Record.DConRefRecord._unused">
  12959. unused bits at the end, must be set to 0.
  12960. </member>
  12961. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(System.Byte[])">
  12962. Read constructor.
  12963. @param data byte array containing a DConRef Record, including the header.
  12964. </member>
  12965. <member name="M:NPOI.HSSF.Record.DConRefRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  12966. Read Constructor.
  12967. @param inStream RecordInputStream containing a DConRefRecord structure.
  12968. </member>
  12969. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstColumn">
  12970. @return The first column of the range.
  12971. </member>
  12972. <member name="P:NPOI.HSSF.Record.DConRefRecord.FirstRow">
  12973. @return The first row of the range.
  12974. </member>
  12975. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastColumn">
  12976. @return The last column of the range.
  12977. </member>
  12978. <member name="P:NPOI.HSSF.Record.DConRefRecord.LastRow">
  12979. @return The last row of the range.
  12980. </member>
  12981. <member name="M:NPOI.HSSF.Record.DConRefRecord.GetPath">
  12982. @return raw path byte array.
  12983. </member>
  12984. <member name="P:NPOI.HSSF.Record.DConRefRecord.ReadablePath">
  12985. @return the link's path, with the special characters stripped/replaced. May be null.
  12986. See MS-XLS 2.5.277 (VirtualPath)
  12987. </member>
  12988. <member name="P:NPOI.HSSF.Record.DConRefRecord.IsExternalRef">
  12989. Checks if the data source in this reference record is external to this sheet or internal.
  12990. @return true iff this is an external reference.
  12991. </member>
  12992. <member name="T:NPOI.HSSF.Record.DefaultColWidthRecord">
  12993. Title: Default Column Width Record
  12994. Description: Specifies the default width for columns that have no specific
  12995. width Set.
  12996. REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  12997. @author Andrew C. Oliver (acoliver at apache dot org)
  12998. @author Jason Height (jheight at chariot dot net dot au)
  12999. @version 2.0-pre
  13000. </member>
  13001. <member name="F:NPOI.HSSF.Record.DefaultColWidthRecord.DEFAULT_COLUMN_WIDTH">
  13002. The default column width is 8 characters
  13003. </member>
  13004. <member name="M:NPOI.HSSF.Record.DefaultColWidthRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13005. Constructs a DefaultColumnWidth record and Sets its fields appropriately.
  13006. @param in the RecordInputstream to Read the record from
  13007. </member>
  13008. <member name="P:NPOI.HSSF.Record.DefaultColWidthRecord.ColWidth">
  13009. Get the default column width
  13010. @return defaultwidth for columns
  13011. </member>
  13012. <member name="T:NPOI.HSSF.Record.DefaultRowHeightRecord">
  13013. Title: Default Row Height Record
  13014. Description: Row height for rows with Undefined or not explicitly defined
  13015. heights.
  13016. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13017. @author Andrew C. Oliver (acoliver at apache dot org)
  13018. @author Jason Height (jheight at chariot dot net dot au)
  13019. @version 2.0-pre
  13020. </member>
  13021. <member name="F:NPOI.HSSF.Record.DefaultRowHeightRecord.DEFAULT_ROW_HEIGHT">
  13022. The default row height for empty rows is 255 twips (255 / 20 == 12.75 points)
  13023. </member>
  13024. <member name="M:NPOI.HSSF.Record.DefaultRowHeightRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13025. <summary>
  13026. Constructs a DefaultRowHeight record and Sets its fields appropriately.
  13027. </summary>
  13028. <param name="in1">the RecordInputstream to Read the record from</param>
  13029. </member>
  13030. <member name="P:NPOI.HSSF.Record.DefaultRowHeightRecord.RowHeight">
  13031. <summary>
  13032. Get the default row height
  13033. </summary>
  13034. </member>
  13035. <member name="T:NPOI.HSSF.Record.DeltaRecord">
  13036. Title: Delta Record
  13037. Description: controls the accuracy of the calculations
  13038. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13039. @author Andrew C. Oliver (acoliver at apache dot org)
  13040. @author Jason Height (jheight at chariot dot net dot au)
  13041. @version 2.0-pre
  13042. </member>
  13043. <member name="M:NPOI.HSSF.Record.DeltaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13044. Constructs a Delta record and Sets its fields appropriately.
  13045. @param in the RecordInputstream to Read the record from
  13046. </member>
  13047. <member name="P:NPOI.HSSF.Record.DeltaRecord.MaxChange">
  13048. Get the maximum Change
  13049. @return maxChange - maximum rounding error
  13050. </member>
  13051. <member name="T:NPOI.HSSF.Record.DimensionsRecord">
  13052. Title: Dimensions Record
  13053. Description: provides the minumum and maximum bounds
  13054. of a sheet.
  13055. REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13056. @author Andrew C. Oliver (acoliver at apache dot org)
  13057. @author Jason Height (jheight at chariot dot net dot au)
  13058. @version 2.0-pre
  13059. </member>
  13060. <member name="M:NPOI.HSSF.Record.DimensionsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13061. Constructs a Dimensions record and Sets its fields appropriately.
  13062. @param in the RecordInputstream to Read the record from
  13063. </member>
  13064. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstRow">
  13065. Get the first row number for the sheet
  13066. @return row - first row on the sheet
  13067. </member>
  13068. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastRow">
  13069. Get the last row number for the sheet
  13070. @return row - last row on the sheet
  13071. </member>
  13072. <member name="P:NPOI.HSSF.Record.DimensionsRecord.FirstCol">
  13073. Get the first column number for the sheet
  13074. @return column - first column on the sheet
  13075. </member>
  13076. <member name="P:NPOI.HSSF.Record.DimensionsRecord.LastCol">
  13077. Get the last col number for the sheet
  13078. @return column - last column on the sheet
  13079. </member>
  13080. <member name="M:NPOI.HSSF.Record.DrawingGroupRecord.ProcessChildRecords">
  13081. Process the bytes into escher records.
  13082. (Not done by default in case we break things,
  13083. Unless you Set the "poi.deSerialize.escher"
  13084. system property)
  13085. </member>
  13086. <member name="P:NPOI.HSSF.Record.DrawingGroupRecord.RecordSize">
  13087. Size of record (including 4 byte headers for all sections)
  13088. </member>
  13089. <member name="T:NPOI.HSSF.Record.DrawingRecord">
  13090. DrawingRecord (0x00EC)<p/>
  13091. </member>
  13092. <member name="M:NPOI.HSSF.Record.DrawingRecord.Clone">
  13093. Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed
  13094. @return cloned drawing records
  13095. </member>
  13096. <member name="T:NPOI.HSSF.Record.DrawingRecordForBiffViewer">
  13097. This Is purely for the biff viewer. During normal operations we don't want
  13098. to be seeing this.
  13099. </member>
  13100. <member name="T:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID">
  13101. <summary>
  13102. specifies the header for an entry in a property table
  13103. </summary>
  13104. </member>
  13105. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.OpId">
  13106. <summary>
  13107. specifies the identifier of the property in this entry.
  13108. </summary>
  13109. </member>
  13110. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.IsBlipId">
  13111. <summary>
  13112. whether the value in the op field is a BLIP identifier.
  13113. If this value equals 0x1, the value in the op field specifies the BLIP identifier
  13114. in the OfficeArtBStoreContainer record, as defined in section 2.2.20. If fComplex equals 0x1, this bit MUST be ignored.
  13115. </summary>
  13116. </member>
  13117. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtFOPTEOPID.IsComplex">
  13118. <summary>
  13119. specifies whether this property is a complex property.
  13120. If this value equals 0x1, the op field specifies the size of the data for this property, rather than the property data itself.
  13121. </summary>
  13122. </member>
  13123. <member name="T:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader">
  13124. <summary>
  13125. specifies the common record header for all the OfficeArt records.
  13126. </summary>
  13127. <remarks>
  13128. author: Antony liu (antony.apollo at gmail.com)
  13129. </remarks>
  13130. </member>
  13131. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Ver">
  13132. <summary>
  13133. specifies the version if the record is an atom. If the record is a container, this field MUST contain 0xF.
  13134. </summary>
  13135. </member>
  13136. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Instance">
  13137. <summary>
  13138. An unsigned integer that differentiates an atom from the other atoms that are contained in the record.
  13139. </summary>
  13140. </member>
  13141. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Type">
  13142. <summary>
  13143. specifies the type of the record. This value MUST be from 0xF000 through 0xFFFF, inclusive.
  13144. </summary>
  13145. </member>
  13146. <member name="P:NPOI.HSSF.Record.Drawing.OfficeArtRecordHeader.Len">
  13147. <summary>
  13148. that specifies the length, in bytes, of the record.
  13149. If the record is an atom, this value specifies the length of the atom, excluding the header.
  13150. If the record is a container, this value specifies the sum of the lengths of the atoms that
  13151. the record contains, plus the length of the record header for each atom.
  13152. </summary>
  13153. </member>
  13154. <member name="T:NPOI.HSSF.Record.DSFRecord">
  13155. Title: double Stream Flag Record
  13156. Description: tells if this Is a double stream file. (always no for HSSF generated files)
  13157. double Stream files contain both BIFF8 and BIFF7 workbooks.
  13158. REFERENCE: PG 305 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13159. @author Andrew C. Oliver (acoliver at apache dot org)
  13160. @version 2.0-pre
  13161. </member>
  13162. <member name="M:NPOI.HSSF.Record.DSFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13163. Constructs a DBCellRecord and Sets its fields appropriately.
  13164. @param in the RecordInputstream to Read the record from
  13165. </member>
  13166. <member name="T:NPOI.HSSF.Record.DVALRecord">
  13167. Title: DATAVALIDATIONS Record
  13168. Description: used in data validation ;
  13169. This record Is the list header of all data validation records (0x01BE) in the current sheet.
  13170. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  13171. </member>
  13172. <member name="F:NPOI.HSSF.Record.DVALRecord.field_1_options">
  13173. Options of the DVAL
  13174. </member>
  13175. <member name="F:NPOI.HSSF.Record.DVALRecord.field_2_horiz_pos">
  13176. Horizontal position of the dialog
  13177. </member>
  13178. <member name="F:NPOI.HSSF.Record.DVALRecord.field_3_vert_pos">
  13179. Vertical position of the dialog
  13180. </member>
  13181. <member name="F:NPOI.HSSF.Record.DVALRecord.field_cbo_id">
  13182. Object ID of the drop down arrow object for list boxes ;
  13183. in our case this will be always FFFF , Until
  13184. MSODrawingGroup and MSODrawing records are implemented
  13185. </member>
  13186. <member name="F:NPOI.HSSF.Record.DVALRecord.field_5_dv_no">
  13187. Number of following DV Records
  13188. </member>
  13189. <member name="M:NPOI.HSSF.Record.DVALRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13190. Constructs a DVAL record and Sets its fields appropriately.
  13191. @param in the RecordInputstream to Read the record from
  13192. </member>
  13193. <member name="P:NPOI.HSSF.Record.DVALRecord.Options">
  13194. @return the field_1_options
  13195. </member>
  13196. <member name="P:NPOI.HSSF.Record.DVALRecord.HorizontalPos">
  13197. @return the Horizontal position of the dialog
  13198. </member>
  13199. <member name="P:NPOI.HSSF.Record.DVALRecord.VerticalPos">
  13200. @return the the Vertical position of the dialog
  13201. </member>
  13202. <member name="P:NPOI.HSSF.Record.DVALRecord.ObjectID">
  13203. Get Object ID of the drop down arrow object for list boxes
  13204. </member>
  13205. <member name="P:NPOI.HSSF.Record.DVALRecord.DVRecNo">
  13206. Get number of following DV records
  13207. </member>
  13208. <member name="T:NPOI.HSSF.Record.DVRecord">
  13209. Title: DATAVALIDATION Record (0x01BE)<p/>
  13210. Description: This record stores data validation Settings and a list of cell ranges
  13211. which contain these Settings. The data validation Settings of a sheet
  13212. are stored in a sequential list of DV records. This list Is followed by
  13213. DVAL record(s)
  13214. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  13215. @version 2.0-pre
  13216. </member>
  13217. <member name="F:NPOI.HSSF.Record.DVRecord._option_flags">
  13218. Option flags
  13219. </member>
  13220. <member name="F:NPOI.HSSF.Record.DVRecord._promptTitle">
  13221. Title of the prompt box
  13222. </member>
  13223. <member name="F:NPOI.HSSF.Record.DVRecord._errorTitle">
  13224. Title of the error box
  13225. </member>
  13226. <member name="F:NPOI.HSSF.Record.DVRecord._promptText">
  13227. Text of the prompt box
  13228. </member>
  13229. <member name="F:NPOI.HSSF.Record.DVRecord._errorText">
  13230. Text of the error box
  13231. </member>
  13232. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_1">
  13233. Not used - Excel seems to always write 0x3FE0
  13234. </member>
  13235. <member name="F:NPOI.HSSF.Record.DVRecord._formula1">
  13236. Formula data for first condition (RPN token array without size field)
  13237. </member>
  13238. <member name="F:NPOI.HSSF.Record.DVRecord._not_used_2">
  13239. Not used - Excel seems to always write 0x0000
  13240. </member>
  13241. <member name="F:NPOI.HSSF.Record.DVRecord._formula2">
  13242. Formula data for second condition (RPN token array without size field)
  13243. </member>
  13244. <member name="F:NPOI.HSSF.Record.DVRecord._regions">
  13245. Cell range address list with all affected ranges
  13246. </member>
  13247. <member name="F:NPOI.HSSF.Record.DVRecord.opt_data_type">
  13248. Option flags field
  13249. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13250. </member>
  13251. <member name="M:NPOI.HSSF.Record.DVRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13252. Constructs a DV record and Sets its fields appropriately.
  13253. @param in the RecordInputstream to Read the record from
  13254. </member>
  13255. <member name="M:NPOI.HSSF.Record.DVRecord.ResolveTitleText(System.String)">
  13256. When entered via the UI, Excel translates empty string into "\0"
  13257. While it is possible to encode the title/text as empty string (Excel doesn't exactly crash),
  13258. the resulting tool-tip text / message box looks wrong. It is best to do the same as the
  13259. Excel UI and encode 'not present' as "\0".
  13260. </member>
  13261. <member name="P:NPOI.HSSF.Record.DVRecord.DataType">
  13262. Get the condition data type
  13263. @return the condition data type
  13264. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13265. </member>
  13266. <member name="P:NPOI.HSSF.Record.DVRecord.ErrorStyle">
  13267. Get the condition error style
  13268. @return the condition error style
  13269. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13270. </member>
  13271. <member name="P:NPOI.HSSF.Record.DVRecord.ListExplicitFormula">
  13272. return true if in list validations the string list Is explicitly given in the formula, false otherwise
  13273. @return true if in list validations the string list Is explicitly given in the formula, false otherwise
  13274. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13275. </member>
  13276. <member name="P:NPOI.HSSF.Record.DVRecord.EmptyCellAllowed">
  13277. return true if empty values are allowed in cells, false otherwise
  13278. @return if empty values are allowed in cells, false otherwise
  13279. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13280. </member>
  13281. <member name="P:NPOI.HSSF.Record.DVRecord.SuppressDropdownArrow">
  13282. @return <code>true</code> if drop down arrow should be suppressed when list validation is
  13283. used, <code>false</code> otherwise
  13284. </member>
  13285. <member name="P:NPOI.HSSF.Record.DVRecord.ShowPromptOnCellSelected">
  13286. return true if a prompt window should appear when cell Is selected, false otherwise
  13287. @return if a prompt window should appear when cell Is selected, false otherwise
  13288. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13289. </member>
  13290. <member name="P:NPOI.HSSF.Record.DVRecord.ShowErrorOnInvalidValue">
  13291. return true if an error window should appear when an invalid value Is entered in the cell, false otherwise
  13292. @return if an error window should appear when an invalid value Is entered in the cell, false otherwise
  13293. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13294. </member>
  13295. <member name="P:NPOI.HSSF.Record.DVRecord.ConditionOperator">
  13296. Get the condition operator
  13297. @return the condition operator
  13298. @see org.apache.poi.hssf.util.HSSFDataValidation utility class
  13299. </member>
  13300. <member name="P:NPOI.HSSF.Record.DVRecord.OptionFlags">
  13301. Gets the option flags field.
  13302. @return options - the option flags field
  13303. </member>
  13304. <member name="M:NPOI.HSSF.Record.DVRecord.Clone">
  13305. Clones the object. Uses serialisation, as the
  13306. contents are somewhat complex
  13307. </member>
  13308. <member name="T:NPOI.HSSF.Record.EOFRecord">
  13309. End Of File record.
  13310. Description: Marks the end of records belonging to a particular object in the
  13311. HSSF File
  13312. REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13313. @author Andrew C. Oliver (acoliver at apache dot org)
  13314. @author Jason Height (jheight at chariot dot net dot au)
  13315. @version 2.0-pre
  13316. </member>
  13317. <member name="M:NPOI.HSSF.Record.EOFRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13318. Constructs a EOFRecord record and Sets its fields appropriately.
  13319. @param in the RecordInputstream to Read the record from
  13320. </member>
  13321. <member name="T:NPOI.HSSF.Record.EscherAggregate">
  13322. This class Is used to aggregate the MSODRAWING and OBJ record
  13323. combinations. This Is necessary due to the bizare way in which
  13324. these records are Serialized. What happens Is that you Get a
  13325. combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records
  13326. but the escher records are Serialized _across_ the MSODRAWING
  13327. records.
  13328. It Gets even worse when you start looking at TXO records.
  13329. So what we do with this class Is aggregate lazily. That Is
  13330. we don't aggregate the MSODRAWING -> OBJ records Unless we
  13331. need to modify them.
  13332. At first document contains 4 types of records which belong to drawing layer.
  13333. There are can be such sequence of record:
  13334. <p/>
  13335. DrawingRecord
  13336. ContinueRecord
  13337. ...
  13338. ContinueRecord
  13339. ObjRecord | TextObjectRecord
  13340. .....
  13341. ContinueRecord
  13342. ...
  13343. ContinueRecord
  13344. ObjRecord | TextObjectRecord
  13345. NoteRecord
  13346. ...
  13347. NoteRecord
  13348. <p/>
  13349. To work with shapes we have to read data from Drawing and Continue records into single array of bytes and
  13350. build escher(office art) records tree from this array.
  13351. Each shape in drawing layer matches corresponding ObjRecord
  13352. Each textbox matches corresponding TextObjectRecord
  13353. <p/>
  13354. ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)
  13355. <p/>
  13356. EscherAggrefate contains also NoteRecords
  13357. NoteRecords must be serial
  13358. @author Glen Stampoultzis (glens at apache.org)
  13359. </member>
  13360. <member name="F:NPOI.HSSF.Record.EscherAggregate.shapeToObj">
  13361. Maps shape container objects to their OBJ records
  13362. </member>
  13363. <member name="F:NPOI.HSSF.Record.EscherAggregate.tailRec">
  13364. list of "tail" records that need to be Serialized after all drawing Group records
  13365. </member>
  13366. <member name="P:NPOI.HSSF.Record.EscherAggregate.Sid">
  13367. @return Returns the current sid.
  13368. </member>
  13369. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToString">
  13370. Calculates the string representation of this record. This Is
  13371. simply a dump of all the records.
  13372. </member>
  13373. <member name="M:NPOI.HSSF.Record.EscherAggregate.ToXml(System.String)">
  13374. Calculates the xml representation of this record. This is
  13375. simply a dump of all the records.
  13376. @param tab - string which must be added before each line (used by default '\t')
  13377. @return xml representation of the all aggregated records
  13378. </member>
  13379. <member name="M:NPOI.HSSF.Record.EscherAggregate.IsDrawingLayerRecord(System.Int16)">
  13380. @param sid - record sid we want to check if it belongs to drawing layer
  13381. @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord
  13382. </member>
  13383. <member name="M:NPOI.HSSF.Record.EscherAggregate.CreateAggregate(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  13384. Collapses the drawing records into an aggregate.
  13385. read Drawing, Obj, TxtObj, Note and Continue records into single byte array,
  13386. create Escher tree from byte array, create map &lt;EscherRecord, Record&gt;
  13387. @param records - list of all records inside sheet
  13388. @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet
  13389. @return new EscherAggregate create from all aggregated records which belong to drawing layer
  13390. </member>
  13391. <member name="M:NPOI.HSSF.Record.EscherAggregate.Serialize(System.Int32,System.Byte[])">
  13392. Serializes this aggregate to a byte array. Since this Is an aggregate
  13393. record it will effectively Serialize the aggregated records.
  13394. @param offset The offset into the start of the array.
  13395. @param data The byte array to Serialize to.
  13396. @return The number of bytes Serialized.
  13397. </member>
  13398. <member name="M:NPOI.HSSF.Record.EscherAggregate.WriteDataIntoDrawingRecord(System.Byte[],System.Int32,System.Int32,System.Byte[],System.Int32)">
  13399. @param drawingData - escher records saved into single byte array
  13400. @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create
  13401. drawing or continue record)
  13402. @param pos current position of data array
  13403. @param data - array of bytes where drawing records must be serialized
  13404. @param i - number of shape, saved into data array
  13405. @return offset of data array after serialization
  13406. </member>
  13407. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherRecordSize(System.Collections.Generic.List{NPOI.DDF.EscherRecord})">
  13408. How many bytes do the raw escher records contain.
  13409. @param records List of escher records
  13410. @return the number of bytes
  13411. </member>
  13412. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetSid(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase},System.Int32)">
  13413. @param records list of records to look into
  13414. @param loc - location of the record which sid must be returned
  13415. @return sid of the record with selected location
  13416. </member>
  13417. <member name="P:NPOI.HSSF.Record.EscherAggregate.RecordSize">
  13418. @return record size, including header size of obj, text, note, drawing, continue records
  13419. </member>
  13420. <member name="M:NPOI.HSSF.Record.EscherAggregate.BuildBaseTree">
  13421. create base tree with such structure:
  13422. EscherDgContainer
  13423. -EscherSpgrContainer
  13424. --EscherSpContainer
  13425. ---EscherSpRecord
  13426. ---EscherSpgrRecord
  13427. ---EscherSpRecord
  13428. -EscherDgRecord
  13429. id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch
  13430. </member>
  13431. <member name="M:NPOI.HSSF.Record.EscherAggregate.Children(System.Byte[],System.Int16,System.Int32)">
  13432. Unused since this Is an aggregate record. Use CreateAggregate().
  13433. @see #CreateAggregate
  13434. </member>
  13435. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetEscherChild(NPOI.DDF.EscherContainerRecord,System.Int32)">
  13436. Converts the Records into UserModel
  13437. objects on the bound HSSFPatriarch
  13438. </member>
  13439. <member name="M:NPOI.HSSF.Record.EscherAggregate.AssociateShapeToObjRecord(NPOI.DDF.EscherRecord,NPOI.HSSF.Record.Record)">
  13440. <summary>
  13441. Associates an escher record to an OBJ record or a TXO record.
  13442. </summary>
  13443. <param name="r">ClientData or Textbox record</param>
  13444. <param name="objRecord">Obj or TextObj record</param>
  13445. </member>
  13446. <member name="M:NPOI.HSSF.Record.EscherAggregate.RemoveShapeToObjRecord(NPOI.DDF.EscherRecord)">
  13447. <summary>
  13448. Remove echerRecord and associated to it Obj or TextObj record
  13449. </summary>
  13450. <param name="rec">clientData or textbox record to be removed</param>
  13451. </member>
  13452. <member name="P:NPOI.HSSF.Record.EscherAggregate.TailRecords">
  13453. @return unmodifiable copy of tail records. We need to access them when building shapes.
  13454. Every HSSFComment shape has a link to a NoteRecord from the tailRec collection.
  13455. </member>
  13456. <member name="M:NPOI.HSSF.Record.EscherAggregate.GetNoteRecordByObj(NPOI.HSSF.Record.ObjRecord)">
  13457. @param obj - ObjRecord with id == NoteRecord.id
  13458. @return null if note record is not found else returns note record with id == obj.id
  13459. </member>
  13460. <member name="T:NPOI.HSSF.Record.ExtendedFormatRecord">
  13461. Title: Extended Format Record
  13462. Description: Probably one of the more complex records. There are two breeds:
  13463. Style and Cell.
  13464. It should be noted that fields in the extended format record are
  13465. somewhat arbitrary. Almost all of the fields are bit-level, but
  13466. we name them as best as possible by functional Group. In some
  13467. places this Is better than others.
  13468. REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13469. @author Andrew C. Oliver (acoliver at apache dot org)
  13470. @version 2.0-pre
  13471. </member>
  13472. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor">
  13473. Constructor ExtendedFormatRecord
  13474. </member>
  13475. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13476. Constructs an ExtendedFormat record and Sets its fields appropriately.
  13477. @param in the RecordInputstream to Read the record from
  13478. </member>
  13479. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.CloneStyleFrom(NPOI.HSSF.Record.ExtendedFormatRecord)">
  13480. Clones all the style information from another
  13481. ExtendedFormatRecord, onto this one. This
  13482. will then hold all the same style options.
  13483. If The source ExtendedFormatRecord comes from
  13484. a different Workbook, you will need to sort
  13485. out the font and format indicies yourself!
  13486. </member>
  13487. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FontIndex">
  13488. <summary>
  13489. Get the index to the FONT record (which font to use 0 based)
  13490. </summary>
  13491. </member>
  13492. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FormatIndex">
  13493. <summary>
  13494. Get the index to the Format record (which FORMAT to use 0-based)
  13495. </summary>
  13496. </member>
  13497. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.CellOptions">
  13498. <summary>
  13499. Gets the options bitmask - you can also use corresponding option bit Getters
  13500. (see other methods that reference this one)
  13501. </summary>
  13502. </member>
  13503. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsLocked">
  13504. <summary>
  13505. Get whether the cell Is locked or not
  13506. </summary>
  13507. </member>
  13508. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsHidden">
  13509. <summary>
  13510. Get whether the cell Is hidden or not
  13511. </summary>
  13512. </member>
  13513. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.XFType">
  13514. <summary>
  13515. Get whether the cell Is a cell or style XFRecord
  13516. </summary>
  13517. </member>
  13518. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord._123Prefix">
  13519. <summary>
  13520. Get some old holdover from lotus 123. Who cares, its all over for Lotus.
  13521. RIP Lotus.
  13522. </summary>
  13523. </member>
  13524. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ParentIndex">
  13525. <summary>
  13526. for cell XF types this Is the parent style (usually 0/normal). For
  13527. style this should be NULL.
  13528. </summary>
  13529. </member>
  13530. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AlignmentOptions">
  13531. <summary>
  13532. Get the alignment options bitmask. See corresponding bitGetter methods
  13533. that reference this one.
  13534. </summary>
  13535. </member>
  13536. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Alignment">
  13537. <summary>
  13538. Get the horizontal alignment of the cell.
  13539. </summary>
  13540. </member>
  13541. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.WrapText">
  13542. <summary>
  13543. Get whether to wrap the text in the cell
  13544. </summary>
  13545. </member>
  13546. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.VerticalAlignment">
  13547. <summary>
  13548. Get the vertical alignment of text in the cell
  13549. </summary>
  13550. </member>
  13551. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.JustifyLast">
  13552. <summary>
  13553. Docs just say this Is for far east versions.. (I'm guessing it
  13554. justifies for right-to-left Read languages)
  13555. </summary>
  13556. </member>
  13557. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Rotation">
  13558. <summary>
  13559. Get the degree of rotation. (I've not actually seen this used anywhere)
  13560. </summary>
  13561. </member>
  13562. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IndentionOptions">
  13563. <summary>
  13564. Get the indent options bitmask (see corresponding bit Getters that reference
  13565. this field)
  13566. </summary>
  13567. </member>
  13568. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Indent">
  13569. <summary>
  13570. Get indention (not sure of the Units, think its spaces)
  13571. </summary>
  13572. </member>
  13573. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ShrinkToFit">
  13574. <summary>
  13575. Get whether to shrink the text to fit
  13576. </summary>
  13577. </member>
  13578. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.MergeCells">
  13579. <summary>
  13580. Get whether to merge cells
  13581. </summary>
  13582. </member>
  13583. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.ReadingOrder">
  13584. <summary>
  13585. Get the Reading order for far east versions (0 - Context, 1 - Left to right,
  13586. 2 - right to left) - We could use some help with support for the far east.
  13587. </summary>
  13588. </member>
  13589. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFormat">
  13590. <summary>
  13591. Get whether or not to use the format in this XF instead of the parent XF.
  13592. </summary>
  13593. </member>
  13594. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentFont">
  13595. <summary>
  13596. Get whether or not to use the font in this XF instead of the parent XF.
  13597. </summary>
  13598. </member>
  13599. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentAlignment">
  13600. <summary>
  13601. Get whether or not to use the alignment in this XF instead of the parent XF.
  13602. </summary>
  13603. </member>
  13604. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentBorder">
  13605. <summary>
  13606. Get whether or not to use the border in this XF instead of the parent XF.
  13607. </summary>
  13608. </member>
  13609. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentPattern">
  13610. <summary>
  13611. Get whether or not to use the pattern in this XF instead of the parent XF.
  13612. (foregrount/background)
  13613. </summary>
  13614. </member>
  13615. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.IsIndentNotParentCellOptions">
  13616. <summary>
  13617. Get whether or not to use the locking/hidden in this XF instead of the parent XF.
  13618. </summary>
  13619. </member>
  13620. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderOptions">
  13621. <summary>
  13622. Get the border options bitmask (see the corresponding bit Getter methods
  13623. that reference back to this one)
  13624. </summary>
  13625. </member>
  13626. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderLeft">
  13627. <summary>
  13628. Get the borderline style for the left border
  13629. </summary>
  13630. </member>
  13631. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderRight">
  13632. <summary>
  13633. Get the borderline style for the right border
  13634. </summary>
  13635. </member>
  13636. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderTop">
  13637. <summary>
  13638. Get the borderline style for the top border
  13639. </summary>
  13640. </member>
  13641. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BorderBottom">
  13642. <summary>
  13643. Get the borderline style for the bottom border
  13644. </summary>
  13645. </member>
  13646. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.PaletteOptions">
  13647. <summary>
  13648. Get the palette options bitmask (see the individual bit Getter methods that
  13649. reference this one)
  13650. </summary>
  13651. </member>
  13652. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.LeftBorderPaletteIdx">
  13653. <summary>
  13654. Get the palette index for the left border color
  13655. </summary>
  13656. </member>
  13657. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.RightBorderPaletteIdx">
  13658. <summary>
  13659. Get the palette index for the right border color
  13660. </summary>
  13661. </member>
  13662. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlPaletteOptions">
  13663. <summary>
  13664. Get the Additional palette options bitmask (see individual bit Getter methods
  13665. that reference this method)
  13666. </summary>
  13667. </member>
  13668. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.TopBorderPaletteIdx">
  13669. <summary>
  13670. Get the palette index for the top border
  13671. </summary>
  13672. </member>
  13673. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.BottomBorderPaletteIdx">
  13674. <summary>
  13675. Get the palette index for the bottom border
  13676. </summary>
  13677. </member>
  13678. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagBorderPaletteIdx">
  13679. <summary>
  13680. Get for diagonal borders
  13681. </summary>
  13682. </member>
  13683. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlDiagLineStyle">
  13684. <summary>
  13685. Get the diagonal border line style
  13686. </summary>
  13687. </member>
  13688. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.Diagonal">
  13689. <summary>
  13690. Not sure what this Is for (maybe Fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..
  13691. </summary>
  13692. </member>
  13693. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.AdtlFillPattern">
  13694. <summary>
  13695. Get the Additional Fill pattern
  13696. </summary>
  13697. </member>
  13698. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillPaletteOptions">
  13699. <summary>
  13700. Get the Fill palette options bitmask (see indivdual bit Getters that
  13701. reference this method)
  13702. </summary>
  13703. </member>
  13704. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillForeground">
  13705. <summary>
  13706. Get the foreground palette color index
  13707. </summary>
  13708. </member>
  13709. <member name="P:NPOI.HSSF.Record.ExtendedFormatRecord.FillBackground">
  13710. <summary>
  13711. Get the background palette color index
  13712. </summary>
  13713. </member>
  13714. <member name="M:NPOI.HSSF.Record.ExtendedFormatRecord.Equals(System.Object)">
  13715. Will consider two different records with the same
  13716. contents as Equals, as the various indexes
  13717. that matter are embedded in the records
  13718. </member>
  13719. <member name="T:NPOI.HSSF.Record.ExternalNameRecord">
  13720. EXTERNALNAME<p/>
  13721. @author Josh Micich
  13722. </member>
  13723. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._ddeValues">
  13724. 'rgoper' / 'Last received results of the DDE link'
  13725. (seems to be only applicable to DDE links)<br/>
  13726. Logically this is a 2-D array, which has been flattened into 1-D array here.
  13727. </member>
  13728. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nColumns">
  13729. (logical) number of columns in the {@link #_ddeValues} array
  13730. </member>
  13731. <member name="F:NPOI.HSSF.Record.ExternalNameRecord._nRows">
  13732. (logical) number of rows in the {@link #_ddeValues} array
  13733. </member>
  13734. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsBuiltInName">
  13735. Convenience Function to determine if the name Is a built-in name
  13736. </member>
  13737. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsAutomaticLink">
  13738. For OLE and DDE, links can be either 'automatic' or 'manual'
  13739. </member>
  13740. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsPicureLink">
  13741. only for OLE and DDE
  13742. </member>
  13743. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.IsStdDocumentNameIdentifier">
  13744. DDE links only. If <c>true</c>, this denotes the 'StdDocumentName'
  13745. </member>
  13746. <member name="P:NPOI.HSSF.Record.ExternalNameRecord.Text">
  13747. @return the standard String representation of this name
  13748. </member>
  13749. <member name="F:NPOI.HSSF.Record.RefSubRecord._extBookIndex">
  13750. index to External Book Block (which starts with a EXTERNALBOOK record)
  13751. </member>
  13752. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(System.Int32,System.Int32,System.Int32)">
  13753. a Constructor for making new sub record
  13754. </member>
  13755. <member name="M:NPOI.HSSF.Record.RefSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13756. @param in the RecordInputstream to Read the record from
  13757. </member>
  13758. <member name="M:NPOI.HSSF.Record.RefSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13759. called by the class that is responsible for writing this sucker.
  13760. Subclasses should implement this so that their data is passed back in a
  13761. byte array.
  13762. @param offset to begin writing at
  13763. @param data byte array containing instance data
  13764. @return number of bytes written
  13765. </member>
  13766. <member name="T:NPOI.HSSF.Record.ExternSheetRecord">
  13767. Title: Extern Sheet
  13768. Description: A List of Inndexes to SupBook
  13769. REFERENCE:
  13770. @author Libin Roman (Vista Portal LDT. Developer)
  13771. @version 1.0-pre
  13772. </member>
  13773. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13774. Constructs a Extern Sheet record and Sets its fields appropriately.
  13775. @param in the RecordInputstream to Read the record from
  13776. </member>
  13777. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddRef(System.Int32,System.Int32,System.Int32)">
  13778. Add a zero-based reference to a {@link org.apache.poi.hssf.record.SupBookRecord}.
  13779. <p>
  13780. If the type of the SupBook record is same-sheet referencing, Add-In referencing,
  13781. DDE data source referencing, or OLE data source referencing,
  13782. then no scope is specified and this value <em>MUST</em> be -2. Otherwise,
  13783. the scope must be set as follows:
  13784. <ol>
  13785. <li><code>-2</code> Workbook-level reference that applies to the entire workbook.</li>
  13786. <li><code>-1</code> Sheet-level reference. </li>
  13787. <li><code>&gt;=0</code> Sheet-level reference. This specifies the first sheet in the reference.
  13788. <p>
  13789. If the SupBook type is unused or external workbook referencing,
  13790. then this value specifies the zero-based index of an external sheet name,
  13791. see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}.
  13792. This referenced string specifies the name of the first sheet within the external workbook that is in scope.
  13793. This sheet MUST be a worksheet or macro sheet.
  13794. </p>
  13795. <p>
  13796. If the supporting link type is self-referencing, then this value specifies the zero-based index of a
  13797. {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies
  13798. the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.
  13799. </p>
  13800. </li>
  13801. </ol></p>
  13802. @param firstSheetIndex the scope, must be -2 for add-in references
  13803. @param lastSheetIndex the scope, must be -2 for add-in references
  13804. @return index of newly added ref
  13805. </member>
  13806. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfREFRecords">
  13807. returns the number of REF Records, which is in model
  13808. @return number of REF records
  13809. </member>
  13810. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.NumOfRefs">
  13811. @return number of REF structures
  13812. </member>
  13813. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.AddREFRecord(NPOI.HSSF.Record.RefSubRecord)">
  13814. Adds REF struct (ExternSheetSubRecord)
  13815. @param rec REF struct
  13816. </member>
  13817. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetExtbookIndexFromRefIndex(System.Int32)">
  13818. Returns the index of the SupBookRecord for this index
  13819. </member>
  13820. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.FindRefIndexFromExtBookIndex(System.Int32)">
  13821. @return -1 if not found
  13822. </member>
  13823. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetFirstSheetIndexFromRefIndex(System.Int32)">
  13824. Returns the first sheet that the reference applies to, or
  13825. -1 if the referenced sheet can't be found, or -2 if the
  13826. reference is workbook scoped.
  13827. </member>
  13828. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.GetLastSheetIndexFromRefIndex(System.Int32)">
  13829. Returns the last sheet that the reference applies to, or
  13830. -1 if the referenced sheet can't be found, or -2 if the
  13831. reference is workbook scoped.
  13832. For a single sheet reference, the first and last should be
  13833. the same.
  13834. </member>
  13835. <member name="M:NPOI.HSSF.Record.ExternSheetRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  13836. called by the class that Is responsible for writing this sucker.
  13837. Subclasses should implement this so that their data Is passed back in a
  13838. byte array.
  13839. @param offset to begin writing at
  13840. @param data byte array containing instance data
  13841. @return number of bytes written
  13842. </member>
  13843. <member name="P:NPOI.HSSF.Record.ExternSheetRecord.Sid">
  13844. return the non static version of the id for this record.
  13845. </member>
  13846. <member name="T:NPOI.HSSF.Record.ExternSheetSubRecord">
  13847. Title: A sub Record for Extern Sheet
  13848. Description: Defines a named range within a workbook.
  13849. REFERENCE:
  13850. @author Libin Roman (Vista Portal LDT. Developer)
  13851. @version 1.0-pre
  13852. </member>
  13853. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor">
  13854. a Constractor for making new sub record
  13855. </member>
  13856. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13857. Constructs a Extern Sheet Sub Record record and Sets its fields appropriately.
  13858. @param in the RecordInputstream to Read the record from
  13859. </member>
  13860. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToSupBook(System.Int16)">
  13861. Sets the Index to the sup book
  13862. @param index sup book index
  13863. </member>
  13864. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToSupBook">
  13865. Gets the index to sup book
  13866. @return sup book index
  13867. </member>
  13868. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToFirstSupBook(System.Int16)">
  13869. Sets the index to first sheet in supbook
  13870. @param index index to first sheet
  13871. </member>
  13872. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToFirstSupBook">
  13873. Gets the index to first sheet from supbook
  13874. @return index to first supbook
  13875. </member>
  13876. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.SetIndexToLastSupBook(System.Int16)">
  13877. Sets the index to last sheet in supbook
  13878. @param index index to last sheet
  13879. </member>
  13880. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.GetIndexToLastSupBook">
  13881. Gets the index to last sheet in supbook
  13882. @return index to last supbook
  13883. </member>
  13884. <member name="M:NPOI.HSSF.Record.ExternSheetSubRecord.Serialize(System.Int32,System.Byte[])">
  13885. called by the class that Is responsible for writing this sucker.
  13886. Subclasses should implement this so that their data Is passed back in a
  13887. byte array.
  13888. @param offset to begin writing at
  13889. @param data byte array containing instance data
  13890. @return number of bytes written
  13891. </member>
  13892. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.RecordSize">
  13893. returns the record size
  13894. </member>
  13895. <member name="P:NPOI.HSSF.Record.ExternSheetSubRecord.Sid">
  13896. return the non static version of the id for this record.
  13897. </member>
  13898. <member name="T:NPOI.HSSF.Record.InfoSubRecord">
  13899. Extended SST table info subrecord
  13900. Contains the elements of "info" in the SST's array field
  13901. @author Andrew C. Oliver (acoliver at apache dot org)
  13902. @version 2.0-pre
  13903. @see org.apache.poi.hssf.record.ExtSSTRecord
  13904. </member>
  13905. <member name="M:NPOI.HSSF.Record.InfoSubRecord.#ctor(System.Int32,System.Int32)">
  13906. Creates new ExtSSTInfoSubRecord
  13907. </member>
  13908. <member name="T:NPOI.HSSF.Record.ExtSSTRecord">
  13909. Title: Extended Static String Table
  13910. Description: This record Is used for a quick Lookup into the SST record. This
  13911. record breaks the SST table into a Set of buckets. The offsets
  13912. to these buckets within the SST record are kept as well as the
  13913. position relative to the start of the SST record.
  13914. REFERENCE: PG 313 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13915. @author Andrew C. Oliver (acoliver at apache dot org)
  13916. @author Jason Height (jheight at apache dot org)
  13917. @version 2.0-pre
  13918. @see org.apache.poi.hssf.record.ExtSSTInfoSubRecord
  13919. </member>
  13920. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13921. Constructs a EOFRecord record and Sets its fields appropriately.
  13922. @param in the RecordInputstream to Read the record from
  13923. </member>
  13924. <member name="P:NPOI.HSSF.Record.ExtSSTRecord.DataSize">
  13925. Returns the size of this record
  13926. </member>
  13927. <member name="M:NPOI.HSSF.Record.ExtSSTRecord.GetRecordSizeForStrings(System.Int32)">
  13928. Given a number of strings (in the sst), returns the size of the extsst record
  13929. </member>
  13930. <member name="T:NPOI.HSSF.Record.FeatHdrRecord">
  13931. Title: FeatHdr (Feature Header) Record
  13932. This record specifies common information for Shared Features, and
  13933. specifies the beginning of a collection of records to define them.
  13934. The collection of data (Globals Substream ABNF, macro sheet substream
  13935. ABNF or worksheet substream ABNF) specifies Shared Feature data.
  13936. </member>
  13937. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFPROTECTION">
  13938. Specifies the enhanced protection type. Used to protect a
  13939. shared workbook by restricting access to some areas of it
  13940. </member>
  13941. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFEC2">
  13942. Specifies that formula errors should be ignored
  13943. </member>
  13944. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFFACTOID">
  13945. Specifies the smart tag type. Recognises certain
  13946. types of entries (proper names, dates/times etc) and
  13947. flags them for action
  13948. </member>
  13949. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.SHAREDFEATURES_ISFLIST">
  13950. Specifies the shared list type. Used for a table
  13951. within a sheet
  13952. </member>
  13953. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.cbHdrData">
  13954. 0x00000000 = rgbHdrData not present
  13955. 0xffffffff = rgbHdrData present
  13956. </member>
  13957. <member name="F:NPOI.HSSF.Record.FeatHdrRecord.rgbHdrData">
  13958. We need a BOFRecord to make sense of this...
  13959. </member>
  13960. <member name="T:NPOI.HSSF.Record.FeatRecord">
  13961. Title: Feat (Feature) Record
  13962. This record specifies Shared Features data. It is normally paired
  13963. up with a {@link FeatHdrRecord}.
  13964. </member>
  13965. <member name="F:NPOI.HSSF.Record.FeatRecord.isf_sharedFeatureType">
  13966. See SHAREDFEATURES_* on {@link FeatHdrRecord}
  13967. </member>
  13968. <member name="F:NPOI.HSSF.Record.FeatRecord.cbFeatData">
  13969. Only matters if type is ISFFEC2
  13970. </member>
  13971. <member name="F:NPOI.HSSF.Record.FeatRecord.sharedFeature">
  13972. Contents depends on isf_sharedFeatureType :
  13973. ISFPROTECTION -> FeatProtection
  13974. ISFFEC2 -> FeatFormulaErr2
  13975. ISFFACTOID -> FeatSmartTag
  13976. </member>
  13977. <member name="T:NPOI.HSSF.Record.FilePassRecord">
  13978. Title: File Pass Record
  13979. Description: Indicates that the record after this record are encrypted. HSSF does not support encrypted excel workbooks
  13980. and the presence of this record will cause Processing to be aborted.
  13981. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  13982. @author Jason Height (jheight at chariot dot net dot au)
  13983. @version 3.0-pre
  13984. </member>
  13985. <member name="T:NPOI.HSSF.Record.FileSharingRecord">
  13986. Title: FILESHARING
  13987. Description: stores the encrypted Readonly for a workbook (Write protect)
  13988. This functionality Is accessed from the options dialog box available when performing 'Save As'.<p/>
  13989. REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)<p/>
  13990. @author Andrew C. Oliver (acoliver at apache dot org)
  13991. </member>
  13992. <member name="M:NPOI.HSSF.Record.FileSharingRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  13993. Constructs a FileSharing record and Sets its fields appropriately.
  13994. @param in the RecordInputstream to Read the record from
  13995. </member>
  13996. <member name="P:NPOI.HSSF.Record.FileSharingRecord.ReadOnly">
  13997. Get the Readonly
  13998. @return short representing if this Is Read only (1 = true)
  13999. </member>
  14000. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Password">
  14001. @returns password hashed with hashPassword() (very lame)
  14002. </member>
  14003. <member name="P:NPOI.HSSF.Record.FileSharingRecord.Username">
  14004. @returns username of the user that Created the file
  14005. </member>
  14006. <member name="M:NPOI.HSSF.Record.FileSharingRecord.Clone">
  14007. Clone this record.
  14008. </member>
  14009. <member name="T:NPOI.HSSF.Record.FnGroupCountRecord">
  14010. Title: Function Group Count Record
  14011. Description: Number of built in function Groups in the current version of the
  14012. SpReadsheet (probably only used on Windoze)
  14013. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14014. @author Andrew C. Oliver (acoliver at apache dot org)
  14015. @version 2.0-pre
  14016. </member>
  14017. <member name="F:NPOI.HSSF.Record.FnGroupCountRecord.COUNT">
  14018. suggested default (14 dec)
  14019. </member>
  14020. <member name="M:NPOI.HSSF.Record.FnGroupCountRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14021. Constructs a FnGroupCount record and Sets its fields appropriately.
  14022. @param in the RecordInputstream to Read the record from
  14023. </member>
  14024. <member name="P:NPOI.HSSF.Record.FnGroupCountRecord.Count">
  14025. Get the number of built-in functions
  14026. @return number of built-in functions
  14027. </member>
  14028. <member name="T:NPOI.HSSF.Record.FontRecord">
  14029. Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
  14030. Description: An element in the Font Table
  14031. REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14032. @author Andrew C. Oliver (acoliver at apache dot org)
  14033. @version 2.0-pre
  14034. </member>
  14035. <member name="M:NPOI.HSSF.Record.FontRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14036. Constructs a Font record and Sets its fields appropriately.
  14037. @param in the RecordInputstream to Read the record from
  14038. </member>
  14039. <member name="M:NPOI.HSSF.Record.FontRecord.CloneStyleFrom(NPOI.HSSF.Record.FontRecord)">
  14040. Clones all the font style information from another
  14041. FontRecord, onto this one. This
  14042. will then hold all the same font style options.
  14043. </member>
  14044. <member name="P:NPOI.HSSF.Record.FontRecord.IsItalic">
  14045. Set the font to be italics or not
  14046. @param italics - whether the font Is italics or not
  14047. @see #SetAttributes(short)
  14048. </member>
  14049. <member name="P:NPOI.HSSF.Record.FontRecord.IsStrikeout">
  14050. Set the font to be stricken out or not
  14051. @param strike - whether the font Is stricken out or not
  14052. @see #SetAttributes(short)
  14053. </member>
  14054. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacoutlined">
  14055. whether to use the mac outline font style thing (mac only) - Some mac person
  14056. should comment this instead of me doing it (since I have no idea)
  14057. @param mac - whether to do that mac font outline thing or not
  14058. @see #SetAttributes(short)
  14059. </member>
  14060. <member name="P:NPOI.HSSF.Record.FontRecord.IsMacshadowed">
  14061. whether to use the mac shado font style thing (mac only) - Some mac person
  14062. should comment this instead of me doing it (since I have no idea)
  14063. @param mac - whether to do that mac font shadow thing or not
  14064. @see #SetAttributes(short)
  14065. </member>
  14066. <member name="P:NPOI.HSSF.Record.FontRecord.Underline">
  14067. Set the type of Underlining for the font
  14068. </member>
  14069. <member name="P:NPOI.HSSF.Record.FontRecord.Family">
  14070. Set the font family (TODO)
  14071. @param f family
  14072. </member>
  14073. <member name="P:NPOI.HSSF.Record.FontRecord.Charset">
  14074. Set the Char Set
  14075. @param charSet - CharSet
  14076. </member>
  14077. <member name="P:NPOI.HSSF.Record.FontRecord.FontName">
  14078. Set the name of the font
  14079. @param fn - name of the font (i.e. "Arial")
  14080. </member>
  14081. <member name="P:NPOI.HSSF.Record.FontRecord.FontHeight">
  14082. Gets the height of the font in 1/20th point Units
  14083. @return fontheight (in points/20)
  14084. </member>
  14085. <member name="P:NPOI.HSSF.Record.FontRecord.Attributes">
  14086. Get the font attributes (see individual bit Getters that reference this method)
  14087. @return attribute - the bitmask
  14088. </member>
  14089. <member name="P:NPOI.HSSF.Record.FontRecord.ColorPaletteIndex">
  14090. Get the font's color palette index
  14091. @return cpi - font color index
  14092. </member>
  14093. <member name="P:NPOI.HSSF.Record.FontRecord.BoldWeight">
  14094. Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  14095. 0x190 for normal and 0x2bc for bold
  14096. @return bw - a number between 100-1000 for the fonts "boldness"
  14097. </member>
  14098. <member name="P:NPOI.HSSF.Record.FontRecord.SuperSubScript">
  14099. Get the type of base or subscript for the font
  14100. @return base or subscript option
  14101. </member>
  14102. <member name="M:NPOI.HSSF.Record.FontRecord.SameProperties(NPOI.HSSF.Record.FontRecord)">
  14103. Does this FontRecord have all the same font
  14104. properties as the supplied FontRecord?
  14105. Note that {@link #equals(Object)} will check
  14106. for exact objects, while this will check
  14107. for exact contents, because normally the
  14108. font record's position makes a big
  14109. difference too.
  14110. </member>
  14111. <member name="M:NPOI.HSSF.Record.FontRecord.Equals(System.Object)">
  14112. Only returns two for the same exact object -
  14113. creating a second FontRecord with the same
  14114. properties won't be considered equal, as
  14115. the record's position in the record stream
  14116. matters.
  14117. </member>
  14118. <member name="T:NPOI.HSSF.Record.FooterRecord">
  14119. Title: Footer Record
  14120. Description: Specifies the footer for a sheet
  14121. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14122. @author Andrew C. Oliver (acoliver at apache dot org)
  14123. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  14124. @author Jason Height (jheight at chariot dot net dot au)
  14125. @version 2.0-pre
  14126. </member>
  14127. <member name="M:NPOI.HSSF.Record.FooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14128. <summary>
  14129. Initializes a new instance of the <see cref="T:NPOI.HSSF.Record.FooterRecord"/> class.
  14130. </summary>
  14131. <param name="in1">the RecordInputstream to Read the record from</param>
  14132. </member>
  14133. <member name="M:NPOI.HSSF.Record.FooterRecord.ToString">
  14134. <summary>
  14135. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  14136. </summary>
  14137. <returns>
  14138. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  14139. </returns>
  14140. </member>
  14141. <member name="P:NPOI.HSSF.Record.FooterRecord.Sid">
  14142. <summary>
  14143. </summary>
  14144. <value></value>
  14145. return the non static version of the id for this record.
  14146. </member>
  14147. <member name="T:NPOI.HSSF.Record.FormatRecord">
  14148. Title: Format Record
  14149. Description: describes a number format -- those goofy strings like $(#,###)
  14150. REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14151. @author Andrew C. Oliver (acoliver at apache dot org)
  14152. @author Shawn M. Laubach (slaubach at apache dot org)
  14153. @version 2.0-pre
  14154. </member>
  14155. <member name="M:NPOI.HSSF.Record.FormatRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14156. Constructs a Format record and Sets its fields appropriately.
  14157. @param in the RecordInputstream to Read the record from
  14158. </member>
  14159. <member name="P:NPOI.HSSF.Record.FormatRecord.IndexCode">
  14160. Get the format index code (for built in formats)
  14161. @return the format index code
  14162. @see org.apache.poi.hssf.model.Workbook
  14163. </member>
  14164. <member name="P:NPOI.HSSF.Record.FormatRecord.FormatString">
  14165. Get the format string
  14166. @return the format string
  14167. </member>
  14168. <member name="T:NPOI.HSSF.Record.SpecialCachedValue">
  14169. Manages the cached formula result values of other types besides numeric.
  14170. Excel encodes the same 8 bytes that would be field_4_value with various NaN
  14171. values that are decoded/encoded by this class.
  14172. </member>
  14173. <member name="F:NPOI.HSSF.Record.SpecialCachedValue.BIT_MARKER">
  14174. deliberately chosen by Excel in order to encode other values within Double NaNs
  14175. </member>
  14176. <member name="M:NPOI.HSSF.Record.SpecialCachedValue.Create(System.Int64)">
  14177. @return <c>null</c> if the double value encoded by <c>valueLongBits</c>
  14178. is a normal (non NaN) double value.
  14179. </member>
  14180. <member name="T:NPOI.HSSF.Record.FormulaRecord">
  14181. Formula Record.
  14182. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14183. @author Andrew C. Oliver (acoliver at apache dot org)
  14184. @author Jason Height (jheight at chariot dot net dot au)
  14185. @version 2.0-pre
  14186. </member>
  14187. <member name="F:NPOI.HSSF.Record.FormulaRecord.specialCachedValue">
  14188. Since the NaN support seems sketchy (different constants) we'll store and spit it out directly
  14189. </member>
  14190. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor">
  14191. Creates new FormulaRecord
  14192. </member>
  14193. <member name="M:NPOI.HSSF.Record.FormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14194. Constructs a Formula record and Sets its fields appropriately.
  14195. Note - id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an
  14196. "explanation of this bug in the documentation) or an exception
  14197. will be throw upon validation
  14198. @param in the RecordInputstream to Read the record from
  14199. </member>
  14200. <member name="P:NPOI.HSSF.Record.FormulaRecord.HasCachedResultString">
  14201. @return <c>true</c> if this {@link FormulaRecord} is followed by a
  14202. {@link StringRecord} representing the cached text result of the formula
  14203. evaluation.
  14204. </member>
  14205. <member name="P:NPOI.HSSF.Record.FormulaRecord.Value">
  14206. Get the calculated value of the formula
  14207. @return calculated value
  14208. </member>
  14209. <member name="P:NPOI.HSSF.Record.FormulaRecord.Options">
  14210. Get the option flags
  14211. @return bitmask
  14212. </member>
  14213. <member name="P:NPOI.HSSF.Record.FormulaRecord.ParsedExpression">
  14214. Get the stack as a list
  14215. @return list of tokens (casts stack to a list and returns it!)
  14216. this method can return null Is we are Unable to Create Ptgs from
  14217. existing excel file
  14218. callers should Check for null!
  14219. </member>
  14220. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.#ctor">
  14221. Construct a new <code>FtCblsSubRecord</code> and
  14222. fill its data with the default values
  14223. </member>
  14224. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.ToString">
  14225. Convert this record to string.
  14226. Used by BiffViewer and other utilities.
  14227. </member>
  14228. <member name="M:NPOI.HSSF.Record.FtCblsSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14229. Serialize the record data into the supplied array of bytes
  14230. @param out the stream to serialize into
  14231. </member>
  14232. <member name="P:NPOI.HSSF.Record.FtCblsSubRecord.Sid">
  14233. @return id of this record.
  14234. </member>
  14235. <member name="T:NPOI.HSSF.Record.FtCfSubRecord">
  14236. The FtCf structure specifies the clipboard format of the picture-type Obj record Containing this FtCf.
  14237. </member>
  14238. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.METAFILE_BIT">
  14239. Specifies the format of the picture is an enhanced metafile.
  14240. </member>
  14241. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.BITMAP_BIT">
  14242. Specifies the format of the picture is a bitmap.
  14243. </member>
  14244. <member name="F:NPOI.HSSF.Record.FtCfSubRecord.UNSPECIFIED_BIT">
  14245. Specifies the picture is in an unspecified format that is
  14246. neither and enhanced metafile nor a bitmap.
  14247. </member>
  14248. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.#ctor">
  14249. Construct a new <code>FtPioGrbitSubRecord</code> and
  14250. fill its data with the default values
  14251. </member>
  14252. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.ToString">
  14253. Convert this record to string.
  14254. Used by BiffViewer and other utilities.
  14255. </member>
  14256. <member name="M:NPOI.HSSF.Record.FtCfSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14257. Serialize the record data into the supplied array of bytes
  14258. @param out the stream to serialize into
  14259. </member>
  14260. <member name="P:NPOI.HSSF.Record.FtCfSubRecord.Sid">
  14261. @return id of this record.
  14262. </member>
  14263. <member name="T:NPOI.HSSF.Record.FtPioGrbitSubRecord">
  14264. This structure appears as part of an Obj record that represents image display properties.
  14265. </member>
  14266. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_PICT_BIT">
  14267. A bit that specifies whether the picture's aspect ratio is preserved when rendered in
  14268. different views (Normal view, Page Break Preview view, Page Layout view and printing).
  14269. </member>
  14270. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DDE_BIT">
  14271. A bit that specifies whether the pictFmla field of the Obj record that Contains
  14272. this FtPioGrbit specifies a DDE reference.
  14273. </member>
  14274. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRINT_CALC_BIT">
  14275. A bit that specifies whether this object is expected to be updated on print to
  14276. reflect the values in the cell associated with the object.
  14277. </member>
  14278. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.ICON_BIT">
  14279. A bit that specifies whether the picture is displayed as an icon.
  14280. </member>
  14281. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CTL_BIT">
  14282. A bit that specifies whether this object is an ActiveX control.
  14283. It MUST NOT be the case that both fCtl and fDde are equal to 1.
  14284. </member>
  14285. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.PRSTM_BIT">
  14286. A bit that specifies whether the object data are stored in an
  14287. embedding storage (= 0) or in the controls stream (ctls) (= 1).
  14288. </member>
  14289. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.CAMERA_BIT">
  14290. A bit that specifies whether this is a camera picture.
  14291. </member>
  14292. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.DEFAULT_SIZE_BIT">
  14293. A bit that specifies whether this picture's size has been explicitly Set.
  14294. 0 = picture size has been explicitly Set, 1 = has not been Set
  14295. </member>
  14296. <member name="F:NPOI.HSSF.Record.FtPioGrbitSubRecord.AUTO_LOAD_BIT">
  14297. A bit that specifies whether the OLE server for the object is called
  14298. to load the object's data automatically when the parent workbook is opened.
  14299. </member>
  14300. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.#ctor">
  14301. Construct a new <code>FtPioGrbitSubRecord</code> and
  14302. fill its data with the default values
  14303. </member>
  14304. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.SetFlagByBit(System.Int32,System.Boolean)">
  14305. Use one of the bitmasks MANUAL_ADVANCE_BIT ... CURSOR_VISIBLE_BIT
  14306. @param bitmask
  14307. @param enabled
  14308. </member>
  14309. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.ToString">
  14310. Convert this record to string.
  14311. Used by BiffViewer and other utilities.
  14312. </member>
  14313. <member name="M:NPOI.HSSF.Record.FtPioGrbitSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14314. Serialize the record data into the supplied array of bytes
  14315. @param out the stream to serialize into
  14316. </member>
  14317. <member name="P:NPOI.HSSF.Record.FtPioGrbitSubRecord.Sid">
  14318. @return id of this record.
  14319. </member>
  14320. <member name="T:NPOI.HSSF.Record.GridsetRecord">
  14321. Title: GridSet Record.
  14322. Description: flag denoting whether the user specified that gridlines are used when
  14323. printing.
  14324. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14325. @author Andrew C. Oliver (acoliver at apache dot org)
  14326. @author Glen Stampoultzis (glens at apache.org)
  14327. @author Jason Height (jheight at chariot dot net dot au)
  14328. @version 2.0-pre
  14329. </member>
  14330. <member name="M:NPOI.HSSF.Record.GridsetRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14331. Constructs a GridSet record and Sets its fields appropriately.
  14332. @param in the RecordInputstream to Read the record from
  14333. </member>
  14334. <member name="P:NPOI.HSSF.Record.GridsetRecord.Gridset">
  14335. Get whether the gridlines are shown during printing.
  14336. @return gridSet - true if gridlines are NOT printed, false if they are.
  14337. </member>
  14338. <member name="T:NPOI.HSSF.Record.GutsRecord">
  14339. Title: Guts Record
  14340. Description: Row/column gutter sizes
  14341. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14342. @author Andrew C. Oliver (acoliver at apache dot org)
  14343. @author Jason Height (jheight at chariot dot net dot au)
  14344. @version 2.0-pre
  14345. </member>
  14346. <member name="M:NPOI.HSSF.Record.GutsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14347. Constructs a Guts record and Sets its fields appropriately.
  14348. @param in the RecordInputstream to Read the record from
  14349. </member>
  14350. <member name="P:NPOI.HSSF.Record.GutsRecord.LeftRowGutter">
  14351. Get the size of the gutter that appears at the left of the rows
  14352. @return gutter size in screen Units
  14353. </member>
  14354. <member name="P:NPOI.HSSF.Record.GutsRecord.TopColGutter">
  14355. Get the size of the gutter that appears at the above the columns
  14356. @return gutter size in screen Units
  14357. </member>
  14358. <member name="P:NPOI.HSSF.Record.GutsRecord.RowLevelMax">
  14359. Get the maximum outline level for the row gutter.
  14360. @return maximum outline level
  14361. </member>
  14362. <member name="P:NPOI.HSSF.Record.GutsRecord.ColLevelMax">
  14363. Get the maximum outline level for the col gutter.
  14364. @return maximum outline level
  14365. </member>
  14366. <member name="T:NPOI.HSSF.Record.HCenterRecord">
  14367. Title: HCenter record
  14368. Description: whether to center between horizontal margins
  14369. REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14370. @author Andrew C. Oliver (acoliver at apache dot org)
  14371. @author Jason Height (jheight at chariot dot net dot au)
  14372. @version 2.0-pre
  14373. </member>
  14374. <member name="M:NPOI.HSSF.Record.HCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14375. Constructs an HCenter record and Sets its fields appropriately.
  14376. @param in the RecordInputstream to Read the record from
  14377. </member>
  14378. <member name="P:NPOI.HSSF.Record.HCenterRecord.HCenter">
  14379. Get whether or not to horizonatally center this sheet.
  14380. @return center - t/f
  14381. </member>
  14382. <member name="T:NPOI.HSSF.Record.HeaderFooterBase">
  14383. Common header/footer base class
  14384. @author Josh Micich
  14385. </member>
  14386. <member name="P:NPOI.HSSF.Record.HeaderFooterBase.TextLength">
  14387. get the length of the footer string
  14388. @return length of the footer string
  14389. </member>
  14390. <member name="T:NPOI.HSSF.Record.HeaderFooterRecord">
  14391. The HEADERFOOTER record stores information Added in Office Excel 2007 for headers/footers.
  14392. @author Yegor Kozlov
  14393. </member>
  14394. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14395. construct a HeaderFooterRecord record. No fields are interpreted and the record will
  14396. be Serialized in its original form more or less
  14397. @param in the RecordInputstream to read the record from
  14398. </member>
  14399. <member name="M:NPOI.HSSF.Record.HeaderFooterRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  14400. spit the record out AS IS. no interpretation or identification
  14401. </member>
  14402. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.Guid">
  14403. If this header belongs to a specific sheet view , the sheet view?s GUID will be saved here.
  14404. If it is zero, it means the current sheet. Otherwise, this field MUST match the guid field
  14405. of the preceding {@link UserSViewBegin} record.
  14406. @return the sheet view's GUID
  14407. </member>
  14408. <member name="P:NPOI.HSSF.Record.HeaderFooterRecord.IsCurrentSheet">
  14409. @return whether this record belongs to the current sheet
  14410. </member>
  14411. <member name="T:NPOI.HSSF.Record.HeaderRecord">
  14412. Title: Header Record
  14413. Description: Specifies a header for a sheet
  14414. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14415. @author Andrew C. Oliver (acoliver at apache dot org)
  14416. @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02
  14417. @author Jason Height (jheight at chariot dot net dot au)
  14418. @version 2.0-pre
  14419. </member>
  14420. <member name="M:NPOI.HSSF.Record.HeaderRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14421. Constructs an Header record and Sets its fields appropriately.
  14422. @param in the RecordInputstream to Read the record from
  14423. </member>
  14424. <member name="T:NPOI.HSSF.Record.HideObjRecord">
  14425. Title: Hide Object Record
  14426. Description: flag defines whether to hide placeholders and object
  14427. REFERENCE: PG 321 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14428. @author Andrew C. Oliver (acoliver at apache dot org)
  14429. @version 2.0-pre
  14430. </member>
  14431. <member name="M:NPOI.HSSF.Record.HideObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14432. Constructs an HideObj record and Sets its fields appropriately.
  14433. @param in the RecordInputstream to Read the record from
  14434. </member>
  14435. <member name="M:NPOI.HSSF.Record.HideObjRecord.SetHideObj(System.Int16)">
  14436. Set hide object options
  14437. @param hide options
  14438. @see #HIDE_ALL
  14439. @see #SHOW_PLACEHOLDERS
  14440. @see #SHOW_ALL
  14441. </member>
  14442. <member name="M:NPOI.HSSF.Record.HideObjRecord.GetHideObj">
  14443. Get hide object options
  14444. @return hide options
  14445. @see #HIDE_ALL
  14446. @see #SHOW_PLACEHOLDERS
  14447. @see #SHOW_ALL
  14448. </member>
  14449. <member name="T:NPOI.HSSF.Record.HorizontalPageBreakRecord">
  14450. HorizontalPageBreak record that stores page breaks at rows
  14451. This class Is just used so that SID Compares work properly in the RecordFactory
  14452. @see PageBreakRecord
  14453. @author Danny Mui (dmui at apache dot org)
  14454. </member>
  14455. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor">
  14456. </member>
  14457. <member name="M:NPOI.HSSF.Record.HorizontalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14458. @param in the RecordInputstream to Read the record from
  14459. </member>
  14460. <member name="T:NPOI.HSSF.Record.HyperlinkRecord">
  14461. The <c>HyperlinkRecord</c> wraps an HLINK-record
  14462. from the Excel-97 format.
  14463. Supports only external links for now (eg http://)
  14464. @author Mark Hissink Muller <a href="mailto:mark@hissinkmuller.nl">mark@hissinkmuller.nl</a>
  14465. @author Yegor Kozlov (yegor at apache dot org)
  14466. </member>
  14467. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.HLINK_URL">
  14468. Link flags
  14469. </member>
  14470. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.URL_uninterpretedTail">
  14471. Tail of a URL link
  14472. </member>
  14473. <member name="F:NPOI.HSSF.Record.HyperlinkRecord.FILE_uninterpretedTail">
  14474. Tail of a file link
  14475. </member>
  14476. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._range">
  14477. cell range of this hyperlink
  14478. </member>
  14479. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._guid">
  14480. 16-byte GUID
  14481. </member>
  14482. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._fileOpts">
  14483. Some sort of options for file links.
  14484. </member>
  14485. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._linkOpts">
  14486. Link options. Can include any of HLINK_* flags.
  14487. </member>
  14488. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._label">
  14489. Test label
  14490. </member>
  14491. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._moniker">
  14492. Moniker. Makes sense only for URL and file links
  14493. </member>
  14494. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._shortFilename">
  14495. in 8:3 DOS format No Unicode string header,
  14496. always 8-bit characters, zero-terminated
  14497. </member>
  14498. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._address">
  14499. Link
  14500. </member>
  14501. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._textMark">
  14502. Text describing a place in document. In Excel UI, this is appended to the
  14503. address, (after a '#' delimiter).<br/>
  14504. This field is optional. If present, the {@link #HLINK_PLACE} must be set.
  14505. </member>
  14506. <member name="F:NPOI.HSSF.Record.HyperlinkRecord._uninterpretedTail">
  14507. Remaining bytes
  14508. </member>
  14509. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor">
  14510. Create a new hyperlink
  14511. </member>
  14512. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14513. Read hyperlink from input stream
  14514. @param in the stream to Read from
  14515. </member>
  14516. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstColumn">
  14517. Return the column of the first cell that Contains the hyperlink
  14518. @return the 0-based column of the first cell that Contains the hyperlink
  14519. </member>
  14520. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastColumn">
  14521. Set the column of the last cell that Contains the hyperlink
  14522. @return the 0-based column of the last cell that Contains the hyperlink
  14523. </member>
  14524. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FirstRow">
  14525. Return the row of the first cell that Contains the hyperlink
  14526. @return the 0-based row of the first cell that Contains the hyperlink
  14527. </member>
  14528. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LastRow">
  14529. Return the row of the last cell that Contains the hyperlink
  14530. @return the 0-based row of the last cell that Contains the hyperlink
  14531. </member>
  14532. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Guid">
  14533. Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER}
  14534. @return 16-byte guid identifier
  14535. </member>
  14536. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Moniker">
  14537. Returns a 16-byte moniker.
  14538. @return 16-byte moniker
  14539. </member>
  14540. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Label">
  14541. Return text label for this hyperlink
  14542. @return text to Display
  14543. </member>
  14544. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.Address">
  14545. Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  14546. @return the Address of this hyperlink
  14547. </member>
  14548. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LinkOptions">
  14549. Link options. Must be a combination of HLINK_* constants.
  14550. </member>
  14551. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.LabelOptions">
  14552. Label options
  14553. </member>
  14554. <member name="P:NPOI.HSSF.Record.HyperlinkRecord.FileOptions">
  14555. Options for a file link
  14556. </member>
  14557. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateUrlLink">
  14558. <summary>
  14559. Initialize a new url link
  14560. </summary>
  14561. </member>
  14562. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateFileLink">
  14563. <summary>
  14564. Initialize a new file link
  14565. </summary>
  14566. </member>
  14567. <member name="M:NPOI.HSSF.Record.HyperlinkRecord.CreateDocumentLink">
  14568. <summary>
  14569. Initialize a new document link
  14570. </summary>
  14571. </member>
  14572. <member name="T:NPOI.HSSF.Record.IndexRecord">
  14573. Title: Index Record
  14574. Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet
  14575. Important for locating cells
  14576. NOT USED IN THIS RELEASE
  14577. REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14578. @author Andrew C. Oliver (acoliver at apache dot org)
  14579. @author Jason Height (jheight at chariot dot net dot au)
  14580. @version 2.0-pre
  14581. </member>
  14582. <member name="M:NPOI.HSSF.Record.IndexRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14583. Constructs an Index record and Sets its fields appropriately.
  14584. @param in the RecordInputstream to Read the record from
  14585. </member>
  14586. <member name="M:NPOI.HSSF.Record.IndexRecord.GetRecordSizeForBlockCount(System.Int32)">
  14587. Returns the size of an INdexRecord when it needs to index the specified number of blocks
  14588. </member>
  14589. <member name="T:NPOI.HSSF.Record.InterfaceEndRecord">
  14590. Title: Interface End Record
  14591. Description: Shows where the Interface Records end (MMS)
  14592. (has no fields)
  14593. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14594. @author Andrew C. Oliver (acoliver at apache dot org)
  14595. @version 2.0-pre
  14596. </member>
  14597. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.Create(NPOI.HSSF.Record.RecordInputStream)">
  14598. Constructs an InterfaceEnd record and Sets its fields appropriately.
  14599. @param in the RecordInputstream to Read the record from
  14600. </member>
  14601. <member name="M:NPOI.HSSF.Record.InterfaceEndRecord.GetDataSize">
  14602. <summary>
  14603. for test TestInterfaceEndRecord.TestCreate()
  14604. </summary>
  14605. <returns></returns>
  14606. </member>
  14607. <member name="T:NPOI.HSSF.Record.InterfaceHdrRecord">
  14608. Title: Interface Header Record
  14609. Description: Defines the beginning of Interface records (MMS)
  14610. REFERENCE: PG 324 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14611. @author Andrew C. Oliver (acoliver at apache dot org)
  14612. @version 2.0-pre
  14613. </member>
  14614. <member name="F:NPOI.HSSF.Record.InterfaceHdrRecord.CODEPAGE">
  14615. suggested (and probably correct) default
  14616. </member>
  14617. <member name="M:NPOI.HSSF.Record.InterfaceHdrRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14618. Constructs an Codepage record and Sets its fields appropriately.
  14619. @param in the RecordInputstream to Read the record from
  14620. </member>
  14621. <member name="T:NPOI.HSSF.Record.IterationRecord">
  14622. Title: Iteration Record
  14623. Description: Tells whether to iterate over forumla calculations or not
  14624. (if a formula Is dependant upon another formula's result)
  14625. (odd feature for something that can only have 32 elements in
  14626. a formula!)
  14627. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14628. @author Andrew C. Oliver (acoliver at apache dot org)
  14629. @author Jason Height (jheight at chariot dot net dot au)
  14630. @version 2.0-pre
  14631. </member>
  14632. <member name="M:NPOI.HSSF.Record.IterationRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14633. Constructs an Iteration record and Sets its fields appropriately.
  14634. @param in the RecordInputstream to Read the record from
  14635. </member>
  14636. <member name="P:NPOI.HSSF.Record.IterationRecord.Iteration">
  14637. Get whether or not to iterate for calculations
  14638. @return whether iterative calculations are turned off or on
  14639. </member>
  14640. <member name="T:NPOI.HSSF.Record.LabelRecord">
  14641. Label Record - Read only support for strings stored directly in the cell.. Don't
  14642. use this (except to Read), use LabelSST instead
  14643. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14644. @see org.apache.poi.hssf.record.LabelSSTRecord
  14645. </member>
  14646. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor">
  14647. Creates new LabelRecord
  14648. </member>
  14649. <member name="M:NPOI.HSSF.Record.LabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14650. Constructs an Label record and Sets its fields appropriately.
  14651. @param in the RecordInputstream to Read the record from
  14652. </member>
  14653. <member name="P:NPOI.HSSF.Record.LabelRecord.StringLength">
  14654. Get the number of Chars this string Contains
  14655. @return number of Chars
  14656. </member>
  14657. <member name="P:NPOI.HSSF.Record.LabelRecord.IsUncompressedUnicode">
  14658. Is this Uncompressed Unicode (16bit)? Or just 8-bit compressed?
  14659. @return IsUnicode - True for 16bit- false for 8bit
  14660. </member>
  14661. <member name="P:NPOI.HSSF.Record.LabelRecord.Value">
  14662. Get the value
  14663. @return the text string
  14664. @see #GetStringLength
  14665. </member>
  14666. <member name="M:NPOI.HSSF.Record.LabelRecord.Serialize(System.Int32,System.Byte[])">
  14667. THROWS A RUNTIME EXCEPTION.. USE LABELSSTRecords. YOU HAVE NO REASON to use LABELRecord!!
  14668. </member>
  14669. <member name="T:NPOI.HSSF.Record.LabelSSTRecord">
  14670. Title: Label SST Record
  14671. Description: Refers to a string in the shared string table and Is a column
  14672. value.
  14673. REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14674. @author Andrew C. Oliver (acoliver at apache dot org)
  14675. @author Jason Height (jheight at chariot dot net dot au)
  14676. @version 2.0-pre
  14677. </member>
  14678. <member name="M:NPOI.HSSF.Record.LabelSSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14679. Constructs an LabelSST record and Sets its fields appropriately.
  14680. @param in the RecordInputstream to Read the record from
  14681. </member>
  14682. <member name="P:NPOI.HSSF.Record.LabelSSTRecord.SSTIndex">
  14683. Get the index to the string in the SSTRecord
  14684. @return index of string in the SST Table
  14685. @see org.apache.poi.hssf.record.SSTRecord
  14686. </member>
  14687. <member name="T:NPOI.HSSF.Record.LeftMarginRecord">
  14688. Record for the left margin.
  14689. NOTE: This source was automatically generated.
  14690. @author Shawn Laubach (slaubach at apache dot org)
  14691. </member>
  14692. <member name="M:NPOI.HSSF.Record.LeftMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14693. Constructs a LeftMargin record and Sets its fields appropriately.
  14694. @param in the RecordInputstream to Read the record from
  14695. </member>
  14696. <member name="P:NPOI.HSSF.Record.LeftMarginRecord.Margin">
  14697. Get the margin field for the LeftMargin record.
  14698. </member>
  14699. <member name="T:NPOI.HSSF.Record.LinkedDataFormulaField">
  14700. Not implemented yet. May commit it anyway just so people can see
  14701. where I'm heading.
  14702. @author Glen Stampoultzis (glens at apache.org)
  14703. </member>
  14704. <member name="T:NPOI.HSSF.Record.IMargin">
  14705. The margin interface Is a parent used to define left, right, top and bottom margins.
  14706. This allows much of the code to be generic when it comes to handling margins.
  14707. NOTE: This source wass automatically generated.
  14708. @author Shawn Laubach (slaubach at apache dot org)
  14709. </member>
  14710. <member name="P:NPOI.HSSF.Record.IMargin.Margin">
  14711. Get the margin field for the Margin.
  14712. </member>
  14713. <member name="T:NPOI.HSSF.Record.MergeCellsRecord">
  14714. Title: Merged Cells Record
  14715. Description: Optional record defining a square area of cells to "merged" into
  14716. one cell.
  14717. REFERENCE: NONE (UNDOCUMENTED PRESENTLY)
  14718. @author Andrew C. Oliver (acoliver at apache dot org)
  14719. @version 2.0-pre
  14720. </member>
  14721. <member name="F:NPOI.HSSF.Record.MergeCellsRecord._regions">
  14722. sometimes the regions array is shared with other MergedCellsRecords
  14723. </member>
  14724. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14725. Constructs a MergedCellsRecord and Sets its fields appropriately
  14726. @param in the RecordInputstream to Read the record from
  14727. </member>
  14728. <member name="P:NPOI.HSSF.Record.MergeCellsRecord.NumAreas">
  14729. Get the number of merged areas. If this drops down to 0 you should just go
  14730. ahead and delete the record.
  14731. @return number of areas
  14732. </member>
  14733. <member name="M:NPOI.HSSF.Record.MergeCellsRecord.GetAreaAt(System.Int32)">
  14734. @return MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
  14735. </member>
  14736. <member name="T:NPOI.HSSF.Record.MMSRecord">
  14737. Title: MMS Record
  14738. Description: defines how many Add menu and del menu options are stored
  14739. in the file. Should always be Set to 0 for HSSF workbooks
  14740. REFERENCE: PG 328 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14741. @author Andrew C. Oliver (acoliver at apache dot org)
  14742. @version 2.0-pre
  14743. </member>
  14744. <member name="M:NPOI.HSSF.Record.MMSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14745. Constructs a MMS record and Sets its fields appropriately.
  14746. @param in the RecordInputstream to Read the record from
  14747. </member>
  14748. <member name="P:NPOI.HSSF.Record.MMSRecord.AddMenuCount">
  14749. Set number of Add menu options (Set to 0)
  14750. @param am number of Add menu options
  14751. </member>
  14752. <member name="P:NPOI.HSSF.Record.MMSRecord.DelMenuCount">
  14753. Set number of del menu options (Set to 0)
  14754. @param dm number of del menu options
  14755. </member>
  14756. <member name="T:NPOI.HSSF.Record.MulBlankRecord">
  14757. Title: Mulitple Blank cell record
  14758. Description: Represents a Set of columns in a row with no value but with styling.
  14759. In this release we have Read-only support for this record type.
  14760. The RecordFactory Converts this to a Set of BlankRecord objects.
  14761. REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14762. @author Andrew C. Oliver (acoliver at apache dot org)
  14763. @author Glen Stampoultzis (glens at apache.org)
  14764. @version 2.0-pre
  14765. @see org.apache.poi.hssf.record.BlankRecord
  14766. </member>
  14767. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor">
  14768. Creates new MulBlankRecord
  14769. </member>
  14770. <member name="M:NPOI.HSSF.Record.MulBlankRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14771. Constructs a MulBlank record and Sets its fields appropriately.
  14772. @param in the RecordInputstream to Read the record from
  14773. </member>
  14774. <member name="P:NPOI.HSSF.Record.MulBlankRecord.Row">
  14775. Get the row number of the cells this represents
  14776. @return row number
  14777. </member>
  14778. <member name="P:NPOI.HSSF.Record.MulBlankRecord.FirstColumn">
  14779. starting column (first cell this holds in the row)
  14780. @return first column number
  14781. </member>
  14782. <member name="P:NPOI.HSSF.Record.MulBlankRecord.LastColumn">
  14783. ending column (last cell this holds in the row)
  14784. @return first column number
  14785. </member>
  14786. <member name="P:NPOI.HSSF.Record.MulBlankRecord.NumColumns">
  14787. Get the number of columns this Contains (last-first +1)
  14788. @return number of columns (last - first +1)
  14789. </member>
  14790. <member name="M:NPOI.HSSF.Record.MulBlankRecord.GetXFAt(System.Int32)">
  14791. returns the xf index for column (coffset = column - field_2_first_col)
  14792. @param coffset the column (coffset = column - field_2_first_col)
  14793. @return the XF index for the column
  14794. </member>
  14795. <member name="T:NPOI.HSSF.Record.MulRKRecord">
  14796. Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values.
  14797. HSSF just Converts this into multiple NUMBER records. Read-ONLY SUPPORT!
  14798. REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  14799. @author Andrew C. Oliver (acoliver at apache dot org)
  14800. @version 2.0-pre
  14801. </member>
  14802. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor">
  14803. Creates new MulRKRecord
  14804. </member>
  14805. <member name="M:NPOI.HSSF.Record.MulRKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14806. Constructs a MulRK record and Sets its fields appropriately.
  14807. @param in the RecordInputstream to Read the record from
  14808. </member>
  14809. <member name="P:NPOI.HSSF.Record.MulRKRecord.FirstColumn">
  14810. starting column (first cell this holds in the row)
  14811. @return first column number
  14812. </member>
  14813. <member name="P:NPOI.HSSF.Record.MulRKRecord.LastColumn">
  14814. ending column (last cell this holds in the row)
  14815. @return first column number
  14816. </member>
  14817. <member name="P:NPOI.HSSF.Record.MulRKRecord.NumColumns">
  14818. Get the number of columns this Contains (last-first +1)
  14819. @return number of columns (last - first +1)
  14820. </member>
  14821. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetXFAt(System.Int32)">
  14822. returns the xf index for column (coffset = column - field_2_first_col)
  14823. @return the XF index for the column
  14824. </member>
  14825. <member name="M:NPOI.HSSF.Record.MulRKRecord.GetRKNumberAt(System.Int32)">
  14826. returns the rk number for column (coffset = column - field_2_first_col)
  14827. @return the value (decoded into a double)
  14828. </member>
  14829. <member name="T:NPOI.HSSF.Record.NameCommentRecord">
  14830. Title: NAMECMT Record (0x0894)
  14831. Description: Defines a comment associated with a specified name.
  14832. REFERENCE:
  14833. @author Andrew Shirley (aks at corefiling.co.uk)
  14834. </member>
  14835. <member name="M:NPOI.HSSF.Record.NameCommentRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14836. @param ris the RecordInputstream to read the record from
  14837. </member>
  14838. <member name="P:NPOI.HSSF.Record.NameCommentRecord.Sid">
  14839. return the non static version of the id for this record.
  14840. </member>
  14841. <member name="P:NPOI.HSSF.Record.NameCommentRecord.NameText">
  14842. @return the name of the NameRecord to which this comment applies.
  14843. </member>
  14844. <member name="P:NPOI.HSSF.Record.NameCommentRecord.CommentText">
  14845. @return the text of the comment.
  14846. </member>
  14847. <member name="T:NPOI.HSSF.Record.NameRecord">
  14848. Title: Name Record (aka Named Range)
  14849. Description: Defines a named range within a workbook.
  14850. REFERENCE:
  14851. @author Libin Roman (Vista Portal LDT. Developer)
  14852. @author Sergei Kozello (sergeikozello at mail.ru)
  14853. @author Glen Stampoultzis (glens at apache.org)
  14854. @version 1.0-pre
  14855. </member>
  14856. <member name="F:NPOI.HSSF.Record.NameRecord.sid">
  14857. </member>
  14858. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CONSOLIDATE_AREA">
  14859. Included for completeness sake, not implemented
  14860. </member>
  14861. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_OPEN">
  14862. Included for completeness sake, not implemented
  14863. </member>
  14864. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_CLOSE">
  14865. Included for completeness sake, not implemented
  14866. </member>
  14867. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATABASE">
  14868. Included for completeness sake, not implemented
  14869. </member>
  14870. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_CRITERIA">
  14871. Included for completeness sake, not implemented
  14872. </member>
  14873. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_RECORDER">
  14874. Included for completeness sake, not implemented
  14875. </member>
  14876. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_DATA_FORM">
  14877. Included for completeness sake, not implemented
  14878. </member>
  14879. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_ACTIVATE">
  14880. Included for completeness sake, not implemented
  14881. </member>
  14882. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_AUTO_DEACTIVATE">
  14883. Included for completeness sake, not implemented
  14884. </member>
  14885. <member name="F:NPOI.HSSF.Record.NameRecord.BUILTIN_SHEET_TITLE">
  14886. Included for completeness sake, not implemented
  14887. </member>
  14888. <member name="F:NPOI.HSSF.Record.NameRecord.field_5_externSheetIndex_plus1">
  14889. One-based extern index of sheet (resolved via LinkTable). Zero if this is a global name
  14890. </member>
  14891. <member name="F:NPOI.HSSF.Record.NameRecord.field_6_sheetNumber">
  14892. the one based sheet number.
  14893. </member>
  14894. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor">
  14895. Creates new NameRecord
  14896. </member>
  14897. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  14898. Constructs a Name record and Sets its fields appropriately.
  14899. @param in the RecordInputstream to Read the record from
  14900. </member>
  14901. <member name="M:NPOI.HSSF.Record.NameRecord.#ctor(System.Byte,System.Int32)">
  14902. Constructor to Create a built-in named region
  14903. @param builtin Built-in byte representation for the name record, use the public constants
  14904. @param index
  14905. </member>
  14906. <member name="P:NPOI.HSSF.Record.NameRecord.FnGroup">
  14907. @return function Group
  14908. @see FnGroupCountRecord
  14909. </member>
  14910. <member name="P:NPOI.HSSF.Record.NameRecord.OptionFlag">
  14911. Gets the option flag
  14912. @return option flag
  14913. </member>
  14914. <member name="P:NPOI.HSSF.Record.NameRecord.KeyboardShortcut">
  14915. returns the keyboard shortcut
  14916. @return keyboard shortcut
  14917. </member>
  14918. <member name="P:NPOI.HSSF.Record.NameRecord.NameTextLength">
  14919. **
  14920. </member>
  14921. <member name="M:NPOI.HSSF.Record.NameRecord.SetFunction(System.Boolean)">
  14922. Indicates that the defined name refers to a user-defined function.
  14923. This attribute is used when there is an add-in or other code project associated with the file.
  14924. @param function <c>true</c> indicates the name refers to a function.
  14925. </member>
  14926. <member name="P:NPOI.HSSF.Record.NameRecord.HasFormula">
  14927. @return <c>true</c> if name has a formula (named range or defined value)
  14928. </member>
  14929. <member name="P:NPOI.HSSF.Record.NameRecord.IsHiddenName">
  14930. @return true if name Is hidden
  14931. </member>
  14932. <member name="P:NPOI.HSSF.Record.NameRecord.IsFunctionName">
  14933. @return true if name Is a function
  14934. </member>
  14935. <member name="P:NPOI.HSSF.Record.NameRecord.IsCommandName">
  14936. @return true if name Is a command
  14937. </member>
  14938. <member name="P:NPOI.HSSF.Record.NameRecord.IsMacro">
  14939. @return true if function macro or command macro
  14940. </member>
  14941. <member name="P:NPOI.HSSF.Record.NameRecord.IsComplexFunction">
  14942. @return true if array formula or user defined
  14943. </member>
  14944. <member name="P:NPOI.HSSF.Record.NameRecord.IsBuiltInName">
  14945. Convenience Function to determine if the name Is a built-in name
  14946. </member>
  14947. <member name="P:NPOI.HSSF.Record.NameRecord.NameText">
  14948. Gets the name
  14949. @return name
  14950. </member>
  14951. <member name="P:NPOI.HSSF.Record.NameRecord.BuiltInName">
  14952. Gets the Built In Name
  14953. @return the built in Name
  14954. </member>
  14955. <member name="P:NPOI.HSSF.Record.NameRecord.NameDefinition">
  14956. Gets the definition, reference (Formula)
  14957. @return definition -- can be null if we cant Parse ptgs
  14958. </member>
  14959. <member name="P:NPOI.HSSF.Record.NameRecord.CustomMenuText">
  14960. Get the custom menu text
  14961. @return custom menu text
  14962. </member>
  14963. <member name="P:NPOI.HSSF.Record.NameRecord.DescriptionText">
  14964. Gets the description text
  14965. @return description text
  14966. </member>
  14967. <member name="P:NPOI.HSSF.Record.NameRecord.HelpTopicText">
  14968. Get the help topic text
  14969. @return gelp topic text
  14970. </member>
  14971. <member name="P:NPOI.HSSF.Record.NameRecord.StatusBarText">
  14972. Gets the status bar text
  14973. @return status bar text
  14974. </member>
  14975. <member name="P:NPOI.HSSF.Record.NameRecord.SheetNumber">
  14976. For named ranges, and built-in names
  14977. @return the 1-based sheet number.
  14978. </member>
  14979. <member name="M:NPOI.HSSF.Record.NameRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  14980. called by the class that Is responsible for writing this sucker.
  14981. Subclasses should implement this so that their data Is passed back in a
  14982. @param offset to begin writing at
  14983. @param data byte array containing instance data
  14984. @return number of bytes written
  14985. </member>
  14986. <member name="P:NPOI.HSSF.Record.NameRecord.ExternSheetNumber">
  14987. Gets the extern sheet number
  14988. @return extern sheet index
  14989. </member>
  14990. <member name="P:NPOI.HSSF.Record.NameRecord.Sid">
  14991. return the non static version of the id for this record.
  14992. </member>
  14993. <member name="M:NPOI.HSSF.Record.NameRecord.ToString">
  14994. @see Object#ToString()
  14995. </member>
  14996. <member name="M:NPOI.HSSF.Record.NameRecord.TranslateBuiltInName(System.Byte)">
  14997. Creates a human Readable name for built in types
  14998. @return Unknown if the built-in name cannot be translated
  14999. </member>
  15000. <member name="T:NPOI.HSSF.Record.NoteRecord">
  15001. NOTE: Comment Associated with a Cell (1Ch)
  15002. @author Yegor Kozlov
  15003. </member>
  15004. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_HIDDEN">
  15005. Flag indicating that the comment Is hidden (default)
  15006. </member>
  15007. <member name="F:NPOI.HSSF.Record.NoteRecord.NOTE_VISIBLE">
  15008. Flag indicating that the comment Is visible
  15009. </member>
  15010. <member name="F:NPOI.HSSF.Record.NoteRecord.field_7_padding">
  15011. Saves padding byte value to reduce delta during round-trip serialization.<br/>
  15012. The documentation is not clear about how padding should work. In any case
  15013. Excel(2007) does something different.
  15014. </member>
  15015. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor">
  15016. Construct a new <c>NoteRecord</c> and
  15017. Fill its data with the default values
  15018. </member>
  15019. <member name="M:NPOI.HSSF.Record.NoteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15020. Constructs a <c>NoteRecord</c> and Fills its fields
  15021. from the supplied <c>RecordInputStream</c>.
  15022. @param in the stream to Read from
  15023. </member>
  15024. <member name="P:NPOI.HSSF.Record.NoteRecord.Sid">
  15025. @return id of this record.
  15026. </member>
  15027. <member name="M:NPOI.HSSF.Record.NoteRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  15028. Serialize the record data into the supplied array of bytes
  15029. @param offset offset in the <c>data</c>
  15030. @param data the data to Serialize into
  15031. @return size of the record
  15032. </member>
  15033. <member name="P:NPOI.HSSF.Record.NoteRecord.DataSize">
  15034. Size of record
  15035. </member>
  15036. <member name="M:NPOI.HSSF.Record.NoteRecord.ToString">
  15037. Convert this record to string.
  15038. Used by BiffViewer and other utulities.
  15039. </member>
  15040. <member name="P:NPOI.HSSF.Record.NoteRecord.Row">
  15041. Return the row that Contains the comment
  15042. @return the row that Contains the comment
  15043. </member>
  15044. <member name="P:NPOI.HSSF.Record.NoteRecord.Column">
  15045. Return the column that Contains the comment
  15046. @return the column that Contains the comment
  15047. </member>
  15048. <member name="P:NPOI.HSSF.Record.NoteRecord.Flags">
  15049. Options flags.
  15050. @return the options flag
  15051. @see #NOTE_VISIBLE
  15052. @see #NOTE_HIDDEN
  15053. </member>
  15054. <member name="P:NPOI.HSSF.Record.NoteRecord.ShapeId">
  15055. Object id for OBJ record that Contains the comment
  15056. </member>
  15057. <member name="P:NPOI.HSSF.Record.NoteRecord.Author">
  15058. Name of the original comment author
  15059. @return the name of the original author of the comment
  15060. </member>
  15061. <member name="P:NPOI.HSSF.Record.NoteRecord.AuthorIsMultibyte">
  15062. For unit testing only!
  15063. </member>
  15064. <member name="T:NPOI.HSSF.Record.NumberRecord">
  15065. Contains a numeric cell value.
  15066. REFERENCE: PG 334 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15067. @author Andrew C. Oliver (acoliver at apache dot org)
  15068. @author Jason Height (jheight at chariot dot net dot au)
  15069. @version 2.0-pre
  15070. </member>
  15071. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor">
  15072. Creates new NumberRecord
  15073. </member>
  15074. <member name="M:NPOI.HSSF.Record.NumberRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15075. Constructs a Number record and Sets its fields appropriately.
  15076. @param in the RecordInputstream to Read the record from
  15077. </member>
  15078. <member name="P:NPOI.HSSF.Record.NumberRecord.Value">
  15079. Get the value for the cell
  15080. @return double representing the value
  15081. </member>
  15082. <member name="T:NPOI.HSSF.Record.ObjectProtectRecord">
  15083. Title: Object Protect Record
  15084. Description: Protect embedded object with the lamest "security" ever invented.
  15085. This record tells "I want to protect my objects" with lame security. It
  15086. appears in conjunction with the PASSWORD and PROTECT records as well as its
  15087. scenario protect cousin.
  15088. REFERENCE: PG 368 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15089. @author Andrew C. Oliver (acoliver at apache dot org)
  15090. </member>
  15091. <member name="M:NPOI.HSSF.Record.ObjectProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15092. Constructs a Protect record and Sets its fields appropriately.
  15093. @param in the RecordInputstream to Read the record from
  15094. </member>
  15095. <member name="P:NPOI.HSSF.Record.ObjectProtectRecord.Protect">
  15096. Get whether the sheet Is protected or not
  15097. @return whether to protect the sheet or not
  15098. </member>
  15099. <member name="T:NPOI.HSSF.Record.ObjRecord">
  15100. The obj record is used to hold various graphic objects and controls.
  15101. @author Glen Stampoultzis (glens at apache.org)
  15102. </member>
  15103. <member name="F:NPOI.HSSF.Record.ObjRecord._uninterpretedData">
  15104. used when POI has no idea what is going on
  15105. </member>
  15106. <member name="F:NPOI.HSSF.Record.ObjRecord._isPaddedToQuadByteMultiple">
  15107. Excel seems to tolerate padding to quad or double byte length
  15108. </member>
  15109. <member name="M:NPOI.HSSF.Record.ObjRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15110. Constructs a OBJ record and Sets its fields appropriately.
  15111. @param in the RecordInputstream to Read the record from
  15112. </member>
  15113. <member name="M:NPOI.HSSF.Record.ObjRecord.CanPaddingBeDiscarded(System.Byte[],System.Int32)">
  15114. Some XLS files have ObjRecords with nearly 8Kb of excessive padding. These were probably
  15115. written by a version of POI (around 3.1) which incorrectly interpreted the second short of
  15116. the ftLbs subrecord (0x1FEE) as a length, and read that many bytes as padding (other bugs
  15117. helped allow this to occur).
  15118. Excel reads files with this excessive padding OK, truncating the over-sized ObjRecord back
  15119. to the its proper size. POI does the same.
  15120. </member>
  15121. <member name="P:NPOI.HSSF.Record.ObjRecord.RecordSize">
  15122. Size of record (excluding 4 byte header)
  15123. </member>
  15124. <member name="T:NPOI.HSSF.Record.OldCellRecord">
  15125. Base class for all old (Biff 2 - Biff 4) cell value records
  15126. (implementors of {@link CellValueRecordInterface}).
  15127. Subclasses are expected to manage the cell data values (of various types).
  15128. </member>
  15129. <member name="P:NPOI.HSSF.Record.OldCellRecord.XFIndex">
  15130. Get the index to the ExtendedFormat, for non-Biff2
  15131. @see NPOI.HSSF.Record.ExtendedFormatRecord
  15132. @return index to the XF record
  15133. </member>
  15134. <member name="P:NPOI.HSSF.Record.OldCellRecord.IsBiff2">
  15135. Is this a Biff2 record, or newer?
  15136. </member>
  15137. <member name="M:NPOI.HSSF.Record.OldCellRecord.AppendValueText(System.Text.StringBuilder)">
  15138. Append specific debug info (used by {@link #ToString()} for the value
  15139. Contained in this record. Trailing new-line should not be Appended
  15140. (superclass does that).
  15141. </member>
  15142. <member name="P:NPOI.HSSF.Record.OldCellRecord.RecordName">
  15143. Gets the debug info BIFF record type name (used by {@link #ToString()}.
  15144. </member>
  15145. <member name="T:NPOI.HSSF.Record.OldFormulaRecord">
  15146. Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in
  15147. encoded form, along with the value if a number
  15148. </member>
  15149. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Value">
  15150. Get the calculated value of the formula
  15151. @return calculated value
  15152. </member>
  15153. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.Options">
  15154. Get the option flags
  15155. @return bitmask
  15156. </member>
  15157. <member name="P:NPOI.HSSF.Record.OldFormulaRecord.ParsedExpression">
  15158. @return the formula tokens. never <code>null</code>
  15159. </member>
  15160. <member name="T:NPOI.HSSF.Record.OldLabelRecord">
  15161. Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for
  15162. strings stored directly in the cell, from the older file formats that
  15163. didn't use {@link LabelSSTRecord}
  15164. </member>
  15165. <member name="M:NPOI.HSSF.Record.OldLabelRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15166. @param in the RecordInputstream to read the record from
  15167. </member>
  15168. <member name="P:NPOI.HSSF.Record.OldLabelRecord.StringLength">
  15169. Get the number of characters this string Contains
  15170. @return number of characters
  15171. </member>
  15172. <member name="P:NPOI.HSSF.Record.OldLabelRecord.Value">
  15173. Get the String of the cell
  15174. </member>
  15175. <member name="M:NPOI.HSSF.Record.OldLabelRecord.Serialize(System.Int32,System.Byte[])">
  15176. Not supported
  15177. </member>
  15178. <member name="T:NPOI.HSSF.Record.OldSheetRecord">
  15179. Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5<br/>
  15180. Description: Defines a sheet within a workbook. Basically stores the sheet name
  15181. and tells where the Beginning of file record is within the HSSF
  15182. file.
  15183. </member>
  15184. <member name="P:NPOI.HSSF.Record.OldSheetRecord.PositionOfBof">
  15185. Get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
  15186. @return offset in bytes
  15187. </member>
  15188. <member name="P:NPOI.HSSF.Record.OldSheetRecord.Sheetname">
  15189. Get the sheetname for this sheet. (this appears in the tabs at the bottom)
  15190. @return sheetname the name of the sheet
  15191. </member>
  15192. <member name="T:NPOI.HSSF.Record.OldStringRecord">
  15193. Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for
  15194. formula string results.
  15195. </member>
  15196. <member name="M:NPOI.HSSF.Record.OldStringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15197. @param in the RecordInputstream to read the record from
  15198. </member>
  15199. <member name="M:NPOI.HSSF.Record.OldStringRecord.GetString">
  15200. @return The string represented by this record.
  15201. </member>
  15202. <member name="T:NPOI.HSSF.Record.PageBreakRecord">
  15203. Record that Contains the functionality page _breaks (horizontal and vertical)
  15204. The other two classes just specifically Set the SIDS for record creation.
  15205. REFERENCE: Microsoft Excel SDK page 322 and 420
  15206. @see HorizontalPageBreakRecord
  15207. @see VerticalPageBreakRecord
  15208. @author Danny Mui (dmui at apache dot org)
  15209. </member>
  15210. <member name="T:NPOI.HSSF.Record.PageBreakRecord.Break">
  15211. Since both records store 2byte integers (short), no point in
  15212. differentiating it in the records.
  15213. The subs (rows or columns, don't seem to be able to Set but excel Sets
  15214. them automatically)
  15215. </member>
  15216. <member name="M:NPOI.HSSF.Record.PageBreakRecord.AddBreak(System.Int32,System.Int32,System.Int32)">
  15217. Adds the page break at the specified parameters
  15218. @param main Depending on sid, will determine row or column to put page break (zero-based)
  15219. @param subFrom No user-interface to Set (defaults to minumum, 0)
  15220. @param subTo No user-interface to Set
  15221. </member>
  15222. <member name="M:NPOI.HSSF.Record.PageBreakRecord.RemoveBreak(System.Int32)">
  15223. Removes the break indicated by the parameter
  15224. @param main (zero-based)
  15225. </member>
  15226. <member name="M:NPOI.HSSF.Record.PageBreakRecord.GetBreak(System.Int32)">
  15227. Retrieves the region at the row/column indicated
  15228. @param main FIXME: Document this!
  15229. @return The Break or null if no break exists at the row/col specified.
  15230. </member>
  15231. <member name="T:NPOI.HSSF.Record.PaletteRecord">
  15232. PaletteRecord - Supports custom palettes.
  15233. @author Andrew C. Oliver (acoliver at apache dot org)
  15234. @author Brian Sanders (bsanders at risklabs dot com) - custom palette editing
  15235. @version 2.0-pre
  15236. </member>
  15237. <member name="F:NPOI.HSSF.Record.PaletteRecord.STANDARD_PALETTE_SIZE">
  15238. The standard size of an XLS palette
  15239. </member>
  15240. <member name="F:NPOI.HSSF.Record.PaletteRecord.FIRST_COLOR_INDEX">
  15241. The byte index of the first color
  15242. </member>
  15243. <member name="M:NPOI.HSSF.Record.PaletteRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15244. Constructs a PaletteRecord record and Sets its fields appropriately.
  15245. @param in the RecordInputstream to Read the record from
  15246. </member>
  15247. <member name="M:NPOI.HSSF.Record.PaletteRecord.ClearColors">
  15248. <summary>
  15249. Dangerous! Only call this if you intend to replace the colors!
  15250. </summary>
  15251. </member>
  15252. <member name="M:NPOI.HSSF.Record.PaletteRecord.GetColor(System.Int16)">
  15253. Returns the color value at a given index
  15254. @return the RGB triplet for the color, or null if the specified index
  15255. does not exist
  15256. </member>
  15257. <member name="M:NPOI.HSSF.Record.PaletteRecord.SetColor(System.Int16,System.Byte,System.Byte,System.Byte)">
  15258. Sets the color value at a given index
  15259. If the given index Is greater than the current last color index,
  15260. then black Is Inserted at every index required to make the palette continuous.
  15261. @param byteIndex the index to Set; if this index Is less than 0x8 or greater than
  15262. 0x40, then no modification Is made
  15263. </member>
  15264. <member name="M:NPOI.HSSF.Record.PaletteRecord.CreateDefaultPalette">
  15265. Creates the default palette as PaletteRecord binary data
  15266. @see org.apache.poi.hssf.model.Workbook#createPalette
  15267. </member>
  15268. <member name="T:NPOI.HSSF.Record.PColor">
  15269. PColor - element in the list of colors - consider it a "struct"
  15270. </member>
  15271. <member name="T:NPOI.HSSF.Record.PaneRecord">
  15272. * Describes the frozen and Unfozen panes.
  15273. * NOTE: This source Is automatically generated please do not modify this file. Either subclass or
  15274. * Remove the record in src/records/definitions.
  15275. * @author Glen Stampoultzis (glens at apache.org)
  15276. </member>
  15277. <member name="M:NPOI.HSSF.Record.PaneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15278. Constructs a Pane record and Sets its fields appropriately.
  15279. @param in the RecordInputstream to Read the record from
  15280. </member>
  15281. <member name="P:NPOI.HSSF.Record.PaneRecord.X">
  15282. Get the x field for the Pane record.
  15283. </member>
  15284. <member name="P:NPOI.HSSF.Record.PaneRecord.Y">
  15285. Get the y field for the Pane record.
  15286. </member>
  15287. <member name="P:NPOI.HSSF.Record.PaneRecord.TopRow">
  15288. Get the top row field for the Pane record.
  15289. </member>
  15290. <member name="P:NPOI.HSSF.Record.PaneRecord.LeftColumn">
  15291. Get the left column field for the Pane record.
  15292. </member>
  15293. <member name="P:NPOI.HSSF.Record.PaneRecord.ActivePane">
  15294. Get the active pane field for the Pane record.
  15295. @return One of
  15296. ACTIVE_PANE_LOWER_RIGHT
  15297. ACTIVE_PANE_UPPER_RIGHT
  15298. ACTIVE_PANE_LOWER_LEFT
  15299. ACTIVE_PANE_UPPER_LEFT
  15300. </member>
  15301. <member name="T:NPOI.HSSF.Record.PasswordRecord">
  15302. Title: Password Record
  15303. Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)
  15304. REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15305. @author Andrew C. Oliver (acoliver at apache dot org)
  15306. @version 2.0-pre
  15307. </member>
  15308. <member name="M:NPOI.HSSF.Record.PasswordRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15309. Constructs a Password record and Sets its fields appropriately.
  15310. @param in the RecordInputstream to Read the record from
  15311. </member>
  15312. <member name="P:NPOI.HSSF.Record.PasswordRecord.Password">
  15313. Get the password
  15314. @return short representing the password
  15315. </member>
  15316. <member name="M:NPOI.HSSF.Record.PasswordRecord.Clone">
  15317. Clone this record.
  15318. </member>
  15319. <member name="T:NPOI.HSSF.Record.PasswordRev4Record">
  15320. Title: Protection Revision 4 password Record
  15321. Description: Stores the (2 byte??!!) encrypted password for a shared
  15322. workbook
  15323. REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15324. @author Andrew C. Oliver (acoliver at apache dot org)
  15325. @version 2.0-pre
  15326. </member>
  15327. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15328. Constructs a PasswordRev4 (PROT4REVPASS) record and Sets its fields appropriately.
  15329. @param in the RecordInputstream to Read the record from
  15330. </member>
  15331. <member name="M:NPOI.HSSF.Record.PasswordRev4Record.SetPassword(System.Int16)">
  15332. set the password
  15333. @param pw representing the password
  15334. </member>
  15335. <member name="T:NPOI.HSSF.Record.PivotTable.DataItemRecord">
  15336. SXDI - Data Item (0x00C5)<br/>
  15337. @author Patrick Cheng
  15338. </member>
  15339. <member name="T:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord">
  15340. SXVDEX - Extended PivotTable View Fields (0x0100)<br/>
  15341. @author Patrick Cheng
  15342. </member>
  15343. <member name="F:NPOI.HSSF.Record.PivotTable.ExtendedPivotTableViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  15344. the value of the <c>cchSubName</c> field when the subName is not present
  15345. </member>
  15346. <member name="T:NPOI.HSSF.Record.PivotTable.PageItemRecord">
  15347. SXPI - Page Item (0x00B6)<br/>
  15348. @author Patrick Cheng
  15349. </member>
  15350. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvi">
  15351. Index to the View Item SXVI(0x00B2) record
  15352. </member>
  15353. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._isxvd">
  15354. Index to the {@link ViewFieldsRecord} SXVD(0x00B1) record
  15355. </member>
  15356. <member name="F:NPOI.HSSF.Record.PivotTable.PageItemRecord.FieldInfo._idObj">
  15357. Object ID for the drop-down arrow
  15358. </member>
  15359. <member name="T:NPOI.HSSF.Record.PivotTable.StreamIDRecord">
  15360. SXIDSTM - Stream ID (0x00D5)<br/>
  15361. @author Patrick Cheng
  15362. </member>
  15363. <member name="T:NPOI.HSSF.Record.PivotTable.ViewDefinitionRecord">
  15364. SXVIEW - View Definition (0x00B0)<br/>
  15365. @author Patrick Cheng
  15366. </member>
  15367. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord">
  15368. SXVD - View Fields (0x00B1)<br/>
  15369. @author Patrick Cheng
  15370. </member>
  15371. <member name="T:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.Axis">
  15372. values for the {@link ViewFieldsRecord#sxaxis} field
  15373. </member>
  15374. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.STRING_NOT_PRESENT_LEN">
  15375. the value of the <c>cchName</c> field when the name is not present
  15376. </member>
  15377. <member name="F:NPOI.HSSF.Record.PivotTable.ViewFieldsRecord.BASE_SIZE">
  15378. 5 shorts
  15379. </member>
  15380. <member name="T:NPOI.HSSF.Record.PivotTable.ViewSourceRecord">
  15381. SXVS - View Source (0x00E3)<br/>
  15382. @author Patrick Cheng
  15383. </member>
  15384. <member name="T:NPOI.HSSF.Record.PrecisionRecord">
  15385. Title: Precision Record
  15386. Description: defines whether to store with full precision or what's Displayed by the gui
  15387. (meaning have really screwed up and skewed figures or only think you do!)
  15388. REFERENCE: PG 372 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15389. @author Andrew C. Oliver (acoliver at apache dot org)
  15390. @version 2.0-pre
  15391. </member>
  15392. <member name="M:NPOI.HSSF.Record.PrecisionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15393. Constructs a Precision record and Sets its fields appropriately.
  15394. @param in the RecordInputstream to Read the record from
  15395. </member>
  15396. <member name="P:NPOI.HSSF.Record.PrecisionRecord.FullPrecision">
  15397. Get whether to use full precision or just skew all you figures all to hell.
  15398. @return fullprecision - or not
  15399. </member>
  15400. <member name="T:NPOI.HSSF.Record.PrintGridlinesRecord">
  15401. Title: Print Gridlines Record
  15402. Description: whether to print the gridlines when you enjoy you spReadsheet on paper.
  15403. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15404. @author Andrew C. Oliver (acoliver at apache dot org)
  15405. @author Jason Height (jheight at chariot dot net dot au)
  15406. @version 2.0-pre
  15407. </member>
  15408. <member name="M:NPOI.HSSF.Record.PrintGridlinesRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15409. Constructs a PrintGridlines record and Sets its fields appropriately.
  15410. @param in the RecordInputstream to Read the record from
  15411. </member>
  15412. <member name="P:NPOI.HSSF.Record.PrintGridlinesRecord.PrintGridlines">
  15413. Get whether or not to print the gridlines (and make your spReadsheet ugly)
  15414. @return make spReadsheet ugly - Y/N
  15415. </member>
  15416. <member name="T:NPOI.HSSF.Record.PrintHeadersRecord">
  15417. Title: Print Headers Record
  15418. Description: Whether or not to print the row/column headers when you
  15419. enjoy your spReadsheet in the physical form.
  15420. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15421. @author Andrew C. Oliver (acoliver at apache dot org)
  15422. @author Jason Height (jheight at chariot dot net dot au)
  15423. @version 2.0-pre
  15424. </member>
  15425. <member name="M:NPOI.HSSF.Record.PrintHeadersRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15426. Constructs a PrintHeaders record and Sets its fields appropriately.
  15427. @param in the RecordInputstream to Read the record from
  15428. </member>
  15429. <member name="P:NPOI.HSSF.Record.PrintHeadersRecord.PrintHeaders">
  15430. <summary>
  15431. Get whether to print the headers - y/n
  15432. </summary>
  15433. <value><c>true</c> if [print headers]; otherwise, <c>false</c>.</value>
  15434. </member>
  15435. <member name="T:NPOI.HSSF.Record.PrintSetupRecord">
  15436. Title: Print Setup Record
  15437. Description: Stores print Setup options -- bogus for HSSF (and marked as such)
  15438. REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15439. @author Andrew C. Oliver (acoliver at apache dot org)
  15440. @author Jason Height (jheight at chariot dot net dot au)
  15441. @version 2.0-pre
  15442. </member>
  15443. <member name="M:NPOI.HSSF.Record.PrintSetupRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15444. Constructs a PrintSetup (SetUP) record and Sets its fields appropriately.
  15445. @param in the RecordInputstream to Read the record from
  15446. </member>
  15447. <member name="T:NPOI.HSSF.Record.ProtectionRev4Record">
  15448. Title: Protection Revision 4 Record
  15449. Description: describes whether this is a protected shared/tracked workbook
  15450. ( HSSF does not support encryption because we don't feel like going to jail )
  15451. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15452. @author Andrew C. Oliver (acoliver at apache dot org)
  15453. @version 2.0-pre
  15454. </member>
  15455. <member name="M:NPOI.HSSF.Record.ProtectionRev4Record.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15456. Constructs a ProtectionRev4 record and Sets its fields appropriately.
  15457. @param in the RecordInputstream to Read the record from
  15458. </member>
  15459. <member name="P:NPOI.HSSF.Record.ProtectionRev4Record.Protect">
  15460. Get whether the this is protected shared/tracked workbook or not
  15461. @return whether to protect the workbook or not
  15462. </member>
  15463. <member name="T:NPOI.HSSF.Record.ProtectRecord">
  15464. Title: Protect Record
  15465. Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)
  15466. (kindly ask the US government to stop having arcane stupid encryption laws and we'll support it)
  15467. (after all terrorists will all use US-legal encrypton right??)
  15468. HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al
  15469. ignore the password record entirely).
  15470. REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15471. @author Andrew C. Oliver (acoliver at apache dot org)
  15472. </member>
  15473. <member name="M:NPOI.HSSF.Record.ProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15474. Constructs a Protect record and Sets its fields appropriately.
  15475. @param in the RecordInputstream to Read the record from
  15476. </member>
  15477. <member name="P:NPOI.HSSF.Record.ProtectRecord.Protect">
  15478. Get whether the sheet is protected or not
  15479. @return whether to protect the sheet or not
  15480. </member>
  15481. <member name="T:NPOI.HSSF.Record.RecalcIdRecord">
  15482. Title: Recalc Id Record
  15483. Description: This record Contains an ID that marks when a worksheet was last
  15484. recalculated. It's an optimization Excel uses to determine if it
  15485. needs to recalculate the spReadsheet when it's opened. So far, only
  15486. the two values <c>0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00</c>
  15487. (do not recalculate) and <c>0xC1 0x01 0x00 0x00 0x60 0x69 0x01
  15488. 0x00</c> have been seen. If the field <c>isNeeded</c> Is
  15489. Set to false (default), then this record Is swallowed during the
  15490. serialization Process
  15491. REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html
  15492. @author Luc Girardin (luc dot girardin at macrofocus dot com)
  15493. @version 2.0-pre
  15494. @see org.apache.poi.hssf.model.Workbook
  15495. </member>
  15496. <member name="F:NPOI.HSSF.Record.RecalcIdRecord._engineId">
  15497. An unsigned integer that specifies the recalculation engine identifier
  15498. of the recalculation engine that performed the last recalculation.
  15499. If the value is less than the recalculation engine identifier associated with the application,
  15500. the application will recalculate the results of all formulas on
  15501. this workbook immediately after loading the file
  15502. </member>
  15503. <member name="M:NPOI.HSSF.Record.RecalcIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15504. Constructs a RECALCID record and Sets its fields appropriately.
  15505. @param in the RecordInputstream to Read the record from
  15506. </member>
  15507. <member name="T:NPOI.HSSF.Record.Record">
  15508. Title: Record
  15509. Description: All HSSF Records inherit from this class. It
  15510. populates the fields common to all records (id, size and data).
  15511. Subclasses should be sure to validate the id,
  15512. Company:
  15513. @author Andrew C. Oliver
  15514. @author Marc Johnson (mjohnson at apache dot org)
  15515. @author Jason Height (jheight at chariot dot net dot au)
  15516. @version 2.0-pre
  15517. </member>
  15518. <member name="M:NPOI.HSSF.Record.Record.#ctor">
  15519. instantiates a blank record strictly for ID matching
  15520. </member>
  15521. <member name="M:NPOI.HSSF.Record.Record.Serialize">
  15522. called by the class that is responsible for writing this sucker.
  15523. Subclasses should implement this so that their data is passed back in a
  15524. byte array.
  15525. @return byte array containing instance data
  15526. </member>
  15527. <member name="P:NPOI.HSSF.Record.Record.Sid">
  15528. return the non static version of the id for this record.
  15529. </member>
  15530. <member name="T:NPOI.HSSF.Record.RecordBase">
  15531. Common base class of {@link Record} and {@link RecordAggregate}
  15532. @author Josh Micich
  15533. </member>
  15534. <member name="M:NPOI.HSSF.Record.RecordBase.Serialize(System.Int32,System.Byte[])">
  15535. called by the class that is responsible for writing this sucker.
  15536. Subclasses should implement this so that their data is passed back in a
  15537. byte array.
  15538. @param offset to begin writing at
  15539. @param data byte array containing instance data
  15540. @return number of bytes written
  15541. </member>
  15542. <member name="P:NPOI.HSSF.Record.RecordBase.RecordSize">
  15543. gives the current serialized size of the record. Should include the sid
  15544. and reclength (4 bytes).
  15545. </member>
  15546. <member name="T:NPOI.HSSF.Record.RecordFactory">
  15547. Title: Record Factory
  15548. Description: Takes a stream and outputs an array of Record objects.
  15549. @deprecated use {@link org.apache.poi.hssf.eventmodel.EventRecordFactory} instead
  15550. @see org.apache.poi.hssf.eventmodel.EventRecordFactory
  15551. @author Andrew C. Oliver (acoliver at apache dot org)
  15552. @author Marc Johnson (mjohnson at apache dot org)
  15553. @author Glen Stampoultzis (glens at apache.org)
  15554. @author Csaba Nagy (ncsaba at yahoo dot com)
  15555. </member>
  15556. <member name="T:NPOI.HSSF.Record.RecordFactory.ReflectionMethodRecordCreator">
  15557. A "create" method is used instead of the usual constructor if the created record might
  15558. be of a different class to the declaring class.
  15559. </member>
  15560. <member name="F:NPOI.HSSF.Record.RecordFactory._recordCreatorsById">
  15561. cache of the recordsToMap();
  15562. </member>
  15563. <member name="M:NPOI.HSSF.Record.RecordFactory.GetRecordClass(System.Int32)">
  15564. Debug / diagnosis method<br/>
  15565. Gets the POI implementation class for a given <tt>sid</tt>. Only a subset of the any BIFF
  15566. records are actually interpreted by POI. A few others are known but not interpreted
  15567. (see {@link UnknownRecord#getBiffName(int)}).
  15568. @return the POI implementation class for the specified record <tt>sid</tt>.
  15569. <code>null</code> if the specified record is not interpreted by POI.
  15570. </member>
  15571. <member name="M:NPOI.HSSF.Record.RecordFactory.SetCapacity(System.Int32)">
  15572. Changes the default capacity (10000) to handle larger files
  15573. </member>
  15574. <member name="M:NPOI.HSSF.Record.RecordFactory.CreateRecords(System.IO.Stream)">
  15575. Create an array of records from an input stream
  15576. @param in the InputStream from which the records will be
  15577. obtained
  15578. @return an array of Records Created from the InputStream
  15579. @exception RecordFormatException on error Processing the
  15580. InputStream
  15581. </member>
  15582. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertBlankRecords(NPOI.HSSF.Record.MulBlankRecord)">
  15583. Converts a {@link MulBlankRecord} into an equivalent array of {@link BlankRecord}s
  15584. </member>
  15585. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertToNumberRecord(NPOI.HSSF.Record.RKRecord)">
  15586. <summary>
  15587. RK record is a slightly smaller alternative to NumberRecord
  15588. POI likes NumberRecord better
  15589. </summary>
  15590. <param name="rk">The rk.</param>
  15591. <returns></returns>
  15592. </member>
  15593. <member name="M:NPOI.HSSF.Record.RecordFactory.ConvertRKRecords(NPOI.HSSF.Record.MulRKRecord)">
  15594. <summary>
  15595. Converts a MulRKRecord into an equivalent array of NumberRecords
  15596. </summary>
  15597. <param name="mrk">The MRK.</param>
  15598. <returns></returns>
  15599. </member>
  15600. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream">
  15601. A stream based way to get at complete records, with
  15602. as low a memory footprint as possible.
  15603. This handles Reading from a RecordInputStream, turning
  15604. the data into full records, processing continue records
  15605. etc.
  15606. Most users should use {@link HSSFEventFactory} /
  15607. {@link HSSFListener} and have new records pushed to
  15608. them, but this does allow for a "pull" style of coding.
  15609. </member>
  15610. <member name="T:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo">
  15611. Keeps track of the sizes of the Initial records up to and including {@link FilePassRecord}
  15612. Needed for protected files because each byte is encrypted with respect to its absolute
  15613. position from the start of the stream.
  15614. </member>
  15615. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.LastRecord">
  15616. @return last record scanned while looking for encryption info.
  15617. This will typically be the first or second record Read. Possibly <code>null</code>
  15618. if stream was empty
  15619. </member>
  15620. <member name="P:NPOI.HSSF.Record.RecordFactoryInputStream.StreamEncryptionInfo.HasBOFRecord">
  15621. <c>false</c> in some test cases
  15622. </member>
  15623. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordBuffer">
  15624. Temporarily stores a group of {@link Record}s, for future return by {@link #nextRecord()}.
  15625. This is used at the start of the workbook stream, and also when the most recently read
  15626. underlying record is a {@link MulRKRecord}
  15627. </member>
  15628. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._unreadRecordIndex">
  15629. used to help iterating over the unread records
  15630. </member>
  15631. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastRecord">
  15632. The most recent record that we gave to the user
  15633. </member>
  15634. <member name="F:NPOI.HSSF.Record.RecordFactoryInputStream._lastDrawingRecord">
  15635. The most recent DrawingRecord seen
  15636. </member>
  15637. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.#ctor(System.IO.Stream,System.Boolean)">
  15638. @param shouldIncludeContinueRecords caller can pass <c>false</c> if loose
  15639. {@link ContinueRecord}s should be skipped (this is sometimes useful in event based
  15640. processing).
  15641. </member>
  15642. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.NextRecord">
  15643. Returns the next (complete) record from the
  15644. stream, or null if there are no more.
  15645. </member>
  15646. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.GetNextUnreadRecord">
  15647. @return the next {@link Record} from the multiple record group as expanded from
  15648. a recently read {@link MulRKRecord}. <code>null</code> if not present.
  15649. </member>
  15650. <member name="M:NPOI.HSSF.Record.RecordFactoryInputStream.ReadNextRecord">
  15651. @return the next available record, or <code>null</code> if
  15652. this pass didn't return a record that's
  15653. suitable for returning (eg was a continue record).
  15654. </member>
  15655. <member name="T:NPOI.HSSF.Record.RecordInputStream">
  15656. Title: Record Input Stream
  15657. Description: Wraps a stream and provides helper methods for the construction of records.
  15658. @author Jason Height (jheight @ apache dot org)
  15659. </member>
  15660. <member name="F:NPOI.HSSF.Record.RecordInputStream.MAX_RECORD_DATA_SIZE">
  15661. Maximum size of a single record (minus the 4 byte header) without a continue
  15662. </member>
  15663. <member name="F:NPOI.HSSF.Record.RecordInputStream._bhi">
  15664. Header {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  15665. </member>
  15666. <member name="F:NPOI.HSSF.Record.RecordInputStream._dataInput">
  15667. Data {@link LittleEndianInput} facet of the wrapped {@link InputStream}
  15668. </member>
  15669. <member name="M:NPOI.HSSF.Record.RecordInputStream.#ctor(System.IO.Stream)">
  15670. the record identifier of the BIFF record currently being read
  15671. </member>
  15672. <member name="M:NPOI.HSSF.Record.RecordInputStream.Read">
  15673. This method will Read a byte from the current record
  15674. </member>
  15675. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadNextSid">
  15676. @return the sid of the next record or {@link #INVALID_SID_VALUE} if at end of stream
  15677. </member>
  15678. <member name="M:NPOI.HSSF.Record.RecordInputStream.NextRecord">
  15679. Moves to the next record in the stream.
  15680. <i>Note: The auto continue flag is Reset to true</i>
  15681. </member>
  15682. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadByte">
  15683. Reads an 8 bit, signed value
  15684. </member>
  15685. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadShort">
  15686. Reads a 16 bit, signed value
  15687. </member>
  15688. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUByte">
  15689. Reads an 8 bit, Unsigned value
  15690. </member>
  15691. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUShort">
  15692. Reads a 16 bit,un- signed value.
  15693. @return
  15694. </member>
  15695. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadUnicodeLEString(System.Int32)">
  15696. given a byte array of 16-bit Unicode Chars, compress to 8-bit and
  15697. return a string
  15698. { 0x16, 0x00 } -0x16
  15699. @param Length the Length of the string
  15700. @return the Converted string
  15701. @exception ArgumentException if len is too large (i.e.,
  15702. there is not enough data in string to Create a String of that
  15703. Length)
  15704. </member>
  15705. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadRemainder">
  15706. Returns the remaining bytes for the current record.
  15707. @return The remaining bytes of the current record.
  15708. </member>
  15709. <member name="M:NPOI.HSSF.Record.RecordInputStream.ReadAllContinuedRemainder">
  15710. Reads all byte data for the current record, including any
  15711. that overlaps into any following continue records.
  15712. @deprecated Best to write a input stream that wraps this one where there Is
  15713. special sub record that may overlap continue records.
  15714. </member>
  15715. <member name="P:NPOI.HSSF.Record.RecordInputStream.Remaining">
  15716. The remaining number of bytes in the <i>current</i> record.
  15717. @return The number of bytes remaining in the current record
  15718. </member>
  15719. <member name="P:NPOI.HSSF.Record.RecordInputStream.IsContinueNext">
  15720. Returns true iif a Continue record is next in the excel stream _currentDataOffset
  15721. @return True when a ContinueRecord is next.
  15722. </member>
  15723. <member name="M:NPOI.HSSF.Record.RecordInputStream.GetNextSid">
  15724. @return sid of next record. Can be called after hasNextRecord()
  15725. </member>
  15726. <member name="T:NPOI.HSSF.Record.RefModeRecord">
  15727. Title: RefMode Record
  15728. Description: Describes which reference mode to use
  15729. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15730. @author Andrew C. Oliver (acoliver at apache dot org)
  15731. @author Jason Height (jheight at chariot dot net dot au)
  15732. @version 2.0-pre
  15733. </member>
  15734. <member name="M:NPOI.HSSF.Record.RefModeRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15735. Constructs a RefMode record and Sets its fields appropriately.
  15736. @param in the RecordInputstream to Read the record from
  15737. </member>
  15738. <member name="P:NPOI.HSSF.Record.RefModeRecord.Mode">
  15739. Get the reference mode to use (HSSF uses/assumes A1)
  15740. @return mode to use
  15741. @see #USE_A1_MODE
  15742. @see #USE_R1C1_MODE
  15743. </member>
  15744. <member name="T:NPOI.HSSF.Record.RefreshAllRecord">
  15745. Title: Refresh All Record
  15746. Description: Flag whether to refresh all external data when loading a sheet.
  15747. (which hssf doesn't support anyhow so who really cares?)
  15748. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15749. @author Andrew C. Oliver (acoliver at apache dot org)
  15750. @version 2.0-pre
  15751. </member>
  15752. <member name="M:NPOI.HSSF.Record.RefreshAllRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15753. Constructs a RefreshAll record and Sets its fields appropriately.
  15754. @param in the RecordInputstream to Read the record from
  15755. </member>
  15756. <member name="P:NPOI.HSSF.Record.RefreshAllRecord.RefreshAll">
  15757. Get whether to refresh all external data when loading a sheet
  15758. @return refreshall or not
  15759. </member>
  15760. <member name="T:NPOI.HSSF.Record.RightMarginRecord">
  15761. Record for the right margin. * NOTE: This source was automatically generated. * @author Shawn Laubach (slaubach at apache dot org)
  15762. </member>
  15763. <member name="M:NPOI.HSSF.Record.RightMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15764. 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)
  15765. </member>
  15766. <member name="P:NPOI.HSSF.Record.RightMarginRecord.Margin">
  15767. Get the margin field for the RightMargin record.
  15768. </member>
  15769. <member name="T:NPOI.HSSF.Record.RKRecord">
  15770. Title: RK Record
  15771. Description: An internal 32 bit number with the two most significant bits
  15772. storing the type. This is part of a bizarre scheme to save disk
  15773. space and memory (gee look at all the other whole records that
  15774. are in the file just "cause"..,far better to waste Processor
  15775. cycles on this then leave on of those "valuable" records out).
  15776. We support this in Read-ONLY mode. HSSF Converts these to NUMBER records
  15777. REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15778. @author Andrew C. Oliver (acoliver at apache dot org)
  15779. @author Jason Height (jheight at chariot dot net dot au)
  15780. @version 2.0-pre
  15781. @see org.apache.poi.hssf.record.NumberRecord
  15782. </member>
  15783. <member name="M:NPOI.HSSF.Record.RKRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15784. Constructs a RK record and Sets its fields appropriately.
  15785. @param in the RecordInputstream to Read the record from
  15786. </member>
  15787. <member name="P:NPOI.HSSF.Record.RKRecord.RKType">
  15788. Get the type of the number
  15789. @return one of these values:
  15790. <OL START="0">
  15791. <LI>RK_IEEE_NUMBER</LI>
  15792. <LI>RK_IEEE_NUMBER_TIMES_100</LI>
  15793. <LI>RK_INTEGER</LI>
  15794. <LI>RK_INTEGER_TIMES_100</LI>
  15795. </OL>
  15796. </member>
  15797. <member name="P:NPOI.HSSF.Record.RKRecord.RKNumber">
  15798. Extract the value of the number
  15799. The mechanism for determining the value is dependent on the two
  15800. low order bits of the raw number. If bit 1 is Set, the number
  15801. is an integer and can be cast directly as a double, otherwise,
  15802. it's apparently the exponent and mantissa of a double (and the
  15803. remaining low-order bits of the double's mantissa are 0's).
  15804. If bit 0 is Set, the result of the conversion to a double Is
  15805. divided by 100; otherwise, the value is left alone.
  15806. [Insert picture of Screwy Squirrel in full Napoleonic regalia]
  15807. @return the value as a proper double (hey, it <B>could</B>
  15808. happen)
  15809. </member>
  15810. <member name="T:NPOI.HSSF.Record.RowDataRecord">
  15811. <summary>
  15812. this record only used for record that has name and not implemented.
  15813. </summary>
  15814. </member>
  15815. <member name="T:NPOI.HSSF.Record.RowRecord">
  15816. Title: Row Record
  15817. Description: stores the row information for the sheet.
  15818. REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15819. @author Andrew C. Oliver (acoliver at apache dot org)
  15820. @author Jason Height (jheight at chariot dot net dot au)
  15821. @version 2.0-pre
  15822. </member>
  15823. <member name="F:NPOI.HSSF.Record.RowRecord.MAX_ROW_NUMBER">
  15824. The maximum row number that excel can handle (zero based) ie 65536 rows Is
  15825. max number of rows.
  15826. </member>
  15827. <member name="F:NPOI.HSSF.Record.RowRecord.field_7_option_flags">
  15828. 16 bit options flags
  15829. </member>
  15830. <member name="M:NPOI.HSSF.Record.RowRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15831. Constructs a Row record and Sets its fields appropriately.
  15832. @param in the RecordInputstream to Read the record from
  15833. </member>
  15834. <member name="P:NPOI.HSSF.Record.RowRecord.IsEmpty">
  15835. Get the logical row number for this row (0 based index)
  15836. @return row - the row number
  15837. </member>
  15838. <member name="P:NPOI.HSSF.Record.RowRecord.FirstCol">
  15839. Get the logical col number for the first cell this row (0 based index)
  15840. @return col - the col number
  15841. </member>
  15842. <member name="P:NPOI.HSSF.Record.RowRecord.LastCol">
  15843. Get the logical col number for the last cell this row plus one (0 based index)
  15844. @return col - the last col number + 1
  15845. </member>
  15846. <member name="P:NPOI.HSSF.Record.RowRecord.Height">
  15847. Get the height of the row
  15848. @return height of the row
  15849. </member>
  15850. <member name="P:NPOI.HSSF.Record.RowRecord.Optimize">
  15851. Get whether to optimize or not (Set to 0)
  15852. @return optimize (Set to 0)
  15853. </member>
  15854. <member name="P:NPOI.HSSF.Record.RowRecord.OptionFlags">
  15855. Gets the option bitmask. (use the individual bit Setters that refer to this
  15856. method)
  15857. @return options - the bitmask
  15858. </member>
  15859. <member name="P:NPOI.HSSF.Record.RowRecord.OutlineLevel">
  15860. Get the outline level of this row
  15861. @return ol - the outline level
  15862. @see #GetOptionFlags()
  15863. </member>
  15864. <member name="P:NPOI.HSSF.Record.RowRecord.Colapsed">
  15865. Get whether or not to colapse this row
  15866. @return c - colapse or not
  15867. @see #GetOptionFlags()
  15868. </member>
  15869. <member name="P:NPOI.HSSF.Record.RowRecord.ZeroHeight">
  15870. Get whether or not to Display this row with 0 height
  15871. @return - z height is zero or not.
  15872. @see #GetOptionFlags()
  15873. </member>
  15874. <member name="P:NPOI.HSSF.Record.RowRecord.BadFontHeight">
  15875. Get whether the font and row height are not compatible
  15876. @return - f -true if they aren't compatible (damn not logic)
  15877. @see #GetOptionFlags()
  15878. </member>
  15879. <member name="P:NPOI.HSSF.Record.RowRecord.Formatted">
  15880. Get whether the row has been formatted (even if its got all blank cells)
  15881. @return formatted or not
  15882. @see #GetOptionFlags()
  15883. </member>
  15884. <member name="P:NPOI.HSSF.Record.RowRecord.XFIndex">
  15885. if the row is formatted then this is the index to the extended format record
  15886. @see org.apache.poi.hssf.record.ExtendedFormatRecord
  15887. @return index to the XF record or bogus value (undefined) if Isn't formatted
  15888. </member>
  15889. <member name="P:NPOI.HSSF.Record.RowRecord.TopBorder">
  15890. bit that specifies whether any cell in the row has a thick top border, or any
  15891. cell in the row directly above the current row has a thick bottom border.
  15892. @param f has thick top border
  15893. </member>
  15894. <member name="P:NPOI.HSSF.Record.RowRecord.BottomBorder">
  15895. A bit that specifies whether any cell in the row has a medium or thick
  15896. bottom border, or any cell in the row directly below the current row has
  15897. a medium or thick top border.
  15898. @param f has thick bottom border
  15899. </member>
  15900. <member name="P:NPOI.HSSF.Record.RowRecord.PhoeneticGuide">
  15901. A bit that specifies whether the phonetic guide feature is enabled for
  15902. any cell in this row.
  15903. @param f use phoenetic guide
  15904. </member>
  15905. <member name="T:NPOI.HSSF.Record.SaveRecalcRecord">
  15906. Title: Save Recalc Record
  15907. Description: defines whether to recalculate before saving (Set to true)
  15908. REFERENCE: PG 381 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15909. @author Andrew C. Oliver (acoliver at apache dot org)
  15910. @author Jason Height (jheight at chariot dot net dot au)
  15911. @version 2.0-pre
  15912. </member>
  15913. <member name="M:NPOI.HSSF.Record.SaveRecalcRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15914. Constructs an SaveRecalc record and Sets its fields appropriately.
  15915. @param in the RecordInputstream to Read the record from
  15916. </member>
  15917. <member name="P:NPOI.HSSF.Record.SaveRecalcRecord.Recalc">
  15918. Get whether to recalculate formulas/etc before saving or not
  15919. @return recalc - whether to recalculate or not
  15920. </member>
  15921. <member name="T:NPOI.HSSF.Record.ScenarioProtectRecord">
  15922. Title: Scenario Protect Record
  15923. Description: I have no idea what a Scenario is or why on would want to
  15924. protect it with the lamest "security" ever invented. However this record tells
  15925. excel "I want to protect my scenarios" (0xAF) with lame security. It appears
  15926. in conjunction with the PASSWORD and PROTECT records as well as its object
  15927. protect cousin.
  15928. REFERENCE: PG 383 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15929. @author Andrew C. Oliver (acoliver at apache dot org)
  15930. </member>
  15931. <member name="M:NPOI.HSSF.Record.ScenarioProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15932. Constructs a Protect record and Sets its fields appropriately.
  15933. @param in the RecordInputstream to Read the record from
  15934. </member>
  15935. <member name="P:NPOI.HSSF.Record.ScenarioProtectRecord.Protect">
  15936. Get whether the sheet is protected or not
  15937. @return whether to protect the sheet or not
  15938. </member>
  15939. <member name="T:NPOI.HSSF.Record.SCLRecord">
  15940. * Specifies the window's zoom magnification. If this record Isn't present then the windows zoom is 100%. see p384 Excel Dev Kit
  15941. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  15942. * Remove the record in src/records/definitions.
  15943. * @author Andrew C. Oliver (acoliver at apache.org)
  15944. </member>
  15945. <member name="M:NPOI.HSSF.Record.SCLRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15946. Constructs a SCL record and Sets its fields appropriately.
  15947. @param in the RecordInputstream to Read the record from
  15948. </member>
  15949. <member name="P:NPOI.HSSF.Record.SCLRecord.DataSize">
  15950. Size of record (exluding 4 byte header)
  15951. </member>
  15952. <member name="P:NPOI.HSSF.Record.SCLRecord.Numerator">
  15953. Get the numerator field for the SCL record.
  15954. </member>
  15955. <member name="P:NPOI.HSSF.Record.SCLRecord.Denominator">
  15956. Get the denominator field for the SCL record.
  15957. </member>
  15958. <member name="T:NPOI.HSSF.Record.SelectionRecord">
  15959. Title: Selection Record
  15960. Description: shows the user's selection on the sheet
  15961. for Write Set num refs to 0
  15962. TODO : Fully implement reference subrecords.
  15963. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  15964. @author Andrew C. Oliver (acoliver at apache dot org)
  15965. @author Jason Height (jheight at chariot dot net dot au)
  15966. @author Glen Stampoultzis (glens at apache.org)
  15967. </member>
  15968. <member name="M:NPOI.HSSF.Record.SelectionRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  15969. <summary>
  15970. Constructs a Selection record and Sets its fields appropriately.
  15971. </summary>
  15972. <param name="in1">the RecordInputstream to Read the record from</param>
  15973. </member>
  15974. <member name="P:NPOI.HSSF.Record.SelectionRecord.Pane">
  15975. <summary>
  15976. Gets or sets the pane this is for.
  15977. </summary>
  15978. <value>The pane.</value>
  15979. </member>
  15980. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRow">
  15981. <summary>
  15982. Gets or sets the active cell row.
  15983. </summary>
  15984. <value>row number of active cell</value>
  15985. </member>
  15986. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellCol">
  15987. <summary>
  15988. Gets or sets the active cell's col
  15989. </summary>
  15990. <value>number of active cell</value>
  15991. </member>
  15992. <member name="P:NPOI.HSSF.Record.SelectionRecord.ActiveCellRef">
  15993. <summary>
  15994. Gets or sets the active cell's reference number
  15995. </summary>
  15996. <value>ref number of active cell</value>
  15997. </member>
  15998. <member name="T:NPOI.HSSF.Record.SharedFormulaRecord">
  15999. Title: SharedFormulaRecord
  16000. Description: Primarily used as an excel optimization so that multiple similar formulas
  16001. are not written out too many times. We should recognize this record and
  16002. Serialize as Is since this Is used when Reading templates.
  16003. Note: the documentation says that the SID Is BC where biffviewer reports 4BC. The hex dump shows
  16004. that the two byte sid representation to be 'BC 04' that Is consistent with the other high byte
  16005. record types.
  16006. @author Danny Mui at apache dot org
  16007. </member>
  16008. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16009. @param in the RecordInputstream to Read the record from
  16010. </member>
  16011. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.ToString">
  16012. print a sort of string representation ([SHARED FORMULA RECORD] id = x [/SHARED FORMULA RECORD])
  16013. </member>
  16014. <member name="M:NPOI.HSSF.Record.SharedFormulaRecord.GetFormulaTokens(NPOI.HSSF.Record.FormulaRecord)">
  16015. @return the equivalent {@link Ptg} array that the formula would have, were it not shared.
  16016. </member>
  16017. <member name="T:NPOI.HSSF.Record.SharedValueRecordBase">
  16018. Common base class for {@link SharedFormulaRecord}, {@link ArrayRecord} and
  16019. {@link TableRecord} which are have similarities.
  16020. @author Josh Micich
  16021. </member>
  16022. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16023. reads only the range (1 {@link CellRangeAddress8Bit}) from the stream
  16024. </member>
  16025. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsInRange(System.Int32,System.Int32)">
  16026. @return <c>true</c> if (rowIx, colIx) is within the range ({@link #Range})
  16027. of this shared value object.
  16028. </member>
  16029. <member name="M:NPOI.HSSF.Record.SharedValueRecordBase.IsFirstCell(System.Int32,System.Int32)">
  16030. @return <c>true</c> if (rowIx, colIx) describes the first cell in this shared value
  16031. object's range ({@link #Range})
  16032. </member>
  16033. <member name="T:NPOI.HSSF.Record.SheetExtRecord">
  16034. <summary>
  16035. </summary>
  16036. </member>
  16037. <member name="T:NPOI.HSSF.Record.SSTDeserializer">
  16038. Handles the task of deserializing a SST string. The two main entry points are
  16039. @author Glen Stampoultzis (glens at apache.org)
  16040. @author Jason Height (jheight at apache.org)
  16041. </member>
  16042. <member name="M:NPOI.HSSF.Record.SSTDeserializer.ManufactureStrings(System.Int32,NPOI.HSSF.Record.RecordInputStream)">
  16043. This Is the starting point where strings are constructed. Note that
  16044. strings may span across multiple continuations. Read the SST record
  16045. carefully before beginning to hack.
  16046. </member>
  16047. <member name="T:NPOI.HSSF.Record.SSTRecord">
  16048. Title: Static String Table Record
  16049. Description: This holds all the strings for LabelSSTRecords.
  16050. REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN:
  16051. 1-57231-498-2)
  16052. @author Andrew C. Oliver (acoliver at apache dot org)
  16053. @author Marc Johnson (mjohnson at apache dot org)
  16054. @author Glen Stampoultzis (glens at apache.org)
  16055. @see org.apache.poi.hssf.record.LabelSSTRecord
  16056. @see org.apache.poi.hssf.record.ContinueRecord
  16057. </member>
  16058. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_RECORD_SIZE">
  16059. how big can an SST record be? As big as any record can be: 8228 bytes
  16060. </member>
  16061. <member name="F:NPOI.HSSF.Record.SSTRecord.STD_RECORD_OVERHEAD">
  16062. standard record overhead: two shorts (record id plus data space size)
  16063. </member>
  16064. <member name="F:NPOI.HSSF.Record.SSTRecord.SST_RECORD_OVERHEAD">
  16065. SST overhead: the standard record overhead, plus the number of strings and the number of Unique strings -- two ints
  16066. </member>
  16067. <member name="F:NPOI.HSSF.Record.SSTRecord.MAX_DATA_SPACE">
  16068. how much data can we stuff into an SST record? That would be _max minus the standard SST record overhead
  16069. </member>
  16070. <member name="F:NPOI.HSSF.Record.SSTRecord.field_1_num_strings">
  16071. Union of strings in the SST and EXTSST
  16072. </member>
  16073. <member name="F:NPOI.HSSF.Record.SSTRecord.field_2_num_unique_strings">
  16074. according to docs ONLY SST
  16075. </member>
  16076. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketAbsoluteOffsets">
  16077. Offsets from the beginning of the SST record (even across continuations)
  16078. </member>
  16079. <member name="F:NPOI.HSSF.Record.SSTRecord.bucketRelativeOffsets">
  16080. Offsets relative the start of the current SST or continue record
  16081. </member>
  16082. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor">
  16083. default constructor
  16084. </member>
  16085. <member name="M:NPOI.HSSF.Record.SSTRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16086. Constructs an SST record and Sets its fields appropriately.
  16087. @param in the RecordInputstream to Read the record from
  16088. </member>
  16089. <member name="M:NPOI.HSSF.Record.SSTRecord.AddString(NPOI.HSSF.Record.UnicodeString)">
  16090. Add a string.
  16091. @param string string to be Added
  16092. @return the index of that string in the table
  16093. </member>
  16094. <member name="P:NPOI.HSSF.Record.SSTRecord.NumStrings">
  16095. @return number of strings
  16096. </member>
  16097. <member name="P:NPOI.HSSF.Record.SSTRecord.NumUniqueStrings">
  16098. @return number of Unique strings
  16099. </member>
  16100. <member name="M:NPOI.HSSF.Record.SSTRecord.GetString(System.Int32)">
  16101. Get a particular string by its index
  16102. @param id index into the array of strings
  16103. @return the desired string
  16104. </member>
  16105. <member name="M:NPOI.HSSF.Record.SSTRecord.ToString">
  16106. Return a debugging string representation
  16107. @return string representation
  16108. </member>
  16109. <member name="P:NPOI.HSSF.Record.SSTRecord.Sid">
  16110. @return sid
  16111. </member>
  16112. <member name="M:NPOI.HSSF.Record.SSTRecord.GetHashCode">
  16113. @return hashcode
  16114. </member>
  16115. <member name="M:NPOI.HSSF.Record.SSTRecord.GetStrings">
  16116. @return an iterator of the strings we hold. All instances are
  16117. UnicodeStrings
  16118. </member>
  16119. <member name="P:NPOI.HSSF.Record.SSTRecord.CountStrings">
  16120. @return count of the strings we hold.
  16121. </member>
  16122. <member name="M:NPOI.HSSF.Record.SSTRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  16123. called by the class that Is responsible for writing this sucker.
  16124. Subclasses should implement this so that their data Is passed back in a
  16125. byte array.
  16126. @return size
  16127. </member>
  16128. <member name="M:NPOI.HSSF.Record.SSTRecord.CreateExtSSTRecord(System.Int32)">
  16129. Creates an extended string record based on the current contents of
  16130. the current SST record. The offset within the stream to the SST record
  16131. Is required because the extended string record points directly to the
  16132. strings in the SST record.
  16133. NOTE: THIS FUNCTION MUST ONLY BE CALLED AFTER THE SST RECORD HAS BEEN
  16134. SERIALIZED.
  16135. @param sstOffset The offset in the stream to the start of the
  16136. SST record.
  16137. @return The new SST record.
  16138. </member>
  16139. <member name="M:NPOI.HSSF.Record.SSTRecord.CalcExtSSTRecordSize">
  16140. Calculates the size in bytes of the EXTSST record as it would be if the
  16141. record was Serialized.
  16142. @return The size of the ExtSST record in bytes.
  16143. </member>
  16144. <member name="T:NPOI.HSSF.Record.SSTSerializer">
  16145. This class handles serialization of SST records. It utilizes the record processor
  16146. class write individual records. This has been refactored from the SSTRecord class.
  16147. @author Glen Stampoultzis (glens at apache.org)
  16148. </member>
  16149. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketAbsoluteOffsets">
  16150. OffSets from the beginning of the SST record (even across continuations)
  16151. </member>
  16152. <member name="F:NPOI.HSSF.Record.SSTSerializer.bucketRelativeOffsets">
  16153. OffSets relative the start of the current SST or continue record
  16154. </member>
  16155. <member name="T:NPOI.HSSF.Record.StandardRecord">
  16156. Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for
  16157. some simplification of serialization logic
  16158. @author Josh Micich
  16159. </member>
  16160. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(System.Int32,System.Byte[])">
  16161. <summary>
  16162. Write the data content of this BIFF record including the sid and record length.
  16163. The subclass must write the exact number of bytes as reported by Record#getRecordSize()
  16164. </summary>
  16165. <param name="offset">offset</param>
  16166. <param name="data">data</param>
  16167. <returns></returns>
  16168. </member>
  16169. <member name="M:NPOI.HSSF.Record.StandardRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  16170. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields
  16171. have already been written by the superclass.<br/>
  16172. The number of bytes written must equal the record size reported by
  16173. {@link Record#getDataSize()} minus four
  16174. ( record header consiting of a 'ushort sid' and 'ushort reclength' has already been written
  16175. by thye superclass).
  16176. </member>
  16177. <member name="T:NPOI.HSSF.Record.StringRecord">
  16178. Supports the STRING record structure.
  16179. @author Glen Stampoultzis (glens at apache.org)
  16180. </member>
  16181. <member name="M:NPOI.HSSF.Record.StringRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16182. Constructs a String record and Sets its fields appropriately.
  16183. @param in the RecordInputstream to Read the record from
  16184. </member>
  16185. <member name="M:NPOI.HSSF.Record.StringRecord.Serialize(NPOI.HSSF.Record.Cont.ContinuableRecordOutput)">
  16186. called by the class that Is responsible for writing this sucker.
  16187. Subclasses should implement this so that their data Is passed back in a
  16188. byte array.
  16189. @param offset to begin writing at
  16190. @param data byte array containing instance data
  16191. @return number of bytes written
  16192. </member>
  16193. <member name="P:NPOI.HSSF.Record.StringRecord.Sid">
  16194. return the non static version of the id for this record.
  16195. </member>
  16196. <member name="P:NPOI.HSSF.Record.StringRecord.String">
  16197. @return The string represented by this record.
  16198. </member>
  16199. <member name="T:NPOI.HSSF.Record.StyleRecord">
  16200. Title: Style Record
  16201. Description: Describes a builtin to the gui or user defined style
  16202. REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16203. @author Andrew C. Oliver (acoliver at apache dot org)
  16204. @author aviks : string fixes for UserDefined Style
  16205. @version 2.0-pre
  16206. </member>
  16207. <member name="M:NPOI.HSSF.Record.StyleRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16208. Constructs a Style record and Sets its fields appropriately.
  16209. @param in the RecordInputstream to Read the record from
  16210. </member>
  16211. <member name="M:NPOI.HSSF.Record.StyleRecord.SetBuiltinStyle(System.Int32)">
  16212. if this is a builtin style set the number of the built in style
  16213. @param builtinStyleId style number (0-7)
  16214. </member>
  16215. <member name="P:NPOI.HSSF.Record.StyleRecord.XFIndex">
  16216. Get the actual index of the style extended format record
  16217. @see #Index
  16218. @return index of the xf record
  16219. </member>
  16220. <member name="P:NPOI.HSSF.Record.StyleRecord.Name">
  16221. Get the style's name
  16222. @return name of the style
  16223. @see #NameLength
  16224. </member>
  16225. <member name="P:NPOI.HSSF.Record.StyleRecord.OutlineStyleLevel">
  16226. Get the row or column level of the style (if builtin 1||2)
  16227. </member>
  16228. <member name="T:NPOI.HSSF.Record.CommonObjectType">
  16229. * The common object data record is used to store all common preferences for an excel object.
  16230. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  16231. * Remove the record in src/records/definitions.
  16232. * @author Glen Stampoultzis (glens at apache.org)
  16233. </member>
  16234. <member name="M:NPOI.HSSF.Record.CommonObjectDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  16235. Constructs a CommonObjectData record and Sets its fields appropriately.
  16236. @param in the RecordInputstream to Read the record from
  16237. </member>
  16238. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.DataSize">
  16239. Size of record (exluding 4 byte header)
  16240. </member>
  16241. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectType">
  16242. Get the object type field for the CommonObjectData record.
  16243. </member>
  16244. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.ObjectId">
  16245. Get the object id field for the CommonObjectData record.
  16246. </member>
  16247. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Option">
  16248. Get the option field for the CommonObjectData record.
  16249. </member>
  16250. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved1">
  16251. Get the reserved1 field for the CommonObjectData record.
  16252. </member>
  16253. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved2">
  16254. Get the reserved2 field for the CommonObjectData record.
  16255. </member>
  16256. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.Reserved3">
  16257. Get the reserved3 field for the CommonObjectData record.
  16258. </member>
  16259. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsLocked">
  16260. true if object is locked when sheet has been protected
  16261. @return the locked field value.
  16262. </member>
  16263. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsPrintable">
  16264. object appears when printed
  16265. @return the printable field value.
  16266. </member>
  16267. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoFill">
  16268. whether object uses an automatic Fill style
  16269. @return the autoFill field value.
  16270. </member>
  16271. <member name="P:NPOI.HSSF.Record.CommonObjectDataSubRecord.IsAutoline">
  16272. whether object uses an automatic line style
  16273. @return the autoline field value.
  16274. </member>
  16275. <member name="T:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord">
  16276. A sub-record within the OBJ record which stores a reference to an object
  16277. stored in a Separate entry within the OLE2 compound file.
  16278. @author Daniel Noll
  16279. </member>
  16280. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_2_refPtg">
  16281. either an area or a cell ref
  16282. </member>
  16283. <member name="F:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.field_4_unknownByte">
  16284. Formulas often have a single non-zero trailing byte.
  16285. This is in a similar position to he pre-streamId padding
  16286. It is unknown if the value is important (it seems to mirror a value a few bytes earlier)
  16287. </member>
  16288. <member name="M:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  16289. Constructs an EmbeddedObjectRef record and Sets its fields appropriately.
  16290. @param in the record input stream.
  16291. </member>
  16292. <member name="P:NPOI.HSSF.Record.EmbeddedObjectRefSubRecord.StreamId">
  16293. Gets the stream ID containing the actual data. The data itself
  16294. can be found under a top-level directory entry in the OLE2 filesystem
  16295. under the name "MBD<var>xxxxxxxx</var>" where <var>xxxxxxxx</var> is
  16296. this ID converted into hex (in big endian order, funnily enough.)
  16297. @return the data stream ID. Possibly <c>null</c>
  16298. </member>
  16299. <member name="T:NPOI.HSSF.Record.EndSubRecord">
  16300. * The end data record is used to denote the end of the subrecords.
  16301. * NOTE: This source is automatically generated please do not modify this file. Either subclass or
  16302. * Remove the record in src/records/definitions.
  16303. * @author Glen Stampoultzis (glens at apache.org)
  16304. </member>
  16305. <member name="M:NPOI.HSSF.Record.EndSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  16306. Constructs a End record and Sets its fields appropriately.
  16307. @param in the RecordInputstream to Read the record from
  16308. </member>
  16309. <member name="P:NPOI.HSSF.Record.EndSubRecord.DataSize">
  16310. Size of record (exluding 4 byte header)
  16311. </member>
  16312. <member name="T:NPOI.HSSF.Record.GroupMarkerSubRecord">
  16313. * The Group marker record is used as a position holder for Groups.
  16314. * @author Glen Stampoultzis (glens at apache.org)
  16315. </member>
  16316. <member name="M:NPOI.HSSF.Record.GroupMarkerSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  16317. Constructs a Group marker record and Sets its fields appropriately.
  16318. @param in the RecordInputstream to Read the record from
  16319. </member>
  16320. <member name="P:NPOI.HSSF.Record.GroupMarkerSubRecord.DataSize">
  16321. Size of record (exluding 4 byte header)
  16322. </member>
  16323. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cbFContinued">
  16324. From [MS-XLS].pdf 2.5.147 FtLbsData:
  16325. An unsigned integer that indirectly specifies whether
  16326. some of the data in this structure appear in a subsequent Continue record.
  16327. If _cbFContinued is 0x00, all of the fields in this structure except sid and _cbFContinued
  16328. MUST NOT exist. If this entire structure is Contained within the same record,
  16329. then _cbFContinued MUST be greater than or equal to the size, in bytes,
  16330. of this structure, not including the four bytes for the ft and _cbFContinued fields
  16331. </member>
  16332. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._unknownPreFormulaInt">
  16333. a formula that specifies the range of cell values that are the items in this list.
  16334. </member>
  16335. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._cLines">
  16336. An unsigned integer that specifies the number of items in the list.
  16337. </member>
  16338. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._iSel">
  16339. An unsigned integer that specifies the one-based index of the first selected item in this list.
  16340. A value of 0x00 specifies there is no currently selected item.
  16341. </member>
  16342. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._flags">
  16343. flags that tell what data follows
  16344. </member>
  16345. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._idEdit">
  16346. An ObjId that specifies the edit box associated with this list.
  16347. A value of 0x00 specifies that there is no edit box associated with this list.
  16348. </member>
  16349. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._dropData">
  16350. An optional LbsDropData that specifies properties for this dropdown control.
  16351. This field MUST exist if and only if the Containing Obj?s cmo.ot is equal to 0x14.
  16352. </member>
  16353. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._rgLines">
  16354. An optional array of strings where each string specifies an item in the list.
  16355. The number of elements in this array, if it exists, MUST be {@link #_cLines}
  16356. </member>
  16357. <member name="F:NPOI.HSSF.Record.LbsDataSubRecord._bsels">
  16358. An optional array of bools that specifies
  16359. which items in the list are part of a multiple selection
  16360. </member>
  16361. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32,System.Int32)">
  16362. @param in the stream to read data from
  16363. @param cbFContinued the seconf short in the record header
  16364. @param cmoOt the Containing Obj's {@link CommonObjectDataSubRecord#field_1_objectType}
  16365. </member>
  16366. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.Formula">
  16367. @return the formula that specifies the range of cell values that are the items in this list.
  16368. </member>
  16369. <member name="P:NPOI.HSSF.Record.LbsDataSubRecord.NumberOfItems">
  16370. @return the number of items in the list
  16371. </member>
  16372. <member name="M:NPOI.HSSF.Record.LbsDataSubRecord.CreateAutoFilterInstance">
  16373. @return a new instance of LbsDataSubRecord to construct auto-filters
  16374. @see org.apache.poi.hssf.model.ComboboxShape#createObjRecord(org.apache.poi.hssf.usermodel.HSSFSimpleShape, int)
  16375. </member>
  16376. <member name="T:NPOI.HSSF.Record.LbsDropData">
  16377. This structure specifies properties of the dropdown list control
  16378. </member>
  16379. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_DROPDOWN">
  16380. Combo dropdown control
  16381. </member>
  16382. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_EDIT_DROPDOWN">
  16383. Combo Edit dropdown control
  16384. </member>
  16385. <member name="F:NPOI.HSSF.Record.LbsDropData.STYLE_COMBO_SIMPLE_DROPDOWN">
  16386. Simple dropdown control (just the dropdown button)
  16387. </member>
  16388. <member name="F:NPOI.HSSF.Record.LbsDropData._wStyle">
  16389. An unsigned integer that specifies the style of this dropdown.
  16390. </member>
  16391. <member name="F:NPOI.HSSF.Record.LbsDropData._cLine">
  16392. An unsigned integer that specifies the number of lines to be displayed in the dropdown.
  16393. </member>
  16394. <member name="F:NPOI.HSSF.Record.LbsDropData._dxMin">
  16395. An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window
  16396. </member>
  16397. <member name="F:NPOI.HSSF.Record.LbsDropData._str">
  16398. a string that specifies the current string value in the dropdown
  16399. </member>
  16400. <member name="F:NPOI.HSSF.Record.LbsDropData._unused">
  16401. Optional, undefined and MUST be ignored.
  16402. This field MUST exist if and only if the size of str in bytes is an odd number
  16403. </member>
  16404. <member name="T:NPOI.HSSF.Record.NoteStructureSubRecord">
  16405. Represents a NoteStructure (0xD) sub record.
  16406. The docs say nothing about it. The Length of this record is always 26 bytes.
  16407. @author Yegor Kozlov
  16408. </member>
  16409. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor">
  16410. Construct a new <c>NoteStructureSubRecord</c> and
  16411. Fill its data with the default values
  16412. </member>
  16413. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.#ctor(NPOI.Util.ILittleEndianInput,System.Int32)">
  16414. Constructs a NoteStructureSubRecord and Sets its fields appropriately.
  16415. </member>
  16416. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.ToString">
  16417. Convert this record to string.
  16418. Used by BiffViewer and other utulities.
  16419. </member>
  16420. <member name="M:NPOI.HSSF.Record.NoteStructureSubRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  16421. Serialize the record data into the supplied array of bytes
  16422. @param offset offset in the <c>data</c>
  16423. @param data the data to Serialize into
  16424. @return size of the record
  16425. </member>
  16426. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.DataSize">
  16427. Size of record
  16428. </member>
  16429. <member name="P:NPOI.HSSF.Record.NoteStructureSubRecord.Sid">
  16430. @return id of this record.
  16431. </member>
  16432. <member name="T:NPOI.HSSF.Record.ScrollableObjectSubRecord">
  16433. <summary>
  16434. FtSbs structure
  16435. </summary>
  16436. </member>
  16437. <member name="T:NPOI.HSSF.Record.SubRecord">
  16438. Subrecords are part of the OBJ class.
  16439. </member>
  16440. <member name="P:NPOI.HSSF.Record.SubRecord.IsTerminating">
  16441. Wether this record terminates the sub-record stream.
  16442. There are two cases when this method must be overridden and return <c>true</c>
  16443. - EndSubRecord (sid = 0x00)
  16444. - LbsDataSubRecord (sid = 0x12)
  16445. @return whether this record is the last in the sub-record stream
  16446. </member>
  16447. <member name="T:NPOI.HSSF.Record.SupBookRecord">
  16448. Title: Sup Book (EXTERNALBOOK)
  16449. Description: A External Workbook Description (Suplemental Book)
  16450. Its only a dummy record for making new ExternSheet Record
  16451. REFERENCE: 5.38
  16452. @author Libin Roman (Vista Portal LDT. Developer)
  16453. @author Andrew C. Oliver (acoliver@apache.org)
  16454. </member>
  16455. <member name="M:NPOI.HSSF.Record.SupBookRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16456. Constructs a Extern Sheet record and Sets its fields appropriately.
  16457. @param id id must be 0x16 or an exception will be throw upon validation
  16458. @param size the size of the data area of the record
  16459. @param data data of the record (should not contain sid/len)
  16460. </member>
  16461. <member name="T:NPOI.HSSF.Record.TabIdRecord">
  16462. Title: Sheet Tab Index Array Record
  16463. Description: Contains an array of sheet id's. Sheets always keep their ID
  16464. regardless of what their name Is.
  16465. REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16466. @author Andrew C. Oliver (acoliver at apache dot org)
  16467. @version 2.0-pre
  16468. </member>
  16469. <member name="M:NPOI.HSSF.Record.TabIdRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16470. Constructs a TabID record and Sets its fields appropriately.
  16471. @param in the RecordInputstream to Read the record from
  16472. </member>
  16473. <member name="M:NPOI.HSSF.Record.TabIdRecord.SetTabIdArray(System.Int16[])">
  16474. Set the tab array. (0,1,2).
  16475. @param array of tab id's {0,1,2}
  16476. </member>
  16477. <member name="M:NPOI.HSSF.Record.TabIdRecord.ToString">
  16478. Get the tab array. (0,1,2).
  16479. @return array of tab id's {0,1,2}
  16480. </member>
  16481. <member name="T:NPOI.HSSF.Record.TableRecord">
  16482. DATATABLE (0x0236)<p/>
  16483. TableRecord - The record specifies a data table.
  16484. This record Is preceded by a single Formula record that
  16485. defines the first cell in the data table, which should
  16486. only contain a single Ptg, {@link TblPtg}.
  16487. See p536 of the June 08 binary docs
  16488. </member>
  16489. <member name="T:NPOI.HSSF.Record.TableStylesRecord">
  16490. TABLESTYLES (0x088E)<br/>
  16491. @author Patrick Cheng
  16492. </member>
  16493. <member name="F:NPOI.HSSF.Record.TextObjectRecord._linkRefPtg">
  16494. expect tRef, tRef3D, tArea, tArea3D or tName
  16495. </member>
  16496. <member name="F:NPOI.HSSF.Record.TextObjectRecord._unknownPostFormulaByte">
  16497. Not clear if needed . Excel seems to be OK if this byte is not present.
  16498. Value is often the same as the earlier firstColumn byte.
  16499. </member>
  16500. <member name="P:NPOI.HSSF.Record.TextObjectRecord.TextOrientation">
  16501. Get the text orientation field for the TextObjectBase record.
  16502. @return a TextOrientation
  16503. </member>
  16504. <member name="P:NPOI.HSSF.Record.TextObjectRecord.HorizontalTextAlignment">
  16505. @return the Horizontal text alignment field value.
  16506. </member>
  16507. <member name="P:NPOI.HSSF.Record.TextObjectRecord.VerticalTextAlignment">
  16508. @return the Vertical text alignment field value.
  16509. </member>
  16510. <member name="P:NPOI.HSSF.Record.TextObjectRecord.IsTextLocked">
  16511. Text has been locked
  16512. @return the text locked field value.
  16513. </member>
  16514. <member name="T:NPOI.HSSF.Record.TopMarginRecord">
  16515. Record for the top margin.
  16516. NOTE: This source was automatically generated.
  16517. @author Shawn Laubach (slaubach at apache dot org)
  16518. </member>
  16519. <member name="M:NPOI.HSSF.Record.TopMarginRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16520. Constructs a TopMargin record and Sets its fields appropriately.
  16521. @param in the RecordInputstream to Read the record from
  16522. </member>
  16523. <member name="P:NPOI.HSSF.Record.TopMarginRecord.Margin">
  16524. Get the margin field for the TopMargin record.
  16525. </member>
  16526. <member name="T:NPOI.HSSF.Record.UncalcedRecord">
  16527. Title: Uncalced Record
  16528. If this record occurs in the Worksheet Substream, it indicates that the formulas have not
  16529. been recalculated before the document was saved.
  16530. @author Olivier Leprince
  16531. </member>
  16532. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor">
  16533. Default constructor
  16534. </member>
  16535. <member name="M:NPOI.HSSF.Record.UncalcedRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16536. Read constructor
  16537. </member>
  16538. <member name="T:NPOI.HSSF.Record.UnknownRecord">
  16539. Title: Unknown Record (for debugging)
  16540. Description: Unknown record just tells you the sid so you can figure out
  16541. what records you are missing. Also helps us Read/modify sheets we
  16542. don't know all the records to. (HSSF leaves these alone!)
  16543. Company: SuperLink Software, Inc.
  16544. @author Andrew C. Oliver (acoliver at apache dot org)
  16545. @author Jason Height (jheight at chariot dot net dot au)
  16546. @author Glen Stampoultzis (glens at apache.org)
  16547. </member>
  16548. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(System.Int32,System.Byte[])">
  16549. @param id id of the record -not Validated, just stored for serialization
  16550. @param data the data
  16551. </member>
  16552. <member name="M:NPOI.HSSF.Record.UnknownRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16553. construct an Unknown record. No fields are interperated and the record will
  16554. be Serialized in its original form more or less
  16555. @param in the RecordInputstream to Read the record from
  16556. </member>
  16557. <member name="M:NPOI.HSSF.Record.UnknownRecord.Serialize(NPOI.Util.ILittleEndianOutput)">
  16558. spit the record out AS IS. no interpretation or identification
  16559. </member>
  16560. <member name="M:NPOI.HSSF.Record.UnknownRecord.ToString">
  16561. print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD])
  16562. </member>
  16563. <member name="M:NPOI.HSSF.Record.UnknownRecord.GetBiffName(System.Int32)">
  16564. These BIFF record types are known but still uninterpreted by POI
  16565. @return the documented name of this BIFF record type, <code>null</code> if unknown to POI
  16566. </member>
  16567. <member name="M:NPOI.HSSF.Record.UnknownRecord.IsObservedButUnknown(System.Int32)">
  16568. @return <c>true</c> if the unknown record id has been observed in POI unit tests
  16569. </member>
  16570. <member name="M:NPOI.HSSF.Record.UnknownRecord.Clone">
  16571. Unlike the other Record.Clone methods this Is a shallow Clone
  16572. </member>
  16573. <member name="T:NPOI.HSSF.Record.UserSViewBegin">
  16574. The UserSViewBegin record specifies Settings for a custom view associated with the sheet.
  16575. This record also marks the start of custom view records, which save custom view Settings.
  16576. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view,
  16577. not Settings for the sheet itself.
  16578. @author Yegor Kozlov
  16579. </member>
  16580. <member name="M:NPOI.HSSF.Record.UserSViewBegin.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16581. construct an UserSViewBegin record. No fields are interpreted and the record will
  16582. be Serialized in its original form more or less
  16583. @param in the RecordInputstream to read the record from
  16584. </member>
  16585. <member name="M:NPOI.HSSF.Record.UserSViewBegin.Serialize(NPOI.Util.ILittleEndianOutput)">
  16586. spit the record out AS IS. no interpretation or identification
  16587. </member>
  16588. <member name="P:NPOI.HSSF.Record.UserSViewBegin.Guid">
  16589. @return Globally unique identifier for the custom view
  16590. </member>
  16591. <member name="T:NPOI.HSSF.Record.UserSViewEnd">
  16592. The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet
  16593. @author Yegor Kozlov
  16594. </member>
  16595. <member name="M:NPOI.HSSF.Record.UserSViewEnd.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16596. construct an UserSViewEnd record. No fields are interpreted and the record will
  16597. be Serialized in its original form more or less
  16598. @param in the RecordInputstream to read the record from
  16599. </member>
  16600. <member name="M:NPOI.HSSF.Record.UserSViewEnd.Serialize(NPOI.Util.ILittleEndianOutput)">
  16601. spit the record out AS IS. no interpretation or identification
  16602. </member>
  16603. <member name="T:NPOI.HSSF.Record.UseSelFSRecord">
  16604. Title: Use Natural Language Formulas Flag
  16605. Description: Tells the GUI if this was written by something that can use
  16606. "natural language" formulas. HSSF can't.
  16607. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16608. @author Andrew C. Oliver (acoliver at apache dot org)
  16609. @version 2.0-pre
  16610. </member>
  16611. <member name="M:NPOI.HSSF.Record.UseSelFSRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16612. Constructs a UseSelFS record and Sets its fields appropriately.
  16613. @param in the RecordInputstream to Read the record from
  16614. </member>
  16615. <member name="T:NPOI.HSSF.Record.VCenterRecord">
  16616. Title: VCenter record
  16617. Description: tells whether to center the sheet between vertical margins
  16618. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16619. @author Andrew C. Oliver (acoliver at apache dot org)
  16620. @author Jason Height (jheight at chariot dot net dot au)
  16621. @version 2.0-pre
  16622. </member>
  16623. <member name="M:NPOI.HSSF.Record.VCenterRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16624. Constructs a VCENTER record and Sets its fields appropriately.
  16625. @param in the RecordInputstream to Read the record from
  16626. </member>
  16627. <member name="P:NPOI.HSSF.Record.VCenterRecord.VCenter">
  16628. Get whether to center vertically or not
  16629. @return vcenter or not
  16630. </member>
  16631. <member name="T:NPOI.HSSF.Record.VerticalPageBreakRecord">
  16632. VerticalPageBreak record that stores page breaks at columns
  16633. This class Is just used so that SID Compares work properly in the RecordFactory
  16634. @see PageBreakRecord
  16635. @author Danny Mui (dmui at apache dot org)
  16636. </member>
  16637. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor">
  16638. </member>
  16639. <member name="M:NPOI.HSSF.Record.VerticalPageBreakRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16640. @param in the RecordInputstream to Read the record from
  16641. </member>
  16642. <member name="T:NPOI.HSSF.Record.WindowOneRecord">
  16643. Title: Window1 Record
  16644. Description: Stores the attributes of the workbook window. This Is basically
  16645. so the gui knows how big to make the window holding the spReadsheet
  16646. document.
  16647. REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16648. @author Andrew C. Oliver (acoliver at apache dot org)
  16649. @version 2.0-pre
  16650. </member>
  16651. <member name="M:NPOI.HSSF.Record.WindowOneRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16652. Constructs a WindowOne record and Sets its fields appropriately.
  16653. @param in the RecordInputstream to Read the record from
  16654. </member>
  16655. <member name="P:NPOI.HSSF.Record.WindowOneRecord.HorizontalHold">
  16656. Get the horizontal position of the window (in 1/20ths of a point)
  16657. @return h - horizontal location
  16658. </member>
  16659. <member name="P:NPOI.HSSF.Record.WindowOneRecord.VerticalHold">
  16660. Get the vertical position of the window (in 1/20ths of a point)
  16661. @return v - vertical location
  16662. </member>
  16663. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Width">
  16664. Get the width of the window
  16665. @return width
  16666. </member>
  16667. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Height">
  16668. Get the height of the window
  16669. @return height
  16670. </member>
  16671. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Options">
  16672. Get the options bitmask (see bit Setters)
  16673. @return o - the bitmask
  16674. </member>
  16675. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Hidden">
  16676. Get whether the window Is hidden or not
  16677. @return Ishidden or not
  16678. </member>
  16679. <member name="P:NPOI.HSSF.Record.WindowOneRecord.Iconic">
  16680. Get whether the window has been iconized or not
  16681. @return iconize or not
  16682. </member>
  16683. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayHorizontalScrollbar">
  16684. Get whether to Display the horizontal scrollbar or not
  16685. @return Display or not
  16686. </member>
  16687. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayVerticalScrollbar">
  16688. Get whether to Display the vertical scrollbar or not
  16689. @return Display or not
  16690. </member>
  16691. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayTabs">
  16692. Get whether to Display the tabs or not
  16693. @return Display or not
  16694. </member>
  16695. <member name="P:NPOI.HSSF.Record.WindowOneRecord.ActiveSheetIndex">
  16696. @return the index of the currently Displayed sheet
  16697. </member>
  16698. <member name="P:NPOI.HSSF.Record.WindowOneRecord.SelectedTab">
  16699. deprecated May 2008
  16700. @deprecated - Misleading name - use GetActiveSheetIndex()
  16701. </member>
  16702. <member name="P:NPOI.HSSF.Record.WindowOneRecord.FirstVisibleTab">
  16703. @return the first visible sheet in the worksheet tab-bar.
  16704. I.E. the scroll position of the tab-bar.
  16705. </member>
  16706. <member name="P:NPOI.HSSF.Record.WindowOneRecord.DisplayedTab">
  16707. deprecated May 2008
  16708. @deprecated - Misleading name - use GetFirstVisibleTab()
  16709. </member>
  16710. <member name="P:NPOI.HSSF.Record.WindowOneRecord.NumSelectedTabs">
  16711. Get the number of selected tabs
  16712. @return number of tabs
  16713. </member>
  16714. <member name="P:NPOI.HSSF.Record.WindowOneRecord.TabWidthRatio">
  16715. ratio of the width of the tabs to the horizontal scrollbar
  16716. @return ratio
  16717. </member>
  16718. <member name="T:NPOI.HSSF.Record.WindowProtectRecord">
  16719. Title: Window Protect Record
  16720. Description: flags whether workbook windows are protected
  16721. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16722. @author Andrew C. Oliver (acoliver at apache dot org)
  16723. @version 2.0-pre
  16724. </member>
  16725. <member name="M:NPOI.HSSF.Record.WindowProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16726. Constructs a WindowProtect record and Sets its fields appropriately.
  16727. @param in the RecordInputstream to Read the record from
  16728. </member>
  16729. <member name="P:NPOI.HSSF.Record.WindowProtectRecord.Protect">
  16730. Is this window protected or not
  16731. @return protected or not
  16732. </member>
  16733. <member name="T:NPOI.HSSF.Record.WindowTwoRecord">
  16734. Title: Window Two Record
  16735. Description: sheet window Settings
  16736. REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16737. @author Andrew C. Oliver (acoliver at apache dot org)
  16738. @author Jason Height (jheight at chariot dot net dot au)
  16739. @version 2.0-pre
  16740. </member>
  16741. <member name="M:NPOI.HSSF.Record.WindowTwoRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16742. Constructs a WindowTwo record and Sets its fields appropriately.
  16743. @param in the RecordInputstream to Read the record from
  16744. </member>
  16745. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Options">
  16746. Get the options bitmask or just use the bit Setters.
  16747. @return options
  16748. </member>
  16749. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayFormulas">
  16750. Get whether the window should Display formulas
  16751. @return formulas or not
  16752. </member>
  16753. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGridlines">
  16754. Get whether the window should Display gridlines
  16755. @return gridlines or not
  16756. </member>
  16757. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayRowColHeadings">
  16758. Get whether the window should Display row and column headings
  16759. @return headings or not
  16760. </member>
  16761. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanes">
  16762. Get whether the window should freeze panes
  16763. @return freeze panes or not
  16764. </member>
  16765. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayZeros">
  16766. Get whether the window should Display zero values
  16767. @return zeros or not
  16768. </member>
  16769. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DefaultHeader">
  16770. Get whether the window should Display a default header
  16771. @return header or not
  16772. </member>
  16773. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Arabic">
  16774. Is this arabic?
  16775. @return arabic or not
  16776. </member>
  16777. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.DisplayGuts">
  16778. Get whether the outline symbols are displaed
  16779. @return symbols or not
  16780. </member>
  16781. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.FreezePanesNoSplit">
  16782. freeze Unsplit panes or not
  16783. @return freeze or not
  16784. </member>
  16785. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsSelected">
  16786. sheet tab Is selected
  16787. @return selected or not
  16788. </member>
  16789. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.IsActive">
  16790. Is the sheet currently Displayed in the window
  16791. @return Displayed or not
  16792. </member>
  16793. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Paged">
  16794. deprecated May 2008
  16795. @deprecated use IsActive()
  16796. </member>
  16797. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.SavedInPageBreakPreview">
  16798. was the sheet saved in page break view
  16799. @return pagebreaksaved or not
  16800. </member>
  16801. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.TopRow">
  16802. Get the top row visible in the window
  16803. @return toprow
  16804. </member>
  16805. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.LeftCol">
  16806. Get the leftmost column Displayed in the window
  16807. @return leftmost
  16808. </member>
  16809. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.HeaderColor">
  16810. Get the palette index for the header color
  16811. @return color
  16812. </member>
  16813. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.PageBreakZoom">
  16814. zoom magification in page break view
  16815. @return zoom
  16816. </member>
  16817. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.NormalZoom">
  16818. Get the zoom magnification in normal view
  16819. @return zoom
  16820. </member>
  16821. <member name="P:NPOI.HSSF.Record.WindowTwoRecord.Reserved">
  16822. Get the reserved bits - why would you do this?
  16823. @return reserved stuff -probably garbage
  16824. </member>
  16825. <member name="T:NPOI.HSSF.Record.WriteAccessRecord">
  16826. Title: Write Access Record
  16827. Description: Stores the username of that who owns the spReadsheet generator
  16828. (on Unix the user's login, on Windoze its the name you typed when
  16829. you installed the thing)
  16830. REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16831. @author Andrew C. Oliver (acoliver at apache dot org)
  16832. @version 2.0-pre
  16833. </member>
  16834. <member name="F:NPOI.HSSF.Record.WriteAccessRecord.PADDING">
  16835. this record is always padded to a constant length
  16836. </member>
  16837. <member name="M:NPOI.HSSF.Record.WriteAccessRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16838. Constructs a WriteAccess record and Sets its fields appropriately.
  16839. @param in the RecordInputstream to Read the record from
  16840. </member>
  16841. <member name="P:NPOI.HSSF.Record.WriteAccessRecord.Username">
  16842. Get the username for the user that Created the report. HSSF uses the logged in user. On
  16843. natively Created M$ Excel sheet this would be the name you typed in when you installed it
  16844. in most cases.
  16845. @return username of the user who Is logged in (probably "tomcat" or "apache")
  16846. </member>
  16847. <member name="T:NPOI.HSSF.Record.WriteProtectRecord">
  16848. Title: Write Protect Record
  16849. Description: Indicated that the sheet/workbook Is Write protected.
  16850. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16851. @version 3.0-pre
  16852. </member>
  16853. <member name="M:NPOI.HSSF.Record.WriteProtectRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16854. Constructs a WriteAccess record and Sets its fields appropriately.
  16855. @param in the RecordInputstream to Read the record from
  16856. </member>
  16857. <member name="T:NPOI.HSSF.Record.WSBoolRecord">
  16858. Title: WSBool Record.
  16859. Description: stores workbook Settings (aka its a big "everything we didn't
  16860. put somewhere else")
  16861. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
  16862. @author Andrew C. Oliver (acoliver at apache dot org)
  16863. @author Glen Stampoultzis (gstamp@iprimus.com.au)
  16864. @author Jason Height (jheight at chariot dot net dot au)
  16865. @version 2.0-pre
  16866. </member>
  16867. <member name="M:NPOI.HSSF.Record.WSBoolRecord.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  16868. Constructs a WSBool record and Sets its fields appropriately.
  16869. @param in the RecordInputstream to Read the record from
  16870. </member>
  16871. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool1">
  16872. Get first byte (see bit Getters)
  16873. </member>
  16874. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Autobreaks">
  16875. <summary>
  16876. Whether to show automatic page breaks or not
  16877. </summary>
  16878. </member>
  16879. <member name="P:NPOI.HSSF.Record.WSBoolRecord.Dialog">
  16880. <summary>
  16881. Whether sheet is a dialog sheet or not
  16882. </summary>
  16883. </member>
  16884. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsBelow">
  16885. <summary>
  16886. Get if row summaries appear below detail in the outline
  16887. </summary>
  16888. </member>
  16889. <member name="P:NPOI.HSSF.Record.WSBoolRecord.RowSumsRight">
  16890. <summary>
  16891. Get if col summaries appear right of the detail in the outline
  16892. </summary>
  16893. </member>
  16894. <member name="P:NPOI.HSSF.Record.WSBoolRecord.WSBool2">
  16895. <summary>
  16896. Get the second byte (see bit Getters)
  16897. </summary>
  16898. </member>
  16899. <member name="P:NPOI.HSSF.Record.WSBoolRecord.FitToPage">
  16900. <summary>
  16901. fit to page option is on
  16902. </summary>
  16903. </member>
  16904. <member name="P:NPOI.HSSF.Record.WSBoolRecord.DisplayGuts">
  16905. <summary>
  16906. Whether to display the guts or not
  16907. </summary>
  16908. </member>
  16909. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateExpression">
  16910. <summary>
  16911. whether alternate expression evaluation is on
  16912. </summary>
  16913. </member>
  16914. <member name="P:NPOI.HSSF.Record.WSBoolRecord.AlternateFormula">
  16915. <summary>
  16916. whether alternative formula entry is on
  16917. </summary>
  16918. </member>
  16919. <member name="F:NPOI.HSSF.XmlTkBlob.xtHeader">
  16920. <summary>
  16921. The xtHeader.drType field MUST be equal to 0x07.
  16922. </summary>
  16923. </member>
  16924. <member name="F:NPOI.HSSF.XmlTkBool.xtHeader">
  16925. <summary>
  16926. The xtHeader.drType field MUST be equal to 0x02.
  16927. </summary>
  16928. </member>
  16929. <member name="F:NPOI.HSSF.XmlTkDouble.xtHeader">
  16930. <summary>
  16931. The xtHeader.drType field MUST be equal to 0x03.
  16932. </summary>
  16933. </member>
  16934. <member name="F:NPOI.HSSF.XmlTkDWord.xtHeader">
  16935. <summary>
  16936. The xtHeader.drType field MUST be equal to 0x04.
  16937. </summary>
  16938. </member>
  16939. <member name="F:NPOI.HSSF.XmlTkEnd.xtHeader">
  16940. <summary>
  16941. The xtHeader.drType field MUST be equal to 0x01.
  16942. </summary>
  16943. </member>
  16944. <member name="F:NPOI.HSSF.XmlTkString.xtHeader">
  16945. <summary>
  16946. The xtHeader.drType field MUST be equal to 0x05.
  16947. </summary>
  16948. </member>
  16949. <member name="F:NPOI.HSSF.XmlTkString.rgbValue">
  16950. <summary>
  16951. An array of Unicode characters. The size of the array, in characters, is specified
  16952. by the cchValue field. The size of the field, in bytes, MUST equal the result of
  16953. the following formula:cchValue * 2.
  16954. </summary>
  16955. </member>
  16956. <member name="F:NPOI.HSSF.XmlTkStyle.chartStyle">
  16957. <summary>
  16958. The chartStyle.xtHeader.xmlTkTag MUST be equal to 0x0003.
  16959. </summary>
  16960. </member>
  16961. <member name="F:NPOI.HSSF.XmlTkTickMarkSkipFrt.nInterval">
  16962. <summary>
  16963. The nInterval.xtHeader.xmlTkTag field MUST be equal to 0x0052.
  16964. </summary>
  16965. </member>
  16966. <member name="T:NPOI.HSSF.UserModel.DVConstraint">
  16967. @author Josh Micich
  16968. </member>
  16969. <member name="M:NPOI.HSSF.UserModel.DVConstraint.#ctor(System.String,System.String[])">
  16970. Creates a list constraint
  16971. </member>
  16972. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateNumericConstraint(System.Int32,System.Int32,System.String,System.String)">
  16973. Creates a number based data validation constraint. The text values entered for expr1 and expr2
  16974. can be either standard Excel formulas or formatted number values. If the expression starts
  16975. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted number.
  16976. @param validationType one of {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#ANY},
  16977. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#DECIMAL},
  16978. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#INTEGER},
  16979. {@link NPOI.SS.UserModel.DataValidationConstraint.ValidationType#TEXT_LENGTH}
  16980. @param comparisonOperator any constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  16981. @param expr1 date formula (when first char is '=') or formatted number value
  16982. @param expr2 date formula (when first char is '=') or formatted number value
  16983. </member>
  16984. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateTimeConstraint(System.Int32,System.String,System.String)">
  16985. Creates a time based data validation constraint. The text values entered for expr1 and expr2
  16986. can be either standard Excel formulas or formatted time values. If the expression starts
  16987. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted time. To parse
  16988. formatted times, two formats are supported: "HH:MM" or "HH:MM:SS". This is contrary to
  16989. Excel which uses the default time format from the OS.
  16990. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  16991. @param expr1 date formula (when first char is '=') or formatted time value
  16992. @param expr2 date formula (when first char is '=') or formatted time value
  16993. </member>
  16994. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateDateConstraint(System.Int32,System.String,System.String,System.String)">
  16995. Creates a date based data validation constraint. The text values entered for expr1 and expr2
  16996. can be either standard Excel formulas or formatted date values. If the expression starts
  16997. with '=' it is Parsed as a formula, otherwise it is Parsed as a formatted date (Excel uses
  16998. the same convention). To parse formatted dates, a date format needs to be specified. This
  16999. is contrary to Excel which uses the default short date format from the OS.
  17000. @param comparisonOperator constant from {@link NPOI.SS.UserModel.DataValidationConstraint.OperatorType} enum
  17001. @param expr1 date formula (when first char is '=') or formatted date value
  17002. @param expr2 date formula (when first char is '=') or formatted date value
  17003. @param dateFormat ignored if both expr1 and expr2 are formulas. Default value is "YYYY/MM/DD"
  17004. otherwise any other valid argument for <c>SimpleDateFormat</c> can be used
  17005. @see <a href='http://java.sun.com/j2se/1.5.0/docs/api/java/text/DateFormat.html'>SimpleDateFormat</a>
  17006. </member>
  17007. <member name="M:NPOI.HSSF.UserModel.DVConstraint.GetFormulaFromTextExpression(System.String)">
  17008. Distinguishes formula expressions from simple value expressions. This logic is only
  17009. required by a few factory methods in this class that create data validation constraints
  17010. from more or less the same parameters that would have been entered in the Excel UI. The
  17011. data validation dialog box uses the convention that formulas begin with '='. Other methods
  17012. in this class follow the POI convention (formulas and values are distinct), so the '='
  17013. convention is not used there.
  17014. @param textExpr a formula or value expression
  17015. @return all text After '=' if textExpr begins with '='. Otherwise <code>null</code> if textExpr does not begin with '='
  17016. </member>
  17017. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertNumber(System.String)">
  17018. @return <code>null</code> if numberStr is <code>null</code>
  17019. </member>
  17020. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertTime(System.String)">
  17021. @return <code>null</code> if timeStr is <code>null</code>
  17022. </member>
  17023. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDate(System.String,NPOI.SS.Util.SimpleDateFormat)">
  17024. @param dateFormat pass <code>null</code> for default YYYYMMDD
  17025. @return <code>null</code> if timeStr is <code>null</code>
  17026. </member>
  17027. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsListValidationType">
  17028. Convenience method
  17029. @return <c>true</c> if this constraint is a 'list' validation
  17030. </member>
  17031. <member name="P:NPOI.HSSF.UserModel.DVConstraint.IsExplicitList">
  17032. Convenience method
  17033. @return <c>true</c> if this constraint is a 'list' validation with explicit values
  17034. </member>
  17035. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value1">
  17036. @return the numeric value for expression 1. May be <c>null</c>
  17037. </member>
  17038. <member name="P:NPOI.HSSF.UserModel.DVConstraint.Value2">
  17039. @return the numeric value for expression 2. May be <c>null</c>
  17040. </member>
  17041. <member name="M:NPOI.HSSF.UserModel.DVConstraint.CreateFormulas(NPOI.HSSF.UserModel.HSSFSheet)">
  17042. @return both Parsed formulas (for expression 1 and 2).
  17043. </member>
  17044. <member name="M:NPOI.HSSF.UserModel.DVConstraint.ConvertDoubleFormula(System.String,System.Double,NPOI.HSSF.UserModel.HSSFSheet)">
  17045. @return The Parsed token array representing the formula or value specified.
  17046. Empty array if both formula and value are <code>null</code>
  17047. </member>
  17048. <member name="T:NPOI.HSSF.UserModel.EscherGraphics">
  17049. Translates Graphics calls into escher calls. The translation Is lossy so
  17050. many features are not supported and some just aren't implemented yet. If
  17051. in doubt test the specific calls you wish to make. Graphics calls are
  17052. always performed into an EscherGroup so one will need to be Created.
  17053. <b>Important:</b>
  17054. <blockquote>
  17055. One important concept worth considering Is that of font size. One of the
  17056. difficulties in Converting Graphics calls into escher Drawing calls Is that
  17057. Excel does not have the concept of absolute pixel positions. It measures
  17058. it's cell widths in 'Chars' and the cell heights in points.
  17059. Unfortunately it's not defined exactly what a type of Char it's
  17060. measuring. Presumably this Is due to the fact that the Excel will be
  17061. using different fonts on different platforms or even within the same
  17062. platform.
  17063. Because of this constraint we've had to calculate the
  17064. verticalPointsPerPixel. This the amount the font should be scaled by when
  17065. you Issue commands such as DrawString(). A good way to calculate this
  17066. Is to use the follow formula:
  17067. <pre>
  17068. multipler = GroupHeightInPoints / heightOfGroup
  17069. </pre>
  17070. The height of the Group Is calculated fairly simply by calculating the
  17071. difference between the y coordinates of the bounding box of the shape. The
  17072. height of the Group can be calculated by using a convenience called
  17073. <c>HSSFClientAnchor.GetAnchorHeightInPoints()</c>.
  17074. </blockquote>
  17075. @author Glen Stampoultzis (glens at apache.org)
  17076. </member>
  17077. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Single)">
  17078. Construct an escher graphics object.
  17079. @param escherGroup The escher Group to Write the graphics calls into.
  17080. @param workbook The workbook we are using.
  17081. @param forecolor The foreground color to use as default.
  17082. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  17083. </member>
  17084. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.#ctor(NPOI.HSSF.UserModel.HSSFShapeGroup,NPOI.HSSF.UserModel.HSSFWorkbook,System.Drawing.Color,System.Drawing.Font,System.Single)">
  17085. Constructs an escher graphics object.
  17086. @param escherGroup The escher Group to Write the graphics calls into.
  17087. @param workbook The workbook we are using.
  17088. @param foreground The foreground color to use as default.
  17089. @param verticalPointsPerPixel The font multiplier. (See class description for information on how this works.).
  17090. @param font The font to use.
  17091. </member>
  17092. <member name="M:NPOI.HSSF.UserModel.EscherGraphics.FillPolygon(System.Int32[],System.Int32[],System.Int32)">
  17093. Fills a (closed) polygon, as defined by a pair of arrays, which
  17094. hold the <i>x</i> and <i>y</i> coordinates.
  17095. This Draws the polygon, with <c>nPoint</c> line segments.
  17096. The first <c>nPoint - 1</c> line segments are
  17097. Drawn between sequential points
  17098. (<c>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</c>).
  17099. The line segment Is a closing one, from the last point to
  17100. the first (assuming they are different).
  17101. The area inside of the polygon Is defined by using an
  17102. even-odd Fill rule (also known as the alternating rule), and
  17103. the area inside of it Is Filled.
  17104. @param xPoints array of the <c>x</c> coordinates.
  17105. @param yPoints array of the <c>y</c> coordinates.
  17106. @param nPoints the total number of points in the polygon.
  17107. @see java.awt.Graphics#DrawPolygon(int[], int[], int)
  17108. </member>
  17109. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector">
  17110. Instances of this class keep track of multiple dependent cell evaluations due
  17111. to recursive calls to <c>HSSFFormulaEvaluator.internalEvaluate()</c>.
  17112. The main purpose of this class Is to detect an attempt to evaluate a cell
  17113. that Is alReady being evaluated. In other words, it detects circular
  17114. references in spReadsheet formulas.
  17115. @author Josh Micich
  17116. </member>
  17117. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame">
  17118. Stores the parameters that identify the evaluation of one cell.<br/>
  17119. </member>
  17120. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.CellEvaluationFrame.FormatAsString">
  17121. @return human Readable string for debug purposes
  17122. </member>
  17123. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.StartEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  17124. Notifies this evaluation tracker that evaluation of the specified cell Is
  17125. about to start.<br/>
  17126. In the case of a <c>true</c> return code, the caller should
  17127. continue evaluation of the specified cell, and also be sure to call
  17128. <c>endEvaluate()</c> when complete.<br/>
  17129. In the case of a <c>false</c> return code, the caller should
  17130. return an evaluation result of
  17131. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  17132. <br/>
  17133. @return <c>true</c> if the specified cell has not been visited yet in the current
  17134. evaluation. <c>false</c> if the specified cell Is alReady being evaluated.
  17135. </member>
  17136. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetector.EndEvaluate(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int32)">
  17137. Notifies this evaluation tracker that the evaluation of the specified
  17138. cell Is complete. <p/>
  17139. Every successful call to <c>startEvaluate</c> must be followed by a
  17140. call to <c>endEvaluate</c> (recommended in a finally block) to enable
  17141. proper tracking of which cells are being evaluated at any point in time.<p/>
  17142. Assuming a well behaved client, parameters to this method would not be
  17143. required. However, they have been included to assert correct behaviour,
  17144. and form more meaningful error messages.
  17145. </member>
  17146. <member name="T:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager">
  17147. This class makes an <c>EvaluationCycleDetector</c> instance available to
  17148. each thRead via a <c>ThReadLocal</c> in order to avoid Adding a parameter
  17149. to a few protected methods within <c>HSSFFormulaEvaluator</c>.
  17150. @author Josh Micich
  17151. </member>
  17152. <member name="M:NPOI.HSSF.UserModel.EvaluationCycleDetectorManager.GetTracker">
  17153. @return
  17154. </member>
  17155. <member name="T:NPOI.HSSF.UserModel.FontDetails">
  17156. <summary>
  17157. Stores width and height details about a font.
  17158. @author Glen Stampoultzis (glens at apache.org)
  17159. </summary>
  17160. </member>
  17161. <member name="M:NPOI.HSSF.UserModel.FontDetails.#ctor(System.String,System.Int32)">
  17162. <summary>
  17163. Construct the font details with the given name and height.
  17164. </summary>
  17165. <param name="fontName">The font name.</param>
  17166. <param name="height">The height of the font.</param>
  17167. </member>
  17168. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetFontName">
  17169. <summary>
  17170. Gets the name of the font.
  17171. </summary>
  17172. <returns></returns>
  17173. </member>
  17174. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetHeight">
  17175. <summary>
  17176. Gets the height.
  17177. </summary>
  17178. <returns></returns>
  17179. </member>
  17180. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChar(System.Char,System.Int32)">
  17181. <summary>
  17182. Adds the char.
  17183. </summary>
  17184. <param name="c">The c.</param>
  17185. <param name="width">The width.</param>
  17186. </member>
  17187. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetCharWidth(System.Char)">
  17188. <summary>
  17189. Retrieves the width of the specified Char. If the metrics for
  17190. a particular Char are not available it defaults to returning the
  17191. width for the 'W' Char.
  17192. </summary>
  17193. <param name="c">The character.</param>
  17194. <returns></returns>
  17195. </member>
  17196. <member name="M:NPOI.HSSF.UserModel.FontDetails.AddChars(System.Char[],System.Int32[])">
  17197. <summary>
  17198. Adds the chars.
  17199. </summary>
  17200. <param name="Chars">The chars.</param>
  17201. <param name="widths">The widths.</param>
  17202. </member>
  17203. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontHeightProperty(System.String)">
  17204. <summary>
  17205. Builds the font height property.
  17206. </summary>
  17207. <param name="fontName">Name of the font.</param>
  17208. <returns></returns>
  17209. </member>
  17210. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontWidthsProperty(System.String)">
  17211. <summary>
  17212. Builds the font widths property.
  17213. </summary>
  17214. <param name="fontName">Name of the font.</param>
  17215. <returns></returns>
  17216. </member>
  17217. <member name="M:NPOI.HSSF.UserModel.FontDetails.BuildFontCharsProperty(System.String)">
  17218. <summary>
  17219. Builds the font chars property.
  17220. </summary>
  17221. <param name="fontName">Name of the font.</param>
  17222. <returns></returns>
  17223. </member>
  17224. <member name="M:NPOI.HSSF.UserModel.FontDetails.Create(System.String,NPOI.Util.Collections.Properties)">
  17225. <summary>
  17226. Create an instance of
  17227. <c>FontDetails</c>
  17228. by loading them from the
  17229. provided property object.
  17230. </summary>
  17231. <param name="fontName">the font name.</param>
  17232. <param name="fontMetricsProps">the property object holding the details of this
  17233. particular font.</param>
  17234. <returns>a new FontDetails instance.</returns>
  17235. </member>
  17236. <member name="M:NPOI.HSSF.UserModel.FontDetails.GetStringWidth(System.String)">
  17237. <summary>
  17238. Gets the width of all Chars in a string.
  17239. </summary>
  17240. <param name="str">The string to measure.</param>
  17241. <returns>The width of the string for a 10 point font.</returns>
  17242. </member>
  17243. <member name="M:NPOI.HSSF.UserModel.FontDetails.Split(System.String,System.String,System.Int32)">
  17244. <summary>
  17245. Split the given string into an array of strings using the given
  17246. delimiter.
  17247. </summary>
  17248. <param name="text">The text.</param>
  17249. <param name="separator">The separator.</param>
  17250. <param name="max">The max.</param>
  17251. <returns></returns>
  17252. </member>
  17253. <member name="T:NPOI.HSSF.UserModel.HeaderFooter">
  17254. <summary>
  17255. Common class for HSSFHeader and HSSFFooter
  17256. </summary>
  17257. </member>
  17258. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.RawText">
  17259. @return the internal text representation (combining center, left and right parts).
  17260. Possibly empty string if no header or footer is set. Never <c>null</c>.
  17261. </member>
  17262. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.UpdateHeaderFooterText(System.String[])">
  17263. <summary>
  17264. Creates the complete footer string based on the left, center, and middle
  17265. strings.
  17266. </summary>
  17267. <param name="parts">The parts.</param>
  17268. </member>
  17269. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.SetHeaderFooterText(System.String)">
  17270. <summary>
  17271. Sets the header footer text.
  17272. </summary>
  17273. <param name="text">the new header footer text (contains mark-up tags). Possibly
  17274. empty string never </param>
  17275. </member>
  17276. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Left">
  17277. <summary>
  17278. Get the left side of the header or footer.
  17279. </summary>
  17280. <value>The string representing the left side.</value>
  17281. </member>
  17282. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Center">
  17283. <summary>
  17284. Get the center of the header or footer.
  17285. </summary>
  17286. <value>The string representing the center.</value>
  17287. </member>
  17288. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Right">
  17289. <summary>
  17290. Get the right side of the header or footer.
  17291. </summary>
  17292. <value>The string representing the right side..</value>
  17293. </member>
  17294. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.FontSize(System.Int16)">
  17295. <summary>
  17296. Returns the string that represents the change in font size.
  17297. </summary>
  17298. <param name="size">the new font size.</param>
  17299. <returns>The special string to represent a new font size</returns>
  17300. </member>
  17301. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Font(System.String,System.String)">
  17302. <summary>
  17303. Returns the string that represents the change in font.
  17304. </summary>
  17305. <param name="font">the new font.</param>
  17306. <param name="style">the fonts style, one of regular, italic, bold, italic bold or bold italic.</param>
  17307. <returns>The special string to represent a new font size</returns>
  17308. </member>
  17309. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Page">
  17310. <summary>
  17311. Returns the string representing the current page number
  17312. </summary>
  17313. <value>The special string for page number.</value>
  17314. </member>
  17315. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.NumPages">
  17316. <summary>
  17317. Returns the string representing the number of pages.
  17318. </summary>
  17319. <value>The special string for the number of pages.</value>
  17320. </member>
  17321. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Date">
  17322. <summary>
  17323. Returns the string representing the current date
  17324. </summary>
  17325. <value>The special string for the date</value>
  17326. </member>
  17327. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Time">
  17328. <summary>
  17329. Gets the time.
  17330. </summary>
  17331. <value>The time.</value>
  17332. Returns the string representing the current time
  17333. @return The special string for the time
  17334. </member>
  17335. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.File">
  17336. <summary>
  17337. Returns the string representing the current file name
  17338. </summary>
  17339. <value>The special string for the file name.</value>
  17340. </member>
  17341. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Tab">
  17342. <summary>
  17343. Returns the string representing the current tab (sheet) name
  17344. </summary>
  17345. <value>The special string for tab name.</value>
  17346. </member>
  17347. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartBold">
  17348. <summary>
  17349. Returns the string representing the start bold
  17350. </summary>
  17351. <returns>The special string for start bold</returns>
  17352. </member>
  17353. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndBold">
  17354. <summary>
  17355. Returns the string representing the end bold
  17356. </summary>
  17357. <value>The special string for end bold.</value>
  17358. </member>
  17359. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartUnderline">
  17360. <summary>
  17361. Returns the string representing the start underline
  17362. </summary>
  17363. <value>The special string for start underline.</value>
  17364. </member>
  17365. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndUnderline">
  17366. <summary>
  17367. Returns the string representing the end underline
  17368. </summary>
  17369. <value>The special string for end underline.</value>
  17370. </member>
  17371. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.StartDoubleUnderline">
  17372. <summary>
  17373. Returns the string representing the start double underline
  17374. </summary>
  17375. <value>The special string for start double underline.</value>
  17376. </member>
  17377. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.EndDoubleUnderline">
  17378. <summary>
  17379. Returns the string representing the end double underline
  17380. </summary>
  17381. <value>The special string for end double underline.</value>
  17382. </member>
  17383. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.StripFields(System.String)">
  17384. <summary>
  17385. Removes any fields (eg macros, page markers etc)
  17386. from the string.
  17387. Normally used to make some text suitable for showing
  17388. to humans, and the resultant text should not normally
  17389. be saved back into the document!
  17390. </summary>
  17391. <param name="text">The text.</param>
  17392. <returns></returns>
  17393. </member>
  17394. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.AreFieldsStripped">
  17395. <summary>
  17396. Are fields currently being Stripped from
  17397. the text that this {@link HeaderStories} returns?
  17398. Default is false, but can be changed
  17399. </summary>
  17400. <value><c>true</c> if [are fields stripped]; otherwise, <c>false</c>.</value>
  17401. </member>
  17402. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.Field">
  17403. <summary>
  17404. Represents a special field in a header or footer,
  17405. eg the page number
  17406. </summary>
  17407. </member>
  17408. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Field.sequence">
  17409. The character sequence that marks this field
  17410. </member>
  17411. <member name="T:NPOI.HSSF.UserModel.HeaderFooter.PairField">
  17412. <summary>
  17413. A special field that normally comes in a pair, eg
  17414. turn on underline / turn off underline
  17415. </summary>
  17416. </member>
  17417. <member name="F:NPOI.HSSF.UserModel.HeaderFooter.Fields.instance">
  17418. <summary>
  17419. Instance to this class.
  17420. </summary>
  17421. </member>
  17422. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#cctor">
  17423. <summary>
  17424. Explicit static constructor to tell C# compiler not to mark type as beforefieldinit.
  17425. </summary>
  17426. </member>
  17427. <member name="M:NPOI.HSSF.UserModel.HeaderFooter.Fields.#ctor">
  17428. <summary>
  17429. Initialize AllFields.
  17430. </summary>
  17431. </member>
  17432. <member name="P:NPOI.HSSF.UserModel.HeaderFooter.Fields.Instance">
  17433. <summary>
  17434. Accessing the initialized instance.
  17435. </summary>
  17436. </member>
  17437. <member name="T:NPOI.HSSF.UserModel.HSSFAnchor">
  17438. <summary>
  17439. An anchor Is what specifics the position of a shape within a client object
  17440. or within another containing shape.
  17441. @author Glen Stampoultzis (glens at apache.org)
  17442. </summary>
  17443. </member>
  17444. <member name="M:NPOI.HSSF.UserModel.HSSFAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  17445. <summary>
  17446. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFAnchor"/> class.
  17447. </summary>
  17448. <param name="dx1">The DX1.</param>
  17449. <param name="dy1">The dy1.</param>
  17450. <param name="dx2">The DX2.</param>
  17451. <param name="dy2">The dy2.</param>
  17452. </member>
  17453. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx1">
  17454. <summary>
  17455. Gets or sets the DX1.
  17456. </summary>
  17457. <value>The DX1.</value>
  17458. </member>
  17459. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy1">
  17460. <summary>
  17461. Gets or sets the dy1.
  17462. </summary>
  17463. <value>The dy1.</value>
  17464. </member>
  17465. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dy2">
  17466. <summary>
  17467. Gets or sets the dy2.
  17468. </summary>
  17469. <value>The dy2.</value>
  17470. </member>
  17471. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.Dx2">
  17472. <summary>
  17473. Gets or sets the DX2.
  17474. </summary>
  17475. <value>The DX2.</value>
  17476. </member>
  17477. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsHorizontallyFlipped">
  17478. <summary>
  17479. Gets a value indicating whether this instance is horizontally flipped.
  17480. </summary>
  17481. <value>
  17482. <c>true</c> if this instance is horizontally flipped; otherwise, <c>false</c>.
  17483. </value>
  17484. </member>
  17485. <member name="P:NPOI.HSSF.UserModel.HSSFAnchor.IsVerticallyFlipped">
  17486. <summary>
  17487. Gets a value indicating whether this instance is vertically flipped.
  17488. </summary>
  17489. <value>
  17490. <c>true</c> if this instance is vertically flipped; otherwise, <c>false</c>.
  17491. </value>
  17492. </member>
  17493. <member name="T:NPOI.HSSF.UserModel.HSSFBorderFormatting">
  17494. High level representation for Border Formatting component
  17495. of Conditional Formatting Settings
  17496. @author Dmitriy Kumshayev
  17497. </member>
  17498. <member name="T:NPOI.HSSF.UserModel.HSSFCell">
  17499. <summary>
  17500. High level representation of a cell in a row of a spReadsheet.
  17501. Cells can be numeric, formula-based or string-based (text). The cell type
  17502. specifies this. String cells cannot conatin numbers and numeric cells cannot
  17503. contain strings (at least according to our model). Client apps should do the
  17504. conversions themselves. Formula cells have the formula string, as well as
  17505. the formula result, which can be numeric or string.
  17506. Cells should have their number (0 based) before being Added to a row. Only
  17507. cells that have values should be Added.
  17508. </summary>
  17509. <remarks>
  17510. @author Andrew C. Oliver (acoliver at apache dot org)
  17511. @author Dan Sherman (dsherman at Isisph.com)
  17512. @author Brian Sanders (kestrel at burdell dot org) Active Cell support
  17513. @author Yegor Kozlov cell comments support
  17514. </remarks>
  17515. </member>
  17516. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16)">
  17517. <summary>
  17518. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  17519. from scratch.
  17520. When the cell is initially Created it is Set to CellType.Blank. Cell types
  17521. can be Changed/overwritten by calling SetCellValue with the appropriate
  17522. type as a parameter although conversions from one type to another may be
  17523. prohibited.
  17524. </summary>
  17525. <param name="book">Workbook record of the workbook containing this cell</param>
  17526. <param name="sheet">Sheet record of the sheet containing this cell</param>
  17527. <param name="row">the row of this cell</param>
  17528. <param name="col">the column for this cell</param>
  17529. </member>
  17530. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32,System.Int16,NPOI.SS.UserModel.CellType)">
  17531. <summary>
  17532. Creates new Cell - Should only be called by HSSFRow. This Creates a cell
  17533. from scratch.
  17534. </summary>
  17535. <param name="book">Workbook record of the workbook containing this cell</param>
  17536. <param name="sheet">Sheet record of the sheet containing this cell</param>
  17537. <param name="row">the row of this cell</param>
  17538. <param name="col">the column for this cell</param>
  17539. <param name="type">CellType.Numeric, CellType.String, CellType.Formula, CellType.Blank,
  17540. CellType.Boolean, CellType.Error</param>
  17541. </member>
  17542. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.CellValueRecordInterface)">
  17543. <summary>
  17544. Creates an Cell from a CellValueRecordInterface. HSSFSheet uses this when
  17545. reading in cells from an existing sheet.
  17546. </summary>
  17547. <param name="book">Workbook record of the workbook containing this cell</param>
  17548. <param name="sheet">Sheet record of the sheet containing this cell</param>
  17549. <param name="cval">the Cell Value Record we wish to represent</param>
  17550. </member>
  17551. <member name="M:NPOI.HSSF.UserModel.HSSFCell.#ctor">
  17552. private constructor to prevent blank construction
  17553. </member>
  17554. <member name="M:NPOI.HSSF.UserModel.HSSFCell.DetermineType(NPOI.HSSF.Record.CellValueRecordInterface)">
  17555. used internally -- given a cell value record, figure out its type
  17556. </member>
  17557. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BoundWorkbook">
  17558. <summary>
  17559. the Workbook that this Cell is bound to
  17560. </summary>
  17561. </member>
  17562. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Row">
  17563. <summary>
  17564. the HSSFRow this cell belongs to
  17565. </summary>
  17566. </member>
  17567. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType)">
  17568. <summary>
  17569. Set the cells type (numeric, formula or string)
  17570. </summary>
  17571. <param name="cellType">Type of the cell.</param>
  17572. </member>
  17573. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellType(NPOI.SS.UserModel.CellType,System.Boolean,System.Int32,System.Int32,System.Int16)">
  17574. <summary>
  17575. Sets the cell type. The SetValue flag indicates whether to bother about
  17576. trying to preserve the current value in the new record if one is Created.
  17577. The SetCellValue method will call this method with false in SetValue
  17578. since it will overWrite the cell value later
  17579. </summary>
  17580. <param name="cellType">Type of the cell.</param>
  17581. <param name="setValue">if set to <c>true</c> [set value].</param>
  17582. <param name="row">The row.</param>
  17583. <param name="col">The col.</param>
  17584. <param name="styleIndex">Index of the style.</param>
  17585. </member>
  17586. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellType">
  17587. <summary>
  17588. Get the cells type (numeric, formula or string)
  17589. </summary>
  17590. <value>The type of the cell.</value>
  17591. </member>
  17592. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Double)">
  17593. <summary>
  17594. Set a numeric value for the cell
  17595. </summary>
  17596. <param name="value">the numeric value to Set this cell to. For formulas we'll Set the
  17597. precalculated value, for numerics we'll Set its value. For other types we
  17598. will Change the cell to a numeric cell and Set its value.</param>
  17599. </member>
  17600. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.DateTime)">
  17601. <summary>
  17602. Set a date value for the cell. Excel treats dates as numeric so you will need to format the cell as
  17603. a date.
  17604. </summary>
  17605. <param name="value">the date value to Set this cell to. For formulas we'll Set the
  17606. precalculated value, for numerics we'll Set its value. For other types we
  17607. will Change the cell to a numeric cell and Set its value.</param>
  17608. </member>
  17609. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.String)">
  17610. <summary>
  17611. Set a string value for the cell. Please note that if you are using
  17612. full 16 bit Unicode you should call SetEncoding() first.
  17613. </summary>
  17614. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  17615. string, for String cells we'll Set its value. For other types we will
  17616. Change the cell to a string cell and Set its value.
  17617. If value is null then we will Change the cell to a Blank cell.</param>
  17618. </member>
  17619. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellErrorValue(System.Byte)">
  17620. set a error value for the cell
  17621. @param errorCode the error value to set this cell to. For formulas we'll set the
  17622. precalculated value , for errors we'll set
  17623. its value. For other types we will change the cell to an error
  17624. cell and set its value.
  17625. </member>
  17626. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  17627. <summary>
  17628. Set a string value for the cell. Please note that if you are using
  17629. full 16 bit Unicode you should call SetEncoding() first.
  17630. </summary>
  17631. <param name="value">value to Set the cell to. For formulas we'll Set the formula
  17632. string, for String cells we'll Set its value. For other types we will
  17633. Change the cell to a string cell and Set its value.
  17634. If value is null then we will Change the cell to a Blank cell.</param>
  17635. </member>
  17636. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyFormulaChanging">
  17637. Should be called any time that a formula could potentially be deleted.
  17638. Does nothing if this cell currently does not hold a formula
  17639. </member>
  17640. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellFormula">
  17641. <summary>
  17642. Gets or sets the cell formula.
  17643. </summary>
  17644. <value>The cell formula.</value>
  17645. </member>
  17646. <member name="P:NPOI.HSSF.UserModel.HSSFCell.NumericCellValue">
  17647. <summary>
  17648. Get the value of the cell as a number. For strings we throw an exception.
  17649. For blank cells we return a 0.
  17650. </summary>
  17651. <value>The numeric cell value.</value>
  17652. </member>
  17653. <member name="M:NPOI.HSSF.UserModel.HSSFCell.GetCellTypeName(NPOI.SS.UserModel.CellType)">
  17654. <summary>
  17655. Used to help format error messages
  17656. </summary>
  17657. <param name="cellTypeCode">The cell type code.</param>
  17658. <returns></returns>
  17659. </member>
  17660. <member name="M:NPOI.HSSF.UserModel.HSSFCell.TypeMismatch(NPOI.SS.UserModel.CellType,NPOI.SS.UserModel.CellType,System.Boolean)">
  17661. <summary>
  17662. Types the mismatch.
  17663. </summary>
  17664. <param name="expectedTypeCode">The expected type code.</param>
  17665. <param name="actualTypeCode">The actual type code.</param>
  17666. <param name="isFormulaCell">if set to <c>true</c> [is formula cell].</param>
  17667. <returns></returns>
  17668. </member>
  17669. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckFormulaCachedValueType(NPOI.SS.UserModel.CellType,NPOI.HSSF.Record.FormulaRecord)">
  17670. <summary>
  17671. Checks the type of the formula cached value.
  17672. </summary>
  17673. <param name="expectedTypeCode">The expected type code.</param>
  17674. <param name="fr">The fr.</param>
  17675. </member>
  17676. <member name="P:NPOI.HSSF.UserModel.HSSFCell.DateCellValue">
  17677. <summary>
  17678. Get the value of the cell as a date. For strings we throw an exception.
  17679. For blank cells we return a null.
  17680. </summary>
  17681. <value>The date cell value.</value>
  17682. </member>
  17683. <member name="P:NPOI.HSSF.UserModel.HSSFCell.StringCellValue">
  17684. <summary>
  17685. Get the value of the cell as a string - for numeric cells we throw an exception.
  17686. For blank cells we return an empty string.
  17687. For formulaCells that are not string Formulas, we return empty String
  17688. </summary>
  17689. <value>The string cell value.</value>
  17690. </member>
  17691. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RichStringCellValue">
  17692. <summary>
  17693. Get the value of the cell as a string - for numeric cells we throw an exception.
  17694. For blank cells we return an empty string.
  17695. For formulaCells that are not string Formulas, we return empty String
  17696. </summary>
  17697. <value>The rich string cell value.</value>
  17698. </member>
  17699. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetCellValue(System.Boolean)">
  17700. <summary>
  17701. Set a bool value for the cell
  17702. </summary>
  17703. <param name="value">the bool value to Set this cell to. For formulas we'll Set the
  17704. precalculated value, for bools we'll Set its value. For other types we
  17705. will Change the cell to a bool cell and Set its value.</param>
  17706. </member>
  17707. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ConvertCellValueToBoolean">
  17708. <summary>
  17709. Chooses a new bool value for the cell when its type is changing.
  17710. Usually the caller is calling SetCellType() with the intention of calling
  17711. SetCellValue(bool) straight afterwards. This method only exists to give
  17712. the cell a somewhat reasonable value until the SetCellValue() call (if at all).
  17713. TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this
  17714. </summary>
  17715. <returns></returns>
  17716. </member>
  17717. <member name="P:NPOI.HSSF.UserModel.HSSFCell.BooleanCellValue">
  17718. <summary>
  17719. Get the value of the cell as a bool. For strings, numbers, and errors, we throw an exception.
  17720. For blank cells we return a false.
  17721. </summary>
  17722. <value><c>true</c> if [boolean cell value]; otherwise, <c>false</c>.</value>
  17723. </member>
  17724. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ErrorCellValue">
  17725. <summary>
  17726. Get the value of the cell as an error code. For strings, numbers, and bools, we throw an exception.
  17727. For blank cells we return a 0.
  17728. </summary>
  17729. <value>The error cell value.</value>
  17730. </member>
  17731. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellStyle">
  17732. <summary>
  17733. Get the style for the cell. This is a reference to a cell style contained in the workbook
  17734. object.
  17735. </summary>
  17736. <value>The cell style.</value>
  17737. </member>
  17738. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ApplyUserCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle)">
  17739. Applying a user-defined style (UDS) is special. Excel does not directly reference user-defined styles, but
  17740. instead create a 'proxy' ExtendedFormatRecord referencing the UDS as parent.
  17741. The proceudre to apply a UDS is as follows:
  17742. 1. search for a ExtendedFormatRecord with parentIndex == style.getIndex()
  17743. and xfType == ExtendedFormatRecord.XF_CELL.
  17744. 2. if not found then create a new ExtendedFormatRecord and copy all attributes from the user-defined style
  17745. and set the parentIndex to be style.getIndex()
  17746. 3. return the index of the ExtendedFormatRecord, this will be assigned to the parent cell record
  17747. @param style the user style to apply
  17748. @return the index of a ExtendedFormatRecord record that will be referenced by the cell
  17749. </member>
  17750. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellValueRecord">
  17751. <summary>
  17752. Should only be used by HSSFSheet and friends. Returns the low level CellValueRecordInterface record
  17753. </summary>
  17754. <value>the cell via the low level api.</value>
  17755. </member>
  17756. <member name="M:NPOI.HSSF.UserModel.HSSFCell.CheckBounds(System.Int32)">
  17757. <summary>
  17758. Checks the bounds.
  17759. </summary>
  17760. <param name="cellIndex">The cell num.</param>
  17761. <exception cref="T:System.Exception">if the bounds are exceeded.</exception>
  17762. </member>
  17763. <member name="M:NPOI.HSSF.UserModel.HSSFCell.SetAsActiveCell">
  17764. <summary>
  17765. Sets this cell as the active cell for the worksheet
  17766. </summary>
  17767. </member>
  17768. <member name="M:NPOI.HSSF.UserModel.HSSFCell.ToString">
  17769. <summary>
  17770. Returns a string representation of the cell
  17771. This method returns a simple representation,
  17772. anthing more complex should be in user code, with
  17773. knowledge of the semantics of the sheet being Processed.
  17774. Formula cells return the formula string,
  17775. rather than the formula result.
  17776. Dates are Displayed in dd-MMM-yyyy format
  17777. Errors are Displayed as #ERR&lt;errIdx&gt;
  17778. </summary>
  17779. </member>
  17780. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CellComment">
  17781. <summary>
  17782. Returns comment associated with this cell
  17783. </summary>
  17784. <value>The cell comment associated with this cell.</value>
  17785. </member>
  17786. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveCellComment">
  17787. <summary>
  17788. Removes the comment for this cell, if
  17789. there is one.
  17790. </summary>
  17791. <remarks>WARNING - some versions of excel will loose
  17792. all comments after performing this action!</remarks>
  17793. </member>
  17794. <member name="P:NPOI.HSSF.UserModel.HSSFCell.ColumnIndex">
  17795. <summary>
  17796. Gets the index of the column.
  17797. </summary>
  17798. <value>The index of the column.</value>
  17799. </member>
  17800. <member name="M:NPOI.HSSF.UserModel.HSSFCell.UpdateCellNum(System.Int32)">
  17801. Updates the cell record's idea of what
  17802. column it belongs in (0 based)
  17803. @param num the new cell number
  17804. </member>
  17805. <member name="P:NPOI.HSSF.UserModel.HSSFCell.RowIndex">
  17806. <summary>
  17807. Gets the (zero based) index of the row containing this cell
  17808. </summary>
  17809. <value>The index of the row.</value>
  17810. </member>
  17811. <member name="P:NPOI.HSSF.UserModel.HSSFCell.Hyperlink">
  17812. <summary>
  17813. Get or set hyperlink associated with this cell
  17814. If the supplied hyperlink is null on setting, the hyperlink for this cell will be removed.
  17815. </summary>
  17816. <value>The hyperlink associated with this cell or null if not found</value>
  17817. </member>
  17818. <member name="M:NPOI.HSSF.UserModel.HSSFCell.RemoveHyperlink">
  17819. <summary>
  17820. Removes the hyperlink for this cell, if there is one.
  17821. </summary>
  17822. </member>
  17823. <member name="P:NPOI.HSSF.UserModel.HSSFCell.CachedFormulaResultType">
  17824. <summary>
  17825. Only valid for formula cells
  17826. </summary>
  17827. <value>one of (CellType.Numeric,CellType.String, CellType.Boolean, CellType.Error) depending
  17828. on the cached value of the formula</value>
  17829. </member>
  17830. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging(System.String)">
  17831. <summary>
  17832. The purpose of this method is to validate the cell state prior to modification
  17833. </summary>
  17834. <param name="msg"></param>
  17835. </member>
  17836. <member name="M:NPOI.HSSF.UserModel.HSSFCell.NotifyArrayFormulaChanging">
  17837. <summary>
  17838. Called when this cell is modified.
  17839. The purpose of this method is to validate the cell state prior to modification.
  17840. </summary>
  17841. </member>
  17842. <member name="T:NPOI.HSSF.UserModel.HSSFCellStyle">
  17843. <summary>
  17844. High level representation of the style of a cell in a sheet of a workbook.
  17845. @author Andrew C. Oliver (acoliver at apache dot org)
  17846. @author Jason Height (jheight at chariot dot net dot au)
  17847. </summary>
  17848. </member>
  17849. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.UserModel.HSSFWorkbook)">
  17850. <summary>
  17851. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  17852. </summary>
  17853. <param name="index">The index.</param>
  17854. <param name="rec">The record.</param>
  17855. <param name="workbook">The workbook.</param>
  17856. </member>
  17857. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.#ctor(System.Int16,NPOI.HSSF.Record.ExtendedFormatRecord,NPOI.HSSF.Model.InternalWorkbook)">
  17858. <summary>
  17859. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFCellStyle"/> class.
  17860. </summary>
  17861. <param name="index">The index.</param>
  17862. <param name="rec">The record.</param>
  17863. <param name="workbook">The workbook.</param>
  17864. </member>
  17865. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Index">
  17866. <summary>
  17867. Get the index within the HSSFWorkbook (sequence within the collection of ExtnededFormat objects)
  17868. </summary>
  17869. <value>Unique index number of the Underlying record this style represents (probably you don't care
  17870. Unless you're comparing which one is which)</value>
  17871. </member>
  17872. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ParentStyle">
  17873. <summary>
  17874. Gets the parent style.
  17875. </summary>
  17876. <value>the parent style for this cell style.
  17877. In most cases this will be null, but in a few
  17878. cases there'll be a fully defined parent.</value>
  17879. </member>
  17880. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.DataFormat">
  17881. <summary>
  17882. Get the index of the format
  17883. </summary>
  17884. <value>The data format.</value>
  17885. </member>
  17886. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString">
  17887. <summary>
  17888. Get the contents of the format string, by looking up
  17889. the DataFormat against the bound workbook
  17890. </summary>
  17891. <returns></returns>
  17892. </member>
  17893. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.SS.UserModel.IWorkbook)">
  17894. <summary>
  17895. Get the contents of the format string, by looking up the DataFormat against the supplied workbook
  17896. </summary>
  17897. <param name="workbook">The workbook</param>
  17898. <returns>the format string or "General" if not found</returns>
  17899. </member>
  17900. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetDataFormatString(NPOI.HSSF.Model.InternalWorkbook)">
  17901. <summary>
  17902. Get the contents of the format string, by looking up
  17903. the DataFormat against the supplied workbook
  17904. </summary>
  17905. <param name="workbook">The internal workbook.</param>
  17906. <returns></returns>
  17907. </member>
  17908. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  17909. <summary>
  17910. Set the font for this style
  17911. </summary>
  17912. <param name="font">a font object Created or retreived from the HSSFWorkbook object</param>
  17913. </member>
  17914. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FontIndex">
  17915. <summary>
  17916. Gets the index of the font for this style.
  17917. </summary>
  17918. <value>The index of the font.</value>
  17919. </member>
  17920. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetFont(NPOI.SS.UserModel.IWorkbook)">
  17921. <summary>
  17922. Gets the font for this style
  17923. </summary>
  17924. <param name="parentWorkbook">The parent workbook that this style belongs to.</param>
  17925. <returns></returns>
  17926. </member>
  17927. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsHidden">
  17928. <summary>
  17929. Get whether the cell's using this style are to be hidden
  17930. </summary>
  17931. <value>whether the cell using this style should be hidden</value>
  17932. </member>
  17933. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.IsLocked">
  17934. <summary>
  17935. Get whether the cell's using this style are to be locked
  17936. </summary>
  17937. <value>whether the cell using this style should be locked</value>
  17938. </member>
  17939. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Alignment">
  17940. <summary>
  17941. Get the type of horizontal alignment for the cell
  17942. </summary>
  17943. <value> the type of alignment</value>
  17944. </member>
  17945. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.WrapText">
  17946. <summary>
  17947. Gets or sets a value indicating whether the text should be wrapped
  17948. </summary>
  17949. <value><c>true</c> if [wrap text]; otherwise, <c>false</c>.</value>
  17950. </member>
  17951. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.VerticalAlignment">
  17952. <summary>
  17953. Gets or sets the vertical alignment for the cell.
  17954. </summary>
  17955. <value>the type of alignment</value>
  17956. </member>
  17957. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Rotation">
  17958. <summary>
  17959. Gets or sets the degree of rotation for the text in the cell
  17960. </summary>
  17961. <value>The rotation degrees (between -90 and 90 degrees).</value>
  17962. </member>
  17963. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.VerifyBelongsToWorkbook(NPOI.HSSF.UserModel.HSSFWorkbook)">
  17964. <summary>
  17965. Verifies that this style belongs to the supplied Workbook.
  17966. Will throw an exception if it belongs to a different one.
  17967. This is normally called when trying to assign a style to a
  17968. cell, to ensure the cell and the style are from the same
  17969. workbook (if they're not, it won't work)
  17970. </summary>
  17971. <param name="wb">The workbook.</param>
  17972. </member>
  17973. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.Indention">
  17974. <summary>
  17975. Gets or sets the number of spaces to indent the text in the cell
  17976. </summary>
  17977. <value>number of spaces</value>
  17978. </member>
  17979. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderLeft">
  17980. <summary>
  17981. Gets or sets the type of border to use for the left border of the cell
  17982. </summary>
  17983. <value>The border type.</value>
  17984. </member>
  17985. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderRight">
  17986. <summary>
  17987. Gets or sets the type of border to use for the right border of the cell
  17988. </summary>
  17989. <value>The border type.</value>
  17990. </member>
  17991. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderTop">
  17992. <summary>
  17993. Gets or sets the type of border to use for the top border of the cell
  17994. </summary>
  17995. <value>The border type.</value>
  17996. </member>
  17997. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderBottom">
  17998. <summary>
  17999. Gets or sets the type of border to use for the bottom border of the cell
  18000. </summary>
  18001. <value>The border type.</value>
  18002. </member>
  18003. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.LeftBorderColor">
  18004. <summary>
  18005. Gets or sets the color to use for the left border
  18006. </summary>
  18007. <value>The index of the color definition</value>
  18008. </member>
  18009. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.RightBorderColor">
  18010. <summary>
  18011. Gets or sets the color to use for the left border.
  18012. </summary>
  18013. <value>The index of the color definition</value>
  18014. </member>
  18015. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.TopBorderColor">
  18016. <summary>
  18017. Gets or sets the color to use for the top border
  18018. </summary>
  18019. <value>The index of the color definition.</value>
  18020. </member>
  18021. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BottomBorderColor">
  18022. <summary>
  18023. Gets or sets the color to use for the left border
  18024. </summary>
  18025. <value>The index of the color definition.</value>
  18026. </member>
  18027. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalColor">
  18028. <summary>
  18029. Gets or sets the color to use for the diagional border
  18030. </summary>
  18031. <value>The index of the color definition.</value>
  18032. </member>
  18033. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonalLineStyle">
  18034. <summary>
  18035. Gets or sets the line type to use for the diagional border
  18036. </summary>
  18037. <value>The line type.</value>
  18038. </member>
  18039. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.BorderDiagonal">
  18040. <summary>
  18041. Gets or sets the type of diagional border
  18042. </summary>.
  18043. <value>The border diagional type.</value>
  18044. </member>
  18045. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ShrinkToFit">
  18046. <summary>
  18047. Gets or sets whether the cell is shrink-to-fit
  18048. </summary>
  18049. </member>
  18050. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.ReadingOrder">
  18051. Get or set the reading order, for RTL/LTR ordering of
  18052. the text.
  18053. <p>0 means Context (Default), 1 means Left To Right,
  18054. and 2 means Right to Left</p>
  18055. @return order - the reading order (0,1,2)
  18056. </member>
  18057. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillPattern">
  18058. <summary>
  18059. Gets or sets the fill pattern. - Set to 1 to Fill with foreground color
  18060. </summary>
  18061. <value>The fill pattern.</value>
  18062. </member>
  18063. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CheckDefaultBackgroundFills">
  18064. <summary>
  18065. Checks if the background and foreground Fills are Set correctly when one
  18066. or the other is Set to the default color.
  18067. Works like the logic table below:
  18068. BACKGROUND FOREGROUND
  18069. NONE AUTOMATIC
  18070. 0x41 0x40
  18071. NONE RED/ANYTHING
  18072. 0x40 0xSOMETHING
  18073. </summary>
  18074. </member>
  18075. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  18076. Clones all the style information from another
  18077. HSSFCellStyle, onto this one. This
  18078. HSSFCellStyle will then have all the same
  18079. properties as the source, but the two may
  18080. be edited independently.
  18081. Any stylings on this HSSFCellStyle will be lost!
  18082. The source HSSFCellStyle could be from another
  18083. HSSFWorkbook if you like. This allows you to
  18084. copy styles from one HSSFWorkbook to another.
  18085. </member>
  18086. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.CloneStyleFrom(NPOI.HSSF.UserModel.HSSFCellStyle)">
  18087. <summary>
  18088. Clones all the style information from another
  18089. HSSFCellStyle, onto this one. This
  18090. HSSFCellStyle will then have all the same
  18091. properties as the source, but the two may
  18092. be edited independently.
  18093. Any stylings on this HSSFCellStyle will be lost!
  18094. The source HSSFCellStyle could be from another
  18095. HSSFWorkbook if you like. This allows you to
  18096. copy styles from one HSSFWorkbook to another.
  18097. </summary>
  18098. <param name="source">The source.</param>
  18099. </member>
  18100. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillBackgroundColor">
  18101. <summary>
  18102. Gets or sets the color of the fill background.
  18103. </summary>
  18104. <value>The color of the fill background.</value>
  18105. Set the background Fill color.
  18106. <example>
  18107. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  18108. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  18109. optionally a Foreground and background Fill can be applied:
  18110. Note: Ensure Foreground color is Set prior to background
  18111. cs.SetFillPattern(HSSFCellStyle.FINE_DOTS );
  18112. cs.SetFillForegroundColor(new HSSFColor.BLUE().Index);
  18113. cs.SetFillBackgroundColor(new HSSFColor.RED().Index);
  18114. or, for the special case of SOLID_Fill:
  18115. cs.SetFillPattern(HSSFCellStyle.SOLID_FOREGROUND );
  18116. cs.SetFillForegroundColor(new HSSFColor.RED().Index);
  18117. It is necessary to Set the Fill style in order
  18118. for the color to be shown in the cell.
  18119. </example>
  18120. </member>
  18121. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.FillForegroundColor">
  18122. <summary>
  18123. Gets or sets the foreground Fill color
  18124. </summary>
  18125. <value>Fill color.</value>
  18126. @see org.apache.poi.hssf.usermodel.HSSFPalette#GetColor(short)
  18127. </member>
  18128. <member name="P:NPOI.HSSF.UserModel.HSSFCellStyle.UserStyleName">
  18129. Gets the name of the user defined style.
  18130. Returns null for built in styles, and
  18131. styles where no name has been defined
  18132. </member>
  18133. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.GetHashCode">
  18134. <summary>
  18135. Serves as a hash function for a particular type.
  18136. </summary>
  18137. <returns>
  18138. A hash code for the current <see cref="T:System.Object"/>.
  18139. </returns>
  18140. </member>
  18141. <member name="M:NPOI.HSSF.UserModel.HSSFCellStyle.Equals(System.Object)">
  18142. <summary>
  18143. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  18144. </summary>
  18145. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  18146. <returns>
  18147. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  18148. </returns>
  18149. <exception cref="T:System.NullReferenceException">
  18150. The <paramref name="obj"/> parameter is null.
  18151. </exception>
  18152. </member>
  18153. <member name="T:NPOI.HSSF.UserModel.HSSFChart">
  18154. Has methods for construction of a chart object.
  18155. @author Glen Stampoultzis (glens at apache.org)
  18156. </member>
  18157. <member name="M:NPOI.HSSF.UserModel.HSSFChart.CreateBarChart(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet)">
  18158. Creates a bar chart. API needs some work. :)
  18159. NOTE: Does not yet work... checking it in just so others
  18160. can take a look.
  18161. </member>
  18162. <member name="M:NPOI.HSSF.UserModel.HSSFChart.GetSheetCharts(NPOI.HSSF.UserModel.HSSFSheet)">
  18163. Returns all the charts for the given sheet.
  18164. NOTE: You won't be able to do very much with
  18165. these charts yet, as this is very limited support
  18166. </member>
  18167. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartX">
  18168. Get the X offset of the chart
  18169. </member>
  18170. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartY">
  18171. Get the Y offset of the chart
  18172. </member>
  18173. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartWidth">
  18174. Get the width of the chart. {@link ChartRecord}
  18175. </member>
  18176. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartHeight">
  18177. Get the height of the chart. {@link ChartRecord}
  18178. </member>
  18179. <member name="P:NPOI.HSSF.UserModel.HSSFChart.Series">
  18180. Returns the series of the chart
  18181. </member>
  18182. <member name="P:NPOI.HSSF.UserModel.HSSFChart.ChartTitle">
  18183. Returns the chart's title, if there is one,
  18184. or null if not
  18185. </member>
  18186. <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})">
  18187. Set value range (basic Axis Options)
  18188. @param axisIndex 0 - primary axis, 1 - secondary axis
  18189. @param minimum minimum value; Double.NaN - automatic; null - no change
  18190. @param maximum maximum value; Double.NaN - automatic; null - no change
  18191. @param majorUnit major unit value; Double.NaN - automatic; null - no change
  18192. @param minorUnit minor unit value; Double.NaN - automatic; null - no change
  18193. </member>
  18194. <member name="T:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries">
  18195. A series in a chart
  18196. </member>
  18197. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.ValueType">
  18198. See {@link SeriesRecord}
  18199. </member>
  18200. <member name="P:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.SeriesTitle">
  18201. Returns the series' title, if there is one,
  18202. or null if not
  18203. </member>
  18204. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataName">
  18205. @return record with data names
  18206. </member>
  18207. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataValues">
  18208. @return record with data values
  18209. </member>
  18210. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataCategoryLabels">
  18211. @return record with data category labels
  18212. </member>
  18213. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetDataSecondaryCategoryLabels">
  18214. @return record with data secondary category labels
  18215. </member>
  18216. <member name="M:NPOI.HSSF.UserModel.HSSFChart.HSSFSeries.GetSeries">
  18217. @return record with series
  18218. </member>
  18219. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(NPOI.DDF.EscherChildAnchorRecord)">
  18220. create anchor from existing file
  18221. @param escherChildAnchorRecord
  18222. </member>
  18223. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  18224. create anchor from scratch
  18225. @param dx1 x coordinate of the left up corner
  18226. @param dy1 y coordinate of the left up corner
  18227. @param dx2 x coordinate of the right down corner
  18228. @param dy2 y coordinate of the right down corner
  18229. </member>
  18230. <member name="M:NPOI.HSSF.UserModel.HSSFChildAnchor.SetAnchor(System.Int32,System.Int32,System.Int32,System.Int32)">
  18231. @param dx1 x coordinate of the left up corner
  18232. @param dy1 y coordinate of the left up corner
  18233. @param dx2 x coordinate of the right down corner
  18234. @param dy2 y coordinate of the right down corner
  18235. </member>
  18236. <member name="T:NPOI.HSSF.UserModel.HSSFClientAnchor">
  18237. <summary>
  18238. A client anchor Is attached to an excel worksheet. It anchors against a
  18239. top-left and buttom-right cell.
  18240. @author Glen Stampoultzis (glens at apache.org)
  18241. </summary>
  18242. </member>
  18243. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor">
  18244. <summary>
  18245. Creates a new client anchor and defaults all the anchor positions to 0.
  18246. </summary>
  18247. </member>
  18248. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  18249. <summary>
  18250. Creates a new client anchor and Sets the top-left and bottom-right
  18251. coordinates of the anchor.
  18252. Note: Microsoft Excel seems to sometimes disallow
  18253. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  18254. reverse them and draw shapes vertically or horizontally flipped!
  18255. </summary>
  18256. <param name="dx1">the x coordinate within the first cell.</param>
  18257. <param name="dy1">the y coordinate within the first cell.</param>
  18258. <param name="dx2">the x coordinate within the second cell.</param>
  18259. <param name="dy2">the y coordinate within the second cell.</param>
  18260. <param name="col1">the column (0 based) of the first cell.</param>
  18261. <param name="row1">the row (0 based) of the first cell.</param>
  18262. <param name="col2">the column (0 based) of the second cell.</param>
  18263. <param name="row2">the row (0 based) of the second cell.</param>
  18264. </member>
  18265. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetAnchorHeightInPoints(NPOI.SS.UserModel.ISheet)">
  18266. <summary>
  18267. Calculates the height of a client anchor in points.
  18268. </summary>
  18269. <param name="sheet">the sheet the anchor will be attached to</param>
  18270. <returns>the shape height.</returns>
  18271. </member>
  18272. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.GetRowHeightInPoints(NPOI.SS.UserModel.ISheet,System.Int32)">
  18273. <summary>
  18274. Gets the row height in points.
  18275. </summary>
  18276. <param name="sheet">The sheet.</param>
  18277. <param name="rowNum">The row num.</param>
  18278. <returns></returns>
  18279. </member>
  18280. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col1">
  18281. <summary>
  18282. Gets or sets the col1.
  18283. </summary>
  18284. <value>The col1.</value>
  18285. </member>
  18286. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Col2">
  18287. <summary>
  18288. Gets or sets the col2.
  18289. </summary>
  18290. <value>The col2.</value>
  18291. </member>
  18292. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row1">
  18293. <summary>
  18294. Gets or sets the row1.
  18295. </summary>
  18296. <value>The row1.</value>
  18297. </member>
  18298. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.Row2">
  18299. <summary>
  18300. Gets or sets the row2.
  18301. </summary>
  18302. <value>The row2.</value>
  18303. </member>
  18304. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.SetAnchor(System.Int16,System.Int32,System.Int32,System.Int32,System.Int16,System.Int32,System.Int32,System.Int32)">
  18305. <summary>
  18306. Sets the top-left and bottom-right
  18307. coordinates of the anchor
  18308. Note: Microsoft Excel seems to sometimes disallow
  18309. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  18310. reverse them and draw shapes vertically or horizontally flipped!
  18311. </summary>
  18312. <param name="col1">the column (0 based) of the first cell.</param>
  18313. <param name="row1"> the row (0 based) of the first cell.</param>
  18314. <param name="x1">the x coordinate within the first cell.</param>
  18315. <param name="y1">the y coordinate within the first cell.</param>
  18316. <param name="col2">the column (0 based) of the second cell.</param>
  18317. <param name="row2">the row (0 based) of the second cell.</param>
  18318. <param name="x2">the x coordinate within the second cell.</param>
  18319. <param name="y2">the y coordinate within the second cell.</param>
  18320. </member>
  18321. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsHorizontallyFlipped">
  18322. <summary>
  18323. Gets a value indicating whether this instance is horizontally flipped.
  18324. </summary>
  18325. <value>
  18326. <c>true</c> if the anchor goes from right to left; otherwise, <c>false</c>.
  18327. </value>
  18328. </member>
  18329. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.IsVerticallyFlipped">
  18330. <summary>
  18331. Gets a value indicating whether this instance is vertically flipped.
  18332. </summary>
  18333. <value>
  18334. <c>true</c> if the anchor goes from bottom to top.; otherwise, <c>false</c>.
  18335. </value>
  18336. </member>
  18337. <member name="P:NPOI.HSSF.UserModel.HSSFClientAnchor.AnchorType">
  18338. <summary>
  18339. Gets the anchor type
  18340. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  18341. </summary>
  18342. <value>The type of the anchor.</value>
  18343. </member>
  18344. <member name="M:NPOI.HSSF.UserModel.HSSFClientAnchor.CheckRange(System.Int32,System.Int32,System.Int32,System.String)">
  18345. <summary>
  18346. Checks the range.
  18347. </summary>
  18348. <param name="value">The value.</param>
  18349. <param name="minRange">The min range.</param>
  18350. <param name="maxRange">The max range.</param>
  18351. <param name="varName">Name of the variable.</param>
  18352. </member>
  18353. <member name="T:NPOI.HSSF.UserModel.HSSFComment">
  18354. <summary>
  18355. Represents a cell comment - a sticky note associated with a cell.
  18356. @author Yegor Kozlov
  18357. </summary>
  18358. </member>
  18359. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  18360. <summary>
  18361. Construct a new comment with the given parent and anchor.
  18362. </summary>
  18363. <param name="parent"></param>
  18364. <param name="anchor">defines position of this anchor in the sheet</param>
  18365. </member>
  18366. <member name="M:NPOI.HSSF.UserModel.HSSFComment.#ctor(NPOI.HSSF.Record.NoteRecord,NPOI.HSSF.Record.TextObjectRecord)">
  18367. <summary>
  18368. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> class.
  18369. </summary>
  18370. <param name="note">The note.</param>
  18371. <param name="txo">The txo.</param>
  18372. </member>
  18373. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Visible">
  18374. <summary>
  18375. Gets or sets a value indicating whether this <see cref="T:NPOI.HSSF.UserModel.HSSFComment"/> is visible.
  18376. </summary>
  18377. <value><c>true</c> if visible; otherwise, <c>false</c>.</value>
  18378. Sets whether this comment Is visible.
  18379. @return
  18380. <c>true</c>
  18381. if the comment Is visible,
  18382. <c>false</c>
  18383. otherwise
  18384. </member>
  18385. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Row">
  18386. <summary>
  18387. Gets or sets the row of the cell that Contains the comment
  18388. </summary>
  18389. <value>the 0-based row of the cell that Contains the comment</value>
  18390. </member>
  18391. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Column">
  18392. <summary>
  18393. Gets or sets the column of the cell that Contains the comment
  18394. </summary>
  18395. <value>the 0-based column of the cell that Contains the comment</value>
  18396. </member>
  18397. <member name="P:NPOI.HSSF.UserModel.HSSFComment.Author">
  18398. <summary>
  18399. Gets or sets the name of the original comment author
  18400. </summary>
  18401. <value>the name of the original author of the comment</value>
  18402. </member>
  18403. <member name="P:NPOI.HSSF.UserModel.HSSFComment.NoteRecord">
  18404. <summary>
  18405. Gets the note record.
  18406. </summary>
  18407. <value>the underlying Note record.</value>
  18408. </member>
  18409. <member name="P:NPOI.HSSF.UserModel.HSSFComment.HasPosition">
  18410. Do we know which cell this comment belongs to?
  18411. </member>
  18412. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting">
  18413. <summary>
  18414. HSSFConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  18415. The class can be used to make a copy HSSFConditionalFormatting Settings
  18416. </summary>
  18417. <example>
  18418. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  18419. newSheet.AddConditionalFormatting(cf);
  18420. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  18421. Use {@link HSSFSheet#GetConditionalFormattingAt(int)} to Get access to an instance of this class.
  18422. To Create a new Conditional Formatting Set use the following approach:
  18423. // Define a Conditional Formatting rule, which triggers formatting
  18424. // when cell's value Is greater or equal than 100.0 and
  18425. // applies patternFormatting defined below.
  18426. HSSFConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  18427. ComparisonOperator.GE,
  18428. "100.0", // 1st formula
  18429. null // 2nd formula Is not used for comparison operator GE
  18430. );
  18431. // Create pattern with red background
  18432. HSSFPatternFormatting patternFmt = rule.cretePatternFormatting();
  18433. patternFormatting.SetFillBackgroundColor(HSSFColor.RED.index);
  18434. // Define a region containing first column
  18435. Region [] regions =
  18436. {
  18437. new Region(1,(short)1,-1,(short)1)
  18438. };
  18439. // Apply Conditional Formatting rule defined above to the regions
  18440. sheet.AddConditionalFormatting(regions, rule);
  18441. </example>
  18442. <remarks>@author Dmitriy Kumshayev</remarks>
  18443. </member>
  18444. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.Aggregates.CFRecordsAggregate)">
  18445. <summary>
  18446. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFConditionalFormatting"/> class.
  18447. </summary>
  18448. <param name="workbook">The workbook.</param>
  18449. <param name="cfAggregate">The cf aggregate.</param>
  18450. </member>
  18451. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.CFRecordsAggregate">
  18452. <summary>
  18453. Gets the CF records aggregate.
  18454. </summary>
  18455. <returns></returns>
  18456. </member>
  18457. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRegions">
  18458. <summary>
  18459. Gets the array of Regions
  18460. </summary>
  18461. <returns></returns>
  18462. </member>
  18463. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetFormattingRanges">
  18464. <summary>
  18465. Gets array of CellRangeAddresses
  18466. </summary>
  18467. <returns></returns>
  18468. </member>
  18469. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.SetRule(System.Int32,NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  18470. <summary>
  18471. Replaces an existing Conditional Formatting rule at position idx.
  18472. Excel allows to Create up to 3 Conditional Formatting rules.
  18473. This method can be useful to modify existing Conditional Formatting rules.
  18474. </summary>
  18475. <param name="idx">position of the rule. Should be between 0 and 2.</param>
  18476. <param name="cfRule">Conditional Formatting rule</param>
  18477. </member>
  18478. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.AddRule(NPOI.HSSF.UserModel.HSSFConditionalFormattingRule)">
  18479. <summary>
  18480. Add a Conditional Formatting rule.
  18481. Excel allows to Create up to 3 Conditional Formatting rules.
  18482. </summary>
  18483. <param name="cfRule">Conditional Formatting rule</param>
  18484. </member>
  18485. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.GetRule(System.Int32)">
  18486. <summary>
  18487. Gets the Conditional Formatting rule at position idx
  18488. </summary>
  18489. <param name="idx">The index.</param>
  18490. <returns></returns>
  18491. </member>
  18492. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormatting.NumberOfRules">
  18493. <summary>
  18494. Gets the number of Conditional Formatting rules.
  18495. </summary>
  18496. <value>The number of rules.</value>
  18497. </member>
  18498. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormatting.ToString">
  18499. <summary>
  18500. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18501. </summary>
  18502. <returns>
  18503. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18504. </returns>
  18505. </member>
  18506. <member name="T:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule">
  18507. High level representation of Conditional Formatting Rule.
  18508. It allows to specify formula based conditions for the Conditional Formatting
  18509. and the formatting Settings such as font, border and pattern.
  18510. @author Dmitriy Kumshayev
  18511. </member>
  18512. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetFontFormatting">
  18513. @return - font formatting object if defined, <c>null</c> otherwise
  18514. </member>
  18515. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateFontFormatting">
  18516. Create a new font formatting structure if it does not exist,
  18517. otherwise just return existing object.
  18518. @return - font formatting object, never returns <c>null</c>.
  18519. </member>
  18520. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetBorderFormatting">
  18521. @return - border formatting object if defined, <c>null</c> otherwise
  18522. </member>
  18523. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreateBorderFormatting">
  18524. Create a new border formatting structure if it does not exist,
  18525. otherwise just return existing object.
  18526. @return - border formatting object, never returns <c>null</c>.
  18527. </member>
  18528. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.GetPatternFormatting">
  18529. @return - pattern formatting object if defined, <c>null</c> otherwise
  18530. </member>
  18531. <member name="M:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.CreatePatternFormatting">
  18532. Create a new pattern formatting structure if it does not exist,
  18533. otherwise just return existing object.
  18534. @return - pattern formatting object, never returns <c>null</c>.
  18535. </member>
  18536. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ConditionType">
  18537. @return - the conditiontype for the cfrule
  18538. </member>
  18539. <member name="P:NPOI.HSSF.UserModel.HSSFConditionalFormattingRule.ComparisonOperation">
  18540. @return - the comparisionoperatation for the cfrule
  18541. </member>
  18542. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateFormulaEvaluator">
  18543. Creates a HSSFFormulaEvaluator, the object that Evaluates formula cells.
  18544. @return a HSSFFormulaEvaluator instance
  18545. </member>
  18546. <member name="M:NPOI.HSSF.UserModel.HSSFCreationHelper.CreateClientAnchor">
  18547. Creates a HSSFClientAnchor. Use this object to position drawing object in a sheet
  18548. @return a HSSFClientAnchor instance
  18549. @see NPOI.SS.usermodel.Drawing
  18550. </member>
  18551. <member name="F:NPOI.HSSF.UserModel.HSSFDataFormat.FIRST_USER_DEFINED_FORMAT_INDEX">
  18552. The first user-defined format starts at 164.
  18553. </member>
  18554. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.#ctor(NPOI.HSSF.Model.InternalWorkbook)">
  18555. <summary>
  18556. Construncts a new data formatter. It takes a workbook to have
  18557. access to the workbooks format records.
  18558. </summary>
  18559. <param name="workbook">the workbook the formats are tied to.</param>
  18560. </member>
  18561. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.String)">
  18562. <summary>
  18563. Get the format index that matches the given format string
  18564. Automatically Converts "text" to excel's format string to represent text.
  18565. </summary>
  18566. <param name="format">The format string matching a built in format.</param>
  18567. <returns>index of format or -1 if Undefined.</returns>
  18568. </member>
  18569. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.String)">
  18570. <summary>
  18571. Get the format index that matches the given format
  18572. string, creating a new format entry if required.
  18573. Aliases text to the proper format as required.
  18574. </summary>
  18575. <param name="pFormat">The format string matching a built in format.</param>
  18576. <returns>index of format.</returns>
  18577. </member>
  18578. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetFormat(System.Int16)">
  18579. <summary>
  18580. Get the format string that matches the given format index
  18581. </summary>
  18582. <param name="index">The index of a format.</param>
  18583. <returns>string represented at index of format or null if there Is not a format at that index</returns>
  18584. </member>
  18585. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.GetBuiltinFormat(System.Int16)">
  18586. <summary>
  18587. Get the format string that matches the given format index
  18588. </summary>
  18589. <param name="index">The index of a built in format.</param>
  18590. <returns>string represented at index of format or null if there Is not a builtin format at that index</returns>
  18591. </member>
  18592. <member name="P:NPOI.HSSF.UserModel.HSSFDataFormat.NumberOfBuiltinBuiltinFormats">
  18593. <summary>
  18594. Get the number of builtin and reserved builtinFormats
  18595. </summary>
  18596. <returns>number of builtin and reserved builtinFormats</returns>
  18597. </member>
  18598. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormat.EnsureFormatsSize(System.Int32)">
  18599. Ensures that the formats list can hold entries
  18600. up to and including the entry with this index
  18601. </member>
  18602. <member name="T:NPOI.HSSF.UserModel.HSSFDataFormatter">
  18603. HSSFDataFormatter contains methods for formatting the value stored in an
  18604. HSSFCell. This can be useful for reports and GUI presentations when you
  18605. need to display data exactly as it appears in Excel. Supported formats
  18606. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  18607. codes, etc.
  18608. Internally, formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  18609. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  18610. formats used by this class must obey the same pattern rules as these Format
  18611. subclasses. This means that only legal number pattern characters ("0", "#",
  18612. ".", "," etc.) may appear in number formats. Other characters can be
  18613. inserted <em>before</em> or <em>after</em> the number pattern to form a
  18614. prefix or suffix.
  18615. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  18616. </c> will be correctly formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  18617. However the pattern <c>"00-00-00"</c> is incorrectly formatted by
  18618. DecimalFormat as "000000--". For Excel formats that are not compatible with
  18619. DecimalFormat, you can provide your own custom {@link Format} implementation
  18620. via <c>HSSFDataFormatter.AddFormat(String,Format)</c>. The following
  18621. custom formats are already provided by this class:
  18622. <pre>
  18623. <ul><li>SSN "000-00-0000"</li>
  18624. <li>Phone Number "(###) ###-####"</li>
  18625. <li>Zip plus 4 "00000-0000"</li>
  18626. </ul>
  18627. </pre>
  18628. If the Excel format pattern cannot be parsed successfully, then a default
  18629. format will be used. The default number format will mimic the Excel General
  18630. format: "#" for whole numbers and "#.##########" for decimal numbers. You
  18631. can override the default format pattern with <c>
  18632. HSSFDataFormatter.DefaultNumberFormat=(Format)</c>. <b>Note:</b> the
  18633. default format will only be used when a Format cannot be created from the
  18634. cell's data format string.
  18635. @author James May (james dot may at fmr dot com)
  18636. </member>
  18637. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor(System.Globalization.CultureInfo)">
  18638. Creates a formatter using the given locale.
  18639. </member>
  18640. <member name="M:NPOI.HSSF.UserModel.HSSFDataFormatter.#ctor">
  18641. Creates a formatter using the {@link Locale#getDefault() default locale}.
  18642. </member>
  18643. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidation">
  18644. Utility class for creating data validation cells
  18645. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  18646. </member>
  18647. <member name="M:NPOI.HSSF.UserModel.HSSFDataValidation.#ctor(NPOI.SS.Util.CellRangeAddressList,NPOI.SS.UserModel.IDataValidationConstraint)">
  18648. Constructor which Initializes the cell range on which this object will be
  18649. applied
  18650. @param constraint
  18651. </member>
  18652. <member name="T:NPOI.HSSF.UserModel.HSSFDataValidationHelper">
  18653. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  18654. </member>
  18655. <member name="T:NPOI.HSSF.UserModel.HSSFDateUtil">
  18656. Contains methods for dealing with Excel dates.
  18657. @author Michael Harhen
  18658. @author Glen Stampoultzis (glens at apache.org)
  18659. @author Dan Sherman (dsherman at isisph.com)
  18660. @author Hack Kampbjorn (hak at 2mba.dk)
  18661. @author Alex Jacoby (ajacoby at gmail.com)
  18662. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  18663. </member>
  18664. <member name="T:NPOI.HSSF.UserModel.HSSFErrorConstants">
  18665. <summary>
  18666. Contains raw Excel error codes (as defined in OOO's excelfileformat.pdf (2.5.6)
  18667. @author Michael Harhen
  18668. </summary>
  18669. </member>
  18670. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NULL">
  18671. <b>#NULL!</b> - Intersection of two cell ranges is empty
  18672. </member>
  18673. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_DIV_0">
  18674. <b>#DIV/0!</b> - Division by zero
  18675. </member>
  18676. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_VALUE">
  18677. <b>#VALUE!</b> - Wrong type of operand
  18678. </member>
  18679. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_REF">
  18680. <b>#REF!</b> - Illegal or deleted cell reference
  18681. </member>
  18682. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NAME">
  18683. <b>#NAME?</b> - Wrong function or range name
  18684. </member>
  18685. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NUM">
  18686. <b>#NUM!</b> - Value range overflow
  18687. </member>
  18688. <member name="F:NPOI.HSSF.UserModel.HSSFErrorConstants.ERROR_NA">
  18689. <b>#N/A</b> - Argument or function not available
  18690. </member>
  18691. <member name="M:NPOI.HSSF.UserModel.HSSFErrorConstants.GetText(System.Int32)">
  18692. <summary>
  18693. Gets standard Excel error literal for the specified error code.
  18694. @throws ArgumentException if the specified error code is not one of the 7
  18695. standard error codes
  18696. </summary>
  18697. <param name="errorCode">The error code.</param>
  18698. <returns></returns>
  18699. </member>
  18700. <member name="M:NPOI.HSSF.UserModel.HSSFErrorConstants.IsValidCode(System.Int32)">
  18701. <summary>
  18702. Determines whether [is valid code] [the specified error code].
  18703. </summary>
  18704. <param name="errorCode">The error code.</param>
  18705. <returns>
  18706. <c>true</c> if the specified error code is a standard Excel error code.; otherwise, <c>false</c>.
  18707. </returns>
  18708. </member>
  18709. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationCell">
  18710. <summary>
  18711. HSSF wrapper for a cell under evaluation
  18712. @author Josh Micich
  18713. </summary>
  18714. </member>
  18715. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationSheet">
  18716. HSSF wrapper for a sheet under evaluation
  18717. @author Josh Micich
  18718. </member>
  18719. <member name="T:NPOI.HSSF.UserModel.HSSFEvaluationWorkbook">
  18720. Internal POI use only
  18721. @author Josh Micich
  18722. </member>
  18723. <member name="T:NPOI.HSSF.UserModel.HSSFFont">
  18724. <summary>
  18725. Represents a Font used in a workbook.
  18726. @version 1.0-pre
  18727. @author Andrew C. Oliver
  18728. </summary>
  18729. </member>
  18730. <member name="M:NPOI.HSSF.UserModel.HSSFFont.#ctor(System.Int16,NPOI.HSSF.Record.FontRecord)">
  18731. <summary>
  18732. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFont"/> class.
  18733. </summary>
  18734. <param name="index">The index.</param>
  18735. <param name="rec">The record.</param>
  18736. </member>
  18737. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontName">
  18738. <summary>
  18739. Get the name for the font (i.e. Arial)
  18740. </summary>
  18741. <value>the name of the font to use</value>
  18742. </member>
  18743. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Index">
  18744. <summary>
  18745. Get the index within the HSSFWorkbook (sequence within the collection of Font objects)
  18746. </summary>
  18747. <value>Unique index number of the Underlying record this Font represents (probably you don't care
  18748. Unless you're comparing which one is which)</value>
  18749. </member>
  18750. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeight">
  18751. <summary>
  18752. Get or sets the font height in Unit's of 1/20th of a point. Maybe you might want to
  18753. use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  18754. </summary>
  18755. <value>height in 1/20ths of a point.</value>
  18756. </member>
  18757. <member name="P:NPOI.HSSF.UserModel.HSSFFont.FontHeightInPoints">
  18758. <summary>
  18759. Gets or sets the font height in points.
  18760. </summary>
  18761. <value>height in the familiar Unit of measure - points.</value>
  18762. </member>
  18763. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsItalic">
  18764. <summary>
  18765. Gets or sets whether to use italics or not
  18766. </summary>
  18767. <value><c>true</c> if this instance is italic; otherwise, <c>false</c>.</value>
  18768. </member>
  18769. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsStrikeout">
  18770. <summary>
  18771. Get whether to use a strikeout horizontal line through the text or not
  18772. </summary>
  18773. <value>
  18774. strikeout or not
  18775. </value>
  18776. </member>
  18777. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Color">
  18778. <summary>
  18779. Gets or sets the color for the font.
  18780. </summary>
  18781. <value>The color to use.</value>
  18782. </member>
  18783. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHSSFColor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  18784. <summary>
  18785. get the color value for the font
  18786. </summary>
  18787. <param name="wb">HSSFWorkbook</param>
  18788. <returns></returns>
  18789. </member>
  18790. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Boldweight">
  18791. <summary>
  18792. Gets or sets the boldness to use
  18793. </summary>
  18794. <value>The boldweight.</value>
  18795. </member>
  18796. <member name="P:NPOI.HSSF.UserModel.HSSFFont.IsBold">
  18797. get or set if the font bold style
  18798. </member>
  18799. <member name="P:NPOI.HSSF.UserModel.HSSFFont.TypeOffset">
  18800. <summary>
  18801. Gets or sets normal,base or subscript.
  18802. </summary>
  18803. <value>offset type to use (none,base,sub)</value>
  18804. </member>
  18805. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Underline">
  18806. <summary>
  18807. Gets or sets the type of text Underlining to use
  18808. </summary>
  18809. <value>The Underlining type.</value>
  18810. </member>
  18811. <member name="P:NPOI.HSSF.UserModel.HSSFFont.Charset">
  18812. <summary>
  18813. Gets or sets the char set to use.
  18814. </summary>
  18815. <value>The char set.</value>
  18816. </member>
  18817. <member name="M:NPOI.HSSF.UserModel.HSSFFont.ToString">
  18818. <summary>
  18819. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18820. </summary>
  18821. <returns>
  18822. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  18823. </returns>
  18824. </member>
  18825. <member name="M:NPOI.HSSF.UserModel.HSSFFont.GetHashCode">
  18826. <summary>
  18827. Serves as a hash function for a particular type.
  18828. </summary>
  18829. <returns>
  18830. A hash code for the current <see cref="T:System.Object"/>.
  18831. </returns>
  18832. </member>
  18833. <member name="M:NPOI.HSSF.UserModel.HSSFFont.Equals(System.Object)">
  18834. <summary>
  18835. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  18836. </summary>
  18837. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  18838. <returns>
  18839. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  18840. </returns>
  18841. <exception cref="T:System.NullReferenceException">
  18842. The <paramref name="obj"/> parameter is null.
  18843. </exception>
  18844. </member>
  18845. <member name="T:NPOI.HSSF.UserModel.HSSFFontFormatting">
  18846. High level representation for Font Formatting component
  18847. of Conditional Formatting Settings
  18848. @author Dmitriy Kumshayev
  18849. </member>
  18850. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.EscapementType">
  18851. Get the type of base or subscript for the font
  18852. @return base or subscript option
  18853. </member>
  18854. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontColorIndex">
  18855. @return font color index
  18856. </member>
  18857. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontHeight">
  18858. Gets the height of the font in 1/20th point Units
  18859. @return fontheight (in points/20); or -1 if not modified
  18860. </member>
  18861. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.FontWeight">
  18862. Get the font weight for this font (100-1000dec or 0x64-0x3e8). Default Is
  18863. 0x190 for normal and 0x2bc for bold
  18864. @return bw - a number between 100-1000 for the fonts "boldness"
  18865. </member>
  18866. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.GetRawRecord">
  18867. @return
  18868. @see org.apache.poi.hssf.record.cf.FontFormatting#GetRawRecord()
  18869. </member>
  18870. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.UnderlineType">
  18871. Get the type of Underlining for the font
  18872. @return font Underlining type
  18873. @see #U_NONE
  18874. @see #U_SINGLE
  18875. @see #U_DOUBLE
  18876. @see #U_SINGLE_ACCOUNTING
  18877. @see #U_DOUBLE_ACCOUNTING
  18878. </member>
  18879. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsBold">
  18880. Get whether the font weight Is Set to bold or not
  18881. @return bold - whether the font Is bold or not
  18882. </member>
  18883. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsEscapementTypeModified">
  18884. @return true if escapement type was modified from default
  18885. </member>
  18886. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontCancellationModified">
  18887. @return true if font cancellation was modified from default
  18888. </member>
  18889. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontOutlineModified">
  18890. @return true if font outline type was modified from default
  18891. </member>
  18892. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontShadowModified">
  18893. @return true if font shadow type was modified from default
  18894. </member>
  18895. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontStyleModified">
  18896. @return true if font style was modified from default
  18897. </member>
  18898. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsItalic">
  18899. @return true if font style was Set to <i>italic</i>
  18900. </member>
  18901. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsOutlineOn">
  18902. @return true if font outline Is on
  18903. </member>
  18904. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsShadowOn">
  18905. @return true if font shadow Is on
  18906. </member>
  18907. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsStrikeout">
  18908. @return true if font strikeout Is on
  18909. </member>
  18910. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsUnderlineTypeModified">
  18911. @return true if font Underline type was modified from default
  18912. </member>
  18913. <member name="P:NPOI.HSSF.UserModel.HSSFFontFormatting.IsFontWeightModified">
  18914. @return true if font weight was modified from default
  18915. </member>
  18916. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  18917. Set font style options.
  18918. @param italic - if true, Set posture style to italic, otherwise to normal
  18919. @param bold- if true, Set font weight to bold, otherwise to normal
  18920. </member>
  18921. <member name="M:NPOI.HSSF.UserModel.HSSFFontFormatting.ResetFontStyle">
  18922. Set font style options to default values (non-italic, non-bold)
  18923. </member>
  18924. <member name="T:NPOI.HSSF.UserModel.HSSFFooter">
  18925. <summary>
  18926. Class to Read and manipulate the footer.
  18927. The footer works by having a left, center, and right side. The total cannot
  18928. be more that 255 bytes long. One uses this class by Getting the HSSFFooter
  18929. from HSSFSheet and then Getting or Setting the left, center, and right side.
  18930. For special things (such as page numbers and date), one can use a the methods
  18931. that return the Chars used to represent these. One can also Change the
  18932. fonts by using similar methods.
  18933. @author Shawn Laubach (slaubach at apache dot org)
  18934. </summary>
  18935. </member>
  18936. <member name="M:NPOI.HSSF.UserModel.HSSFFooter.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  18937. <summary>
  18938. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  18939. </summary>
  18940. <param name="psb">Footer record to create the footer with</param>
  18941. </member>
  18942. <member name="P:NPOI.HSSF.UserModel.HSSFFooter.RawText">
  18943. <summary>
  18944. Gets the raw footer.
  18945. </summary>
  18946. <value>The raw footer.</value>
  18947. </member>
  18948. <member name="T:NPOI.HSSF.UserModel.HSSFFormulaEvaluator">
  18949. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  18950. </member>
  18951. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  18952. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  18953. for the (conservative) assumption that any cell may have its definition changed after
  18954. evaluation begins.
  18955. </member>
  18956. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.#ctor(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  18957. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  18958. </member>
  18959. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  18960. @param stabilityClassifier used to optimise caching performance. Pass <code>null</code>
  18961. for the (conservative) assumption that any cell may have its definition changed after
  18962. evaluation begins.
  18963. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  18964. </member>
  18965. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.SetupEnvironment(System.String[],NPOI.HSSF.UserModel.HSSFFormulaEvaluator[])">
  18966. Coordinates several formula evaluators together so that formulas that involve external
  18967. references can be evaluated.
  18968. @param workbookNames the simple file names used to identify the workbooks in formulas
  18969. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  18970. @param evaluators all evaluators for the full set of workbooks required by the formulas.
  18971. </member>
  18972. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  18973. If cell Contains a formula, the formula is Evaluated and returned,
  18974. else the CellValue simply copies the appropriate cell value from
  18975. the cell and also its cell type. This method should be preferred over
  18976. EvaluateInCell() when the call should not modify the contents of the
  18977. original cell.
  18978. @param cell
  18979. If cell contains a formula, the formula is evaluated and returned,
  18980. else the CellValue simply copies the appropriate cell value from
  18981. the cell and also its cell type. This method should be preferred over
  18982. evaluateInCell() when the call should not modify the contents of the
  18983. original cell.
  18984. @param cell may be <c>null</c> signifying that the cell is not present (or blank)
  18985. @return <c>null</c> if the supplied cell is <c>null</c> or blank
  18986. </member>
  18987. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.ClearAllCachedResultValues">
  18988. Should be called whenever there are major changes (e.g. moving sheets) to input cells
  18989. in the evaluated workbook. If performance is not critical, a single call to this method
  18990. may be used instead of many specific calls to the notify~ methods.
  18991. Failure to call this method after changing cell values will cause incorrect behaviour
  18992. of the evaluate~ methods of this class
  18993. </member>
  18994. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  18995. Should be called to tell the cell value cache that the specified (value or formula) cell
  18996. has changed.
  18997. Failure to call this method after changing cell values will cause incorrect behaviour
  18998. of the evaluate~ methods of this class
  18999. </member>
  19000. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  19001. Should be called to tell the cell value cache that the specified cell has just been
  19002. deleted.
  19003. Failure to call this method after changing cell values will cause incorrect behaviour
  19004. of the evaluate~ methods of this class
  19005. </member>
  19006. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  19007. Should be called to tell the cell value cache that the specified (value or formula) cell
  19008. has changed.
  19009. Failure to call this method after changing cell values will cause incorrect behaviour
  19010. of the evaluate~ methods of this class
  19011. </member>
  19012. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  19013. If cell Contains formula, it Evaluates the formula,
  19014. and saves the result of the formula. The cell
  19015. remains as a formula cell.
  19016. Else if cell does not contain formula, this method leaves
  19017. the cell UnChanged.
  19018. Note that the type of the formula result is returned,
  19019. so you know what kind of value is also stored with
  19020. the formula.
  19021. <pre>
  19022. int EvaluatedCellType = evaluator.EvaluateFormulaCell(cell);
  19023. </pre>
  19024. Be aware that your cell will hold both the formula,
  19025. and the result. If you want the cell Replaced with
  19026. the result of the formula, use {@link #EvaluateInCell(HSSFCell)}
  19027. @param cell The cell to Evaluate
  19028. @return The type of the formula result (the cell's type remains as CellType.Formula however)
  19029. </member>
  19030. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateFormulaCellValue(NPOI.SS.UserModel.ICell)">
  19031. Returns a CellValue wrapper around the supplied ValueEval instance.
  19032. @param cell
  19033. </member>
  19034. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  19035. If cell Contains formula, it Evaluates the formula, and
  19036. puts the formula result back into the cell, in place
  19037. of the old formula.
  19038. Else if cell does not contain formula, this method leaves
  19039. the cell UnChanged.
  19040. Note that the same instance of Cell is returned to
  19041. allow chained calls like:
  19042. <pre>
  19043. int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
  19044. </pre>
  19045. Be aware that your cell value will be Changed to hold the
  19046. result of the formula. If you simply want the formula
  19047. value computed for you, use {@link #EvaluateFormulaCell(HSSFCell)}
  19048. @param cell
  19049. </member>
  19050. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.HSSF.UserModel.HSSFWorkbook)">
  19051. Loops over all cells in all sheets of the supplied
  19052. workbook.
  19053. For cells that contain formulas, their formulas are
  19054. Evaluated, and the results are saved. These cells
  19055. remain as formula cells.
  19056. For cells that do not contain formulas, no Changes
  19057. are made.
  19058. This is a helpful wrapper around looping over all
  19059. cells, and calling EvaluateFormulaCell on each one.
  19060. </member>
  19061. <member name="M:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.EvaluateAllFormulaCells(NPOI.SS.UserModel.IWorkbook)">
  19062. Loops over all cells in all sheets of the supplied
  19063. workbook.
  19064. For cells that contain formulas, their formulas are
  19065. evaluated, and the results are saved. These cells
  19066. remain as formula cells.
  19067. For cells that do not contain formulas, no changes
  19068. are made.
  19069. This is a helpful wrapper around looping over all
  19070. cells, and calling evaluateFormulaCell on each one.
  19071. </member>
  19072. <member name="P:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.IgnoreMissingWorkbooks">
  19073. Whether to ignore missing references to external workbooks and
  19074. use cached formula results in the main workbook instead.
  19075. <p>
  19076. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  19077. With this method you can control how POI handles such missing references:
  19078. <ul>
  19079. <li>by default ignoreMissingWorkbooks=false and POI throws {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  19080. if an external reference cannot be resolved</li>
  19081. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  19082. that already exists in the main workbook</li>
  19083. </ul>
  19084. </p>
  19085. @param ignore whether to ignore missing references to external workbooks
  19086. </member>
  19087. <member name="P:NPOI.HSSF.UserModel.HSSFFormulaEvaluator.DebugEvaluationOutputForNextEval">
  19088. {@inheritDoc}
  19089. </member>
  19090. <member name="T:NPOI.HSSF.UserModel.HSSFHeader">
  19091. <summary>
  19092. Class to Read and manipulate the header.
  19093. The header works by having a left, center, and right side. The total cannot
  19094. be more that 255 bytes long. One uses this class by Getting the HSSFHeader
  19095. from HSSFSheet and then Getting or Setting the left, center, and right side.
  19096. For special things (such as page numbers and date), one can use a the methods
  19097. that return the Chars used to represent these. One can also Change the
  19098. fonts by using similar methods.
  19099. @author Shawn Laubach (slaubach at apache dot org)
  19100. </summary>
  19101. </member>
  19102. <member name="M:NPOI.HSSF.UserModel.HSSFHeader.#ctor(NPOI.HSSF.Record.Aggregates.PageSettingsBlock)">
  19103. <summary>
  19104. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFFooter"/> class.
  19105. </summary>
  19106. <param name="psb">Footer record to Create the footer with</param>
  19107. </member>
  19108. <member name="P:NPOI.HSSF.UserModel.HSSFHeader.RawText">
  19109. <summary>
  19110. Gets the raw footer.
  19111. </summary>
  19112. <value>The raw footer.</value>
  19113. </member>
  19114. <member name="T:NPOI.HSSF.UserModel.HSSFHyperlink">
  19115. <summary>
  19116. Represents an Excel hyperlink.
  19117. </summary>
  19118. <remarks>@author Yegor Kozlov (yegor at apache dot org)</remarks>
  19119. </member>
  19120. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.record">
  19121. Low-level record object that stores the actual hyperlink data
  19122. </member>
  19123. <member name="F:NPOI.HSSF.UserModel.HSSFHyperlink.link_type">
  19124. If we Create a new hypelrink remember its type
  19125. </member>
  19126. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.SS.UserModel.HyperlinkType)">
  19127. <summary>
  19128. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  19129. </summary>
  19130. <param name="type">The type of hyperlink to Create.</param>
  19131. </member>
  19132. <member name="M:NPOI.HSSF.UserModel.HSSFHyperlink.#ctor(NPOI.HSSF.Record.HyperlinkRecord)">
  19133. <summary>
  19134. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFHyperlink"/> class.
  19135. </summary>
  19136. <param name="record">The record.</param>
  19137. </member>
  19138. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstRow">
  19139. <summary>
  19140. Gets or sets the row of the first cell that Contains the hyperlink
  19141. </summary>
  19142. <value>the 0-based row of the cell that Contains the hyperlink.</value>
  19143. </member>
  19144. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastRow">
  19145. <summary>
  19146. Gets or sets the row of the last cell that Contains the hyperlink
  19147. </summary>
  19148. <value>the 0-based row of the last cell that Contains the hyperlink</value>
  19149. </member>
  19150. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.FirstColumn">
  19151. <summary>
  19152. Gets or sets the column of the first cell that Contains the hyperlink
  19153. </summary>
  19154. <value>the 0-based column of the first cell that Contains the hyperlink</value>
  19155. </member>
  19156. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.LastColumn">
  19157. <summary>
  19158. Gets or sets the column of the last cell that Contains the hyperlink
  19159. </summary>
  19160. <value>the 0-based column of the last cell that Contains the hyperlink</value>
  19161. </member>
  19162. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Address">
  19163. <summary>
  19164. Gets or sets Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  19165. </summary>
  19166. <value>the Address of this hyperlink</value>
  19167. </member>
  19168. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.TextMark">
  19169. <summary>
  19170. Gets or sets the text mark.
  19171. </summary>
  19172. <value>The text mark.</value>
  19173. </member>
  19174. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.ShortFilename">
  19175. <summary>
  19176. Gets or sets the short filename.
  19177. </summary>
  19178. <value>The short filename.</value>
  19179. </member>
  19180. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Label">
  19181. <summary>
  19182. Gets or sets the text label for this hyperlink
  19183. </summary>
  19184. <value>text to Display</value>
  19185. </member>
  19186. <member name="P:NPOI.HSSF.UserModel.HSSFHyperlink.Type">
  19187. <summary>
  19188. Gets the type of this hyperlink
  19189. </summary>
  19190. <value>the type of this hyperlink</value>
  19191. </member>
  19192. <member name="T:NPOI.HSSF.UserModel.HSSFName">
  19193. <summary>
  19194. High Level Represantion of Named Range
  19195. </summary>
  19196. <remarks>@author Libin Roman (Vista Portal LDT. Developer)</remarks>
  19197. </member>
  19198. <member name="M:NPOI.HSSF.UserModel.HSSFName.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Record.NameRecord,NPOI.HSSF.Record.NameCommentRecord)">
  19199. <summary>
  19200. Creates new HSSFName - called by HSSFWorkbook to Create a sheet from
  19201. scratch.
  19202. </summary>
  19203. <param name="book">lowlevel Workbook object associated with the sheet.</param>
  19204. <param name="name">the Name Record</param>
  19205. <param name="comment"></param>
  19206. </member>
  19207. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetName">
  19208. <summary>
  19209. Gets or sets the sheets name which this named range is referenced to
  19210. </summary>
  19211. <value>sheet name, which this named range refered to</value>
  19212. </member>
  19213. <member name="P:NPOI.HSSF.UserModel.HSSFName.NameName">
  19214. <summary>
  19215. Gets or sets the name of the named range
  19216. </summary>
  19217. <value>named range name</value>
  19218. </member>
  19219. <member name="P:NPOI.HSSF.UserModel.HSSFName.SheetIndex">
  19220. Returns the sheet index this name applies to.
  19221. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  19222. </member>
  19223. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetNameDefinition(NPOI.SS.Formula.PTG.Ptg[])">
  19224. <summary>
  19225. Sets the NameParsedFormula structure that specifies the formula for the defined name.
  19226. </summary>
  19227. <param name="ptgs">the sequence of {@link Ptg}s for the formula.</param>
  19228. </member>
  19229. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsDeleted">
  19230. <summary>
  19231. Tests if this name points to a cell that no longer exists
  19232. </summary>
  19233. <value>
  19234. <c>true</c> if the name refers to a deleted cell; otherwise, <c>false</c>.
  19235. </value>
  19236. </member>
  19237. <member name="P:NPOI.HSSF.UserModel.HSSFName.IsFunctionName">
  19238. <summary>
  19239. Gets a value indicating whether this instance is function name.
  19240. </summary>
  19241. <value>
  19242. <c>true</c> if this instance is function name; otherwise, <c>false</c>.
  19243. </value>
  19244. </member>
  19245. <member name="M:NPOI.HSSF.UserModel.HSSFName.SetFunction(System.Boolean)">
  19246. Indicates that the defined name refers to a user-defined function.
  19247. This attribute is used when there is an add-in or other code project associated with the file.
  19248. @param value <c>true</c> indicates the name refers to a function.
  19249. </member>
  19250. <member name="M:NPOI.HSSF.UserModel.HSSFName.ToString">
  19251. <summary>
  19252. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  19253. </summary>
  19254. <returns>
  19255. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  19256. </returns>
  19257. </member>
  19258. <member name="T:NPOI.HSSF.UserModel.HSSFObjectData">
  19259. Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...
  19260. @author Daniel Noll
  19261. </member>
  19262. <member name="F:NPOI.HSSF.UserModel.HSSFObjectData._root">
  19263. Reference to the filesystem root, required for retrieving the object data.
  19264. </member>
  19265. <member name="P:NPOI.HSSF.UserModel.HSSFObjectData.OLE2ClassName">
  19266. Returns the OLE2 Class Name of the object
  19267. </member>
  19268. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetDirectory">
  19269. Gets the object data. Only call for ones that have
  19270. data though. See {@link #hasDirectoryEntry()}
  19271. @return the object data as an OLE2 directory.
  19272. @ if there was an error Reading the data.
  19273. </member>
  19274. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.GetObjectData">
  19275. Returns the data portion, for an ObjectData
  19276. that doesn't have an associated POIFS Directory
  19277. Entry
  19278. </member>
  19279. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.HasDirectoryEntry">
  19280. Does this ObjectData have an associated POIFS
  19281. Directory Entry?
  19282. (Not all do, those that don't have a data portion)
  19283. </member>
  19284. <member name="M:NPOI.HSSF.UserModel.HSSFObjectData.FindObjectRecord">
  19285. Finds the EmbeddedObjectRefSubRecord, or throws an
  19286. Exception if there wasn't one
  19287. </member>
  19288. <member name="T:NPOI.HSSF.UserModel.HSSFOptimiser">
  19289. <summary>
  19290. Excel can Get cranky if you give it files containing too
  19291. many (especially duplicate) objects, and this class can
  19292. help to avoid those.
  19293. In general, it's much better to make sure you don't
  19294. duplicate the objects in your code, as this is likely
  19295. to be much faster than creating lots and lots of
  19296. excel objects+records, only to optimise them down to
  19297. many fewer at a later stage.
  19298. However, sometimes this is too hard / tricky to do, which
  19299. is where the use of this class comes in.
  19300. </summary>
  19301. </member>
  19302. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseFonts(NPOI.HSSF.UserModel.HSSFWorkbook)">
  19303. <summary>
  19304. Goes through the Workbook, optimising the fonts by
  19305. removing duplicate ones.
  19306. For now, only works on fonts used in HSSFCellStyle
  19307. and HSSFRichTextString. Any other font uses
  19308. (eg charts, pictures) may well end up broken!
  19309. This can be a slow operation, especially if you have
  19310. lots of cells, cell styles or rich text strings
  19311. </summary>
  19312. <param name="workbook">The workbook in which to optimise the fonts</param>
  19313. </member>
  19314. <member name="M:NPOI.HSSF.UserModel.HSSFOptimiser.OptimiseCellStyles(NPOI.HSSF.UserModel.HSSFWorkbook)">
  19315. <summary>
  19316. Goes through the Wokrbook, optimising the cell styles
  19317. by removing duplicate ones and ones that aren't used.
  19318. For best results, optimise the fonts via a call to
  19319. OptimiseFonts(HSSFWorkbook) first
  19320. </summary>
  19321. <param name="workbook">The workbook in which to optimise the cell styles</param>
  19322. </member>
  19323. <member name="T:NPOI.HSSF.UserModel.HSSFPalette">
  19324. <summary>
  19325. Represents a workbook color palette.
  19326. Internally, the XLS format refers to colors using an offset into the palette
  19327. record. Thus, the first color in the palette has the index 0x8, the second
  19328. has the index 0x9, etc. through 0x40
  19329. @author Brian Sanders (bsanders at risklabs dot com)
  19330. </summary>
  19331. </member>
  19332. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.GetColor(System.Int16)">
  19333. <summary>
  19334. Retrieves the color at a given index
  19335. </summary>
  19336. <param name="index">the palette index, between 0x8 to 0x40 inclusive.</param>
  19337. <returns>the color, or null if the index Is not populated</returns>
  19338. </member>
  19339. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindColor(System.Byte,System.Byte,System.Byte)">
  19340. <summary>
  19341. Finds the first occurance of a given color
  19342. </summary>
  19343. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  19344. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  19345. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  19346. <returns>the color, or null if the color does not exist in this palette</returns>
  19347. </member>
  19348. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.FindSimilarColor(System.Byte,System.Byte,System.Byte)">
  19349. <summary>
  19350. Finds the closest matching color in the custom palette. The
  19351. method for Finding the distance between the colors Is fairly
  19352. primative.
  19353. </summary>
  19354. <param name="red">The red component of the color to match.</param>
  19355. <param name="green">The green component of the color to match.</param>
  19356. <param name="blue">The blue component of the color to match.</param>
  19357. <returns>The closest color or null if there are no custom
  19358. colors currently defined.</returns>
  19359. </member>
  19360. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.SetColorAtIndex(System.Int16,System.Byte,System.Byte,System.Byte)">
  19361. <summary>
  19362. Sets the color at the given offset
  19363. </summary>
  19364. <param name="index">the palette index, between 0x8 to 0x40 inclusive</param>
  19365. <param name="red">the RGB red component, between 0 and 255 inclusive</param>
  19366. <param name="green">the RGB green component, between 0 and 255 inclusive</param>
  19367. <param name="blue">the RGB blue component, between 0 and 255 inclusive</param>
  19368. </member>
  19369. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.AddColor(System.Byte,System.Byte,System.Byte)">
  19370. <summary>
  19371. Adds a new color into an empty color slot.
  19372. </summary>
  19373. <param name="red">The red component</param>
  19374. <param name="green">The green component</param>
  19375. <param name="blue">The blue component</param>
  19376. <returns>The new custom color.</returns>
  19377. </member>
  19378. <member name="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor">
  19379. <summary>
  19380. user custom color
  19381. </summary>
  19382. </member>
  19383. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte[])">
  19384. <summary>
  19385. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  19386. </summary>
  19387. <param name="byteOffset">The byte offset.</param>
  19388. <param name="colors">The colors.</param>
  19389. </member>
  19390. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.#ctor(System.Int16,System.Byte,System.Byte,System.Byte)">
  19391. <summary>
  19392. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPalette.CustomColor"/> class.
  19393. </summary>
  19394. <param name="byteOffset">The byte offset.</param>
  19395. <param name="red">The red.</param>
  19396. <param name="green">The green.</param>
  19397. <param name="blue">The blue.</param>
  19398. </member>
  19399. <member name="P:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.Indexed">
  19400. <summary>
  19401. Gets index to the standard palette
  19402. </summary>
  19403. <value></value>
  19404. </member>
  19405. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetTriplet">
  19406. <summary>
  19407. Gets triplet representation like that in Excel
  19408. </summary>
  19409. <value></value>
  19410. </member>
  19411. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetHexString">
  19412. <summary>
  19413. Gets a hex string exactly like a gnumeric triplet
  19414. </summary>
  19415. <value></value>
  19416. </member>
  19417. <member name="M:NPOI.HSSF.UserModel.HSSFPalette.CustomColor.GetGnumericPart(System.Byte)">
  19418. <summary>
  19419. Gets the gnumeric part.
  19420. </summary>
  19421. <param name="color">The color.</param>
  19422. <returns></returns>
  19423. </member>
  19424. <member name="T:NPOI.HSSF.UserModel.HSSFPatriarch">
  19425. <summary>
  19426. The patriarch is the toplevel container for shapes in a sheet. It does
  19427. little other than act as a container for other shapes and Groups.
  19428. @author Glen Stampoultzis (glens at apache.org)
  19429. </summary>
  19430. </member>
  19431. <member name="F:NPOI.HSSF.UserModel.HSSFPatriarch._boundAggregate">
  19432. The EscherAggregate we have been bound to.
  19433. (This will handle writing us out into records,
  19434. and building up our shapes from the records)
  19435. </member>
  19436. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.#ctor(NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.EscherAggregate)">
  19437. <summary>
  19438. Creates the patriarch.
  19439. </summary>
  19440. <param name="sheet">the sheet this patriarch is stored in.</param>
  19441. <param name="boundAggregate">The bound aggregate.</param>
  19442. </member>
  19443. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.PreSerialize">
  19444. check if any shapes contain wrong data
  19445. At now(13.08.2010) check if patriarch contains 2 or more comments with same coordinates
  19446. </member>
  19447. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  19448. @param shape to be removed
  19449. @return true of shape is removed
  19450. </member>
  19451. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateGroup(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  19452. <summary>
  19453. Creates a new Group record stored Under this patriarch.
  19454. </summary>
  19455. <param name="anchor">the client anchor describes how this Group is attached
  19456. to the sheet.</param>
  19457. <returns>the newly created Group.</returns>
  19458. </member>
  19459. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateSimpleShape(NPOI.HSSF.UserModel.HSSFClientAnchor)">
  19460. <summary>
  19461. Creates a simple shape. This includes such shapes as lines, rectangles,
  19462. and ovals.
  19463. Note: Microsoft Excel seems to sometimes disallow
  19464. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  19465. reverse them and draw shapes vertically or horizontally flipped!
  19466. </summary>
  19467. <param name="anchor">the client anchor describes how this Group is attached
  19468. to the sheet.</param>
  19469. <returns>the newly created shape.</returns>
  19470. </member>
  19471. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32)">
  19472. <summary>
  19473. Creates a picture.
  19474. </summary>
  19475. <param name="anchor">the client anchor describes how this Group is attached
  19476. to the sheet.</param>
  19477. <param name="pictureIndex">Index of the picture.</param>
  19478. <returns>the newly created shape.</returns>
  19479. </member>
  19480. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  19481. <summary>
  19482. CreatePicture
  19483. </summary>
  19484. <param name="anchor">the client anchor describes how this picture is attached to the sheet.</param>
  19485. <param name="pictureIndex">the index of the picture in the workbook collection of pictures.</param>
  19486. <returns>return newly created shape</returns>
  19487. </member>
  19488. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateObjectData(NPOI.HSSF.UserModel.HSSFClientAnchor,System.Int32,System.Int32)">
  19489. Adds a new OLE Package Shape
  19490. @param anchor the client anchor describes how this picture is
  19491. attached to the sheet.
  19492. @param storageId the storageId returned by {@Link HSSFWorkbook.AddOlePackage}
  19493. @param pictureIndex the index of the picture (used as preview image) in the
  19494. workbook collection of pictures.
  19495. @return newly Created shape
  19496. </member>
  19497. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreatePolygon(NPOI.SS.UserModel.IClientAnchor)">
  19498. <summary>
  19499. Creates a polygon
  19500. </summary>
  19501. <param name="anchor">the client anchor describes how this Group is attached
  19502. to the sheet.</param>
  19503. <returns>the newly Created shape.</returns>
  19504. </member>
  19505. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateTextbox(NPOI.SS.UserModel.IClientAnchor)">
  19506. <summary>
  19507. Constructs a textbox Under the patriarch.
  19508. </summary>
  19509. <param name="anchor">the client anchor describes how this Group is attached
  19510. to the sheet.</param>
  19511. <returns>the newly Created textbox.</returns>
  19512. </member>
  19513. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComment(NPOI.HSSF.UserModel.HSSFAnchor)">
  19514. Constructs a cell comment.
  19515. @param anchor the client anchor describes how this comment is attached
  19516. to the sheet.
  19517. @return the newly created comment.
  19518. </member>
  19519. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateComboBox(NPOI.HSSF.UserModel.HSSFAnchor)">
  19520. YK: used to create autofilters
  19521. @see org.apache.poi.hssf.usermodel.HSSFSheet#setAutoFilter(int, int, int, int)
  19522. </member>
  19523. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  19524. <summary>
  19525. Constructs a cell comment.
  19526. </summary>
  19527. <param name="anchor">the client anchor describes how this comment is attached
  19528. to the sheet.</param>
  19529. <returns>the newly created comment.</returns>
  19530. </member>
  19531. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Children">
  19532. <summary>
  19533. Returns a list of all shapes contained by the patriarch.
  19534. </summary>
  19535. <value>The children.</value>
  19536. </member>
  19537. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  19538. add a shape to this drawing
  19539. </member>
  19540. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.CountOfAllChildren">
  19541. <summary>
  19542. Total count of all children and their children's children.
  19543. </summary>
  19544. <value>The count of all children.</value>
  19545. </member>
  19546. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  19547. <summary>
  19548. Sets the coordinate space of this Group. All children are contrained
  19549. to these coordinates.
  19550. </summary>
  19551. <param name="x1">The x1.</param>
  19552. <param name="y1">The y1.</param>
  19553. <param name="x2">The x2.</param>
  19554. <param name="y2">The y2.</param>
  19555. </member>
  19556. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.ContainsChart">
  19557. <summary>
  19558. Does this HSSFPatriarch contain a chart?
  19559. (Technically a reference to a chart, since they
  19560. Get stored in a different block of records)
  19561. FIXME - detect chart in all cases (only seems
  19562. to work on some charts so far)
  19563. </summary>
  19564. <returns>
  19565. <c>true</c> if this instance contains chart; otherwise, <c>false</c>.
  19566. </returns>
  19567. </member>
  19568. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X1">
  19569. <summary>
  19570. The top left x coordinate of this Group.
  19571. </summary>
  19572. <value>The x1.</value>
  19573. </member>
  19574. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y1">
  19575. <summary>
  19576. The top left y coordinate of this Group.
  19577. </summary>
  19578. <value>The y1.</value>
  19579. </member>
  19580. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.X2">
  19581. <summary>
  19582. The bottom right x coordinate of this Group.
  19583. </summary>
  19584. <value>The x2.</value>
  19585. </member>
  19586. <member name="P:NPOI.HSSF.UserModel.HSSFPatriarch.Y2">
  19587. <summary>
  19588. The bottom right y coordinate of this Group.
  19589. </summary>
  19590. <value>The y2.</value>
  19591. </member>
  19592. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.GetBoundAggregate">
  19593. <summary>
  19594. Returns the aggregate escher record we're bound to
  19595. </summary>
  19596. <returns></returns>
  19597. </member>
  19598. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  19599. Creates a new client anchor and sets the top-left and bottom-right
  19600. coordinates of the anchor.
  19601. @param dx1 the x coordinate in EMU within the first cell.
  19602. @param dy1 the y coordinate in EMU within the first cell.
  19603. @param dx2 the x coordinate in EMU within the second cell.
  19604. @param dy2 the y coordinate in EMU within the second cell.
  19605. @param col1 the column (0 based) of the first cell.
  19606. @param row1 the row (0 based) of the first cell.
  19607. @param col2 the column (0 based) of the second cell.
  19608. @param row2 the row (0 based) of the second cell.
  19609. @return the newly created client anchor
  19610. </member>
  19611. <member name="M:NPOI.HSSF.UserModel.HSSFPatriarch.BuildShapeTree">
  19612. create shape tree from existing escher records tree
  19613. </member>
  19614. <member name="T:NPOI.HSSF.UserModel.HSSFPatternFormatting">
  19615. <summary>
  19616. High level representation for Conditional Formatting Settings
  19617. @author Dmitriy Kumshayev
  19618. </summary>
  19619. </member>
  19620. <member name="M:NPOI.HSSF.UserModel.HSSFPatternFormatting.#ctor(NPOI.HSSF.Record.CFRuleRecord)">
  19621. <summary>
  19622. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPatternFormatting"/> class.
  19623. </summary>
  19624. <param name="cfRuleRecord">The cf rule record.</param>
  19625. </member>
  19626. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.PatternFormattingBlock">
  19627. <summary>
  19628. Gets the pattern formatting block.
  19629. </summary>
  19630. <value>The pattern formatting block.</value>
  19631. </member>
  19632. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillBackgroundColor">
  19633. <summary>
  19634. Gets or sets the color of the fill background.
  19635. </summary>
  19636. <value>The color of the fill background.</value>
  19637. </member>
  19638. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillForegroundColor">
  19639. <summary>
  19640. Gets or sets the color of the fill foreground.
  19641. </summary>
  19642. <value>The color of the fill foreground.</value>
  19643. </member>
  19644. <member name="P:NPOI.HSSF.UserModel.HSSFPatternFormatting.FillPattern">
  19645. <summary>
  19646. Gets or sets the fill pattern.
  19647. </summary>
  19648. <value>The fill pattern.</value>
  19649. </member>
  19650. <member name="T:NPOI.HSSF.UserModel.HSSFPicture">
  19651. <summary>
  19652. Represents a escher picture. Eg. A GIF, JPEG etc...
  19653. @author Glen Stampoultzis
  19654. @author Yegor Kozlov (yegor at apache.org)
  19655. </summary>
  19656. </member>
  19657. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  19658. <summary>
  19659. Constructs a picture object.
  19660. </summary>
  19661. <param name="parent">The parent.</param>
  19662. <param name="anchor">The anchor.</param>
  19663. </member>
  19664. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize">
  19665. <summary>
  19666. Reset the image to the dimension of the embedded image
  19667. </summary>
  19668. <remarks>
  19669. Please note, that this method works correctly only for workbooks
  19670. with default font size (Arial 10pt for .xls).
  19671. If the default font is changed the resized image can be streched vertically or horizontally.
  19672. </remarks>
  19673. </member>
  19674. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double)">
  19675. <summary>
  19676. Resize the image proportionally.
  19677. </summary>
  19678. <param name="scale">scale</param>
  19679. <seealso cref="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)"/>
  19680. </member>
  19681. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.Resize(System.Double,System.Double)">
  19682. Resize the image
  19683. <p>
  19684. Please note, that this method works correctly only for workbooks
  19685. with default font size (Arial 10pt for .xls).
  19686. If the default font is changed the resized image can be streched vertically or horizontally.
  19687. </p>
  19688. <p>
  19689. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  19690. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  19691. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  19692. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  19693. </p>
  19694. @param scaleX the amount by which the image width is multiplied relative to the original width.
  19695. @param scaleY the amount by which the image height is multiplied relative to the original height.
  19696. </member>
  19697. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureIndex">
  19698. <summary>
  19699. Gets or sets the index of the picture.
  19700. </summary>
  19701. <value>The index of the picture.</value>
  19702. </member>
  19703. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double)">
  19704. Calculate the preferred size for this picture.
  19705. @param scale the amount by which image dimensions are multiplied relative to the original size.
  19706. @return HSSFClientAnchor with the preferred size for this image
  19707. @since POI 3.0.2
  19708. </member>
  19709. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize(System.Double,System.Double)">
  19710. <summary>
  19711. Calculate the preferred size for this picture.
  19712. </summary>
  19713. <param name="scaleX">the amount by which image width is multiplied relative to the original width.</param>
  19714. <param name="scaleY">the amount by which image height is multiplied relative to the original height.</param>
  19715. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  19716. </member>
  19717. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetPreferredSize">
  19718. <summary>
  19719. Calculate the preferred size for this picture.
  19720. </summary>
  19721. <returns>HSSFClientAnchor with the preferred size for this image</returns>
  19722. </member>
  19723. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetResolution(System.Drawing.Image)">
  19724. <summary>
  19725. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  19726. Return the the "effective" dpi calculated as
  19727. <c>25.4/HorizontalPixelSize</c>
  19728. and
  19729. <c>25.4/VerticalPixelSize</c>
  19730. . Where 25.4 is the number of mm in inch.
  19731. </summary>
  19732. <param name="r">The image.</param>
  19733. <returns>the resolution</returns>
  19734. </member>
  19735. <member name="M:NPOI.HSSF.UserModel.HSSFPicture.GetImageDimension">
  19736. <summary>
  19737. Return the dimension of the embedded image in pixel
  19738. </summary>
  19739. <returns>image dimension</returns>
  19740. </member>
  19741. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.PictureData">
  19742. Return picture data for this shape
  19743. @return picture data for this shape
  19744. </member>
  19745. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.FileName">
  19746. The color applied to the lines of this shape.
  19747. </member>
  19748. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.ClientAnchor">
  19749. @return the anchor that is used by this picture.
  19750. </member>
  19751. <member name="P:NPOI.HSSF.UserModel.HSSFPicture.Sheet">
  19752. @return the sheet which contains the picture shape
  19753. </member>
  19754. <member name="T:NPOI.HSSF.UserModel.HSSFPictureData">
  19755. <summary>
  19756. Represents binary data stored in the file. Eg. A GIF, JPEG etc...
  19757. @author Daniel Noll
  19758. </summary>
  19759. </member>
  19760. <member name="F:NPOI.HSSF.UserModel.HSSFPictureData.blip">
  19761. Underlying escher blip record containing the bitmap data.
  19762. </member>
  19763. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.#ctor(NPOI.DDF.EscherBlipRecord)">
  19764. <summary>
  19765. Constructs a picture object.
  19766. </summary>
  19767. <param name="blip">the underlying blip record containing the bitmap data.</param>
  19768. </member>
  19769. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Data">
  19770. <summary>
  19771. Gets the picture data.
  19772. </summary>
  19773. <value>the picture data.</value>
  19774. </member>
  19775. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.Format">
  19776. <summary>
  19777. gets format of the picture.
  19778. </summary>
  19779. <value>The format.</value>
  19780. </member>
  19781. <member name="M:NPOI.HSSF.UserModel.HSSFPictureData.SuggestFileExtension">
  19782. <summary>
  19783. Suggests a file extension for this image.
  19784. </summary>
  19785. <returns>the file extension.</returns>
  19786. </member>
  19787. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.MimeType">
  19788. Returns the mime type for the image
  19789. </member>
  19790. <member name="P:NPOI.HSSF.UserModel.HSSFPictureData.PictureType">
  19791. @return the POI internal image type, -1 if not unknown image type
  19792. @see Workbook#PICTURE_TYPE_DIB
  19793. @see Workbook#PICTURE_TYPE_EMF
  19794. @see Workbook#PICTURE_TYPE_JPEG
  19795. @see Workbook#PICTURE_TYPE_PICT
  19796. @see Workbook#PICTURE_TYPE_PNG
  19797. @see Workbook#PICTURE_TYPE_WMF
  19798. </member>
  19799. <member name="T:NPOI.HSSF.UserModel.HSSFPolygon">
  19800. <summary>
  19801. @author Glen Stampoultzis (glens at baselinksoftware.com)
  19802. </summary>
  19803. </member>
  19804. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateSpContainer">
  19805. Generates the shape records for this shape.
  19806. </member>
  19807. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.CreateObjRecord">
  19808. Creates the low level OBJ record for this shape.
  19809. </member>
  19810. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.XPoints">
  19811. @return array of x coordinates
  19812. </member>
  19813. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.YPoints">
  19814. @return array of y coordinates
  19815. </member>
  19816. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPoints(System.Int32[],System.Int32[])">
  19817. @param xPoints - array of x coordinates
  19818. @param yPoints - array of y coordinates
  19819. </member>
  19820. <member name="M:NPOI.HSSF.UserModel.HSSFPolygon.SetPolygonDrawArea(System.Int32,System.Int32)">
  19821. Defines the width and height of the points in the polygon
  19822. @param width
  19823. @param height
  19824. </member>
  19825. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaWidth">
  19826. @return shape width
  19827. </member>
  19828. <member name="P:NPOI.HSSF.UserModel.HSSFPolygon.DrawAreaHeight">
  19829. @return shape height
  19830. </member>
  19831. <member name="T:NPOI.HSSF.UserModel.HSSFPrintSetup">
  19832. <summary>
  19833. Used to modify the print Setup.
  19834. @author Shawn Laubach (slaubach at apache dot org)
  19835. </summary>
  19836. </member>
  19837. <member name="M:NPOI.HSSF.UserModel.HSSFPrintSetup.#ctor(NPOI.HSSF.Record.PrintSetupRecord)">
  19838. <summary>
  19839. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFPrintSetup"/> class.
  19840. </summary>
  19841. <param name="printSetupRecord">Takes the low level print Setup record.</param>
  19842. </member>
  19843. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PaperSize">
  19844. <summary>
  19845. Gets or sets the size of the paper.
  19846. </summary>
  19847. <value>The size of the paper.</value>
  19848. </member>
  19849. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Scale">
  19850. <summary>
  19851. Gets or sets the scale.
  19852. </summary>
  19853. <value>The scale.</value>
  19854. </member>
  19855. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.PageStart">
  19856. <summary>
  19857. Gets or sets the page start.
  19858. </summary>
  19859. <value>The page start.</value>
  19860. </member>
  19861. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitWidth">
  19862. <summary>
  19863. Gets or sets the number of pages wide to fit sheet in.
  19864. </summary>
  19865. <value>the number of pages wide to fit sheet in</value>
  19866. </member>
  19867. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FitHeight">
  19868. <summary>
  19869. Gets or sets number of pages high to fit the sheet in
  19870. </summary>
  19871. <value>number of pages high to fit the sheet in.</value>
  19872. </member>
  19873. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Options">
  19874. <summary>
  19875. Gets or sets the bit flags for the options.
  19876. </summary>
  19877. <value>the bit flags for the options.</value>
  19878. </member>
  19879. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.LeftToRight">
  19880. <summary>
  19881. Gets or sets the left to right print order.
  19882. </summary>
  19883. <value>the left to right print order.</value>
  19884. </member>
  19885. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Landscape">
  19886. <summary>
  19887. Gets or sets the landscape mode.
  19888. </summary>
  19889. <value>the landscape mode.</value>
  19890. </member>
  19891. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.ValidSettings">
  19892. <summary>
  19893. Gets or sets the valid Settings.
  19894. </summary>
  19895. <value>the valid Settings.</value>
  19896. </member>
  19897. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoColor">
  19898. <summary>
  19899. Gets or sets the black and white Setting.
  19900. </summary>
  19901. <value>black and white Setting</value>
  19902. </member>
  19903. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Draft">
  19904. <summary>
  19905. Gets or sets the draft mode.
  19906. </summary>
  19907. <value>the draft mode.</value>
  19908. </member>
  19909. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Notes">
  19910. <summary>
  19911. Gets or sets the print notes.
  19912. </summary>
  19913. <value>the print notes.</value>
  19914. </member>
  19915. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.NoOrientation">
  19916. <summary>
  19917. Gets or sets a value indicating whether [no orientation].
  19918. </summary>
  19919. <value><c>true</c> if [no orientation]; otherwise, <c>false</c>.</value>
  19920. </member>
  19921. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.UsePage">
  19922. <summary>
  19923. Gets or sets the use page numbers.
  19924. </summary>
  19925. <value>use page numbers. </value>
  19926. </member>
  19927. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HResolution">
  19928. <summary>
  19929. Gets or sets the horizontal resolution.
  19930. </summary>
  19931. <value>the horizontal resolution.</value>
  19932. </member>
  19933. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.VResolution">
  19934. <summary>
  19935. Gets or sets the vertical resolution.
  19936. </summary>
  19937. <value>the vertical resolution.</value>
  19938. </member>
  19939. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.HeaderMargin">
  19940. <summary>
  19941. Gets or sets the header margin.
  19942. </summary>
  19943. <value>The header margin.</value>
  19944. </member>
  19945. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.FooterMargin">
  19946. <summary>
  19947. Gets or sets the footer margin.
  19948. </summary>
  19949. <value>The footer margin.</value>
  19950. </member>
  19951. <member name="P:NPOI.HSSF.UserModel.HSSFPrintSetup.Copies">
  19952. <summary>
  19953. Gets or sets the number of copies.
  19954. </summary>
  19955. <value>the number of copies.</value>
  19956. </member>
  19957. <member name="T:NPOI.HSSF.UserModel.HSSFRichTextString">
  19958. <summary>
  19959. Rich text Unicode string. These strings can have fonts applied to
  19960. arbitary parts of the string.
  19961. @author Glen Stampoultzis (glens at apache.org)
  19962. @author Jason Height (jheight at apache.org)
  19963. </summary>
  19964. </member>
  19965. <member name="F:NPOI.HSSF.UserModel.HSSFRichTextString.NO_FONT">
  19966. Place holder for indicating that NO_FONT has been applied here
  19967. </member>
  19968. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor">
  19969. <summary>
  19970. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  19971. </summary>
  19972. </member>
  19973. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(System.String)">
  19974. <summary>
  19975. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  19976. </summary>
  19977. <param name="str">The string.</param>
  19978. </member>
  19979. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.#ctor(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  19980. <summary>
  19981. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFRichTextString"/> class.
  19982. </summary>
  19983. <param name="book">The workbook.</param>
  19984. <param name="record">The record.</param>
  19985. </member>
  19986. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.SetWorkbookReferences(NPOI.HSSF.Model.InternalWorkbook,NPOI.HSSF.Record.LabelSSTRecord)">
  19987. <summary>
  19988. This must be called to Setup the internal work book references whenever
  19989. a RichTextString Is Added to a cell
  19990. </summary>
  19991. <param name="book">The workbook.</param>
  19992. <param name="record">The record.</param>
  19993. </member>
  19994. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CloneStringIfRequired">
  19995. <summary>
  19996. Called whenever the Unicode string Is modified. When it Is modified
  19997. we need to Create a new SST index, so that other LabelSSTRecords will not
  19998. be affected by Changes tat we make to this string.
  19999. </summary>
  20000. <returns></returns>
  20001. </member>
  20002. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.AddToSSTIfRequired">
  20003. <summary>
  20004. Adds to SST if required.
  20005. </summary>
  20006. </member>
  20007. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  20008. <summary>
  20009. Applies a font to the specified Chars of a string.
  20010. </summary>
  20011. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  20012. <param name="endIndex">The end index to apply the font to (exclusive).</param>
  20013. <param name="fontIndex">The font to use.</param>
  20014. </member>
  20015. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  20016. <summary>
  20017. Applies a font to the specified Chars of a string.
  20018. </summary>
  20019. <param name="startIndex">The start index to apply the font to (inclusive).</param>
  20020. <param name="endIndex"> The end index to apply to font to (exclusive).</param>
  20021. <param name="font">The index of the font to use.</param>
  20022. </member>
  20023. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  20024. <summary>
  20025. Sets the font of the entire string.
  20026. </summary>
  20027. <param name="font">The font to use.</param>
  20028. </member>
  20029. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ClearFormatting">
  20030. <summary>
  20031. Removes any formatting that may have been applied to the string.
  20032. </summary>
  20033. </member>
  20034. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.String">
  20035. <summary>
  20036. Returns the plain string representation.
  20037. </summary>
  20038. <value>The string.</value>
  20039. </member>
  20040. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.RawUnicodeString">
  20041. <summary>
  20042. Returns the raw, probably shared Unicode String.
  20043. Used when tweaking the styles, eg updating font
  20044. positions.
  20045. Changes to this string may well effect
  20046. other RichTextStrings too!
  20047. </summary>
  20048. <value>The raw unicode string.</value>
  20049. </member>
  20050. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.UnicodeString">
  20051. <summary>
  20052. Gets or sets the unicode string.
  20053. </summary>
  20054. <value>The unicode string.</value>
  20055. </member>
  20056. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.Length">
  20057. <summary>
  20058. Gets the number of Chars in the font..
  20059. </summary>
  20060. <value>The length.</value>
  20061. </member>
  20062. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontAtIndex(System.Int32)">
  20063. <summary>
  20064. Returns the font in use at a particular index.
  20065. </summary>
  20066. <param name="index">The index.</param>
  20067. <returns>The font that's currently being applied at that
  20068. index or null if no font Is being applied or the
  20069. index Is out of range.</returns>
  20070. </member>
  20071. <member name="P:NPOI.HSSF.UserModel.HSSFRichTextString.NumFormattingRuns">
  20072. <summary>
  20073. Gets the number of formatting runs used. There will always be at
  20074. least one of font NO_FONT.
  20075. </summary>
  20076. <value>The num formatting runs.</value>
  20077. </member>
  20078. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetIndexOfFormattingRun(System.Int32)">
  20079. <summary>
  20080. The index within the string to which the specified formatting run applies.
  20081. </summary>
  20082. <param name="index">the index of the formatting run</param>
  20083. <returns>the index within the string.</returns>
  20084. </member>
  20085. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.GetFontOfFormattingRun(System.Int32)">
  20086. <summary>
  20087. Gets the font used in a particular formatting run.
  20088. </summary>
  20089. <param name="index">the index of the formatting run.</param>
  20090. <returns>the font number used.</returns>
  20091. </member>
  20092. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.CompareTo(NPOI.HSSF.UserModel.HSSFRichTextString)">
  20093. <summary>
  20094. Compares one rich text string to another.
  20095. </summary>
  20096. <param name="other">The other rich text string.</param>
  20097. <returns></returns>
  20098. </member>
  20099. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.Equals(System.Object)">
  20100. <summary>
  20101. Equalses the specified o.
  20102. </summary>
  20103. <param name="o">The o.</param>
  20104. <returns></returns>
  20105. </member>
  20106. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ToString">
  20107. <summary>
  20108. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  20109. </summary>
  20110. <returns>
  20111. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  20112. </returns>
  20113. </member>
  20114. <member name="M:NPOI.HSSF.UserModel.HSSFRichTextString.ApplyFont(System.Int16)">
  20115. <summary>
  20116. Applies the specified font to the entire string.
  20117. </summary>
  20118. <param name="fontIndex">Index of the font to apply.</param>
  20119. </member>
  20120. <member name="T:NPOI.HSSF.UserModel.HSSFRow">
  20121. <summary>
  20122. High level representation of a row of a spReadsheet.
  20123. Only rows that have cells should be Added to a Sheet.
  20124. @author Andrew C. Oliver (acoliver at apache dot org)
  20125. @author Glen Stampoultzis (glens at apache.org)
  20126. </summary>
  20127. </member>
  20128. <member name="F:NPOI.HSSF.UserModel.HSSFRow.INITIAL_CAPACITY">
  20129. <summary>
  20130. used for collections
  20131. </summary>
  20132. </member>
  20133. <member name="F:NPOI.HSSF.UserModel.HSSFRow.row">
  20134. reference to low level representation
  20135. </member>
  20136. <member name="F:NPOI.HSSF.UserModel.HSSFRow.book">
  20137. reference to containing low level Workbook
  20138. </member>
  20139. <member name="F:NPOI.HSSF.UserModel.HSSFRow.sheet">
  20140. reference to containing Sheet
  20141. </member>
  20142. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,System.Int32)">
  20143. <summary>
  20144. Creates new HSSFRow from scratch. Only HSSFSheet should do this.
  20145. </summary>
  20146. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  20147. <param name="sheet">low-level Sheet object that Contains this Row</param>
  20148. <param name="rowNum">the row number of this row (0 based)</param>
  20149. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  20150. </member>
  20151. <member name="M:NPOI.HSSF.UserModel.HSSFRow.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.Record.RowRecord)">
  20152. <summary>
  20153. Creates an HSSFRow from a low level RowRecord object. Only HSSFSheet should do
  20154. this. HSSFSheet uses this when an existing file is Read in.
  20155. </summary>
  20156. <param name="book">low-level Workbook object containing the sheet that Contains this row</param>
  20157. <param name="sheet"> low-level Sheet object that Contains this Row</param>
  20158. <param name="record">the low level api object this row should represent</param>
  20159. <see cref="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)"/>
  20160. </member>
  20161. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32)">
  20162. <summary>
  20163. Use this to create new cells within the row and return it.
  20164. 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"/>).
  20165. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  20166. </summary>
  20167. <param name="column">the column number this cell represents</param>
  20168. <returns>a high level representation of the created cell.</returns>
  20169. </member>
  20170. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  20171. <summary>
  20172. Use this to create new cells within the row and return it.
  20173. The cell that is returned is a CELL_TYPE_BLANK. The type can be changed
  20174. either through calling setCellValue or setCellType.
  20175. </summary>
  20176. <param name="columnIndex">the column number this cell represents</param>
  20177. <param name="type">a high level representation of the created cell.</param>
  20178. <returns></returns>
  20179. </member>
  20180. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  20181. <summary>
  20182. Remove the Cell from this row.
  20183. </summary>
  20184. <param name="cell">The cell to Remove.</param>
  20185. </member>
  20186. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveCell(NPOI.SS.UserModel.ICell,System.Boolean)">
  20187. <summary>
  20188. Removes the cell.
  20189. </summary>
  20190. <param name="cell">The cell.</param>
  20191. <param name="alsoRemoveRecords">if set to <c>true</c> [also remove records].</param>
  20192. </member>
  20193. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewLastCellPlusOne(System.Int32)">
  20194. used internally to refresh the "last cell plus one" when the last cell is removed.
  20195. @return 0 when row contains no cells
  20196. </member>
  20197. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CalculateNewFirstCell(System.Int32)">
  20198. used internally to refresh the "first cell" when the first cell is removed.
  20199. @return 0 when row contains no cells (also when first cell is occupied)
  20200. </member>
  20201. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CreateCellFromRecord(NPOI.HSSF.Record.CellValueRecordInterface)">
  20202. <summary>
  20203. Create a high level Cell object from an existing low level record. Should
  20204. only be called from HSSFSheet or HSSFRow itself.
  20205. </summary>
  20206. <param name="cell">The low level cell to Create the high level representation from</param>
  20207. <returns> the low level record passed in</returns>
  20208. </member>
  20209. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsHidden">
  20210. <summary>
  20211. true, when the row is invisible. This is the case when the height is zero.
  20212. </summary>
  20213. </member>
  20214. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RemoveAllCells">
  20215. <summary>
  20216. Removes all the cells from the row, and their
  20217. records too.
  20218. </summary>
  20219. </member>
  20220. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowNum">
  20221. <summary>
  20222. Get row number this row represents
  20223. </summary>
  20224. <value>the row number (0 based)</value>
  20225. </member>
  20226. <member name="P:NPOI.HSSF.UserModel.HSSFRow.OutlineLevel">
  20227. <summary>
  20228. Returns the rows outline level. Increased as you
  20229. put it into more Groups (outlines), reduced as
  20230. you take it out of them.
  20231. </summary>
  20232. <value>The outline level.</value>
  20233. </member>
  20234. <member name="M:NPOI.HSSF.UserModel.HSSFRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  20235. <summary>
  20236. Moves the supplied cell to a new column, which
  20237. must not already have a cell there!
  20238. </summary>
  20239. <param name="cell">The cell to move</param>
  20240. <param name="newColumn">The new column number (0 based)</param>
  20241. </member>
  20242. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Sheet">
  20243. Returns the HSSFSheet this row belongs to
  20244. @return the HSSFSheet that owns this row
  20245. </member>
  20246. <member name="M:NPOI.HSSF.UserModel.HSSFRow.AddCell(NPOI.SS.UserModel.ICell)">
  20247. <summary>
  20248. used internally to Add a cell.
  20249. </summary>
  20250. <param name="cell">The cell.</param>
  20251. </member>
  20252. <member name="M:NPOI.HSSF.UserModel.HSSFRow.RetrieveCell(System.Int32)">
  20253. <summary>
  20254. Get the hssfcell representing a given column (logical cell)
  20255. 0-based. If you ask for a cell that is not defined, then
  20256. you Get a null.
  20257. This is the basic call, with no policies applied
  20258. </summary>
  20259. <param name="cellnum">0 based column number</param>
  20260. <returns>Cell representing that column or null if Undefined.</returns>
  20261. </member>
  20262. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int16)">
  20263. <summary>
  20264. Get the hssfcell representing a given column (logical cell)
  20265. 0-based. If you ask for a cell that is not defined then
  20266. you get a null, unless you have set a different
  20267. MissingCellPolicy on the base workbook.
  20268. Short method signature provided to retain binary
  20269. compatibility.
  20270. </summary>
  20271. <param name="cellnum">0 based column number</param>
  20272. <returns>Cell representing that column or null if undefined.</returns>
  20273. </member>
  20274. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32)">
  20275. <summary>
  20276. Get the hssfcell representing a given column (logical cell)
  20277. 0-based. If you ask for a cell that is not defined then
  20278. you get a null, unless you have set a different
  20279. MissingCellPolicy on the base workbook.
  20280. </summary>
  20281. <param name="cellnum">0 based column number</param>
  20282. <returns>Cell representing that column or null if undefined.</returns>
  20283. </member>
  20284. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  20285. <summary>
  20286. Get the hssfcell representing a given column (logical cell)
  20287. 0-based. If you ask for a cell that is not defined, then
  20288. your supplied policy says what to do
  20289. </summary>
  20290. <param name="cellnum">0 based column number</param>
  20291. <param name="policy">Policy on blank / missing cells</param>
  20292. <returns>that column or null if Undefined + policy allows.</returns>
  20293. </member>
  20294. <member name="P:NPOI.HSSF.UserModel.HSSFRow.FirstCellNum">
  20295. <summary>
  20296. Get the number of the first cell contained in this row.
  20297. </summary>
  20298. <value>the first logical cell in the row, or -1 if the row does not contain any cells.</value>
  20299. </member>
  20300. <member name="P:NPOI.HSSF.UserModel.HSSFRow.LastCellNum">
  20301. <summary>
  20302. Gets the index of the last cell contained in this row PLUS ONE
  20303. . The result also happens to be the 1-based column number of the last cell. This value can be used as a
  20304. standard upper bound when iterating over cells:
  20305. </summary>
  20306. <value>
  20307. short representing the last logical cell in the row PLUS ONE, or -1 if the
  20308. row does not contain any cells.
  20309. </value>
  20310. <example>
  20311. short minColIx = row.GetFirstCellNum();
  20312. short maxColIx = row.GetLastCellNum();
  20313. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  20314. Cell cell = row.GetCell(colIx);
  20315. if(cell == null) {
  20316. continue;
  20317. }
  20318. //... do something with cell
  20319. }
  20320. </example>
  20321. </member>
  20322. <member name="P:NPOI.HSSF.UserModel.HSSFRow.PhysicalNumberOfCells">
  20323. <summary>
  20324. Gets the number of defined cells (NOT number of cells in the actual row!).
  20325. That is to say if only columns 0,4,5 have values then there would be 3.
  20326. </summary>
  20327. <value>the number of defined cells in the row.</value>
  20328. </member>
  20329. <member name="P:NPOI.HSSF.UserModel.HSSFRow.ZeroHeight">
  20330. <summary>
  20331. Gets or sets whether or not to Display this row with 0 height
  20332. </summary>
  20333. <value>height is zero or not.</value>
  20334. </member>
  20335. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Height">
  20336. <summary>
  20337. Get or sets the row's height or ff (-1) for undefined/default-height in twips (1/20th of a point)
  20338. </summary>
  20339. <value>rowheight or 0xff for Undefined (use sheet default)</value>
  20340. </member>
  20341. <member name="P:NPOI.HSSF.UserModel.HSSFRow.IsFormatted">
  20342. <summary>
  20343. is this row formatted? Most aren't, but some rows
  20344. do have whole-row styles. For those that do, you
  20345. can get the formatting from {@link #getRowStyle()}
  20346. </summary>
  20347. <value>
  20348. <c>true</c> if this instance is formatted; otherwise, <c>false</c>.
  20349. </value>
  20350. </member>
  20351. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowStyle">
  20352. <summary>
  20353. Returns the whole-row cell styles. Most rows won't
  20354. have one of these, so will return null. Call IsFormmated to check first
  20355. </summary>
  20356. <value>The row style.</value>
  20357. </member>
  20358. <member name="P:NPOI.HSSF.UserModel.HSSFRow.HeightInPoints">
  20359. <summary>
  20360. Get the row's height or ff (-1) for Undefined/default-height in points (20*Height)
  20361. </summary>
  20362. <value>row height or 0xff for Undefined (use sheet default).</value>
  20363. </member>
  20364. <member name="P:NPOI.HSSF.UserModel.HSSFRow.RowRecord">
  20365. <summary>
  20366. Get the lowlevel RowRecord represented by this object - should only be called
  20367. by other parts of the high level API
  20368. </summary>
  20369. <value>RowRecord this row represents</value>
  20370. </member>
  20371. <member name="M:NPOI.HSSF.UserModel.HSSFRow.FindFirstCell(System.Int32)">
  20372. <summary>
  20373. used internally to refresh the "first cell" when the first cell is Removed.
  20374. </summary>
  20375. <param name="firstcell">The first cell index.</param>
  20376. <returns></returns>
  20377. </member>
  20378. <member name="P:NPOI.HSSF.UserModel.HSSFRow.Cells">
  20379. <summary>
  20380. Get cells in the row (existing cells only, no blanks)
  20381. </summary>
  20382. </member>
  20383. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetEnumerator">
  20384. <summary>
  20385. Gets the cell enumerator of the physically defined cells.
  20386. </summary>
  20387. <remarks>
  20388. Note that the 4th element might well not be cell 4, as the iterator
  20389. will not return Un-defined (null) cells.
  20390. Call CellNum on the returned cells to know which cell they are.
  20391. </remarks>
  20392. </member>
  20393. <member name="M:NPOI.HSSF.UserModel.HSSFRow.CompareTo(System.Object)">
  20394. <summary>
  20395. 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.
  20396. </summary>
  20397. <param name="obj">An object to compare with this instance.</param>
  20398. <returns>
  20399. A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:
  20400. Value
  20401. Meaning
  20402. Less than zero
  20403. This instance is less than <paramref name="obj"/>.
  20404. Zero
  20405. This instance is equal to <paramref name="obj"/>.
  20406. Greater than zero
  20407. This instance is greater than <paramref name="obj"/>.
  20408. </returns>
  20409. <exception cref="T:System.ArgumentException">
  20410. <paramref name="obj"/> is not the same type as this instance.
  20411. </exception>
  20412. </member>
  20413. <member name="M:NPOI.HSSF.UserModel.HSSFRow.Equals(System.Object)">
  20414. <summary>
  20415. Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
  20416. </summary>
  20417. <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
  20418. <returns>
  20419. true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
  20420. </returns>
  20421. <exception cref="T:System.NullReferenceException">
  20422. The <paramref name="obj"/> parameter is null.
  20423. </exception>
  20424. </member>
  20425. <member name="M:NPOI.HSSF.UserModel.HSSFRow.GetHashCode">
  20426. <summary>
  20427. Returns a hash code. In this case it is the number of the row.
  20428. </summary>
  20429. </member>
  20430. <member name="T:NPOI.HSSF.UserModel.HSSFShape">
  20431. <summary>
  20432. An abstract shape.
  20433. Note: Microsoft Excel seems to sometimes disallow
  20434. higher y1 than y2 or higher x1 than x2 in the anchor, you might need to
  20435. reverse them and draw shapes vertically or horizontally flipped!
  20436. </summary>
  20437. </member>
  20438. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.ObjRecord)">
  20439. creates shapes from existing file
  20440. @param spContainer
  20441. @param objRecord
  20442. </member>
  20443. <member name="M:NPOI.HSSF.UserModel.HSSFShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  20444. <summary>
  20445. Create a new shape with the specified parent and anchor.
  20446. </summary>
  20447. <param name="parent">The parent.</param>
  20448. <param name="anchor">The anchor.</param>
  20449. </member>
  20450. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Parent">
  20451. <summary>
  20452. Gets the parent shape.
  20453. </summary>
  20454. <value>The parent.</value>
  20455. </member>
  20456. <member name="P:NPOI.HSSF.UserModel.HSSFShape.Anchor">
  20457. <summary>
  20458. Gets or sets the anchor that is used by this shape.
  20459. </summary>
  20460. <value>The anchor.</value>
  20461. </member>
  20462. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyleColor">
  20463. <summary>
  20464. The color applied to the lines of this shape.
  20465. </summary>
  20466. <value>The color of the line style.</value>
  20467. </member>
  20468. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetLineStyleColor(System.Int32,System.Int32,System.Int32)">
  20469. <summary>
  20470. Sets the color applied to the lines of this shape
  20471. </summary>
  20472. <param name="red">The red.</param>
  20473. <param name="green">The green.</param>
  20474. <param name="blue">The blue.</param>
  20475. </member>
  20476. <member name="P:NPOI.HSSF.UserModel.HSSFShape.FillColor">
  20477. <summary>
  20478. Gets or sets the color used to fill this shape.
  20479. </summary>
  20480. <value>The color of the fill.</value>
  20481. </member>
  20482. <member name="M:NPOI.HSSF.UserModel.HSSFShape.SetFillColor(System.Int32,System.Int32,System.Int32)">
  20483. <summary>
  20484. Sets the color used to fill this shape.
  20485. </summary>
  20486. <param name="red">The red.</param>
  20487. <param name="green">The green.</param>
  20488. <param name="blue">The blue.</param>
  20489. </member>
  20490. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineWidth">
  20491. <summary>
  20492. Gets or sets with width of the line in EMUs. 12700 = 1 pt.
  20493. </summary>
  20494. <value>The width of the line.</value>
  20495. </member>
  20496. <member name="P:NPOI.HSSF.UserModel.HSSFShape.LineStyle">
  20497. <summary>
  20498. Gets or sets One of the constants in LINESTYLE_*
  20499. </summary>
  20500. <value>The line style.</value>
  20501. </member>
  20502. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsNoFill">
  20503. <summary>
  20504. Gets or sets a value indicating whether this instance is no fill.
  20505. </summary>
  20506. <value>
  20507. <c>true</c> if this shape Is not filled with a color; otherwise, <c>false</c>.
  20508. </value>
  20509. </member>
  20510. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipVertical">
  20511. <summary>
  20512. whether this shape is vertically flipped.
  20513. </summary>
  20514. </member>
  20515. <member name="P:NPOI.HSSF.UserModel.HSSFShape.IsFlipHorizontal">
  20516. <summary>
  20517. whether this shape is horizontally flipped.
  20518. </summary>
  20519. </member>
  20520. <member name="P:NPOI.HSSF.UserModel.HSSFShape.RotationDegree">
  20521. <summary>
  20522. get or set the rotation, in degrees, that is applied to a shape.
  20523. Negative values specify rotation in the counterclockwise direction.
  20524. Rotation occurs around the center of the shape.
  20525. The default value for this property is 0x00000000
  20526. </summary>
  20527. </member>
  20528. <member name="P:NPOI.HSSF.UserModel.HSSFShape.CountOfAllChildren">
  20529. <summary>
  20530. Count of all children and their childrens children.
  20531. </summary>
  20532. <value>The count of all children.</value>
  20533. </member>
  20534. <member name="T:NPOI.HSSF.UserModel.HSSFShapeContainer">
  20535. <summary>
  20536. An interface that indicates whether a class can contain children.
  20537. @author Glen Stampoultzis (glens at apache.org)
  20538. </summary>
  20539. </member>
  20540. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Children">
  20541. <summary>
  20542. Gets Any children contained by this shape.
  20543. </summary>
  20544. <value>The children.</value>
  20545. </member>
  20546. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.AddShape(NPOI.HSSF.UserModel.HSSFShape)">
  20547. <summary>
  20548. dd shape to the list of child records
  20549. </summary>
  20550. <param name="shape">shape</param>
  20551. </member>
  20552. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  20553. <summary>
  20554. set coordinates of this group relative to the parent
  20555. </summary>
  20556. <param name="x1">x1</param>
  20557. <param name="y1">y1</param>
  20558. <param name="x2">x2</param>
  20559. <param name="y2">y2</param>
  20560. </member>
  20561. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X1">
  20562. <summary>
  20563. Get the top left x coordinate of this group.
  20564. </summary>
  20565. </member>
  20566. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y1">
  20567. <summary>
  20568. Get the top left y coordinate of this group.
  20569. </summary>
  20570. </member>
  20571. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.X2">
  20572. <summary>
  20573. Get the bottom right x coordinate of this group.
  20574. </summary>
  20575. </member>
  20576. <member name="P:NPOI.HSSF.UserModel.HSSFShapeContainer.Y2">
  20577. <summary>
  20578. Get the bottom right y coordinate of this group.
  20579. </summary>
  20580. </member>
  20581. <member name="M:NPOI.HSSF.UserModel.HSSFShapeContainer.RemoveShape(NPOI.HSSF.UserModel.HSSFShape)">
  20582. remove first level shapes
  20583. @param shape to be removed
  20584. @return true if shape is removed else return false
  20585. </member>
  20586. <member name="T:NPOI.HSSF.UserModel.HSSFShapeFactory">
  20587. @author Evgeniy Berlog
  20588. date: 05.06.12
  20589. </member>
  20590. <member name="M:NPOI.HSSF.UserModel.HSSFShapeFactory.CreateShapeTree(NPOI.DDF.EscherContainerRecord,NPOI.HSSF.Record.EscherAggregate,NPOI.HSSF.UserModel.HSSFShapeContainer,NPOI.POIFS.FileSystem.DirectoryNode)">
  20591. build shape tree from escher container
  20592. @param container root escher container from which escher records must be taken
  20593. @param agg - EscherAggregate
  20594. @param out - shape container to which shapes must be added
  20595. @param root - node to create HSSFObjectData shapes
  20596. </member>
  20597. <member name="T:NPOI.HSSF.UserModel.HSSFShapeGroup">
  20598. <summary>
  20599. A shape Group may contain other shapes. It was no actual form on the
  20600. sheet.
  20601. @author Glen Stampoultzis (glens at apache.org)
  20602. </summary>
  20603. </member>
  20604. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateGroup(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20605. <summary>
  20606. Create another Group Under this Group.
  20607. </summary>
  20608. <param name="anchor">the position of the new Group.</param>
  20609. <returns>the Group</returns>
  20610. </member>
  20611. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateShape(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20612. <summary>
  20613. Create a new simple shape Under this Group.
  20614. </summary>
  20615. <param name="anchor">the position of the shape.</param>
  20616. <returns>the shape</returns>
  20617. </member>
  20618. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreateTextbox(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20619. <summary>
  20620. Create a new textbox Under this Group.
  20621. </summary>
  20622. <param name="anchor">the position of the shape.</param>
  20623. <returns>the textbox</returns>
  20624. </member>
  20625. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePolygon(NPOI.HSSF.UserModel.HSSFChildAnchor)">
  20626. <summary>
  20627. Creates a polygon
  20628. </summary>
  20629. <param name="anchor">the client anchor describes how this Group Is attached
  20630. to the sheet.</param>
  20631. <returns>the newly Created shape.</returns>
  20632. </member>
  20633. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.CreatePicture(NPOI.HSSF.UserModel.HSSFChildAnchor,System.Int32)">
  20634. <summary>
  20635. Creates a picture.
  20636. </summary>
  20637. <param name="anchor">the client anchor describes how this Group Is attached
  20638. to the sheet.</param>
  20639. <param name="pictureIndex">Index of the picture.</param>
  20640. <returns>the newly Created shape.</returns>
  20641. </member>
  20642. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Children">
  20643. <summary>
  20644. Return all children contained by this shape.
  20645. </summary>
  20646. <value></value>
  20647. </member>
  20648. <member name="M:NPOI.HSSF.UserModel.HSSFShapeGroup.SetCoordinates(System.Int32,System.Int32,System.Int32,System.Int32)">
  20649. <summary>
  20650. Sets the coordinate space of this Group. All children are constrained
  20651. to these coordinates.
  20652. </summary>
  20653. <param name="x1">The x1.</param>
  20654. <param name="y1">The y1.</param>
  20655. <param name="x2">The x2.</param>
  20656. <param name="y2">The y2.</param>
  20657. </member>
  20658. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X1">
  20659. <summary>
  20660. Gets The top left x coordinate of this Group.
  20661. </summary>
  20662. <value>The x1.</value>
  20663. </member>
  20664. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y1">
  20665. <summary>
  20666. Gets The top left y coordinate of this Group.
  20667. </summary>
  20668. <value>The y1.</value>
  20669. </member>
  20670. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.X2">
  20671. <summary>
  20672. Gets The bottom right x coordinate of this Group.
  20673. </summary>
  20674. <value>The x2.</value>
  20675. </member>
  20676. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.Y2">
  20677. <summary>
  20678. Gets the bottom right y coordinate of this Group.
  20679. </summary>
  20680. <value>The y2.</value>
  20681. </member>
  20682. <member name="P:NPOI.HSSF.UserModel.HSSFShapeGroup.CountOfAllChildren">
  20683. <summary>
  20684. Count of all children and their childrens children.
  20685. </summary>
  20686. <value></value>
  20687. </member>
  20688. <member name="T:NPOI.HSSF.UserModel.HSSFSheet">
  20689. <summary>
  20690. High level representation of a worksheet.
  20691. </summary>
  20692. <remarks>
  20693. @author Andrew C. Oliver (acoliver at apache dot org)
  20694. @author Glen Stampoultzis (glens at apache.org)
  20695. @author Libin Roman (romal at vistaportal.com)
  20696. @author Shawn Laubach (slaubach at apache dot org) (Just a little)
  20697. @author Jean-Pierre Paris (jean-pierre.paris at m4x dot org) (Just a little, too)
  20698. @author Yegor Kozlov (yegor at apache.org) (Autosizing columns)
  20699. </remarks>
  20700. </member>
  20701. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_DEFAULT">
  20702. width of 1px in columns with default width in units of 1/256 of a character width
  20703. </member>
  20704. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.PX_MODIFIED">
  20705. width of 1px in columns with overridden width in units of 1/256 of a character width
  20706. </member>
  20707. <member name="F:NPOI.HSSF.UserModel.HSSFSheet.INITIAL_CAPACITY">
  20708. Used for compile-time optimization. This is the initial size for the collection of
  20709. rows. It is currently Set to 20. If you generate larger sheets you may benefit
  20710. by Setting this to a higher number and recompiling a custom edition of HSSFSheet.
  20711. </member>
  20712. <member name="F:NPOI.HSSF.UserModel.HSSFSheet._sheet">
  20713. reference to the low level Sheet object
  20714. </member>
  20715. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook)">
  20716. <summary>
  20717. Creates new HSSFSheet - called by HSSFWorkbook to create a _sheet from
  20718. scratch. You should not be calling this from application code (its protected anyhow).
  20719. </summary>
  20720. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  20721. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet"/>
  20722. </member>
  20723. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.#ctor(NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.Model.InternalSheet)">
  20724. <summary>
  20725. Creates an HSSFSheet representing the given Sheet object. Should only be
  20726. called by HSSFWorkbook when reading in an exisiting file.
  20727. </summary>
  20728. <param name="workbook">The HSSF Workbook object associated with the _sheet.</param>
  20729. <param name="sheet">lowlevel Sheet object this _sheet will represent</param>
  20730. <see cref="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)"/>
  20731. </member>
  20732. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CloneSheet(NPOI.HSSF.UserModel.HSSFWorkbook)">
  20733. <summary>
  20734. Clones the _sheet.
  20735. </summary>
  20736. <param name="workbook">The _workbook.</param>
  20737. <returns>the cloned sheet</returns>
  20738. </member>
  20739. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CopyRow(System.Int32,System.Int32)">
  20740. <summary>
  20741. Copy one row to the target row
  20742. </summary>
  20743. <param name="sourceIndex">index of the source row</param>
  20744. <param name="targetIndex">index of the target row</param>
  20745. </member>
  20746. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetPropertiesFromSheet(NPOI.HSSF.Model.InternalSheet)">
  20747. <summary>
  20748. used internally to Set the properties given a Sheet object
  20749. </summary>
  20750. <param name="sheet">The _sheet.</param>
  20751. </member>
  20752. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayZeros">
  20753. Gets the flag indicating whether the window should show 0 (zero) in cells containing zero value.
  20754. When false, cells with zero value appear blank instead of showing the number zero.
  20755. In Excel 2003 this option can be changed in the Options dialog on the View tab.
  20756. @return whether all zero values on the worksheet are displayed
  20757. </member>
  20758. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRow(System.Int32)">
  20759. <summary>
  20760. Create a new row within the _sheet and return the high level representation
  20761. </summary>
  20762. <param name="rownum">The row number.</param>
  20763. <returns></returns>
  20764. @see org.apache.poi.hssf.usermodel.HSSFRow
  20765. @see #RemoveRow(HSSFRow)
  20766. </member>
  20767. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateRowFromRecord(NPOI.HSSF.Record.RowRecord)">
  20768. <summary>
  20769. Used internally to Create a high level Row object from a low level row object.
  20770. USed when Reading an existing file
  20771. </summary>
  20772. <param name="row">low level record to represent as a high level Row and Add to _sheet.</param>
  20773. <returns>HSSFRow high level representation</returns>
  20774. </member>
  20775. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  20776. <summary>
  20777. Remove a row from this _sheet. All cells contained in the row are Removed as well
  20778. </summary>
  20779. <param name="row">the row to Remove.</param>
  20780. </member>
  20781. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindLastRow(System.Int32)">
  20782. <summary>
  20783. used internally to refresh the "last row" when the last row is Removed.
  20784. </summary>
  20785. <param name="lastrow">The last row.</param>
  20786. <returns></returns>
  20787. </member>
  20788. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.FindFirstRow(System.Int32)">
  20789. <summary>
  20790. used internally to refresh the "first row" when the first row is Removed.
  20791. </summary>
  20792. <param name="firstrow">The first row.</param>
  20793. <returns></returns>
  20794. </member>
  20795. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddRow(NPOI.HSSF.UserModel.HSSFRow,System.Boolean)">
  20796. Add a row to the _sheet
  20797. @param AddLow whether to Add the row to the low level model - false if its already there
  20798. </member>
  20799. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnStyle(System.Int32)">
  20800. <summary>
  20801. Returns the HSSFCellStyle that applies to the given
  20802. (0 based) column, or null if no style has been
  20803. set for that column
  20804. </summary>
  20805. <param name="column">The column.</param>
  20806. <returns></returns>
  20807. </member>
  20808. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRow(System.Int32)">
  20809. <summary>
  20810. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  20811. defined you get a null. This is to say row 4 represents the fifth row on a _sheet.
  20812. </summary>
  20813. <param name="rowIndex">Index of the row to get.</param>
  20814. <returns>the row number or null if its not defined on the _sheet</returns>
  20815. </member>
  20816. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PhysicalNumberOfRows">
  20817. <summary>
  20818. Returns the number of phsyically defined rows (NOT the number of rows in the _sheet)
  20819. </summary>
  20820. <value>The physical number of rows.</value>
  20821. </member>
  20822. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FirstRowNum">
  20823. <summary>
  20824. Gets the first row on the _sheet
  20825. </summary>
  20826. <value>the number of the first logical row on the _sheet</value>
  20827. </member>
  20828. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LastRowNum">
  20829. <summary>
  20830. Gets the last row on the _sheet
  20831. </summary>
  20832. <value>last row contained n this _sheet.</value>
  20833. </member>
  20834. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  20835. <summary>
  20836. Creates a data validation object
  20837. </summary>
  20838. <param name="dataValidation">The data validation object settings</param>
  20839. </member>
  20840. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnHidden(System.Int32,System.Boolean)">
  20841. <summary>
  20842. Get the visibility state for a given column.F:\Gloria\�о�\�ļ���ʽ\NPOI\src\NPOI\HSSF\Util\HSSFDataValidation.cs
  20843. </summary>
  20844. <param name="column">the column to Get (0-based).</param>
  20845. <param name="hidden">the visiblity state of the column.</param>
  20846. </member>
  20847. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnHidden(System.Int32)">
  20848. <summary>
  20849. Get the hidden state for a given column.
  20850. </summary>
  20851. <param name="column">the column to Set (0-based)</param>
  20852. <returns>the visiblity state of the column;
  20853. </returns>
  20854. </member>
  20855. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnWidth(System.Int32,System.Int32)">
  20856. <summary>
  20857. Set the width (in Units of 1/256th of a Char width)
  20858. </summary>
  20859. <param name="column">the column to Set (0-based)</param>
  20860. <param name="width">the width in Units of 1/256th of a Char width</param>
  20861. </member>
  20862. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnWidth(System.Int32)">
  20863. <summary>
  20864. Get the width (in Units of 1/256th of a Char width )
  20865. </summary>
  20866. <param name="column">the column to Set (0-based)</param>
  20867. <returns>the width in Units of 1/256th of a Char width</returns>
  20868. </member>
  20869. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultColumnWidth">
  20870. <summary>
  20871. Gets or sets the default width of the column.
  20872. </summary>
  20873. <value>The default width of the column.</value>
  20874. </member>
  20875. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeight">
  20876. <summary>
  20877. Get the default row height for the _sheet (if the rows do not define their own height) in
  20878. twips (1/20 of a point)
  20879. </summary>
  20880. <value>The default height of the row.</value>
  20881. </member>
  20882. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DefaultRowHeightInPoints">
  20883. <summary>
  20884. Get the default row height for the _sheet (if the rows do not define their own height) in
  20885. points.
  20886. </summary>
  20887. <value>The default row height in points.</value>
  20888. </member>
  20889. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsGridsPrinted">
  20890. <summary>
  20891. Get whether gridlines are printed.
  20892. </summary>
  20893. <value>
  20894. <c>true</c> if printed; otherwise, <c>false</c>.
  20895. </value>
  20896. </member>
  20897. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.Region)">
  20898. <summary>
  20899. Adds a merged region of cells (hence those cells form one)
  20900. </summary>
  20901. <param name="region">The region (rowfrom/colfrom-rowto/colto) to merge.</param>
  20902. <returns>index of this region</returns>
  20903. </member>
  20904. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  20905. <summary>
  20906. adds a merged region of cells (hence those cells form one)
  20907. </summary>
  20908. <param name="region">region (rowfrom/colfrom-rowto/colto) to merge</param>
  20909. <returns>index of this region</returns>
  20910. </member>
  20911. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ForceFormulaRecalculation">
  20912. <summary>
  20913. Whether a record must be Inserted or not at generation to indicate that
  20914. formula must be recalculated when _workbook is opened.
  20915. </summary>
  20916. <value>
  20917. <c>true</c> if [force formula recalculation]; otherwise, <c>false</c>.
  20918. </value>
  20919. @return true if an Uncalced record must be Inserted or not at generation
  20920. </member>
  20921. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.VerticallyCenter">
  20922. <summary>
  20923. Determine whether printed output for this _sheet will be vertically centered.
  20924. </summary>
  20925. <value><c>true</c> if [vertically center]; otherwise, <c>false</c>.</value>
  20926. </member>
  20927. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.HorizontallyCenter">
  20928. <summary>
  20929. Determine whether printed output for this _sheet will be horizontally centered.
  20930. </summary>
  20931. <value><c>true</c> if [horizontally center]; otherwise, <c>false</c>.</value>
  20932. </member>
  20933. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveMergedRegion(System.Int32)">
  20934. <summary>
  20935. Removes a merged region of cells (hence letting them free)
  20936. </summary>
  20937. <param name="index">index of the region to Unmerge</param>
  20938. </member>
  20939. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.NumMergedRegions">
  20940. <summary>
  20941. returns the number of merged regions
  20942. </summary>
  20943. <value>The number of merged regions</value>
  20944. </member>
  20945. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetRowEnumerator">
  20946. <summary>
  20947. Gets the row enumerator.
  20948. </summary>
  20949. <returns>
  20950. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  20951. be the third row if say for instance the second row is undefined.
  20952. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  20953. if you care which one it is.
  20954. </returns>
  20955. </member>
  20956. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetEnumerator">
  20957. <summary>
  20958. Alias for GetRowEnumerator() to allow <c>foreach</c> loops.
  20959. </summary>
  20960. <returns>
  20961. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  20962. be the third row if say for instance the second row is undefined.
  20963. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  20964. if you care which one it is.
  20965. </returns>
  20966. </member>
  20967. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Sheet">
  20968. <summary>
  20969. used internally in the API to Get the low level Sheet record represented by this
  20970. Object.
  20971. </summary>
  20972. <value>low level representation of this HSSFSheet.</value>
  20973. </member>
  20974. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCell(System.Int32,System.Int32)">
  20975. <summary>
  20976. Sets the active cell.
  20977. </summary>
  20978. <param name="row">The row.</param>
  20979. <param name="column">The column.</param>
  20980. </member>
  20981. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  20982. <summary>
  20983. Sets the active cell range.
  20984. </summary>
  20985. <param name="firstRow">The first row.</param>
  20986. <param name="lastRow">The last row.</param>
  20987. <param name="firstColumn">The first column.</param>
  20988. <param name="lastColumn">The last column.</param>
  20989. </member>
  20990. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  20991. <summary>
  20992. Sets the active cell range.
  20993. </summary>
  20994. <param name="cellranges">The cellranges.</param>
  20995. <param name="activeRange">The index of the active range.</param>
  20996. <param name="activeRow">The active row in the active range</param>
  20997. <param name="activeColumn">The active column in the active range</param>
  20998. </member>
  20999. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeExpression">
  21000. <summary>
  21001. Gets or sets whether alternate expression evaluation is on
  21002. </summary>
  21003. <value>
  21004. <c>true</c> if [alternative expression]; otherwise, <c>false</c>.
  21005. </value>
  21006. </member>
  21007. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.AlternativeFormula">
  21008. <summary>
  21009. whether alternative formula entry is on
  21010. </summary>
  21011. <value><c>true</c> alternative formulas or not; otherwise, <c>false</c>.</value>
  21012. </member>
  21013. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Autobreaks">
  21014. <summary>
  21015. show automatic page breaks or not
  21016. </summary>
  21017. <value>whether to show auto page breaks</value>
  21018. </member>
  21019. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Dialog">
  21020. <summary>
  21021. Gets or sets a value indicating whether _sheet is a dialog _sheet
  21022. </summary>
  21023. <value><c>true</c> if is dialog; otherwise, <c>false</c>.</value>
  21024. </member>
  21025. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGuts">
  21026. <summary>
  21027. Gets or sets a value indicating whether to Display the guts or not.
  21028. </summary>
  21029. <value><c>true</c> if guts or no guts (or glory); otherwise, <c>false</c>.</value>
  21030. </member>
  21031. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.FitToPage">
  21032. <summary>
  21033. Gets or sets a value indicating whether fit to page option is on
  21034. </summary>
  21035. <value><c>true</c> if [fit to page]; otherwise, <c>false</c>.</value>
  21036. </member>
  21037. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsBelow">
  21038. <summary>
  21039. Get if row summaries appear below detail in the outline
  21040. </summary>
  21041. <value><c>true</c> if below or not; otherwise, <c>false</c>.</value>
  21042. </member>
  21043. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowSumsRight">
  21044. <summary>
  21045. Get if col summaries appear right of the detail in the outline
  21046. </summary>
  21047. <value><c>true</c> right or not; otherwise, <c>false</c>.</value>
  21048. </member>
  21049. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsPrintGridlines">
  21050. <summary>
  21051. Gets or sets whether gridlines are printed.
  21052. </summary>
  21053. <value>
  21054. <c>true</c> Gridlines are printed; otherwise, <c>false</c>.
  21055. </value>
  21056. </member>
  21057. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PrintSetup">
  21058. <summary>
  21059. Gets the print setup object.
  21060. </summary>
  21061. <value>The user model for the print setup object.</value>
  21062. </member>
  21063. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Header">
  21064. <summary>
  21065. Gets the user model for the document header.
  21066. </summary>
  21067. <value>The Document header.</value>
  21068. </member>
  21069. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Footer">
  21070. <summary>
  21071. Gets the user model for the document footer.
  21072. </summary>
  21073. <value>The Document footer.</value>
  21074. </member>
  21075. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsRightToLeft">
  21076. <summary>
  21077. Gets or sets whether the worksheet is displayed from right to left instead of from left to right.
  21078. </summary>
  21079. <value>true for right to left, false otherwise</value>
  21080. <remarks>poi bug 47970</remarks>
  21081. </member>
  21082. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsSelected">
  21083. <summary>
  21084. Note - this is not the same as whether the _sheet is focused (isActive)
  21085. </summary>
  21086. <value>
  21087. <c>true</c> if this _sheet is currently selected; otherwise, <c>false</c>.
  21088. </value>
  21089. </member>
  21090. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsActive">
  21091. <summary>
  21092. Gets or sets a value indicating if this _sheet is currently focused.
  21093. </summary>
  21094. <value><c>true</c> if this _sheet is currently focused; otherwise, <c>false</c>.</value>
  21095. </member>
  21096. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetActive(System.Boolean)">
  21097. <summary>
  21098. Sets whether sheet is selected.
  21099. </summary>
  21100. <param name="sel">Whether to select the sheet or deselect the sheet.</param>
  21101. </member>
  21102. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Protect">
  21103. <summary>
  21104. Answer whether protection is enabled or disabled
  21105. </summary>
  21106. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  21107. </member>
  21108. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Password">
  21109. <summary>
  21110. Gets the hashed password
  21111. </summary>
  21112. <value>The password.</value>
  21113. </member>
  21114. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ObjectProtect">
  21115. <summary>
  21116. Answer whether object protection is enabled or disabled
  21117. </summary>
  21118. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  21119. </member>
  21120. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ScenarioProtect">
  21121. <summary>
  21122. Answer whether scenario protection is enabled or disabled
  21123. </summary>
  21124. <value><c>true</c> if protection enabled; otherwise, <c>false</c>.</value>
  21125. </member>
  21126. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ProtectSheet(System.String)">
  21127. <summary>
  21128. Sets the protection enabled as well as the password
  21129. </summary>
  21130. <param name="password">password to set for protection, pass <code>null</code> to remove protection</param>
  21131. </member>
  21132. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetZoom(System.Int32,System.Int32)">
  21133. <summary>
  21134. Sets the zoom magnication for the _sheet. The zoom is expressed as a
  21135. fraction. For example to express a zoom of 75% use 3 for the numerator
  21136. and 4 for the denominator.
  21137. </summary>
  21138. <param name="numerator">The numerator for the zoom magnification.</param>
  21139. <param name="denominator">The denominator for the zoom magnification.</param>
  21140. </member>
  21141. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetEnclosedBorderOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21142. <summary>
  21143. Sets the enclosed border of region.
  21144. </summary>
  21145. <param name="region">The region.</param>
  21146. <param name="borderType">Type of the border.</param>
  21147. <param name="color">The color.</param>
  21148. </member>
  21149. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderRightOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21150. <summary>
  21151. Sets the right border of region.
  21152. </summary>
  21153. <param name="region">The region.</param>
  21154. <param name="borderType">Type of the border.</param>
  21155. <param name="color">The color.</param>
  21156. </member>
  21157. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderLeftOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21158. <summary>
  21159. Sets the left border of region.
  21160. </summary>
  21161. <param name="region">The region.</param>
  21162. <param name="borderType">Type of the border.</param>
  21163. <param name="color">The color.</param>
  21164. </member>
  21165. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderTopOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21166. <summary>
  21167. Sets the top border of region.
  21168. </summary>
  21169. <param name="region">The region.</param>
  21170. <param name="borderType">Type of the border.</param>
  21171. <param name="color">The color.</param>
  21172. </member>
  21173. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetBorderBottomOfRegion(NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.BorderStyle,System.Int16)">
  21174. <summary>
  21175. Sets the bottom border of region.
  21176. </summary>
  21177. <param name="region">The region.</param>
  21178. <param name="borderType">Type of the border.</param>
  21179. <param name="color">The color.</param>
  21180. </member>
  21181. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TopRow">
  21182. <summary>
  21183. The top row in the visible view when the _sheet is
  21184. first viewed after opening it in a viewer
  21185. </summary>
  21186. <value>the rownum (0 based) of the top row</value>
  21187. </member>
  21188. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.LeftCol">
  21189. <summary>
  21190. The left col in the visible view when the _sheet Is
  21191. first viewed after opening it in a viewer
  21192. </summary>
  21193. <value>the rownum (0 based) of the top row</value>
  21194. </member>
  21195. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int32,System.Int32)">
  21196. Sets desktop window pane display area, when the
  21197. file is first opened in a viewer.
  21198. @param toprow the top row to show in desktop window pane
  21199. @param leftcol the left column to show in desktop window pane
  21200. </member>
  21201. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShowInPane(System.Int16,System.Int16)">
  21202. <summary>
  21203. Sets desktop window pane display area, when the
  21204. file is first opened in a viewer.
  21205. </summary>
  21206. <param name="toprow">the top row to show in desktop window pane</param>
  21207. <param name="leftcol">the left column to show in desktop window pane</param>
  21208. </member>
  21209. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftMerged(System.Int32,System.Int32,System.Int32,System.Boolean)">
  21210. <summary>
  21211. Shifts the merged regions left or right depending on mode
  21212. TODO: MODE , this is only row specific
  21213. </summary>
  21214. <param name="startRow">The start row.</param>
  21215. <param name="endRow">The end row.</param>
  21216. <param name="n">The n.</param>
  21217. <param name="IsRow">if set to <c>true</c> [is row].</param>
  21218. </member>
  21219. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  21220. <summary>
  21221. Shifts rows between startRow and endRow n number of rows.
  21222. If you use a negative number, it will Shift rows up.
  21223. Code Ensures that rows don't wrap around.
  21224. Calls ShiftRows(startRow, endRow, n, false, false);
  21225. Additionally Shifts merged regions that are completely defined in these
  21226. rows (ie. merged 2 cells on a row to be Shifted).
  21227. </summary>
  21228. <param name="startRow">the row to start Shifting</param>
  21229. <param name="endRow">the row to end Shifting</param>
  21230. <param name="n">the number of rows to Shift</param>
  21231. </member>
  21232. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  21233. <summary>
  21234. Shifts rows between startRow and endRow n number of rows.
  21235. If you use a negative number, it will shift rows up.
  21236. Code ensures that rows don't wrap around
  21237. Additionally shifts merged regions that are completely defined in these
  21238. rows (ie. merged 2 cells on a row to be shifted).
  21239. TODO Might want to add bounds checking here
  21240. </summary>
  21241. <param name="startRow">the row to start shifting</param>
  21242. <param name="endRow">the row to end shifting</param>
  21243. <param name="n">the number of rows to shift</param>
  21244. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  21245. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  21246. </member>
  21247. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean)">
  21248. <summary>
  21249. Shifts rows between startRow and endRow n number of rows.
  21250. If you use a negative number, it will Shift rows up.
  21251. Code Ensures that rows don't wrap around
  21252. Additionally Shifts merged regions that are completely defined in these
  21253. rows (ie. merged 2 cells on a row to be Shifted).
  21254. TODO Might want to Add bounds Checking here
  21255. </summary>
  21256. <param name="startRow">the row to start Shifting</param>
  21257. <param name="endRow">the row to end Shifting</param>
  21258. <param name="n">the number of rows to Shift</param>
  21259. <param name="copyRowHeight">whether to copy the row height during the Shift</param>
  21260. <param name="resetOriginalRowHeight">whether to Set the original row's height to the default</param>
  21261. <param name="moveComments">if set to <c>true</c> [move comments].</param>
  21262. </member>
  21263. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.InsertChartRecords(System.Collections.Generic.List{NPOI.HSSF.Record.RecordBase})">
  21264. <summary>
  21265. Inserts the chart records.
  21266. </summary>
  21267. <param name="records">The records.</param>
  21268. </member>
  21269. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  21270. <summary>
  21271. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  21272. </summary>
  21273. <param name="colSplit">Horizonatal position of split.</param>
  21274. <param name="rowSplit">Vertical position of split.</param>
  21275. <param name="leftmostColumn">Top row visible in bottom pane</param>
  21276. <param name="topRow">Left column visible in right pane.</param>
  21277. </member>
  21278. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateFreezePane(System.Int32,System.Int32)">
  21279. <summary>
  21280. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  21281. </summary>
  21282. <param name="colSplit">Horizonatal position of split.</param>
  21283. <param name="rowSplit">Vertical position of split.</param>
  21284. </member>
  21285. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  21286. <summary>
  21287. Creates a split pane. Any existing freezepane or split pane is overwritten.
  21288. </summary>
  21289. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point).</param>
  21290. <param name="ySplitPos">Vertical position of split (in 1/20th of a point).</param>
  21291. <param name="leftmostColumn">Left column visible in right pane.</param>
  21292. <param name="topRow">Top row visible in bottom pane.</param>
  21293. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT,PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  21294. </member>
  21295. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.PaneInformation">
  21296. <summary>
  21297. Returns the information regarding the currently configured pane (split or freeze).
  21298. </summary>
  21299. <value>null if no pane configured, or the pane information.</value>
  21300. </member>
  21301. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayGridlines">
  21302. <summary>
  21303. Gets or sets if gridlines are Displayed.
  21304. </summary>
  21305. <value>whether gridlines are Displayed</value>
  21306. </member>
  21307. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayFormulas">
  21308. <summary>
  21309. Gets or sets a value indicating whether formulas are displayed.
  21310. </summary>
  21311. <value>whether formulas are Displayed</value>
  21312. </member>
  21313. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DisplayRowColHeadings">
  21314. <summary>
  21315. Gets or sets a value indicating whether RowColHeadings are displayed.
  21316. </summary>
  21317. <value>
  21318. whether RowColHeadings are displayed
  21319. </value>
  21320. </member>
  21321. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  21322. <summary>
  21323. Gets the size of the margin in inches.
  21324. </summary>
  21325. <param name="margin">which margin to get.</param>
  21326. <returns>the size of the margin</returns>
  21327. </member>
  21328. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  21329. <summary>
  21330. Sets the size of the margin in inches.
  21331. </summary>
  21332. <param name="margin">which margin to get.</param>
  21333. <param name="size">the size of the margin</param>
  21334. </member>
  21335. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowBreak(System.Int32)">
  21336. <summary>
  21337. Sets a page break at the indicated row
  21338. </summary>
  21339. <param name="row">The row.</param>
  21340. </member>
  21341. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsRowBroken(System.Int32)">
  21342. <summary>
  21343. Determines if there is a page break at the indicated row
  21344. </summary>
  21345. <param name="row">The row.</param>
  21346. <returns>
  21347. <c>true</c> if [is row broken] [the specified row]; otherwise, <c>false</c>.
  21348. </returns>
  21349. </member>
  21350. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveRowBreak(System.Int32)">
  21351. <summary>
  21352. Removes the page break at the indicated row
  21353. </summary>
  21354. <param name="row">The row.</param>
  21355. </member>
  21356. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.RowBreaks">
  21357. <summary>
  21358. Retrieves all the horizontal page breaks
  21359. </summary>
  21360. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  21361. </member>
  21362. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.ColumnBreaks">
  21363. <summary>
  21364. Retrieves all the vertical page breaks
  21365. </summary>
  21366. <value>all the vertical page breaks, or null if there are no column page breaks</value>
  21367. </member>
  21368. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnBreak(System.Int32)">
  21369. <summary>
  21370. Sets a page break at the indicated column
  21371. </summary>
  21372. <param name="column">The column.</param>
  21373. </member>
  21374. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsColumnBroken(System.Int32)">
  21375. <summary>
  21376. Determines if there is a page break at the indicated column
  21377. </summary>
  21378. <param name="column">The column.</param>
  21379. <returns>
  21380. <c>true</c> if [is column broken] [the specified column]; otherwise, <c>false</c>.
  21381. </returns>
  21382. </member>
  21383. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveColumnBreak(System.Int32)">
  21384. <summary>
  21385. Removes a page break at the indicated column
  21386. </summary>
  21387. <param name="column">The column.</param>
  21388. </member>
  21389. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateRow(System.Int32)">
  21390. <summary>
  21391. Runs a bounds Check for row numbers
  21392. </summary>
  21393. <param name="row">The row.</param>
  21394. </member>
  21395. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.ValidateColumn(System.Int32)">
  21396. <summary>
  21397. Runs a bounds Check for column numbers
  21398. </summary>
  21399. <param name="column">The column.</param>
  21400. </member>
  21401. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.DumpDrawingRecords(System.Boolean)">
  21402. <summary>
  21403. Aggregates the drawing records and dumps the escher record hierarchy
  21404. to the standard output.
  21405. </summary>
  21406. <param name="fat">if set to <c>true</c> [fat].</param>
  21407. </member>
  21408. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingEscherAggregate">
  21409. <summary>
  21410. Returns the agregate escher records for this _sheet,
  21411. it there is one.
  21412. WARNING - calling this will trigger a parsing of the
  21413. associated escher records. Any that aren't supported
  21414. (such as charts and complex drawing types) will almost
  21415. certainly be lost or corrupted when written out.
  21416. </summary>
  21417. <value>The drawing escher aggregate.</value>
  21418. </member>
  21419. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DrawingPatriarch">
  21420. This will hold any graphics or charts for the sheet.
  21421. @return the top-level drawing patriarch, if there is one, else returns null
  21422. </member>
  21423. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.CreateDrawingPatriarch">
  21424. Creates the top-level drawing patriarch. This will have
  21425. the effect of removing any existing drawings on this
  21426. sheet.
  21427. This may then be used to add graphics or charts
  21428. @return The new patriarch.
  21429. </member>
  21430. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.TabColorIndex">
  21431. <summary>
  21432. Gets or sets the tab color of the _sheet
  21433. </summary>
  21434. </member>
  21435. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.IsAutoTabColor">
  21436. <summary>
  21437. Gets or sets whether the tab color of _sheet is automatic
  21438. </summary>
  21439. </member>
  21440. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  21441. <summary>
  21442. Expands or collapses a column Group.
  21443. </summary>
  21444. <param name="columnNumber">One of the columns in the Group.</param>
  21445. <param name="collapsed">true = collapse Group, false = expand Group.</param>
  21446. </member>
  21447. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupColumn(System.Int32,System.Int32)">
  21448. <summary>
  21449. Create an outline for the provided column range.
  21450. </summary>
  21451. <param name="fromColumn">beginning of the column range.</param>
  21452. <param name="toColumn">end of the column range.</param>
  21453. </member>
  21454. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupColumn(System.Int32,System.Int32)">
  21455. <summary>
  21456. Ungroups the column.
  21457. </summary>
  21458. <param name="fromColumn">From column.</param>
  21459. <param name="toColumn">To column.</param>
  21460. </member>
  21461. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GroupRow(System.Int32,System.Int32)">
  21462. <summary>
  21463. Groups the row.
  21464. </summary>
  21465. <param name="fromRow">From row.</param>
  21466. <param name="toRow">To row.</param>
  21467. </member>
  21468. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  21469. <summary>
  21470. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  21471. </summary>
  21472. <param name="cell">any cell within Array Formula range</param>
  21473. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  21474. </member>
  21475. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellRange(NPOI.SS.Util.CellRangeAddress)">
  21476. <summary>
  21477. Also creates cells if they don't exist.
  21478. </summary>
  21479. </member>
  21480. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  21481. <summary>
  21482. Sets array formula to specified region for result.
  21483. </summary>
  21484. <param name="formula">text representation of the formula</param>
  21485. <param name="range">Region of array formula for result</param>
  21486. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  21487. </member>
  21488. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.UngroupRow(System.Int32,System.Int32)">
  21489. <summary>
  21490. Ungroups the row.
  21491. </summary>
  21492. <param name="fromRow">From row.</param>
  21493. <param name="toRow">To row.</param>
  21494. </member>
  21495. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  21496. <summary>
  21497. Sets the row group collapsed.
  21498. </summary>
  21499. <param name="row">The row.</param>
  21500. <param name="collapse">if set to <c>true</c> [collapse].</param>
  21501. </member>
  21502. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  21503. <summary>
  21504. Sets the default column style for a given column. POI will only apply this style to new cells Added to the _sheet.
  21505. </summary>
  21506. <param name="column">the column index</param>
  21507. <param name="style">the style to set</param>
  21508. </member>
  21509. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32)">
  21510. <summary>
  21511. Adjusts the column width to fit the contents.
  21512. This Process can be relatively slow on large sheets, so this should
  21513. normally only be called once per column, at the end of your
  21514. Processing.
  21515. </summary>
  21516. <param name="column">the column index.</param>
  21517. </member>
  21518. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.AutoSizeColumn(System.Int32,System.Boolean)">
  21519. <summary>
  21520. Adjusts the column width to fit the contents.
  21521. This Process can be relatively slow on large sheets, so this should
  21522. normally only be called once per column, at the end of your
  21523. Processing.
  21524. You can specify whether the content of merged cells should be considered or ignored.
  21525. Default is to ignore merged cells.
  21526. </summary>
  21527. <param name="column">the column index</param>
  21528. <param name="useMergedCells">whether to use the contents of merged cells when calculating the width of the column</param>
  21529. </member>
  21530. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  21531. <summary>
  21532. Checks if the provided region is part of the merged regions.
  21533. </summary>
  21534. <param name="mergedRegion">Region searched in the merged regions</param>
  21535. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  21536. </member>
  21537. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetMergedRegion(System.Int32)">
  21538. <summary>
  21539. Gets the merged region at the specified index
  21540. </summary>
  21541. <param name="index">The index.</param>
  21542. <returns></returns>
  21543. </member>
  21544. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.HSSFFont2Font(NPOI.HSSF.UserModel.HSSFFont)">
  21545. <summary>
  21546. Convert HSSFFont to Font.
  21547. </summary>
  21548. <param name="font1">The font.</param>
  21549. <returns></returns>
  21550. </member>
  21551. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetCellComment(System.Int32,System.Int32)">
  21552. <summary>
  21553. Returns cell comment for the specified row and column
  21554. </summary>
  21555. <param name="row">The row.</param>
  21556. <param name="column">The column.</param>
  21557. <returns>cell comment or null if not found</returns>
  21558. </member>
  21559. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetConditionalFormatting">
  21560. <summary>
  21561. Gets the sheet conditional formatting.
  21562. </summary>
  21563. <value>The sheet conditional formatting.</value>
  21564. </member>
  21565. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.DVRecords">
  21566. <summary>
  21567. Get the DVRecords objects that are associated to this _sheet
  21568. </summary>
  21569. <value>a list of DVRecord instances</value>
  21570. </member>
  21571. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.Workbook">
  21572. <summary>
  21573. Provide a reference to the parent workbook.
  21574. </summary>
  21575. </member>
  21576. <member name="P:NPOI.HSSF.UserModel.HSSFSheet.SheetName">
  21577. <summary>
  21578. Returns the name of this _sheet
  21579. </summary>
  21580. </member>
  21581. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetDataValidationHelper">
  21582. <summary>
  21583. Create an instance of a DataValidationHelper.
  21584. </summary>
  21585. <returns>Instance of a DataValidationHelper</returns>
  21586. </member>
  21587. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  21588. <summary>
  21589. Enable filtering for a range of cells
  21590. </summary>
  21591. <param name="range">the range of cells to filter</param>
  21592. </member>
  21593. <member name="M:NPOI.HSSF.UserModel.HSSFSheet.GetColumnOutlineLevel(System.Int32)">
  21594. <summary>
  21595. Returns the column outline level. Increased as you
  21596. put it into more groups (outlines), reduced as
  21597. you take it out of them.
  21598. </summary>
  21599. <param name="columnIndex"></param>
  21600. <returns></returns>
  21601. </member>
  21602. <member name="T:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting">
  21603. <summary>
  21604. The Conditional Formatting facet of HSSFSheet
  21605. @author Dmitriy Kumshayev
  21606. </summary>
  21607. </member>
  21608. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  21609. <summary>
  21610. A factory method allowing to Create a conditional formatting rule
  21611. with a cell comparison operator
  21612. TODO - formulas containing cell references are currently not Parsed properly
  21613. </summary>
  21614. <param name="comparisonOperation">a constant value from HSSFConditionalFormattingRule.ComparisonOperator</param>
  21615. <param name="formula1">formula for the valued, Compared with the cell</param>
  21616. <param name="formula2">second formula (only used with HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN
  21617. and HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN operations)</param>
  21618. <returns></returns>
  21619. </member>
  21620. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  21621. <summary>
  21622. A factory method allowing to Create a conditional formatting rule with a formula.
  21623. The formatting rules are applied by Excel when the value of the formula not equal to 0.
  21624. TODO - formulas containing cell references are currently not Parsed properly
  21625. </summary>
  21626. <param name="formula">formula for the valued, Compared with the cell</param>
  21627. <returns></returns>
  21628. </member>
  21629. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  21630. <summary>
  21631. Adds a copy of HSSFConditionalFormatting object to the sheet
  21632. This method could be used to copy HSSFConditionalFormatting object
  21633. from one sheet to another.
  21634. </summary>
  21635. <param name="cf">HSSFConditionalFormatting object</param>
  21636. <returns>index of the new Conditional Formatting object</returns>
  21637. <example>
  21638. HSSFConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  21639. newSheet.AddConditionalFormatting(cf);
  21640. </example>
  21641. </member>
  21642. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  21643. <summary>
  21644. Allows to Add a new Conditional Formatting Set to the sheet.
  21645. </summary>
  21646. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  21647. <param name="cfRules">Set of up to three conditional formatting rules</param>
  21648. <returns>index of the newly Created Conditional Formatting object</returns>
  21649. </member>
  21650. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  21651. <summary>
  21652. Adds the conditional formatting.
  21653. </summary>
  21654. <param name="regions">The regions.</param>
  21655. <param name="rule1">The rule1.</param>
  21656. <returns></returns>
  21657. </member>
  21658. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  21659. <summary>
  21660. Adds the conditional formatting.
  21661. </summary>
  21662. <param name="regions">The regions.</param>
  21663. <param name="rule1">The rule1.</param>
  21664. <param name="rule2">The rule2.</param>
  21665. <returns></returns>
  21666. </member>
  21667. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  21668. <summary>
  21669. Gets Conditional Formatting object at a particular index
  21670. @param index
  21671. of the Conditional Formatting object to fetch
  21672. </summary>
  21673. <param name="index">Conditional Formatting object</param>
  21674. <returns></returns>
  21675. </member>
  21676. <member name="P:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.NumConditionalFormattings">
  21677. <summary>
  21678. the number of Conditional Formatting objects of the sheet
  21679. </summary>
  21680. <value>The num conditional formattings.</value>
  21681. </member>
  21682. <member name="M:NPOI.HSSF.UserModel.HSSFSheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  21683. <summary>
  21684. Removes a Conditional Formatting object by index
  21685. </summary>
  21686. <param name="index">index of a Conditional Formatting object to Remove</param>
  21687. </member>
  21688. <member name="T:NPOI.HSSF.UserModel.HSSFSimpleShape">
  21689. <summary>
  21690. Represents a simple shape such as a line, rectangle or oval.
  21691. @author Glen Stampoultzis (glens at apache.org)
  21692. </summary>
  21693. </member>
  21694. <member name="M:NPOI.HSSF.UserModel.HSSFSimpleShape.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  21695. <summary>
  21696. Initializes a new instance of the <see cref="T:NPOI.HSSF.UserModel.HSSFSimpleShape"/> class.
  21697. </summary>
  21698. <param name="parent">The parent.</param>
  21699. <param name="anchor">The anchor.</param>
  21700. </member>
  21701. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.ShapeType">
  21702. <summary>
  21703. Gets the shape type.
  21704. </summary>
  21705. <value>One of the OBJECT_TYPE_* constants.</value>
  21706. @see #OBJECT_TYPE_LINE
  21707. @see #OBJECT_TYPE_OVAL
  21708. @see #OBJECT_TYPE_RECTANGLE
  21709. @see #OBJECT_TYPE_PICTURE
  21710. @see #OBJECT_TYPE_COMMENT
  21711. </member>
  21712. <member name="P:NPOI.HSSF.UserModel.HSSFSimpleShape.String">
  21713. <summary>
  21714. Get or set the rich text string used by this object.
  21715. </summary>
  21716. </member>
  21717. <member name="T:NPOI.HSSF.UserModel.HSSFTextbox">
  21718. <summary>
  21719. A textbox Is a shape that may hold a rich text string.
  21720. @author Glen Stampoultzis (glens at apache.org)
  21721. </summary>
  21722. </member>
  21723. <member name="M:NPOI.HSSF.UserModel.HSSFTextbox.#ctor(NPOI.HSSF.UserModel.HSSFShape,NPOI.HSSF.UserModel.HSSFAnchor)">
  21724. <summary>
  21725. Construct a new textbox with the given parent and anchor.
  21726. </summary>
  21727. <param name="parent">The parent.</param>
  21728. <param name="anchor">One of HSSFClientAnchor or HSSFChildAnchor</param>
  21729. </member>
  21730. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginLeft">
  21731. <summary>
  21732. Gets or sets the left margin within the textbox.
  21733. </summary>
  21734. <value>The margin left.</value>
  21735. </member>
  21736. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginRight">
  21737. <summary>
  21738. Gets or sets the right margin within the textbox.
  21739. </summary>
  21740. <value>The margin right.</value>
  21741. </member>
  21742. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginTop">
  21743. <summary>
  21744. Gets or sets the top margin within the textbox
  21745. </summary>
  21746. <value>The top margin.</value>
  21747. </member>
  21748. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.MarginBottom">
  21749. <summary>
  21750. Gets or sets the bottom margin within the textbox.
  21751. </summary>
  21752. <value>The margin bottom.</value>
  21753. </member>
  21754. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.HorizontalAlignment">
  21755. <summary>
  21756. Gets or sets the horizontal alignment.
  21757. </summary>
  21758. <value>The horizontal alignment.</value>
  21759. </member>
  21760. <member name="P:NPOI.HSSF.UserModel.HSSFTextbox.VerticalAlignment">
  21761. <summary>
  21762. Gets or sets the vertical alignment.
  21763. </summary>
  21764. <value>The vertical alignment.</value>
  21765. </member>
  21766. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook">
  21767. <summary>
  21768. High level representation of a workbook. This is the first object most users
  21769. will construct whether they are reading or writing a workbook. It is also the
  21770. top level object for creating new sheets/etc.
  21771. </summary>
  21772. @author Andrew C. Oliver (acoliver at apache dot org)
  21773. @author Glen Stampoultzis (glens at apache.org)
  21774. @author Shawn Laubach (slaubach at apache dot org)
  21775. </member>
  21776. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.MAX_STYLES">
  21777. The maximum number of cell styles in a .xls workbook.
  21778. The 'official' limit is 4,000, but POI allows a slightly larger number.
  21779. This extra delta takes into account built-in styles that are automatically
  21780. created for new workbooks
  21781. See http://office.microsoft.com/en-us/excel-help/excel-specifications-and-limits-HP005199291.aspx
  21782. </member>
  21783. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.INITIAL_CAPACITY">
  21784. used for compile-time performance/memory optimization. This determines the
  21785. initial capacity for the sheet collection. Its currently Set to 3.
  21786. Changing it in this release will decrease performance
  21787. since you're never allowed to have more or less than three sheets!
  21788. </member>
  21789. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.workbook">
  21790. this Is the reference to the low level Workbook object
  21791. </member>
  21792. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._sheets">
  21793. this holds the HSSFSheet objects attached to this workbook
  21794. </member>
  21795. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.names">
  21796. this holds the HSSFName objects attached to this workbook
  21797. </member>
  21798. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.preserveNodes">
  21799. holds whether or not to preserve other nodes in the POIFS. Used
  21800. for macros and embedded objects.
  21801. </member>
  21802. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.formatter">
  21803. Used to keep track of the data formatter so that all
  21804. CreateDataFormatter calls return the same one for a given
  21805. book. This Ensures that updates from one places Is visible
  21806. someplace else.
  21807. </member>
  21808. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.fonts">
  21809. this holds the HSSFFont objects attached to this workbook.
  21810. We only create these from the low level records as required.
  21811. </member>
  21812. <member name="T:NPOI.HSSF.UserModel.HSSFWorkbook.SheetRecordCollector">
  21813. <summary>
  21814. Totals the sizes of all sheet records and eventually serializes them
  21815. </summary>
  21816. </member>
  21817. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor">
  21818. <summary>
  21819. Creates new HSSFWorkbook from scratch (start here!)
  21820. </summary>
  21821. </member>
  21822. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  21823. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the
  21824. POI filesystem around your inputstream, including all nodes.
  21825. This calls {@link #HSSFWorkbook(InputStream, boolean)} with
  21826. preserve nodes set to true.
  21827. @see #HSSFWorkbook(InputStream, boolean)
  21828. @see #HSSFWorkbook(POIFSFileSystem)
  21829. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  21830. @exception IOException if the stream cannot be read
  21831. </member>
  21832. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  21833. <summary>
  21834. given a POI POIFSFileSystem object, Read in its Workbook and populate the high and
  21835. low level models. If you're Reading in a workbook...start here.
  21836. </summary>
  21837. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  21838. <param name="preserveNodes">whether to preseve other nodes, such as
  21839. macros. This takes more memory, so only say yes if you
  21840. need to. If Set, will store all of the POIFSFileSystem
  21841. in memory</param>
  21842. </member>
  21843. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.WORKBOOK_DIR_ENTRY_NAMES">
  21844. Normally, the Workbook will be in a POIFS Stream
  21845. called "Workbook". However, some weird XLS generators use "WORKBOOK"
  21846. </member>
  21847. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Boolean)">
  21848. <summary>
  21849. given a POI POIFSFileSystem object, and a specific directory
  21850. within it, Read in its Workbook and populate the high and
  21851. low level models. If you're Reading in a workbook...start here.
  21852. </summary>
  21853. <param name="directory">the POI filesystem directory to Process from</param>
  21854. <param name="fs">the POI filesystem that Contains the Workbook stream.</param>
  21855. <param name="preserveNodes">whether to preseve other nodes, such as
  21856. macros. This takes more memory, so only say yes if you
  21857. need to. If Set, will store all of the POIFSFileSystem
  21858. in memory</param>
  21859. </member>
  21860. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,System.Boolean)">
  21861. given a POI POIFSFileSystem object, and a specific directory
  21862. within it, read in its Workbook and populate the high and
  21863. low level models. If you're reading in a workbook...start here.
  21864. @param directory the POI filesystem directory to process from
  21865. @param preserveNodes whether to preseve other nodes, such as
  21866. macros. This takes more memory, so only say yes if you
  21867. need to. If set, will store all of the POIFSFileSystem
  21868. in memory
  21869. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  21870. @exception IOException if the stream cannot be read
  21871. </member>
  21872. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.#ctor(System.IO.Stream,System.Boolean)">
  21873. Companion to HSSFWorkbook(POIFSFileSystem), this constructs the POI filesystem around your
  21874. inputstream.
  21875. @param s the POI filesystem that Contains the Workbook stream.
  21876. @param preserveNodes whether to preseve other nodes, such as
  21877. macros. This takes more memory, so only say yes if you
  21878. need to.
  21879. @see org.apache.poi.poifs.filesystem.POIFSFileSystem
  21880. @see #HSSFWorkbook(POIFSFileSystem)
  21881. @exception IOException if the stream cannot be Read
  21882. </member>
  21883. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPropertiesFromWorkbook(NPOI.HSSF.Model.InternalWorkbook)">
  21884. used internally to Set the workbook properties.
  21885. </member>
  21886. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ConvertLabelRecords(System.Collections.IList,System.Int32)">
  21887. <summary>
  21888. This is basically a kludge to deal with the now obsolete Label records. If
  21889. you have to read in a sheet that contains Label records, be aware that the rest
  21890. of the API doesn't deal with them, the low level structure only provides Read-only
  21891. semi-immutable structures (the Sets are there for interface conformance with NO
  21892. impelmentation). In short, you need to call this function passing it a reference
  21893. to the Workbook object. All labels will be converted to LabelSST records and their
  21894. contained strings will be written to the Shared String tabel (SSTRecord) within
  21895. the Workbook.
  21896. </summary>
  21897. <param name="records">The records.</param>
  21898. <param name="offset">The offset.</param>
  21899. </member>
  21900. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.MissingCellPolicy">
  21901. <summary>
  21902. Retrieves the current policy on what to do when
  21903. getting missing or blank cells from a row.
  21904. The default is to return blank and null cells.
  21905. </summary>
  21906. <value>The missing cell policy.</value>
  21907. </member>
  21908. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetOrder(System.String,System.Int32)">
  21909. <summary>
  21910. Sets the order of appearance for a given sheet.
  21911. </summary>
  21912. <param name="sheetname">the name of the sheet to reorder</param>
  21913. <param name="pos">the position that we want to Insert the sheet into (0 based)</param>
  21914. </member>
  21915. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ValidateSheetIndex(System.Int32)">
  21916. <summary>
  21917. Validates the index of the sheet.
  21918. </summary>
  21919. <param name="index">The index.</param>
  21920. </member>
  21921. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.InsertChartRecord">
  21922. Test only. Do not use
  21923. </member>
  21924. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTab(System.Int32)">
  21925. <summary>
  21926. Selects a single sheet. This may be different to
  21927. the 'active' sheet (which Is the sheet with focus).
  21928. </summary>
  21929. <param name="index">The index.</param>
  21930. </member>
  21931. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSelectedTabs(System.Int32[])">
  21932. <summary>
  21933. Sets the selected tabs.
  21934. </summary>
  21935. <param name="indexes">The indexes.</param>
  21936. </member>
  21937. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ActiveSheetIndex">
  21938. <summary>
  21939. Gets the tab whose data is actually seen when the sheet is opened.
  21940. This may be different from the "selected sheet" since excel seems to
  21941. allow you to show the data of one sheet when another Is seen "selected"
  21942. in the tabs (at the bottom).
  21943. </summary>
  21944. </member>
  21945. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetActiveSheet(System.Int32)">
  21946. <summary>
  21947. Sets the tab whose data is actually seen when the sheet is opened.
  21948. This may be different from the "selected sheet" since excel seems to
  21949. allow you to show the data of one sheet when another Is seen "selected"
  21950. in the tabs (at the bottom).
  21951. <param name="index">The sheet number(0 based).</param>
  21952. </summary>
  21953. </member>
  21954. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.FirstVisibleTab">
  21955. <summary>
  21956. Gets or sets the first tab that is displayed in the list of tabs
  21957. in excel.
  21958. </summary>
  21959. </member>
  21960. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_COMPRESSED_UNICODE">
  21961. @deprecated POI will now properly handle Unicode strings without
  21962. forceing an encoding
  21963. </member>
  21964. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook.ENCODING_UTF_16">
  21965. @deprecated POI will now properly handle Unicode strings without
  21966. forceing an encoding
  21967. </member>
  21968. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetName(System.Int32,System.String)">
  21969. <summary>
  21970. Set the sheet name.
  21971. </summary>
  21972. <param name="sheetIx">The sheet number(0 based).</param>
  21973. <param name="name">The name.</param>
  21974. </member>
  21975. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetName(System.Int32)">
  21976. <summary>
  21977. Get the sheet name
  21978. </summary>
  21979. <param name="sheetIx">The sheet index.</param>
  21980. <returns>Sheet name</returns>
  21981. </member>
  21982. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetHidden(System.Int32)">
  21983. <summary>
  21984. Check whether a sheet is hidden
  21985. </summary>
  21986. <param name="sheetIx">The sheet index.</param>
  21987. <returns>
  21988. <c>true</c> if sheet is hidden; otherwise, <c>false</c>.
  21989. </returns>
  21990. </member>
  21991. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.IsSheetVeryHidden(System.Int32)">
  21992. <summary>
  21993. Check whether a sheet is very hidden.
  21994. This is different from the normal
  21995. hidden status
  21996. </summary>
  21997. <param name="sheetIx">The sheet index.</param>
  21998. <returns>
  21999. <c>true</c> if sheet is very hidden; otherwise, <c>false</c>.
  22000. </returns>
  22001. </member>
  22002. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  22003. <summary>
  22004. Hide or Unhide a sheet
  22005. </summary>
  22006. <param name="sheetIx">The sheet index</param>
  22007. <param name="hidden">True to mark the sheet as hidden, false otherwise</param>
  22008. </member>
  22009. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  22010. <summary>
  22011. Hide or unhide a sheet.
  22012. </summary>
  22013. <param name="sheetIx">The sheet number</param>
  22014. <param name="hidden">0 for not hidden, 1 for hidden, 2 for very hidden</param>
  22015. </member>
  22016. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(System.String)">
  22017. <summary>
  22018. Returns the index of the sheet by his name
  22019. </summary>
  22020. <param name="name">the sheet name</param>
  22021. <returns>index of the sheet (0 based)</returns>
  22022. </member>
  22023. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  22024. <summary>
  22025. Returns the index of the given sheet
  22026. </summary>
  22027. <param name="sheet">the sheet to look up</param>
  22028. <returns>index of the sheet (0 based).-1
  22029. if not found </returns>
  22030. </member>
  22031. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetExternalSheetIndex(System.Int32)">
  22032. <summary>
  22033. Returns the external sheet index of the sheet
  22034. with the given internal index, creating one
  22035. if needed.
  22036. Used by some of the more obscure formula and
  22037. named range things.
  22038. </summary>
  22039. <param name="internalSheetIndex">Index of the internal sheet.</param>
  22040. <returns></returns>
  22041. </member>
  22042. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet">
  22043. <summary>
  22044. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and returns
  22045. the high level representation. Use this to Create new sheets.
  22046. </summary>
  22047. <returns>HSSFSheet representing the new sheet.</returns>
  22048. </member>
  22049. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CloneSheet(System.Int32)">
  22050. <summary>
  22051. Create an HSSFSheet from an existing sheet in the HSSFWorkbook.
  22052. </summary>
  22053. <param name="sheetIndex">the sheet index</param>
  22054. <returns>HSSFSheet representing the Cloned sheet.</returns>
  22055. </member>
  22056. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetUniqueSheetName(System.String)">
  22057. <summary>
  22058. Gets the name of the unique sheet.
  22059. </summary>
  22060. <param name="srcName">Name of the SRC.</param>
  22061. <returns></returns>
  22062. </member>
  22063. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateSheet(System.String)">
  22064. <summary>
  22065. Create an HSSFSheet for this HSSFWorkbook, Adds it to the sheets and
  22066. returns the high level representation. Use this to Create new sheets.
  22067. </summary>
  22068. <param name="sheetname">sheetname to set for the sheet.</param>
  22069. <returns>HSSFSheet representing the new sheet.</returns>
  22070. </member>
  22071. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfSheets">
  22072. <summary>
  22073. Get the number of spreadsheets in the workbook (this will be three after serialization)
  22074. </summary>
  22075. <value>The number of sheets.</value>
  22076. </member>
  22077. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheets">
  22078. <summary>
  22079. Gets the sheets.
  22080. </summary>
  22081. <returns></returns>
  22082. </member>
  22083. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheetAt(System.Int32)">
  22084. <summary>
  22085. Get the HSSFSheet object at the given index.
  22086. </summary>
  22087. <param name="index">index of the sheet number (0-based)</param>
  22088. <returns>HSSFSheet at the provided index</returns>
  22089. </member>
  22090. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetSheet(System.String)">
  22091. <summary>
  22092. Get sheet with the given name (case insensitive match)
  22093. </summary>
  22094. <param name="name">name of the sheet</param>
  22095. <returns>HSSFSheet with the name provided or null if it does not exist</returns>
  22096. </member>
  22097. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveSheetAt(System.Int32)">
  22098. <summary>
  22099. Removes sheet at the given index.
  22100. </summary>
  22101. <param name="index">index of the sheet (0-based)</param>
  22102. <remarks>
  22103. Care must be taken if the Removed sheet Is the currently active or only selected sheet in
  22104. the workbook. There are a few situations when Excel must have a selection and/or active
  22105. sheet. (For example when printing - see Bug 40414).
  22106. This method makes sure that if the Removed sheet was active, another sheet will become
  22107. active in its place. Furthermore, if the Removed sheet was the only selected sheet, another
  22108. sheet will become selected. The newly active/selected sheet will have the same index, or
  22109. one less if the Removed sheet was the last in the workbook.
  22110. </remarks>
  22111. </member>
  22112. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.BackupFlag">
  22113. <summary>
  22114. determine whether the Excel GUI will backup the workbook when saving.
  22115. </summary>
  22116. <value>the current Setting for backups.</value>
  22117. </member>
  22118. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  22119. <summary>
  22120. Sets the repeating rows and columns for a sheet (as found in
  22121. File-&gt;PageSetup-&gt;Sheet). This Is function Is included in the workbook
  22122. because it Creates/modifies name records which are stored at the
  22123. workbook level.
  22124. </summary>
  22125. <param name="sheetIndex">0 based index to sheet.</param>
  22126. <param name="startColumn">0 based start of repeating columns.</param>
  22127. <param name="endColumn">0 based end of repeating columns.</param>
  22128. <param name="startRow">0 based start of repeating rows.</param>
  22129. <param name="endRow">0 based end of repeating rows.</param>
  22130. <example>
  22131. To set just repeating columns:
  22132. workbook.SetRepeatingRowsAndColumns(0,0,1,-1-1);
  22133. To set just repeating rows:
  22134. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  22135. To remove all repeating rows and columns for a sheet.
  22136. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  22137. </example>
  22138. </member>
  22139. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateFont">
  22140. <summary>
  22141. Create a new Font and Add it to the workbook's font table
  22142. </summary>
  22143. <returns>new font object</returns>
  22144. </member>
  22145. <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)">
  22146. <summary>
  22147. Finds a font that matches the one with the supplied attributes
  22148. </summary>
  22149. <param name="boldWeight">The bold weight.</param>
  22150. <param name="color">The color.</param>
  22151. <param name="fontHeight">Height of the font.</param>
  22152. <param name="name">The name.</param>
  22153. <param name="italic">if set to <c>true</c> [italic].</param>
  22154. <param name="strikeout">if set to <c>true</c> [strikeout].</param>
  22155. <param name="typeOffset">The type offset.</param>
  22156. <param name="underline">The underline.</param>
  22157. <returns></returns>
  22158. </member>
  22159. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfFonts">
  22160. <summary>
  22161. Get the number of fonts in the font table
  22162. </summary>
  22163. <value>The number of fonts.</value>
  22164. </member>
  22165. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetFontAt(System.Int16)">
  22166. <summary>
  22167. Get the font at the given index number
  22168. </summary>
  22169. <param name="idx">The index number</param>
  22170. <returns>HSSFFont at the index</returns>
  22171. </member>
  22172. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResetFontCache">
  22173. <summary>
  22174. Reset the fonts cache, causing all new calls
  22175. to getFontAt() to create new objects.
  22176. Should only be called after deleting fonts,
  22177. and that's not something you should normally do
  22178. </summary>
  22179. </member>
  22180. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateCellStyle">
  22181. <summary>
  22182. Create a new Cell style and Add it to the workbook's style table
  22183. </summary>
  22184. <returns>the new Cell Style object</returns>
  22185. </member>
  22186. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumCellStyles">
  22187. <summary>
  22188. Get the number of styles the workbook Contains
  22189. </summary>
  22190. <value>count of cell styles</value>
  22191. </member>
  22192. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetCellStyleAt(System.Int16)">
  22193. <summary>
  22194. Get the cell style object at the given index
  22195. </summary>
  22196. <param name="idx">index within the Set of styles</param>
  22197. <returns>HSSFCellStyle object at the index</returns>
  22198. </member>
  22199. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Close">
  22200. Closes the underlying {@link NPOIFSFileSystem} from which
  22201. the Workbook was read, if any. Has no effect on Workbooks
  22202. opened from an InputStream, or newly created ones.
  22203. </member>
  22204. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.Write(System.IO.Stream)">
  22205. <summary>
  22206. Write out this workbook to an Outputstream. Constructs
  22207. a new POI POIFSFileSystem, passes in the workbook binary representation and
  22208. Writes it out.
  22209. </summary>
  22210. <param name="stream">the java OutputStream you wish to Write the XLS to</param>
  22211. </member>
  22212. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetBytes">
  22213. <summary>
  22214. Get the bytes of just the HSSF portions of the XLS file.
  22215. Use this to construct a POI POIFSFileSystem yourself.
  22216. </summary>
  22217. <returns>byte[] array containing the binary representation of this workbook and all contained
  22218. sheets, rows, cells, etc.</returns>
  22219. </member>
  22220. <member name="F:NPOI.HSSF.UserModel.HSSFWorkbook._udfFinder">
  22221. The locator of user-defined functions.
  22222. By default includes functions from the Excel Analysis Toolpack
  22223. </member>
  22224. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  22225. Register a new toolpack in this workbook.
  22226. @param toopack the toolpack to register
  22227. </member>
  22228. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.Workbook">
  22229. <summary>
  22230. Gets the workbook.
  22231. </summary>
  22232. <value>The workbook.</value>
  22233. </member>
  22234. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NumberOfNames">
  22235. <summary>
  22236. Gets the total number of named ranges in the workboko
  22237. </summary>
  22238. <value>The number of named ranges</value>
  22239. </member>
  22240. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameAt(System.Int32)">
  22241. <summary>
  22242. Gets the Named range
  22243. </summary>
  22244. <param name="nameIndex">position of the named range</param>
  22245. <returns>named range high level</returns>
  22246. </member>
  22247. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameName(System.Int32)">
  22248. <summary>
  22249. Gets the named range name
  22250. </summary>
  22251. <param name="index">the named range index (0 based)</param>
  22252. <returns>named range name</returns>
  22253. </member>
  22254. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ResolveNameXText(System.Int32,System.Int32)">
  22255. <summary>
  22256. TODO - make this less cryptic / move elsewhere
  22257. </summary>
  22258. <param name="reFindex">Index to REF entry in EXTERNSHEET record in the Link Table</param>
  22259. <param name="definedNameIndex">zero-based to DEFINEDNAME or EXTERNALNAME record</param>
  22260. <returns>the string representation of the defined or external name</returns>
  22261. </member>
  22262. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.String)">
  22263. <summary>
  22264. Sets the printarea for the sheet provided
  22265. i.e. Reference = $A$1:$B$2
  22266. </summary>
  22267. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  22268. <param name="reference">Valid name Reference for the Print Area</param>
  22269. </member>
  22270. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  22271. <summary>
  22272. Sets the print area.
  22273. </summary>
  22274. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  22275. <param name="startColumn">Column to begin printarea</param>
  22276. <param name="endColumn">Column to end the printarea</param>
  22277. <param name="startRow">Row to begin the printarea</param>
  22278. <param name="endRow">Row to end the printarea</param>
  22279. </member>
  22280. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetPrintArea(System.Int32)">
  22281. <summary>
  22282. Retrieves the reference for the printarea of the specified sheet, the sheet name Is Appended to the reference even if it was not specified.
  22283. </summary>
  22284. <param name="sheetIndex">Zero-based sheet index (0 Represents the first sheet to keep consistent with java)</param>
  22285. <returns>String Null if no print area has been defined</returns>
  22286. </member>
  22287. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemovePrintArea(System.Int32)">
  22288. <summary>
  22289. Delete the printarea for the sheet specified
  22290. </summary>
  22291. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  22292. </member>
  22293. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateName">
  22294. <summary>
  22295. Creates a new named range and Add it to the model
  22296. </summary>
  22297. <returns>named range high level</returns>
  22298. </member>
  22299. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(System.String)">
  22300. <summary>
  22301. Gets the named range index by his name
  22302. Note:
  22303. Excel named ranges are case-insensitive and
  22304. this method performs a case-insensitive search.
  22305. </summary>
  22306. <param name="name">named range name</param>
  22307. <returns>named range index</returns>
  22308. </member>
  22309. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetNameIndex(NPOI.HSSF.UserModel.HSSFName)">
  22310. <summary>
  22311. As GetNameIndex(String) is not necessarily unique
  22312. (name + sheet index is unique), this method is more accurate.
  22313. </summary>
  22314. <param name="name">the name whose index in the list of names of this workbook should be looked up.</param>
  22315. <returns>an index value >= 0 if the name was found; -1, if the name was not found</returns>
  22316. </member>
  22317. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.Int32)">
  22318. <summary>
  22319. Remove the named range by his index
  22320. </summary>
  22321. <param name="index">The named range index (0 based)</param>
  22322. </member>
  22323. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.CreateDataFormat">
  22324. <summary>
  22325. Creates the instance of HSSFDataFormat for this workbook.
  22326. </summary>
  22327. <returns>the HSSFDataFormat object</returns>
  22328. </member>
  22329. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(System.String)">
  22330. <summary>
  22331. Remove the named range by his name
  22332. </summary>
  22333. <param name="name">named range name</param>
  22334. </member>
  22335. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.RemoveName(NPOI.HSSF.UserModel.HSSFName)">
  22336. <summary>
  22337. As #removeName(String) is not necessarily unique (name + sheet index is unique),
  22338. this method is more accurate.
  22339. </summary>
  22340. <param name="name">the name to remove.</param>
  22341. </member>
  22342. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.DumpDrawingGroupRecords(System.Boolean)">
  22343. <summary>
  22344. Spits out a list of all the drawing records in the workbook.
  22345. </summary>
  22346. <param name="fat">if set to <c>true</c> [fat].</param>
  22347. </member>
  22348. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  22349. <summary>
  22350. Adds a picture to the workbook.
  22351. </summary>
  22352. <param name="pictureData">The bytes of the picture</param>
  22353. <param name="format">The format of the picture. One of
  22354. PictureType.</param>
  22355. <returns>the index to this picture (1 based).</returns>
  22356. </member>
  22357. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllPictures">
  22358. <summary>
  22359. Gets all pictures from the Workbook.
  22360. </summary>
  22361. <returns>the list of pictures (a list of HSSFPictureData objects.)</returns>
  22362. </member>
  22363. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.SearchForPictures(System.Collections.IList,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFPictureData})">
  22364. <summary>
  22365. Performs a recursive search for pictures in the given list of escher records.
  22366. </summary>
  22367. <param name="escherRecords">the escher records.</param>
  22368. <param name="pictures">the list to populate with the pictures.</param>
  22369. </member>
  22370. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  22371. <summary>
  22372. Adds the LinkTable records required to allow formulas referencing
  22373. the specified external workbook to be added to this one. Allows
  22374. formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the
  22375. file, for workbooks not already referenced.
  22376. </summary>
  22377. <param name="name">The name the workbook will be referenced as in formulas</param>
  22378. <param name="workbook">The open workbook to fetch the link required information from</param>
  22379. <returns></returns>
  22380. </member>
  22381. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.IsWriteProtected">
  22382. <summary>
  22383. Is the workbook protected with a password (not encrypted)?
  22384. </summary>
  22385. <value>
  22386. <c>true</c> if this instance is write protected; otherwise, <c>false</c>.
  22387. </value>
  22388. </member>
  22389. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.WriteProtectWorkbook(System.String,System.String)">
  22390. <summary>
  22391. protect a workbook with a password (not encypted, just Sets Writeprotect
  22392. flags and the password.
  22393. </summary>
  22394. <param name="password">password to set</param>
  22395. <param name="username">The username.</param>
  22396. </member>
  22397. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.UnwriteProtectWorkbook">
  22398. <summary>
  22399. Removes the Write protect flag
  22400. </summary>
  22401. </member>
  22402. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects">
  22403. <summary>
  22404. Gets all embedded OLE2 objects from the Workbook.
  22405. </summary>
  22406. <returns>the list of embedded objects (a list of HSSFObjectData objects.)</returns>
  22407. </member>
  22408. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFSheet,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  22409. <summary>
  22410. Gets all embedded OLE2 objects from the Workbook.
  22411. </summary>
  22412. <param name="sheet">the list of records to search.</param>
  22413. <param name="objects">the list of embedded objects to populate.</param>
  22414. </member>
  22415. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetAllEmbeddedObjects(NPOI.HSSF.UserModel.HSSFShapeContainer,System.Collections.Generic.List{NPOI.HSSF.UserModel.HSSFObjectData})">
  22416. <summary>
  22417. Recursively iterates a shape container to get all embedded objects.
  22418. </summary>
  22419. <param name="parent">the parent.</param>
  22420. <param name="objects">the list of embedded objects to populate.</param>
  22421. </member>
  22422. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.NewUID">
  22423. <summary>
  22424. Gets the new UID.
  22425. </summary>
  22426. <value>The new UID.</value>
  22427. </member>
  22428. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.GetEnumerator">
  22429. <summary>
  22430. Support foreach ISheet, e.g.
  22431. HSSFWorkbook workbook = new HSSFWorkbook();
  22432. foreach(ISheet sheet in workbook) ...
  22433. </summary>
  22434. <returns>Enumeration of all the sheets of this workbook</returns>
  22435. </member>
  22436. <member name="P:NPOI.HSSF.UserModel.HSSFWorkbook.ForceFormulaRecalculation">
  22437. <summary>
  22438. Whether the application shall perform a full recalculation when the workbook is opened.
  22439. Typically you want to force formula recalculation when you modify cell formulas or values
  22440. of a workbook previously created by Excel. When set to true, this flag will tell Excel
  22441. that it needs to recalculate all formulas in the workbook the next time the file is opened.
  22442. Note, that recalculation updates cached formula results and, thus, modifies the workbook.
  22443. Depending on the version, Excel may prompt you with "Do you want to save the changes in <em>filename</em>?"
  22444. on close.
  22445. Value is true if the application will perform a full recalculation of
  22446. workbook values when the workbook is opened.
  22447. since 3.8
  22448. </summary>
  22449. </member>
  22450. <member name="M:NPOI.HSSF.UserModel.HSSFWorkbook.ChangeExternalReference(System.String,System.String)">
  22451. Changes an external referenced file to another file.
  22452. A formular in Excel which refers a cell in another file is saved in two parts:
  22453. The referenced file is stored in an reference table. the row/cell information is saved separate.
  22454. This method invokation will only change the reference in the lookup-table itself.
  22455. @param oldUrl The old URL to search for and which is to be replaced
  22456. @param newUrl The URL replacement
  22457. @return true if the oldUrl was found and replaced with newUrl. Otherwise false
  22458. </member>
  22459. <member name="T:NPOI.HSSF.UserModel.OperationEvaluatorFactory">
  22460. This class Creates <c>OperationEval</c> instances to help evaluate <c>OperationPtg</c>
  22461. formula tokens.
  22462. @author Josh Micich
  22463. </member>
  22464. <member name="M:NPOI.HSSF.UserModel.OperationEvaluatorFactory.Create(NPOI.SS.Formula.PTG.OperationPtg)">
  22465. returns the OperationEval concrete impl instance corresponding
  22466. to the supplied operationPtg
  22467. </member>
  22468. <member name="T:NPOI.HSSF.UserModel.StaticFontMetrics">
  22469. Allows the user to lookup the font metrics for a particular font without
  22470. actually having the font on the system. The font details are Loaded
  22471. as a resource from the POI jar file (or classpath) and should be contained
  22472. in path "/font_metrics.properties". The font widths are for a 10 point
  22473. version of the font. Use a multiplier for other sizes.
  22474. @author Glen Stampoultzis (glens at apache.org)
  22475. </member>
  22476. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontMetricsProps">
  22477. The font metrics property file we're using
  22478. </member>
  22479. <member name="F:NPOI.HSSF.UserModel.StaticFontMetrics.fontDetailsMap">
  22480. Our cache of font details we've alReady looked up
  22481. </member>
  22482. <member name="M:NPOI.HSSF.UserModel.StaticFontMetrics.GetFontDetails(System.Drawing.Font)">
  22483. Retrieves the fake font details for a given font.
  22484. @param font the font to lookup.
  22485. @return the fake font.
  22486. </member>
  22487. <member name="F:NPOI.HSSF.Util.GUID._d1">
  22488. 4 bytes - little endian
  22489. </member>
  22490. <member name="F:NPOI.HSSF.Util.GUID._d2">
  22491. 2 bytes - little endian
  22492. </member>
  22493. <member name="F:NPOI.HSSF.Util.GUID._d3">
  22494. 2 bytes - little endian
  22495. </member>
  22496. <member name="F:NPOI.HSSF.Util.GUID._d4">
  22497. 8 bytes - serialized as big endian, stored with inverted endianness here
  22498. </member>
  22499. <member name="M:NPOI.HSSF.Util.GUID.Parse(System.String)">
  22500. Read a GUID in standard text form e.g.<br/>
  22501. 13579BDF-0246-8ACE-0123-456789ABCDEF
  22502. <br/> -&gt; <br/>
  22503. 0x13579BDF, 0x0246, 0x8ACE 0x0123456789ABCDEF
  22504. </member>
  22505. <member name="T:NPOI.HSSF.Util.HSSFCellRangeAddress">
  22506. <p>Title: HSSFCellRangeAddress</p>
  22507. <p>Description:
  22508. Implementation of the cell range Address lists,like Is described in
  22509. OpenOffice.org's Excel Documentation .
  22510. In BIFF8 there Is a common way to store absolute cell range Address
  22511. lists in several records (not formulas). A cell range Address list
  22512. consists of a field with the number of ranges and the list of the range
  22513. Addresses. Each cell range Address (called an AddR structure) Contains
  22514. 4 16-bit-values.</p>
  22515. <p>Copyright: Copyright (c) 2004</p>
  22516. <p>Company: </p>
  22517. @author Dragos Buleandra (dragos.buleandra@trade2b.ro)
  22518. @version 2.0-pre
  22519. </member>
  22520. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_Addr_number">
  22521. Number of following AddR structures
  22522. </member>
  22523. <member name="F:NPOI.HSSF.Util.HSSFCellRangeAddress.field_regions_list">
  22524. List of AddR structures. Each structure represents a cell range
  22525. </member>
  22526. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  22527. Construct a new HSSFCellRangeAddress object and Sets its fields appropriately .
  22528. Even this Isn't an Excel record , I kept the same behavior for reading/writing
  22529. the object's data as for a regular record .
  22530. @param in the RecordInputstream to read the record from
  22531. </member>
  22532. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddRStructureNumber">
  22533. Get the number of following AddR structures.
  22534. The number of this structures Is automatically Set when reading an Excel file
  22535. and/or increased when you manually Add a new AddR structure .
  22536. This Is the reason there Isn't a Set method for this field .
  22537. @return number of AddR structures
  22538. </member>
  22539. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.AddAddRStructure(System.Int16,System.Int16,System.Int16,System.Int16)">
  22540. Add an AddR structure .
  22541. @param first_row - the upper left hand corner's row
  22542. @param first_col - the upper left hand corner's col
  22543. @param last_row - the lower right hand corner's row
  22544. @param last_col - the lower right hand corner's col
  22545. @return the index of this AddR structure
  22546. </member>
  22547. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.RemoveAddRStructureAt(System.Int32)">
  22548. Remove the AddR structure stored at the passed in index
  22549. @param index The AddR structure's index
  22550. </member>
  22551. <member name="M:NPOI.HSSF.Util.HSSFCellRangeAddress.GetAddRStructureAt(System.Int32)">
  22552. return the AddR structure at the given index.
  22553. @return AddrStructure representing
  22554. </member>
  22555. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstColumn">
  22556. Get the upper left hand corner column number
  22557. @return column number for the upper left hand corner
  22558. </member>
  22559. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.FirstRow">
  22560. Get the upper left hand corner row number
  22561. @return row number for the upper left hand corner
  22562. </member>
  22563. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastColumn">
  22564. Get the lower right hand corner column number
  22565. @return column number for the lower right hand corner
  22566. </member>
  22567. <member name="P:NPOI.HSSF.Util.HSSFCellRangeAddress.AddrStructure.LastRow">
  22568. Get the lower right hand corner row number
  22569. @return row number for the lower right hand corner
  22570. </member>
  22571. <member name="T:NPOI.HSSF.Util.HSSFCellUtil">
  22572. <summary>
  22573. Various utility functions that make working with a cells and rows easier. The various
  22574. methods that deal with style's allow you to Create your HSSFCellStyles as you need them.
  22575. When you apply a style change to a cell, the code will attempt to see if a style already
  22576. exists that meets your needs. If not, then it will Create a new style. This is to prevent
  22577. creating too many styles. there is an upper limit in Excel on the number of styles that
  22578. can be supported.
  22579. @author Eric Pugh epugh@upstate.com
  22580. </summary>
  22581. </member>
  22582. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetRow(System.Int32,NPOI.HSSF.UserModel.HSSFSheet)">
  22583. <summary>
  22584. Get a row from the spreadsheet, and Create it if it doesn't exist.
  22585. </summary>
  22586. <param name="rowCounter">The 0 based row number</param>
  22587. <param name="sheet">The sheet that the row is part of.</param>
  22588. <returns>The row indicated by the rowCounter</returns>
  22589. </member>
  22590. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  22591. <summary>
  22592. Get a specific cell from a row. If the cell doesn't exist,
  22593. </summary>
  22594. <param name="row">The row that the cell is part of</param>
  22595. <param name="column">The column index that the cell is in.</param>
  22596. <returns>The cell indicated by the column.</returns>
  22597. </member>
  22598. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.HSSF.UserModel.HSSFCellStyle)">
  22599. <summary>
  22600. Creates a cell, gives it a value, and applies a style if provided
  22601. </summary>
  22602. <param name="row">the row to Create the cell in</param>
  22603. <param name="column">the column index to Create the cell in</param>
  22604. <param name="value">The value of the cell</param>
  22605. <param name="style">If the style is not null, then Set</param>
  22606. <returns>A new HSSFCell</returns>
  22607. </member>
  22608. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  22609. <summary>
  22610. Create a cell, and give it a value.
  22611. </summary>
  22612. <param name="row">the row to Create the cell in</param>
  22613. <param name="column">the column index to Create the cell in</param>
  22614. <param name="value">The value of the cell</param>
  22615. <returns>A new HSSFCell.</returns>
  22616. </member>
  22617. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.RemapCellStyle(NPOI.HSSF.UserModel.HSSFCellStyle,System.Collections.Generic.Dictionary{System.Int16,System.Int16})">
  22618. <summary>
  22619. Translate color palette entries from the source to the destination sheet
  22620. </summary>
  22621. </member>
  22622. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.Int16)">
  22623. <summary>
  22624. Take a cell, and align it.
  22625. </summary>
  22626. <param name="cell">the cell to Set the alignment for</param>
  22627. <param name="workbook">The workbook that is being worked with.</param>
  22628. <param name="align">the column alignment to use.</param>
  22629. </member>
  22630. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,NPOI.HSSF.UserModel.HSSFFont)">
  22631. <summary>
  22632. Take a cell, and apply a font to it
  22633. </summary>
  22634. <param name="cell">the cell to Set the alignment for</param>
  22635. <param name="workbook">The workbook that is being worked with.</param>
  22636. <param name="font">The HSSFFont that you want to Set...</param>
  22637. </member>
  22638. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.HSSF.UserModel.HSSFWorkbook,System.String,System.Object)">
  22639. This method attempt to find an already existing HSSFCellStyle that matches
  22640. what you want the style to be. If it does not find the style, then it
  22641. Creates a new one. If it does Create a new one, then it applies the
  22642. propertyName and propertyValue to the style. This is necessary because
  22643. Excel has an upper limit on the number of Styles that it supports.
  22644. @param workbook The workbook that is being worked with.
  22645. @param propertyName The name of the property that is to be
  22646. changed.
  22647. @param propertyValue The value of the property that is to be
  22648. changed.
  22649. @param cell The cell that needs it's style changes
  22650. @exception NestableException Thrown if an error happens.
  22651. </member>
  22652. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  22653. <summary>
  22654. Returns a map containing the format properties of the given cell style.
  22655. </summary>
  22656. <param name="style">cell style</param>
  22657. <returns>map of format properties (String -&gt; Object)</returns>
  22658. </member>
  22659. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.HSSF.UserModel.HSSFWorkbook,System.Collections.Hashtable)">
  22660. <summary>
  22661. Sets the format properties of the given style based on the given map.
  22662. </summary>
  22663. <param name="style">The cell style</param>
  22664. <param name="workbook">The parent workbook.</param>
  22665. <param name="properties">The map of format properties (String -&gt; Object).</param>
  22666. </member>
  22667. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetShort(System.Collections.Hashtable,System.String)">
  22668. <summary>
  22669. Utility method that returns the named short value form the given map.
  22670. Returns zero if the property does not exist, or is not a {@link Short}.
  22671. </summary>
  22672. <param name="properties">The map of named properties (String -&gt; Object)</param>
  22673. <param name="name">The property name.</param>
  22674. <returns>property value, or zero</returns>
  22675. </member>
  22676. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.GetBoolean(System.Collections.Hashtable,System.String)">
  22677. <summary>
  22678. Utility method that returns the named boolean value form the given map.
  22679. Returns false if the property does not exist, or is not a {@link Boolean}.
  22680. </summary>
  22681. <param name="properties">map of properties (String -&gt; Object)</param>
  22682. <param name="name">The property name.</param>
  22683. <returns>property value, or false</returns>
  22684. </member>
  22685. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.PutShort(System.Collections.Hashtable,System.String,System.Int16)">
  22686. <summary>
  22687. Utility method that Puts the named short value to the given map.
  22688. </summary>
  22689. <param name="properties">The map of properties (String -&gt; Object).</param>
  22690. <param name="name">The property name.</param>
  22691. <param name="value">The property value.</param>
  22692. </member>
  22693. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.PutBoolean(System.Collections.Hashtable,System.String,System.Boolean)">
  22694. <summary>
  22695. Utility method that Puts the named boolean value to the given map.
  22696. </summary>
  22697. <param name="properties">map of properties (String -&gt; Object)</param>
  22698. <param name="name">property name</param>
  22699. <param name="value">property value</param>
  22700. </member>
  22701. <member name="M:NPOI.HSSF.Util.HSSFCellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  22702. <summary>
  22703. Looks for text in the cell that should be unicode, like alpha; and provides the
  22704. unicode version of it.
  22705. </summary>
  22706. <param name="cell">The cell to check for unicode values</param>
  22707. <returns>transalted to unicode</returns>
  22708. </member>
  22709. <member name="T:NPOI.HSSF.Util.HSSFColor">
  22710. Intends to provide support for the very evil index to triplet Issue and
  22711. will likely replace the color constants interface for HSSF 2.0.
  22712. This class Contains static inner class members for representing colors.
  22713. Each color has an index (for the standard palette in Excel (tm) ),
  22714. native (RGB) triplet and string triplet. The string triplet Is as the
  22715. color would be represented by Gnumeric. Having (string) this here Is a bit of a
  22716. collusion of function between HSSF and the HSSFSerializer but I think its
  22717. a reasonable one in this case.
  22718. @author Andrew C. Oliver (acoliver at apache dot org)
  22719. @author Brian Sanders (bsanders at risklabs dot com) - full default color palette
  22720. </member>
  22721. <member name="M:NPOI.HSSF.Util.HSSFColor.#ctor">
  22722. Creates a new instance of HSSFColor
  22723. </member>
  22724. <member name="M:NPOI.HSSF.Util.HSSFColor.GetIndexHash">
  22725. this function returns all colors in a hastable. Its not implemented as a
  22726. static member/staticly initialized because that would be dirty in a
  22727. server environment as it Is intended. This means you'll eat the time
  22728. it takes to Create it once per request but you will not hold onto it
  22729. if you have none of those requests.
  22730. @return a hashtable containing all colors keyed by <c>int</c> excel-style palette indexes
  22731. </member>
  22732. <member name="M:NPOI.HSSF.Util.HSSFColor.GetMutableIndexHash">
  22733. This function returns all the Colours, stored in a Hashtable that
  22734. can be edited. No caching is performed. If you don't need to edit
  22735. the table, then call {@link #getIndexHash()} which returns a
  22736. statically cached imuatable map of colours.
  22737. </member>
  22738. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTripletHash">
  22739. <summary>
  22740. this function returns all colors in a hastable. Its not implemented as a
  22741. static member/staticly initialized because that would be dirty in a
  22742. server environment as it Is intended. This means you'll eat the time
  22743. it takes to Create it once per request but you will not hold onto it
  22744. if you have none of those requests.
  22745. </summary>
  22746. <returns>a hashtable containing all colors keyed by String gnumeric-like triplets</returns>
  22747. </member>
  22748. <member name="P:NPOI.HSSF.Util.HSSFColor.Indexed">
  22749. @return index to the standard palette
  22750. </member>
  22751. <member name="M:NPOI.HSSF.Util.HSSFColor.GetTriplet">
  22752. @return triplet representation like that in Excel
  22753. </member>
  22754. <member name="M:NPOI.HSSF.Util.HSSFColor.GetHexString">
  22755. @return a hex string exactly like a gnumeric triplet
  22756. </member>
  22757. <member name="T:NPOI.HSSF.Util.HSSFColor.Black">
  22758. Class BLACK
  22759. </member>
  22760. <member name="T:NPOI.HSSF.Util.HSSFColor.Brown">
  22761. Class BROWN
  22762. </member>
  22763. <member name="T:NPOI.HSSF.Util.HSSFColor.OliveGreen">
  22764. Class OLIVE_GREEN
  22765. </member>
  22766. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkGreen">
  22767. Class DARK_GREEN
  22768. </member>
  22769. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkTeal">
  22770. Class DARK_TEAL
  22771. </member>
  22772. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkBlue">
  22773. Class DARK_BLUE
  22774. </member>
  22775. <member name="T:NPOI.HSSF.Util.HSSFColor.Indigo">
  22776. Class INDIGO
  22777. </member>
  22778. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey80Percent">
  22779. Class GREY_80_PERCENT
  22780. </member>
  22781. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkRed">
  22782. Class DARK_RED
  22783. </member>
  22784. <member name="T:NPOI.HSSF.Util.HSSFColor.Orange">
  22785. Class ORANGE
  22786. </member>
  22787. <member name="T:NPOI.HSSF.Util.HSSFColor.DarkYellow">
  22788. Class DARK_YELLOW
  22789. </member>
  22790. <member name="T:NPOI.HSSF.Util.HSSFColor.Green">
  22791. Class GREEN
  22792. </member>
  22793. <member name="T:NPOI.HSSF.Util.HSSFColor.Teal">
  22794. Class TEAL
  22795. </member>
  22796. <member name="T:NPOI.HSSF.Util.HSSFColor.Blue">
  22797. Class BLUE
  22798. </member>
  22799. <member name="T:NPOI.HSSF.Util.HSSFColor.BlueGrey">
  22800. Class BLUE_GREY
  22801. </member>
  22802. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey50Percent">
  22803. Class GREY_50_PERCENT
  22804. </member>
  22805. <member name="T:NPOI.HSSF.Util.HSSFColor.Red">
  22806. Class RED
  22807. </member>
  22808. <member name="T:NPOI.HSSF.Util.HSSFColor.LightOrange">
  22809. Class LIGHT_ORANGE
  22810. </member>
  22811. <member name="T:NPOI.HSSF.Util.HSSFColor.Lime">
  22812. Class LIME
  22813. </member>
  22814. <member name="T:NPOI.HSSF.Util.HSSFColor.SeaGreen">
  22815. Class SEA_GREEN
  22816. </member>
  22817. <member name="T:NPOI.HSSF.Util.HSSFColor.Aqua">
  22818. Class AQUA
  22819. </member>
  22820. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey40Percent">
  22821. Class GREY_40_PERCENT
  22822. </member>
  22823. <member name="T:NPOI.HSSF.Util.HSSFColor.Turquoise">
  22824. Class TURQUOISE
  22825. </member>
  22826. <member name="T:NPOI.HSSF.Util.HSSFColor.SkyBlue">
  22827. Class SKY_BLUE
  22828. </member>
  22829. <member name="T:NPOI.HSSF.Util.HSSFColor.Plum">
  22830. Class PLUM
  22831. </member>
  22832. <member name="T:NPOI.HSSF.Util.HSSFColor.Grey25Percent">
  22833. Class GREY_25_PERCENT
  22834. </member>
  22835. <member name="T:NPOI.HSSF.Util.HSSFColor.Rose">
  22836. Class ROSE
  22837. </member>
  22838. <member name="T:NPOI.HSSF.Util.HSSFColor.Tan">
  22839. Class TAN
  22840. </member>
  22841. <member name="T:NPOI.HSSF.Util.HSSFColor.LightYellow">
  22842. Class LIGHT_YELLOW
  22843. </member>
  22844. <member name="T:NPOI.HSSF.Util.HSSFColor.LightGreen">
  22845. Class LIGHT_GREEN
  22846. </member>
  22847. <member name="T:NPOI.HSSF.Util.HSSFColor.LightTurquoise">
  22848. Class LIGHT_TURQUOISE
  22849. </member>
  22850. <member name="T:NPOI.HSSF.Util.HSSFColor.PaleBlue">
  22851. Class PALE_BLUE
  22852. </member>
  22853. <member name="T:NPOI.HSSF.Util.HSSFColor.Lavender">
  22854. Class LAVENDER
  22855. </member>
  22856. <member name="T:NPOI.HSSF.Util.HSSFColor.White">
  22857. Class WHITE
  22858. </member>
  22859. <member name="T:NPOI.HSSF.Util.HSSFColor.CornflowerBlue">
  22860. Class CORNFLOWER_BLUE
  22861. </member>
  22862. <member name="T:NPOI.HSSF.Util.HSSFColor.LemonChiffon">
  22863. Class LEMON_CHIFFON
  22864. </member>
  22865. <member name="T:NPOI.HSSF.Util.HSSFColor.Maroon">
  22866. Class MAROON
  22867. </member>
  22868. <member name="T:NPOI.HSSF.Util.HSSFColor.Orchid">
  22869. Class ORCHID
  22870. </member>
  22871. <member name="T:NPOI.HSSF.Util.HSSFColor.Coral">
  22872. Class CORAL
  22873. </member>
  22874. <member name="T:NPOI.HSSF.Util.HSSFColor.RoyalBlue">
  22875. Class ROYAL_BLUE
  22876. </member>
  22877. <member name="T:NPOI.HSSF.Util.HSSFColor.LightCornflowerBlue">
  22878. Class LIGHT_CORNFLOWER_BLUE
  22879. </member>
  22880. <member name="T:NPOI.HSSF.Util.HSSFColor.Automatic">
  22881. Special Default/Normal/Automatic color.
  22882. <i>Note:</i> This class Is NOT in the default HashTables returned by HSSFColor.
  22883. The index Is a special case which Is interpreted in the various SetXXXColor calls.
  22884. @author Jason
  22885. </member>
  22886. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil">
  22887. <summary>
  22888. Various utility functions that make working with a region of cells easier.
  22889. @author Eric Pugh epugh@upstate.com
  22890. </summary>
  22891. </member>
  22892. <member name="T:NPOI.HSSF.Util.HSSFRegionUtil.CellPropertySetter">
  22893. <summary>
  22894. For setting the same property on many cells to the same value
  22895. </summary>
  22896. </member>
  22897. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderLeft(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22898. <summary>
  22899. Sets the left border for a region of cells by manipulating the cell style
  22900. of the individual cells on the left
  22901. </summary>
  22902. <param name="border">The new border</param>
  22903. <param name="region">The region that should have the border</param>
  22904. <param name="sheet">The sheet that the region is on.</param>
  22905. <param name="workbook">The workbook that the region is on.</param>
  22906. </member>
  22907. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22908. <summary>
  22909. Sets the leftBorderColor attribute of the HSSFRegionUtil object
  22910. </summary>
  22911. <param name="color">The color of the border</param>
  22912. <param name="region">The region that should have the border</param>
  22913. <param name="sheet">The sheet that the region is on.</param>
  22914. <param name="workbook">The workbook that the region is on.</param>
  22915. </member>
  22916. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderRight(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22917. <summary>
  22918. Sets the borderRight attribute of the HSSFRegionUtil object
  22919. </summary>
  22920. <param name="border">The new border</param>
  22921. <param name="region">The region that should have the border</param>
  22922. <param name="sheet">The sheet that the region is on.</param>
  22923. <param name="workbook">The workbook that the region is on.</param>
  22924. </member>
  22925. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22926. <summary>
  22927. Sets the rightBorderColor attribute of the HSSFRegionUtil object
  22928. </summary>
  22929. <param name="color">The color of the border</param>
  22930. <param name="region">The region that should have the border</param>
  22931. <param name="sheet">The workbook that the region is on.</param>
  22932. <param name="workbook">The sheet that the region is on.</param>
  22933. </member>
  22934. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderBottom(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22935. <summary>
  22936. Sets the borderBottom attribute of the HSSFRegionUtil object
  22937. </summary>
  22938. <param name="border">The new border</param>
  22939. <param name="region">The region that should have the border</param>
  22940. <param name="sheet">The sheet that the region is on.</param>
  22941. <param name="workbook">The workbook that the region is on.</param>
  22942. </member>
  22943. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22944. <summary>
  22945. Sets the bottomBorderColor attribute of the HSSFRegionUtil object
  22946. </summary>
  22947. <param name="color">The color of the border</param>
  22948. <param name="region">The region that should have the border</param>
  22949. <param name="sheet">The sheet that the region is on.</param>
  22950. <param name="workbook">The workbook that the region is on.</param>
  22951. </member>
  22952. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetBorderTop(NPOI.SS.UserModel.BorderStyle,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22953. <summary>
  22954. Sets the borderBottom attribute of the HSSFRegionUtil object
  22955. </summary>
  22956. <param name="border">The new border</param>
  22957. <param name="region">The region that should have the border</param>
  22958. <param name="sheet">The sheet that the region is on.</param>
  22959. <param name="workbook">The workbook that the region is on.</param>
  22960. </member>
  22961. <member name="M:NPOI.HSSF.Util.HSSFRegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.HSSF.UserModel.HSSFSheet,NPOI.HSSF.UserModel.HSSFWorkbook)">
  22962. <summary>
  22963. Sets the topBorderColor attribute of the HSSFRegionUtil object
  22964. </summary>
  22965. <param name="color">The color of the border</param>
  22966. <param name="region">The region that should have the border</param>
  22967. <param name="sheet">The sheet that the region is on.</param>
  22968. <param name="workbook">The workbook that the region is on.</param>
  22969. </member>
  22970. <member name="T:NPOI.HSSF.Util.LazilyConcatenatedByteArray">
  22971. Utility for delaying the concatenation of multiple byte arrays. Doing this up-front
  22972. causes significantly more copying, which for a large number of byte arrays can cost
  22973. a large amount of time.
  22974. </member>
  22975. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Clear">
  22976. Clears the array (sets the concatenated length back to zero.
  22977. </member>
  22978. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.Concatenate(System.Byte[])">
  22979. Concatenates an array onto the end of our array.
  22980. This is a relatively fast operation.
  22981. @param array the array to concatenate.
  22982. @throws ArgumentException if {@code array} is {@code null}.
  22983. </member>
  22984. <member name="M:NPOI.HSSF.Util.LazilyConcatenatedByteArray.ToArray">
  22985. Gets the concatenated contents as a single byte array.
  22986. This is a slower operation, but the concatenated array is stored off as a single
  22987. array again so that subsequent calls will not perform Additional copying.
  22988. @return the byte array. Returns {@code null} if no data has been placed into it.
  22989. </member>
  22990. <member name="T:NPOI.HSSF.Util.RangeAddress">
  22991. * Title: Range Address
  22992. * Description: provides connectivity utilities for ranges
  22993. *
  22994. *
  22995. * REFERENCE:
  22996. * @author IgOr KaTz &amp; EuGeNe BuMaGiN (Tal Moshaiov) (VistaPortal LDT.)
  22997. @version 1.0
  22998. </member>
  22999. <member name="M:NPOI.HSSF.Util.RangeAddress.#ctor(System.String)">
  23000. Accepts an external reference from excel.
  23001. i.e. Sheet1!$A$4:$B$9
  23002. @param _url
  23003. </member>
  23004. <member name="P:NPOI.HSSF.Util.RangeAddress.Address">
  23005. @return String <b>note: </b> All absolute references are Removed
  23006. </member>
  23007. <member name="T:NPOI.HSSF.Util.RKUtil">
  23008. Utility class for helping convert RK numbers.
  23009. @author Andrew C. Oliver (acoliver at apache dot org)
  23010. @author Glen Stampoultzis (glens at apache.org)
  23011. @author Rolf-J黵gen Moll
  23012. @see org.apache.poi.hssf.record.MulRKRecord
  23013. @see org.apache.poi.hssf.record.RKRecord
  23014. </member>
  23015. <member name="M:NPOI.HSSF.Util.RKUtil.DecodeNumber(System.Int32)">
  23016. Do the dirty work of decoding; made a private static method to
  23017. facilitate testing the algorithm
  23018. </member>
  23019. <member name="T:NPOI.POIDocument">
  23020. <summary>
  23021. This holds the common functionality for all POI
  23022. Document classes.
  23023. Currently, this relates to Document Information Properties
  23024. </summary>
  23025. <remarks>@author Nick Burch</remarks>
  23026. </member>
  23027. <member name="F:NPOI.POIDocument.sInf">
  23028. Holds metadata on our document
  23029. </member>
  23030. <member name="F:NPOI.POIDocument.dsInf">
  23031. Holds further metadata on our document
  23032. </member>
  23033. <member name="F:NPOI.POIDocument.directory">
  23034. The directory that our document lives in
  23035. </member>
  23036. <member name="F:NPOI.POIDocument.initialized">
  23037. For our own logging use
  23038. </member>
  23039. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  23040. <summary>
  23041. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  23042. </summary>
  23043. <param name="dir">The dir.</param>
  23044. <param name="fs">The fs.</param>
  23045. </member>
  23046. <member name="M:NPOI.POIDocument.#ctor(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  23047. <summary>
  23048. Initializes a new instance of the <see cref="T:NPOI.POIDocument"/> class.
  23049. </summary>
  23050. <param name="fs">The fs.</param>
  23051. </member>
  23052. <member name="M:NPOI.POIDocument.CreateInformationProperties">
  23053. Will create whichever of SummaryInformation
  23054. and DocumentSummaryInformation (HPSF) properties
  23055. are not already part of your document.
  23056. This is normally useful when creating a new
  23057. document from scratch.
  23058. If the information properties are already there,
  23059. then nothing will happen.
  23060. </member>
  23061. <member name="P:NPOI.POIDocument.DocumentSummaryInformation">
  23062. <summary>
  23063. Fetch the Document Summary Information of the document
  23064. </summary>
  23065. <value>The document summary information.</value>
  23066. </member>
  23067. <member name="P:NPOI.POIDocument.SummaryInformation">
  23068. <summary>
  23069. Fetch the Summary Information of the document
  23070. </summary>
  23071. <value>The summary information.</value>
  23072. </member>
  23073. <member name="M:NPOI.POIDocument.ReadProperties">
  23074. <summary>
  23075. Find, and Create objects for, the standard
  23076. Documment Information Properties (HPSF).
  23077. If a given property Set is missing or corrupt,
  23078. it will remain null;
  23079. </summary>
  23080. </member>
  23081. <member name="M:NPOI.POIDocument.GetPropertySet(System.String)">
  23082. <summary>
  23083. For a given named property entry, either return it or null if
  23084. if it wasn't found
  23085. </summary>
  23086. <param name="setName">Name of the set.</param>
  23087. <returns></returns>
  23088. </member>
  23089. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  23090. <summary>
  23091. Writes out the standard Documment Information Properties (HPSF)
  23092. </summary>
  23093. <param name="outFS">the POIFSFileSystem to Write the properties into</param>
  23094. </member>
  23095. <member name="M:NPOI.POIDocument.WriteProperties(NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.IList)">
  23096. <summary>
  23097. Writes out the standard Documment Information Properties (HPSF)
  23098. </summary>
  23099. <param name="outFS">the POIFSFileSystem to Write the properties into.</param>
  23100. <param name="writtenEntries">a list of POIFS entries to Add the property names too.</param>
  23101. </member>
  23102. <member name="M:NPOI.POIDocument.WritePropertySet(System.String,NPOI.HPSF.PropertySet,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  23103. <summary>
  23104. Writes out a given ProperySet
  23105. </summary>
  23106. <param name="name">the (POIFS Level) name of the property to Write.</param>
  23107. <param name="Set">the PropertySet to Write out.</param>
  23108. <param name="outFS">the POIFSFileSystem to Write the property into.</param>
  23109. </member>
  23110. <member name="M:NPOI.POIDocument.Write(System.IO.Stream)">
  23111. <summary>
  23112. Writes the document out to the specified output stream
  23113. </summary>
  23114. <param name="out1">The out1.</param>
  23115. </member>
  23116. <member name="M:NPOI.POIDocument.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  23117. <summary>
  23118. Copies nodes from one POIFS to the other minus the excepts
  23119. </summary>
  23120. <param name="source">the source POIFS to copy from.</param>
  23121. <param name="target">the target POIFS to copy to</param>
  23122. <param name="excepts">a list of Strings specifying what nodes NOT to copy</param>
  23123. </member>
  23124. <member name="M:NPOI.POIDocument.CopyNodes(NPOI.POIFS.FileSystem.DirectoryNode,NPOI.POIFS.FileSystem.DirectoryNode,System.Collections.Generic.List{System.String})">
  23125. <summary>
  23126. Copies nodes from one POIFS to the other minus the excepts
  23127. </summary>
  23128. <param name="sourceRoot">the source POIFS to copy from.</param>
  23129. <param name="targetRoot">the target POIFS to copy to</param>
  23130. <param name="excepts">a list of Strings specifying what nodes NOT to copy</param>
  23131. </member>
  23132. <member name="M:NPOI.POIDocument.isInList(System.String,System.Collections.IList)">
  23133. <summary>
  23134. Checks to see if the String is in the list, used when copying
  23135. nodes between one POIFS and another
  23136. </summary>
  23137. <param name="entry">The entry.</param>
  23138. <param name="list">The list.</param>
  23139. <returns>
  23140. <c>true</c> if [is in list] [the specified entry]; otherwise, <c>false</c>.
  23141. </returns>
  23142. </member>
  23143. <member name="M:NPOI.POIDocument.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  23144. <summary>
  23145. Copies an Entry into a target POIFS directory, recursively
  23146. </summary>
  23147. <param name="entry">The entry.</param>
  23148. <param name="target">The target.</param>
  23149. </member>
  23150. <member name="T:NPOI.POIFS.Common.POIFSBigBlockSize">
  23151. <p>A class describing attributes of the Big Block Size</p>
  23152. </member>
  23153. <member name="M:NPOI.POIFS.Common.POIFSBigBlockSize.GetHeaderValue">
  23154. Returns the value that Gets written into the
  23155. header.
  23156. Is the power of two that corresponds to the
  23157. size of the block, eg 512 => 9
  23158. </member>
  23159. <member name="T:NPOI.POIFS.Common.POIFSConstants">
  23160. <summary>
  23161. A repository for constants shared by POI classes.
  23162. @author Marc Johnson (mjohnson at apache dot org)
  23163. </summary>
  23164. </member>
  23165. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALLER_BIG_BLOCK_SIZE">
  23166. Most files use 512 bytes as their big block size
  23167. </member>
  23168. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGER_BIG_BLOCK_SIZE">
  23169. Some use 4096 bytes
  23170. </member>
  23171. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_SIZE">
  23172. Most files use 512 bytes as their big block size
  23173. </member>
  23174. <member name="F:NPOI.POIFS.Common.POIFSConstants.MINI_BLOCK_SIZE">
  23175. Most files use 512 bytes as their big block size
  23176. </member>
  23177. <member name="F:NPOI.POIFS.Common.POIFSConstants.SMALL_BLOCK_SIZE">
  23178. How big a block in the small block stream is. Fixed size
  23179. </member>
  23180. <member name="F:NPOI.POIFS.Common.POIFSConstants.PROPERTY_SIZE">
  23181. How big a single property is
  23182. </member>
  23183. <member name="F:NPOI.POIFS.Common.POIFSConstants.BIG_BLOCK_MINIMUM_DOCUMENT_SIZE">
  23184. The minimum size of a document before it's stored using
  23185. Big Blocks (normal streams). Smaller documents go in the
  23186. Mini Stream (SBAT / Small Blocks)
  23187. </member>
  23188. <member name="F:NPOI.POIFS.Common.POIFSConstants.LARGEST_REGULAR_SECTOR_NUMBER">
  23189. The highest sector number you're allowed, 0xFFFFFFFA
  23190. </member>
  23191. <member name="F:NPOI.POIFS.Common.POIFSConstants.FAT_SECTOR_BLOCK">
  23192. Indicates the sector holds a FAT block (0xFFFFFFFD)
  23193. </member>
  23194. <member name="F:NPOI.POIFS.Common.POIFSConstants.DIFAT_SECTOR_BLOCK">
  23195. Indicates the sector holds a DIFAT block (0xFFFFFFFC)
  23196. </member>
  23197. <member name="F:NPOI.POIFS.Common.POIFSConstants.END_OF_CHAIN">
  23198. Indicates the sector is the end of a chain (0xFFFFFFFE)
  23199. </member>
  23200. <member name="F:NPOI.POIFS.Common.POIFSConstants.UNUSED_BLOCK">
  23201. Indicates the sector is not used (0xFFFFFFFF)
  23202. </member>
  23203. <member name="F:NPOI.POIFS.Common.POIFSConstants.OOXML_FILE_HEADER">
  23204. The first 4 bytes of an OOXML file, used in detection
  23205. </member>
  23206. <member name="M:NPOI.POIFS.Crypt.Decryptor.GetDataStream(NPOI.POIFS.FileSystem.DirectoryNode)">
  23207. <summary>
  23208. Return a stream with decrypted data.
  23209. Use {@link #getLength()} to get the size of that data that can be safely read from the stream.
  23210. Just reading to the end of the input stream is not sufficient because there are
  23211. normally padding bytes that must be discarded
  23212. </summary>
  23213. <param name="dir">the node to read from</param>
  23214. <returns>decrypted stream</returns>
  23215. </member>
  23216. <member name="P:NPOI.POIFS.Crypt.Decryptor.Length">
  23217. <summary>
  23218. Returns the length of the encytpted data that can be safely read with
  23219. {@link #getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)}.
  23220. Just reading to the end of the input stream is not sufficient because there are
  23221. normally padding bytes that must be discarded
  23222. The length variable is initialized in {@link #getDataStream(org.apache.poi.poifs.filesystem.DirectoryNode)},
  23223. an attempt to call getLength() prior to getDataStream() will result in IllegalStateException.
  23224. return length of the encrypted data
  23225. </summary>
  23226. </member>
  23227. <member name="T:NPOI.POIFS.Dev.POIFSViewable">
  23228. <summary>
  23229. Interface for a drill-down viewable object. Such an object has
  23230. content that may or may not be displayed, at the discretion of the
  23231. viewer. The content is returned to the viewer as an array or as an
  23232. Iterator, and the object provides a clue as to which technique the
  23233. viewer should use to get its content.
  23234. A POIFSViewable object is also expected to provide a short
  23235. description of itself, that can be used by a viewer when the
  23236. viewable object is collapsed.
  23237. @author Marc Johnson (mjohnson at apache dot org)
  23238. </summary>
  23239. </member>
  23240. <member name="P:NPOI.POIFS.Dev.POIFSViewable.PreferArray">
  23241. <summary>
  23242. Provides a short description of the object to be used when a
  23243. POIFSViewable object has not provided its contents.
  23244. </summary>
  23245. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  23246. </member>
  23247. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ShortDescription">
  23248. <summary>
  23249. Gets the short description.
  23250. </summary>
  23251. <value>The short description.</value>
  23252. </member>
  23253. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableArray">
  23254. <summary>
  23255. Get an array of objects, some of which may implement POIFSViewable
  23256. </summary>
  23257. <value>The viewable array.</value>
  23258. </member>
  23259. <member name="P:NPOI.POIFS.Dev.POIFSViewable.ViewableIterator">
  23260. <summary>
  23261. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  23262. </summary>
  23263. <value>The viewable iterator.</value>
  23264. </member>
  23265. <member name="T:NPOI.POIFS.Dev.POIFSViewEngine">
  23266. <summary>
  23267. This class contains methods used to inspect POIFSViewable objects
  23268. @author Marc Johnson (mjohnson at apache dot org)
  23269. </summary>
  23270. </member>
  23271. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.InspectViewable(System.Object,System.Boolean,System.Int32,System.String)">
  23272. <summary>
  23273. Inspect an object that may be viewable, and drill down if told to
  23274. </summary>
  23275. <param name="viewable">the object to be viewed</param>
  23276. <param name="drilldown">if <c>true</c> and the object implements POIFSViewable, inspect the objects' contents</param>
  23277. <param name="indentLevel">how far in to indent each string</param>
  23278. <param name="indentString">string to use for indenting</param>
  23279. <returns>a List of Strings holding the content</returns>
  23280. </member>
  23281. <member name="M:NPOI.POIFS.Dev.POIFSViewEngine.Indent(System.Int32,System.String,System.String)">
  23282. <summary>
  23283. Indents the specified indent level.
  23284. </summary>
  23285. <param name="indentLevel">how far in to indent each string</param>
  23286. <param name="indentString">string to use for indenting</param>
  23287. <param name="data">The data.</param>
  23288. <returns></returns>
  23289. </member>
  23290. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReader">
  23291. <summary>
  23292. An event-driven Reader for POIFS file systems. Users of this class
  23293. first Create an instance of it, then use the RegisterListener
  23294. methods to Register POIFSReaderListener instances for specific
  23295. documents. Once all the listeners have been Registered, the Read()
  23296. method is called, which results in the listeners being notified as
  23297. their documents are Read.
  23298. @author Marc Johnson (mjohnson at apache dot org)
  23299. </summary>
  23300. </member>
  23301. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.#ctor">
  23302. <summary>
  23303. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSReader"/> class.
  23304. </summary>
  23305. </member>
  23306. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.Read(System.IO.Stream)">
  23307. <summary>
  23308. Read from an InputStream and Process the documents we Get
  23309. </summary>
  23310. <param name="stream">the InputStream from which to Read the data</param>
  23311. <returns>POIFSDocument list</returns>
  23312. </member>
  23313. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  23314. Register a POIFSReaderListener for all documents
  23315. @param listener the listener to be registered
  23316. @exception NullPointerException if listener is null
  23317. @exception IllegalStateException if read() has already been
  23318. called
  23319. </member>
  23320. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,System.String)">
  23321. Register a POIFSReaderListener for a document in the root
  23322. directory
  23323. @param listener the listener to be registered
  23324. @param name the document name
  23325. @exception NullPointerException if listener is null or name is
  23326. null or empty
  23327. @exception IllegalStateException if read() has already been
  23328. called
  23329. </member>
  23330. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23331. Register a POIFSReaderListener for a document in the specified
  23332. directory
  23333. @param listener the listener to be registered
  23334. @param path the document path; if null, the root directory is
  23335. assumed
  23336. @param name the document name
  23337. @exception NullPointerException if listener is null or name is
  23338. null or empty
  23339. @exception IllegalStateException if read() has already been
  23340. called
  23341. </member>
  23342. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReader.ProcessProperties(NPOI.POIFS.Storage.BlockList,NPOI.POIFS.Storage.BlockList,System.Collections.IEnumerator,NPOI.POIFS.FileSystem.POIFSDocumentPath)">
  23343. <summary>
  23344. Processes the properties.
  23345. </summary>
  23346. <param name="small_blocks">The small_blocks.</param>
  23347. <param name="big_blocks">The big_blocks.</param>
  23348. <param name="properties">The properties.</param>
  23349. <param name="path">The path.</param>
  23350. <returns></returns>
  23351. </member>
  23352. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEvent">
  23353. Class POIFSReaderEvent
  23354. @author Marc Johnson (mjohnson at apache dot org)
  23355. @version %I%, %G%
  23356. </member>
  23357. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.#ctor(NPOI.POIFS.FileSystem.DocumentInputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23358. package scoped constructor
  23359. @param stream the DocumentInputStream, freshly opened
  23360. @param path the path of the document
  23361. @param documentName the name of the document
  23362. </member>
  23363. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Stream">
  23364. @return the DocumentInputStream, freshly opened
  23365. </member>
  23366. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Path">
  23367. @return the document's path
  23368. </member>
  23369. <member name="P:NPOI.POIFS.EventFileSystem.POIFSReaderEvent.Name">
  23370. @return the document's name
  23371. </member>
  23372. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderEventArgs">
  23373. <summary>
  23374. EventArgs for POIFSReader
  23375. author: Tony Qu
  23376. </summary>
  23377. </member>
  23378. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderListener">
  23379. Interface POIFSReaderListener
  23380. @author Marc Johnson (mjohnson at apache dot org)
  23381. @version %I%, %G%
  23382. </member>
  23383. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderListener.ProcessPOIFSReaderEvent(NPOI.POIFS.EventFileSystem.POIFSReaderEvent)">
  23384. Process a POIFSReaderEvent that this listener had Registered
  23385. for
  23386. @param event the POIFSReaderEvent
  23387. </member>
  23388. <member name="T:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry">
  23389. A registry for POIFSReaderListeners and the DocumentDescriptors of
  23390. the documents those listeners are interested in
  23391. @author Marc Johnson (mjohnson at apache dot org)
  23392. @version %I%, %G%
  23393. </member>
  23394. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.#ctor">
  23395. Construct the registry
  23396. </member>
  23397. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23398. Register a POIFSReaderListener for a particular document
  23399. @param listener the listener
  23400. @param path the path of the document of interest
  23401. @param documentName the name of the document of interest
  23402. </member>
  23403. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.RegisterListener(NPOI.POIFS.EventFileSystem.POIFSReaderListener)">
  23404. Register for all documents
  23405. @param listener the listener who wants to Get all documents
  23406. </member>
  23407. <member name="M:NPOI.POIFS.EventFileSystem.POIFSReaderRegistry.GetListeners(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23408. Get am iterator of listeners for a particular document
  23409. @param path the document path
  23410. @param name the name of the document
  23411. @return an Iterator POIFSReaderListeners; may be empty
  23412. </member>
  23413. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent">
  23414. Class POIFSWriterEvent
  23415. @author Marc Johnson (mjohnson at apache dot org)
  23416. @version %I%, %G%
  23417. </member>
  23418. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  23419. namespace scoped constructor
  23420. @param stream the DocumentOutputStream, freshly opened
  23421. @param path the path of the document
  23422. @param documentName the name of the document
  23423. @param limit the limit, in bytes, that can be written to the
  23424. stream
  23425. </member>
  23426. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Stream">
  23427. @return the DocumentOutputStream, freshly opened
  23428. </member>
  23429. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Path">
  23430. @return the document's path
  23431. </member>
  23432. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Name">
  23433. @return the document's name
  23434. </member>
  23435. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEvent.Limit">
  23436. @return the limit on writing, in bytes
  23437. </member>
  23438. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs">
  23439. <summary>
  23440. EventArgs for POIFSWriter
  23441. author: Tony Qu
  23442. </summary>
  23443. </member>
  23444. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.#ctor(NPOI.POIFS.FileSystem.DocumentOutputStream,NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String,System.Int32)">
  23445. <summary>
  23446. Initializes a new instance of the <see cref="T:NPOI.POIFS.EventFileSystem.POIFSWriterEvent"/> class.
  23447. </summary>
  23448. <param name="stream">the POIFSDocumentWriter, freshly opened</param>
  23449. <param name="path">the path of the document</param>
  23450. <param name="documentName">the name of the document</param>
  23451. <param name="limit">the limit, in bytes, that can be written to the stream</param>
  23452. </member>
  23453. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Limit">
  23454. <summary>
  23455. Gets the limit on writing, in bytes
  23456. </summary>
  23457. <value>The limit.</value>
  23458. </member>
  23459. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Name">
  23460. <summary>
  23461. Gets the document's name
  23462. </summary>
  23463. <value>The name.</value>
  23464. </member>
  23465. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Path">
  23466. <summary>
  23467. Gets the document's path
  23468. </summary>
  23469. <value>The path.</value>
  23470. </member>
  23471. <member name="P:NPOI.POIFS.EventFileSystem.POIFSWriterEventArgs.Stream">
  23472. <summary>
  23473. the POIFSDocumentWriter, freshly opened
  23474. </summary>
  23475. <value>The stream.</value>
  23476. </member>
  23477. <member name="T:NPOI.POIFS.EventFileSystem.POIFSWriterListener">
  23478. Interface POIFSWriterListener
  23479. @author Marc Johnson (mjohnson at apache dot org)
  23480. @version %I%, %G%
  23481. </member>
  23482. <member name="M:NPOI.POIFS.EventFileSystem.POIFSWriterListener.ProcessPOIFSWriterEvent(NPOI.POIFS.EventFileSystem.POIFSWriterEvent)">
  23483. Process a POIFSWriterEvent that this listener had registered
  23484. for
  23485. @param event the POIFSWriterEvent
  23486. </member>
  23487. <member name="T:NPOI.POIFS.FileSystem.BATManaged">
  23488. <summary>
  23489. This interface defines behaviors for objects managed by the Block
  23490. Allocation Table (BAT).
  23491. @author Marc Johnson (mjohnson at apache dot org)
  23492. </summary>
  23493. </member>
  23494. <member name="P:NPOI.POIFS.FileSystem.BATManaged.CountBlocks">
  23495. <summary>
  23496. Gets the number of BigBlock's this instance uses
  23497. </summary>
  23498. <value>count of BigBlock instances</value>
  23499. </member>
  23500. <member name="P:NPOI.POIFS.FileSystem.BATManaged.StartBlock">
  23501. <summary>
  23502. Sets the start block for this instance
  23503. </summary>
  23504. <value>index into the array of BigBlock instances making up the the filesystem</value>
  23505. </member>
  23506. <member name="T:NPOI.POIFS.FileSystem.BlockStore">
  23507. <summary>
  23508. This abstract class describes a way to read, store, chain
  23509. and free a series of blocks (be they Big or Small ones)
  23510. </summary>
  23511. </member>
  23512. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockStoreBlockSize">
  23513. <summary>
  23514. Returns the size of the blocks managed through the block store.
  23515. </summary>
  23516. <returns></returns>
  23517. </member>
  23518. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBlockAt(System.Int32)">
  23519. <summary>
  23520. Load the block at the given offset.
  23521. </summary>
  23522. <param name="offset"></param>
  23523. <returns></returns>
  23524. </member>
  23525. <member name="M:NPOI.POIFS.FileSystem.BlockStore.CreateBlockIfNeeded(System.Int32)">
  23526. <summary>
  23527. Extends the file if required to hold blocks up to
  23528. the specified offset, and return the block from there.
  23529. </summary>
  23530. <param name="offset"></param>
  23531. <returns></returns>
  23532. </member>
  23533. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetBATBlockAndIndex(System.Int32)">
  23534. <summary>
  23535. Returns the BATBlock that handles the specified offset,
  23536. and the relative index within it
  23537. </summary>
  23538. <param name="offset"></param>
  23539. <returns></returns>
  23540. </member>
  23541. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetNextBlock(System.Int32)">
  23542. <summary>
  23543. Works out what block follows the specified one.
  23544. </summary>
  23545. <param name="offset"></param>
  23546. <returns></returns>
  23547. </member>
  23548. <member name="M:NPOI.POIFS.FileSystem.BlockStore.SetNextBlock(System.Int32,System.Int32)">
  23549. <summary>
  23550. Changes the record of what block follows the specified one.
  23551. </summary>
  23552. <param name="offset"></param>
  23553. <param name="nextBlock"></param>
  23554. </member>
  23555. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetFreeBlock">
  23556. <summary>
  23557. Finds a free block, and returns its offset.
  23558. This method will extend the file/stream if needed, and if doing
  23559. so, allocate new FAT blocks to address the extra space.
  23560. </summary>
  23561. <returns></returns>
  23562. </member>
  23563. <member name="M:NPOI.POIFS.FileSystem.BlockStore.GetChainLoopDetector">
  23564. <summary>
  23565. Creates a Detector for loops in the chain
  23566. </summary>
  23567. <returns></returns>
  23568. </member>
  23569. <member name="T:NPOI.POIFS.FileSystem.ChainLoopDetector">
  23570. <summary>
  23571. Used to detect if a chain has a loop in it, so
  23572. we can bail out with an error rather than
  23573. spinning away for ever...
  23574. </summary>
  23575. </member>
  23576. <member name="T:NPOI.POIFS.FileSystem.DirectoryEntry">
  23577. <summary>
  23578. This interface defines methods specific to Directory objects
  23579. managed by a Filesystem instance.
  23580. @author Marc Johnson (mjohnson at apache dot org)
  23581. </summary>
  23582. </member>
  23583. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.Entries">
  23584. <summary>
  23585. get an iterator of the Entry instances contained directly in
  23586. this instance (in other words, children only; no grandchildren
  23587. etc.)
  23588. </summary>
  23589. <value>The entries.never null, but hasNext() may return false
  23590. immediately (i.e., this DirectoryEntry is empty). All
  23591. objects retrieved by next() are guaranteed to be
  23592. implementations of Entry.</value>
  23593. </member>
  23594. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryNames">
  23595. <summary>
  23596. get the names of all the Entries contained directly in this
  23597. instance (in other words, names of children only; no grandchildren etc).
  23598. </summary>
  23599. <value>the names of all the entries that may be retrieved with
  23600. getEntry(String), which may be empty (if this DirectoryEntry is empty
  23601. </value>
  23602. </member>
  23603. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.IsEmpty">
  23604. <summary>
  23605. is this DirectoryEntry empty?
  23606. </summary>
  23607. <value><c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.</value>
  23608. </member>
  23609. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.EntryCount">
  23610. <summary>
  23611. find out how many Entry instances are contained directly within
  23612. this DirectoryEntry
  23613. </summary>
  23614. <value>number of immediately (no grandchildren etc.) contained
  23615. Entry instances</value>
  23616. </member>
  23617. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.GetEntry(System.String)">
  23618. <summary>
  23619. get a specified Entry by name
  23620. </summary>
  23621. <param name="name">the name of the Entry to obtain.</param>
  23622. <returns>the specified Entry, if it is directly contained in
  23623. this DirectoryEntry</returns>
  23624. </member>
  23625. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.IO.Stream)">
  23626. <summary>
  23627. Create a new DocumentEntry
  23628. </summary>
  23629. <param name="name">the name of the new DocumentEntry</param>
  23630. <param name="stream">the Stream from which to Create the new DocumentEntry</param>
  23631. <returns>the new DocumentEntry</returns>
  23632. </member>
  23633. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  23634. <summary>
  23635. Create a new DocumentEntry; the data will be provided later
  23636. </summary>
  23637. <param name="name">the name of the new DocumentEntry</param>
  23638. <param name="size">the size of the new DocumentEntry</param>
  23639. <param name="writer">BeforeWriting event handler</param>
  23640. <returns>the new DocumentEntry</returns>
  23641. </member>
  23642. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.CreateDirectory(System.String)">
  23643. <summary>
  23644. Create a new DirectoryEntry
  23645. </summary>
  23646. <param name="name">the name of the new DirectoryEntry</param>
  23647. <returns>the name of the new DirectoryEntry</returns>
  23648. </member>
  23649. <member name="P:NPOI.POIFS.FileSystem.DirectoryEntry.StorageClsid">
  23650. <summary>
  23651. Gets or sets the storage ClassID.
  23652. </summary>
  23653. <value>The storage ClassID.</value>
  23654. </member>
  23655. <member name="M:NPOI.POIFS.FileSystem.DirectoryEntry.HasEntry(System.String)">
  23656. <summary>
  23657. Checks if entry with specified name present
  23658. </summary>
  23659. <param name="name">entry name</param>
  23660. <returns>true if have</returns>
  23661. </member>
  23662. <member name="T:NPOI.POIFS.FileSystem.DirectoryNode">
  23663. <summary>
  23664. Simple implementation of DirectoryEntry
  23665. @author Marc Johnson (mjohnson at apache dot org)
  23666. </summary>
  23667. </member>
  23668. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.#ctor(NPOI.POIFS.Properties.DirectoryProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem,NPOI.POIFS.FileSystem.DirectoryNode)">
  23669. <summary>
  23670. Create a DirectoryNode. This method Is not public by design; it
  23671. Is intended strictly for the internal use of this package
  23672. </summary>
  23673. <param name="property">the DirectoryProperty for this DirectoryEntry</param>
  23674. <param name="nFileSystem">the POIFSFileSystem we belong to</param>
  23675. <param name="parent">the parent of this entry</param>
  23676. </member>
  23677. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreatePOIFSDocumentReader(System.String)">
  23678. <summary>
  23679. open a document in the directory's entry's list of entries
  23680. </summary>
  23681. <param name="documentName">the name of the document to be opened</param>
  23682. <returns>a newly opened DocumentStream</returns>
  23683. </member>
  23684. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDocument(NPOI.POIFS.FileSystem.POIFSDocument)">
  23685. <summary>
  23686. Create a new DocumentEntry; the data will be provided later
  23687. </summary>
  23688. <param name="document">the name of the new documentEntry</param>
  23689. <returns>the new DocumentEntry</returns>
  23690. </member>
  23691. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.ChangeName(System.String,System.String)">
  23692. <summary>
  23693. Change a contained Entry's name
  23694. </summary>
  23695. <param name="oldName">the original name</param>
  23696. <param name="newName">the new name</param>
  23697. <returns>true if the operation succeeded, else false</returns>
  23698. </member>
  23699. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.DeleteEntry(NPOI.POIFS.FileSystem.EntryNode)">
  23700. <summary>
  23701. Deletes the entry.
  23702. </summary>
  23703. <param name="entry">the EntryNode to be Deleted</param>
  23704. <returns>true if the entry was Deleted, else false</returns>
  23705. </member>
  23706. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Path">
  23707. <summary>
  23708. Gets the path.
  23709. </summary>
  23710. <value>this directory's path representation</value>
  23711. </member>
  23712. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.Entries">
  23713. <summary>
  23714. get an iterator of the Entry instances contained directly in
  23715. this instance (in other words, children only; no grandchildren
  23716. etc.)
  23717. </summary>
  23718. <value>
  23719. The entries.never null, but hasNext() may return false
  23720. immediately (i.e., this DirectoryEntry is empty). All
  23721. objects retrieved by next() are guaranteed to be
  23722. implementations of Entry.
  23723. </value>
  23724. </member>
  23725. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryNames">
  23726. get the names of all the Entries contained directly in this
  23727. instance (in other words, names of children only; no grandchildren
  23728. etc).
  23729. @return the names of all the entries that may be retrieved with
  23730. getEntry(String), which may be empty (if this
  23731. DirectoryEntry is empty)
  23732. </member>
  23733. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsEmpty">
  23734. <summary>
  23735. is this DirectoryEntry empty?
  23736. </summary>
  23737. <value>
  23738. <c>true</c> if this instance contains no Entry instances; otherwise, <c>false</c>.
  23739. </value>
  23740. </member>
  23741. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.EntryCount">
  23742. <summary>
  23743. find out how many Entry instances are contained directly within
  23744. this DirectoryEntry
  23745. </summary>
  23746. <value>
  23747. number of immediately (no grandchildren etc.) contained
  23748. Entry instances
  23749. </value>
  23750. </member>
  23751. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.GetEntry(System.String)">
  23752. <summary>
  23753. get a specified Entry by name
  23754. </summary>
  23755. <param name="name">the name of the Entry to obtain.</param>
  23756. <returns>
  23757. the specified Entry, if it is directly contained in
  23758. this DirectoryEntry
  23759. </returns>
  23760. </member>
  23761. <member name="M:NPOI.POIFS.FileSystem.DirectoryNode.CreateDirectory(System.String)">
  23762. <summary>
  23763. Create a new DirectoryEntry
  23764. </summary>
  23765. <param name="name">the name of the new DirectoryEntry</param>
  23766. <returns>the name of the new DirectoryEntry</returns>
  23767. </member>
  23768. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.StorageClsid">
  23769. <summary>
  23770. Gets or Sets the storage clsid for the directory entry
  23771. </summary>
  23772. <value>The storage ClassID.</value>
  23773. </member>
  23774. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDirectoryEntry">
  23775. <summary>
  23776. Is this a DirectoryEntry?
  23777. </summary>
  23778. <value>true if the Entry Is a DirectoryEntry, else false</value>
  23779. </member>
  23780. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.IsDeleteOK">
  23781. <summary>
  23782. extensions use this method to verify internal rules regarding
  23783. deletion of the underlying store.
  23784. </summary>
  23785. <value> true if it's ok to Delete the underlying store, else
  23786. false</value>
  23787. </member>
  23788. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableArray">
  23789. <summary>
  23790. Get an array of objects, some of which may implement POIFSViewable
  23791. </summary>
  23792. <value>an array of Object; may not be null, but may be empty</value>
  23793. </member>
  23794. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ViewableIterator">
  23795. <summary>
  23796. Get an Iterator of objects, some of which may implement
  23797. POIFSViewable
  23798. </summary>
  23799. <value>an Iterator; may not be null, but may have an empty
  23800. back end store</value>
  23801. </member>
  23802. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.PreferArray">
  23803. <summary>
  23804. Give viewers a hint as to whether to call GetViewableArray or
  23805. GetViewableIterator
  23806. </summary>
  23807. <value><c>true</c> if a viewer should call GetViewableArray; otherwise, <c>false</c>if
  23808. a viewer should call GetViewableIterator</value>
  23809. </member>
  23810. <member name="P:NPOI.POIFS.FileSystem.DirectoryNode.ShortDescription">
  23811. <summary>
  23812. Provides a short description of the object, to be used when a
  23813. POIFSViewable object has not provided its contents.
  23814. </summary>
  23815. <value>The short description.</value>
  23816. </member>
  23817. <member name="T:NPOI.POIFS.FileSystem.DocumentDescriptor">
  23818. <summary>
  23819. Class DocumentDescriptor
  23820. @author Marc Johnson (mjohnson at apache dot org)
  23821. </summary>
  23822. </member>
  23823. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String)">
  23824. <summary>
  23825. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.DocumentDescriptor"/> class.
  23826. </summary>
  23827. <param name="path">the Document path</param>
  23828. <param name="name">the Document name</param>
  23829. </member>
  23830. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Path">
  23831. <summary>
  23832. Gets the path.
  23833. </summary>
  23834. <value>The path.</value>
  23835. </member>
  23836. <member name="P:NPOI.POIFS.FileSystem.DocumentDescriptor.Name">
  23837. <summary>
  23838. Gets the name.
  23839. </summary>
  23840. <value>The name.</value>
  23841. </member>
  23842. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.Equals(System.Object)">
  23843. <summary>
  23844. equality. Two DocumentDescriptor instances are equal if they
  23845. have equal paths and names
  23846. </summary>
  23847. <param name="o">the object we're checking equality for</param>
  23848. <returns>true if the object is equal to this object</returns>
  23849. </member>
  23850. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.GetHashCode">
  23851. <summary>
  23852. Serves as a hash function for a particular type.
  23853. </summary>
  23854. <returns>
  23855. hashcode
  23856. </returns>
  23857. </member>
  23858. <member name="M:NPOI.POIFS.FileSystem.DocumentDescriptor.ToString">
  23859. <summary>
  23860. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  23861. </summary>
  23862. <returns>
  23863. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  23864. </returns>
  23865. </member>
  23866. <member name="T:NPOI.POIFS.FileSystem.DocumentEntry">
  23867. <summary>
  23868. This interface defines methods specific to Document objects
  23869. managed by a Filesystem instance.
  23870. @author Marc Johnson (mjohnson at apache dot org)
  23871. </summary>
  23872. </member>
  23873. <member name="P:NPOI.POIFS.FileSystem.DocumentEntry.Size">
  23874. <summary>
  23875. get the size of the document, in bytes
  23876. </summary>
  23877. <value>size in bytes</value>
  23878. </member>
  23879. <member name="T:NPOI.POIFS.FileSystem.DocumentInputStream">
  23880. This class provides methods to read a DocumentEntry managed by a
  23881. {@link POIFSFileSystem} or {@link NPOIFSFileSystem} instance.
  23882. It Creates the appropriate one, and delegates, allowing us to
  23883. work transparently with the two.
  23884. </member>
  23885. <member name="F:NPOI.POIFS.FileSystem.DocumentInputStream.EOF">
  23886. returned by read operations if we're at end of document
  23887. </member>
  23888. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor">
  23889. For use by downstream implementations
  23890. </member>
  23891. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  23892. Create an InputStream from the specified DocumentEntry
  23893. @param document the DocumentEntry to be read
  23894. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  23895. been deleted?)
  23896. </member>
  23897. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  23898. Create an InputStream from the specified Document
  23899. @param document the Document to be read
  23900. </member>
  23901. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  23902. Create an InputStream from the specified Document
  23903. @param document the Document to be read
  23904. </member>
  23905. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.MarkSupported">
  23906. Tests if this input stream supports the mark and reset methods.
  23907. @return <code>true</code> always
  23908. </member>
  23909. <member name="M:NPOI.POIFS.FileSystem.DocumentInputStream.Reset">
  23910. Repositions this stream to the position at the time the mark() method was
  23911. last called on this input stream. If mark() has not been called this
  23912. method repositions the stream to its beginning.
  23913. </member>
  23914. <member name="T:NPOI.POIFS.FileSystem.DocumentNode">
  23915. <summary>
  23916. Simple implementation of DocumentEntry
  23917. @author Marc Johnson (mjohnson at apache dot org)
  23918. </summary>
  23919. </member>
  23920. <member name="M:NPOI.POIFS.FileSystem.DocumentNode.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.DirectoryNode)">
  23921. create a DocumentNode. This method Is not public by design; it
  23922. Is intended strictly for the internal use of this package
  23923. @param property the DocumentProperty for this DocumentEntry
  23924. @param parent the parent of this entry
  23925. </member>
  23926. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Document">
  23927. get the POIFSDocument
  23928. @return the internal POIFSDocument
  23929. </member>
  23930. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.Size">
  23931. get the zize of the document, in bytes
  23932. @return size in bytes
  23933. </member>
  23934. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDocumentEntry">
  23935. Is this a DocumentEntry?
  23936. @return true if the Entry Is a DocumentEntry, else false
  23937. </member>
  23938. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.IsDeleteOK">
  23939. extensions use this method to verify internal rules regarding
  23940. deletion of the underlying store.
  23941. @return true if it's ok to delete the underlying store, else
  23942. false
  23943. </member>
  23944. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableArray">
  23945. Get an array of objects, some of which may implement
  23946. POIFSViewable
  23947. @return an array of Object; may not be null, but may be empty
  23948. </member>
  23949. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ViewableIterator">
  23950. Get an Iterator of objects, some of which may implement
  23951. POIFSViewable
  23952. @return an Iterator; may not be null, but may have an empty
  23953. back end store
  23954. </member>
  23955. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.PreferArray">
  23956. Give viewers a hint as to whether to call getViewableArray or
  23957. getViewableIterator
  23958. @return true if a viewer should call getViewableArray, false if
  23959. a viewer should call getViewableIterator
  23960. </member>
  23961. <member name="P:NPOI.POIFS.FileSystem.DocumentNode.ShortDescription">
  23962. Provides a short description of the object, to be used when a
  23963. POIFSViewable object has not provided its contents.
  23964. @return short description
  23965. </member>
  23966. <member name="T:NPOI.POIFS.FileSystem.DocumentOutputStream">
  23967. This class provides a wrapper over an OutputStream so that Document
  23968. Writers can't accidently go over their size limits
  23969. @author Marc Johnson (mjohnson at apache dot org)
  23970. </member>
  23971. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.#ctor(System.IO.Stream,System.Int32)">
  23972. Create a DocumentOutputStream
  23973. @param stream the OutputStream to which the data is actually
  23974. read
  23975. @param limit the maximum number of bytes that can be written
  23976. </member>
  23977. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Int32)">
  23978. Writes the specified byte to this output stream. The general
  23979. contract for write is that one byte is written to the output
  23980. stream. The byte to be written is the eight low-order bits of
  23981. the argument b. The 24 high-order bits of b are ignored.
  23982. @param b the byte.
  23983. @exception IOException if an I/O error occurs. In particular,
  23984. an IOException may be thrown if the
  23985. output stream has been closed, or if the
  23986. Writer tries to write too much data.
  23987. </member>
  23988. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[])">
  23989. Writes b.Length bytes from the specified byte array
  23990. to this output stream.
  23991. @param b the data.
  23992. @exception IOException if an I/O error occurs.
  23993. </member>
  23994. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Write(System.Byte[],System.Int32,System.Int32)">
  23995. <summary>
  23996. Writes len bytes from the specified byte array starting at
  23997. offset off to this output stream. The general contract for
  23998. Write(b, off, len) is that some of the bytes in the array b are
  23999. written to the output stream in order; element b[off] is the
  24000. first byte written and b[off+len-1] is the last byte written by
  24001. this operation.
  24002. </summary>
  24003. <param name="b">the data.</param>
  24004. <param name="off">the start offset in the data.</param>
  24005. <param name="len">the number of bytes to Write.</param>
  24006. </member>
  24007. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Flush">
  24008. <summary>
  24009. Flushes this output stream and forces any buffered output bytes to be written out
  24010. </summary>
  24011. </member>
  24012. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.Close">
  24013. Closes this output stream and releases any system resources
  24014. associated with this stream. The general contract of close is
  24015. that it closes the output stream. A closed stream cannot
  24016. perform output operations and cannot be reopened.
  24017. @exception IOException if an I/O error occurs.
  24018. </member>
  24019. <member name="M:NPOI.POIFS.FileSystem.DocumentOutputStream.WriteFiller(System.Int32,System.Byte)">
  24020. write the rest of the document's data (fill in at the end)
  24021. @param totalLimit the actual number of bytes the corresponding
  24022. document must fill
  24023. @param fill the byte to fill remaining space with
  24024. @exception IOException on I/O error
  24025. </member>
  24026. <member name="T:NPOI.POIFS.FileSystem.Entry">
  24027. <summary>
  24028. This interface provides access to an object managed by a Filesystem
  24029. instance. Entry objects are further divided into DocumentEntry and
  24030. DirectoryEntry instances.
  24031. @author Marc Johnson (mjohnson at apache dot org)
  24032. </summary>
  24033. </member>
  24034. <member name="P:NPOI.POIFS.FileSystem.Entry.Name">
  24035. <summary>
  24036. Get the name of the Entry
  24037. </summary>
  24038. <value>The name.</value>
  24039. </member>
  24040. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDirectoryEntry">
  24041. <summary>
  24042. Is this a DirectoryEntry?
  24043. </summary>
  24044. <value>
  24045. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  24046. </value>
  24047. </member>
  24048. <member name="P:NPOI.POIFS.FileSystem.Entry.IsDocumentEntry">
  24049. <summary>
  24050. Is this a DocumentEntry?
  24051. </summary>
  24052. <value>
  24053. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  24054. </value>
  24055. </member>
  24056. <member name="P:NPOI.POIFS.FileSystem.Entry.Parent">
  24057. <summary>
  24058. Get this Entry's parent (the DirectoryEntry that owns this
  24059. Entry). All Entry objects, except the root Entry, has a parent.
  24060. </summary>
  24061. <value>this Entry's parent; null iff this Is the root Entry</value>
  24062. This property is moved to EntryNode
  24063. </member>
  24064. <member name="M:NPOI.POIFS.FileSystem.Entry.Delete">
  24065. <summary>
  24066. Delete this Entry. ThIs operation should succeed, but there are
  24067. special circumstances when it will not:
  24068. If this Entry Is the root of the Entry tree, it cannot be
  24069. deleted, as there Is no way to Create another one.
  24070. If this Entry Is a directory, it cannot be deleted unless it Is
  24071. empty.
  24072. </summary>
  24073. <returns>true if the Entry was successfully deleted, else false</returns>
  24074. </member>
  24075. <member name="M:NPOI.POIFS.FileSystem.Entry.RenameTo(System.String)">
  24076. <summary>
  24077. Rename this Entry. ThIs operation will fail if:
  24078. There Is a sibling Entry (i.e., an Entry whose parent Is the
  24079. same as this Entry's parent) with the same name.
  24080. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  24081. by the Filesystem and many not be Changed.
  24082. </summary>
  24083. <param name="newName">the new name for this Entry</param>
  24084. <returns>true if the operation succeeded, else false</returns>
  24085. </member>
  24086. <member name="T:NPOI.POIFS.FileSystem.EntryNode">
  24087. <summary>
  24088. Abstract implementation of Entry
  24089. Extending classes should override isDocument() or isDirectory(), as
  24090. appropriate
  24091. Extending classes must override isDeleteOK()
  24092. @author Marc Johnson (mjohnson at apache dot org)
  24093. </summary>
  24094. </member>
  24095. <member name="M:NPOI.POIFS.FileSystem.EntryNode.#ctor(NPOI.POIFS.Properties.Property,NPOI.POIFS.FileSystem.DirectoryNode)">
  24096. <summary>
  24097. Create a DocumentNode. ThIs method Is not public by design; it
  24098. Is intended strictly for the internal use of extending classes
  24099. </summary>
  24100. <param name="property">the Property for this Entry</param>
  24101. <param name="parent">the parent of this entry</param>
  24102. </member>
  24103. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Property">
  24104. <summary>
  24105. grant access to the property
  24106. </summary>
  24107. <value>the property backing this entry</value>
  24108. </member>
  24109. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsRoot">
  24110. <summary>
  24111. Is this the root of the tree?
  24112. </summary>
  24113. <value><c>true</c> if this instance is root; otherwise, <c>false</c>.</value>
  24114. </member>
  24115. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDeleteOK">
  24116. <summary>
  24117. extensions use this method to verify internal rules regarding
  24118. deletion of the underlying store.
  24119. </summary>
  24120. <value>
  24121. <c>true</c> if it's ok to Delete the underlying store; otherwise, <c>false</c>.
  24122. </value>
  24123. </member>
  24124. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Name">
  24125. <summary>
  24126. Get the name of the Entry
  24127. </summary>
  24128. <value>The name.</value>
  24129. Get the name of the Entry
  24130. @return name
  24131. </member>
  24132. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDirectoryEntry">
  24133. <summary>
  24134. Is this a DirectoryEntry?
  24135. </summary>
  24136. <value>
  24137. <c>true</c> if the Entry Is a DirectoryEntry; otherwise, <c>false</c>.
  24138. </value>
  24139. </member>
  24140. <member name="P:NPOI.POIFS.FileSystem.EntryNode.IsDocumentEntry">
  24141. <summary>
  24142. Is this a DocumentEntry?
  24143. </summary>
  24144. <value>
  24145. <c>true</c> if the Entry Is a DocumentEntry; otherwise, <c>false</c>.
  24146. </value>
  24147. </member>
  24148. <member name="P:NPOI.POIFS.FileSystem.EntryNode.Parent">
  24149. <summary>
  24150. Get this Entry's parent (the DocumentEntry that owns this
  24151. Entry). All Entry objects, except the root Entry, has a parent.
  24152. </summary>
  24153. <value>this Entry's parent; null iff this Is the root Entry</value>
  24154. </member>
  24155. <member name="M:NPOI.POIFS.FileSystem.EntryNode.Delete">
  24156. <summary>
  24157. Delete this Entry. ThIs operation should succeed, but there are
  24158. special circumstances when it will not:
  24159. If this Entry Is the root of the Entry tree, it cannot be
  24160. deleted, as there Is no way to Create another one.
  24161. If this Entry Is a directory, it cannot be deleted unless it Is
  24162. empty.
  24163. </summary>
  24164. <returns>
  24165. true if the Entry was successfully deleted, else false
  24166. </returns>
  24167. </member>
  24168. <member name="M:NPOI.POIFS.FileSystem.EntryNode.RenameTo(System.String)">
  24169. <summary>
  24170. Rename this Entry. ThIs operation will fail if:
  24171. There Is a sibling Entry (i.e., an Entry whose parent Is the
  24172. same as this Entry's parent) with the same name.
  24173. ThIs Entry Is the root of the Entry tree. Its name Is dictated
  24174. by the Filesystem and many not be Changed.
  24175. </summary>
  24176. <param name="newName">the new name for this Entry</param>
  24177. <returns>
  24178. true if the operation succeeded, else false
  24179. </returns>
  24180. </member>
  24181. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  24182. Copies an Entry into a target POIFS directory, recursively
  24183. </member>
  24184. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  24185. Copies all the nodes from one POIFS Directory to another
  24186. @param sourceRoot
  24187. is the source Directory to copy from
  24188. @param targetRoot
  24189. is the target Directory to copy to
  24190. </member>
  24191. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.FilteringDirectoryNode,NPOI.POIFS.FileSystem.FilteringDirectoryNode)">
  24192. Copies nodes from one Directory to the other minus the excepts
  24193. @param filteredSource The filtering source Directory to copy from
  24194. @param filteredTarget The filtering target Directory to copy to
  24195. </member>
  24196. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  24197. Copies nodes from one Directory to the other minus the excepts
  24198. @param sourceRoot
  24199. is the source Directory to copy from
  24200. @param targetRoot
  24201. is the target Directory to copy to
  24202. @param excepts
  24203. is a list of Strings specifying what nodes NOT to copy
  24204. @deprecated use {@link FilteringDirectoryNode} instead
  24205. </member>
  24206. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem)">
  24207. Copies all nodes from one POIFS to the other
  24208. @param source
  24209. is the source POIFS to copy from
  24210. @param target
  24211. is the target POIFS to copy to
  24212. </member>
  24213. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  24214. Copies nodes from one POIFS to the other, minus the excepts.
  24215. This delegates the filtering work to {@link FilteringDirectoryNode},
  24216. so excepts can be of the form "NodeToExclude" or
  24217. "FilteringDirectory/ExcludedChildNode"
  24218. @param source is the source POIFS to copy from
  24219. @param target is the target POIFS to copy to
  24220. @param excepts is a list of Entry Names to be excluded from the copy
  24221. </member>
  24222. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDirectoriesIdentical(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  24223. Checks to see if the two Directories hold the same contents.
  24224. For this to be true, they must have entries with the same names,
  24225. no entries in one but not the other, and the size+contents
  24226. of each entry must match, and they must share names.
  24227. To exclude certain parts of the Directory from being checked,
  24228. use a {@link FilteringDirectoryNode}
  24229. </member>
  24230. <member name="M:NPOI.POIFS.FileSystem.EntryUtils.AreDocumentsIdentical(NPOI.POIFS.FileSystem.DocumentEntry,NPOI.POIFS.FileSystem.DocumentEntry)">
  24231. Checks to see if two Documents have the same name
  24232. and the same contents. (Their parent directories are
  24233. not checked)
  24234. </member>
  24235. <member name="T:NPOI.POIFS.FileSystem.FilteringDirectoryNode">
  24236. <summary>
  24237. A DirectoryEntry filter, which exposes another DirectoryEntry less certain parts.
  24238. This is typically used when copying or comparing Filesystems.
  24239. </summary>
  24240. </member>
  24241. <member name="M:NPOI.POIFS.FileSystem.FilteringDirectoryNode.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.ICollection{System.String})">
  24242. <summary>
  24243. Creates a filter round the specified directory, which will exclude entries such as
  24244. "MyNode" and "MyDir/IgnoreNode". The excludes can stretch into children, if they contain a /.
  24245. </summary>
  24246. <param name="directory">The Directory to filter</param>
  24247. <param name="excludes">The Entries to exclude</param>
  24248. </member>
  24249. <member name="T:NPOI.POIFS.FileSystem.NDocumentInputStream">
  24250. This class provides methods to read a DocumentEntry managed by a
  24251. {@link NPOIFSFileSystem} instance.
  24252. </member>
  24253. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_offset">
  24254. current offset into the Document
  24255. </member>
  24256. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._current_block_count">
  24257. current block count
  24258. </member>
  24259. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset">
  24260. current marked offset into the Document (used by mark and Reset)
  24261. </member>
  24262. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._marked_offset_count">
  24263. and the block count for it
  24264. </member>
  24265. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document_size">
  24266. the Document's size
  24267. </member>
  24268. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._closed">
  24269. have we been closed?
  24270. </member>
  24271. <member name="F:NPOI.POIFS.FileSystem.NDocumentInputStream._document">
  24272. the actual Document
  24273. </member>
  24274. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24275. Create an InputStream from the specified DocumentEntry
  24276. @param document the DocumentEntry to be read
  24277. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  24278. been deleted?)
  24279. </member>
  24280. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.#ctor(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  24281. Create an InputStream from the specified Document
  24282. @param document the Document to be read
  24283. </member>
  24284. <member name="M:NPOI.POIFS.FileSystem.NDocumentInputStream.Reset">
  24285. Repositions this stream to the position at the time the mark() method was
  24286. last called on this input stream. If mark() has not been called this
  24287. method repositions the stream to its beginning.
  24288. </member>
  24289. <member name="T:NPOI.POIFS.FileSystem.NDocumentOutputStream">
  24290. This class provides methods to write a DocumentEntry managed by a
  24291. {@link NPOIFSFileSystem} instance.
  24292. </member>
  24293. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document_size">
  24294. the Document's size
  24295. </member>
  24296. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._closed">
  24297. have we been closed?
  24298. </member>
  24299. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._document">
  24300. the actual Document
  24301. </member>
  24302. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._property">
  24303. and its Property
  24304. </member>
  24305. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._buffer">
  24306. our buffer, when null we're into normal blocks
  24307. </member>
  24308. <member name="F:NPOI.POIFS.FileSystem.NDocumentOutputStream._stream">
  24309. our main block stream, when we're into normal blocks
  24310. </member>
  24311. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24312. Create an OutputStream from the specified DocumentEntry.
  24313. The specified entry will be emptied.
  24314. @param document the DocumentEntry to be written
  24315. </member>
  24316. <member name="M:NPOI.POIFS.FileSystem.NDocumentOutputStream.#ctor(NPOI.POIFS.FileSystem.DirectoryEntry,System.String)">
  24317. Create an OutputStream to create the specified new Entry
  24318. @param parent Where to create the Entry
  24319. @param name Name of the new entry
  24320. </member>
  24321. <member name="T:NPOI.POIFS.FileSystem.NotOLE2FileException">
  24322. This exception is thrown when we try to open a file that doesn't
  24323. seem to actually be an OLE2 file After all
  24324. </member>
  24325. <member name="T:NPOI.POIFS.FileSystem.NPOIFSDocument">
  24326. This class manages a document in the NIO POIFS filesystem.
  24327. This is the {@link NPOIFSFileSystem} version.
  24328. </member>
  24329. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.FileSystem.DocumentNode)">
  24330. Constructor for an existing Document
  24331. </member>
  24332. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(NPOI.POIFS.Properties.DocumentProperty,NPOI.POIFS.FileSystem.NPOIFSFileSystem)">
  24333. Constructor for an existing Document
  24334. </member>
  24335. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.#ctor(System.String,NPOI.POIFS.FileSystem.NPOIFSFileSystem,System.IO.Stream)">
  24336. Constructor for a new Document
  24337. @param name the name of the POIFSDocument
  24338. @param stream the InputStream we read data from
  24339. </member>
  24340. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.Free">
  24341. Frees the underlying stream and property
  24342. </member>
  24343. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.Size">
  24344. @return size of the document
  24345. </member>
  24346. <member name="P:NPOI.POIFS.FileSystem.NPOIFSDocument.DocumentProperty">
  24347. @return the instance's DocumentProperty
  24348. </member>
  24349. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableArray">
  24350. Get an array of objects, some of which may implement POIFSViewable
  24351. @return an array of Object; may not be null, but may be empty
  24352. </member>
  24353. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetViewableIterator">
  24354. Get an Iterator of objects, some of which may implement POIFSViewable
  24355. @return an Iterator; may not be null, but may have an empty back end
  24356. store
  24357. </member>
  24358. <member name="M:NPOI.POIFS.FileSystem.NPOIFSDocument.GetShortDescription">
  24359. Provides a short description of the object, to be used when a
  24360. POIFSViewable object has not provided its contents.
  24361. @return short description
  24362. </member>
  24363. <member name="T:NPOI.POIFS.FileSystem.NPOIFSFileSystem">
  24364. This is the main class of the POIFS system; it manages the entire
  24365. life cycle of the filesystem.
  24366. This is the new NIO version
  24367. </member>
  24368. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  24369. Convenience method for clients that want to avoid the auto-close behaviour of the constructor.
  24370. </member>
  24371. <member name="F:NPOI.POIFS.FileSystem.NPOIFSFileSystem.bigBlockSize">
  24372. What big block size the file uses. Most files
  24373. use 512 bytes, but a few use 4096
  24374. </member>
  24375. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor">
  24376. Constructor, intended for writing
  24377. </member>
  24378. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileInfo,System.Boolean)">
  24379. <p>Creates a POIFSFileSystem from a <tt>File</tt>. This uses less memory than
  24380. creating from an <tt>InputStream</tt>.</p>
  24381. <p>Note that with this constructor, you will need to call {@link #close()}
  24382. when you're done to have the underlying file closed, as the file is
  24383. kept open during normal operation to read the data out.</p>
  24384. @param file the File from which to read or read/write the data
  24385. @param readOnly whether the POIFileSystem will only be used in read-only mode
  24386. @exception IOException on errors reading, or on invalid data
  24387. </member>
  24388. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream)">
  24389. * <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  24390. * less memory than creating from an <tt>InputStream</tt>. The stream will
  24391. * be used in read-only mode.</p>
  24392. *
  24393. * <p>Note that with this constructor, you will need to call {@link #close()}
  24394. * when you're done to have the underlying Channel closed, as the channel is
  24395. * kept open during normal operation to read the data out.</p>
  24396. *
  24397. * @param channel the FileChannel from which to read the data
  24398. *
  24399. * @exception IOException on errors reading, or on invalid data
  24400. </member>
  24401. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.FileStream,System.Boolean)">
  24402. <p>Creates a POIFSFileSystem from an open <tt>FileChannel</tt>. This uses
  24403. less memory than creating from an <tt>InputStream</tt>.</p>
  24404. <p>Note that with this constructor, you will need to call {@link #close()}
  24405. when you're done to have the underlying Channel closed, as the channel is
  24406. kept open during normal operation to read the data out.</p>
  24407. @param channel the FileChannel from which to read or read/write the data
  24408. @param readOnly whether the POIFileSystem will only be used in read-only mode
  24409. @exception IOException on errors reading, or on invalid data
  24410. </member>
  24411. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.#ctor(System.IO.Stream)">
  24412. Create a POIFSFileSystem from an <tt>InputStream</tt>. Normally the stream is read until
  24413. EOF. The stream is always closed.<p/>
  24414. Some streams are usable After reaching EOF (typically those that return <code>true</code>
  24415. for <tt>markSupported()</tt>). In the unlikely case that the caller has such a stream
  24416. <i>and</i> needs to use it After this constructor completes, a work around is to wrap the
  24417. stream in order to trap the <tt>close()</tt> call. A convenience method (
  24418. <tt>CreateNonClosingInputStream()</tt>) has been provided for this purpose:
  24419. <pre>
  24420. InputStream wrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  24421. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  24422. is.Reset();
  24423. doSomethingElse(is);
  24424. </pre>
  24425. Note also the special case of <tt>MemoryStream</tt> for which the <tt>close()</tt>
  24426. method does nothing.
  24427. <pre>
  24428. MemoryStream bais = ...
  24429. HSSFWorkbook wb = new HSSFWorkbook(bais); // calls bais.Close() !
  24430. bais.Reset(); // no problem
  24431. doSomethingElse(bais);
  24432. </pre>
  24433. @param stream the InputStream from which to read the data
  24434. @exception IOException on errors Reading, or on invalid data
  24435. </member>
  24436. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  24437. @param stream the stream to be closed
  24438. @param success <code>false</code> if an exception is currently being thrown in the calling method
  24439. </member>
  24440. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  24441. Checks that the supplied InputStream (which MUST
  24442. support mark and reset, or be a PushbackInputStream)
  24443. has a POIFS (OLE2) header at the start of it.
  24444. If your InputStream does not support mark / reset,
  24445. then wrap it in a PushBackInputStream, then be
  24446. sure to always use that, and not the original!
  24447. @param inp An InputStream which supports either mark/reset, or is a PushbackInputStream
  24448. </member>
  24449. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.HasPOIFSHeader(System.Byte[])">
  24450. Checks if the supplied first 8 bytes of a stream / file
  24451. has a POIFS (OLE2) header.
  24452. </member>
  24453. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.ReadCoreContents">
  24454. Read and process the PropertiesTable and the
  24455. FAT / XFAT blocks, so that we're Ready to
  24456. work with the file
  24457. </member>
  24458. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBlockAt(System.Int32)">
  24459. Load the block at the given offset.
  24460. </member>
  24461. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateBlockIfNeeded(System.Int32)">
  24462. Load the block at the given offset,
  24463. extending the file if needed
  24464. </member>
  24465. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBATBlockAndIndex(System.Int32)">
  24466. Returns the BATBlock that handles the specified offset,
  24467. and the relative index within it
  24468. </member>
  24469. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetNextBlock(System.Int32)">
  24470. Works out what block follows the specified one.
  24471. </member>
  24472. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.SetNextBlock(System.Int32,System.Int32)">
  24473. Changes the record of what block follows the specified one.
  24474. </member>
  24475. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetFreeBlock">
  24476. Finds a free block, and returns its offset.
  24477. This method will extend the file if needed, and if doing
  24478. so, allocate new FAT blocks to Address the extra space.
  24479. </member>
  24480. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.PropertyTable">
  24481. For unit Testing only! Returns the underlying
  24482. properties table
  24483. </member>
  24484. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetMiniStore">
  24485. Returns the MiniStore, which performs a similar low
  24486. level function to this, except for the small blocks.
  24487. </member>
  24488. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.NPOIFSDocument)">
  24489. add a new POIFSDocument to the FileSytem
  24490. @param document the POIFSDocument being Added
  24491. </member>
  24492. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  24493. add a new DirectoryProperty to the FileSystem
  24494. @param directory the DirectoryProperty being Added
  24495. </member>
  24496. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  24497. Create a new document to be Added to the root directory
  24498. @param stream the InputStream from which the document's data
  24499. will be obtained
  24500. @param name the name of the new POIFSDocument
  24501. @return the new DocumentEntry
  24502. @exception IOException on error creating the new POIFSDocument
  24503. </member>
  24504. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  24505. create a new DocumentEntry in the root entry; the data will be
  24506. provided later
  24507. @param name the name of the new DocumentEntry
  24508. @param size the size of the new DocumentEntry
  24509. @param Writer the Writer of the new DocumentEntry
  24510. @return the new DocumentEntry
  24511. @exception IOException
  24512. </member>
  24513. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDirectory(System.String)">
  24514. create a new DirectoryEntry in the root directory
  24515. @param name the name of the new DirectoryEntry
  24516. @return the new DirectoryEntry
  24517. @exception IOException on name duplication
  24518. </member>
  24519. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem">
  24520. Write the filesystem out to the open file. Will thrown an
  24521. {@link ArgumentException} if opened from an
  24522. {@link InputStream}.
  24523. @exception IOException thrown on errors writing to the stream
  24524. </member>
  24525. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  24526. Write the filesystem out
  24527. @param stream the OutputStream to which the filesystem will be
  24528. written
  24529. @exception IOException thrown on errors writing to the stream
  24530. </member>
  24531. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.syncWithDataSource">
  24532. Has our in-memory objects write their state
  24533. to their backing blocks
  24534. </member>
  24535. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Close">
  24536. Closes the FileSystem, freeing any underlying files, streams
  24537. and buffers. After this, you will be unable to read or
  24538. write from the FileSystem.
  24539. </member>
  24540. <member name="P:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Root">
  24541. Get the root entry
  24542. @return the root entry
  24543. </member>
  24544. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.CreateDocumentInputStream(System.String)">
  24545. open a document in the root entry's list of entries
  24546. @param documentName the name of the document to be opened
  24547. @return a newly opened DocumentInputStream
  24548. @exception IOException if the document does not exist or the
  24549. name is that of a DirectoryEntry
  24550. </member>
  24551. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  24552. remove an entry
  24553. @param entry to be Removed
  24554. </member>
  24555. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableArray">
  24556. Get an array of objects, some of which may implement
  24557. POIFSViewable
  24558. @return an array of Object; may not be null, but may be empty
  24559. </member>
  24560. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetViewableIterator">
  24561. Get an Iterator of objects, some of which may implement
  24562. POIFSViewable
  24563. @return an Iterator; may not be null, but may have an empty
  24564. back end store
  24565. </member>
  24566. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetShortDescription">
  24567. Provides a short description of the object, to be used when a
  24568. POIFSViewable object has not provided its contents.
  24569. @return short description
  24570. </member>
  24571. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSize">
  24572. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  24573. </member>
  24574. <member name="M:NPOI.POIFS.FileSystem.NPOIFSFileSystem.GetBigBlockSizeDetails">
  24575. @return The Big Block size, normally 512 bytes, sometimes 4096 bytes
  24576. </member>
  24577. <member name="T:NPOI.POIFS.FileSystem.NPOIFSMiniStore">
  24578. This class handles the MiniStream (small block store)
  24579. in the NIO case for {@link NPOIFSFileSystem}
  24580. </member>
  24581. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBlockAt(System.Int32)">
  24582. Load the block at the given offset.
  24583. </member>
  24584. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.CreateBlockIfNeeded(System.Int32)">
  24585. Load the block, extending the underlying stream if needed
  24586. </member>
  24587. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetBATBlockAndIndex(System.Int32)">
  24588. Returns the BATBlock that handles the specified offset,
  24589. and the relative index within it
  24590. </member>
  24591. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetNextBlock(System.Int32)">
  24592. Works out what block follows the specified one.
  24593. </member>
  24594. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SetNextBlock(System.Int32,System.Int32)">
  24595. Changes the record of what block follows the specified one.
  24596. </member>
  24597. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.GetFreeBlock">
  24598. Finds a free block, and returns its offset.
  24599. This method will extend the file if needed, and if doing
  24600. so, allocate new FAT blocks to Address the extra space.
  24601. </member>
  24602. <member name="M:NPOI.POIFS.FileSystem.NPOIFSMiniStore.SyncWithDataSource">
  24603. Writes the SBATs to their backing blocks
  24604. </member>
  24605. <member name="T:NPOI.POIFS.FileSystem.NPOIFSStream">
  24606. This handles Reading and writing a stream within a
  24607. {@link NPOIFSFileSystem}. It can supply an iterator
  24608. to read blocks, and way to write out to existing and
  24609. new blocks.
  24610. Most users will want a higher level version of this,
  24611. which deals with properties to track which stream
  24612. this is.
  24613. This only works on big block streams, it doesn't
  24614. handle small block ones.
  24615. This uses the new NIO code
  24616. TODO Implement a streaming write method, and append
  24617. </member>
  24618. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore,System.Int32)">
  24619. Constructor for an existing stream. It's up to you
  24620. to know how to Get the start block (eg from a
  24621. {@link HeaderBlock} or a {@link Property})
  24622. </member>
  24623. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.#ctor(NPOI.POIFS.FileSystem.BlockStore)">
  24624. Constructor for a new stream. A start block won't
  24625. be allocated until you begin writing to it.
  24626. </member>
  24627. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetStartBlock">
  24628. What block does this stream start at?
  24629. Will be {@link POIFSConstants#END_OF_CHAIN} for a
  24630. new stream that hasn't been written to yet.
  24631. </member>
  24632. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.GetBlockIterator">
  24633. Returns an iterator that'll supply one {@link ByteBuffer}
  24634. per block in the stream.
  24635. </member>
  24636. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.UpdateContents(System.Byte[])">
  24637. Updates the contents of the stream to the new
  24638. Set of bytes.
  24639. Note - if this is property based, you'll still
  24640. need to update the size in the property yourself
  24641. </member>
  24642. <member name="M:NPOI.POIFS.FileSystem.NPOIFSStream.Free">
  24643. Frees all blocks in the stream
  24644. </member>
  24645. <member name="T:NPOI.POIFS.FileSystem.ODocumentInputStream">
  24646. This class provides methods to read a DocumentEntry managed by a
  24647. {@link POIFSFileSystem} instance.
  24648. @author Marc Johnson (mjohnson at apache dot org)
  24649. </member>
  24650. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._current_offset">
  24651. current offset into the Document
  24652. </member>
  24653. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._marked_offset">
  24654. current marked offset into the Document (used by mark and Reset)
  24655. </member>
  24656. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document_size">
  24657. the Document's size
  24658. </member>
  24659. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._closed">
  24660. have we been closed?
  24661. </member>
  24662. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._document">
  24663. the actual Document
  24664. </member>
  24665. <member name="F:NPOI.POIFS.FileSystem.ODocumentInputStream._currentBlock">
  24666. the data block Containing the current stream pointer
  24667. </member>
  24668. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24669. Create an InputStream from the specified DocumentEntry
  24670. @param document the DocumentEntry to be read
  24671. @exception IOException if the DocumentEntry cannot be opened (like, maybe it has
  24672. been deleted?)
  24673. </member>
  24674. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  24675. Create an InputStream from the specified Document
  24676. @param document the Document to be read
  24677. </member>
  24678. <member name="M:NPOI.POIFS.FileSystem.ODocumentInputStream.Reset">
  24679. Repositions this stream to the position at the time the mark() method was
  24680. last called on this input stream. If mark() has not been called this
  24681. method repositions the stream to its beginning.
  24682. </member>
  24683. <member name="T:NPOI.POIFS.FileSystem.OfficeXmlFileException">
  24684. <summary>
  24685. This exception is thrown when we try to open a file that's actually
  24686. an Office 2007+ XML file, rather than an OLE2 file (which is what
  24687. POIFS works with)
  24688. </summary>
  24689. </member>
  24690. <member name="T:NPOI.POIFS.FileSystem.Ole10Native">
  24691. Represents an Ole10Native record which is wrapped around certain binary
  24692. files being embedded in OLE2 documents.
  24693. @author Rainer Schwarze
  24694. </member>
  24695. <member name="T:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode">
  24696. the field encoding mode - merely a try-and-error guess ...
  24697. </member>
  24698. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.parsed">
  24699. the data is stored in parsed format - including label, command, etc.
  24700. </member>
  24701. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.unparsed">
  24702. the data is stored raw after the length field
  24703. </member>
  24704. <member name="F:NPOI.POIFS.FileSystem.Ole10Native.EncodingMode.compact">
  24705. the data is stored raw after the length field and the flags1 field
  24706. </member>
  24707. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.POIFSFileSystem)">
  24708. <summary>
  24709. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  24710. to include a stream &quot;{01}Ole10Native&quot; which Contains the actual
  24711. data relevant for this class.
  24712. </summary>
  24713. <param name="poifs">poifs POI Filesystem object</param>
  24714. <returns>Returns an instance of this class</returns>
  24715. </member>
  24716. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.CreateFromEmbeddedOleObject(NPOI.POIFS.FileSystem.DirectoryNode)">
  24717. <summary>
  24718. Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
  24719. to include a stream &quot;{01}Ole10Native&quot; which contains the actual
  24720. data relevant for this class.
  24721. </summary>
  24722. <param name="directory">directory POI Filesystem object</param>
  24723. <returns>Returns an instance of this class</returns>
  24724. </member>
  24725. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.String,System.String,System.String,System.Byte[])">
  24726. Creates an instance and fills the fields based on ... the fields
  24727. </member>
  24728. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32,System.Boolean)">
  24729. Creates an instance and Fills the fields based on the data in the given buffer.
  24730. @param data The buffer Containing the Ole10Native record
  24731. @param offset The start offset of the record in the buffer
  24732. @param plain as of POI 3.11 this parameter is ignored
  24733. @throws Ole10NativeException on invalid or unexcepted data format
  24734. </member>
  24735. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.#ctor(System.Byte[],System.Int32)">
  24736. Creates an instance and Fills the fields based on the data in the given buffer.
  24737. @param data The buffer Containing the Ole10Native record
  24738. @param offset The start offset of the record in the buffer
  24739. @throws Ole10NativeException on invalid or unexcepted data format
  24740. </member>
  24741. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.TotalSize">
  24742. Returns the value of the totalSize field - the total length of the structure
  24743. is totalSize + 4 (value of this field + size of this field).
  24744. @return the totalSize
  24745. </member>
  24746. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags1">
  24747. Returns flags1 - currently unknown - usually 0x0002.
  24748. @return the flags1
  24749. </member>
  24750. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Label">
  24751. Returns the label field - usually the name of the file (without directory) but
  24752. probably may be any name specified during packaging/embedding the data.
  24753. @return the label
  24754. </member>
  24755. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.FileName">
  24756. Returns the fileName field - usually the name of the file being embedded
  24757. including the full path.
  24758. @return the fileName
  24759. </member>
  24760. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags2">
  24761. Returns flags2 - currently unknown - mostly 0x0000.
  24762. @return the flags2
  24763. </member>
  24764. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Unknown1">
  24765. Returns unknown1 field - currently unknown.
  24766. @return the unknown1
  24767. </member>
  24768. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Command">
  24769. Returns the command field - usually the name of the file being embedded
  24770. including the full path, may be a command specified during embedding the file.
  24771. @return the command
  24772. </member>
  24773. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataSize">
  24774. Returns the size of the embedded file. If the size is 0 (zero), no data has been
  24775. embedded. To be sure, that no data has been embedded, check whether
  24776. {@link #getDataBuffer()} returns <code>null</code>.
  24777. @return the dataSize
  24778. </member>
  24779. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.DataBuffer">
  24780. Returns the buffer Containing the embedded file's data, or <code>null</code>
  24781. if no data was embedded. Note that an embedding may provide information about
  24782. the data, but the actual data is not included. (So label, filename etc. are
  24783. available, but this method returns <code>null</code>.)
  24784. @return the dataBuffer
  24785. </member>
  24786. <member name="P:NPOI.POIFS.FileSystem.Ole10Native.Flags3">
  24787. Returns the flags3 - currently unknown.
  24788. @return the flags3
  24789. </member>
  24790. <member name="M:NPOI.POIFS.FileSystem.Ole10Native.WriteOut(System.IO.Stream)">
  24791. Have the contents printer out into an OutputStream, used when writing a
  24792. file back out to disk (Normally, atom classes will keep their bytes
  24793. around, but non atom classes will just request the bytes from their
  24794. children, then chuck on their header and return)
  24795. </member>
  24796. <member name="T:NPOI.POIFS.FileSystem.POIFSDocument">
  24797. <summary>
  24798. This class manages a document in the POIFS filesystem.
  24799. @author Marc Johnson (mjohnson at apache dot org)
  24800. </summary>
  24801. </member>
  24802. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.#ctor(System.String,System.IO.Stream)">
  24803. <summary>
  24804. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSDocument"/> class.
  24805. </summary>
  24806. <param name="name">the name of the POIFSDocument</param>
  24807. <param name="stream">the InputStream we read data from</param>
  24808. </member>
  24809. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.#ctor(System.String,NPOI.POIFS.Storage.ListManagedBlock[],System.Int32)">
  24810. <summary>
  24811. Constructor from small blocks
  24812. </summary>
  24813. <param name="name">the name of the POIFSDocument</param>
  24814. <param name="blocks">the small blocks making up the POIFSDocument</param>
  24815. <param name="length">the actual length of the POIFSDocument</param>
  24816. </member>
  24817. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.Read(System.Byte[],System.Int32)">
  24818. <summary>
  24819. read data from the internal stores
  24820. </summary>
  24821. <param name="buffer">the buffer to write to</param>
  24822. <param name="offset">the offset into our storage to read from</param>
  24823. </member>
  24824. <member name="M:NPOI.POIFS.FileSystem.POIFSDocument.WriteBlocks(System.IO.Stream)">
  24825. <summary>
  24826. Writes the blocks.
  24827. </summary>
  24828. <param name="stream">The stream.</param>
  24829. </member>
  24830. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.CountBlocks">
  24831. <summary>
  24832. Gets the number of BigBlock's this instance uses
  24833. </summary>
  24834. <value>count of BigBlock instances</value>
  24835. </member>
  24836. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.DocumentProperty">
  24837. <summary>
  24838. Gets the document property.
  24839. </summary>
  24840. <value>The document property.</value>
  24841. </member>
  24842. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.PreferArray">
  24843. <summary>
  24844. Provides a short description of the object to be used when a
  24845. POIFSViewable object has not provided its contents.
  24846. </summary>
  24847. <value><c>true</c> if [prefer array]; otherwise, <c>false</c>.</value>
  24848. </member>
  24849. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ShortDescription">
  24850. <summary>
  24851. Gets the short description.
  24852. </summary>
  24853. <value>The short description.</value>
  24854. </member>
  24855. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.Size">
  24856. <summary>
  24857. Gets the size.
  24858. </summary>
  24859. <value>The size.</value>
  24860. </member>
  24861. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.SmallBlocks">
  24862. <summary>
  24863. Gets the small blocks.
  24864. </summary>
  24865. <value>The small blocks.</value>
  24866. </member>
  24867. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.StartBlock">
  24868. <summary>
  24869. Sets the start block for this instance
  24870. </summary>
  24871. <value>
  24872. index into the array of BigBlock instances making up the the filesystem
  24873. </value>
  24874. </member>
  24875. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ViewableArray">
  24876. <summary>
  24877. Get an array of objects, some of which may implement POIFSViewable
  24878. </summary>
  24879. <value>The viewable array.</value>
  24880. </member>
  24881. <member name="P:NPOI.POIFS.FileSystem.POIFSDocument.ViewableIterator">
  24882. <summary>
  24883. Give viewers a hint as to whether to call ViewableArray or ViewableIterator
  24884. </summary>
  24885. <value>The viewable iterator.</value>
  24886. </member>
  24887. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentPath">
  24888. <summary>
  24889. Class POIFSDocumentPath
  24890. @author Marc Johnson (mjohnson at apache dot org)
  24891. </summary>
  24892. </member>
  24893. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor">
  24894. <summary>
  24895. simple constructor for the path of a document that is in the
  24896. root of the POIFSFileSystem. The constructor that takes an
  24897. array of Strings can also be used to create such a
  24898. POIFSDocumentPath by passing it a null or empty String array
  24899. </summary>
  24900. </member>
  24901. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(System.String[])">
  24902. <summary>
  24903. constructor for the path of a document that is not in the root
  24904. of the POIFSFileSystem
  24905. </summary>
  24906. <param name="components">the Strings making up the path to a document.
  24907. The Strings must be ordered as they appear in
  24908. the directory hierarchy of the the document
  24909. -- the first string must be the name of a
  24910. directory in the root of the POIFSFileSystem,
  24911. and every Nth (for N &gt; 1) string thereafter
  24912. must be the name of a directory in the
  24913. directory identified by the (N-1)th string.
  24914. If the components parameter is null or has
  24915. zero length, the POIFSDocumentPath is
  24916. appropriate for a document that is in the
  24917. root of a POIFSFileSystem</param>
  24918. </member>
  24919. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.#ctor(NPOI.POIFS.FileSystem.POIFSDocumentPath,System.String[])">
  24920. <summary>
  24921. constructor that adds additional subdirectories to an existing
  24922. path
  24923. </summary>
  24924. <param name="path">the existing path</param>
  24925. <param name="components">the additional subdirectory names to be added</param>
  24926. </member>
  24927. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.Equals(System.Object)">
  24928. <summary>
  24929. equality. Two POIFSDocumentPath instances are equal if they
  24930. have the same number of component Strings, and if each
  24931. component String is equal to its coresponding component String
  24932. </summary>
  24933. <param name="o">the object we're checking equality for</param>
  24934. <returns>true if the object is equal to this object</returns>
  24935. </member>
  24936. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetComponent(System.Int32)">
  24937. <summary>
  24938. get the specified component
  24939. </summary>
  24940. <param name="n">which component (0 ... length() - 1)</param>
  24941. <returns>the nth component;</returns>
  24942. </member>
  24943. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.GetHashCode">
  24944. <summary>
  24945. Serves as a hash function for a particular type.
  24946. </summary>
  24947. <returns>
  24948. A hash code for the current <see cref="T:System.Object"/>.
  24949. </returns>
  24950. </member>
  24951. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentPath.ToString">
  24952. <summary>
  24953. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24954. </summary>
  24955. <returns>
  24956. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  24957. </returns>
  24958. </member>
  24959. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Length">
  24960. <summary>
  24961. Gets the length.
  24962. </summary>
  24963. <value>the number of components</value>
  24964. </member>
  24965. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentPath.Parent">
  24966. <summary>
  24967. Returns the path's parent or <c>null</c> if this path
  24968. is the root path.
  24969. </summary>
  24970. <value>path of parent, or null if this path is the root path</value>
  24971. </member>
  24972. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentReader">
  24973. <summary>
  24974. This class provides methods to read a DocumentEntry managed by a
  24975. Filesystem instance.
  24976. @author Marc Johnson (mjohnson at apache dot org)
  24977. </summary>
  24978. </member>
  24979. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.DocumentEntry)">
  24980. <summary>
  24981. Create an InputStream from the specified DocumentEntry
  24982. </summary>
  24983. <param name="document">the DocumentEntry to be read</param>
  24984. </member>
  24985. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.#ctor(NPOI.POIFS.FileSystem.POIFSDocument)">
  24986. <summary>
  24987. Create an InputStream from the specified Document
  24988. </summary>
  24989. <param name="document">the Document to be read</param>
  24990. </member>
  24991. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.EOD">
  24992. <summary>
  24993. at the end Of document.
  24994. </summary>
  24995. <returns></returns>
  24996. </member>
  24997. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Available">
  24998. <summary>
  24999. Returns the number of bytes that can be read (or skipped over)
  25000. from this input stream without blocking by the next caller of a
  25001. method for this input stream. The next caller might be the same
  25002. thread or or another thread.
  25003. </summary>
  25004. <value>the number of bytes that can be read from this input
  25005. stream without blocking.</value>
  25006. </member>
  25007. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Close">
  25008. <summary>
  25009. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  25010. </summary>
  25011. </member>
  25012. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[])">
  25013. <summary>
  25014. Reads some number of bytes from the input stream and stores
  25015. them into the buffer array b. The number of bytes actually read
  25016. is returned as an integer. The definition of this method in
  25017. java.io.InputStream allows this method to block, but it won't.
  25018. If b is null, a NullPointerException is thrown. If the length
  25019. of b is zero, then no bytes are read and 0 is returned;
  25020. otherwise, there is an attempt to read at least one byte. If no
  25021. byte is available because the stream is at end of file, the
  25022. value -1 is returned; otherwise, at least one byte is read and
  25023. stored into b.
  25024. The first byte read is stored into element b[0], the next one
  25025. into b[1], and so on. The number of bytes read is, at most,
  25026. equal to the length of b. Let k be the number of bytes actually
  25027. read; these bytes will be stored in elements b[0] through
  25028. b[k-1], leaving elements b[k] through b[b.length-1] unaffected.
  25029. If the first byte cannot be read for any reason other than end
  25030. of file, then an IOException is thrown. In particular, an
  25031. IOException is thrown if the input stream has been closed.
  25032. The read(b) method for class InputStream has the same effect as:
  25033. </summary>
  25034. <param name="b">the buffer into which the data is read.</param>
  25035. <returns>the total number of bytes read into the buffer, or -1
  25036. if there is no more data because the end of the stream
  25037. has been reached.</returns>
  25038. </member>
  25039. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Read(System.Byte[],System.Int32,System.Int32)">
  25040. <summary>
  25041. Reads up to len bytes of data from the input stream into an
  25042. array of bytes. An attempt is made to read as many as len
  25043. bytes, but a smaller number may be read, possibly zero. The
  25044. number of bytes actually read is returned as an integer.
  25045. The definition of this method in java.io.InputStream allows it
  25046. to block, but it won't.
  25047. If b is null, a NullPointerException is thrown.
  25048. If off is negative, or len is negative, or off+len is greater
  25049. than the length of the array b, then an
  25050. IndexOutOfBoundsException is thrown.
  25051. If len is zero, then no bytes are read and 0 is returned;
  25052. otherwise, there is an attempt to read at least one byte. If no
  25053. byte is available because the stream is at end of file, the
  25054. value -1 is returned; otherwise, at least one byte is read and
  25055. stored into b.
  25056. The first byte read is stored into element b[off], the next one
  25057. into b[off+1], and so on. The number of bytes read is, at most,
  25058. equal to len. Let k be the number of bytes actually read; these
  25059. bytes will be stored in elements b[off] through b[off+k-1],
  25060. leaving elements b[off+k] through b[off+len-1] unaffected.
  25061. In every case, elements b[0] through b[off] and elements
  25062. b[off+len] through b[b.length-1] are unaffected.
  25063. If the first byte cannot be read for any reason other than end
  25064. of file, then an IOException is thrown. In particular, an
  25065. IOException is thrown if the input stream has been closed.
  25066. </summary>
  25067. <param name="b">the buffer into which the data is read.</param>
  25068. <param name="off">the start offset in array b at which the data is
  25069. written.</param>
  25070. <param name="len">the maximum number of bytes to read.</param>
  25071. <returns>the total number of bytes read into the buffer, or -1
  25072. if there is no more data because the end of the stream
  25073. has been reached.</returns>
  25074. </member>
  25075. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.ReadByte">
  25076. <summary>
  25077. Reads the next byte of data from the input stream. The value
  25078. byte is returned as an int in the range 0 to 255. If no byte is
  25079. available because the end of the stream has been reached, the
  25080. value -1 is returned. The definition of this method in
  25081. java.io.InputStream allows this method to block, but it won't.
  25082. </summary>
  25083. <returns>the next byte of data, or -1 if the end of the stream
  25084. is reached.
  25085. </returns>
  25086. </member>
  25087. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Seek(System.Int64,System.IO.SeekOrigin)">
  25088. <summary>
  25089. When overridden in a derived class, sets the position within the current stream.
  25090. </summary>
  25091. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  25092. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  25093. <returns>
  25094. The new position within the current stream.
  25095. </returns>
  25096. <exception cref="T:System.IO.IOException">
  25097. An I/O error occurs.
  25098. </exception>
  25099. <exception cref="T:System.NotSupportedException">
  25100. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  25101. </exception>
  25102. <exception cref="T:System.ObjectDisposedException">
  25103. Methods were called after the stream was closed.
  25104. </exception>
  25105. </member>
  25106. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Skip(System.Int64)">
  25107. <summary>
  25108. Skips the specified n.
  25109. </summary>
  25110. <param name="n">The n.</param>
  25111. <returns></returns>
  25112. </member>
  25113. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentReader.Write(System.Byte[],System.Int32,System.Int32)">
  25114. <summary>
  25115. 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.
  25116. </summary>
  25117. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  25118. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  25119. <param name="count">The number of bytes to be written to the current stream.</param>
  25120. <exception cref="T:System.ArgumentException">
  25121. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  25122. </exception>
  25123. <exception cref="T:System.ArgumentNullException">
  25124. <paramref name="buffer"/> is null.
  25125. </exception>
  25126. <exception cref="T:System.ArgumentOutOfRangeException">
  25127. <paramref name="offset"/> or <paramref name="count"/> is negative.
  25128. </exception>
  25129. <exception cref="T:System.IO.IOException">
  25130. An I/O error occurs.
  25131. </exception>
  25132. <exception cref="T:System.NotSupportedException">
  25133. The stream does not support writing.
  25134. </exception>
  25135. <exception cref="T:System.ObjectDisposedException">
  25136. Methods were called after the stream was closed.
  25137. </exception>
  25138. </member>
  25139. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanRead">
  25140. <summary>
  25141. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  25142. </summary>
  25143. <value></value>
  25144. <returns>true if the stream supports reading; otherwise, false.
  25145. </returns>
  25146. </member>
  25147. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanSeek">
  25148. <summary>
  25149. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  25150. </summary>
  25151. <value></value>
  25152. <returns>true if the stream supports seeking; otherwise, false.
  25153. </returns>
  25154. </member>
  25155. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.CanWrite">
  25156. <summary>
  25157. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  25158. </summary>
  25159. <value></value>
  25160. <returns>true if the stream supports writing; otherwise, false.
  25161. </returns>
  25162. </member>
  25163. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Length">
  25164. <summary>
  25165. When overridden in a derived class, gets the length in bytes of the stream.
  25166. </summary>
  25167. <value></value>
  25168. <returns>
  25169. A long value representing the length of the stream in bytes.
  25170. </returns>
  25171. <exception cref="T:System.NotSupportedException">
  25172. A class derived from Stream does not support seeking.
  25173. </exception>
  25174. <exception cref="T:System.ObjectDisposedException">
  25175. Methods were called after the stream was closed.
  25176. </exception>
  25177. </member>
  25178. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentReader.Position">
  25179. <summary>
  25180. When overridden in a derived class, gets or sets the position within the current stream.
  25181. </summary>
  25182. <value></value>
  25183. <returns>
  25184. The current position within the stream.
  25185. </returns>
  25186. <exception cref="T:System.IO.IOException">
  25187. An I/O error occurs.
  25188. </exception>
  25189. <exception cref="T:System.NotSupportedException">
  25190. The stream does not support seeking.
  25191. </exception>
  25192. <exception cref="T:System.ObjectDisposedException">
  25193. Methods were called after the stream was closed.
  25194. </exception>
  25195. </member>
  25196. <member name="T:NPOI.POIFS.FileSystem.POIFSDocumentWriter">
  25197. <summary>
  25198. This class provides a wrapper over an OutputStream so that Document
  25199. writers can't accidently go over their size limits
  25200. @author Marc Johnson (mjohnson at apache dot org)
  25201. </summary>
  25202. </member>
  25203. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.#ctor(System.IO.Stream,System.Int32)">
  25204. <summary>
  25205. Create a POIFSDocumentWriter
  25206. </summary>
  25207. <param name="stream">the OutputStream to which the data is actually</param>
  25208. <param name="limit">the maximum number of bytes that can be written</param>
  25209. </member>
  25210. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Close">
  25211. <summary>
  25212. Closes this output stream and releases any system resources
  25213. associated with this stream. The general contract of close is
  25214. that it closes the output stream. A closed stream cannot
  25215. perform output operations and cannot be reopened.
  25216. </summary>
  25217. </member>
  25218. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Flush">
  25219. <summary>
  25220. Flushes this output stream and forces any buffered output bytes
  25221. to be written out.
  25222. </summary>
  25223. </member>
  25224. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[])">
  25225. <summary>
  25226. Writes b.length bytes from the specified byte array
  25227. to this output stream.
  25228. </summary>
  25229. <param name="b">the data.</param>
  25230. </member>
  25231. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Write(System.Byte[],System.Int32,System.Int32)">
  25232. <summary>
  25233. Writes len bytes from the specified byte array starting at
  25234. offset off to this output stream. The general contract for
  25235. write(b, off, len) is that some of the bytes in the array b are
  25236. written to the output stream in order; element b[off] is the
  25237. first byte written and b[off+len-1] is the last byte written by
  25238. this operation.
  25239. If b is null, a NullPointerException is thrown.
  25240. If off is negative, or len is negative, or off+len is greater
  25241. than the length of the array b, then an
  25242. IndexOutOfBoundsException is thrown.
  25243. </summary>
  25244. <param name="b">the data.</param>
  25245. <param name="off">the start offset in the data.</param>
  25246. <param name="len">the number of bytes to write.</param>
  25247. </member>
  25248. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteByte(System.Byte)">
  25249. <summary>
  25250. Writes the specified byte to this output stream. The general
  25251. contract for write is that one byte is written to the output
  25252. stream. The byte to be written is the eight low-order bits of
  25253. the argument b. The 24 high-order bits of b are ignored.
  25254. </summary>
  25255. <param name="b">the byte.</param>
  25256. </member>
  25257. <member name="M:NPOI.POIFS.FileSystem.POIFSDocumentWriter.WriteFiller(System.Int32,System.Byte)">
  25258. <summary>
  25259. write the rest of the document's data (fill in at the end)
  25260. </summary>
  25261. <param name="totalLimit">the actual number of bytes the corresponding
  25262. document must fill</param>
  25263. <param name="fill">the byte to fill remaining space with</param>
  25264. </member>
  25265. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanRead">
  25266. <summary>
  25267. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  25268. </summary>
  25269. <value></value>
  25270. <returns>true if the stream supports reading; otherwise, false.
  25271. </returns>
  25272. </member>
  25273. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanSeek">
  25274. <summary>
  25275. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  25276. </summary>
  25277. <value></value>
  25278. <returns>true if the stream supports seeking; otherwise, false.
  25279. </returns>
  25280. </member>
  25281. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.CanWrite">
  25282. <summary>
  25283. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  25284. </summary>
  25285. <value></value>
  25286. <returns>true if the stream supports writing; otherwise, false.
  25287. </returns>
  25288. </member>
  25289. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Length">
  25290. <summary>
  25291. When overridden in a derived class, gets the length in bytes of the stream.
  25292. </summary>
  25293. <value></value>
  25294. <returns>
  25295. A long value representing the length of the stream in bytes.
  25296. </returns>
  25297. <exception cref="T:System.NotSupportedException">
  25298. A class derived from Stream does not support seeking.
  25299. </exception>
  25300. <exception cref="T:System.ObjectDisposedException">
  25301. Methods were called after the stream was closed.
  25302. </exception>
  25303. </member>
  25304. <member name="P:NPOI.POIFS.FileSystem.POIFSDocumentWriter.Position">
  25305. <summary>
  25306. When overridden in a derived class, gets or sets the position within the current stream.
  25307. </summary>
  25308. <value></value>
  25309. <returns>
  25310. The current position within the stream.
  25311. </returns>
  25312. <exception cref="T:System.IO.IOException">
  25313. An I/O error occurs.
  25314. </exception>
  25315. <exception cref="T:System.NotSupportedException">
  25316. The stream does not support seeking.
  25317. </exception>
  25318. <exception cref="T:System.ObjectDisposedException">
  25319. Methods were called after the stream was closed.
  25320. </exception>
  25321. </member>
  25322. <member name="T:NPOI.POIFS.FileSystem.POIFSFileSystem">
  25323. <summary>
  25324. This is the main class of the POIFS system; it manages the entire
  25325. life cycle of the filesystem.
  25326. @author Marc Johnson (mjohnson at apache dot org)
  25327. </summary>
  25328. </member>
  25329. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateNonClosingInputStream(System.IO.Stream)">
  25330. <summary>
  25331. Convenience method for clients that want to avoid the auto-Close behaviour of the constructor.
  25332. </summary>
  25333. <param name="stream">The stream.</param>
  25334. <example>
  25335. A convenience method (
  25336. CreateNonClosingInputStream()) has been provided for this purpose:
  25337. StreamwrappedStream = POIFSFileSystem.CreateNonClosingInputStream(is);
  25338. HSSFWorkbook wb = new HSSFWorkbook(wrappedStream);
  25339. is.reset();
  25340. doSomethingElse(is);
  25341. </example>
  25342. <returns></returns>
  25343. </member>
  25344. <member name="F:NPOI.POIFS.FileSystem.POIFSFileSystem.bigBlockSize">
  25345. What big block size the file uses. Most files
  25346. use 512 bytes, but a few use 4096
  25347. </member>
  25348. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor">
  25349. <summary>
  25350. Initializes a new instance of the <see cref="T:NPOI.POIFS.FileSystem.POIFSFileSystem"/> class. intended for writing
  25351. </summary>
  25352. </member>
  25353. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.#ctor(System.IO.Stream)">
  25354. <summary>
  25355. Create a POIFSFileSystem from an Stream. Normally the stream is Read until
  25356. EOF. The stream is always Closed. In the unlikely case that the caller has such a stream and
  25357. needs to use it after this constructor completes, a work around is to wrap the
  25358. stream in order to trap the Close() call.
  25359. </summary>
  25360. <param name="stream">the Streamfrom which to Read the data</param>
  25361. </member>
  25362. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CloseInputStream(System.IO.Stream,System.Boolean)">
  25363. @param stream the stream to be Closed
  25364. @param success <c>false</c> if an exception is currently being thrown in the calling method
  25365. </member>
  25366. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.HasPOIFSHeader(System.IO.Stream)">
  25367. <summary>
  25368. Checks that the supplied Stream(which MUST
  25369. support mark and reset, or be a PushbackInputStream)
  25370. has a POIFS (OLE2) header at the start of it.
  25371. If your Streamdoes not support mark / reset,
  25372. then wrap it in a PushBackInputStream, then be
  25373. sure to always use that, and not the original!
  25374. </summary>
  25375. <param name="inp">An Streamwhich supports either mark/reset, or is a PushbackStream</param>
  25376. <returns>
  25377. <c>true</c> if [has POIFS header] [the specified inp]; otherwise, <c>false</c>.
  25378. </returns>
  25379. </member>
  25380. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocument(System.IO.Stream,System.String)">
  25381. <summary>
  25382. Create a new document to be Added to the root directory
  25383. </summary>
  25384. <param name="stream"> the Streamfrom which the document's data will be obtained</param>
  25385. <param name="name">the name of the new POIFSDocument</param>
  25386. <returns>the new DocumentEntry</returns>
  25387. </member>
  25388. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocument(System.String,System.Int32,NPOI.POIFS.EventFileSystem.POIFSWriterListener)">
  25389. <summary>
  25390. Create a new DocumentEntry in the root entry; the data will be
  25391. provided later
  25392. </summary>
  25393. <param name="name">the name of the new DocumentEntry</param>
  25394. <param name="size">the size of the new DocumentEntry</param>
  25395. <param name="writer">the Writer of the new DocumentEntry</param>
  25396. <returns>the new DocumentEntry</returns>
  25397. </member>
  25398. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDirectory(System.String)">
  25399. <summary>
  25400. Create a new DirectoryEntry in the root directory
  25401. </summary>
  25402. <param name="name">the name of the new DirectoryEntry</param>
  25403. <returns>the new DirectoryEntry</returns>
  25404. </member>
  25405. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.CreateDocumentInputStream(System.String)">
  25406. open a document in the root entry's list of entries
  25407. @param documentName the name of the document to be opened
  25408. @return a newly opened DocumentInputStream
  25409. @exception IOException if the document does not exist or the
  25410. name is that of a DirectoryEntry
  25411. </member>
  25412. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.WriteFileSystem(System.IO.Stream)">
  25413. <summary>
  25414. Writes the file system.
  25415. </summary>
  25416. <param name="stream">the OutputStream to which the filesystem will be
  25417. written</param>
  25418. </member>
  25419. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.Root">
  25420. <summary>
  25421. Get the root entry
  25422. </summary>
  25423. <value>The root.</value>
  25424. </member>
  25425. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.AddDocument(NPOI.POIFS.FileSystem.POIFSDocument)">
  25426. <summary>
  25427. Add a new POIFSDocument
  25428. </summary>
  25429. <param name="document">the POIFSDocument being Added</param>
  25430. </member>
  25431. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.AddDirectory(NPOI.POIFS.Properties.DirectoryProperty)">
  25432. <summary>
  25433. Add a new DirectoryProperty
  25434. </summary>
  25435. <param name="directory">The directory.</param>
  25436. </member>
  25437. <member name="M:NPOI.POIFS.FileSystem.POIFSFileSystem.Remove(NPOI.POIFS.FileSystem.EntryNode)">
  25438. <summary>
  25439. Removes the specified entry.
  25440. </summary>
  25441. <param name="entry">The entry.</param>
  25442. </member>
  25443. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ViewableArray">
  25444. <summary>
  25445. Get an array of objects, some of which may implement
  25446. POIFSViewable
  25447. </summary>
  25448. <value>an array of Object; may not be null, but may be empty</value>
  25449. </member>
  25450. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ViewableIterator">
  25451. <summary>
  25452. Get an Iterator of objects, some of which may implement
  25453. POIFSViewable
  25454. </summary>
  25455. <value>an Iterator; may not be null, but may have an empty
  25456. back end store</value>
  25457. </member>
  25458. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.PreferArray">
  25459. <summary>
  25460. Give viewers a hint as to whether to call GetViewableArray or
  25461. GetViewableIterator
  25462. </summary>
  25463. <value><c>true</c> if a viewer should call GetViewableArray, <c>false</c> if
  25464. a viewer should call GetViewableIterator </value>
  25465. </member>
  25466. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.ShortDescription">
  25467. <summary>
  25468. Provides a short description of the object, to be used when a
  25469. POIFSViewable object has not provided its contents.
  25470. </summary>
  25471. <value>The short description.</value>
  25472. </member>
  25473. <member name="P:NPOI.POIFS.FileSystem.POIFSFileSystem.BigBlockSize">
  25474. <summary>
  25475. Gets The Big Block size, normally 512 bytes, sometimes 4096 bytes
  25476. </summary>
  25477. <value>The size of the big block.</value>
  25478. </member>
  25479. <member name="T:NPOI.POIFS.NIO.ByteArrayBackedDataSource">
  25480. <summary>
  25481. A POIFS <see cref="T:NPOI.POIFS.NIO.DataSource"/> backed by a byte array.
  25482. </summary>
  25483. </member>
  25484. <member name="T:NPOI.POIFS.NIO.DataSource">
  25485. <summary>
  25486. Common definition of how we read and write bytes
  25487. </summary>
  25488. </member>
  25489. <member name="M:NPOI.POIFS.NIO.DataSource.Close">
  25490. <summary>
  25491. Close the underlying stream
  25492. </summary>
  25493. </member>
  25494. <member name="M:NPOI.POIFS.NIO.DataSource.CopyTo(System.IO.Stream)">
  25495. <summary>
  25496. Copies the contents to the specified Stream
  25497. </summary>
  25498. <param name="stream"></param>
  25499. </member>
  25500. <member name="T:NPOI.POIFS.NIO.FileBackedDataSource">
  25501. <summary>
  25502. A POIFS DataSource backed by a File
  25503. TODO - Return the ByteBuffers in such a way that in RW mode,
  25504. changes to the buffer end up on the disk (will fix the HPSF TestWrite
  25505. currently failing unit test when done)
  25506. </summary>
  25507. </member>
  25508. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Read(System.Int32,System.Int64)">
  25509. <summary>
  25510. Reads a sequence of bytes from this FileStream starting at the given file position.
  25511. </summary>
  25512. <param name="length"></param>
  25513. <param name="position">The file position at which the transfer is to begin;</param>
  25514. <returns></returns>
  25515. </member>
  25516. <member name="M:NPOI.POIFS.NIO.FileBackedDataSource.Write(NPOI.Util.ByteBuffer,System.Int64)">
  25517. <summary>
  25518. Writes a sequence of bytes to this FileStream from the given Stream,
  25519. starting at the given file position.
  25520. </summary>
  25521. <param name="src">The Stream from which bytes are to be transferred</param>
  25522. <param name="position">The file position at which the transfer is to begin;
  25523. must be non-negative</param>
  25524. </member>
  25525. <member name="T:NPOI.POIFS.Properties.Child">
  25526. <summary>
  25527. This interface defines methods for finding and setting sibling
  25528. Property instances
  25529. @author Marc Johnson (mjohnson at apache dot org)
  25530. </summary>
  25531. </member>
  25532. <member name="P:NPOI.POIFS.Properties.Child.PreviousChild">
  25533. <summary>
  25534. Gets or sets the previous child.
  25535. </summary>
  25536. <value>The previous child.</value>
  25537. </member>
  25538. <member name="P:NPOI.POIFS.Properties.Child.NextChild">
  25539. <summary>
  25540. Gets or sets the next child.
  25541. </summary>
  25542. <value>The next child.</value>
  25543. </member>
  25544. <member name="T:NPOI.POIFS.Properties.DirectoryProperty">
  25545. <summary>
  25546. Trivial extension of Property for POIFSDocuments
  25547. @author Marc Johnson (mjohnson at apache dot org)
  25548. </summary>
  25549. </member>
  25550. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.String)">
  25551. <summary>
  25552. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  25553. </summary>
  25554. <param name="name">the name of the directory</param>
  25555. </member>
  25556. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  25557. <summary>
  25558. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DirectoryProperty"/> class.
  25559. </summary>
  25560. <param name="index">index number</param>
  25561. <param name="array">byte data</param>
  25562. <param name="offset">offset into byte data</param>
  25563. </member>
  25564. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.ChangeName(NPOI.POIFS.Properties.Property,System.String)">
  25565. <summary>
  25566. Change a Property's name
  25567. </summary>
  25568. <param name="property">the Property whose name Is being Changed.</param>
  25569. <param name="newName">the new name for the Property</param>
  25570. <returns>true if the name Change could be made, else false</returns>
  25571. </member>
  25572. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.DeleteChild(NPOI.POIFS.Properties.Property)">
  25573. <summary>
  25574. Delete a Property
  25575. </summary>
  25576. <param name="property">the Property being Deleted</param>
  25577. <returns>true if the Property could be Deleted, else false</returns>
  25578. </member>
  25579. <member name="T:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator">
  25580. <summary>
  25581. Directory Property Comparer
  25582. </summary>
  25583. </member>
  25584. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Equals(System.Object)">
  25585. <summary>
  25586. Object equality, implemented as object identity
  25587. </summary>
  25588. <param name="o">Object we're being Compared to</param>
  25589. <returns>true if identical, else false</returns>
  25590. </member>
  25591. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PropertyComparator.Compare(NPOI.POIFS.Properties.Property,NPOI.POIFS.Properties.Property)">
  25592. <summary>
  25593. Compare method. Assumes both parameters are non-null
  25594. instances of Property. One property is less than another if
  25595. its name is shorter than the other property's name. If the
  25596. names are the same length, the property whose name comes
  25597. before the other property's name, alphabetically, is less
  25598. than the other property.
  25599. </summary>
  25600. <param name="o1">first object to compare, better be a Property</param>
  25601. <param name="o2">second object to compare, better be a Property</param>
  25602. <returns>negative value if o1 smaller than o2,
  25603. zero if o1 equals o2,
  25604. positive value if o1 bigger than o2.</returns>
  25605. </member>
  25606. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.IsDirectory">
  25607. <summary>
  25608. Gets a value indicating whether this instance is directory.
  25609. </summary>
  25610. <value>
  25611. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  25612. </value>
  25613. </member>
  25614. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.PreWrite">
  25615. <summary>
  25616. Perform whatever activities need to be performed prior to
  25617. writing
  25618. </summary>
  25619. </member>
  25620. <member name="P:NPOI.POIFS.Properties.DirectoryProperty.Children">
  25621. <summary>
  25622. Get an iterator over the children of this Parent; all elements
  25623. are instances of Property.
  25624. </summary>
  25625. <value>Iterator of children; may refer to an empty collection</value>
  25626. </member>
  25627. <member name="M:NPOI.POIFS.Properties.DirectoryProperty.AddChild(NPOI.POIFS.Properties.Property)">
  25628. <summary>
  25629. Add a new child to the collection of children
  25630. </summary>
  25631. <param name="property">the new child to be added; must not be null</param>
  25632. </member>
  25633. <member name="T:NPOI.POIFS.Properties.DocumentProperty">
  25634. <summary>
  25635. Trivial extension of Property for POIFSDocuments
  25636. @author Marc Johnson (mjohnson at apache dot org)
  25637. </summary>
  25638. </member>
  25639. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.String,System.Int32)">
  25640. <summary>
  25641. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  25642. </summary>
  25643. <param name="name">POIFSDocument name</param>
  25644. <param name="size">POIFSDocument size</param>
  25645. </member>
  25646. <member name="M:NPOI.POIFS.Properties.DocumentProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  25647. <summary>
  25648. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.DocumentProperty"/> class.
  25649. </summary>
  25650. <param name="index">index number</param>
  25651. <param name="array">byte data</param>
  25652. <param name="offset">offset into byte data</param>
  25653. </member>
  25654. <member name="P:NPOI.POIFS.Properties.DocumentProperty.Document">
  25655. <summary>
  25656. Gets or sets the document.
  25657. </summary>
  25658. <value>the associated POIFSDocument</value>
  25659. </member>
  25660. <member name="P:NPOI.POIFS.Properties.DocumentProperty.IsDirectory">
  25661. <summary>
  25662. Determines whether this instance is directory.
  25663. </summary>
  25664. <returns>
  25665. <c>true</c> if this instance is directory; otherwise, <c>false</c>.
  25666. </returns>
  25667. </member>
  25668. <member name="M:NPOI.POIFS.Properties.DocumentProperty.PreWrite">
  25669. <summary>
  25670. Perform whatever activities need to be performed prior to
  25671. writing
  25672. </summary>
  25673. </member>
  25674. <member name="M:NPOI.POIFS.Properties.DocumentProperty.UpdateSize(System.Int32)">
  25675. Update the size of the property's data
  25676. </member>
  25677. <member name="M:NPOI.POIFS.Properties.NPropertyTable.PreWrite">
  25678. Prepare to be written
  25679. </member>
  25680. <member name="T:NPOI.POIFS.Properties.Parent">
  25681. <summary>
  25682. Behavior for parent (directory) properties
  25683. @author Marc Johnson27591@hotmail.com
  25684. </summary>
  25685. </member>
  25686. <member name="P:NPOI.POIFS.Properties.Parent.Children">
  25687. <summary>
  25688. Get an iterator over the children of this Parent
  25689. all elements are instances of Property.
  25690. </summary>
  25691. <returns></returns>
  25692. </member>
  25693. <member name="M:NPOI.POIFS.Properties.Parent.AddChild(NPOI.POIFS.Properties.Property)">
  25694. <summary>
  25695. Add a new child to the collection of children
  25696. </summary>
  25697. <param name="property">the new child to be added; must not be null</param>
  25698. </member>
  25699. <member name="P:NPOI.POIFS.Properties.Parent.PreviousChild">
  25700. <summary>
  25701. Sets the previous child.
  25702. </summary>
  25703. </member>
  25704. <member name="P:NPOI.POIFS.Properties.Parent.NextChild">
  25705. <summary>
  25706. Sets the next child.
  25707. </summary>
  25708. </member>
  25709. <member name="T:NPOI.POIFS.Properties.Property">
  25710. <summary>
  25711. This abstract base class is the ancestor of all classes
  25712. implementing POIFS Property behavior.
  25713. @author Marc Johnson (mjohnson at apache dot org)
  25714. </summary>
  25715. </member>
  25716. <member name="M:NPOI.POIFS.Properties.Property.#ctor">
  25717. <summary>
  25718. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.Property"/> class.
  25719. </summary>
  25720. </member>
  25721. <member name="M:NPOI.POIFS.Properties.Property.#ctor(System.Int32,System.Byte[],System.Int32)">
  25722. <summary>
  25723. Constructor from byte data
  25724. </summary>
  25725. <param name="index">index number</param>
  25726. <param name="array">byte data</param>
  25727. <param name="offset">offset into byte data</param>
  25728. </member>
  25729. <member name="M:NPOI.POIFS.Properties.Property.WriteData(System.IO.Stream)">
  25730. <summary>
  25731. Write the raw data to an OutputStream.
  25732. </summary>
  25733. <param name="stream">the OutputStream to which the data Should be
  25734. written.</param>
  25735. </member>
  25736. <member name="P:NPOI.POIFS.Properties.Property.StartBlock">
  25737. <summary>
  25738. Gets or sets the start block for the document referred to by this
  25739. Property.
  25740. </summary>
  25741. <value>the start block index</value>
  25742. </member>
  25743. <member name="P:NPOI.POIFS.Properties.Property.ShouldUseSmallBlocks">
  25744. <summary>
  25745. Based on the currently defined size, Should this property use
  25746. small blocks?
  25747. </summary>
  25748. <returns>true if the size Is less than _big_block_minimum_bytes</returns>
  25749. </member>
  25750. <member name="M:NPOI.POIFS.Properties.Property.IsSmall(System.Int32)">
  25751. <summary>
  25752. does the length indicate a small document?
  25753. </summary>
  25754. <param name="length">length in bytes</param>
  25755. <returns>
  25756. <c>true</c> if the length Is less than
  25757. _big_block_minimum_bytes; otherwise, <c>false</c>.
  25758. </returns>
  25759. </member>
  25760. <member name="P:NPOI.POIFS.Properties.Property.Name">
  25761. <summary>
  25762. Gets or sets the name of this property
  25763. </summary>
  25764. <value>property name</value>
  25765. </member>
  25766. <member name="P:NPOI.POIFS.Properties.Property.IsDirectory">
  25767. <summary>
  25768. Gets a value indicating whether this instance is directory.
  25769. </summary>
  25770. <value>
  25771. <c>true</c> if a directory type Property; otherwise, <c>false</c>.
  25772. </value>
  25773. </member>
  25774. <member name="P:NPOI.POIFS.Properties.Property.StorageClsid">
  25775. <summary>
  25776. Gets or sets the storage class ID for this property stream. ThIs Is the Class ID
  25777. of the COM object which can read and write this property stream </summary>
  25778. <value>Storage Class ID</value>
  25779. </member>
  25780. <member name="P:NPOI.POIFS.Properties.Property.PropertyType">
  25781. <summary>
  25782. Set the property type. Makes no attempt to validate the value.
  25783. </summary>
  25784. <value>the property type (root, file, directory)</value>
  25785. </member>
  25786. <member name="P:NPOI.POIFS.Properties.Property.NodeColor">
  25787. <summary>
  25788. Sets the color of the node.
  25789. </summary>
  25790. <value>the node color (red or black)</value>
  25791. </member>
  25792. <member name="P:NPOI.POIFS.Properties.Property.ChildProperty">
  25793. <summary>
  25794. Sets the child property.
  25795. </summary>
  25796. <value>the child property's index in the Property Table</value>
  25797. </member>
  25798. <member name="P:NPOI.POIFS.Properties.Property.ChildIndex">
  25799. <summary>
  25800. Get the child property (its index in the Property Table)
  25801. </summary>
  25802. <value>The index of the child.</value>
  25803. </member>
  25804. <member name="P:NPOI.POIFS.Properties.Property.Size">
  25805. <summary>
  25806. Gets or sets the size of the document associated with this Property
  25807. </summary>
  25808. <value>the size of the document, in bytes</value>
  25809. </member>
  25810. <member name="P:NPOI.POIFS.Properties.Property.Index">
  25811. <summary>
  25812. Gets or sets the index.
  25813. </summary>
  25814. <value>The index.</value>
  25815. Get the index for this Property
  25816. @return the index of this Property within its Property Table
  25817. </member>
  25818. <member name="M:NPOI.POIFS.Properties.Property.PreWrite">
  25819. <summary>
  25820. Perform whatever activities need to be performed prior to
  25821. writing
  25822. </summary>
  25823. </member>
  25824. <member name="P:NPOI.POIFS.Properties.Property.NextChildIndex">
  25825. <summary>
  25826. Gets the index of the next child.
  25827. </summary>
  25828. <value>The index of the next child.</value>
  25829. </member>
  25830. <member name="P:NPOI.POIFS.Properties.Property.PreviousChildIndex">
  25831. <summary>
  25832. Gets the index of the previous child.
  25833. </summary>
  25834. <value>The index of the previous child.</value>
  25835. </member>
  25836. <member name="M:NPOI.POIFS.Properties.Property.IsValidIndex(System.Int32)">
  25837. <summary>
  25838. Determines whether the specified index Is valid
  25839. </summary>
  25840. <param name="index">value to be checked</param>
  25841. <returns>
  25842. <c>true</c> if the index Is valid; otherwise, <c>false</c>.
  25843. </returns>
  25844. </member>
  25845. <member name="P:NPOI.POIFS.Properties.Property.PreviousChild">
  25846. <summary>
  25847. Gets or sets the previous child.
  25848. </summary>
  25849. <value>the new 'previous' child; may be null, which has
  25850. the effect of saying there Is no 'previous' child</value>
  25851. </member>
  25852. <member name="P:NPOI.POIFS.Properties.Property.NextChild">
  25853. <summary>
  25854. Gets or sets the next Child
  25855. </summary>
  25856. <value> the new 'next' child; may be null, which has the
  25857. effect of saying there Is no 'next' child</value>
  25858. </member>
  25859. <member name="P:NPOI.POIFS.Properties.Property.ViewableArray">
  25860. <summary>
  25861. Get an array of objects, some of which may implement
  25862. POIFSViewable
  25863. </summary>
  25864. <value>an array of Object; may not be null, but may be empty</value>
  25865. </member>
  25866. <member name="P:NPOI.POIFS.Properties.Property.ViewableIterator">
  25867. <summary>
  25868. Get an Iterator of objects, some of which may implement POIFSViewable
  25869. </summary>
  25870. <value> may not be null, but may have an empty
  25871. back end store</value>
  25872. </member>
  25873. <member name="P:NPOI.POIFS.Properties.Property.PreferArray">
  25874. <summary>
  25875. Give viewers a hint as to whether to call GetViewableArray or
  25876. GetViewableIterator
  25877. </summary>
  25878. <value><c>true</c> if a viewer Should call GetViewableArray; otherwise, <c>false</c>
  25879. if a viewer Should call GetViewableIterator
  25880. </value>
  25881. </member>
  25882. <member name="P:NPOI.POIFS.Properties.Property.ShortDescription">
  25883. <summary>
  25884. Provides a short description of the object, to be used when a
  25885. POIFSViewable object has not provided its contents.
  25886. </summary>
  25887. <value>The short description.</value>
  25888. </member>
  25889. <member name="T:NPOI.POIFS.Properties.PropertyConstants">
  25890. <summary>
  25891. Constants used by Properties namespace
  25892. </summary>
  25893. </member>
  25894. <member name="M:NPOI.POIFS.Properties.PropertyFactory.ConvertToProperties(NPOI.POIFS.Storage.ListManagedBlock[])">
  25895. <summary>
  25896. Convert raw data blocks to an array of Property's
  25897. </summary>
  25898. <param name="blocks">The blocks to be converted</param>
  25899. <returns>the converted List of Property objects. May contain
  25900. nulls, but will not be null</returns>
  25901. </member>
  25902. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock)">
  25903. Default constructor
  25904. </member>
  25905. <member name="M:NPOI.POIFS.Properties.PropertyTable.#ctor(NPOI.POIFS.Storage.HeaderBlock,NPOI.POIFS.Storage.RawDataBlockList)">
  25906. reading constructor (used when we've read in a file and we want
  25907. to extract the property table from it). Populates the
  25908. properties thoroughly
  25909. @param startBlock the first block of the property table
  25910. @param blockList the list of blocks
  25911. @exception IOException if anything goes wrong (which should be
  25912. a result of the input being NFG)
  25913. </member>
  25914. <member name="M:NPOI.POIFS.Properties.PropertyTable.PreWrite">
  25915. Prepare to be written Leon
  25916. </member>
  25917. <member name="P:NPOI.POIFS.Properties.PropertyTable.CountBlocks">
  25918. Return the number of BigBlock's this instance uses
  25919. @return count of BigBlock instances
  25920. </member>
  25921. <member name="M:NPOI.POIFS.Properties.PropertyTable.WriteBlocks(System.IO.Stream)">
  25922. Write the storage to an Stream
  25923. @param stream the Stream to which the stored data should
  25924. be written
  25925. @exception IOException on problems writing to the specified
  25926. stream
  25927. </member>
  25928. <member name="M:NPOI.POIFS.Properties.RootProperty.#ctor(System.Int32,System.Byte[],System.Int32)">
  25929. <summary>
  25930. Initializes a new instance of the <see cref="T:NPOI.POIFS.Properties.RootProperty"/> class.
  25931. </summary>
  25932. <param name="index">index number</param>
  25933. <param name="array">byte data</param>
  25934. <param name="offset">offset into byte data</param>
  25935. </member>
  25936. <member name="P:NPOI.POIFS.Properties.RootProperty.Size">
  25937. <summary>
  25938. Gets or sets the size of the document associated with this Property
  25939. </summary>
  25940. <value>the size of the document, in bytes</value>
  25941. </member>
  25942. <member name="T:NPOI.POIFS.Storage.BATBlock">
  25943. <summary>
  25944. A block of block allocation table entries. BATBlocks are created
  25945. only through a static factory method: createBATBlocks.
  25946. @author Marc Johnson (mjohnson at apache dot org)
  25947. </summary>
  25948. </member>
  25949. <member name="F:NPOI.POIFS.Storage.BATBlock._values">
  25950. For a regular fat block, these are 128 / 1024
  25951. next sector values.
  25952. For a XFat (DIFat) block, these are 127 / 1023
  25953. next sector values, then a chaining value.
  25954. </member>
  25955. <member name="F:NPOI.POIFS.Storage.BATBlock._has_free_sectors">
  25956. Does this BATBlock have any free sectors in it?
  25957. </member>
  25958. <member name="F:NPOI.POIFS.Storage.BATBlock.ourBlockIndex">
  25959. Where in the file are we?
  25960. </member>
  25961. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor">
  25962. <summary>
  25963. Create a single instance initialized with default values
  25964. </summary>
  25965. </member>
  25966. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32,System.Int32)">
  25967. Create a single instance initialized (perhaps partially) with entries
  25968. @param entries the array of block allocation table entries
  25969. @param start_index the index of the first entry to be written
  25970. to the block
  25971. @param end_index the index, plus one, of the last entry to be
  25972. written to the block (writing is for all index
  25973. k, start_index &lt;= k &lt; end_index)
  25974. </member>
  25975. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.IO.BinaryReader)">
  25976. Create a single BATBlock from the byte buffer, which must hold at least
  25977. one big block of data to be read.
  25978. </member>
  25979. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateEmptyBATBlock(NPOI.POIFS.Common.POIFSBigBlockSize,System.Boolean)">
  25980. **
  25981. </member>
  25982. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[])">
  25983. <summary>
  25984. Create an array of BATBlocks from an array of int block
  25985. allocation table entries
  25986. </summary>
  25987. <param name="bigBlockSize">the poifs bigBlockSize</param>
  25988. <param name="entries">the array of int entries</param>
  25989. <returns>the newly created array of BATBlocks</returns>
  25990. </member>
  25991. <member name="M:NPOI.POIFS.Storage.BATBlock.CreateXBATBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32[],System.Int32)">
  25992. <summary>
  25993. Create an array of XBATBlocks from an array of int block
  25994. allocation table entries
  25995. </summary>
  25996. <param name="bigBlockSize"></param>
  25997. <param name="entries">the array of int entries</param>
  25998. <param name="startBlock">the start block of the array of XBAT blocks</param>
  25999. <returns>the newly created array of BATBlocks</returns>
  26000. </member>
  26001. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateStorageRequirements(System.Int32)">
  26002. <summary>
  26003. Calculate how many BATBlocks are needed to hold a specified
  26004. number of BAT entries.
  26005. </summary>
  26006. <param name="entryCount">the number of entries</param>
  26007. <returns>the number of BATBlocks needed</returns>
  26008. </member>
  26009. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateXBATStorageRequirements(System.Int32)">
  26010. <summary>
  26011. Calculate how many XBATBlocks are needed to hold a specified
  26012. number of BAT entries.
  26013. </summary>
  26014. <param name="entryCount">the number of entries</param>
  26015. <returns>the number of XBATBlocks needed</returns>
  26016. </member>
  26017. <member name="M:NPOI.POIFS.Storage.BATBlock.CalculateMaximumSize(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  26018. Calculates the maximum size of a file which is addressable given the
  26019. number of FAT (BAT) sectors specified. (We don't care if those BAT
  26020. blocks come from the 109 in the header, or from header + XBATS, it
  26021. won't affect the calculation)
  26022. The actual file size will be between [size of fatCount-1 blocks] and
  26023. [size of fatCount blocks].
  26024. For 512 byte block sizes, this means we may over-estimate by up to 65kb.
  26025. For 4096 byte block sizes, this means we may over-estimate by up to 4mb
  26026. </member>
  26027. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerBlock">
  26028. <summary>
  26029. Gets the entries per block.
  26030. </summary>
  26031. <value>The number of entries per block</value>
  26032. </member>
  26033. <member name="P:NPOI.POIFS.Storage.BATBlock.EntriesPerXBATBlock">
  26034. <summary>
  26035. Gets the entries per XBAT block.
  26036. </summary>
  26037. <value>number of entries per XBAT block</value>
  26038. </member>
  26039. <member name="P:NPOI.POIFS.Storage.BATBlock.XBATChainOffset">
  26040. <summary>
  26041. Gets the XBAT chain offset.
  26042. </summary>
  26043. <value>offset of chain index of XBAT block</value>
  26044. </member>
  26045. <member name="P:NPOI.POIFS.Storage.BATBlock.HasFreeSectors">
  26046. Does this BATBlock have any free sectors in it, or
  26047. is it full?
  26048. </member>
  26049. <member name="P:NPOI.POIFS.Storage.BATBlock.OurBlockIndex">
  26050. Retrieve where in the file we live
  26051. </member>
  26052. <member name="M:NPOI.POIFS.Storage.BATBlock.#ctor(System.Int32[],System.Int32,System.Int32)">
  26053. <summary>
  26054. Create a single instance initialized (perhaps partially) with entries
  26055. </summary>
  26056. <param name="entries">the array of block allocation table entries</param>
  26057. <param name="start_index">the index of the first entry to be written
  26058. to the block</param>
  26059. <param name="end_index">the index, plus one, of the last entry to be
  26060. written to the block (writing is for all index
  26061. k, start_index less than k less than end_index)
  26062. </param>
  26063. </member>
  26064. <member name="M:NPOI.POIFS.Storage.BATBlock.WriteData(System.IO.Stream)">
  26065. <summary>
  26066. Write the block's data to an Stream
  26067. </summary>
  26068. <param name="stream">the Stream to which the stored data should
  26069. be written</param>
  26070. </member>
  26071. <member name="T:NPOI.POIFS.Storage.BigBlock">
  26072. <summary>
  26073. Abstract base class of all POIFS block storage classes. All
  26074. extensions of BigBlock should write 512 bytes of data when
  26075. requested to write their data.
  26076. This class has package scope, as there is no reason at this time to
  26077. make the class public.
  26078. @author Marc Johnson (mjohnson at apache dot org)
  26079. </summary>
  26080. </member>
  26081. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream,System.Byte[])">
  26082. <summary>
  26083. Default implementation of write for extending classes that
  26084. contain their data in a simple array of bytes.
  26085. </summary>
  26086. <param name="stream">the OutputStream to which the data should be written.</param>
  26087. <param name="data">the byte array of to be written.</param>
  26088. </member>
  26089. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteBlocks(System.IO.Stream)">
  26090. <summary>
  26091. Write the block's data to an OutputStream
  26092. </summary>
  26093. <param name="stream">the OutputStream to which the stored data should be written</param>
  26094. </member>
  26095. <member name="M:NPOI.POIFS.Storage.BigBlock.WriteData(System.IO.Stream)">
  26096. <summary>
  26097. Write the storage to an OutputStream
  26098. </summary>
  26099. <param name="stream">the OutputStream to which the stored data should be written </param>
  26100. </member>
  26101. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableReader">
  26102. <summary>
  26103. This class manages and creates the Block Allocation Table, which is
  26104. basically a set of linked lists of block indices.
  26105. Each block of the filesystem has an index. The first block, the
  26106. header, is skipped; the first block after the header is index 0,
  26107. the next is index 1, and so on.
  26108. A block's index is also its index into the Block Allocation
  26109. Table. The entry that it finds in the Block Allocation Table is the
  26110. index of the next block in the linked list of blocks making up a
  26111. file, or it is set to -2: end of list.
  26112. @author Marc Johnson (mjohnson at apache dot org)
  26113. </summary>
  26114. </member>
  26115. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32,System.Int32[],System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  26116. <summary>
  26117. create a BlockAllocationTableReader for an existing filesystem. Side
  26118. effect: when this method finishes, the BAT blocks will have
  26119. been Removed from the raw block list, and any blocks labeled as
  26120. 'unused' in the block allocation table will also have been
  26121. Removed from the raw block list. </summary>
  26122. <param name="bigBlockSizse">the poifs bigBlockSize</param>
  26123. <param name="block_count">the number of BAT blocks making up the block allocation table</param>
  26124. <param name="block_array">the array of BAT block indices from the
  26125. filesystem's header</param>
  26126. <param name="xbat_count">the number of XBAT blocks</param>
  26127. <param name="xbat_index">the index of the first XBAT block</param>
  26128. <param name="raw_block_list">the list of RawDataBlocks</param>
  26129. </member>
  26130. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  26131. <summary>
  26132. create a BlockAllocationTableReader from an array of raw data blocks
  26133. </summary>
  26134. <param name="bigBlockSize"></param>
  26135. <param name="blocks">the raw data</param>
  26136. <param name="raw_block_list">the list holding the managed blocks</param>
  26137. </member>
  26138. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26139. <summary>
  26140. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableReader"/> class.
  26141. </summary>
  26142. </member>
  26143. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.FetchBlocks(System.Int32,System.Int32,NPOI.POIFS.Storage.BlockList)">
  26144. <summary>
  26145. walk the entries from a specified point and return the
  26146. associated blocks. The associated blocks are Removed from the block list
  26147. </summary>
  26148. <param name="startBlock">the first block in the chain</param>
  26149. <param name="headerPropertiesStartBlock"></param>
  26150. <param name="blockList">the raw data block list</param>
  26151. <returns>array of ListManagedBlocks, in their correct order</returns>
  26152. </member>
  26153. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.IsUsed(System.Int32)">
  26154. <summary>
  26155. determine whether the block specified by index is used or not
  26156. </summary>
  26157. <param name="index">determine whether the block specified by index is used or not</param>
  26158. <returns>
  26159. <c>true</c> if the specified block is used; otherwise, <c>false</c>.
  26160. </returns>
  26161. </member>
  26162. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.GetNextBlockIndex(System.Int32)">
  26163. <summary>
  26164. return the next block index
  26165. </summary>
  26166. <param name="index">The index of the current block</param>
  26167. <returns>index of the next block (may be
  26168. POIFSConstants.END_OF_CHAIN, indicating end of chain
  26169. (duh))</returns>
  26170. </member>
  26171. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableReader.SetEntries(NPOI.POIFS.Storage.ListManagedBlock[],NPOI.POIFS.Storage.BlockList)">
  26172. <summary>
  26173. Convert an array of blocks into a Set of integer indices
  26174. </summary>
  26175. <param name="blocks">the array of blocks containing the indices</param>
  26176. <param name="raw_blocks">the list of blocks being managed. Unused
  26177. blocks will be eliminated from the list</param>
  26178. </member>
  26179. <member name="T:NPOI.POIFS.Storage.BlockAllocationTableWriter">
  26180. <summary>
  26181. This class manages and creates the Block Allocation Table, which is
  26182. basically a set of linked lists of block indices.
  26183. Each block of the filesystem has an index. The first block, the
  26184. header, is skipped; the first block after the header is index 0,
  26185. the next is index 1, and so on.
  26186. A block's index is also its index into the Block Allocation
  26187. Table. The entry that it finds in the Block Allocation Table is the
  26188. index of the next block in the linked list of blocks making up a
  26189. file, or it is set to -2: end of list.
  26190. *
  26191. @author Marc Johnson (mjohnson at apache dot org)
  26192. </summary>
  26193. </member>
  26194. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26195. <summary>
  26196. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockAllocationTableWriter"/> class.
  26197. </summary>
  26198. </member>
  26199. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.CreateBlocks">
  26200. <summary>
  26201. Create the BATBlocks we need
  26202. </summary>
  26203. <returns>start block index of BAT blocks</returns>
  26204. </member>
  26205. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.AllocateSpace(System.Int32)">
  26206. <summary>
  26207. Allocate space for a block of indices
  26208. </summary>
  26209. <param name="blockCount">the number of blocks to allocate space for</param>
  26210. <returns>the starting index of the blocks</returns>
  26211. </member>
  26212. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.StartBlock">
  26213. <summary>
  26214. Sets the start block for this instance
  26215. </summary>
  26216. <value>
  26217. index into the array of BigBlock instances making up the the filesystem
  26218. </value>
  26219. </member>
  26220. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.SimpleCreateBlocks">
  26221. <summary>
  26222. create the BATBlocks
  26223. </summary>
  26224. </member>
  26225. <member name="M:NPOI.POIFS.Storage.BlockAllocationTableWriter.WriteBlocks(System.IO.Stream)">
  26226. <summary>
  26227. Write the storage to an OutputStream
  26228. </summary>
  26229. <param name="stream">the OutputStream to which the stored data should be written</param>
  26230. </member>
  26231. <member name="P:NPOI.POIFS.Storage.BlockAllocationTableWriter.CountBlocks">
  26232. <summary>
  26233. Gets the number of BigBlock's this instance uses
  26234. </summary>
  26235. <value>count of BigBlock instances</value>
  26236. </member>
  26237. <member name="T:NPOI.POIFS.Storage.BlockList">
  26238. <summary>
  26239. Interface for lists of blocks that are mapped by block allocation
  26240. tables
  26241. @author Marc Johnson (mjohnson at apache dot org)
  26242. </summary>
  26243. </member>
  26244. <member name="M:NPOI.POIFS.Storage.BlockList.Zap(System.Int32)">
  26245. <summary>
  26246. remove the specified block from the list
  26247. </summary>
  26248. <param name="index">the index of the specified block; if the index is
  26249. out of range, that's ok</param>
  26250. </member>
  26251. <member name="M:NPOI.POIFS.Storage.BlockList.Remove(System.Int32)">
  26252. <summary>
  26253. Remove and return the specified block from the list
  26254. </summary>
  26255. <param name="index">the index of the specified block</param>
  26256. <returns>the specified block</returns>
  26257. </member>
  26258. <member name="M:NPOI.POIFS.Storage.BlockList.FetchBlocks(System.Int32,System.Int32)">
  26259. <summary>
  26260. get the blocks making up a particular stream in the list. The
  26261. blocks are removed from the list.
  26262. </summary>
  26263. <param name="startBlock">the index of the first block in the stream</param>
  26264. <param name="headerPropertiesStartBlock"></param>
  26265. <returns>the stream as an array of correctly ordered blocks</returns>
  26266. </member>
  26267. <member name="P:NPOI.POIFS.Storage.BlockList.BAT">
  26268. <summary>
  26269. set the associated BlockAllocationTable
  26270. </summary>
  26271. <value>the associated BlockAllocationTable</value>
  26272. </member>
  26273. <member name="M:NPOI.POIFS.Storage.BlockListImpl.#ctor">
  26274. <summary>
  26275. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.BlockListImpl"/> class.
  26276. </summary>
  26277. </member>
  26278. <member name="M:NPOI.POIFS.Storage.BlockListImpl.SetBlocks(NPOI.POIFS.Storage.ListManagedBlock[])">
  26279. <summary>
  26280. provide blocks to manage
  26281. </summary>
  26282. <param name="blocks">blocks to be managed</param>
  26283. </member>
  26284. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Zap(System.Int32)">
  26285. <summary>
  26286. remove the specified block from the list
  26287. </summary>
  26288. <param name="index">the index of the specified block; if the index is
  26289. out of range, that's ok</param>
  26290. </member>
  26291. <member name="M:NPOI.POIFS.Storage.BlockListImpl.Remove(System.Int32)">
  26292. <summary>
  26293. Remove and return the specified block from the list
  26294. </summary>
  26295. <param name="index">the index of the specified block</param>
  26296. <returns>the specified block</returns>
  26297. </member>
  26298. <member name="M:NPOI.POIFS.Storage.BlockListImpl.FetchBlocks(System.Int32,System.Int32)">
  26299. <summary>
  26300. get the blocks making up a particular stream in the list. The
  26301. blocks are removed from the list.
  26302. </summary>
  26303. <param name="startBlock">the index of the first block in the stream</param>
  26304. <param name="headerPropertiesStartBlock"></param>
  26305. <returns>
  26306. the stream as an array of correctly ordered blocks
  26307. </returns>
  26308. </member>
  26309. <member name="P:NPOI.POIFS.Storage.BlockListImpl.BAT">
  26310. <summary>
  26311. set the associated BlockAllocationTable
  26312. </summary>
  26313. <value>the associated BlockAllocationTable</value>
  26314. </member>
  26315. <member name="T:NPOI.POIFS.Storage.BlockWritable">
  26316. <summary>
  26317. An interface for persisting block storage of POIFS components.
  26318. @author Marc Johnson (mjohnson at apache dot org)
  26319. </summary>
  26320. </member>
  26321. <member name="M:NPOI.POIFS.Storage.BlockWritable.WriteBlocks(System.IO.Stream)">
  26322. <summary>
  26323. Writes the blocks.
  26324. </summary>
  26325. <param name="stream">The stream.</param>
  26326. </member>
  26327. <member name="T:NPOI.POIFS.Storage.DataInputBlock">
  26328. Wraps a <c>byte</c> array and provides simple data input access.
  26329. Internally, this class maintains a buffer read index, so that for the most part, primitive
  26330. data can be read in a data-input-stream-like manner.<p/>
  26331. Note - the calling class should call the {@link #available()} method to detect end-of-buffer
  26332. and Move to the next data block when the current is exhausted.
  26333. For optimisation reasons, no error handling is performed in this class. Thus, mistakes in
  26334. calling code ran may raise ugly exceptions here, like {@link ArrayIndexOutOfBoundsException},
  26335. etc .<p/>
  26336. The multi-byte primitive input methods ({@link #readUshortLE()}, {@link #readIntLE()} and
  26337. {@link #readLongLE()}) have corresponding 'spanning Read' methods which (when required) perform
  26338. a read across the block boundary. These spanning read methods take the previous
  26339. {@link DataInputBlock} as a parameter.
  26340. Reads of larger amounts of data (into <c>byte</c> array buffers) must be managed by the caller
  26341. since these could conceivably involve more than two blocks.
  26342. @author Josh Micich
  26343. </member>
  26344. <member name="F:NPOI.POIFS.Storage.DataInputBlock._buf">
  26345. Possibly any size (usually 512K or 64K). Assumed to be at least 8 bytes for all blocks
  26346. before the end of the stream. The last block in the stream can be any size except zero.
  26347. </member>
  26348. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE">
  26349. Reads a <c>short</c> which was encoded in <em>little endian</em> format.
  26350. </member>
  26351. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadUshortLE(NPOI.POIFS.Storage.DataInputBlock)">
  26352. Reads a <c>short</c> which spans the end of <c>prevBlock</c> and the start of this block.
  26353. </member>
  26354. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE">
  26355. Reads an <c>int</c> which was encoded in <em>little endian</em> format.
  26356. </member>
  26357. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadIntLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  26358. Reads an <c>int</c> which spans the end of <c>prevBlock</c> and the start of this block.
  26359. </member>
  26360. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE">
  26361. Reads a <c>long</c> which was encoded in <em>little endian</em> format.
  26362. </member>
  26363. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadLongLE(NPOI.POIFS.Storage.DataInputBlock,System.Int32)">
  26364. Reads a <c>long</c> which spans the end of <c>prevBlock</c> and the start of this block.
  26365. </member>
  26366. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadSpanning(NPOI.POIFS.Storage.DataInputBlock,System.Int32,System.Byte[])">
  26367. Reads a small amount of data from across the boundary between two blocks.
  26368. The {@link #_readIndex} of this (the second) block is updated accordingly.
  26369. Note- this method (and other code) assumes that the second {@link DataInputBlock}
  26370. always is big enough to complete the read without being exhausted.
  26371. </member>
  26372. <member name="M:NPOI.POIFS.Storage.DataInputBlock.ReadFully(System.Byte[],System.Int32,System.Int32)">
  26373. Reads <c>len</c> bytes from this block into the supplied buffer.
  26374. </member>
  26375. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(NPOI.POIFS.Storage.RawDataBlock)">
  26376. <summary>
  26377. create a document block from a raw data block
  26378. </summary>
  26379. <param name="block">The block.</param>
  26380. </member>
  26381. <member name="M:NPOI.POIFS.Storage.DocumentBlock.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  26382. <summary>
  26383. Create a single instance initialized with data.
  26384. </summary>
  26385. <param name="stream">the InputStream delivering the data.</param>
  26386. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26387. </member>
  26388. <member name="P:NPOI.POIFS.Storage.DocumentBlock.Size">
  26389. <summary>
  26390. Get the number of bytes Read for this block.
  26391. </summary>
  26392. <value>bytes Read into the block</value>
  26393. </member>
  26394. <member name="P:NPOI.POIFS.Storage.DocumentBlock.PartiallyRead">
  26395. <summary>
  26396. Was this a partially Read block?
  26397. </summary>
  26398. <value><c>true</c> if the block was only partially filled with data</value>
  26399. </member>
  26400. <member name="P:NPOI.POIFS.Storage.DocumentBlock.FillByte">
  26401. <summary>
  26402. Gets the fill byte used
  26403. </summary>
  26404. <value>The fill byte.</value>
  26405. </member>
  26406. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  26407. <summary>
  26408. convert a single long array into an array of DocumentBlock
  26409. instances
  26410. </summary>
  26411. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26412. <param name="array">the byte array to be converted</param>
  26413. <param name="size">the intended size of the array (which may be smaller)</param>
  26414. <returns>an array of DocumentBlock instances, filled from the
  26415. input array</returns>
  26416. </member>
  26417. <member name="M:NPOI.POIFS.Storage.DocumentBlock.Read(NPOI.POIFS.Storage.DocumentBlock[],System.Byte[],System.Int32)">
  26418. <summary>
  26419. Read data from an array of DocumentBlocks
  26420. </summary>
  26421. <param name="blocks">the blocks to Read from</param>
  26422. <param name="buffer">the buffer to Write the data into</param>
  26423. <param name="offset">the offset into the array of blocks to Read from</param>
  26424. </member>
  26425. <member name="M:NPOI.POIFS.Storage.DocumentBlock.WriteData(System.IO.Stream)">
  26426. <summary>
  26427. Write the storage to an OutputStream
  26428. </summary>
  26429. <param name="stream">the OutputStream to which the stored data should
  26430. be written</param>
  26431. </member>
  26432. <member name="T:NPOI.POIFS.Storage.HeaderBlock">
  26433. <summary>
  26434. The block containing the archive header
  26435. @author Marc Johnson (mjohnson at apache dot org)
  26436. </summary>
  26437. </member>
  26438. <member name="F:NPOI.POIFS.Storage.HeaderBlock.bigBlockSize">
  26439. What big block Size the file uses. Most files
  26440. use 512 bytes, but a few use 4096
  26441. </member>
  26442. <member name="F:NPOI.POIFS.Storage.HeaderBlock._sbat_count">
  26443. Number of small block allocation table blocks (int)
  26444. (Number of MiniFAT Sectors in Microsoft parlance)
  26445. </member>
  26446. <member name="M:NPOI.POIFS.Storage.HeaderBlock.#ctor(System.IO.Stream)">
  26447. <summary>
  26448. create a new HeaderBlockReader from an Stream
  26449. </summary>
  26450. <param name="stream">the source Stream</param>
  26451. </member>
  26452. <member name="M:NPOI.POIFS.Storage.HeaderBlock.AlertShortRead(System.Int32,System.Int32)">
  26453. <summary>
  26454. Alerts the short read.
  26455. </summary>
  26456. <param name="read">The read.</param>
  26457. <param name="expectedReadSize">The expected size.</param>
  26458. </member>
  26459. <member name="P:NPOI.POIFS.Storage.HeaderBlock.PropertyStart">
  26460. <summary>
  26461. Get start of Property Table
  26462. </summary>
  26463. <value>the index of the first block of the Property Table</value>
  26464. </member>
  26465. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATStart">
  26466. <summary>
  26467. Gets start of small block allocation table
  26468. </summary>
  26469. <value>The SBAT start.</value>
  26470. </member>
  26471. <member name="P:NPOI.POIFS.Storage.HeaderBlock.SBATCount">
  26472. <summary>
  26473. Gets number of BAT blocks
  26474. </summary>
  26475. <value>The BAT count.</value>
  26476. </member>
  26477. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BATArray">
  26478. <summary>
  26479. Gets the BAT array.
  26480. </summary>
  26481. <value>The BAT array.</value>
  26482. </member>
  26483. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATCount">
  26484. <summary>
  26485. Gets the XBAT count.
  26486. </summary>
  26487. <value>The XBAT count.</value>
  26488. @return XBAT count
  26489. </member>
  26490. <member name="P:NPOI.POIFS.Storage.HeaderBlock.XBATIndex">
  26491. <summary>
  26492. Gets the index of the XBAT.
  26493. </summary>
  26494. <value>The index of the XBAT.</value>
  26495. </member>
  26496. <member name="P:NPOI.POIFS.Storage.HeaderBlock.BigBlockSize">
  26497. <summary>
  26498. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  26499. </summary>
  26500. <value>The size of the big block.</value>
  26501. @return
  26502. </member>
  26503. <member name="T:NPOI.POIFS.Storage.HeaderBlockConstants">
  26504. <summary>
  26505. Constants used in reading/writing the Header block
  26506. @author Marc Johnson (mjohnson at apache dot org)
  26507. </summary>
  26508. </member>
  26509. <member name="T:NPOI.POIFS.Storage.HeaderBlockReader">
  26510. <summary>
  26511. The block containing the archive header
  26512. @author Marc Johnson (mjohnson at apache dot org)
  26513. </summary>
  26514. </member>
  26515. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader.bigBlockSize">
  26516. What big block Size the file uses. Most files
  26517. use 512 bytes, but a few use 4096
  26518. </member>
  26519. <member name="F:NPOI.POIFS.Storage.HeaderBlockReader._sbat_count">
  26520. Number of small block allocation table blocks (int)
  26521. (Number of MiniFAT Sectors in Microsoft parlance)
  26522. </member>
  26523. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.#ctor(System.IO.Stream)">
  26524. <summary>
  26525. create a new HeaderBlockReader from an Stream
  26526. </summary>
  26527. <param name="stream">the source Stream</param>
  26528. </member>
  26529. <member name="M:NPOI.POIFS.Storage.HeaderBlockReader.AlertShortRead(System.Int32,System.Int32)">
  26530. <summary>
  26531. Alerts the short read.
  26532. </summary>
  26533. <param name="read">The read.</param>
  26534. <param name="expectedReadSize">expected size to read</param>
  26535. </member>
  26536. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.PropertyStart">
  26537. <summary>
  26538. Get start of Property Table
  26539. </summary>
  26540. <value>the index of the first block of the Property Table</value>
  26541. </member>
  26542. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.SBATStart">
  26543. <summary>
  26544. Gets start of small block allocation table
  26545. </summary>
  26546. <value>The SBAT start.</value>
  26547. </member>
  26548. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATCount">
  26549. <summary>
  26550. Gets number of BAT blocks
  26551. </summary>
  26552. <value>The BAT count.</value>
  26553. </member>
  26554. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BATArray">
  26555. <summary>
  26556. Gets the BAT array.
  26557. </summary>
  26558. <value>The BAT array.</value>
  26559. </member>
  26560. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATCount">
  26561. <summary>
  26562. Gets the XBAT count.
  26563. </summary>
  26564. <value>The XBAT count.</value>
  26565. @return XBAT count
  26566. </member>
  26567. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.XBATIndex">
  26568. <summary>
  26569. Gets the index of the XBAT.
  26570. </summary>
  26571. <value>The index of the XBAT.</value>
  26572. </member>
  26573. <member name="P:NPOI.POIFS.Storage.HeaderBlockReader.BigBlockSize">
  26574. <summary>
  26575. Gets The Big Block Size, normally 512 bytes, sometimes 4096 bytes
  26576. </summary>
  26577. <value>The size of the big block.</value>
  26578. @return
  26579. </member>
  26580. <member name="T:NPOI.POIFS.Storage.HeaderBlockWriter">
  26581. <summary>
  26582. The block containing the archive header
  26583. @author Marc Johnson (mjohnson at apache dot org)
  26584. </summary>
  26585. </member>
  26586. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.SetBATBlocks(System.Int32,System.Int32)">
  26587. <summary>
  26588. Set BAT block parameters. Assumes that all BAT blocks are
  26589. contiguous. Will construct XBAT blocks if necessary and return
  26590. the array of newly constructed XBAT blocks.
  26591. </summary>
  26592. <param name="blockCount">count of BAT blocks</param>
  26593. <param name="startBlock">index of first BAT block</param>
  26594. <returns>array of XBAT blocks; may be zero Length, will not be
  26595. null</returns>
  26596. </member>
  26597. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.PropertyStart">
  26598. <summary>
  26599. Set start of Property Table
  26600. </summary>
  26601. <value>the index of the first block of the Property
  26602. Table</value>
  26603. </member>
  26604. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBAStart">
  26605. <summary>
  26606. Set start of small block allocation table
  26607. </summary>
  26608. <value>the index of the first big block of the small
  26609. block allocation table</value>
  26610. </member>
  26611. <member name="P:NPOI.POIFS.Storage.HeaderBlockWriter.SBATBlockCount">
  26612. <summary>
  26613. Set count of SBAT blocks
  26614. </summary>
  26615. <value>the number of SBAT blocks</value>
  26616. </member>
  26617. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.CalculateXBATStorageRequirements(NPOI.POIFS.Common.POIFSBigBlockSize,System.Int32)">
  26618. <summary>
  26619. For a given number of BAT blocks, calculate how many XBAT
  26620. blocks will be needed
  26621. </summary>
  26622. <param name="bigBlockSize"></param>
  26623. <param name="blockCount">number of BAT blocks</param>
  26624. <returns>number of XBAT blocks needed</returns>
  26625. </member>
  26626. <member name="M:NPOI.POIFS.Storage.HeaderBlockWriter.WriteBlocks(System.IO.Stream)">
  26627. <summary>
  26628. Write the block's data to an Stream
  26629. </summary>
  26630. <param name="stream">the Stream to which the stored data should
  26631. be written
  26632. </param>
  26633. </member>
  26634. <member name="T:NPOI.POIFS.Storage.ListManagedBlock">
  26635. <summary>
  26636. An interface for blocks managed by a list that works with a
  26637. BlockAllocationTable to keep block sequences straight
  26638. @author Marc Johnson (mjohnson at apache dot org
  26639. </summary>
  26640. </member>
  26641. <member name="P:NPOI.POIFS.Storage.ListManagedBlock.Data">
  26642. <summary>
  26643. Get the data from the block
  26644. </summary>
  26645. <value>the block's data as a byte array</value>
  26646. </member>
  26647. <member name="T:NPOI.POIFS.Storage.PropertyBlock">
  26648. <summary>
  26649. A block of Property instances
  26650. @author Marc Johnson (mjohnson at apache dot org)
  26651. </summary>
  26652. </member>
  26653. <member name="M:NPOI.POIFS.Storage.PropertyBlock.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Properties.Property[],System.Int32)">
  26654. <summary>
  26655. Create a single instance initialized with default values
  26656. </summary>
  26657. <param name="bigBlockSize"></param>
  26658. <param name="properties">the properties to be inserted</param>
  26659. <param name="offset">the offset into the properties array</param>
  26660. </member>
  26661. <member name="M:NPOI.POIFS.Storage.PropertyBlock.CreatePropertyBlockArray(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.Generic.List{NPOI.POIFS.Properties.Property})">
  26662. <summary>
  26663. Create an array of PropertyBlocks from an array of Property
  26664. instances, creating empty Property instances to make up any
  26665. shortfall
  26666. </summary>
  26667. <param name="bigBlockSize"></param>
  26668. <param name="properties">the Property instances to be converted into PropertyBlocks, in a java List</param>
  26669. <returns>the array of newly created PropertyBlock instances</returns>
  26670. </member>
  26671. <member name="M:NPOI.POIFS.Storage.PropertyBlock.WriteData(System.IO.Stream)">
  26672. <summary>
  26673. Write the block's data to an OutputStream
  26674. </summary>
  26675. <param name="stream">the OutputStream to which the stored data should be written</param>
  26676. </member>
  26677. <member name="T:NPOI.POIFS.Storage.RawDataBlock">
  26678. <summary>
  26679. A big block created from an InputStream, holding the raw data
  26680. @author Marc Johnson (mjohnson at apache dot org
  26681. </summary>
  26682. </member>
  26683. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream)">
  26684. <summary>
  26685. Constructor RawDataBlock
  26686. </summary>
  26687. <param name="stream">the Stream from which the data will be read</param>
  26688. </member>
  26689. <member name="M:NPOI.POIFS.Storage.RawDataBlock.#ctor(System.IO.Stream,System.Int32)">
  26690. <summary>
  26691. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlock"/> class.
  26692. </summary>
  26693. <param name="stream">the Stream from which the data will be read</param>
  26694. <param name="blockSize">the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE}</param>
  26695. </member>
  26696. <member name="P:NPOI.POIFS.Storage.RawDataBlock.EOF">
  26697. <summary>
  26698. When we read the data, did we hit end of file?
  26699. </summary>
  26700. <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
  26701. it's possible to both have data, and also hit EoF...</value>
  26702. </member>
  26703. <member name="P:NPOI.POIFS.Storage.RawDataBlock.HasData">
  26704. <summary>
  26705. Did we actually find any data to read? It's possible,
  26706. in the event of a short last block, to both have hit
  26707. the EoF, but also to have data
  26708. </summary>
  26709. <value><c>true</c> if this instance has data; otherwise, <c>false</c>.</value>
  26710. </member>
  26711. <member name="P:NPOI.POIFS.Storage.RawDataBlock.Data">
  26712. <summary>
  26713. Get the data from the block
  26714. </summary>
  26715. <value>the block's data as a byte array</value>
  26716. </member>
  26717. <member name="T:NPOI.POIFS.Storage.RawDataBlockList">
  26718. <summary>
  26719. A list of RawDataBlocks instances, and methods to manage the list
  26720. @author Marc Johnson (mjohnson at apache dot org
  26721. </summary>
  26722. </member>
  26723. <member name="M:NPOI.POIFS.Storage.RawDataBlockList.#ctor(System.IO.Stream,NPOI.POIFS.Common.POIFSBigBlockSize)">
  26724. <summary>
  26725. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.RawDataBlockList"/> class.
  26726. </summary>
  26727. <param name="stream">the InputStream from which the data will be read</param>
  26728. <param name="bigBlockSize">The big block size, either 512 bytes or 4096 bytes</param>
  26729. </member>
  26730. <member name="T:NPOI.POIFS.Storage.SmallBlockTableReader">
  26731. <summary>
  26732. This class implements reading the small document block list from an
  26733. existing file
  26734. @author Marc Johnson (mjohnson at apache dot org)
  26735. </summary>
  26736. </member>
  26737. <member name="M:NPOI.POIFS.Storage.SmallBlockTableReader.GetSmallDocumentBlocks(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.RawDataBlockList,NPOI.POIFS.Properties.RootProperty,System.Int32)">
  26738. <summary>
  26739. fetch the small document block list from an existing file
  26740. </summary>
  26741. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26742. <param name="blockList">the raw data from which the small block table will be extracted</param>
  26743. <param name="root">the root property (which contains the start block and small block table size)</param>
  26744. <param name="sbatStart">the start block of the SBAT</param>
  26745. <returns>the small document block list</returns>
  26746. </member>
  26747. <member name="T:NPOI.POIFS.Storage.SmallBlockTableWriter">
  26748. <summary>
  26749. This class implements reading the small document block list from an
  26750. existing file
  26751. @author Marc Johnson (mjohnson at apache dot org)
  26752. </summary>
  26753. </member>
  26754. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.#ctor(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.IList,NPOI.POIFS.Properties.RootProperty)">
  26755. <summary>
  26756. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallBlockTableWriter"/> class.
  26757. </summary>
  26758. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26759. <param name="documents">a IList of POIFSDocument instances</param>
  26760. <param name="root">the Filesystem's root property</param>
  26761. </member>
  26762. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBATBlockCount">
  26763. <summary>
  26764. Get the number of SBAT blocks
  26765. </summary>
  26766. <value>number of SBAT big blocks</value>
  26767. </member>
  26768. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.SBAT">
  26769. <summary>
  26770. Gets the SBAT.
  26771. </summary>
  26772. <value>the Small Block Allocation Table</value>
  26773. </member>
  26774. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.CountBlocks">
  26775. <summary>
  26776. Return the number of BigBlock's this instance uses
  26777. </summary>
  26778. <value>count of BigBlock instances</value>
  26779. </member>
  26780. <member name="P:NPOI.POIFS.Storage.SmallBlockTableWriter.StartBlock">
  26781. <summary>
  26782. Sets the start block.
  26783. </summary>
  26784. <value>The start block.</value>
  26785. </member>
  26786. <member name="M:NPOI.POIFS.Storage.SmallBlockTableWriter.WriteBlocks(System.IO.Stream)">
  26787. <summary>
  26788. Write the storage to an OutputStream
  26789. </summary>
  26790. <param name="stream">the OutputStream to which the stored data should be written</param>
  26791. </member>
  26792. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlock">
  26793. <summary>
  26794. Storage for documents that are too small to use regular
  26795. DocumentBlocks for their data
  26796. @author Marc Johnson (mjohnson at apache dot org)
  26797. </summary>
  26798. </member>
  26799. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,System.Byte[],System.Int32)">
  26800. <summary>
  26801. convert a single long array into an array of SmallDocumentBlock
  26802. instances
  26803. </summary>
  26804. <param name="bigBlockSize">the poifs bigBlockSize</param>
  26805. <param name="array">the byte array to be converted</param>
  26806. <param name="size">the intended size of the array (which may be smaller)</param>
  26807. <returns>an array of SmallDocumentBlock instances, filled from
  26808. the array</returns>
  26809. </member>
  26810. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Fill(NPOI.POIFS.Common.POIFSBigBlockSize,System.Collections.IList)">
  26811. <summary>
  26812. fill out a List of SmallDocumentBlocks so that it fully occupies
  26813. a Set of big blocks
  26814. </summary>
  26815. <param name="bigBlockSize"></param>
  26816. <param name="blocks">the List to be filled out.</param>
  26817. <returns>number of big blocks the list encompasses</returns>
  26818. </member>
  26819. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Convert(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.BlockWritable[],System.Int32)">
  26820. <summary>
  26821. Factory for creating SmallDocumentBlocks from DocumentBlocks
  26822. </summary>
  26823. <param name="bigBlocksSize"></param>
  26824. <param name="store">the original DocumentBlocks</param>
  26825. <param name="size">the total document size</param>
  26826. <returns>an array of new SmallDocumentBlocks instances</returns>
  26827. </member>
  26828. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Extract(NPOI.POIFS.Common.POIFSBigBlockSize,NPOI.POIFS.Storage.ListManagedBlock[])">
  26829. <summary>
  26830. create a list of SmallDocumentBlock's from raw data
  26831. </summary>
  26832. <param name="bigBlockSize"></param>
  26833. <param name="blocks">the raw data containing the SmallDocumentBlock</param>
  26834. <returns>a List of SmallDocumentBlock's extracted from the input</returns>
  26835. </member>
  26836. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.Read(NPOI.POIFS.Storage.BlockWritable[],System.Byte[],System.Int32)">
  26837. <summary>
  26838. Read data from an array of SmallDocumentBlocks
  26839. </summary>
  26840. <param name="blocks">the blocks to Read from.</param>
  26841. <param name="buffer">the buffer to Write the data into.</param>
  26842. <param name="offset">the offset into the array of blocks to Read from</param>
  26843. </member>
  26844. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.CalcSize(System.Int32)">
  26845. <summary>
  26846. Calculate the storage size of a Set of SmallDocumentBlocks
  26847. </summary>
  26848. <param name="size"> number of SmallDocumentBlocks</param>
  26849. <returns>total size</returns>
  26850. </member>
  26851. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.MakeEmptySmallDocumentBlock(NPOI.POIFS.Common.POIFSBigBlockSize)">
  26852. <summary>
  26853. Makes the empty small document block.
  26854. </summary>
  26855. <returns></returns>
  26856. </member>
  26857. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.ConvertToBlockCount(System.Int32)">
  26858. <summary>
  26859. Converts to block count.
  26860. </summary>
  26861. <param name="size">The size.</param>
  26862. <returns></returns>
  26863. </member>
  26864. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlock.WriteBlocks(System.IO.Stream)">
  26865. <summary>
  26866. Write the storage to an OutputStream
  26867. </summary>
  26868. <param name="stream">the OutputStream to which the stored data should
  26869. be written</param>
  26870. </member>
  26871. <member name="P:NPOI.POIFS.Storage.SmallDocumentBlock.Data">
  26872. <summary>
  26873. Get the data from the block
  26874. </summary>
  26875. <value>the block's data as a byte array</value>
  26876. </member>
  26877. <member name="T:NPOI.POIFS.Storage.SmallDocumentBlockList">
  26878. <summary>
  26879. A list of SmallDocumentBlocks instances, and methods to manage the list
  26880. @author Marc Johnson (mjohnson at apache dot org)
  26881. </summary>
  26882. </member>
  26883. <member name="M:NPOI.POIFS.Storage.SmallDocumentBlockList.#ctor(System.Collections.Generic.List{NPOI.POIFS.Storage.SmallDocumentBlock})">
  26884. <summary>
  26885. Initializes a new instance of the <see cref="T:NPOI.POIFS.Storage.SmallDocumentBlockList"/> class.
  26886. </summary>
  26887. <param name="blocks">a list of SmallDocumentBlock instances</param>
  26888. </member>
  26889. <member name="T:NPOI.POIOLE2TextExtractor">
  26890. <summary>
  26891. Common Parent for OLE2 based Text Extractors
  26892. of POI Documents, such as .doc, .xls
  26893. You will typically find the implementation of
  26894. a given format's text extractor under NPOI.Format.Extractor
  26895. </summary>
  26896. <remarks>
  26897. @see org.apache.poi.hssf.extractor.ExcelExtractor
  26898. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  26899. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  26900. @see org.apache.poi.hwpf.extractor.WordExtractor
  26901. </remarks>
  26902. </member>
  26903. <member name="M:NPOI.POIOLE2TextExtractor.#ctor(NPOI.POIDocument)">
  26904. <summary>
  26905. Creates a new text extractor for the given document
  26906. </summary>
  26907. <param name="document"></param>
  26908. </member>
  26909. <member name="P:NPOI.POIOLE2TextExtractor.DocSummaryInformation">
  26910. <summary>
  26911. Returns the document information metadata for the document
  26912. </summary>
  26913. <value>The doc summary information.</value>
  26914. </member>
  26915. <member name="P:NPOI.POIOLE2TextExtractor.SummaryInformation">
  26916. <summary>
  26917. Returns the summary information metadata for the document
  26918. </summary>
  26919. <value>The summary information.</value>
  26920. </member>
  26921. <member name="P:NPOI.POIOLE2TextExtractor.MetadataTextExtractor">
  26922. <summary>
  26923. Returns an HPSF powered text extractor for the
  26924. document properties metadata, such as title and author.
  26925. </summary>
  26926. <value></value>
  26927. </member>
  26928. <member name="T:NPOI.POITextExtractor">
  26929. <summary>
  26930. Common Parent for Text Extractors
  26931. of POI Documents.
  26932. You will typically find the implementation of
  26933. a given format's text extractor under
  26934. org.apache.poi.[format].extractor .
  26935. </summary>
  26936. @see org.apache.poi.hssf.extractor.ExcelExtractor
  26937. @see org.apache.poi.hslf.extractor.PowerPointExtractor
  26938. @see org.apache.poi.hdgf.extractor.VisioTextExtractor
  26939. @see org.apache.poi.hwpf.extractor.WordExtractor
  26940. </member>
  26941. <member name="F:NPOI.POITextExtractor.document">
  26942. The POIDocument that's open
  26943. </member>
  26944. <member name="M:NPOI.POITextExtractor.#ctor(NPOI.POIDocument)">
  26945. <summary>
  26946. Creates a new text extractor for the given document
  26947. </summary>
  26948. <param name="document">The document.</param>
  26949. </member>
  26950. <member name="M:NPOI.POITextExtractor.#ctor(NPOI.POITextExtractor)">
  26951. <summary>
  26952. Creates a new text extractor, using the same
  26953. document as another text extractor. Normally
  26954. only used by properties extractors.
  26955. </summary>
  26956. <param name="otherExtractor">The other extractor.</param>
  26957. </member>
  26958. <member name="P:NPOI.POITextExtractor.Text">
  26959. <summary>
  26960. Retrieves all the text from the document.
  26961. How cells, paragraphs etc are separated in the text
  26962. is implementation specific - see the javadocs for
  26963. a specific project for details.
  26964. </summary>
  26965. <value>All the text from the document.</value>
  26966. </member>
  26967. <member name="P:NPOI.POITextExtractor.MetadataTextExtractor">
  26968. <summary>
  26969. Returns another text extractor, which is able to
  26970. output the textual content of the document
  26971. metadata / properties, such as author and title.
  26972. </summary>
  26973. <value>The metadata text extractor.</value>
  26974. </member>
  26975. <member name="M:NPOI.Util.POIUtils.CopyNodeRecursively(NPOI.POIFS.FileSystem.Entry,NPOI.POIFS.FileSystem.DirectoryEntry)">
  26976. Copies an Entry into a target POIFS directory, recursively
  26977. </member>
  26978. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.DirectoryEntry,NPOI.POIFS.FileSystem.DirectoryEntry,System.Collections.Generic.List{System.String})">
  26979. Copies nodes from one POIFS to the other minus the excepts
  26980. @param source
  26981. is the source POIFS to copy from
  26982. @param target
  26983. is the target POIFS to copy to
  26984. @param excepts
  26985. is a list of Strings specifying what nodes NOT to copy
  26986. </member>
  26987. <member name="M:NPOI.Util.POIUtils.CopyNodes(NPOI.POIFS.FileSystem.POIFSFileSystem,NPOI.POIFS.FileSystem.POIFSFileSystem,System.Collections.Generic.List{System.String})">
  26988. Copies nodes from one POIFS to the other minus the excepts
  26989. @param source
  26990. is the source POIFS to copy from
  26991. @param target
  26992. is the target POIFS to copy to
  26993. @param excepts
  26994. is a list of Strings specifying what nodes NOT to copy
  26995. </member>
  26996. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Byte)">
  26997. <summary>
  26998. Fills the specified array.
  26999. </summary>
  27000. <param name="array">The array.</param>
  27001. <param name="defaultValue">The default value.</param>
  27002. </member>
  27003. <member name="M:NPOI.Util.Arrays.Fill(System.Byte[],System.Int32,System.Int32,System.Byte)">
  27004. <summary>
  27005. Assigns the specified byte value to each element of the specified
  27006. range of the specified array of bytes. The range to be filled
  27007. extends from index <tt>fromIndex</tt>, inclusive, to index
  27008. <tt>toIndex</tt>, exclusive. (If <tt>fromIndex==toIndex</tt>, the
  27009. range to be filled is empty.)
  27010. </summary>
  27011. <param name="a">the array to be filled</param>
  27012. <param name="fromIndex">the index of the first element (inclusive) to be filled with the specified value</param>
  27013. <param name="toIndex">the index of the last element (exclusive) to be filled with the specified value</param>
  27014. <param name="val">the value to be stored in all elements of the array</param>
  27015. <exception cref="T:System.ArgumentException">if <c>fromIndex &gt; toIndex</c></exception>
  27016. <exception cref="T:System.IndexOutOfRangeException"> if <c>fromIndex &lt; 0</c> or <c>toIndex &gt; a.length</c></exception>
  27017. </member>
  27018. <member name="M:NPOI.Util.Arrays.RangeCheck(System.Int32,System.Int32,System.Int32)">
  27019. <summary>
  27020. Checks that {@code fromIndex} and {@code toIndex} are in
  27021. the range and throws an appropriate exception, if they aren't.
  27022. </summary>
  27023. <param name="length"></param>
  27024. <param name="fromIndex"></param>
  27025. <param name="toIndex"></param>
  27026. </member>
  27027. <member name="M:NPOI.Util.Arrays.AsList(System.Array)">
  27028. <summary>
  27029. Convert Array to ArrayList
  27030. </summary>
  27031. <param name="arr">source array</param>
  27032. <returns></returns>
  27033. </member>
  27034. <member name="M:NPOI.Util.Arrays.Fill(System.Int32[],System.Byte)">
  27035. <summary>
  27036. Fills the specified array.
  27037. </summary>
  27038. <param name="array">The array.</param>
  27039. <param name="defaultValue">The default value.</param>
  27040. </member>
  27041. <member name="M:NPOI.Util.Arrays.Equals(System.Object,System.Object)">
  27042. <summary>
  27043. Equals the specified a1.
  27044. </summary>
  27045. <param name="a1">The a1.</param>
  27046. <param name="b1">The b1.</param>
  27047. <returns></returns>
  27048. </member>
  27049. <member name="M:NPOI.Util.Arrays.Equals(System.Object[],System.Object[])">
  27050. Returns <c>true</c> if the two specified arrays of Objects are
  27051. <i>equal</i> to one another. The two arrays are considered equal if
  27052. both arrays contain the same number of elements, and all corresponding
  27053. pairs of elements in the two arrays are equal. Two objects <c>e1</c>
  27054. and <c>e2</c> are considered <i>equal</i> if <c>(e1==null ? e2==null
  27055. : e1.equals(e2))</c>. In other words, the two arrays are equal if
  27056. they contain the same elements in the same order. Also, two array
  27057. references are considered equal if both are <c>null</c>.
  27058. @param a one array to be tested for equality
  27059. @param a2 the other array to be tested for equality
  27060. @return <c>true</c> if the two arrays are equal
  27061. </member>
  27062. <member name="M:NPOI.Util.Arrays.ArrayMoveWithin(System.Object[],System.Int32,System.Int32,System.Int32)">
  27063. <summary>
  27064. Moves a number of entries in an array to another point in the array, shifting those inbetween as required.
  27065. </summary>
  27066. <param name="array">The array to alter</param>
  27067. <param name="moveFrom">The (0 based) index of the first entry to move</param>
  27068. <param name="moveTo">The (0 based) index of the positition to move to</param>
  27069. <param name="numToMove">The number of entries to move</param>
  27070. </member>
  27071. <member name="M:NPOI.Util.Arrays.CopyOf(System.Byte[],System.Int32)">
  27072. <summary>
  27073. Copies the specified array, truncating or padding with zeros (if
  27074. necessary) so the copy has the specified length. This method is temporary
  27075. replace for Arrays.copyOf() until we start to require JDK 1.6.
  27076. </summary>
  27077. <param name="source">the array to be copied</param>
  27078. <param name="newLength">the length of the copy to be returned</param>
  27079. <returns>a copy of the original array, truncated or padded with zeros to obtain the specified length</returns>
  27080. </member>
  27081. <member name="M:NPOI.Util.Arrays.HashCode(System.Int64[])">
  27082. Returns a hash code based on the contents of the specified array.
  27083. For any two <tt>long</tt> arrays <tt>a</tt> and <tt>b</tt>
  27084. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27085. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27086. The value returned by this method is the same value that would be
  27087. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27088. method on a {@link List} Containing a sequence of {@link Long}
  27089. instances representing the elements of <tt>a</tt> in the same order.
  27090. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27091. @param a the array whose hash value to compute
  27092. @return a content-based hash code for <tt>a</tt>
  27093. @since 1.5
  27094. </member>
  27095. <member name="M:NPOI.Util.Arrays.HashCode(System.Int32[])">
  27096. Returns a hash code based on the contents of the specified array.
  27097. For any two non-null <tt>int</tt> arrays <tt>a</tt> and <tt>b</tt>
  27098. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27099. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27100. The value returned by this method is the same value that would be
  27101. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27102. method on a {@link List} Containing a sequence of {@link int}
  27103. instances representing the elements of <tt>a</tt> in the same order.
  27104. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27105. @param a the array whose hash value to compute
  27106. @return a content-based hash code for <tt>a</tt>
  27107. @since 1.5
  27108. </member>
  27109. <member name="M:NPOI.Util.Arrays.HashCode(System.Int16[])">
  27110. Returns a hash code based on the contents of the specified array.
  27111. For any two <tt>short</tt> arrays <tt>a</tt> and <tt>b</tt>
  27112. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27113. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27114. The value returned by this method is the same value that would be
  27115. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27116. method on a {@link List} Containing a sequence of {@link short}
  27117. instances representing the elements of <tt>a</tt> in the same order.
  27118. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27119. @param a the array whose hash value to compute
  27120. @return a content-based hash code for <tt>a</tt>
  27121. @since 1.5
  27122. </member>
  27123. <member name="M:NPOI.Util.Arrays.HashCode(System.Char[])">
  27124. Returns a hash code based on the contents of the specified array.
  27125. For any two <tt>char</tt> arrays <tt>a</tt> and <tt>b</tt>
  27126. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27127. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27128. The value returned by this method is the same value that would be
  27129. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27130. method on a {@link List} Containing a sequence of {@link Character}
  27131. instances representing the elements of <tt>a</tt> in the same order.
  27132. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27133. @param a the array whose hash value to compute
  27134. @return a content-based hash code for <tt>a</tt>
  27135. @since 1.5
  27136. </member>
  27137. <member name="M:NPOI.Util.Arrays.HashCode(System.Byte[])">
  27138. Returns a hash code based on the contents of the specified array.
  27139. For any two <tt>byte</tt> arrays <tt>a</tt> and <tt>b</tt>
  27140. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27141. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27142. The value returned by this method is the same value that would be
  27143. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27144. method on a {@link List} Containing a sequence of {@link Byte}
  27145. instances representing the elements of <tt>a</tt> in the same order.
  27146. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27147. @param a the array whose hash value to compute
  27148. @return a content-based hash code for <tt>a</tt>
  27149. @since 1.5
  27150. </member>
  27151. <member name="M:NPOI.Util.Arrays.HashCode(System.Boolean[])">
  27152. Returns a hash code based on the contents of the specified array.
  27153. For any two <tt>bool</tt> arrays <tt>a</tt> and <tt>b</tt>
  27154. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27155. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27156. The value returned by this method is the same value that would be
  27157. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27158. method on a {@link List} Containing a sequence of {@link Boolean}
  27159. instances representing the elements of <tt>a</tt> in the same order.
  27160. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27161. @param a the array whose hash value to compute
  27162. @return a content-based hash code for <tt>a</tt>
  27163. @since 1.5
  27164. </member>
  27165. <member name="M:NPOI.Util.Arrays.HashCode(System.Single[])">
  27166. Returns a hash code based on the contents of the specified array.
  27167. For any two <tt>float</tt> arrays <tt>a</tt> and <tt>b</tt>
  27168. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27169. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27170. The value returned by this method is the same value that would be
  27171. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27172. method on a {@link List} Containing a sequence of {@link Float}
  27173. instances representing the elements of <tt>a</tt> in the same order.
  27174. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27175. @param a the array whose hash value to compute
  27176. @return a content-based hash code for <tt>a</tt>
  27177. @since 1.5
  27178. </member>
  27179. <member name="M:NPOI.Util.Arrays.HashCode(System.Double[])">
  27180. Returns a hash code based on the contents of the specified array.
  27181. For any two <tt>double</tt> arrays <tt>a</tt> and <tt>b</tt>
  27182. such that <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27183. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27184. The value returned by this method is the same value that would be
  27185. obtained by invoking the {@link List#hashCode() <tt>hashCode</tt>}
  27186. method on a {@link List} Containing a sequence of {@link Double}
  27187. instances representing the elements of <tt>a</tt> in the same order.
  27188. If <tt>a</tt> is <tt>null</tt>, this method returns 0.
  27189. @param a the array whose hash value to compute
  27190. @return a content-based hash code for <tt>a</tt>
  27191. @since 1.5
  27192. </member>
  27193. <member name="M:NPOI.Util.Arrays.HashCode(System.Object[])">
  27194. Returns a hash code based on the contents of the specified array. If
  27195. the array Contains other arrays as elements, the hash code is based on
  27196. their identities rather than their contents. It is therefore
  27197. acceptable to invoke this method on an array that Contains itself as an
  27198. element, either directly or indirectly through one or more levels of
  27199. arrays.
  27200. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  27201. <tt>Arrays.Equals(a, b)</tt>, it is also the case that
  27202. <tt>Arrays.HashCode(a) == Arrays.HashCode(b)</tt>.
  27203. The value returned by this method is equal to the value that would
  27204. be returned by <tt>Arrays.AsList(a).HashCode()</tt>, unless <tt>a</tt>
  27205. is <tt>null</tt>, in which case <tt>0</tt> is returned.
  27206. @param a the array whose content-based hash code to compute
  27207. @return a content-based hash code for <tt>a</tt>
  27208. @see #deepHashCode(Object[])
  27209. @since 1.5
  27210. </member>
  27211. <member name="M:NPOI.Util.Arrays.DeepHashCode(System.Object[])">
  27212. Returns a hash code based on the "deep contents" of the specified
  27213. array. If the array Contains other arrays as elements, the
  27214. hash code is based on their contents and so on, ad infInitum.
  27215. It is therefore unacceptable to invoke this method on an array that
  27216. Contains itself as an element, either directly or indirectly through
  27217. one or more levels of arrays. The behavior of such an invocation is
  27218. undefined.
  27219. For any two arrays <tt>a</tt> and <tt>b</tt> such that
  27220. <tt>Arrays.DeepEquals(a, b)</tt>, it is also the case that
  27221. <tt>Arrays.DeepHashCode(a) == Arrays.DeepHashCode(b)</tt>.
  27222. The computation of the value returned by this method is similar to
  27223. that of the value returned by {@link List#hashCode()} on a list
  27224. Containing the same elements as <tt>a</tt> in the same order, with one
  27225. difference: If an element <tt>e</tt> of <tt>a</tt> is itself an array,
  27226. its hash code is computed not by calling <tt>e.HashCode()</tt>, but as
  27227. by calling the appropriate overloading of <tt>Arrays.HashCode(e)</tt>
  27228. if <tt>e</tt> is an array of a primitive type, or as by calling
  27229. <tt>Arrays.DeepHashCode(e)</tt> recursively if <tt>e</tt> is an array
  27230. of a reference type. If <tt>a</tt> is <tt>null</tt>, this method
  27231. returns 0.
  27232. @param a the array whose deep-content-based hash code to compute
  27233. @return a deep-content-based hash code for <tt>a</tt>
  27234. @see #hashCode(Object[])
  27235. @since 1.5
  27236. </member>
  27237. <member name="M:NPOI.Util.Arrays.DeepEquals(System.Object[],System.Object[])">
  27238. Returns <tt>true</tt> if the two specified arrays are <i>deeply
  27239. Equal</i> to one another. Unlike the {@link #Equals(Object[],Object[])}
  27240. method, this method is appropriate for use with nested arrays of
  27241. arbitrary depth.
  27242. Two array references are considered deeply equal if both
  27243. are <tt>null</tt>, or if they refer to arrays that contain the same
  27244. number of elements and all corresponding pairs of elements in the two
  27245. arrays are deeply Equal.
  27246. Two possibly <tt>null</tt> elements <tt>e1</tt> and <tt>e2</tt> are
  27247. deeply equal if any of the following conditions hold:
  27248. <ul>
  27249. <li> <tt>e1</tt> and <tt>e2</tt> are both arrays of object reference
  27250. types, and <tt>Arrays.DeepEquals(e1, e2) would return true</tt></li>
  27251. <li> <tt>e1</tt> and <tt>e2</tt> are arrays of the same primitive
  27252. type, and the appropriate overloading of
  27253. <tt>Arrays.Equals(e1, e2)</tt> would return true.</li>
  27254. <li> <tt>e1 == e2</tt></li>
  27255. <li> <tt>e1.Equals(e2)</tt> would return true.</li>
  27256. </ul>
  27257. Note that this defInition permits <tt>null</tt> elements at any depth.
  27258. If either of the specified arrays contain themselves as elements
  27259. either directly or indirectly through one or more levels of arrays,
  27260. the behavior of this method is undefined.
  27261. @param a1 one array to be tested for Equality
  27262. @param a2 the other array to be tested for Equality
  27263. @return <tt>true</tt> if the two arrays are equal
  27264. @see #Equals(Object[],Object[])
  27265. @see Objects#deepEquals(Object, Object)
  27266. @since 1.5
  27267. </member>
  27268. <member name="M:NPOI.Util.Arrays.ToString(System.Int64[])">
  27269. Returns a string representation of the contents of the specified array.
  27270. The string representation consists of a list of the array's elements,
  27271. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27272. Separated by the characters <tt>", "</tt> (a comma followed by a
  27273. space). Elements are Converted to strings as by
  27274. <tt>String.ValueOf(long)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27275. is <tt>null</tt>.
  27276. @param a the array whose string representation to return
  27277. @return a string representation of <tt>a</tt>
  27278. @since 1.5
  27279. </member>
  27280. <member name="M:NPOI.Util.Arrays.ToString(System.Int32[])">
  27281. Returns a string representation of the contents of the specified array.
  27282. The string representation consists of a list of the array's elements,
  27283. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27284. Separated by the characters <tt>", "</tt> (a comma followed by a
  27285. space). Elements are Converted to strings as by
  27286. <tt>String.ValueOf(int)</tt>. Returns <tt>"null"</tt> if <tt>a</tt> is
  27287. <tt>null</tt>.
  27288. @param a the array whose string representation to return
  27289. @return a string representation of <tt>a</tt>
  27290. @since 1.5
  27291. </member>
  27292. <member name="M:NPOI.Util.Arrays.ToString(System.Int16[])">
  27293. Returns a string representation of the contents of the specified array.
  27294. The string representation consists of a list of the array's elements,
  27295. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27296. Separated by the characters <tt>", "</tt> (a comma followed by a
  27297. space). Elements are Converted to strings as by
  27298. <tt>String.ValueOf(short)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27299. is <tt>null</tt>.
  27300. @param a the array whose string representation to return
  27301. @return a string representation of <tt>a</tt>
  27302. @since 1.5
  27303. </member>
  27304. <member name="M:NPOI.Util.Arrays.ToString(System.Char[])">
  27305. Returns a string representation of the contents of the specified array.
  27306. The string representation consists of a list of the array's elements,
  27307. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27308. Separated by the characters <tt>", "</tt> (a comma followed by a
  27309. space). Elements are Converted to strings as by
  27310. <tt>String.ValueOf(char)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27311. is <tt>null</tt>.
  27312. @param a the array whose string representation to return
  27313. @return a string representation of <tt>a</tt>
  27314. @since 1.5
  27315. </member>
  27316. <member name="M:NPOI.Util.Arrays.ToString(System.Byte[])">
  27317. Returns a string representation of the contents of the specified array.
  27318. The string representation consists of a list of the array's elements,
  27319. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements
  27320. are Separated by the characters <tt>", "</tt> (a comma followed
  27321. by a space). Elements are Converted to strings as by
  27322. <tt>String.ValueOf(byte)</tt>. Returns <tt>"null"</tt> if
  27323. <tt>a</tt> is <tt>null</tt>.
  27324. @param a the array whose string representation to return
  27325. @return a string representation of <tt>a</tt>
  27326. @since 1.5
  27327. </member>
  27328. <member name="M:NPOI.Util.Arrays.ToString(System.Boolean[])">
  27329. Returns a string representation of the contents of the specified array.
  27330. The string representation consists of a list of the array's elements,
  27331. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27332. Separated by the characters <tt>", "</tt> (a comma followed by a
  27333. space). Elements are Converted to strings as by
  27334. <tt>String.ValueOf(bool)</tt>. Returns <tt>"null"</tt> if
  27335. <tt>a</tt> is <tt>null</tt>.
  27336. @param a the array whose string representation to return
  27337. @return a string representation of <tt>a</tt>
  27338. @since 1.5
  27339. </member>
  27340. <member name="M:NPOI.Util.Arrays.ToString(System.Single[])">
  27341. Returns a string representation of the contents of the specified array.
  27342. The string representation consists of a list of the array's elements,
  27343. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27344. Separated by the characters <tt>", "</tt> (a comma followed by a
  27345. space). Elements are Converted to strings as by
  27346. <tt>String.ValueOf(float)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27347. is <tt>null</tt>.
  27348. @param a the array whose string representation to return
  27349. @return a string representation of <tt>a</tt>
  27350. @since 1.5
  27351. </member>
  27352. <member name="M:NPOI.Util.Arrays.ToString(System.Double[])">
  27353. Returns a string representation of the contents of the specified array.
  27354. The string representation consists of a list of the array's elements,
  27355. enclosed in square brackets (<tt>"[]"</tt>). Adjacent elements are
  27356. Separated by the characters <tt>", "</tt> (a comma followed by a
  27357. space). Elements are Converted to strings as by
  27358. <tt>String.ValueOf(double)</tt>. Returns <tt>"null"</tt> if <tt>a</tt>
  27359. is <tt>null</tt>.
  27360. @param a the array whose string representation to return
  27361. @return a string representation of <tt>a</tt>
  27362. @since 1.5
  27363. </member>
  27364. <member name="M:NPOI.Util.Arrays.DeepToString(System.Object[])">
  27365. Returns a string representation of the "deep contents" of the specified
  27366. array. If the array Contains other arrays as elements, the string
  27367. representation Contains their contents and so on. This method is
  27368. designed for Converting multidimensional arrays to strings.
  27369. The string representation consists of a list of the array's
  27370. elements, enclosed in square brackets (<tt>"[]"</tt>). Adjacent
  27371. elements are Separated by the characters <tt>", "</tt> (a comma
  27372. followed by a space). Elements are Converted to strings as by
  27373. <tt>String.ValueOf(Object)</tt>, unless they are themselves
  27374. arrays.
  27375. If an element <tt>e</tt> is an array of a primitive type, it is
  27376. Converted to a string as by invoking the appropriate overloading of
  27377. <tt>Arrays.ToString(e)</tt>. If an element <tt>e</tt> is an array of a
  27378. reference type, it is Converted to a string as by invoking
  27379. this method recursively.
  27380. To avoid infInite recursion, if the specified array Contains itself
  27381. as an element, or Contains an indirect reference to itself through one
  27382. or more levels of arrays, the self-reference is Converted to the string
  27383. <tt>"[...]"</tt>. For example, an array Containing only a reference
  27384. to itself would be rendered as <tt>"[[...]]"</tt>.
  27385. This method returns <tt>"null"</tt> if the specified array
  27386. is <tt>null</tt>.
  27387. @param a the array whose string representation to return
  27388. @return a string representation of <tt>a</tt>
  27389. @see #ToString(Object[])
  27390. @since 1.5
  27391. </member>
  27392. <member name="M:NPOI.Util.Arrays.ToString(System.Object[])">
  27393. Returns a string representation of the contents of the specified array.
  27394. If the array contains other arrays as elements, they are converted to
  27395. strings by the {@link Object#toString} method inherited from
  27396. <tt>Object</tt>, which describes their <i>identities</i> rather than
  27397. their contents.
  27398. <p>The value returned by this method is equal to the value that would
  27399. be returned by <tt>Arrays.asList(a).toString()</tt>, unless <tt>a</tt>
  27400. is <tt>null</tt>, in which case <tt>"null"</tt> is returned.</p>
  27401. @param a the array whose string representation to return
  27402. @return a string representation of <tt>a</tt>
  27403. @see #deepToString(Object[])
  27404. @since 1.5
  27405. </member>
  27406. <member name="F:NPOI.Util.BigInteger._signum">
  27407. The signum of this BigInteger: -1 for negative, 0 for zero, or
  27408. 1 for positive. Note that the BigInteger zero <i>must</i> have
  27409. a signum of 0. This is necessary to ensures that there is exactly one
  27410. representation for each BigInteger value.
  27411. @serial
  27412. </member>
  27413. <member name="F:NPOI.Util.BigInteger.mag">
  27414. The magnitude of this BigInteger, in <i>big-endian</i> order: the
  27415. zeroth element of this array is the most-significant int of the
  27416. magnitude. The magnitude must be "minimal" in that the most-significant
  27417. int ({@code mag[0]}) must be non-zero. This is necessary to
  27418. ensure that there is exactly one representation for each BigInteger
  27419. value. Note that this implies that the BigInteger zero has a
  27420. zero-length mag array.
  27421. </member>
  27422. <member name="F:NPOI.Util.BigInteger.bitCount">
  27423. One plus the bitCount of this BigInteger. Zeros means unitialized.
  27424. @serial
  27425. @see #bitCount
  27426. @deprecated Deprecated since logical value is offset from stored
  27427. value and correction factor is applied in accessor method.
  27428. </member>
  27429. <member name="F:NPOI.Util.BigInteger.bitLength">
  27430. One plus the bitLength of this BigInteger. Zeros means unitialized.
  27431. (either value is acceptable).
  27432. @serial
  27433. @see #bitLength()
  27434. @deprecated Deprecated since logical value is offset from stored
  27435. value and correction factor is applied in accessor method.
  27436. </member>
  27437. <member name="F:NPOI.Util.BigInteger.firstNonzeroIntNum">
  27438. Two plus the index of the lowest-order int in the magnitude of this
  27439. BigInteger that contains a nonzero int, or -2 (either value is acceptable).
  27440. The least significant int has int-number 0, the next int in order of
  27441. increasing significance has int-number 1, and so forth.
  27442. @deprecated Deprecated since logical value is offset from stored
  27443. value and correction factor is applied in accessor method.
  27444. </member>
  27445. <member name="F:NPOI.Util.BigInteger.LONG_MASK">
  27446. This mask is used to obtain the value of an int as if it were unsigned.
  27447. </member>
  27448. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[],System.Int32)">
  27449. This internal constructor differs from its public cousin
  27450. with the arguments reversed in two ways: it assumes that its
  27451. arguments are correct, and it doesn't copy the magnitude array.
  27452. </member>
  27453. <member name="M:NPOI.Util.BigInteger.#ctor(System.Byte[])">
  27454. Translates a byte array containing the two's-complement binary
  27455. representation of a BigInteger into a BigInteger. The input array is
  27456. assumed to be in <i>big-endian</i> byte-order: the most significant
  27457. byte is in the zeroth element.
  27458. @param val big-endian two's-complement binary representation of
  27459. BigInteger.
  27460. @throws NumberFormatException {@code val} is zero bytes long.
  27461. </member>
  27462. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int32[])">
  27463. This private constructor translates an int array containing the
  27464. two's-complement binary representation of a BigInteger into a
  27465. BigInteger. The input array is assumed to be in <i>big-endian</i>
  27466. int-order: the most significant int is in the zeroth element.
  27467. </member>
  27468. <member name="M:NPOI.Util.BigInteger.#ctor(System.Int64)">
  27469. Constructs a BigInteger with the specified value, which may not be zero.
  27470. </member>
  27471. <member name="M:NPOI.Util.BigInteger.TrustedStripLeadingZeroInts(System.Int32[])">
  27472. Returns the input array stripped of any leading zero bytes.
  27473. Since the source is trusted the copying may be skipped.
  27474. </member>
  27475. <member name="M:NPOI.Util.BigInteger.ToString(System.Int32)">
  27476. Returns the String representation of this BigInteger in the
  27477. given radix. If the radix is outside the range from {@link
  27478. Character#Min_RADIX} to {@link Character#Max_RADIX} inclusive,
  27479. it will default to 10 (as is the case for
  27480. {@code Integer.toString}). The digit-to-character mapping
  27481. provided by {@code Character.forDigit} is used, and a minus
  27482. sign is prepended if appropriate. (This representation is
  27483. compatible with the {@link #BigInteger(String, int) (String,
  27484. int)} constructor.)
  27485. @param radix radix of the String representation.
  27486. @return String representation of this BigInteger in the given radix.
  27487. @see Integer#toString
  27488. @see Character#forDigit
  27489. @see #BigInteger(java.lang.String, int)
  27490. </member>
  27491. <member name="F:NPOI.Util.BigInteger.ZERO">
  27492. The BigInteger constant zero.
  27493. @since 1.2
  27494. </member>
  27495. <member name="F:NPOI.Util.BigInteger.One">
  27496. The BigInteger constant one.
  27497. @since 1.2
  27498. </member>
  27499. <member name="F:NPOI.Util.BigInteger.Two">
  27500. The BigInteger constant two. (Not exported.)
  27501. </member>
  27502. <member name="F:NPOI.Util.BigInteger.TEN">
  27503. The BigInteger constant ten.
  27504. @since 1.5
  27505. </member>
  27506. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int64)">
  27507. Returns a BigInteger whose value is equal to that of the
  27508. specified {@code long}. This "static factory method" is
  27509. provided in preference to a ({@code long}) constructor
  27510. because it allows for reuse of frequently used BigIntegers.
  27511. @param val value of the BigInteger to return.
  27512. @return a BigInteger with the specified value.
  27513. </member>
  27514. <member name="M:NPOI.Util.BigInteger.ValueOf(System.Int32[])">
  27515. Returns a BigInteger with the given two's complement representation.
  27516. Assumes that the input array will not be modified (the returned
  27517. BigInteger will reference the input array if feasible).
  27518. </member>
  27519. <member name="M:NPOI.Util.BigInteger.BitLengthForInt(System.Int32)">
  27520. Package private method to return bit length for an integer.
  27521. </member>
  27522. <member name="M:NPOI.Util.BigInteger.BitCount">
  27523. Returns the number of bits in the two's complement representation
  27524. of this BigInteger that differ from its sign bit. This method is
  27525. useful when implementing bit-vector style sets atop BigIntegers.
  27526. @return number of bits in the two's complement representation
  27527. of this BigInteger that differ from its sign bit.
  27528. </member>
  27529. <member name="M:NPOI.Util.BigInteger.Abs">
  27530. Returns a BigInteger whose value is the absolute value of this
  27531. BigInteger.
  27532. @return {@code abs(this)}
  27533. </member>
  27534. <member name="M:NPOI.Util.BigInteger.Negate">
  27535. Returns a BigInteger whose value is {@code (-this)}.
  27536. @return {@code -this}
  27537. </member>
  27538. <member name="M:NPOI.Util.BigInteger.Pow(System.Int32)">
  27539. Returns a BigInteger whose value is <c>(this<sup>exponent</sup>)</c>.
  27540. Note that {@code exponent} is an integer rather than a BigInteger.
  27541. @param exponent exponent to which this BigInteger is to be raised.
  27542. @return <c>this<sup>exponent</sup></c>
  27543. @throws ArithmeticException {@code exponent} is negative. (This would
  27544. cause the operation to yield a non-integer value.)
  27545. </member>
  27546. <member name="M:NPOI.Util.BigInteger.MultiplyToLen(System.Int32[],System.Int32,System.Int32[],System.Int32,System.Int32[])">
  27547. Multiplies int arrays x and y to the specified lengths and places
  27548. the result into z. There will be no leading zeros in the resultant array.
  27549. </member>
  27550. <member name="M:NPOI.Util.BigInteger.mulAdd(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  27551. Multiply an array by one word k and add to result, return the carry
  27552. </member>
  27553. <member name="M:NPOI.Util.BigInteger.squareToLen(System.Int32[],System.Int32,System.Int32[])">
  27554. Squares the contents of the int array x. The result is placed into the
  27555. int array z. The contents of x are not changed.
  27556. </member>
  27557. <member name="M:NPOI.Util.BigInteger.addOne(System.Int32[],System.Int32,System.Int32,System.Int32)">
  27558. Add one word to the number a mlen words into a. Return the resulting
  27559. carry.
  27560. </member>
  27561. <member name="M:NPOI.Util.BigInteger.Signum">
  27562. Returns the signum function of this BigInteger.
  27563. @return -1, 0 or 1 as the value of this BigInteger is negative, zero or
  27564. positive.
  27565. </member>
  27566. <member name="M:NPOI.Util.BigInteger.ToByteArray">
  27567. Returns a byte array containing the two's-complement
  27568. representation of this BigInteger. The byte array will be in
  27569. <i>big-endian</i> byte-order: the most significant byte is in
  27570. the zeroth element. The array will contain the minimum number
  27571. of bytes required to represent this BigInteger, including at
  27572. least one sign bit, which is {@code (ceil((this.bitLength() +
  27573. 1)/8))}. (This representation is compatible with the
  27574. {@link #BigInteger(byte[]) (byte[])} constructor.)
  27575. @return a byte array containing the two's-complement representation of
  27576. this BigInteger.
  27577. @see #BigInteger(byte[])
  27578. </member>
  27579. <member name="M:NPOI.Util.BigInteger.intLength">
  27580. Returns the length of the two's complement representation in ints,
  27581. including space for at least one sign bit.
  27582. </member>
  27583. <member name="M:NPOI.Util.BigInteger.GetInt(System.Int32)">
  27584. Returns the specified int of the little-endian two's complement
  27585. representation (int 0 is the least significant). The int number can
  27586. be arbitrarily high (values are logically preceded by infinitely many
  27587. sign ints).
  27588. </member>
  27589. <member name="M:NPOI.Util.BigInteger.FirstNonzeroIntNum">
  27590. Returns the index of the int that contains the first nonzero int in the
  27591. little-endian binary representation of the magnitude (int 0 is the
  27592. least significant). If the magnitude is zero, return value is undefined.
  27593. </member>
  27594. <member name="M:NPOI.Util.BigInteger.stripLeadingZeroBytes(System.Byte[])">
  27595. Returns a copy of the input array stripped of any leading zero bytes.
  27596. </member>
  27597. <member name="M:NPOI.Util.BigInteger.makePositive(System.Byte[])">
  27598. Takes an array a representing a negative 2's-complement number and
  27599. returns the minimal (no leading zero bytes) unsigned whose value is -a.
  27600. </member>
  27601. <member name="M:NPOI.Util.BigInteger.makePositive(System.Int32[])">
  27602. Takes an array a representing a negative 2's-complement number and
  27603. returns the minimal (no leading zero ints) unsigned whose value is -a.
  27604. </member>
  27605. <member name="M:NPOI.Util.BigInteger.NumberOfLeadingZeros(System.Int32)">
  27606. Returns the number of zero bits preceding the highest-order
  27607. ("leftmost") one-bit in the two's complement binary representation
  27608. of the specified {@code int} value. Returns 32 if the
  27609. specified value has no one-bits in its two's complement representation,
  27610. in other words if it is equal to zero.
  27611. Note that this method is closely related to the logarithm base 2.
  27612. For all positive {@code int} values x:
  27613. <ul>
  27614. <li>floor(log<sub>2</sub>(x)) = {@code 31 - numberOfLeadingZeros(x)}</li>
  27615. <li>ceil(log<sub>2</sub>(x)) = {@code 32 - numberOfLeadingZeros(x - 1)}</li>
  27616. </ul>
  27617. @return the number of zero bits preceding the highest-order
  27618. ("leftmost") one-bit in the two's complement binary representation
  27619. of the specified {@code int} value, or 32 if the value
  27620. is equal to zero.
  27621. @since 1.5
  27622. </member>
  27623. <member name="M:NPOI.Util.BigInteger.NumberOfTrailingZeros(System.Int32)">
  27624. Returns the number of zero bits following the lowest-order ("rightmost")
  27625. one-bit in the two's complement binary representation of the specified
  27626. {@code int} value. Returns 32 if the specified value has no
  27627. one-bits in its two's complement representation, in other words if it is
  27628. equal to zero.
  27629. @return the number of zero bits following the lowest-order ("rightmost")
  27630. one-bit in the two's complement binary representation of the
  27631. specified {@code int} value, or 32 if the value is equal
  27632. to zero.
  27633. @since 1.5
  27634. </member>
  27635. <member name="M:NPOI.Util.BigInteger.BitCountForInt(System.Int32)">
  27636. Returns the number of one-bits in the two's complement binary
  27637. representation of the specified {@code int} value. This function is
  27638. sometimes referred to as the <i>population count</i>.
  27639. @return the number of one-bits in the two's complement binary
  27640. representation of the specified {@code int} value.
  27641. @since 1.5
  27642. </member>
  27643. <member name="M:NPOI.Util.BigInteger.compareMagnitude(NPOI.Util.BigInteger)">
  27644. Compares the magnitude array of this BigInteger with the specified
  27645. BigInteger's. This is the version of compareTo ignoring sign.
  27646. @param val BigInteger whose magnitude array to be compared.
  27647. @return -1, 0 or 1 as this magnitude array is less than, equal to or
  27648. greater than the magnitude aray for the specified BigInteger's.
  27649. </member>
  27650. <member name="M:NPOI.Util.BigInteger.Equals(System.Object)">
  27651. Compares this BigInteger with the specified Object for equality.
  27652. @param x Object to which this BigInteger is to be compared.
  27653. @return {@code true} if and only if the specified Object is a
  27654. BigInteger whose value is numerically equal to this BigInteger.
  27655. </member>
  27656. <member name="M:NPOI.Util.BigInteger.Min(NPOI.Util.BigInteger)">
  27657. Returns the minimum of this BigInteger and {@code val}.
  27658. @param val value with which the minimum is to be computed.
  27659. @return the BigInteger whose value is the lesser of this BigInteger and
  27660. {@code val}. If they are equal, either may be returned.
  27661. </member>
  27662. <member name="M:NPOI.Util.BigInteger.Max(NPOI.Util.BigInteger)">
  27663. Returns the maximum of this BigInteger and {@code val}.
  27664. @param val value with which the maximum is to be computed.
  27665. @return the BigInteger whose value is the greater of this and
  27666. {@code val}. If they are equal, either may be returned.
  27667. </member>
  27668. <member name="M:NPOI.Util.BigInteger.GetHashCode">
  27669. Returns the hash code for this BigInteger.
  27670. @return hash code for this BigInteger.
  27671. </member>
  27672. <member name="M:NPOI.Util.BigInteger.IntValue">
  27673. Converts this BigInteger to an {@code int}. This
  27674. conversion is analogous to a
  27675. <i>narrowing primitive conversion</i> from {@code long} to
  27676. {@code int} as defined in section 5.1.3 of
  27677. <cite>The Java(TM) Language Specification</cite>:
  27678. if this BigInteger is too big to fit in an
  27679. {@code int}, only the low-order 32 bits are returned.
  27680. Note that this conversion can lose information about the
  27681. overall magnitude of the BigInteger value as well as return a
  27682. result with the opposite sign.
  27683. @return this BigInteger converted to an {@code int}.
  27684. </member>
  27685. <member name="M:NPOI.Util.BigInteger.LongValue">
  27686. Converts this BigInteger to a {@code long}. This
  27687. conversion is analogous to a
  27688. <i>narrowing primitive conversion</i> from {@code long} to
  27689. {@code int} as defined in section 5.1.3 of
  27690. <cite>The Java(TM) Language Specification</cite>:
  27691. if this BigInteger is too big to fit in a
  27692. {@code long}, only the low-order 64 bits are returned.
  27693. Note that this conversion can lose information about the
  27694. overall magnitude of the BigInteger value as well as return a
  27695. result with the opposite sign.
  27696. @return this BigInteger converted to a {@code long}.
  27697. </member>
  27698. <member name="M:NPOI.Util.BigInteger.ShiftRight(System.Int32)">
  27699. Returns a BigInteger whose value is {@code (this >> n)}. Sign
  27700. extension is performed. The shift distance, {@code n}, may be
  27701. negative, in which case this method performs a left shift.
  27702. (Computes <c>floor(this / 2<sup>n</sup>)</c>.)
  27703. @param n shift distance, in bits.
  27704. @return {@code this >> n}
  27705. @throws ArithmeticException if the shift distance is {@code
  27706. Integer.Min_VALUE}.
  27707. @see #shiftLeft
  27708. </member>
  27709. <member name="M:NPOI.Util.BigInteger.Not">
  27710. Returns a BigInteger whose value is {@code (~this)}. (This method
  27711. returns a negative value if and only if this BigInteger is
  27712. non-negative.)
  27713. @return {@code ~this}
  27714. </member>
  27715. <member name="M:NPOI.Util.BigInteger.Or(NPOI.Util.BigInteger)">
  27716. Returns a BigInteger whose value is {@code (this | val)}. (This method
  27717. returns a negative BigInteger if and only if either this or val is
  27718. negative.)
  27719. @param val value to be OR'ed with this BigInteger.
  27720. @return {@code this | val}
  27721. </member>
  27722. <member name="M:NPOI.Util.BigInteger.Multiply(System.Int64)">
  27723. Package private methods used by BigDecimal code to multiply a BigInteger
  27724. with a long. Assumes v is not equal to INFLATED.
  27725. </member>
  27726. <member name="M:NPOI.Util.BigInteger.Multiply(NPOI.Util.BigInteger)">
  27727. Returns a BigInteger whose value is {@code (this * val)}.
  27728. @param val value to be multiplied by this BigInteger.
  27729. @return {@code this * val}
  27730. </member>
  27731. <member name="M:NPOI.Util.BigInteger.Add(NPOI.Util.BigInteger)">
  27732. Returns a BigInteger whose value is {@code (this + val)}.
  27733. @param val value to be added to this BigInteger.
  27734. @return {@code this + val}
  27735. </member>
  27736. <member name="M:NPOI.Util.BigInteger.add(System.Int32[],System.Int32[])">
  27737. Adds the contents of the int arrays x and y. This method allocates
  27738. a new int array to hold the answer and returns a reference to that
  27739. array.
  27740. </member>
  27741. <member name="M:NPOI.Util.BigInteger.Subtract(NPOI.Util.BigInteger)">
  27742. Returns a BigInteger whose value is {@code (this - val)}.
  27743. @param val value to be subtracted from this BigInteger.
  27744. @return {@code this - val}
  27745. </member>
  27746. <member name="M:NPOI.Util.BigInteger.Subtract(System.Int32[],System.Int32[])">
  27747. Subtracts the contents of the second int arrays (little) from the
  27748. first (big). The first int array (big) must represent a larger number
  27749. than the second. This method allocates the space necessary to hold the
  27750. answer.
  27751. </member>
  27752. <member name="M:NPOI.Util.BigInteger.Divide(NPOI.Util.BigInteger)">
  27753. Returns a BigInteger whose value is {@code (this / val)}.
  27754. @param val value by which this BigInteger is to be divided.
  27755. @return {@code this / val}
  27756. @throws ArithmeticException if {@code val} is zero.
  27757. </member>
  27758. <member name="F:NPOI.Util.MutableBigInteger._value">
  27759. Holds the magnitude of this MutableBigInteger in big endian order.
  27760. The magnitude may start at an offset into the value array, and it may
  27761. end before the length of the value array.
  27762. </member>
  27763. <member name="F:NPOI.Util.MutableBigInteger.intLen">
  27764. The number of ints of the value array that are currently used
  27765. to hold the magnitude of this MutableBigInteger. The magnitude starts
  27766. at an offset and offset + intLen may be less than value.Length.
  27767. </member>
  27768. <member name="F:NPOI.Util.MutableBigInteger.offset">
  27769. The offset into the value array where the magnitude of this
  27770. MutableBigInteger begins.
  27771. </member>
  27772. <member name="F:NPOI.Util.MutableBigInteger.One">
  27773. MutableBigInteger with one element value array with the value 1. Used by
  27774. BigDecimal divideAndRound to increment the quotient. Use this constant
  27775. only when the method is not going to modify this object.
  27776. </member>
  27777. <member name="M:NPOI.Util.MutableBigInteger.#ctor">
  27778. The default constructor. An empty MutableBigInteger is created with
  27779. a one word capacity.
  27780. </member>
  27781. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32)">
  27782. Construct a new MutableBigInteger with a magnitude specified by
  27783. the int val.
  27784. </member>
  27785. <member name="M:NPOI.Util.MutableBigInteger.#ctor(System.Int32[])">
  27786. Construct a new MutableBigInteger with the specified value array
  27787. up to the length of the array supplied.
  27788. </member>
  27789. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.BigInteger)">
  27790. Construct a new MutableBigInteger with a magnitude equal to the
  27791. specified BigInteger.
  27792. </member>
  27793. <member name="M:NPOI.Util.MutableBigInteger.#ctor(NPOI.Util.MutableBigInteger)">
  27794. Construct a new MutableBigInteger with a magnitude equal to the
  27795. specified MutableBigInteger.
  27796. </member>
  27797. <member name="M:NPOI.Util.MutableBigInteger.getMagnitudeArray">
  27798. Internal helper method to return the magnitude array. The caller is not
  27799. supposed to modify the returned array.
  27800. </member>
  27801. <member name="M:NPOI.Util.MutableBigInteger.toLong">
  27802. Convert this MutableBigInteger to a long value. The caller has to make
  27803. sure this MutableBigInteger can be fit into long.
  27804. </member>
  27805. <member name="M:NPOI.Util.MutableBigInteger.toBigInteger(System.Int32)">
  27806. Convert this MutableBigInteger to a BigInteger object.
  27807. </member>
  27808. <member name="M:NPOI.Util.MutableBigInteger.clear">
  27809. Clear out a MutableBigInteger for reuse.
  27810. </member>
  27811. <member name="M:NPOI.Util.MutableBigInteger.reset">
  27812. Set a MutableBigInteger to zero, removing its offset.
  27813. </member>
  27814. <member name="M:NPOI.Util.MutableBigInteger.compare(NPOI.Util.MutableBigInteger)">
  27815. Compare the magnitude of two MutableBigIntegers. Returns -1, 0 or 1
  27816. as this MutableBigInteger is numerically less than, equal to, or
  27817. greater than <c>b</c>.
  27818. </member>
  27819. <member name="M:NPOI.Util.MutableBigInteger.compareHalf(NPOI.Util.MutableBigInteger)">
  27820. Compare this against half of a MutableBigInteger object (Needed for
  27821. remainder tests).
  27822. Assumes no leading unnecessary zeros, which holds for results
  27823. from divide().
  27824. </member>
  27825. <member name="M:NPOI.Util.MutableBigInteger.getLowestSetBit">
  27826. Return the index of the lowest set bit in this MutableBigInteger. If the
  27827. magnitude of this MutableBigInteger is zero, -1 is returned.
  27828. </member>
  27829. <member name="M:NPOI.Util.MutableBigInteger.getInt(System.Int32)">
  27830. Return the int in use in this MutableBigInteger at the specified
  27831. index. This method is not used because it is not inlined on all
  27832. platforms.
  27833. </member>
  27834. <member name="M:NPOI.Util.MutableBigInteger.getLong(System.Int32)">
  27835. Return a long which is equal to the unsigned value of the int in
  27836. use in this MutableBigInteger at the specified index. This method is
  27837. not used because it is not inlined on all platforms.
  27838. </member>
  27839. <member name="M:NPOI.Util.MutableBigInteger.normalize">
  27840. Ensure that the MutableBigInteger is in normal form, specifically
  27841. making sure that there are no leading zeros, and that if the
  27842. magnitude is zero, then intLen is zero.
  27843. </member>
  27844. <member name="M:NPOI.Util.MutableBigInteger.ensureCapacity(System.Int32)">
  27845. If this MutableBigInteger cannot hold len words, increase the size
  27846. of the value array to len words.
  27847. </member>
  27848. <member name="M:NPOI.Util.MutableBigInteger.toIntArray">
  27849. Convert this MutableBigInteger into an int array with no leading
  27850. zeros, of a length that is equal to this MutableBigInteger's intLen.
  27851. </member>
  27852. <member name="M:NPOI.Util.MutableBigInteger.setInt(System.Int32,System.Int32)">
  27853. Sets the int at index+offset in this MutableBigInteger to val.
  27854. This does not get inlined on all platforms so it is not used
  27855. as often as originally intended.
  27856. </member>
  27857. <member name="M:NPOI.Util.MutableBigInteger.setValue(System.Int32[],System.Int32)">
  27858. Sets this MutableBigInteger's value array to the specified array.
  27859. The intLen is set to the specified length.
  27860. </member>
  27861. <member name="M:NPOI.Util.MutableBigInteger.copyValue(NPOI.Util.MutableBigInteger)">
  27862. Sets this MutableBigInteger's value array to a copy of the specified
  27863. array. The intLen is set to the length of the new array.
  27864. </member>
  27865. <member name="M:NPOI.Util.MutableBigInteger.copyValue(System.Int32[])">
  27866. Sets this MutableBigInteger's value array to a copy of the specified
  27867. array. The intLen is set to the length of the specified array.
  27868. </member>
  27869. <member name="M:NPOI.Util.MutableBigInteger.isOne">
  27870. Returns true iff this MutableBigInteger has a value of one.
  27871. </member>
  27872. <member name="M:NPOI.Util.MutableBigInteger.isZero">
  27873. Returns true iff this MutableBigInteger has a value of zero.
  27874. </member>
  27875. <member name="M:NPOI.Util.MutableBigInteger.isEven">
  27876. Returns true iff this MutableBigInteger is even.
  27877. </member>
  27878. <member name="M:NPOI.Util.MutableBigInteger.isOdd">
  27879. Returns true iff this MutableBigInteger is odd.
  27880. </member>
  27881. <member name="M:NPOI.Util.MutableBigInteger.isNormal">
  27882. Returns true iff this MutableBigInteger is in normal form. A
  27883. MutableBigInteger is in normal form if it has no leading zeros
  27884. after the offset, and intLen + offset &lt;= value.Length.
  27885. </member>
  27886. <member name="M:NPOI.Util.MutableBigInteger.toString">
  27887. Returns a String representation of this MutableBigInteger in radix 10.
  27888. </member>
  27889. <member name="M:NPOI.Util.MutableBigInteger.rightShift(System.Int32)">
  27890. Right shift this MutableBigInteger n bits. The MutableBigInteger is left
  27891. in normal form.
  27892. </member>
  27893. <member name="M:NPOI.Util.MutableBigInteger.leftShift(System.Int32)">
  27894. Left shift this MutableBigInteger n bits.
  27895. </member>
  27896. <member name="M:NPOI.Util.MutableBigInteger.divadd(System.Int32[],System.Int32[],System.Int32)">
  27897. A primitive used for division. This method adds in one multiple of the
  27898. divisor a back to the dividend result at a specified offset. It is used
  27899. when qhat was estimated too large, and must be adjusted.
  27900. </member>
  27901. <member name="M:NPOI.Util.MutableBigInteger.mulsub(System.Int32[],System.Int32[],System.Int32,System.Int32,System.Int32)">
  27902. This method is used for division. It multiplies an n word input a by one
  27903. word input x, and subtracts the n word product from q. This is needed
  27904. when subtracting qhat*divisor from dividend.
  27905. </member>
  27906. <member name="M:NPOI.Util.MutableBigInteger.primitiveRightShift(System.Int32)">
  27907. Right shift this MutableBigInteger n bits, where n is
  27908. less than 32.
  27909. Assumes that intLen > 0, n > 0 for speed
  27910. </member>
  27911. <member name="M:NPOI.Util.MutableBigInteger.primitiveLeftShift(System.Int32)">
  27912. Left shift this MutableBigInteger n bits, where n is
  27913. less than 32.
  27914. Assumes that intLen > 0, n > 0 for speed
  27915. </member>
  27916. <member name="M:NPOI.Util.MutableBigInteger.add(NPOI.Util.MutableBigInteger)">
  27917. Adds the contents of two MutableBigInteger objects.The result
  27918. is placed within this MutableBigInteger.
  27919. The contents of the addend are not changed.
  27920. </member>
  27921. <member name="M:NPOI.Util.MutableBigInteger.subtract(NPOI.Util.MutableBigInteger)">
  27922. Subtracts the smaller of this and b from the larger and places the
  27923. result into this MutableBigInteger.
  27924. </member>
  27925. <member name="M:NPOI.Util.MutableBigInteger.difference(NPOI.Util.MutableBigInteger)">
  27926. Subtracts the smaller of a and b from the larger and places the result
  27927. into the larger. Returns 1 if the answer is in a, -1 if in b, 0 if no
  27928. operation was performed.
  27929. </member>
  27930. <member name="M:NPOI.Util.MutableBigInteger.multiply(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  27931. Multiply the contents of two MutableBigInteger objects. The result is
  27932. placed into MutableBigInteger z. The contents of y are not changed.
  27933. </member>
  27934. <member name="M:NPOI.Util.MutableBigInteger.mul(System.Int32,NPOI.Util.MutableBigInteger)">
  27935. Multiply the contents of this MutableBigInteger by the word y. The
  27936. result is placed into z.
  27937. </member>
  27938. <member name="M:NPOI.Util.MutableBigInteger.divideOneWord(System.Int32,NPOI.Util.MutableBigInteger)">
  27939. This method is used for division of an n word dividend by a one word
  27940. divisor. The quotient is placed into quotient. The one word divisor is
  27941. specified by divisor.
  27942. @return the remainder of the division is returned.
  27943. </member>
  27944. <member name="M:NPOI.Util.MutableBigInteger.divide(NPOI.Util.MutableBigInteger,NPOI.Util.MutableBigInteger)">
  27945. Calculates the quotient of this div b and places the quotient in the
  27946. provided MutableBigInteger objects and the remainder object is returned.
  27947. Uses Algorithm D in Knuth section 4.3.1.
  27948. Many optimizations to that algorithm have been adapted from the Colin
  27949. Plumb C library.
  27950. It special cases one word divisors for speed. The content of b is not
  27951. changed.
  27952. </member>
  27953. <member name="M:NPOI.Util.MutableBigInteger.divide(System.Int64,NPOI.Util.MutableBigInteger)">
  27954. Internally used to calculate the quotient of this div v and places the
  27955. quotient in the provided MutableBigInteger object and the remainder is
  27956. returned.
  27957. @return the remainder of the division will be returned.
  27958. </member>
  27959. <member name="M:NPOI.Util.MutableBigInteger.divideMagnitude(System.Int32[],NPOI.Util.MutableBigInteger)">
  27960. Divide this MutableBigInteger by the divisor represented by its magnitude
  27961. array. The quotient will be placed into the provided quotient object &amp;
  27962. the remainder object is returned.
  27963. </member>
  27964. <member name="M:NPOI.Util.MutableBigInteger.unsignedLongCompare(System.Int64,System.Int64)">
  27965. Compare two longs as if they were unsigned.
  27966. Returns true iff one is bigger than two.
  27967. </member>
  27968. <member name="M:NPOI.Util.MutableBigInteger.divWord(System.Int32[],System.Int64,System.Int32)">
  27969. This method divides a long quantity by an int to estimate
  27970. qhat for two multi precision numbers. It is used when
  27971. the signed value of n is less than zero.
  27972. </member>
  27973. <member name="M:NPOI.Util.MutableBigInteger.hybridGCD(NPOI.Util.MutableBigInteger)">
  27974. Calculate GCD of this and b. This and b are changed by the computation.
  27975. </member>
  27976. <member name="M:NPOI.Util.MutableBigInteger.binaryGCD(NPOI.Util.MutableBigInteger)">
  27977. Calculate GCD of this and v.
  27978. Assumes that this and v are not zero.
  27979. </member>
  27980. <member name="M:NPOI.Util.MutableBigInteger.binaryGcd(System.Int32,System.Int32)">
  27981. Calculate GCD of a and b interpreted as unsigned integers.
  27982. </member>
  27983. <member name="M:NPOI.Util.MutableBigInteger.mutableModInverse(NPOI.Util.MutableBigInteger)">
  27984. Returns the modInverse of this mod p. This and p are not affected by
  27985. the operation.
  27986. </member>
  27987. <member name="M:NPOI.Util.MutableBigInteger.modInverse(NPOI.Util.MutableBigInteger)">
  27988. Calculate the multiplicative inverse of this mod mod, where mod is odd.
  27989. This and mod are not changed by the calculation.
  27990. This method implements an algorithm due to Richard Schroeppel, that uses
  27991. the same intermediate representation as Montgomery Reduction
  27992. ("Montgomery Form"). The algorithm is described in an unpublished
  27993. manuscript entitled "Fast Modular Reciprocals."
  27994. </member>
  27995. <member name="M:NPOI.Util.MutableBigInteger.euclidModInverse(System.Int32)">
  27996. Uses the extended Euclidean algorithm to compute the modInverse of base
  27997. mod a modulus that is a power of 2. The modulus is 2^k.
  27998. </member>
  27999. <member name="T:NPOI.Util.BitField">
  28000. <summary>
  28001. Manage operations dealing with bit-mapped fields.
  28002. @author Marc Johnson (mjohnson at apache dot org)
  28003. @author Andrew C. Oliver (acoliver at apache dot org)
  28004. </summary>
  28005. </member>
  28006. <member name="M:NPOI.Util.BitField.#ctor(System.Int32)">
  28007. <summary>
  28008. Create a <see cref="T:NPOI.Util.BitField"/> instance
  28009. </summary>
  28010. <param name="mask">
  28011. the mask specifying which bits apply to this
  28012. BitField. Bits that are set in this mask are the
  28013. bits that this BitField operates on
  28014. </param>
  28015. </member>
  28016. <member name="M:NPOI.Util.BitField.#ctor(System.UInt32)">
  28017. <summary>
  28018. Create a <see cref="T:NPOI.Util.BitField"/> instance
  28019. </summary>
  28020. <param name="mask">
  28021. the mask specifying which bits apply to this
  28022. BitField. Bits that are set in this mask are the
  28023. bits that this BitField operates on
  28024. </param>
  28025. </member>
  28026. <member name="M:NPOI.Util.BitField.Clear(System.Int32)">
  28027. <summary>
  28028. Clear the bits.
  28029. </summary>
  28030. <param name="holder">the int data containing the bits we're interested in</param>
  28031. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  28032. </member>
  28033. <member name="M:NPOI.Util.BitField.ClearShort(System.Int16)">
  28034. <summary>
  28035. Clear the bits.
  28036. </summary>
  28037. <param name="holder">the short data containing the bits we're interested in</param>
  28038. <returns>the value of holder with the specified bits cleared (set to 0)</returns>
  28039. </member>
  28040. <member name="M:NPOI.Util.BitField.GetRawValue(System.Int32)">
  28041. <summary>
  28042. Obtain the value for the specified BitField, appropriately
  28043. shifted right. Many users of a BitField will want to treat the
  28044. specified bits as an int value, and will not want to be aware
  28045. that the value is stored as a BitField (and so shifted left so
  28046. many bits)
  28047. </summary>
  28048. <param name="holder">the int data containing the bits we're interested in</param>
  28049. <returns>the selected bits, shifted right appropriately</returns>
  28050. </member>
  28051. <member name="M:NPOI.Util.BitField.GetShortRawValue(System.Int16)">
  28052. <summary>
  28053. Obtain the value for the specified BitField, unshifted
  28054. </summary>
  28055. <param name="holder">the short data containing the bits we're interested in</param>
  28056. <returns>the selected bits</returns>
  28057. </member>
  28058. <member name="M:NPOI.Util.BitField.GetShortValue(System.Int16)">
  28059. <summary>
  28060. Obtain the value for the specified BitField, appropriately
  28061. shifted right, as a short. Many users of a BitField will want
  28062. to treat the specified bits as an int value, and will not want
  28063. to be aware that the value is stored as a BitField (and so
  28064. shifted left so many bits)
  28065. </summary>
  28066. <param name="holder">the short data containing the bits we're interested in</param>
  28067. <returns>the selected bits, shifted right appropriately</returns>
  28068. </member>
  28069. <member name="M:NPOI.Util.BitField.GetValue(System.Int32)">
  28070. <summary>
  28071. Obtain the value for the specified BitField, appropriately
  28072. shifted right. Many users of a BitField will want to treat the
  28073. specified bits as an int value, and will not want to be aware
  28074. that the value is stored as a BitField (and so shifted left so
  28075. many bits)
  28076. </summary>
  28077. <param name="holder">the int data containing the bits we're interested in</param>
  28078. <returns>the selected bits, shifted right appropriately</returns>
  28079. </member>
  28080. <member name="M:NPOI.Util.BitField.IsAllSet(System.Int32)">
  28081. <summary>
  28082. Are all of the bits set or not? This is a stricter test than
  28083. isSet, in that all of the bits in a multi-bit set must be set
  28084. for this method to return true
  28085. </summary>
  28086. <param name="holder">the int data containing the bits we're interested in</param>
  28087. <returns>
  28088. <c>true</c> if all of the bits are set otherwise, <c>false</c>.
  28089. </returns>
  28090. </member>
  28091. <member name="M:NPOI.Util.BitField.IsSet(System.Int32)">
  28092. <summary>
  28093. is the field set or not? This is most commonly used for a
  28094. single-bit field, which is often used to represent a boolean
  28095. value; the results of using it for a multi-bit field is to
  28096. determine whether *any* of its bits are set
  28097. </summary>
  28098. <param name="holder">the int data containing the bits we're interested in</param>
  28099. <returns>
  28100. <c>true</c> if any of the bits are set; otherwise, <c>false</c>.
  28101. </returns>
  28102. </member>
  28103. <member name="M:NPOI.Util.BitField.Set(System.Int32)">
  28104. <summary>
  28105. Set the bits.
  28106. </summary>
  28107. <param name="holder">the int data containing the bits we're interested in</param>
  28108. <returns>the value of holder with the specified bits set to 1</returns>
  28109. </member>
  28110. <member name="M:NPOI.Util.BitField.SetBoolean(System.Int32,System.Boolean)">
  28111. <summary>
  28112. Set a boolean BitField
  28113. </summary>
  28114. <param name="holder">the int data containing the bits we're interested in</param>
  28115. <param name="flag">indicating whether to set or clear the bits</param>
  28116. <returns>the value of holder with the specified bits set or cleared</returns>
  28117. </member>
  28118. <member name="M:NPOI.Util.BitField.SetShort(System.Int16)">
  28119. <summary>
  28120. Set the bits.
  28121. </summary>
  28122. <param name="holder">the short data containing the bits we're interested in</param>
  28123. <returns>the value of holder with the specified bits set to 1</returns>
  28124. </member>
  28125. <member name="M:NPOI.Util.BitField.SetShortBoolean(System.Int16,System.Boolean)">
  28126. <summary>
  28127. Set a boolean BitField
  28128. </summary>
  28129. <param name="holder">the short data containing the bits we're interested in</param>
  28130. <param name="flag">indicating whether to set or clear the bits</param>
  28131. <returns>the value of holder with the specified bits set or cleared</returns>
  28132. </member>
  28133. <member name="M:NPOI.Util.BitField.SetShortValue(System.Int16,System.Int16)">
  28134. <summary>
  28135. Obtain the value for the specified BitField, appropriately
  28136. shifted right, as a short. Many users of a BitField will want
  28137. to treat the specified bits as an int value, and will not want
  28138. to be aware that the value is stored as a BitField (and so
  28139. shifted left so many bits)
  28140. </summary>
  28141. <param name="holder">the short data containing the bits we're interested in</param>
  28142. <param name="value">the new value for the specified bits</param>
  28143. <returns>the selected bits, shifted right appropriately</returns>
  28144. </member>
  28145. <member name="M:NPOI.Util.BitField.SetValue(System.Int32,System.Int32)">
  28146. <summary>
  28147. Sets the value.
  28148. </summary>
  28149. <param name="holder">the byte data containing the bits we're interested in</param>
  28150. <param name="value">The value.</param>
  28151. <returns></returns>
  28152. </member>
  28153. <member name="M:NPOI.Util.BitField.SetByteBoolean(System.Byte,System.Boolean)">
  28154. <summary>
  28155. Set a boolean BitField
  28156. </summary>
  28157. <param name="holder"> the byte data containing the bits we're interested in</param>
  28158. <param name="flag">indicating whether to set or clear the bits</param>
  28159. <returns>the value of holder with the specified bits set or cleared</returns>
  28160. </member>
  28161. <member name="M:NPOI.Util.BitField.ClearByte(System.Byte)">
  28162. <summary>
  28163. Clears the bits.
  28164. </summary>
  28165. <param name="holder">the byte data containing the bits we're interested in</param>
  28166. <returns>the value of holder with the specified bits cleared</returns>
  28167. </member>
  28168. <member name="M:NPOI.Util.BitField.SetByte(System.Byte)">
  28169. <summary>
  28170. Set the bits.
  28171. </summary>
  28172. <param name="holder">the byte data containing the bits we're interested in</param>
  28173. <returns>the value of holder with the specified bits set to 1</returns>
  28174. </member>
  28175. <member name="T:NPOI.Util.BitFieldFactory">
  28176. <summary>
  28177. Returns immutable Btfield instances.
  28178. @author Jason Height (jheight at apache dot org)
  28179. </summary>
  28180. </member>
  28181. <member name="M:NPOI.Util.BitFieldFactory.GetInstance(System.Int32)">
  28182. <summary>
  28183. Gets the instance.
  28184. </summary>
  28185. <param name="mask">The mask.</param>
  28186. <returns></returns>
  28187. </member>
  28188. <member name="T:NPOI.Util.BlockingInputStream">
  28189. Implementation of a BlockingInputStream to provide data to
  28190. RawDataBlock that expects data in 512 byte chunks. Useful to read
  28191. data from slow (ie, non FileInputStream) sources, for example when
  28192. Reading an OLE2 Document over a network.
  28193. Possible extentions: add a timeout. Curently a call to Read(byte[]) on this
  28194. class is blocking, so use at your own peril if your underlying stream blocks.
  28195. @author Jens Gerhard
  28196. @author aviks - documentation cleanups.
  28197. </member>
  28198. <member name="M:NPOI.Util.BlockingInputStream.Read(System.Byte[])">
  28199. We had to revert to byte per byte Reading to keep
  28200. with slow network connections on one hand, without
  28201. missing the end-of-file.
  28202. This is the only method that does its own thing in this class
  28203. everything else is delegated to aggregated stream.
  28204. THIS IS A BLOCKING BLOCK READ!!!
  28205. </member>
  28206. <member name="M:NPOI.Util.ByteBuffer.Remaining">
  28207. <summary>
  28208. Returns the number of elements between the current position and the limit.
  28209. </summary>
  28210. <returns>The number of elements remaining in this buffer</returns>
  28211. </member>
  28212. <member name="M:NPOI.Util.ByteBuffer.HasRemaining">
  28213. <summary>
  28214. Tells whether there are any elements between the current position and the limit.
  28215. </summary>
  28216. <returns>true if, and only if, there is at least one element remaining in this buffer</returns>
  28217. </member>
  28218. <member name="T:NPOI.Util.ByteField">
  28219. <summary>
  28220. representation of a byte (8-bit) field at a fixed location within a
  28221. byte array
  28222. @author Marc Johnson (mjohnson at apache dot org
  28223. </summary>
  28224. </member>
  28225. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32)">
  28226. <summary>
  28227. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28228. </summary>
  28229. <param name="offset">The offset.</param>
  28230. </member>
  28231. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte)">
  28232. <summary>
  28233. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28234. </summary>
  28235. <param name="offset">The offset.</param>
  28236. <param name="value">The value.</param>
  28237. </member>
  28238. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte[])">
  28239. <summary>
  28240. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28241. </summary>
  28242. <param name="offset">The offset.</param>
  28243. <param name="data">The data.</param>
  28244. </member>
  28245. <member name="M:NPOI.Util.ByteField.#ctor(System.Int32,System.Byte,System.Byte[])">
  28246. <summary>
  28247. Initializes a new instance of the <see cref="T:NPOI.Util.ByteField"/> class.
  28248. </summary>
  28249. <param name="offset">The offset.</param>
  28250. <param name="_value">The _value.</param>
  28251. <param name="data">The data.</param>
  28252. </member>
  28253. <member name="P:NPOI.Util.ByteField.Value">
  28254. <summary>
  28255. Gets or sets the value.
  28256. </summary>
  28257. <value>The value.</value>
  28258. </member>
  28259. <member name="M:NPOI.Util.ByteField.ReadFromBytes(System.Byte[])">
  28260. <summary>
  28261. set the value from its offset into an array of bytes
  28262. </summary>
  28263. <param name="data">the byte array from which the value is to be read</param>
  28264. </member>
  28265. <member name="M:NPOI.Util.ByteField.ReadFromStream(System.IO.Stream)">
  28266. <summary>
  28267. set the value from an Stream
  28268. </summary>
  28269. <param name="stream">the Stream from which the value is to be read</param>
  28270. </member>
  28271. <member name="M:NPOI.Util.ByteField.Set(System.Byte,System.Byte[])">
  28272. <summary>
  28273. set the ByteField's current value and write it to a byte array
  28274. </summary>
  28275. <param name="value">value to be set</param>
  28276. <param name="data">the byte array to write the value to</param>
  28277. </member>
  28278. <member name="M:NPOI.Util.ByteField.ToString">
  28279. <summary>
  28280. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28281. </summary>
  28282. <returns>
  28283. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  28284. </returns>
  28285. </member>
  28286. <member name="M:NPOI.Util.ByteField.WriteToBytes(System.Byte[])">
  28287. <summary>
  28288. write the value out to an array of bytes at the appropriate offset
  28289. </summary>
  28290. <param name="data">the array of bytes to which the value is to be written</param>
  28291. </member>
  28292. <member name="T:NPOI.Util.ClassID">
  28293. <summary>
  28294. Represents a class ID (16 bytes). Unlike other little-endian
  28295. type the {@link ClassID} is not just 16 bytes stored in the wrong
  28296. order. Instead, it is a double word (4 bytes) followed by two
  28297. words (2 bytes each) followed by 8 bytes.
  28298. @author Rainer Klute
  28299. <a href="mailto:klute@rainer-klute.de">klute@rainer-klute.de</a>
  28300. @version $Id: ClassID.java 489730 2006-12-22 19:18:16Z bayard $
  28301. @since 2002-02-09
  28302. </summary>
  28303. </member>
  28304. <member name="F:NPOI.Util.ClassID.bytes">
  28305. The bytes making out the class ID in correct order,
  28306. i.e. big-endian.
  28307. </member>
  28308. <member name="M:NPOI.Util.ClassID.#ctor(System.Byte[],System.Int32)">
  28309. <summary>
  28310. Creates a <see cref="T:NPOI.Util.ClassID"/> and Reads its value from a byte array.
  28311. </summary>
  28312. <param name="src">The byte array to Read from.</param>
  28313. <param name="offset">The offset of the first byte to Read.</param>
  28314. </member>
  28315. <member name="M:NPOI.Util.ClassID.#ctor">
  28316. <summary>
  28317. Creates a <see cref="T:NPOI.Util.ClassID"/> and initializes its value with 0x00 bytes.
  28318. </summary>
  28319. </member>
  28320. <member name="M:NPOI.Util.ClassID.#ctor(System.String)">
  28321. <p>Creates a {@link ClassID} from a human-readable representation of the Class ID in standard
  28322. format <code>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</code>.</p>
  28323. @param externalForm representation of the Class ID represented by this object.
  28324. </member>
  28325. <member name="F:NPOI.Util.ClassID.LENGTH">
  28326. The number of bytes occupied by this object in the byte
  28327. stream.
  28328. </member>
  28329. <member name="P:NPOI.Util.ClassID.Length">
  28330. <summary>
  28331. Gets the length.
  28332. </summary>
  28333. <value>The number of bytes occupied by this object in the byte stream.</value>
  28334. </member>
  28335. <member name="P:NPOI.Util.ClassID.Bytes">
  28336. <summary>
  28337. Gets or sets the bytes making out the class ID. They are returned in correct order, i.e. big-endian.
  28338. </summary>
  28339. <value>the bytes making out the class ID..</value>
  28340. </member>
  28341. <member name="M:NPOI.Util.ClassID.Read(System.Byte[],System.Int32)">
  28342. <summary>
  28343. Reads the class ID's value from a byte array by turning little-endian into big-endian.
  28344. </summary>
  28345. <param name="src">The byte array to Read from</param>
  28346. <param name="offset">The offset within the </param>
  28347. <returns>A byte array containing the class ID.</returns>
  28348. </member>
  28349. <member name="M:NPOI.Util.ClassID.Write(System.Byte[],System.Int32)">
  28350. <summary>
  28351. Writes the class ID to a byte array in the little-endian format.
  28352. </summary>
  28353. <param name="dst">The byte array to Write to.</param>
  28354. <param name="offset">The offset within the </param>
  28355. </member>
  28356. <member name="M:NPOI.Util.ClassID.Equals(System.Object)">
  28357. <summary>
  28358. Checks whether this ClassID is equal to another
  28359. object.
  28360. </summary>
  28361. <param name="o">the object to compare this PropertySet with</param>
  28362. <returns>true if the objects are equal, else
  28363. false</returns>
  28364. </member>
  28365. <member name="M:NPOI.Util.ClassID.GetHashCode">
  28366. <summary>
  28367. Serves as a hash function for a particular type.
  28368. </summary>
  28369. <returns>
  28370. A hash code for the current <see cref="T:System.Object"/>.
  28371. </returns>
  28372. </member>
  28373. <member name="M:NPOI.Util.ClassID.ToString">
  28374. <summary>
  28375. Returns a human-Readable representation of the Class ID in standard
  28376. format <c>"{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}"</c>.
  28377. </summary>
  28378. <returns>
  28379. A String representation of the Class ID represented by this object..
  28380. </returns>
  28381. </member>
  28382. <member name="T:NPOI.Util.CodePageUtil">
  28383. Utilities for working with Microsoft CodePages.
  28384. <p>Provides constants for understanding numeric codepages,
  28385. along with utilities to translate these into Java Character Sets.</p>
  28386. </member>
  28387. <member name="F:NPOI.Util.CodePageUtil.CP_037">
  28388. <p>Codepage 037, a special case</p>
  28389. </member>
  28390. <member name="F:NPOI.Util.CodePageUtil.CP_SJIS">
  28391. <p>Codepage for SJIS</p>
  28392. </member>
  28393. <member name="F:NPOI.Util.CodePageUtil.CP_GBK">
  28394. <p>Codepage for GBK, aka MS936</p>
  28395. </member>
  28396. <member name="F:NPOI.Util.CodePageUtil.CP_MS949">
  28397. <p>Codepage for MS949</p>
  28398. </member>
  28399. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16">
  28400. <p>Codepage for UTF-16</p>
  28401. </member>
  28402. <member name="F:NPOI.Util.CodePageUtil.CP_UTF16_BE">
  28403. <p>Codepage for UTF-16 big-endian</p>
  28404. </member>
  28405. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1250">
  28406. <p>Codepage for Windows 1250</p>
  28407. </member>
  28408. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1251">
  28409. <p>Codepage for Windows 1251</p>
  28410. </member>
  28411. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1252">
  28412. <p>Codepage for Windows 1252</p>
  28413. </member>
  28414. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1253">
  28415. <p>Codepage for Windows 1253</p>
  28416. </member>
  28417. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1254">
  28418. <p>Codepage for Windows 1254</p>
  28419. </member>
  28420. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1255">
  28421. <p>Codepage for Windows 1255</p>
  28422. </member>
  28423. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1256">
  28424. <p>Codepage for Windows 1256</p>
  28425. </member>
  28426. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1257">
  28427. <p>Codepage for Windows 1257</p>
  28428. </member>
  28429. <member name="F:NPOI.Util.CodePageUtil.CP_WINDOWS_1258">
  28430. <p>Codepage for Windows 1258</p>
  28431. </member>
  28432. <member name="F:NPOI.Util.CodePageUtil.CP_JOHAB">
  28433. <p>Codepage for Johab</p>
  28434. </member>
  28435. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMAN">
  28436. <p>Codepage for Macintosh Roman (Java: MacRoman)</p>
  28437. </member>
  28438. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_JAPAN">
  28439. <p>Codepage for Macintosh Japan (Java: unknown - use SJIS, cp942 or
  28440. cp943)</p>
  28441. </member>
  28442. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_TRADITIONAL">
  28443. <p>Codepage for Macintosh Chinese Traditional (Java: unknown - use Big5,
  28444. MS950, or cp937)</p>
  28445. </member>
  28446. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_KOREAN">
  28447. <p>Codepage for Macintosh Korean (Java: unknown - use EUC_KR or
  28448. cp949)</p>
  28449. </member>
  28450. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ARABIC">
  28451. <p>Codepage for Macintosh Arabic (Java: MacArabic)</p>
  28452. </member>
  28453. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_HEBREW">
  28454. <p>Codepage for Macintosh Hebrew (Java: MacHebrew)</p>
  28455. </member>
  28456. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_GREEK">
  28457. <p>Codepage for Macintosh Greek (Java: MacGreek)</p>
  28458. </member>
  28459. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CYRILLIC">
  28460. <p>Codepage for Macintosh Cyrillic (Java: MacCyrillic)</p>
  28461. </member>
  28462. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CHINESE_SIMPLE">
  28463. <p>Codepage for Macintosh Chinese Simplified (Java: unknown - use
  28464. EUC_CN, ISO2022_CN_GB, MS936 or cp935)</p>
  28465. </member>
  28466. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ROMANIA">
  28467. <p>Codepage for Macintosh Romanian (Java: MacRomania)</p>
  28468. </member>
  28469. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_UKRAINE">
  28470. <p>Codepage for Macintosh Ukrainian (Java: MacUkraine)</p>
  28471. </member>
  28472. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_THAI">
  28473. <p>Codepage for Macintosh Thai (Java: MacThai)</p>
  28474. </member>
  28475. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CENTRAL_EUROPE">
  28476. <p>Codepage for Macintosh Central Europe (Latin-2)
  28477. (Java: MacCentralEurope)</p>
  28478. </member>
  28479. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_ICELAND">
  28480. <p>Codepage for Macintosh Iceland (Java: MacIceland)</p>
  28481. </member>
  28482. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_TURKISH">
  28483. <p>Codepage for Macintosh Turkish (Java: MacTurkish)</p>
  28484. </member>
  28485. <member name="F:NPOI.Util.CodePageUtil.CP_MAC_CROATIAN">
  28486. <p>Codepage for Macintosh Croatian (Java: MacCroatian)</p>
  28487. </member>
  28488. <member name="F:NPOI.Util.CodePageUtil.CP_US_ACSII">
  28489. <p>Codepage for US-ASCII</p>
  28490. </member>
  28491. <member name="F:NPOI.Util.CodePageUtil.CP_KOI8_R">
  28492. <p>Codepage for KOI8-R</p>
  28493. </member>
  28494. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_1">
  28495. <p>Codepage for ISO-8859-1</p>
  28496. </member>
  28497. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_2">
  28498. <p>Codepage for ISO-8859-2</p>
  28499. </member>
  28500. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_3">
  28501. <p>Codepage for ISO-8859-3</p>
  28502. </member>
  28503. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_4">
  28504. <p>Codepage for ISO-8859-4</p>
  28505. </member>
  28506. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_5">
  28507. <p>Codepage for ISO-8859-5</p>
  28508. </member>
  28509. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_6">
  28510. <p>Codepage for ISO-8859-6</p>
  28511. </member>
  28512. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_7">
  28513. <p>Codepage for ISO-8859-7</p>
  28514. </member>
  28515. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_8">
  28516. <p>Codepage for ISO-8859-8</p>
  28517. </member>
  28518. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_8859_9">
  28519. <p>Codepage for ISO-8859-9</p>
  28520. </member>
  28521. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP1">
  28522. <p>Codepage for ISO-2022-JP</p>
  28523. </member>
  28524. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP2">
  28525. <p>Another codepage for ISO-2022-JP</p>
  28526. </member>
  28527. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_JP3">
  28528. <p>Yet another codepage for ISO-2022-JP</p>
  28529. </member>
  28530. <member name="F:NPOI.Util.CodePageUtil.CP_ISO_2022_KR">
  28531. <p>Codepage for ISO-2022-KR</p>
  28532. </member>
  28533. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_JP">
  28534. <p>Codepage for EUC-JP</p>
  28535. </member>
  28536. <member name="F:NPOI.Util.CodePageUtil.CP_EUC_KR">
  28537. <p>Codepage for EUC-KR</p>
  28538. </member>
  28539. <member name="F:NPOI.Util.CodePageUtil.CP_GB2312">
  28540. <p>Codepage for GB2312</p>
  28541. </member>
  28542. <member name="F:NPOI.Util.CodePageUtil.CP_GB18030">
  28543. <p>Codepage for GB18030</p>
  28544. </member>
  28545. <member name="F:NPOI.Util.CodePageUtil.CP_US_ASCII2">
  28546. <p>Another codepage for US-ASCII</p>
  28547. </member>
  28548. <member name="F:NPOI.Util.CodePageUtil.CP_UTF8">
  28549. <p>Codepage for UTF-8</p>
  28550. </member>
  28551. <member name="F:NPOI.Util.CodePageUtil.CP_UNICODE">
  28552. <p>Codepage for Unicode</p>
  28553. </member>
  28554. <member name="M:NPOI.Util.CodePageUtil.GetBytesInCodePage(System.String,System.Int32)">
  28555. Converts a string into bytes, in the equivalent character encoding
  28556. to the supplied codepage number.
  28557. @param string The string to convert
  28558. @param codepage The codepage number
  28559. </member>
  28560. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32)">
  28561. Converts the bytes into a String, based on the equivalent character encoding
  28562. to the supplied codepage number.
  28563. @param string The byte of the string to convert
  28564. @param codepage The codepage number
  28565. </member>
  28566. <member name="M:NPOI.Util.CodePageUtil.GetStringFromCodePage(System.Byte[],System.Int32,System.Int32,System.Int32)">
  28567. Converts the bytes into a String, based on the equivalent character encoding
  28568. to the supplied codepage number.
  28569. @param string The byte of the string to convert
  28570. @param codepage The codepage number
  28571. </member>
  28572. <member name="M:NPOI.Util.CodePageUtil.CodepageToEncoding(System.Int32)">
  28573. <p>Turns a codepage number into the equivalent character encoding's
  28574. name.</p>
  28575. @param codepage The codepage number
  28576. @return The character encoding's name. If the codepage number is 65001,
  28577. the encoding name is "UTF-8". All other positive numbers are mapped to
  28578. "cp" followed by the number, e.g. if the codepage number is 1252 the
  28579. returned character encoding name will be "cp1252".
  28580. @exception UnsupportedEncodingException if the specified codepage is
  28581. less than zero.
  28582. </member>
  28583. <member name="T:NPOI.Util.Collections.HashSet`1">
  28584. <summary>
  28585. This class comes from Java
  28586. </summary>
  28587. </member>
  28588. <member name="M:NPOI.Util.Collections.HashSet`1.#ctor">
  28589. <summary>
  28590. Initializes a new instance of the class.
  28591. </summary>
  28592. </member>
  28593. <member name="M:NPOI.Util.Collections.HashSet`1.Add(`0)">
  28594. <summary>
  28595. Adds the specified o.
  28596. </summary>
  28597. <param name="o">The o.</param>
  28598. </member>
  28599. <member name="M:NPOI.Util.Collections.HashSet`1.Contains(`0)">
  28600. <summary>
  28601. Determines whether [contains] [the specified o].
  28602. </summary>
  28603. <param name="o">The o.</param>
  28604. <returns>
  28605. <c>true</c> if [contains] [the specified o]; otherwise, <c>false</c>.
  28606. </returns>
  28607. </member>
  28608. <member name="M:NPOI.Util.Collections.HashSet`1.CopyTo(`0[],System.Int32)">
  28609. <summary>
  28610. 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.
  28611. </summary>
  28612. <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>
  28613. <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
  28614. <exception cref="T:System.ArgumentNullException">
  28615. <paramref name="array"/> is null.
  28616. </exception>
  28617. <exception cref="T:System.ArgumentOutOfRangeException">
  28618. <paramref name="index"/> is less than zero.
  28619. </exception>
  28620. <exception cref="T:System.ArgumentException">
  28621. <paramref name="array"/> is multidimensional.
  28622. -or-
  28623. <paramref name="index"/> is equal to or greater than the length of <paramref name="array"/>.
  28624. -or-
  28625. 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"/>.
  28626. </exception>
  28627. <exception cref="T:System.ArgumentException">
  28628. The type of the source <see cref="T:System.Collections.ICollection"/> cannot be cast automatically to the type of the destination <paramref name="array"/>.
  28629. </exception>
  28630. </member>
  28631. <member name="P:NPOI.Util.Collections.HashSet`1.Count">
  28632. <summary>
  28633. Gets the number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  28634. </summary>
  28635. <value></value>
  28636. <returns>
  28637. The number of elements contained in the <see cref="T:System.Collections.ICollection"/>.
  28638. </returns>
  28639. </member>
  28640. <member name="M:NPOI.Util.Collections.HashSet`1.GetEnumerator">
  28641. <summary>
  28642. Returns an enumerator that iterates through a collection.
  28643. </summary>
  28644. <returns>
  28645. An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
  28646. </returns>
  28647. </member>
  28648. <member name="M:NPOI.Util.Collections.HashSet`1.Remove(`0)">
  28649. <summary>
  28650. Removes the specified o.
  28651. </summary>
  28652. <param name="o">The o.</param>
  28653. </member>
  28654. <member name="M:NPOI.Util.Collections.HashSet`1.Clear">
  28655. <summary>
  28656. Removes all of the elements from this set.
  28657. The set will be empty after this call returns.
  28658. </summary>
  28659. </member>
  28660. <member name="T:NPOI.Util.Collections.Properties">
  28661. <summary>
  28662. This class comes from Java
  28663. </summary>
  28664. </member>
  28665. <member name="M:NPOI.Util.Collections.Properties.#ctor">
  28666. <summary>
  28667. Initializes a new instance of the <see cref="T:NPOI.Util.Collections.Properties"/> class.
  28668. </summary>
  28669. </member>
  28670. <member name="M:NPOI.Util.Collections.Properties.Remove(System.String)">
  28671. <summary>
  28672. Removes the specified key.
  28673. </summary>
  28674. <param name="key">The key.</param>
  28675. <returns></returns>
  28676. </member>
  28677. <member name="M:NPOI.Util.Collections.Properties.GetEnumerator">
  28678. <summary>
  28679. Gets the enumerator.
  28680. </summary>
  28681. <returns></returns>
  28682. </member>
  28683. <member name="M:NPOI.Util.Collections.Properties.ContainsKey(System.String)">
  28684. <summary>
  28685. Determines whether the specified key contains key.
  28686. </summary>
  28687. <param name="key">The key.</param>
  28688. <returns>
  28689. <c>true</c> if the specified key contains key; otherwise, <c>false</c>.
  28690. </returns>
  28691. </member>
  28692. <member name="M:NPOI.Util.Collections.Properties.Add(System.String,System.String)">
  28693. <summary>
  28694. Adds the specified key.
  28695. </summary>
  28696. <param name="key">The key.</param>
  28697. <param name="value">The value.</param>
  28698. </member>
  28699. <member name="P:NPOI.Util.Collections.Properties.Count">
  28700. <summary>
  28701. Gets the count.
  28702. </summary>
  28703. <value>The count.</value>
  28704. </member>
  28705. <member name="P:NPOI.Util.Collections.Properties.Item(System.String)">
  28706. <summary>
  28707. Gets or sets the <see cref="T:System.String"/> with the specified key.
  28708. </summary>
  28709. <value></value>
  28710. </member>
  28711. <member name="P:NPOI.Util.Collections.Properties.Keys">
  28712. <summary>
  28713. Gets the keys.
  28714. </summary>
  28715. <value>The keys.</value>
  28716. </member>
  28717. <member name="M:NPOI.Util.Collections.Properties.Clear">
  28718. <summary>
  28719. Clears this instance.
  28720. </summary>
  28721. </member>
  28722. <member name="M:NPOI.Util.Collections.Properties.Load(System.IO.Stream)">
  28723. <summary>
  28724. Loads the specified in stream.
  28725. </summary>
  28726. <param name="inStream">The in stream.</param>
  28727. </member>
  28728. <member name="M:NPOI.Util.Collections.Properties.LoadConvert(System.String)">
  28729. <summary>
  28730. Loads the convert.
  28731. </summary>
  28732. <param name="theString">The string.</param>
  28733. <returns></returns>
  28734. <remarks>
  28735. Converts encoded &#92;uxxxx to unicode chars
  28736. and changes special saved chars to their original forms
  28737. </remarks>
  28738. </member>
  28739. <member name="M:NPOI.Util.Collections.Properties.ContinueLine(System.String)">
  28740. <summary>
  28741. Continues the line.
  28742. </summary>
  28743. <param name="line">The line.</param>
  28744. <returns></returns>
  28745. </member>
  28746. <member name="T:NPOI.Util.CRC32">
  28747. <summary>
  28748. CRC Verification
  28749. </summary>
  28750. </member>
  28751. <member name="M:NPOI.Util.CRC32.#ctor">
  28752. <summary>
  28753. Initializes a new instance of the <see cref="T:NPOI.Util.CRC32"/> class.
  28754. </summary>
  28755. </member>
  28756. <member name="M:NPOI.Util.CRC32.ByteCRC(System.Byte[]@)">
  28757. <summary>
  28758. CRC Bytes.
  28759. </summary>
  28760. <param name="buffer">The buffer.</param>
  28761. <returns></returns>
  28762. </member>
  28763. <member name="M:NPOI.Util.CRC32.StringCRC(System.String)">
  28764. <summary>
  28765. String CRC
  28766. </summary>
  28767. <param name="sInputString">the string</param>
  28768. <returns></returns>
  28769. </member>
  28770. <member name="M:NPOI.Util.CRC32.FileCRC(System.String)">
  28771. <summary>
  28772. File CRC
  28773. </summary>
  28774. <param name="sInputFilename">the input file</param>
  28775. <returns></returns>
  28776. </member>
  28777. <member name="M:NPOI.Util.CRC32.StreamCRC(System.IO.Stream)">
  28778. <summary>
  28779. Stream CRC
  28780. </summary>
  28781. <param name="inFile">the input stream</param>
  28782. <returns></returns>
  28783. </member>
  28784. <member name="T:NPOI.Util.IDelayableLittleEndianOutput">
  28785. <summary>
  28786. Implementors of this interface allow client code to 'delay' writing to a certain section of a
  28787. data output stream.<br/>
  28788. A typical application is for writing BIFF records when the size is not known until well after
  28789. the header has been written. The client code can call <see cref="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput"/>
  28790. to reserve two bytes of the output for the 'ushort size' header field. The delayed output can
  28791. be written at any stage.
  28792. </summary>
  28793. <remarks>@author Josh Micich</remarks>
  28794. </member>
  28795. <member name="M:NPOI.Util.IDelayableLittleEndianOutput.CreateDelayedOutput(System.Int32)">
  28796. <summary>
  28797. Creates an output stream intended for outputting a sequence of <c>size</c> bytes.
  28798. </summary>
  28799. <param name="size"></param>
  28800. <returns></returns>
  28801. </member>
  28802. <member name="T:NPOI.Util.FixedField">
  28803. <summary>
  28804. behavior of a field at a fixed location within a byte array
  28805. @author Marc Johnson (mjohnson at apache dot org
  28806. </summary>
  28807. </member>
  28808. <member name="M:NPOI.Util.FixedField.ReadFromBytes(System.Byte[])">
  28809. <summary>
  28810. set the value from its offset into an array of bytes
  28811. </summary>
  28812. <param name="data">the byte array from which the value is to be read</param>
  28813. </member>
  28814. <member name="M:NPOI.Util.FixedField.ReadFromStream(System.IO.Stream)">
  28815. <summary>
  28816. set the value from an Stream
  28817. </summary>
  28818. <param name="stream">the Stream from which the value is to be read</param>
  28819. </member>
  28820. <member name="M:NPOI.Util.FixedField.ToString">
  28821. <summary>
  28822. return the value as a String
  28823. </summary>
  28824. <returns></returns>
  28825. </member>
  28826. <member name="M:NPOI.Util.FixedField.WriteToBytes(System.Byte[])">
  28827. <summary>
  28828. write the value out to an array of bytes at the appropriate offset
  28829. </summary>
  28830. <param name="data">the array of bytes to which the value is to be written</param>
  28831. </member>
  28832. <member name="T:NPOI.Util.HexDump">
  28833. <summary>
  28834. dump data in hexadecimal format; derived from a HexDump utility I
  28835. wrote in June 2001.
  28836. @author Marc Johnson
  28837. @author Glen Stampoultzis (glens at apache.org)
  28838. </summary>
  28839. </member>
  28840. <member name="M:NPOI.Util.HexDump.Dump(System.IO.Stream,System.IO.Stream,System.Int32,System.Int32)">
  28841. Dumps <code>bytesToDump</code> bytes to an output stream.
  28842. @param in The stream to read from
  28843. @param out The output stream
  28844. @param start The index to use as the starting position for the left hand side label
  28845. @param bytesToDump The number of bytes to output. Use -1 to read until the end of file.
  28846. </member>
  28847. <member name="M:NPOI.Util.HexDump.ShortToHex(System.Int32)">
  28848. <summary>
  28849. Shorts to hex.
  28850. </summary>
  28851. <param name="value">The value.</param>
  28852. <returns>char array of 2 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28853. </member>
  28854. <member name="M:NPOI.Util.HexDump.ByteToHex(System.Int32)">
  28855. <summary>
  28856. Bytes to hex.
  28857. </summary>
  28858. <param name="value">The value.</param>
  28859. <returns>char array of 1 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28860. </member>
  28861. <member name="M:NPOI.Util.HexDump.IntToHex(System.Int32)">
  28862. <summary>
  28863. Ints to hex.
  28864. </summary>
  28865. <param name="value">The value.</param>
  28866. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28867. </member>
  28868. <member name="M:NPOI.Util.HexDump.LongToHex(System.Int64)">
  28869. <summary>
  28870. char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'
  28871. </summary>
  28872. <param name="value">The value.</param>
  28873. <returns>char array of 4 (zero padded) uppercase hex chars and prefixed with '0x'</returns>
  28874. </member>
  28875. <member name="M:NPOI.Util.HexDump.ToHexChars(System.Int64,System.Int32)">
  28876. <summary>
  28877. Toes the hex chars.
  28878. </summary>
  28879. <param name="pValue">The p value.</param>
  28880. <param name="nBytes">The n bytes.</param>
  28881. <returns>char array of uppercase hex chars, zero padded and prefixed with '0x'</returns>
  28882. </member>
  28883. <member name="M:NPOI.Util.HexRead.ReadData(System.String)">
  28884. <summary>
  28885. This method reads hex data from a filename and returns a byte array.
  28886. The file may contain line comments that are preceeded with a # symbol.
  28887. </summary>
  28888. <param name="filename">The filename to read</param>
  28889. <returns>The bytes read from the file.</returns>
  28890. <exception cref="T:System.IO.IOException">If there was a problem while reading the file.</exception>
  28891. </member>
  28892. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.String)">
  28893. <summary>
  28894. Same as ReadData(String) except that this method allows you to specify sections within
  28895. a file. Sections are referenced using section headers in the form:
  28896. </summary>
  28897. <param name="stream">The stream.</param>
  28898. <param name="section">The section.</param>
  28899. <returns></returns>
  28900. </member>
  28901. <member name="M:NPOI.Util.HexRead.ReadData(System.String,System.String)">
  28902. <summary>
  28903. Reads the data.
  28904. </summary>
  28905. <param name="filename">The filename.</param>
  28906. <param name="section">The section.</param>
  28907. <returns></returns>
  28908. </member>
  28909. <member name="M:NPOI.Util.HexRead.ReadData(System.IO.Stream,System.Int32)">
  28910. <summary>
  28911. Reads the data.
  28912. </summary>
  28913. <param name="stream">The stream.</param>
  28914. <param name="eofChar">The EOF char.</param>
  28915. <returns></returns>
  28916. </member>
  28917. <member name="M:NPOI.Util.HexRead.ReadFromString(System.String)">
  28918. <summary>
  28919. Reads from string.
  28920. </summary>
  28921. <param name="data">The data.</param>
  28922. <returns></returns>
  28923. </member>
  28924. <member name="M:NPOI.Util.HexRead.ReadToEOL(System.IO.Stream)">
  28925. <summary>
  28926. Reads to EOL.
  28927. </summary>
  28928. <param name="stream">The stream.</param>
  28929. </member>
  28930. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32)">
  28931. <summary>
  28932. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing byte array class.
  28933. </summary>
  28934. <param name="offset">offset of the field within its byte array.</param>
  28935. </member>
  28936. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32)">
  28937. <summary>
  28938. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  28939. byte array and initialize its value
  28940. </summary>
  28941. <param name="offset">offset of the field within its byte array</param>
  28942. <param name="value">the initial value</param>
  28943. </member>
  28944. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Byte[])">
  28945. <summary>
  28946. Construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  28947. byte array and initialize its value from its byte array
  28948. </summary>
  28949. <param name="offset">offset of the field within its byte array</param>
  28950. <param name="data">the byte array to Read the value from</param>
  28951. </member>
  28952. <member name="M:NPOI.Util.IntegerField.#ctor(System.Int32,System.Int32,System.Byte[])">
  28953. <summary>
  28954. construct the <see cref="T:NPOI.Util.IntegerField"/> with its offset into its containing
  28955. byte array, initialize its value, and write the value to a byte
  28956. </summary>
  28957. <param name="offset">offset of the field within its byte array</param>
  28958. <param name="value">the initial value</param>
  28959. <param name="data">the byte array to write the value to</param>
  28960. </member>
  28961. <member name="P:NPOI.Util.IntegerField.Value">
  28962. <summary>
  28963. get or Set the IntegerField's current value
  28964. </summary>
  28965. <value>The value.</value>
  28966. <returns></returns>
  28967. </member>
  28968. <member name="M:NPOI.Util.IntegerField.Set(System.Int32,System.Byte[])">
  28969. <summary>
  28970. Set the IntegerField's current value and write it to a byte array
  28971. </summary>
  28972. <param name="value">value to be Set</param>
  28973. <param name="data">the byte array to write the value to</param>
  28974. </member>
  28975. <member name="M:NPOI.Util.IntegerField.ReadFromBytes(System.Byte[])">
  28976. <summary>
  28977. Set the value from its offset into an array of bytes
  28978. </summary>
  28979. <param name="data">The data.</param>
  28980. </member>
  28981. <member name="M:NPOI.Util.IntegerField.ReadFromStream(System.IO.Stream)">
  28982. <summary>
  28983. Set the value from an Stream
  28984. </summary>
  28985. <param name="stream">the Stream from which the value is to be Read</param>
  28986. </member>
  28987. <member name="M:NPOI.Util.IntegerField.WriteToBytes(System.Byte[])">
  28988. <summary>
  28989. write the value out to an array of bytes at the appropriate offset
  28990. </summary>
  28991. <param name="data"> the array of bytes to which the value is to be written </param>
  28992. </member>
  28993. <member name="M:NPOI.Util.IntegerField.Write(System.Int32,System.Int32,System.Byte[])">
  28994. <summary>
  28995. Same as using the constructor <see cref="T:NPOI.Util.IntegerField"/> with the same
  28996. parameter list. Avoid creation of an useless object.
  28997. </summary>
  28998. <param name="offset">offset of the field within its byte array</param>
  28999. <param name="value">the initial value</param>
  29000. <param name="data">the byte array to write the value to</param>
  29001. </member>
  29002. <member name="M:NPOI.Util.IntegerField.ToString">
  29003. <summary>
  29004. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29005. </summary>
  29006. <returns>
  29007. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29008. </returns>
  29009. </member>
  29010. <member name="T:NPOI.Util.IntList">
  29011. <summary>
  29012. 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
  29013. the mimicry of List is as follows:
  29014. <ul>
  29015. <li> if possible, operations designated 'optional' in the List
  29016. interface are attempted</li>
  29017. <li> wherever the List interface refers to an Object, substitute
  29018. int</li>
  29019. <li> wherever the List interface refers to a Collection or List,
  29020. substitute IntList</li>
  29021. </ul>
  29022. the mimicry is not perfect, however:
  29023. <ul>
  29024. <li> operations involving Iterators or ListIterators are not
  29025. supported</li>
  29026. <li> Remove(Object) becomes RemoveValue to distinguish it from
  29027. Remove(int index)</li>
  29028. <li> subList is not supported</li>
  29029. </ul>
  29030. @author Marc Johnson
  29031. </summary>
  29032. </member>
  29033. <member name="M:NPOI.Util.IntList.#ctor">
  29034. <summary>
  29035. create an IntList of default size
  29036. </summary>
  29037. </member>
  29038. <member name="M:NPOI.Util.IntList.#ctor(NPOI.Util.IntList)">
  29039. <summary>
  29040. create a copy of an existing IntList
  29041. </summary>
  29042. <param name="list">the existing IntList</param>
  29043. </member>
  29044. <member name="M:NPOI.Util.IntList.#ctor(System.Int32,System.Int32)">
  29045. <summary>
  29046. create an IntList with a predefined Initial size
  29047. </summary>
  29048. <param name="initialCapacity">the size for the internal array</param>
  29049. <param name="fillvalue"></param>
  29050. </member>
  29051. <member name="M:NPOI.Util.IntList.Add(System.Int32,System.Int32)">
  29052. <summary>
  29053. add the specfied value at the specified index
  29054. </summary>
  29055. <param name="index">the index where the new value is to be Added</param>
  29056. <param name="value">the new value</param>
  29057. </member>
  29058. <member name="M:NPOI.Util.IntList.Add(System.Int32)">
  29059. <summary>
  29060. Appends the specified element to the end of this list
  29061. </summary>
  29062. <param name="value">element to be Appended to this list.</param>
  29063. <returns>return true (as per the general contract of the Collection.add method</returns>
  29064. </member>
  29065. <member name="M:NPOI.Util.IntList.AddAll(NPOI.Util.IntList)">
  29066. <summary>
  29067. Appends all of the elements in the specified collection to the
  29068. end of this list, in the order that they are returned by the
  29069. specified collection's iterator. The behavior of this
  29070. operation is unspecified if the specified collection is
  29071. modified while the operation is in progress. (Note that this
  29072. will occur if the specified collection is this list, and it's
  29073. nonempty.)
  29074. </summary>
  29075. <param name="c">collection whose elements are to be Added to this list.</param>
  29076. <returns>return true if this list Changed as a result of the call.</returns>
  29077. </member>
  29078. <member name="M:NPOI.Util.IntList.AddAll(System.Int32,NPOI.Util.IntList)">
  29079. <summary>
  29080. Inserts all of the elements in the specified collection into
  29081. this list at the specified position. Shifts the element
  29082. currently at that position (if any) and any subsequent elements
  29083. to the right (increases their indices). The new elements will
  29084. appear in this list in the order that they are returned by the
  29085. specified collection's iterator. The behavior of this
  29086. operation is unspecified if the specified collection is
  29087. modified while the operation is in progress. (Note that this
  29088. will occur if the specified collection is this list, and it's
  29089. nonempty.)
  29090. </summary>
  29091. <param name="index">index at which to insert first element from the specified collection.</param>
  29092. <param name="c">elements to be inserted into this list.</param>
  29093. <returns>return true if this list Changed as a result of the call.</returns>
  29094. </member>
  29095. <member name="M:NPOI.Util.IntList.Clear">
  29096. <summary>
  29097. Removes all of the elements from this list. This list will be
  29098. empty After this call returns (unless it throws an exception).
  29099. </summary>
  29100. </member>
  29101. <member name="M:NPOI.Util.IntList.Contains(System.Int32)">
  29102. <summary>
  29103. Returns true if this list Contains the specified element. More
  29104. formally, returns true if and only if this list Contains at
  29105. least one element e such that o == e
  29106. </summary>
  29107. <param name="o">element whose presence in this list is to be Tested.</param>
  29108. <returns>return true if this list Contains the specified element.</returns>
  29109. </member>
  29110. <member name="M:NPOI.Util.IntList.ContainsAll(NPOI.Util.IntList)">
  29111. <summary>
  29112. Returns true if this list Contains all of the elements of the
  29113. specified collection.
  29114. </summary>
  29115. <param name="c">collection to be Checked for Containment in this list.</param>
  29116. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  29117. </member>
  29118. <member name="M:NPOI.Util.IntList.Equals(System.Object)">
  29119. <summary>
  29120. Compares the specified object with this list for Equality.
  29121. Returns true if and only if the specified object is also a
  29122. list, both lists have the same size, and all corresponding
  29123. pairs of elements in the two lists are Equal. (Two elements e1
  29124. and e2 are equal if e1 == e2.) In other words, two lists are
  29125. defined to be equal if they contain the same elements in the
  29126. same order. This defInition ensures that the Equals method
  29127. works properly across different implementations of the List
  29128. interface.
  29129. </summary>
  29130. <param name="o">the object to be Compared for Equality with this list.</param>
  29131. <returns>return true if the specified object is equal to this list.</returns>
  29132. </member>
  29133. <member name="M:NPOI.Util.IntList.Get(System.Int32)">
  29134. <summary>
  29135. Returns the element at the specified position in this list.
  29136. </summary>
  29137. <param name="index">index of element to return.</param>
  29138. <returns>return the element at the specified position in this list.</returns>
  29139. </member>
  29140. <member name="M:NPOI.Util.IntList.GetHashCode">
  29141. <summary>
  29142. Returns the hash code value for this list. The hash code of a
  29143. list is defined to be the result of the following calculation:
  29144. <code>
  29145. hashCode = 1;
  29146. Iterator i = list.Iterator();
  29147. while (i.HasNext()) {
  29148. Object obj = i.Next();
  29149. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  29150. }
  29151. </code>
  29152. This ensures that list1.Equals(list2) implies that
  29153. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  29154. list2, as required by the general contract of Object.HashCode.
  29155. </summary>
  29156. <returns>return the hash code value for this list.</returns>
  29157. </member>
  29158. <member name="M:NPOI.Util.IntList.IndexOf(System.Int32)">
  29159. <summary>
  29160. Returns the index in this list of the first occurrence of the
  29161. specified element, or -1 if this list does not contain this
  29162. element. More formally, returns the lowest index i such that
  29163. (o == Get(i)), or -1 if there is no such index.
  29164. </summary>
  29165. <param name="o">element to search for.</param>
  29166. <returns>return the index in this list of the first occurrence of the
  29167. specified element, or -1 if this list does not contain
  29168. this element.</returns>
  29169. </member>
  29170. <member name="M:NPOI.Util.IntList.IsEmpty">
  29171. <summary>
  29172. Returns true if this list Contains no elements.
  29173. </summary>
  29174. <returns>return true if this list Contains no elements.</returns>
  29175. </member>
  29176. <member name="M:NPOI.Util.IntList.LastIndexOf(System.Int32)">
  29177. <summary>
  29178. Returns the index in this list of the last occurrence of the
  29179. specified element, or -1 if this list does not contain this
  29180. element. More formally, returns the highest index i such that
  29181. (o == Get(i)), or -1 if there is no such index.
  29182. </summary>
  29183. <param name="o">element to search for.</param>
  29184. <returns>the index in this list of the last occurrence of the
  29185. specified element, or -1 if this list does not contain
  29186. this element.
  29187. </returns>
  29188. </member>
  29189. <member name="M:NPOI.Util.IntList.Remove(System.Int32)">
  29190. <summary>
  29191. Removes the element at the specified position in this list.
  29192. Shifts any subsequent elements to the left (subtracts one from
  29193. their indices). Returns the element that was Removed from the
  29194. list.
  29195. </summary>
  29196. <param name="index">the index of the element to Removed.</param>
  29197. <returns>return the element previously at the specified position.</returns>
  29198. </member>
  29199. <member name="M:NPOI.Util.IntList.RemoveValue(System.Int32)">
  29200. <summary>
  29201. Removes the first occurrence in this list of the specified
  29202. element (optional operation). If this list does not contain
  29203. the element, it is unChanged. More formally, Removes the
  29204. element with the lowest index i such that (o.Equals(get(i)))
  29205. (if such an element exists).
  29206. </summary>
  29207. <param name="o">element to be Removed from this list, if present.</param>
  29208. <returns>return true if this list Contained the specified element.</returns>
  29209. </member>
  29210. <member name="M:NPOI.Util.IntList.RemoveAll(NPOI.Util.IntList)">
  29211. <summary>
  29212. Removes from this list all the elements that are Contained in
  29213. the specified collection
  29214. </summary>
  29215. <param name="c">collection that defines which elements will be Removed from the list.</param>
  29216. <returns>return true if this list Changed as a result of the call.</returns>
  29217. </member>
  29218. <member name="M:NPOI.Util.IntList.RetainAll(NPOI.Util.IntList)">
  29219. <summary>
  29220. Retains only the elements in this list that are Contained in
  29221. the specified collection. In other words, Removes from this
  29222. list all the elements that are not Contained in the specified
  29223. collection.
  29224. </summary>
  29225. <param name="c">collection that defines which elements this Set will retain.</param>
  29226. <returns>return true if this list Changed as a result of the call.</returns>
  29227. </member>
  29228. <member name="M:NPOI.Util.IntList.Set(System.Int32,System.Int32)">
  29229. <summary>
  29230. Replaces the element at the specified position in this list with the specified element
  29231. </summary>
  29232. <param name="index">index of element to Replace.</param>
  29233. <param name="element">element to be stored at the specified position.</param>
  29234. <returns>the element previously at the specified position.</returns>
  29235. </member>
  29236. <member name="M:NPOI.Util.IntList.Size">
  29237. <summary>
  29238. Returns the number of elements in this list. If this list
  29239. Contains more than Int32.MaxValue elements, returns
  29240. Int32.MaxValue.
  29241. </summary>
  29242. <returns>the number of elements in this IntList</returns>
  29243. </member>
  29244. <member name="P:NPOI.Util.IntList.Count">
  29245. <summary>
  29246. the number of elements in this IntList
  29247. </summary>
  29248. </member>
  29249. <member name="M:NPOI.Util.IntList.ToArray">
  29250. <summary>
  29251. Returns an array Containing all of the elements in this list in
  29252. proper sequence. Obeys the general contract of the
  29253. Collection.ToArray method.
  29254. </summary>
  29255. <returns>an array Containing all of the elements in this list in proper sequence.</returns>
  29256. </member>
  29257. <member name="M:NPOI.Util.IntList.ToArray(System.Int32[])">
  29258. <summary>
  29259. Returns an array Containing all of the elements in this list in
  29260. proper sequence. Obeys the general contract of the
  29261. Collection.ToArray(Object[]) method.
  29262. </summary>
  29263. <param name="a">the array into which the elements of this list are to
  29264. be stored, if it is big enough; otherwise, a new array
  29265. is allocated for this purpose.</param>
  29266. <returns>return an array Containing the elements of this list.</returns>
  29267. </member>
  29268. <member name="T:NPOI.Util.IntMapper`1">
  29269. <summary>
  29270. A List of objects that are indexed AND keyed by an int; also allows for Getting
  29271. the index of a value in the list
  29272. <p>I am happy is someone wants to re-implement this without using the
  29273. internal list and hashmap. If so could you please make sure that
  29274. you can add elements half way into the list and have the value-key mappings
  29275. update</p>
  29276. </summary>
  29277. <typeparam name="T"></typeparam>
  29278. <remarks>@author Jason Height</remarks>
  29279. </member>
  29280. <member name="M:NPOI.Util.IntMapper`1.#ctor">
  29281. <summary>
  29282. create an IntMapper of default size
  29283. </summary>
  29284. </member>
  29285. <member name="M:NPOI.Util.IntMapper`1.Add(`0)">
  29286. <summary>
  29287. Appends the specified element to the end of this list
  29288. </summary>
  29289. <param name="value">element to be Appended to this list.</param>
  29290. <returns>return true (as per the general contract of the Collection.add method)</returns>
  29291. </member>
  29292. <member name="P:NPOI.Util.IntMapper`1.Size">
  29293. <summary>
  29294. Gets the size.
  29295. </summary>
  29296. </member>
  29297. <member name="P:NPOI.Util.IntMapper`1.Item(System.Int32)">
  29298. <summary>
  29299. Gets the T object at the specified index.
  29300. </summary>
  29301. <param name="index"></param>
  29302. <returns></returns>
  29303. </member>
  29304. <member name="M:NPOI.Util.IntMapper`1.GetIndex(`0)">
  29305. <summary>
  29306. Gets the index of T object.
  29307. </summary>
  29308. <param name="o">The o.</param>
  29309. <returns></returns>
  29310. </member>
  29311. <member name="M:NPOI.Util.IntMapper`1.GetEnumerator">
  29312. <summary>
  29313. Gets the enumerator.
  29314. </summary>
  29315. <returns></returns>
  29316. </member>
  29317. <member name="M:NPOI.Util.IOUtils.ToByteArray(System.IO.Stream)">
  29318. <summary>
  29319. Reads all the data from the input stream, and returns
  29320. the bytes Read.
  29321. </summary>
  29322. <param name="stream">The stream.</param>
  29323. <returns></returns>
  29324. <remarks>Tony Qu changed the code</remarks>
  29325. </member>
  29326. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[])">
  29327. <summary>
  29328. Reads the fully.
  29329. </summary>
  29330. <param name="stream">The stream.</param>
  29331. <param name="b">The b.</param>
  29332. <returns></returns>
  29333. </member>
  29334. <member name="M:NPOI.Util.IOUtils.ReadFully(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
  29335. <summary>
  29336. Same as the normal
  29337. <c>in.Read(b, off, len)</c>
  29338. , but tries to ensure that the entire len number of bytes is Read.
  29339. If the end of file is reached before any bytes are Read, returns -1.
  29340. If the end of the file is reached after some bytes are
  29341. Read, returns the number of bytes Read.
  29342. If the end of the file isn't reached before len
  29343. bytes have been Read, will return len bytes.
  29344. </summary>
  29345. <param name="stream">The stream.</param>
  29346. <param name="b">The b.</param>
  29347. <param name="off">The off.</param>
  29348. <param name="len">The len.</param>
  29349. <returns></returns>
  29350. </member>
  29351. <member name="M:NPOI.Util.IOUtils.Copy(System.IO.Stream,System.IO.Stream)">
  29352. <summary>
  29353. Copies all the data from the given InputStream to the OutputStream. It
  29354. leaves both streams open, so you will still need to close them once done.
  29355. </summary>
  29356. <param name="inp"></param>
  29357. <param name="out1"></param>
  29358. </member>
  29359. <member name="T:NPOI.Util.LittleEndian">
  29360. <summary>
  29361. a utility class for handling little-endian numbers, which the 80x86 world is
  29362. replete with. The methods are all static, and input/output is from/to byte
  29363. arrays, or from InputStreams.
  29364. </summary>
  29365. <remarks>
  29366. @author Marc Johnson (mjohnson at apache dot org)
  29367. @author Andrew Oliver (acoliver at apache dot org)
  29368. </remarks>
  29369. </member>
  29370. <member name="M:NPOI.Util.LittleEndian.#ctor">
  29371. <summary>
  29372. Initializes a new instance of the <see cref="T:NPOI.Util.LittleEndian"/> class.
  29373. </summary>
  29374. </member>
  29375. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[],System.Int32)">
  29376. <summary>
  29377. get a short value from a byte array
  29378. </summary>
  29379. <param name="data">the byte array</param>
  29380. <param name="offset">a starting offset into the byte array</param>
  29381. <returns>the short (16-bit) value</returns>
  29382. </member>
  29383. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[],System.Int32)">
  29384. <summary>
  29385. get an unsigned short value from a byte array
  29386. </summary>
  29387. <param name="data">the byte array</param>
  29388. <param name="offset">a starting offset into the byte array</param>
  29389. <returns>the unsigned short (16-bit) value in an integer</returns>
  29390. </member>
  29391. <member name="M:NPOI.Util.LittleEndian.GetShort(System.Byte[])">
  29392. <summary>
  29393. get a short value from a byte array
  29394. </summary>
  29395. <param name="data">a starting offset into the byte array</param>
  29396. <returns>the short (16-bit) value</returns>
  29397. </member>
  29398. <member name="M:NPOI.Util.LittleEndian.GetUShort(System.Byte[])">
  29399. <summary>
  29400. get a short value from a byte array
  29401. </summary>
  29402. <param name="data">the unsigned short (16-bit) value in an integer</param>
  29403. <returns></returns>
  29404. </member>
  29405. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[],System.Int32)">
  29406. <summary>
  29407. get an int value from a byte array
  29408. </summary>
  29409. <param name="data">the byte array</param>
  29410. <param name="offset">a starting offset into the byte array</param>
  29411. <returns>the int (32-bit) value</returns>
  29412. </member>
  29413. <member name="M:NPOI.Util.LittleEndian.GetInt(System.Byte[])">
  29414. <summary>
  29415. get an int value from the beginning of a byte array
  29416. </summary>
  29417. <param name="data">the byte array</param>
  29418. <returns>the int (32-bit) value</returns>
  29419. </member>
  29420. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[],System.Int32)">
  29421. <summary>
  29422. Gets the U int.
  29423. </summary>
  29424. <param name="data">the byte array</param>
  29425. <param name="offset">a starting offset into the byte array</param>
  29426. <returns>the unsigned int (32-bit) value in a long</returns>
  29427. </member>
  29428. <member name="M:NPOI.Util.LittleEndian.GetUInt(System.Byte[])">
  29429. <summary>
  29430. Gets the U int.
  29431. </summary>
  29432. <param name="data">the byte array</param>
  29433. <returns>the unsigned int (32-bit) value in a long</returns>
  29434. </member>
  29435. <member name="M:NPOI.Util.LittleEndian.GetLong(System.Byte[],System.Int32)">
  29436. <summary>
  29437. get a long value from a byte array
  29438. </summary>
  29439. <param name="data">the byte array</param>
  29440. <param name="offset">a starting offset into the byte array</param>
  29441. <returns>the long (64-bit) value</returns>
  29442. </member>
  29443. <member name="M:NPOI.Util.LittleEndian.GetDouble(System.Byte[],System.Int32)">
  29444. <summary>
  29445. get a double value from a byte array, reads it in little endian format
  29446. then converts the resulting revolting IEEE 754 (curse them) floating
  29447. point number to a c# double
  29448. </summary>
  29449. <param name="data">the byte array</param>
  29450. <param name="offset">a starting offset into the byte array</param>
  29451. <returns>the double (64-bit) value</returns>
  29452. </member>
  29453. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int32,System.Int16)">
  29454. <summary>
  29455. Puts the short.
  29456. </summary>
  29457. <param name="data">the byte array</param>
  29458. <param name="offset">a starting offset into the byte array</param>
  29459. <param name="value">The value.</param>
  29460. </member>
  29461. <member name="M:NPOI.Util.LittleEndian.PutByte(System.Byte[],System.Int32,System.Int32)">
  29462. <summary>
  29463. Added for consistency with other put~() methods
  29464. </summary>
  29465. <param name="data">the byte array</param>
  29466. <param name="offset">a starting offset into the byte array</param>
  29467. <param name="value">The value.</param>
  29468. </member>
  29469. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32,System.Int32)">
  29470. <summary>
  29471. Puts the U short.
  29472. </summary>
  29473. <param name="data">the byte array</param>
  29474. <param name="offset">a starting offset into the byte array</param>
  29475. <param name="value">The value.</param>
  29476. </member>
  29477. <member name="M:NPOI.Util.LittleEndian.PutShort(System.Byte[],System.Int16)">
  29478. <summary>
  29479. put a short value into beginning of a byte array
  29480. </summary>
  29481. <param name="data">the byte array</param>
  29482. <param name="value">the short (16-bit) value</param>
  29483. </member>
  29484. <member name="M:NPOI.Util.LittleEndian.PutShort(System.IO.Stream,System.Int16)">
  29485. Put signed short into output stream
  29486. @param value
  29487. the short (16-bit) value
  29488. @param outputStream
  29489. output stream
  29490. @throws IOException
  29491. if an I/O error occurs
  29492. </member>
  29493. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32,System.Int32)">
  29494. <summary>
  29495. put an int value into a byte array
  29496. </summary>
  29497. <param name="data">the byte array</param>
  29498. <param name="offset">a starting offset into the byte array</param>
  29499. <param name="value">the int (32-bit) value</param>
  29500. </member>
  29501. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Byte[],System.Int32)">
  29502. <summary>
  29503. put an int value into beginning of a byte array
  29504. </summary>
  29505. <param name="data">the byte array</param>
  29506. <param name="value">the int (32-bit) value</param>
  29507. </member>
  29508. <member name="M:NPOI.Util.LittleEndian.PutInt(System.Int32,System.IO.Stream)">
  29509. <summary>
  29510. Put int into output stream
  29511. </summary>
  29512. <param name="value">the int (32-bit) value</param>
  29513. <param name="outputStream">output stream</param>
  29514. </member>
  29515. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int32,System.Int64)">
  29516. <summary>
  29517. put a long value into a byte array
  29518. </summary>
  29519. <param name="data">the byte array</param>
  29520. <param name="offset">a starting offset into the byte array</param>
  29521. <param name="value">the long (64-bit) value</param>
  29522. </member>
  29523. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Int32,System.Double)">
  29524. <summary>
  29525. put a double value into a byte array
  29526. </summary>
  29527. <param name="data">the byte array</param>
  29528. <param name="offset">a starting offset into the byte array</param>
  29529. <param name="value">the double (64-bit) value</param>
  29530. </member>
  29531. <member name="M:NPOI.Util.LittleEndian.ReadShort(System.IO.Stream)">
  29532. <summary>
  29533. Reads the short.
  29534. </summary>
  29535. <param name="stream">The stream.</param>
  29536. <returns></returns>
  29537. </member>
  29538. <member name="M:NPOI.Util.LittleEndian.ReadInt(System.IO.Stream)">
  29539. <summary>
  29540. get an int value from an Stream
  29541. </summary>
  29542. <param name="stream">the Stream from which the int is to be read</param>
  29543. <returns>the int (32-bit) value</returns>
  29544. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  29545. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  29546. </member>
  29547. <member name="M:NPOI.Util.LittleEndian.ReadLong(System.IO.Stream)">
  29548. <summary>
  29549. get a long value from a Stream
  29550. </summary>
  29551. <param name="stream">the Stream from which the long is to be read</param>
  29552. <returns>the long (64-bit) value</returns>
  29553. <exception cref="T:System.IO.IOException">will be propagated back to the caller</exception>
  29554. <exception cref="T:NPOI.Util.BufferUnderrunException">if the stream cannot provide enough bytes</exception>
  29555. </member>
  29556. <member name="M:NPOI.Util.LittleEndian.UByteToInt(System.Byte)">
  29557. <summary>
  29558. Us the byte to int.
  29559. </summary>
  29560. <param name="b">The b.</param>
  29561. <returns></returns>
  29562. </member>
  29563. <member name="M:NPOI.Util.LittleEndian.GetUnsignedByte(System.Byte[],System.Int32)">
  29564. <summary>
  29565. get the unsigned value of a byte.
  29566. </summary>
  29567. <param name="data">the byte array.</param>
  29568. <param name="offset">a starting offset into the byte array.</param>
  29569. <returns>the unsigned value of the byte as a 32 bit integer</returns>
  29570. </member>
  29571. <member name="M:NPOI.Util.LittleEndian.GetByteArray(System.Byte[],System.Int32,System.Int32)">
  29572. <summary>
  29573. Copy a portion of a byte array
  29574. </summary>
  29575. <param name="data"> the original byte array</param>
  29576. <param name="offset">Where to start copying from.</param>
  29577. <param name="size">Number of bytes to copy.</param>
  29578. <returns>The byteArray value</returns>
  29579. <exception cref="T:System.IndexOutOfRangeException">
  29580. if copying would cause access ofdata outside array bounds.
  29581. </exception>
  29582. </member>
  29583. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[])">
  29584. <summary>
  29585. Gets the unsigned byte.
  29586. </summary>
  29587. <param name="data">the byte array</param>
  29588. <returns></returns>
  29589. </member>
  29590. <member name="M:NPOI.Util.LittleEndian.GetUByte(System.Byte[],System.Int32)">
  29591. <summary>
  29592. Gets the unsigned byte.
  29593. </summary>
  29594. <param name="data">the byte array</param>
  29595. <param name="offset">a starting offset into the byte array</param>
  29596. <returns></returns>
  29597. </member>
  29598. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Byte[],System.Double)">
  29599. <summary>
  29600. Puts the double.
  29601. </summary>
  29602. <param name="data">the byte array</param>
  29603. <param name="value">The value.</param>
  29604. </member>
  29605. <member name="M:NPOI.Util.LittleEndian.PutDouble(System.Double,System.IO.Stream)">
  29606. put a double value into a byte array
  29607. @param value
  29608. the double (64-bit) value
  29609. @param outputStream
  29610. output stream
  29611. @throws IOException
  29612. if an I/O error occurs
  29613. </member>
  29614. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.UInt32)">
  29615. <summary>
  29616. Puts the uint.
  29617. </summary>
  29618. <param name="data">the byte array</param>
  29619. <param name="value">The value.</param>
  29620. </member>
  29621. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Int64,System.IO.Stream)">
  29622. Put unsigned int into output stream
  29623. @param value
  29624. the int (32-bit) value
  29625. @param outputStream
  29626. output stream
  29627. @throws IOException
  29628. if an I/O error occurs
  29629. </member>
  29630. <member name="M:NPOI.Util.LittleEndian.PutUInt(System.Byte[],System.Int32,System.UInt32)">
  29631. <summary>
  29632. Puts the uint.
  29633. </summary>
  29634. <param name="data">the byte array</param>
  29635. <param name="offset">a starting offset into the byte array</param>
  29636. <param name="value">The value.</param>
  29637. </member>
  29638. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Byte[],System.Int64)">
  29639. <summary>
  29640. Puts the long.
  29641. </summary>
  29642. <param name="data">the byte array</param>
  29643. <param name="value">The value.</param>
  29644. </member>
  29645. <member name="M:NPOI.Util.LittleEndian.PutLong(System.Int64,System.IO.Stream)">
  29646. Put long into output stream
  29647. @param value
  29648. the long (64-bit) value
  29649. @param outputStream
  29650. output stream
  29651. @throws IOException
  29652. if an I/O error occurs
  29653. </member>
  29654. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.UInt64)">
  29655. <summary>
  29656. Puts the long.
  29657. </summary>
  29658. <param name="data">the byte array</param>
  29659. <param name="value">The value.</param>
  29660. </member>
  29661. <member name="M:NPOI.Util.LittleEndian.PutULong(System.Byte[],System.Int32,System.UInt64)">
  29662. <summary>
  29663. Puts the ulong.
  29664. </summary>
  29665. <param name="data">the byte array</param>
  29666. <param name="offset">a starting offset into the byte array</param>
  29667. <param name="value">The value.</param>
  29668. </member>
  29669. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.Int64,System.Int32)">
  29670. <summary>
  29671. Puts the number.
  29672. </summary>
  29673. <param name="data">the byte array</param>
  29674. <param name="offset">a starting offset into the byte array</param>
  29675. <param name="value">The value.</param>
  29676. <param name="size">The size.</param>
  29677. </member>
  29678. <member name="M:NPOI.Util.LittleEndian.PutNumber(System.Byte[],System.Int32,System.UInt64,System.Int32)">
  29679. <summary>
  29680. Puts the number.
  29681. </summary>
  29682. <param name="data">the byte array</param>
  29683. <param name="offset">a starting offset into the byte array</param>
  29684. <param name="value">The value.</param>
  29685. <param name="size">The size.</param>
  29686. </member>
  29687. <member name="M:NPOI.Util.LittleEndian.PutShortArray(System.Byte[],System.Int32,System.Int16[])">
  29688. <summary>
  29689. Puts the short array.
  29690. </summary>
  29691. <param name="data">the byte array</param>
  29692. <param name="offset">a starting offset into the byte array</param>
  29693. <param name="value">The value.</param>
  29694. </member>
  29695. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Byte[],System.Int32)">
  29696. <summary>
  29697. Puts the U short.
  29698. </summary>
  29699. <param name="data">the byte array</param>
  29700. <param name="value">The value.</param>
  29701. </member>
  29702. <member name="M:NPOI.Util.LittleEndian.PutUShort(System.Int32,System.IO.Stream)">
  29703. Put unsigned short into output stream
  29704. @param value
  29705. the unsigned short (16-bit) value
  29706. @param outputStream
  29707. output stream
  29708. @throws IOException
  29709. if an I/O error occurs
  29710. </member>
  29711. <member name="M:NPOI.Util.LittleEndian.ReadFromStream(System.IO.Stream,System.Int32)">
  29712. <summary>
  29713. Reads from stream.
  29714. </summary>
  29715. <param name="stream">The stream.</param>
  29716. <param name="size">The size.</param>
  29717. <returns></returns>
  29718. </member>
  29719. <member name="M:NPOI.Util.LittleEndian.ReadULong(System.IO.Stream)">
  29720. <summary>
  29721. Reads the long.
  29722. </summary>
  29723. <param name="stream">The stream.</param>
  29724. <returns></returns>
  29725. </member>
  29726. <member name="T:NPOI.Util.LittleEndianByteArrayInputStream">
  29727. <summary>
  29728. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianInput"/>
  29729. </summary>
  29730. <remarks>@author Josh Micich</remarks>
  29731. </member>
  29732. <member name="T:NPOI.Util.LittleEndianByteArrayOutputStream">
  29733. <summary>
  29734. Adapts a plain byte array to <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  29735. </summary>
  29736. <remarks>@author Josh Micich</remarks>
  29737. </member>
  29738. <member name="T:NPOI.Util.ILittleEndianInput">
  29739. @author Josh Micich
  29740. </member>
  29741. <member name="T:NPOI.Util.LittleEndianInputStream">
  29742. <summary>
  29743. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianInput"/><p/>
  29744. This class does not buffer any input, so the stream Read position maintained
  29745. by this class is consistent with that of the inner stream.
  29746. </summary>
  29747. <remarks>
  29748. @author Josh Micich
  29749. </remarks>
  29750. </member>
  29751. <member name="T:NPOI.Util.ILittleEndianOutput">
  29752. @author Josh Micich
  29753. </member>
  29754. <member name="T:NPOI.Util.LittleEndianOutputStream">
  29755. <summary>
  29756. Wraps an <see cref="T:System.IO.Stream"/> providing <see cref="T:NPOI.Util.ILittleEndianOutput"/>
  29757. </summary>
  29758. <remarks>@author Josh Micich</remarks>
  29759. </member>
  29760. <member name="M:NPOI.Util.LongField.#ctor(System.Int32)">
  29761. <summary>
  29762. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  29763. </summary>
  29764. <param name="offset">The offset.</param>
  29765. </member>
  29766. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64)">
  29767. <summary>
  29768. construct the LongField with its offset into its containing
  29769. byte array and initialize its value
  29770. </summary>
  29771. <param name="offset">offset of the field within its byte array</param>
  29772. <param name="value">the initial value</param>
  29773. </member>
  29774. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Byte[])">
  29775. <summary>
  29776. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  29777. byte array and initialize its value from its byte array
  29778. </summary>
  29779. <param name="offset">The offset of the field within its byte array</param>
  29780. <param name="data">the byte array to read the value from</param>
  29781. </member>
  29782. <member name="M:NPOI.Util.LongField.#ctor(System.Int32,System.Int64,System.Byte[])">
  29783. <summary>
  29784. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  29785. byte array, initialize its value, and write the value to a byte
  29786. array
  29787. </summary>
  29788. <param name="offset">offset of the field within its byte array</param>
  29789. <param name="value">the initial value</param>
  29790. <param name="data">the byte array to write the value to</param>
  29791. </member>
  29792. <member name="P:NPOI.Util.LongField.Value">
  29793. <summary>
  29794. Getg or sets the LongField's current value
  29795. </summary>
  29796. <value>The current value</value>
  29797. </member>
  29798. <member name="M:NPOI.Util.LongField.Set(System.Int64,System.Byte[])">
  29799. <summary>
  29800. set the LongField's current value and write it to a byte array
  29801. </summary>
  29802. <param name="value">value to be set</param>
  29803. <param name="data">the byte array to write the value to</param>
  29804. </member>
  29805. <member name="M:NPOI.Util.LongField.ReadFromBytes(System.Byte[])">
  29806. <summary>
  29807. set the value from its offset into an array of bytes
  29808. </summary>
  29809. <param name="data">the byte array from which the value is to be read</param>
  29810. </member>
  29811. <member name="M:NPOI.Util.LongField.ReadFromStream(System.IO.Stream)">
  29812. <summary>
  29813. set the value from an Stream
  29814. </summary>
  29815. <param name="stream">the Stream from which the value is to be</param>
  29816. </member>
  29817. <member name="M:NPOI.Util.LongField.WriteToBytes(System.Byte[])">
  29818. <summary>
  29819. write the value out to an array of bytes at the appropriate offset
  29820. </summary>
  29821. <param name="data">the array of bytes to which the value is to be written</param>
  29822. </member>
  29823. <member name="M:NPOI.Util.LongField.Write(System.Int32,System.Int64,System.Byte[])">
  29824. <summary>
  29825. Same as using the constructor <see cref="T:NPOI.Util.LongField"/> with the same
  29826. parameter list. Avoid creation of an useless object.
  29827. </summary>
  29828. <param name="offset">offset of the field within its byte array</param>
  29829. <param name="value">the initial value</param>
  29830. <param name="data">the byte array to write the value to</param>
  29831. </member>
  29832. <member name="M:NPOI.Util.LongField.ToString">
  29833. <summary>
  29834. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29835. </summary>
  29836. <returns>
  29837. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  29838. </returns>
  29839. </member>
  29840. <member name="T:NPOI.Util.LZWDecompresser">
  29841. This class provides common functionality for the
  29842. various LZW implementations in the different file
  29843. formats.
  29844. It's currently used by HDGF and HMEF.
  29845. Two good resources on LZW are:
  29846. http://en.wikipedia.org/wiki/LZW
  29847. http://marknelson.us/1989/10/01/lzw-data-compression/
  29848. </member>
  29849. <member name="F:NPOI.Util.LZWDecompresser.maskMeansCompressed">
  29850. Does the mask bit mean it's compressed or uncompressed?
  29851. </member>
  29852. <member name="F:NPOI.Util.LZWDecompresser.codeLengthIncrease">
  29853. How much to append to the code length in the stream
  29854. to Get the real code length? Normally 2 or 3
  29855. </member>
  29856. <member name="F:NPOI.Util.LZWDecompresser.positionIsBigEndian">
  29857. Does the 12 bits of the position Get stored in
  29858. Little Endian or Big Endian form?
  29859. This controls whether a pos+length of 0x12 0x34
  29860. becomes a position of 0x123 or 0x312
  29861. </member>
  29862. <member name="M:NPOI.Util.LZWDecompresser.populateDictionary(System.Byte[])">
  29863. Populates the dictionary, and returns where in it
  29864. to begin writing new codes.
  29865. Generally, if the dictionary is pre-populated, then new
  29866. codes should be placed at the end of that block.
  29867. Equally, if the dictionary is left with all zeros, then
  29868. usually the new codes can go in at the start.
  29869. </member>
  29870. <member name="M:NPOI.Util.LZWDecompresser.adjustDictionaryOffset(System.Int32)">
  29871. Adjusts the position offset if needed when looking
  29872. something up in the dictionary.
  29873. </member>
  29874. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream)">
  29875. Decompresses the given input stream, returning the array of bytes
  29876. of the decompressed input.
  29877. </member>
  29878. <member name="M:NPOI.Util.LZWDecompresser.decompress(System.IO.Stream,System.IO.Stream)">
  29879. Perform a streaming decompression of the input.
  29880. Works by:
  29881. 1) Reading a flag byte, the 8 bits of which tell you if the
  29882. following 8 codes are compressed our un-compressed
  29883. 2) Consider the 8 bits in turn
  29884. 3) If the bit is Set, the next code is un-compressed, so
  29885. add it to the dictionary and output it
  29886. 4) If the bit isn't Set, then read in the length and start
  29887. position in the dictionary, and output the bytes there
  29888. 5) Loop until we've done all 8 bits, then read in the next
  29889. flag byte
  29890. </member>
  29891. <member name="M:NPOI.Util.LZWDecompresser.fromInt(System.Int32)">
  29892. Given an integer, turn it into a java byte, handling
  29893. the wrapping.
  29894. This is a convenience method
  29895. </member>
  29896. <member name="M:NPOI.Util.LZWDecompresser.fromByte(System.Byte)">
  29897. Given a java byte, turn it into an integer between 0
  29898. and 255 (i.e. handle the unwrapping).
  29899. This is a convenience method
  29900. </member>
  29901. <member name="T:NPOI.Util.NullLogger">
  29902. <summary>
  29903. A Logger class that strives to make it as easy as possible for
  29904. developers to write Log calls, while simultaneously making those
  29905. calls as cheap as possible by performing lazy evaluation of the Log
  29906. message.
  29907. @author Marc Johnson (mjohnson at apache dot org)
  29908. @author Glen Stampoultzis (glens at apache.org)
  29909. @author Nicola Ken Barozzi (nicolaken at apache.org)
  29910. </summary>
  29911. </member>
  29912. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object)">
  29913. Log a message
  29914. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29915. @param obj1 The object to Log.
  29916. </member>
  29917. <member name="M:NPOI.Util.NullLogger.Check(System.Int32)">
  29918. Check if a Logger is enabled to Log at the specified level
  29919. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29920. </member>
  29921. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object)">
  29922. Log a message. Lazily appends Object parameters together.
  29923. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29924. @param obj1 first object to place in the message
  29925. @param obj2 second object to place in the message
  29926. </member>
  29927. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  29928. Log a message. Lazily appends Object parameters together.
  29929. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29930. @param obj1 first Object to place in the message
  29931. @param obj2 second Object to place in the message
  29932. @param obj3 third Object to place in the message
  29933. </member>
  29934. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  29935. Log a message. Lazily appends Object parameters together.
  29936. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29937. @param obj1 first Object to place in the message
  29938. @param obj2 second Object to place in the message
  29939. @param obj3 third Object to place in the message
  29940. @param obj4 fourth Object to place in the message
  29941. </member>
  29942. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  29943. Log a message. Lazily appends Object parameters together.
  29944. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29945. @param obj1 first Object to place in the message
  29946. @param obj2 second Object to place in the message
  29947. @param obj3 third Object to place in the message
  29948. @param obj4 fourth Object to place in the message
  29949. @param obj5 fifth Object to place in the message
  29950. </member>
  29951. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  29952. Log a message. Lazily appends Object parameters together.
  29953. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29954. @param obj1 first Object to place in the message
  29955. @param obj2 second Object to place in the message
  29956. @param obj3 third Object to place in the message
  29957. @param obj4 fourth Object to place in the message
  29958. @param obj5 fifth Object to place in the message
  29959. @param obj6 sixth Object to place in the message
  29960. </member>
  29961. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  29962. Log a message. Lazily appends Object parameters together.
  29963. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29964. @param obj1 first Object to place in the message
  29965. @param obj2 second Object to place in the message
  29966. @param obj3 third Object to place in the message
  29967. @param obj4 fourth Object to place in the message
  29968. @param obj5 fifth Object to place in the message
  29969. @param obj6 sixth Object to place in the message
  29970. @param obj7 seventh Object to place in the message
  29971. </member>
  29972. <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)">
  29973. Log a message. Lazily appends Object parameters together.
  29974. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29975. @param obj1 first Object to place in the message
  29976. @param obj2 second Object to place in the message
  29977. @param obj3 third Object to place in the message
  29978. @param obj4 fourth Object to place in the message
  29979. @param obj5 fifth Object to place in the message
  29980. @param obj6 sixth Object to place in the message
  29981. @param obj7 seventh Object to place in the message
  29982. @param obj8 eighth Object to place in the message
  29983. </member>
  29984. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Exception)">
  29985. Log a message
  29986. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29987. @param obj1 The object to Log. This is converted to a string.
  29988. @param exception An exception to be Logged
  29989. </member>
  29990. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  29991. Log a message. Lazily appends Object parameters together.
  29992. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  29993. @param obj1 first Object to place in the message
  29994. @param obj2 second Object to place in the message
  29995. @param exception An exception to be Logged
  29996. </member>
  29997. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  29998. Log a message. Lazily appends Object parameters together.
  29999. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30000. @param obj1 first Object to place in the message
  30001. @param obj2 second Object to place in the message
  30002. @param obj3 third object to place in the message
  30003. @param exception An error message to be Logged
  30004. </member>
  30005. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30006. Log a message. Lazily appends Object parameters together.
  30007. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30008. @param obj1 first Object to place in the message
  30009. @param obj2 second Object to place in the message
  30010. @param obj3 third object to place in the message
  30011. @param obj4 fourth object to place in the message
  30012. @param exception An exception to be Logged
  30013. </member>
  30014. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30015. Log a message. Lazily appends Object parameters together.
  30016. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30017. @param obj1 first Object to place in the message
  30018. @param obj2 second Object to place in the message
  30019. @param obj3 third object to place in the message
  30020. @param obj4 fourth object to place in the message
  30021. @param obj5 fifth object to place in the message
  30022. @param exception An exception to be Logged
  30023. </member>
  30024. <member name="M:NPOI.Util.NullLogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30025. Log a message. Lazily appends Object parameters together.
  30026. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30027. @param obj1 first Object to place in the message
  30028. @param obj2 second Object to place in the message
  30029. @param obj3 third object to place in the message
  30030. @param obj4 fourth object to place in the message
  30031. @param obj5 fifth object to place in the message
  30032. @param obj6 sixth object to place in the message
  30033. @param exception An exception to be Logged
  30034. </member>
  30035. <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)">
  30036. Log a message. Lazily appends Object parameters together.
  30037. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30038. @param obj1 first Object to place in the message
  30039. @param obj2 second Object to place in the message
  30040. @param obj3 third object to place in the message
  30041. @param obj4 fourth object to place in the message
  30042. @param obj5 fifth object to place in the message
  30043. @param obj6 sixth object to place in the message
  30044. @param obj7 seventh object to place in the message
  30045. @param exception An exception to be Logged
  30046. </member>
  30047. <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)">
  30048. Log a message. Lazily appends Object parameters together.
  30049. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30050. @param obj1 first Object to place in the message
  30051. @param obj2 second Object to place in the message
  30052. @param obj3 third object to place in the message
  30053. @param obj4 fourth object to place in the message
  30054. @param obj5 fifth object to place in the message
  30055. @param obj6 sixth object to place in the message
  30056. @param obj7 seventh object to place in the message
  30057. @param obj8 eighth object to place in the message
  30058. @param exception An exception to be Logged
  30059. </member>
  30060. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object)">
  30061. Logs a formated message. The message itself may contain %
  30062. characters as place holders. This routine will attempt to match
  30063. the placeholder by looking at the type of parameter passed to
  30064. obj1.
  30065. If the parameter is an array, it traverses the array first and
  30066. matches parameters sequentially against the array items.
  30067. Otherwise the parameters after <c>message</c> are matched
  30068. in order.
  30069. If the place holder matches against a number it is printed as a
  30070. whole number. This can be overridden by specifying a precision
  30071. in the form %n.m where n is the padding for the whole part and
  30072. m is the number of decimal places to display. n can be excluded
  30073. if desired. n and m may not be more than 9.
  30074. If the last parameter (after flattening) is a Exception it is
  30075. Logged specially.
  30076. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30077. @param message The message to Log.
  30078. @param obj1 The first object to match against.
  30079. </member>
  30080. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object)">
  30081. Logs a formated message. The message itself may contain %
  30082. characters as place holders. This routine will attempt to match
  30083. the placeholder by looking at the type of parameter passed to
  30084. obj1.
  30085. If the parameter is an array, it traverses the array first and
  30086. matches parameters sequentially against the array items.
  30087. Otherwise the parameters after <c>message</c> are matched
  30088. in order.
  30089. If the place holder matches against a number it is printed as a
  30090. whole number. This can be overridden by specifying a precision
  30091. in the form %n.m where n is the padding for the whole part and
  30092. m is the number of decimal places to display. n can be excluded
  30093. if desired. n and m may not be more than 9.
  30094. If the last parameter (after flattening) is a Exception it is
  30095. Logged specially.
  30096. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30097. @param message The message to Log.
  30098. @param obj1 The first object to match against.
  30099. @param obj2 The second object to match against.
  30100. </member>
  30101. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object)">
  30102. Logs a formated message. The message itself may contain %
  30103. characters as place holders. This routine will attempt to match
  30104. the placeholder by looking at the type of parameter passed to
  30105. obj1.
  30106. If the parameter is an array, it traverses the array first and
  30107. matches parameters sequentially against the array items.
  30108. Otherwise the parameters after <c>message</c> are matched
  30109. in order.
  30110. If the place holder matches against a number it is printed as a
  30111. whole number. This can be overridden by specifying a precision
  30112. in the form %n.m where n is the padding for the whole part and
  30113. m is the number of decimal places to display. n can be excluded
  30114. if desired. n and m may not be more than 9.
  30115. If the last parameter (after flattening) is a Exception it is
  30116. Logged specially.
  30117. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30118. @param message The message to Log.
  30119. @param obj1 The first object to match against.
  30120. @param obj2 The second object to match against.
  30121. @param obj3 The third object to match against.
  30122. </member>
  30123. <member name="M:NPOI.Util.NullLogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object,System.Object)">
  30124. Logs a formated message. The message itself may contain %
  30125. characters as place holders. This routine will attempt to match
  30126. the placeholder by looking at the type of parameter passed to
  30127. obj1.
  30128. If the parameter is an array, it traverses the array first and
  30129. matches parameters sequentially against the array items.
  30130. Otherwise the parameters after <c>message</c> are matched
  30131. in order.
  30132. If the place holder matches against a number it is printed as a
  30133. whole number. This can be overridden by specifying a precision
  30134. in the form %n.m where n is the padding for the whole part and
  30135. m is the number of decimal places to display. n can be excluded
  30136. if desired. n and m may not be more than 9.
  30137. If the last parameter (after flattening) is a Exception it is
  30138. Logged specially.
  30139. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30140. @param message The message to Log.
  30141. @param obj1 The first object to match against.
  30142. @param obj2 The second object to match against.
  30143. @param obj3 The third object to match against.
  30144. @param obj4 The forth object to match against.
  30145. </member>
  30146. <member name="F:NPOI.Util.PngUtils.PNG_FILE_HEADER">
  30147. File header for PNG format.
  30148. </member>
  30149. <member name="M:NPOI.Util.PngUtils.MatchesPngHeader(System.Byte[],System.Int32)">
  30150. Checks if the offset matches the PNG header.
  30151. @param data the data to check.
  30152. @param offset the offset to check at.
  30153. @return {@code true} if the offset matches.
  30154. </member>
  30155. <member name="F:NPOI.Util.POILogFactory._loggers">
  30156. Map of POILogger instances, with classes as keys
  30157. </member>
  30158. <member name="F:NPOI.Util.POILogFactory._nullLogger">
  30159. A common instance of NullLogger, as it does nothing
  30160. we only need the one
  30161. </member>
  30162. <member name="F:NPOI.Util.POILogFactory._loggerClassName">
  30163. The name of the class to use. Initialised the
  30164. first time we need it
  30165. </member>
  30166. <member name="M:NPOI.Util.POILogFactory.#ctor">
  30167. <summary>
  30168. Initializes a new instance of the <see cref="T:NPOI.Util.POILogFactory"/> class.
  30169. </summary>
  30170. </member>
  30171. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.Type)">
  30172. <summary>
  30173. Get a logger, based on a class name
  30174. </summary>
  30175. <param name="type">the class whose name defines the log</param>
  30176. <returns>a POILogger for the specified class</returns>
  30177. </member>
  30178. <member name="M:NPOI.Util.POILogFactory.GetLogger(System.String)">
  30179. <summary>
  30180. Get a logger, based on a String
  30181. </summary>
  30182. <param name="cat">the String that defines the log</param>
  30183. <returns>a POILogger for the specified class</returns>
  30184. </member>
  30185. <member name="M:NPOI.Util.POILogger.#ctor">
  30186. package scope so it cannot be instantiated outside of the util
  30187. package. You need a POILogger? Go to the POILogFactory for one
  30188. </member>
  30189. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object)">
  30190. Log a message
  30191. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30192. @param obj1 The object to Log. This is converted to a string.
  30193. </member>
  30194. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Exception)">
  30195. Log a message
  30196. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30197. @param obj1 The object to Log. This is converted to a string.
  30198. @param exception An exception to be Logged
  30199. </member>
  30200. <member name="M:NPOI.Util.POILogger.Check(System.Int32)">
  30201. Check if a Logger is enabled to Log at the specified level
  30202. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30203. </member>
  30204. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object)">
  30205. Log a message. Lazily appends Object parameters together.
  30206. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30207. @param obj1 first object to place in the message
  30208. @param obj2 second object to place in the message
  30209. </member>
  30210. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object)">
  30211. Log a message. Lazily appends Object parameters together.
  30212. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30213. @param obj1 first Object to place in the message
  30214. @param obj2 second Object to place in the message
  30215. @param obj3 third Object to place in the message
  30216. </member>
  30217. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object)">
  30218. Log a message. Lazily appends Object parameters together.
  30219. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30220. @param obj1 first Object to place in the message
  30221. @param obj2 second Object to place in the message
  30222. @param obj3 third Object to place in the message
  30223. @param obj4 fourth Object to place in the message
  30224. </member>
  30225. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30226. Log a message. Lazily appends Object parameters together.
  30227. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30228. @param obj1 first Object to place in the message
  30229. @param obj2 second Object to place in the message
  30230. @param obj3 third Object to place in the message
  30231. @param obj4 fourth Object to place in the message
  30232. @param obj5 fifth Object to place in the message
  30233. </member>
  30234. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30235. Log a message. Lazily appends Object parameters together.
  30236. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30237. @param obj1 first Object to place in the message
  30238. @param obj2 second Object to place in the message
  30239. @param obj3 third Object to place in the message
  30240. @param obj4 fourth Object to place in the message
  30241. @param obj5 fifth Object to place in the message
  30242. @param obj6 sixth Object to place in the message
  30243. </member>
  30244. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object)">
  30245. Log a message. Lazily appends Object parameters together.
  30246. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30247. @param obj1 first Object to place in the message
  30248. @param obj2 second Object to place in the message
  30249. @param obj3 third Object to place in the message
  30250. @param obj4 fourth Object to place in the message
  30251. @param obj5 fifth Object to place in the message
  30252. @param obj6 sixth Object to place in the message
  30253. @param obj7 seventh Object to place in the message
  30254. </member>
  30255. <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)">
  30256. Log a message. Lazily appends Object parameters together.
  30257. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30258. @param obj1 first Object to place in the message
  30259. @param obj2 second Object to place in the message
  30260. @param obj3 third Object to place in the message
  30261. @param obj4 fourth Object to place in the message
  30262. @param obj5 fifth Object to place in the message
  30263. @param obj6 sixth Object to place in the message
  30264. @param obj7 seventh Object to place in the message
  30265. @param obj8 eighth Object to place in the message
  30266. </member>
  30267. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Exception)">
  30268. Log an exception, without a message
  30269. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30270. @param exception An exception to be Logged
  30271. </member>
  30272. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Exception)">
  30273. Log a message. Lazily appends Object parameters together.
  30274. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30275. @param obj1 first Object to place in the message
  30276. @param obj2 second Object to place in the message
  30277. @param exception An exception to be Logged
  30278. </member>
  30279. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Exception)">
  30280. Log a message. Lazily appends Object parameters together.
  30281. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30282. @param obj1 first Object to place in the message
  30283. @param obj2 second Object to place in the message
  30284. @param obj3 third object to place in the message
  30285. @param exception An error message to be Logged
  30286. </member>
  30287. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30288. Log a message. Lazily appends Object parameters together.
  30289. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30290. @param obj1 first Object to place in the message
  30291. @param obj2 second Object to place in the message
  30292. @param obj3 third object to place in the message
  30293. @param obj4 fourth object to place in the message
  30294. @param exception An exception to be Logged
  30295. </member>
  30296. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30297. Log a message. Lazily appends Object parameters together.
  30298. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30299. @param obj1 first Object to place in the message
  30300. @param obj2 second Object to place in the message
  30301. @param obj3 third object to place in the message
  30302. @param obj4 fourth object to place in the message
  30303. @param obj5 fifth object to place in the message
  30304. @param exception An exception to be Logged
  30305. </member>
  30306. <member name="M:NPOI.Util.POILogger.Log(System.Int32,System.Object,System.Object,System.Object,System.Object,System.Object,System.Object,System.Exception)">
  30307. Log a message. Lazily appends Object parameters together.
  30308. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30309. @param obj1 first Object to place in the message
  30310. @param obj2 second Object to place in the message
  30311. @param obj3 third object to place in the message
  30312. @param obj4 fourth object to place in the message
  30313. @param obj5 fifth object to place in the message
  30314. @param obj6 sixth object to place in the message
  30315. @param exception An exception to be Logged
  30316. </member>
  30317. <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)">
  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 obj3 third object to place in the message
  30323. @param obj4 fourth object to place in the message
  30324. @param obj5 fifth object to place in the message
  30325. @param obj6 sixth object to place in the message
  30326. @param obj7 seventh object to place in the message
  30327. @param exception An exception to be Logged
  30328. </member>
  30329. <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)">
  30330. Log a message. Lazily appends Object parameters together.
  30331. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30332. @param obj1 first Object to place in the message
  30333. @param obj2 second Object to place in the message
  30334. @param obj3 third object to place in the message
  30335. @param obj4 fourth object to place in the message
  30336. @param obj5 fifth object to place in the message
  30337. @param obj6 sixth object to place in the message
  30338. @param obj7 seventh object to place in the message
  30339. @param obj8 eighth object to place in the message
  30340. @param exception An exception to be Logged
  30341. </member>
  30342. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object)">
  30343. Logs a formated message. The message itself may contain %
  30344. characters as place holders. This routine will attempt to match
  30345. the placeholder by looking at the type of parameter passed to
  30346. obj1.
  30347. If the parameter is an array, it traverses the array first and
  30348. matches parameters sequentially against the array items.
  30349. Otherwise the parameters after <c>message</c> are matched
  30350. in order.
  30351. If the place holder matches against a number it is printed as a
  30352. whole number. This can be overridden by specifying a precision
  30353. in the form %n.m where n is the padding for the whole part and
  30354. m is the number of decimal places to display. n can be excluded
  30355. if desired. n and m may not be more than 9.
  30356. If the last parameter (after flattening) is a Exception it is
  30357. Logged specially.
  30358. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30359. @param message The message to Log.
  30360. @param obj1 The first object to match against.
  30361. </member>
  30362. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object)">
  30363. Logs a formated message. The message itself may contain %
  30364. characters as place holders. This routine will attempt to match
  30365. the placeholder by looking at the type of parameter passed to
  30366. obj1.
  30367. If the parameter is an array, it traverses the array first and
  30368. matches parameters sequentially against the array items.
  30369. Otherwise the parameters after <c>message</c> are matched
  30370. in order.
  30371. If the place holder matches against a number it is printed as a
  30372. whole number. This can be overridden by specifying a precision
  30373. in the form %n.m where n is the padding for the whole part and
  30374. m is the number of decimal places to display. n can be excluded
  30375. if desired. n and m may not be more than 9.
  30376. If the last parameter (after flattening) is a Exception it is
  30377. Logged specially.
  30378. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30379. @param message The message to Log.
  30380. @param obj1 The first object to match against.
  30381. @param obj2 The second object to match against.
  30382. </member>
  30383. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object)">
  30384. Logs a formated message. The message itself may contain %
  30385. characters as place holders. This routine will attempt to match
  30386. the placeholder by looking at the type of parameter passed to
  30387. obj1.
  30388. If the parameter is an array, it traverses the array first and
  30389. matches parameters sequentially against the array items.
  30390. Otherwise the parameters after <c>message</c> are matched
  30391. in order.
  30392. If the place holder matches against a number it is printed as a
  30393. whole number. This can be overridden by specifying a precision
  30394. in the form %n.m where n is the padding for the whole part and
  30395. m is the number of decimal places to display. n can be excluded
  30396. if desired. n and m may not be more than 9.
  30397. If the last parameter (after flattening) is a Exception it is
  30398. Logged specially.
  30399. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30400. @param message The message to Log.
  30401. @param obj1 The first object to match against.
  30402. @param obj2 The second object to match against.
  30403. @param obj3 The third object to match against.
  30404. </member>
  30405. <member name="M:NPOI.Util.POILogger.LogFormatted(System.Int32,System.String,System.Object,System.Object,System.Object,System.Object)">
  30406. Logs a formated message. The message itself may contain %
  30407. characters as place holders. This routine will attempt to match
  30408. the placeholder by looking at the type of parameter passed to
  30409. obj1.
  30410. If the parameter is an array, it traverses the array first and
  30411. matches parameters sequentially against the array items.
  30412. Otherwise the parameters after <c>message</c> are matched
  30413. in order.
  30414. If the place holder matches against a number it is printed as a
  30415. whole number. This can be overridden by specifying a precision
  30416. in the form %n.m where n is the padding for the whole part and
  30417. m is the number of decimal places to display. n can be excluded
  30418. if desired. n and m may not be more than 9.
  30419. If the last parameter (after flattening) is a Exception it is
  30420. Logged specially.
  30421. @param level One of DEBUG, INFO, WARN, ERROR, FATAL
  30422. @param message The message to Log.
  30423. @param obj1 The first object to match against.
  30424. @param obj2 The second object to match against.
  30425. @param obj3 The third object to match against.
  30426. @param obj4 The forth object to match against.
  30427. </member>
  30428. <member name="M:NPOI.Util.POILogger.FlattenArrays(System.Object[])">
  30429. Flattens any contained objects. Only tranverses one level deep.
  30430. </member>
  30431. <member name="M:NPOI.Util.PushbackStream.ReadByte">
  30432. <summary>
  30433. 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.
  30434. </summary>
  30435. <returns>
  30436. The unsigned byte cast to an Int32, or -1 if at the end of the stream.
  30437. </returns>
  30438. <exception cref="T:System.NotSupportedException">
  30439. The stream does not support reading.
  30440. </exception>
  30441. <exception cref="T:System.ObjectDisposedException">
  30442. Methods were called after the stream was closed.
  30443. </exception>
  30444. </member>
  30445. <member name="M:NPOI.Util.PushbackStream.Read(System.Byte[],System.Int32,System.Int32)">
  30446. <summary>
  30447. 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.
  30448. </summary>
  30449. <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>
  30450. <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>
  30451. <param name="count">The maximum number of bytes to be read from the current stream.</param>
  30452. <returns>
  30453. 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.
  30454. </returns>
  30455. <exception cref="T:System.ArgumentException">
  30456. The sum of <paramref name="offset"/> and <paramref name="count"/> is larger than the buffer length.
  30457. </exception>
  30458. <exception cref="T:System.ArgumentNullException">
  30459. <paramref name="buffer"/> is null.
  30460. </exception>
  30461. <exception cref="T:System.ArgumentOutOfRangeException">
  30462. <paramref name="offset"/> or <paramref name="count"/> is negative.
  30463. </exception>
  30464. <exception cref="T:System.IO.IOException">
  30465. An I/O error occurs.
  30466. </exception>
  30467. <exception cref="T:System.NotSupportedException">
  30468. The stream does not support reading.
  30469. </exception>
  30470. <exception cref="T:System.ObjectDisposedException">
  30471. Methods were called after the stream was closed.
  30472. </exception>
  30473. </member>
  30474. <member name="M:NPOI.Util.PushbackStream.Unread(System.Int32)">
  30475. <summary>
  30476. Unreads the specified b.
  30477. </summary>
  30478. <param name="b">The b.</param>
  30479. </member>
  30480. <member name="P:NPOI.Util.PushbackStream.CanRead">
  30481. <summary>
  30482. When overridden in a derived class, gets a value indicating whether the current stream supports reading.
  30483. </summary>
  30484. <value></value>
  30485. <returns>true if the stream supports reading; otherwise, false.
  30486. </returns>
  30487. </member>
  30488. <member name="P:NPOI.Util.PushbackStream.CanSeek">
  30489. <summary>
  30490. When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
  30491. </summary>
  30492. <value></value>
  30493. <returns>true if the stream supports seeking; otherwise, false.
  30494. </returns>
  30495. </member>
  30496. <member name="P:NPOI.Util.PushbackStream.CanWrite">
  30497. <summary>
  30498. When overridden in a derived class, gets a value indicating whether the current stream supports writing.
  30499. </summary>
  30500. <value></value>
  30501. <returns>true if the stream supports writing; otherwise, false.
  30502. </returns>
  30503. </member>
  30504. <member name="P:NPOI.Util.PushbackStream.Length">
  30505. <summary>
  30506. When overridden in a derived class, gets the length in bytes of the stream.
  30507. </summary>
  30508. <value></value>
  30509. <returns>
  30510. A long value representing the length of the stream in bytes.
  30511. </returns>
  30512. <exception cref="T:System.NotSupportedException">
  30513. A class derived from Stream does not support seeking.
  30514. </exception>
  30515. <exception cref="T:System.ObjectDisposedException">
  30516. Methods were called after the stream was closed.
  30517. </exception>
  30518. </member>
  30519. <member name="P:NPOI.Util.PushbackStream.Position">
  30520. <summary>
  30521. When overridden in a derived class, gets or sets the position within the current stream.
  30522. </summary>
  30523. <value></value>
  30524. <returns>
  30525. The current position within the stream.
  30526. </returns>
  30527. <exception cref="T:System.IO.IOException">
  30528. An I/O error occurs.
  30529. </exception>
  30530. <exception cref="T:System.NotSupportedException">
  30531. The stream does not support seeking.
  30532. </exception>
  30533. <exception cref="T:System.ObjectDisposedException">
  30534. Methods were called after the stream was closed.
  30535. </exception>
  30536. </member>
  30537. <member name="M:NPOI.Util.PushbackStream.Close">
  30538. <summary>
  30539. Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream.
  30540. </summary>
  30541. </member>
  30542. <member name="M:NPOI.Util.PushbackStream.Flush">
  30543. <summary>
  30544. When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
  30545. </summary>
  30546. <exception cref="T:System.IO.IOException">
  30547. An I/O error occurs.
  30548. </exception>
  30549. </member>
  30550. <member name="M:NPOI.Util.PushbackStream.Seek(System.Int64,System.IO.SeekOrigin)">
  30551. <summary>
  30552. When overridden in a derived class, sets the position within the current stream.
  30553. </summary>
  30554. <param name="offset">A byte offset relative to the <paramref name="origin"/> parameter.</param>
  30555. <param name="origin">A value of type <see cref="T:System.IO.SeekOrigin"/> indicating the reference point used to obtain the new position.</param>
  30556. <returns>
  30557. The new position within the current stream.
  30558. </returns>
  30559. <exception cref="T:System.IO.IOException">
  30560. An I/O error occurs.
  30561. </exception>
  30562. <exception cref="T:System.NotSupportedException">
  30563. The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
  30564. </exception>
  30565. <exception cref="T:System.ObjectDisposedException">
  30566. Methods were called after the stream was closed.
  30567. </exception>
  30568. </member>
  30569. <member name="M:NPOI.Util.PushbackStream.SetLength(System.Int64)">
  30570. <summary>
  30571. When overridden in a derived class, sets the length of the current stream.
  30572. </summary>
  30573. <param name="value">The desired length of the current stream in bytes.</param>
  30574. <exception cref="T:System.IO.IOException">
  30575. An I/O error occurs.
  30576. </exception>
  30577. <exception cref="T:System.NotSupportedException">
  30578. The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
  30579. </exception>
  30580. <exception cref="T:System.ObjectDisposedException">
  30581. Methods were called after the stream was closed.
  30582. </exception>
  30583. </member>
  30584. <member name="M:NPOI.Util.PushbackStream.Write(System.Byte[],System.Int32,System.Int32)">
  30585. <summary>
  30586. 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.
  30587. </summary>
  30588. <param name="buffer">An array of bytes. This method copies <paramref name="count"/> bytes from <paramref name="buffer"/> to the current stream.</param>
  30589. <param name="offset">The zero-based byte offset in <paramref name="buffer"/> at which to begin copying bytes to the current stream.</param>
  30590. <param name="count">The number of bytes to be written to the current stream.</param>
  30591. <exception cref="T:System.ArgumentException">
  30592. The sum of <paramref name="offset"/> and <paramref name="count"/> is greater than the buffer length.
  30593. </exception>
  30594. <exception cref="T:System.ArgumentNullException">
  30595. <paramref name="buffer"/> is null.
  30596. </exception>
  30597. <exception cref="T:System.ArgumentOutOfRangeException">
  30598. <paramref name="offset"/> or <paramref name="count"/> is negative.
  30599. </exception>
  30600. <exception cref="T:System.IO.IOException">
  30601. An I/O error occurs.
  30602. </exception>
  30603. <exception cref="T:System.NotSupportedException">
  30604. The stream does not support writing.
  30605. </exception>
  30606. <exception cref="T:System.ObjectDisposedException">
  30607. Methods were called after the stream was closed.
  30608. </exception>
  30609. </member>
  30610. <member name="M:NPOI.Util.PushbackStream.WriteByte(System.Byte)">
  30611. <summary>
  30612. Writes a byte to the current position in the stream and advances the position within the stream by one byte.
  30613. </summary>
  30614. <param name="value">The byte to write to the stream.</param>
  30615. <exception cref="T:System.IO.IOException">
  30616. An I/O error occurs.
  30617. </exception>
  30618. <exception cref="T:System.NotSupportedException">
  30619. The stream does not support writing, or the stream is already closed.
  30620. </exception>
  30621. <exception cref="T:System.ObjectDisposedException">
  30622. Methods were called after the stream was closed.
  30623. </exception>
  30624. </member>
  30625. <member name="T:NPOI.Util.RecordFormatException">
  30626. A common exception thrown by our binary format Parsers
  30627. (especially HSSF and DDF), when they hit invalid
  30628. format or data when Processing a record.
  30629. </member>
  30630. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32)">
  30631. <summary>
  30632. construct the ShortField with its offset into its containing
  30633. byte array
  30634. </summary>
  30635. <param name="offset">offset of the field within its byte array</param>
  30636. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  30637. </member>
  30638. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16)">
  30639. <summary>
  30640. construct the ShortField with its offset into its containing byte array and initialize its value
  30641. </summary>
  30642. <param name="offset">offset of the field within its byte array</param>
  30643. <param name="value">the initial value</param>
  30644. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  30645. </member>
  30646. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Byte[])">
  30647. <summary>
  30648. Construct the ShortField with its offset into its containing
  30649. byte array and initialize its value from its byte array
  30650. </summary>
  30651. <param name="offset">offset of the field within its byte array</param>
  30652. <param name="data">the byte array to read the value from</param>
  30653. <exception cref="T:System.IndexOutOfRangeException">if the offset is not
  30654. within the range of 0..(data.length - 1)</exception>
  30655. </member>
  30656. <member name="M:NPOI.Util.ShortField.#ctor(System.Int32,System.Int16,System.Byte[]@)">
  30657. <summary>
  30658. construct the ShortField with its offset into its containing
  30659. byte array, initialize its value, and write its value to its
  30660. byte array
  30661. </summary>
  30662. <param name="offset">offset of the field within its byte array</param>
  30663. <param name="value">the initial value</param>
  30664. <param name="data">the byte array to write the value to</param>
  30665. <exception cref="T:System.IndexOutOfRangeException">if offset is negative</exception>
  30666. </member>
  30667. <member name="P:NPOI.Util.ShortField.Value">
  30668. <summary>
  30669. Gets or sets the value.
  30670. </summary>
  30671. <value>The value.</value>
  30672. </member>
  30673. <member name="M:NPOI.Util.ShortField.Set(System.Int16,System.Byte[]@)">
  30674. <summary>
  30675. set the ShortField's current value and write it to a byte array
  30676. </summary>
  30677. <param name="value">value to be set</param>
  30678. <param name="data">the byte array to write the value to</param>
  30679. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  30680. of range</exception>
  30681. </member>
  30682. <member name="M:NPOI.Util.ShortField.ReadFromBytes(System.Byte[])">
  30683. <summary>
  30684. set the value from its offset into an array of bytes
  30685. </summary>
  30686. <param name="data">the byte array from which the value is to be read</param>
  30687. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  30688. of range</exception>
  30689. </member>
  30690. <member name="M:NPOI.Util.ShortField.ReadFromStream(System.IO.Stream)">
  30691. <summary>
  30692. set the value from an Stream
  30693. </summary>
  30694. <param name="stream">the Stream from which the value is to be
  30695. read</param>
  30696. <exception cref="T:System.IO.IOException">if an IOException is thrown from reading
  30697. the Stream</exception>
  30698. <exception cref="T:NPOI.Util.BufferUnderrunException">if there is not enough data
  30699. available from the Stream</exception>
  30700. </member>
  30701. <member name="M:NPOI.Util.ShortField.WriteToBytes(System.Byte[])">
  30702. <summary>
  30703. write the value out to an array of bytes at the appropriate
  30704. offset
  30705. </summary>
  30706. <param name="data">the array of bytes to which the value is to be
  30707. written</param>
  30708. <exception cref="T:System.IndexOutOfRangeException">if the offset is out
  30709. of range</exception>
  30710. </member>
  30711. <member name="M:NPOI.Util.ShortField.Write(System.Int32,System.Int16,System.Byte[]@)">
  30712. <summary>
  30713. Same as using the constructor <see cref="T:NPOI.Util.ShortField"/> with the same
  30714. parameter list. Avoid creation of an useless object.
  30715. </summary>
  30716. <param name="offset">offset of the field within its byte array</param>
  30717. <param name="value">the initial value</param>
  30718. <param name="data">the byte array to write the value to</param>
  30719. </member>
  30720. <member name="M:NPOI.Util.ShortField.ToString">
  30721. <summary>
  30722. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  30723. </summary>
  30724. <returns>
  30725. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  30726. </returns>
  30727. </member>
  30728. <member name="T:NPOI.Util.ShortList">
  30729. <summary>
  30730. A List of short's; as full an implementation of the java.Util.List
  30731. interface as possible, with an eye toward minimal creation of
  30732. objects
  30733. the mimicry of List is as follows:
  30734. <ul>
  30735. <li> if possible, operations designated 'optional' in the List
  30736. interface are attempted</li>
  30737. <li> wherever the List interface refers to an Object, substitute
  30738. short</li>
  30739. <li> wherever the List interface refers to a Collection or List,
  30740. substitute shortList</li>
  30741. </ul>
  30742. the mimicry is not perfect, however:
  30743. <ul>
  30744. <li> operations involving Iterators or ListIterators are not
  30745. supported</li>
  30746. <li> Remove(Object) becomes RemoveValue to distinguish it from
  30747. Remove(short index)</li>
  30748. <li> subList is not supported</li>
  30749. </ul>
  30750. </summary>
  30751. </member>
  30752. <member name="M:NPOI.Util.ShortList.#ctor">
  30753. <summary>
  30754. create an shortList of default size
  30755. </summary>
  30756. </member>
  30757. <member name="M:NPOI.Util.ShortList.#ctor(NPOI.Util.ShortList)">
  30758. <summary>
  30759. create a copy of an existing shortList
  30760. </summary>
  30761. <param name="list">the existing shortList</param>
  30762. </member>
  30763. <member name="M:NPOI.Util.ShortList.#ctor(System.Int32)">
  30764. <summary>
  30765. create an shortList with a predefined Initial size
  30766. </summary>
  30767. <param name="InitialCapacity">the size for the internal array</param>
  30768. </member>
  30769. <member name="M:NPOI.Util.ShortList.Add(System.Int32,System.Int16)">
  30770. <summary>
  30771. add the specfied value at the specified index
  30772. </summary>
  30773. <param name="index">the index where the new value is to be Added</param>
  30774. <param name="value">the new value</param>
  30775. </member>
  30776. <member name="M:NPOI.Util.ShortList.Add(System.Int16)">
  30777. <summary>
  30778. Appends the specified element to the end of this list
  30779. </summary>
  30780. <param name="value">element to be Appended to this list.</param>
  30781. <returns>return true (as per the general contract of the Collection.add method).</returns>
  30782. </member>
  30783. <member name="M:NPOI.Util.ShortList.AddAll(NPOI.Util.ShortList)">
  30784. <summary>
  30785. Appends all of the elements in the specified collection to the
  30786. end of this list, in the order that they are returned by the
  30787. specified collection's iterator. The behavior of this
  30788. operation is unspecified if the specified collection is
  30789. modified while the operation is in progress. (Note that this
  30790. will occur if the specified collection is this list, and it's
  30791. nonempty.)
  30792. </summary>
  30793. <param name="c">collection whose elements are to be Added to this list.</param>
  30794. <returns>return true if this list Changed as a result of the call.</returns>
  30795. </member>
  30796. <member name="M:NPOI.Util.ShortList.AddAll(System.Int32,NPOI.Util.ShortList)">
  30797. <summary>
  30798. Inserts all of the elements in the specified collection into
  30799. this list at the specified position. Shifts the element
  30800. currently at that position (if any) and any subsequent elements
  30801. to the right (increases their indices). The new elements will
  30802. appear in this list in the order that they are returned by the
  30803. specified collection's iterator. The behavior of this
  30804. operation is unspecified if the specified collection is
  30805. modified while the operation is in progress. (Note that this
  30806. will occur if the specified collection is this list, and it's
  30807. nonempty.)
  30808. </summary>
  30809. <param name="index">index at which to insert first element from the specified collection.</param>
  30810. <param name="c">elements to be inserted into this list.</param>
  30811. <returns>return true if this list Changed as a result of the call.</returns>
  30812. <exception cref="T:System.IndexOutOfRangeException"> if the index is out of range (index &lt; 0 || index &gt; size())</exception>
  30813. </member>
  30814. <member name="M:NPOI.Util.ShortList.Clear">
  30815. <summary>
  30816. Removes all of the elements from this list. This list will be
  30817. empty After this call returns (unless it throws an exception).
  30818. </summary>
  30819. </member>
  30820. <member name="M:NPOI.Util.ShortList.Contains(System.Int16)">
  30821. <summary>
  30822. Returns true if this list Contains the specified element. More
  30823. formally, returns true if and only if this list Contains at
  30824. least one element e such that o == e
  30825. </summary>
  30826. <param name="o">element whose presence in this list is to be Tested.</param>
  30827. <returns>return true if this list Contains the specified element.</returns>
  30828. </member>
  30829. <member name="M:NPOI.Util.ShortList.ContainsAll(NPOI.Util.ShortList)">
  30830. <summary>
  30831. Returns true if this list Contains all of the elements of the specified collection.
  30832. </summary>
  30833. <param name="c">collection to be Checked for Containment in this list.</param>
  30834. <returns>return true if this list Contains all of the elements of the specified collection.</returns>
  30835. </member>
  30836. <member name="M:NPOI.Util.ShortList.Equals(System.Object)">
  30837. <summary>
  30838. Compares the specified object with this list for Equality.
  30839. Returns true if and only if the specified object is also a
  30840. list, both lists have the same size, and all corresponding
  30841. pairs of elements in the two lists are Equal. (Two elements e1
  30842. and e2 are equal if e1 == e2.) In other words, two lists are
  30843. defined to be equal if they contain the same elements in the
  30844. same order. This defInition ensures that the Equals method
  30845. works properly across different implementations of the List
  30846. interface.
  30847. </summary>
  30848. <param name="o">the object to be Compared for Equality with this list.</param>
  30849. <returns>return true if the specified object is equal to this list.</returns>
  30850. </member>
  30851. <member name="M:NPOI.Util.ShortList.Get(System.Int32)">
  30852. <summary>
  30853. Returns the element at the specified position in this list.
  30854. </summary>
  30855. <param name="index">index of element to return.</param>
  30856. <returns>return the element at the specified position in this list.</returns>
  30857. </member>
  30858. <member name="M:NPOI.Util.ShortList.GetHashCode">
  30859. <summary>
  30860. Returns the hash code value for this list. The hash code of a
  30861. list is defined to be the result of the following calculation:
  30862. <code>
  30863. hashCode = 1;
  30864. Iterator i = list.Iterator();
  30865. while (i.HasNext()) {
  30866. Object obj = i.Next();
  30867. hashCode = 31*hashCode + (obj==null ? 0 : obj.HashCode());
  30868. }
  30869. </code>
  30870. This ensures that list1.Equals(list2) implies that
  30871. list1.HashCode()==list2.HashCode() for any two lists, list1 and
  30872. list2, as required by the general contract of Object.HashCode.
  30873. </summary>
  30874. <returns>return the hash code value for this list.</returns>
  30875. </member>
  30876. <member name="M:NPOI.Util.ShortList.IndexOf(System.Int16)">
  30877. <summary>
  30878. Returns the index in this list of the first occurrence of the
  30879. specified element, or -1 if this list does not contain this
  30880. element. More formally, returns the lowest index i such that
  30881. (o == Get(i)), or -1 if there is no such index.
  30882. </summary>
  30883. <param name="o">element to search for.</param>
  30884. <returns>the index in this list of the first occurrence of the
  30885. specified element, or -1 if this list does not contain
  30886. this element.
  30887. </returns>
  30888. </member>
  30889. <member name="M:NPOI.Util.ShortList.IsEmpty">
  30890. <summary>
  30891. Returns true if this list Contains no elements.
  30892. </summary>
  30893. <returns>return true if this list Contains no elements.</returns>
  30894. </member>
  30895. <member name="M:NPOI.Util.ShortList.LastIndexOf(System.Int16)">
  30896. <summary>
  30897. Returns the index in this list of the last occurrence of the
  30898. specified element, or -1 if this list does not contain this
  30899. element. More formally, returns the highest index i such that
  30900. (o == Get(i)), or -1 if there is no such index.
  30901. </summary>
  30902. <param name="o">element to search for.</param>
  30903. <returns>return the index in this list of the last occurrence of the
  30904. specified element, or -1 if this list does not contain this element.</returns>
  30905. </member>
  30906. <member name="M:NPOI.Util.ShortList.Remove(System.Int32)">
  30907. <summary>
  30908. Removes the element at the specified position in this list.
  30909. Shifts any subsequent elements to the left (subtracts one from
  30910. their indices). Returns the element that was Removed from the
  30911. list.
  30912. </summary>
  30913. <param name="index">the index of the element to Removed.</param>
  30914. <returns>return the element previously at the specified position.</returns>
  30915. </member>
  30916. <member name="M:NPOI.Util.ShortList.RemoveValue(System.Int16)">
  30917. <summary>
  30918. Removes the first occurrence in this list of the specified
  30919. element (optional operation). If this list does not contain
  30920. the element, it is unChanged. More formally, Removes the
  30921. element with the lowest index i such that (o.Equals(get(i)))
  30922. (if such an element exists).
  30923. </summary>
  30924. <param name="o">element to be Removed from this list, if present.</param>
  30925. <returns>return true if this list Contained the specified element.</returns>
  30926. </member>
  30927. <member name="M:NPOI.Util.ShortList.RemoveAll(NPOI.Util.ShortList)">
  30928. <summary>
  30929. Removes from this list all the elements that are Contained in the specified collection
  30930. </summary>
  30931. <param name="c">collection that defines which elements will be removed from this list.</param>
  30932. <returns>return true if this list Changed as a result of the call.</returns>
  30933. </member>
  30934. <member name="M:NPOI.Util.ShortList.RetainAll(NPOI.Util.ShortList)">
  30935. <summary>
  30936. Retains only the elements in this list that are Contained in
  30937. the specified collection. In other words, Removes from this
  30938. list all the elements that are not Contained in the specified
  30939. collection.
  30940. </summary>
  30941. <param name="c">collection that defines which elements this Set will retain.</param>
  30942. <returns>return true if this list Changed as a result of the call.</returns>
  30943. </member>
  30944. <member name="M:NPOI.Util.ShortList.Set(System.Int32,System.Int16)">
  30945. <summary>
  30946. Replaces the element at the specified position in this list with the specified element
  30947. </summary>
  30948. <param name="index">index of element to Replace.</param>
  30949. <param name="element">element to be stored at the specified position.</param>
  30950. <returns>return the element previously at the specified position.</returns>
  30951. </member>
  30952. <member name="M:NPOI.Util.ShortList.Size">
  30953. <summary>
  30954. Returns the number of elements in this list. If this list
  30955. Contains more than Int32.MaxValue elements, returns
  30956. Int32.MaxValue.
  30957. </summary>
  30958. <returns>return the number of elements in this shortList</returns>
  30959. </member>
  30960. <member name="P:NPOI.Util.ShortList.Count">
  30961. <summary>
  30962. the number of elements in this shortList
  30963. </summary>
  30964. </member>
  30965. <member name="M:NPOI.Util.ShortList.ToArray">
  30966. <summary>
  30967. Returns an array Containing all of the elements in this list in
  30968. proper sequence. Obeys the general contract of the
  30969. Collection.ToArray method.
  30970. </summary>
  30971. <returns>an array Containing all of the elements in this list in
  30972. proper sequence.</returns>
  30973. </member>
  30974. <member name="M:NPOI.Util.ShortList.ToArray(System.Int16[])">
  30975. <summary>
  30976. Returns an array Containing all of the elements in this list in
  30977. proper sequence. Obeys the general contract of the
  30978. Collection.ToArray(Object[]) method.
  30979. </summary>
  30980. <param name="a">the array into which the elements of this list are to
  30981. be stored, if it is big enough; otherwise, a new array
  30982. is allocated for this purpose.</param>
  30983. <returns>return an array Containing the elements of this list.</returns>
  30984. </member>
  30985. <member name="T:NPOI.Util.StringUtil">
  30986. <summary>
  30987. Title: String Utility Description: Collection of string handling utilities
  30988. @author Andrew C. Oliver
  30989. @author Sergei Kozello (sergeikozello at mail.ru)
  30990. @author Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp)
  30991. @since May 10, 2002
  30992. @version 1.0
  30993. </summary>
  30994. </member>
  30995. <member name="M:NPOI.Util.StringUtil.#ctor">
  30996. Constructor for the StringUtil object
  30997. </member>
  30998. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[],System.Int32,System.Int32)">
  30999. <summary>
  31000. Given a byte array of 16-bit unicode characters in Little Endian
  31001. Format (most important byte last), return a Java String representation
  31002. of it.
  31003. { 0x16, 0x00 } -0x16
  31004. </summary>
  31005. <param name="str">the byte array to be converted</param>
  31006. <param name="offset">the initial offset into the
  31007. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  31008. <param name="len">the Length of the string</param>
  31009. <returns>the converted string</returns>
  31010. </member>
  31011. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeLE(System.Byte[])">
  31012. <summary>
  31013. Given a byte array of 16-bit unicode characters in little endian
  31014. Format (most important byte last), return a Java String representation
  31015. of it.
  31016. { 0x16, 0x00 } -0x16
  31017. </summary>
  31018. <param name="str">the byte array to be converted</param>
  31019. <returns>the converted string</returns>
  31020. </member>
  31021. <member name="M:NPOI.Util.StringUtil.GetToUnicodeLE(System.String)">
  31022. Convert String to 16-bit unicode characters in little endian format
  31023. @param string the string
  31024. @return the byte array of 16-bit unicode characters
  31025. </member>
  31026. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[],System.Int32,System.Int32)">
  31027. <summary>
  31028. Given a byte array of 16-bit unicode characters in big endian
  31029. Format (most important byte first), return a Java String representation
  31030. of it.
  31031. { 0x00, 0x16 } -0x16
  31032. </summary>
  31033. <param name="str">the byte array to be converted</param>
  31034. <param name="offset">the initial offset into the
  31035. byte array. it is assumed that string[ offset ] and string[ offset + 1 ] contain the first 16-bit unicode character</param>
  31036. <param name="len">the Length of the string</param>
  31037. <returns> the converted string</returns>
  31038. </member>
  31039. <member name="M:NPOI.Util.StringUtil.GetFromUnicodeBE(System.Byte[])">
  31040. <summary>
  31041. Given a byte array of 16-bit unicode characters in big endian
  31042. Format (most important byte first), return a Java String representation
  31043. of it.
  31044. { 0x00, 0x16 } -0x16
  31045. </summary>
  31046. <param name="str">the byte array to be converted</param>
  31047. <returns>the converted string</returns>
  31048. </member>
  31049. <member name="M:NPOI.Util.StringUtil.GetFromCompressedUnicode(System.Byte[],System.Int32,System.Int32)">
  31050. <summary>
  31051. Read 8 bit data (in IsO-8859-1 codepage) into a (unicode) Java
  31052. String and return.
  31053. (In Excel terms, read compressed 8 bit unicode as a string)
  31054. </summary>
  31055. <param name="str">byte array to read</param>
  31056. <param name="offset">offset to read byte array</param>
  31057. <param name="len">Length to read byte array</param>
  31058. <returns>generated String instance by reading byte array</returns>
  31059. </member>
  31060. <member name="M:NPOI.Util.StringUtil.PutCompressedUnicode(System.String,System.Byte[],System.Int32)">
  31061. <summary>
  31062. Takes a unicode (java) string, and returns it as 8 bit data (in IsO-8859-1
  31063. codepage).
  31064. (In Excel terms, write compressed 8 bit unicode)
  31065. </summary>
  31066. <param name="input">the String containing the data to be written</param>
  31067. <param name="output">the byte array to which the data Is to be written</param>
  31068. <param name="offset">an offset into the byte arrat at which the data Is start when written</param>
  31069. </member>
  31070. <member name="M:NPOI.Util.StringUtil.PutUnicodeLE(System.String,System.Byte[],System.Int32)">
  31071. <summary>
  31072. Takes a unicode string, and returns it as little endian (most
  31073. important byte last) bytes in the supplied byte array.
  31074. (In Excel terms, write uncompressed unicode)
  31075. </summary>
  31076. <param name="input">the String containing the unicode data to be written</param>
  31077. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String</param>
  31078. <param name="offset">the offset to start writing into the byte array</param>
  31079. </member>
  31080. <member name="M:NPOI.Util.StringUtil.PutUnicodeBE(System.String,System.Byte[],System.Int32)">
  31081. <summary>
  31082. Takes a unicode string, and returns it as big endian (most
  31083. important byte first) bytes in the supplied byte array.
  31084. (In Excel terms, write uncompressed unicode)
  31085. </summary>
  31086. <param name="input">the String containing the unicode data to be written</param>
  31087. <param name="output">the byte array to hold the uncompressed unicode, should be twice the Length of the String.</param>
  31088. <param name="offset">the offset to start writing into the byte array</param>
  31089. </member>
  31090. <member name="M:NPOI.Util.StringUtil.GetPreferredEncoding">
  31091. <summary>
  31092. Gets the preferred encoding.
  31093. </summary>
  31094. <returns>the encoding we want to use, currently hardcoded to IsO-8859-1</returns>
  31095. </member>
  31096. <member name="M:NPOI.Util.StringUtil.HasMultibyte(System.String)">
  31097. <summary>
  31098. check the parameter Has multibyte character
  31099. </summary>
  31100. <param name="value"> string to check</param>
  31101. <returns>
  31102. <c>true</c> if Has at least one multibyte character; otherwise, <c>false</c>.
  31103. </returns>
  31104. </member>
  31105. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput)">
  31106. InputStream <c>in</c> is expected to contain:
  31107. <ol>
  31108. <li>ushort nChars</li>
  31109. <li>byte is16BitFlag</li>
  31110. <li>byte[]/char[] characterData</li>
  31111. </ol>
  31112. For this encoding, the is16BitFlag is always present even if nChars==0.
  31113. </member>
  31114. <member name="M:NPOI.Util.StringUtil.ReadUnicodeString(NPOI.Util.ILittleEndianInput,System.Int32)">
  31115. InputStream <c>in</c> is expected to contain:
  31116. <ol>
  31117. <li>byte is16BitFlag</li>
  31118. <li>byte[]/char[] characterData</li>
  31119. </ol>
  31120. For this encoding, the is16BitFlag is always present even if nChars==0.
  31121. <br/>
  31122. This method should be used when the nChars field is <em>not</em> stored
  31123. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  31124. #readUnicodeString(LittleEndianInput)} can be used.
  31125. </member>
  31126. <member name="M:NPOI.Util.StringUtil.WriteUnicodeString(NPOI.Util.ILittleEndianOutput,System.String)">
  31127. OutputStream <c>out</c> will get:
  31128. <ol>
  31129. <li>ushort nChars</li>
  31130. <li>byte is16BitFlag</li>
  31131. <li>byte[]/char[] characterData</li>
  31132. </ol>
  31133. For this encoding, the is16BitFlag is always present even if nChars==0.
  31134. </member>
  31135. <member name="M:NPOI.Util.StringUtil.WriteUnicodeStringFlagAndData(NPOI.Util.ILittleEndianOutput,System.String)">
  31136. OutputStream <c>out</c> will get:
  31137. <ol>
  31138. <li>byte is16BitFlag</li>
  31139. <li>byte[]/char[] characterData</li>
  31140. </ol>
  31141. For this encoding, the is16BitFlag is always present even if nChars==0.
  31142. <br/>
  31143. This method should be used when the nChars field is <em>not</em> stored
  31144. as a ushort immediately before the is16BitFlag. Otherwise, {@link
  31145. #writeUnicodeString(LittleEndianOutput, String)} can be used.
  31146. </member>
  31147. <member name="M:NPOI.Util.StringUtil.GetEncodedSize(System.String)">
  31148. <summary>
  31149. Gets the number of bytes that would be written by WriteUnicodeString(LittleEndianOutput, String)
  31150. </summary>
  31151. <param name="value">The value.</param>
  31152. <returns></returns>
  31153. </member>
  31154. <member name="M:NPOI.Util.StringUtil.IsUnicodeString(System.String)">
  31155. <summary>
  31156. Checks to see if a given String needs to be represented as Unicode
  31157. </summary>
  31158. <param name="value">The value.</param>
  31159. <returns>
  31160. <c>true</c> if string needs Unicode to be represented.; otherwise, <c>false</c>.
  31161. </returns>
  31162. <remarks>Tony Qu change the logic</remarks>
  31163. </member>
  31164. <member name="M:NPOI.Util.StringUtil.ToHexString(System.String)">
  31165. <summary>
  31166. Encodes non-US-ASCII characters in a string, good for encoding file names for download
  31167. http://www.acriticsreview.com/List.aspx?listid=42
  31168. </summary>
  31169. <param name="s"></param>
  31170. <returns></returns>
  31171. </member>
  31172. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Char)">
  31173. <summary>
  31174. Encodes a non-US-ASCII character.
  31175. </summary>
  31176. <param name="chr"></param>
  31177. <returns></returns>
  31178. </member>
  31179. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int16)">
  31180. <summary>
  31181. Encodes a non-US-ASCII character.
  31182. </summary>
  31183. <param name="chr"></param>
  31184. <returns></returns>
  31185. </member>
  31186. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int32)">
  31187. <summary>
  31188. Encodes a non-US-ASCII character.
  31189. </summary>
  31190. <param name="chr"></param>
  31191. <returns></returns>
  31192. </member>
  31193. <member name="M:NPOI.Util.StringUtil.ToHexString(System.Int64)">
  31194. <summary>
  31195. Encodes a non-US-ASCII character.
  31196. </summary>
  31197. <param name="chr"></param>
  31198. <returns></returns>
  31199. </member>
  31200. <member name="M:NPOI.Util.StringUtil.NeedToEncode(System.Char)">
  31201. <summary>
  31202. Determines if the character needs to be encoded.
  31203. http://www.acriticsreview.com/List.aspx?listid=42
  31204. </summary>
  31205. <param name="chr"></param>
  31206. <returns></returns>
  31207. </member>
  31208. <member name="M:NPOI.Util.StringUtil.mapMsCodepointString(System.String)">
  31209. Some strings may contain encoded characters of the unicode private use area.
  31210. Currently the characters of the symbol fonts are mapped to the corresponding
  31211. characters in the normal unicode range.
  31212. @param string the original string
  31213. @return the string with mapped characters
  31214. @see <a href="http://www.alanwood.net/unicode/private_use_area.html#symbol">Private Use Area (symbol)</a>
  31215. @see <a href="http://www.alanwood.net/demos/symbol.html">Symbol font - Unicode alternatives for Greek and special characters in HTML</a>
  31216. </member>
  31217. <member name="F:NPOI.Util.StringUtil.MIN_HIGH_SURROGATE">
  31218. The minimum value of a
  31219. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  31220. Unicode high-surrogate code unit</a>
  31221. in the UTF-16 encoding, constant {@code '\u005CuD800'}.
  31222. A high-surrogate is also known as a <i>leading-surrogate</i>.
  31223. @since 1.5
  31224. </member>
  31225. <member name="F:NPOI.Util.StringUtil.MAX_HIGH_SURROGATE">
  31226. The maximum value of a
  31227. <a href="http://www.unicode.org/glossary/#high_surrogate_code_unit">
  31228. Unicode high-surrogate code unit</a>
  31229. in the UTF-16 encoding, constant {@code '\u005CuDBFF'}.
  31230. A high-surrogate is also known as a <i>leading-surrogate</i>.
  31231. @since 1.5
  31232. </member>
  31233. <member name="F:NPOI.Util.StringUtil.MIN_LOW_SURROGATE">
  31234. The minimum value of a
  31235. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  31236. Unicode low-surrogate code unit</a>
  31237. in the UTF-16 encoding, constant {@code '\u005CuDC00'}.
  31238. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  31239. @since 1.5
  31240. </member>
  31241. <member name="F:NPOI.Util.StringUtil.MAX_LOW_SURROGATE">
  31242. The maximum value of a
  31243. <a href="http://www.unicode.org/glossary/#low_surrogate_code_unit">
  31244. Unicode low-surrogate code unit</a>
  31245. in the UTF-16 encoding, constant {@code '\u005CuDFFF'}.
  31246. A low-surrogate is also known as a <i>trailing-surrogate</i>.
  31247. @since 1.5
  31248. </member>
  31249. <member name="M:NPOI.Util.StringUtil.toCodePoint(System.Char,System.Char)">
  31250. Converts the specified surrogate pair to its supplementary code
  31251. point value. This method does not validate the specified
  31252. surrogate pair. The caller must validate it using {@link
  31253. #isSurrogatePair(char, char) isSurrogatePair} if necessary.
  31254. @param high the high-surrogate code unit
  31255. @param low the low-surrogate code unit
  31256. @return the supplementary code point composed from the
  31257. specified surrogate pair.
  31258. @since 1.5
  31259. </member>
  31260. <member name="M:NPOI.Util.StringUtil.CharCount(System.Int32)">
  31261. Determines the number of {@code char} values needed to
  31262. represent the specified character (Unicode code point). If the
  31263. specified character is equal to or greater than 0x10000, then
  31264. the method returns 2. Otherwise, the method returns 1.
  31265. This method doesn't validate the specified character to be a
  31266. valid Unicode code point. The caller must validate the
  31267. character value using {@link #isValidCodePoint(int) isValidCodePoint}
  31268. if necessary.
  31269. @param codePoint the character (Unicode code point) to be tested.
  31270. @return 2 if the character is a valid supplementary character; 1 otherwise.
  31271. @see Character#isSupplementaryCodePoint(int)
  31272. @since 1.5
  31273. </member>
  31274. <member name="T:NPOI.Util.SystemOutLogger">
  31275. <summary>
  31276. A logger class that strives to make it as easy as possible for
  31277. developers to write log calls, while simultaneously making those
  31278. calls as cheap as possible by performing lazy Evaluation of the log
  31279. message.
  31280. </summary>
  31281. <remarks>
  31282. @author Marc Johnson (mjohnson at apache dot org)
  31283. @author Glen Stampoultzis (glens at apache.org)
  31284. @author Nicola Ken Barozzi (nicolaken at apache.org)
  31285. </remarks>
  31286. </member>
  31287. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object)">
  31288. <summary>
  31289. Log a message
  31290. </summary>
  31291. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  31292. <param name="obj1">The object to log.</param>
  31293. </member>
  31294. <member name="M:NPOI.Util.SystemOutLogger.Log(System.Int32,System.Object,System.Exception)">
  31295. <summary>
  31296. Log a message
  31297. </summary>
  31298. <param name="level"> One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  31299. <param name="obj1">The object to log. This is Converted to a string.</param>
  31300. <param name="exception">An exception to be logged</param>
  31301. </member>
  31302. <member name="M:NPOI.Util.SystemOutLogger.Check(System.Int32)">
  31303. <summary>
  31304. Check if a logger is enabled to log at the specified level
  31305. </summary>
  31306. <param name="level">One of DEBUG, INFO, WARN, ERROR, FATAL</param>
  31307. <returns></returns>
  31308. </member>
  31309. <member name="M:NPOI.Util.TempFile.CreateTempFile(System.String,System.String)">
  31310. Creates a temporary file. Files are collected into one directory and by default are
  31311. deleted on exit from the VM. Files can be kept by defining the system property
  31312. <c>poi.keep.tmp.files</c>.
  31313. Dont forget to close all files or it might not be possible to delete them.
  31314. </member>
  31315. <member name="T:NPOI.Util.ULongField">
  31316. <summary>
  31317. </summary>
  31318. </member>
  31319. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32)">
  31320. <summary>
  31321. construct the <see cref="T:NPOI.Util.LongField"/> with its offset into its containing byte array
  31322. </summary>
  31323. <param name="offset">The offset.</param>
  31324. </member>
  31325. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64)">
  31326. <summary>
  31327. construct the LongField with its offset into its containing
  31328. byte array and initialize its value
  31329. </summary>
  31330. <param name="offset">offset of the field within its byte array</param>
  31331. <param name="value">the initial value</param>
  31332. </member>
  31333. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.Byte[])">
  31334. <summary>
  31335. Construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  31336. byte array and initialize its value from its byte array
  31337. </summary>
  31338. <param name="offset">The offset of the field within its byte array</param>
  31339. <param name="data">the byte array to read the value from</param>
  31340. </member>
  31341. <member name="M:NPOI.Util.ULongField.#ctor(System.Int32,System.UInt64,System.Byte[])">
  31342. <summary>
  31343. construct the <see cref="T:NPOI.Util.LongField"/> class with its offset into its containing
  31344. byte array, initialize its value, and write the value to a byte
  31345. array
  31346. </summary>
  31347. <param name="offset">offset of the field within its byte array</param>
  31348. <param name="value">the initial value</param>
  31349. <param name="data">the byte array to write the value to</param>
  31350. </member>
  31351. <member name="P:NPOI.Util.ULongField.Value">
  31352. <summary>
  31353. Getg or sets the LongField's current value
  31354. </summary>
  31355. <value>The current value</value>
  31356. </member>
  31357. <member name="M:NPOI.Util.ULongField.Set(System.UInt64,System.Byte[])">
  31358. <summary>
  31359. set the LongField's current value and write it to a byte array
  31360. </summary>
  31361. <param name="value">value to be set</param>
  31362. <param name="data">the byte array to write the value to</param>
  31363. </member>
  31364. <member name="M:NPOI.Util.ULongField.ReadFromBytes(System.Byte[])">
  31365. <summary>
  31366. set the value from its offset into an array of bytes
  31367. </summary>
  31368. <param name="data">the byte array from which the value is to be read</param>
  31369. </member>
  31370. <member name="M:NPOI.Util.ULongField.ReadFromStream(System.IO.Stream)">
  31371. <summary>
  31372. set the value from an Stream
  31373. </summary>
  31374. <param name="stream">the Stream from which the value is to be</param>
  31375. </member>
  31376. <member name="M:NPOI.Util.ULongField.WriteToBytes(System.Byte[])">
  31377. <summary>
  31378. write the value out to an array of bytes at the appropriate offset
  31379. </summary>
  31380. <param name="data">the array of bytes to which the value is to be written</param>
  31381. </member>
  31382. <member name="M:NPOI.Util.ULongField.ToString">
  31383. <summary>
  31384. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31385. </summary>
  31386. <returns>
  31387. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  31388. </returns>
  31389. </member>
  31390. <member name="T:NPOI.Util.Units">
  31391. @author Yegor Kozlov
  31392. </member>
  31393. <member name="M:NPOI.Util.Units.FixedPointToDecimal(System.Int32)">
  31394. Converts a value of type FixedPoint to a decimal number
  31395. @param fixedPoint
  31396. @return decimal number
  31397. @see <a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a>
  31398. </member>
  31399. <member name="T:NPOI.SS.Extractor.IExcelExtractor">
  31400. Common interface for Excel text extractors, covering
  31401. HSSF and XSSF
  31402. </member>
  31403. <member name="P:NPOI.SS.Extractor.IExcelExtractor.Text">
  31404. Retreives the text contents of the file
  31405. </member>
  31406. <member name="T:NPOI.SS.Format.CellDateFormatter">
  31407. Formats a date value.
  31408. @author Ken Arnold, Industrious Media LLC
  31409. </member>
  31410. <member name="M:NPOI.SS.Format.CellDateFormatter.#ctor(System.String)">
  31411. Creates a new date formatter with the given specification.
  31412. @param format The format.
  31413. </member>
  31414. <member name="M:NPOI.SS.Format.CellDateFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31415. {@inheritDoc}
  31416. </member>
  31417. <member name="M:NPOI.SS.Format.CellDateFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31418. {@inheritDoc}
  31419. <p/>
  31420. For a date, this is <tt>"mm/d/y"</tt>.
  31421. </member>
  31422. <member name="T:NPOI.SS.Format.CellElapsedFormatter">
  31423. This class : printing out an elapsed time format.
  31424. @author Ken Arnold, Industrious Media LLC
  31425. </member>
  31426. <member name="M:NPOI.SS.Format.CellElapsedFormatter.#ctor(System.String)">
  31427. Creates a elapsed time formatter.
  31428. @param pattern The pattern to Parse.
  31429. </member>
  31430. <member name="M:NPOI.SS.Format.CellElapsedFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31431. {@inheritDoc}
  31432. </member>
  31433. <member name="M:NPOI.SS.Format.CellElapsedFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31434. {@inheritDoc}
  31435. <p/>
  31436. For a date, this is <tt>"mm/d/y"</tt>.
  31437. </member>
  31438. <member name="T:NPOI.SS.Format.CellFormat">
  31439. Format a value according to the standard Excel behavior. This "standard" is
  31440. not explicitly documented by Microsoft, so the behavior is determined by
  31441. experimentation; see the tests.
  31442. An Excel format has up to four parts, Separated by semicolons. Each part
  31443. specifies what to do with particular kinds of values, depending on the number
  31444. of parts given:
  31445. - One part (example: <c>[Green]#.##</c>)
  31446. If the value is a number, display according to this one part (example: green text,
  31447. with up to two decimal points). If the value is text, display it as is.
  31448. - Two parts (example: <c>[Green]#.##;[Red]#.##</c>)
  31449. If the value is a positive number or zero, display according to the first part (example: green
  31450. text, with up to two decimal points); if it is a negative number, display
  31451. according to the second part (example: red text, with up to two decimal
  31452. points). If the value is text, display it as is.
  31453. - Three parts (example: <c>[Green]#.##;[Black]#.##;[Red]#.##</c>)
  31454. If the value is a positive number, display according to the first part (example: green text, with up to
  31455. two decimal points); if it is zero, display according to the second part
  31456. (example: black text, with up to two decimal points); if it is a negative
  31457. number, display according to the third part (example: red text, with up to
  31458. two decimal points). If the value is text, display it as is.
  31459. - Four parts (example: <c>[Green]#.##;[Black]#.##;[Red]#.##;[@]</c>)
  31460. If the value is a positive number, display according to the first part (example: green text,
  31461. with up to two decimal points); if it is zero, display according to the
  31462. second part (example: black text, with up to two decimal points); if it is a
  31463. negative number, display according to the third part (example: red text, with
  31464. up to two decimal points). If the value is text, display according to the
  31465. fourth part (example: text in the cell's usual color, with the text value
  31466. surround by brackets).
  31467. In Addition to these, there is a general format that is used when no format
  31468. is specified. This formatting is presented by the {@link #GENERAL_FORMAT}
  31469. object.
  31470. @author Ken Arnold, Industrious Media LLC
  31471. </member>
  31472. <member name="T:NPOI.SS.Format.CellFormat.GeneralCellFormat">
  31473. Format a value as it would be were no format specified. This is also
  31474. used when the format specified is <tt>General</tt>.
  31475. </member>
  31476. <member name="F:NPOI.SS.Format.CellFormat.formatCache">
  31477. Maps a format string to its Parsed version for efficiencies sake.
  31478. </member>
  31479. <member name="M:NPOI.SS.Format.CellFormat.GetInstance(System.String)">
  31480. Returns a {@link CellFormat} that applies the given format. Two calls
  31481. with the same format may or may not return the same object.
  31482. @param format The format.
  31483. @return A {@link CellFormat} that applies the given format.
  31484. </member>
  31485. <member name="M:NPOI.SS.Format.CellFormat.#ctor(System.String)">
  31486. Creates a new object.
  31487. @param format The format.
  31488. </member>
  31489. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.Object)">
  31490. Returns the result of Applying the format to the given value. If the
  31491. value is a number (a type of {@link Number} object), the correct number
  31492. format type is chosen; otherwise it is considered a text object.
  31493. @param value The value
  31494. @return The result, in a {@link CellFormatResult}.
  31495. </member>
  31496. <member name="M:NPOI.SS.Format.CellFormat.Apply(System.DateTime,System.Double)">
  31497. Returns the result of applying the format to the given date.
  31498. @param date The date.
  31499. @param numericValue The numeric value for the date.
  31500. @return The result, in a {@link CellFormatResult}.
  31501. </member>
  31502. <member name="M:NPOI.SS.Format.CellFormat.Apply(NPOI.SS.UserModel.ICell)">
  31503. Fetches the appropriate value from the cell, and returns the result of
  31504. Applying it to the appropriate format. For formula cells, the computed
  31505. value is what is used.
  31506. @param c The cell.
  31507. @return The result, in a {@link CellFormatResult}.
  31508. </member>
  31509. <member name="M:NPOI.SS.Format.CellFormat.GetApplicableFormatPart(System.Object)">
  31510. Returns the {@link CellFormatPart} that applies to the value. Result
  31511. depends on how many parts the cell format has, the cell value and any
  31512. conditions. The value must be a {@link Number}.
  31513. @param value The value.
  31514. @return The {@link CellFormatPart} that applies to the value.
  31515. </member>
  31516. <member name="M:NPOI.SS.Format.CellFormat.UltimateType(NPOI.SS.UserModel.ICell)">
  31517. Returns the ultimate cell type, following the results of formulas. If
  31518. the cell is a {@link Cell#CELL_TYPE_FORMULA}, this returns the result of
  31519. {@link Cell#getCachedFormulaResultType()}. Otherwise this returns the
  31520. result of {@link Cell#getCellType()}.
  31521. @param cell The cell.
  31522. @return The ultimate type of this cell.
  31523. </member>
  31524. <member name="M:NPOI.SS.Format.CellFormat.Equals(System.Object)">
  31525. Returns <tt>true</tt> if the other object is a {@link CellFormat} object
  31526. with the same format.
  31527. @param obj The other object.
  31528. @return <tt>true</tt> if the two objects are Equal.
  31529. </member>
  31530. <member name="M:NPOI.SS.Format.CellFormat.GetHashCode">
  31531. Returns a hash code for the format.
  31532. @return A hash code for the format.
  31533. </member>
  31534. <member name="T:NPOI.SS.Format.CellFormatCondition">
  31535. This object represents a condition in a cell format.
  31536. @author Ken Arnold, Industrious Media LLC
  31537. </member>
  31538. <member name="M:NPOI.SS.Format.CellFormatCondition.GetInstance(System.String,System.String)">
  31539. Returns an instance of a condition object.
  31540. @param opString The operator as a string. One of <tt>"&lt;"</tt>,
  31541. <tt>"&lt;="</tt>, <tt>">"</tt>, <tt>">="</tt>,
  31542. <tt>"="</tt>, <tt>"=="</tt>, <tt>"!="</tt>, or
  31543. <tt>"&lt;>"</tt>.
  31544. @param constStr The constant (such as <tt>"12"</tt>).
  31545. @return A condition object for the given condition.
  31546. </member>
  31547. <member name="M:NPOI.SS.Format.CellFormatCondition.Pass(System.Double)">
  31548. Returns <tt>true</tt> if the given value passes the constraint's test.
  31549. @param value The value to compare against.
  31550. @return <tt>true</tt> if the given value passes the constraint's test.
  31551. </member>
  31552. <member name="T:NPOI.SS.Format.CellFormatPart">
  31553. Objects of this class represent a single part of a cell format expression.
  31554. Each cell can have up to four of these for positive, zero, negative, and text
  31555. values.
  31556. <p/>
  31557. Each format part can contain a color, a condition, and will always contain a
  31558. format specification. For example <tt>"[Red][>=10]#"</tt> has a color
  31559. (<tt>[Red]</tt>), a condition (<tt>>=10</tt>) and a format specification
  31560. (<tt>#</tt>).
  31561. <p/>
  31562. This class also Contains patterns for matching the subparts of format
  31563. specification. These are used internally, but are made public in case other
  31564. code has use for them.
  31565. @author Ken Arnold, Industrious Media LLC
  31566. </member>
  31567. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_PAT">
  31568. Pattern for the color part of a cell format part.
  31569. </member>
  31570. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_PAT">
  31571. Pattern for the condition part of a cell format part.
  31572. </member>
  31573. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_PAT">
  31574. Pattern for the format specification part of a cell format part.
  31575. </member>
  31576. <member name="F:NPOI.SS.Format.CellFormatPart.FORMAT_PAT">
  31577. Pattern for an entire cell single part.
  31578. </member>
  31579. <member name="F:NPOI.SS.Format.CellFormatPart.COLOR_GROUP">
  31580. Within {@link #FORMAT_PAT}, the group number for the matched color.
  31581. </member>
  31582. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_OPERATOR_GROUP">
  31583. Within {@link #FORMAT_PAT}, the group number for the operator in the
  31584. condition.
  31585. </member>
  31586. <member name="F:NPOI.SS.Format.CellFormatPart.CONDITION_VALUE_GROUP">
  31587. Within {@link #FORMAT_PAT}, the group number for the value in the
  31588. condition.
  31589. </member>
  31590. <member name="F:NPOI.SS.Format.CellFormatPart.SPECIFICATION_GROUP">
  31591. Within {@link #FORMAT_PAT}, the group number for the format
  31592. specification.
  31593. </member>
  31594. <member name="M:NPOI.SS.Format.CellFormatPart.#ctor(System.String)">
  31595. Create an object to represent a format part.
  31596. @param desc The string to Parse.
  31597. </member>
  31598. <member name="M:NPOI.SS.Format.CellFormatPart.Applies(System.Object)">
  31599. Returns <tt>true</tt> if this format part applies to the given value. If
  31600. the value is a number and this is part has a condition, returns
  31601. <tt>true</tt> only if the number passes the condition. Otherwise, this
  31602. allways return <tt>true</tt>.
  31603. @param valueObject The value to Evaluate.
  31604. @return <tt>true</tt> if this format part applies to the given value.
  31605. </member>
  31606. <member name="M:NPOI.SS.Format.CellFormatPart.FindGroup(System.Text.RegularExpressions.Regex,System.String,System.String)">
  31607. Returns the number of the first group that is the same as the marker
  31608. string. The search starts with group 1.
  31609. @param pat The pattern to use.
  31610. @param str The string to match against the pattern.
  31611. @param marker The marker value to find the group of.
  31612. @return The matching group number.
  31613. @throws ArgumentException No group matches the marker.
  31614. </member>
  31615. <member name="M:NPOI.SS.Format.CellFormatPart.GetColor(System.Text.RegularExpressions.Match)">
  31616. Returns the color specification from the matcher, or <tt>null</tt> if
  31617. there is none.
  31618. @param m The matcher for the format part.
  31619. @return The color specification or <tt>null</tt>.
  31620. </member>
  31621. <member name="M:NPOI.SS.Format.CellFormatPart.GetCondition(System.Text.RegularExpressions.Match)">
  31622. Returns the condition specification from the matcher, or <tt>null</tt> if
  31623. there is none.
  31624. @param m The matcher for the format part.
  31625. @return The condition specification or <tt>null</tt>.
  31626. </member>
  31627. <member name="M:NPOI.SS.Format.CellFormatPart.GetCellFormatType(System.Text.RegularExpressions.Match)">
  31628. Returns the CellFormatType object implied by the format specification for
  31629. the format part.
  31630. @param matcher The matcher for the format part.
  31631. @return The CellFormatType.
  31632. </member>
  31633. <member name="M:NPOI.SS.Format.CellFormatPart.GetFormatter(System.Text.RegularExpressions.Match)">
  31634. Returns the formatter object implied by the format specification for the
  31635. format part.
  31636. @param matcher The matcher for the format part.
  31637. @return The formatter.
  31638. </member>
  31639. <member name="M:NPOI.SS.Format.CellFormatPart.formatType(System.String)">
  31640. Returns the type of format.
  31641. @param fdesc The format specification
  31642. @return The type of format.
  31643. </member>
  31644. <member name="M:NPOI.SS.Format.CellFormatPart.QuoteSpecial(System.String,NPOI.SS.Format.CellFormatType)">
  31645. Returns a version of the original string that has any special characters
  31646. quoted (or escaped) as appropriate for the cell format type. The format
  31647. type object is queried to see what is special.
  31648. @param repl The original string.
  31649. @param type The format type representation object.
  31650. @return A version of the string with any special characters Replaced.
  31651. @see CellFormatType#isSpecial(char)
  31652. </member>
  31653. <member name="M:NPOI.SS.Format.CellFormatPart.Apply(System.Object)">
  31654. Apply this format part to the given value. This returns a {@link
  31655. CellFormatResult} object with the results.
  31656. @param value The value to apply this format part to.
  31657. @return A {@link CellFormatResult} object Containing the results of
  31658. Applying the format to the value.
  31659. </member>
  31660. <member name="P:NPOI.SS.Format.CellFormatPart.CellFormatType">
  31661. Returns the CellFormatType object implied by the format specification for
  31662. the format part.
  31663. @return The CellFormatType.
  31664. </member>
  31665. <member name="P:NPOI.SS.Format.CellFormatPart.HasCondition">
  31666. Returns <tt>true</tt> if this format part has a condition.
  31667. @return <tt>true</tt> if this format part has a condition.
  31668. </member>
  31669. <member name="M:NPOI.SS.Format.CellFormatPart.ExpandChar(System.String)">
  31670. Expands a character. This is only partly done, because we don't have the
  31671. correct info. In Excel, this would be expanded to fill the rest of the
  31672. cell, but we don't know, in general, what the "rest of the cell" is1.
  31673. @param part The character to be repeated is the second character in this
  31674. string.
  31675. @return The character repeated three times.
  31676. </member>
  31677. <member name="M:NPOI.SS.Format.CellFormatPart.Group(System.Text.RegularExpressions.Match,System.Int32)">
  31678. Returns the string from the group, or <tt>""</tt> if the group is
  31679. <tt>null</tt>.
  31680. @param m The matcher.
  31681. @param g The group number.
  31682. @return The group or <tt>""</tt>.
  31683. </member>
  31684. <member name="T:NPOI.SS.Format.CellFormatResult">
  31685. This object Contains the result of Applying a cell format or cell format part
  31686. to a value.
  31687. @author Ken Arnold, Industrious Media LLC
  31688. @see CellFormatPart#Apply(Object)
  31689. @see CellFormat#Apply(Object)
  31690. </member>
  31691. <member name="P:NPOI.SS.Format.CellFormatResult.Applies">
  31692. This is <tt>true</tt> if no condition was given that applied to the
  31693. value, or if the condition is satisfied. If a condition is relevant, and
  31694. when applied the value fails the test, this is <tt>false</tt>.
  31695. </member>
  31696. <member name="P:NPOI.SS.Format.CellFormatResult.Text">
  31697. The resulting text. This will never be <tt>null</tt>.
  31698. </member>
  31699. <member name="P:NPOI.SS.Format.CellFormatResult.TextColor">
  31700. The color the format Sets, or <tt>null</tt> if the format Sets no color.
  31701. This will always be <tt>null</tt> if {@link #applies} is <tt>false</tt>.
  31702. </member>
  31703. <member name="M:NPOI.SS.Format.CellFormatResult.#ctor(System.Boolean,System.String,System.Drawing.Color)">
  31704. Creates a new format result object.
  31705. @param applies The value for {@link #applies}.
  31706. @param text The value for {@link #text}.
  31707. @param textColor The value for {@link #textColor}.
  31708. </member>
  31709. <member name="T:NPOI.SS.Format.CellFormatter">
  31710. This is the abstract supertype for the various cell formatters.
  31711. @author Ken Arnold, Industrious Media LLC
  31712. </member>
  31713. <member name="F:NPOI.SS.Format.CellFormatter.format">
  31714. The original specified format.
  31715. </member>
  31716. <member name="F:NPOI.SS.Format.CellFormatter.LOCALE">
  31717. This is the locale used to Get a consistent format result from which to
  31718. work.
  31719. </member>
  31720. <member name="M:NPOI.SS.Format.CellFormatter.#ctor(System.String)">
  31721. Creates a new formatter object, storing the format in {@link #format}.
  31722. @param format The format.
  31723. </member>
  31724. <member name="M:NPOI.SS.Format.CellFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31725. Format a value according the format string.
  31726. @param toAppendTo The buffer to append to.
  31727. @param value The value to format.
  31728. </member>
  31729. <member name="M:NPOI.SS.Format.CellFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31730. Format a value according to the type, in the most basic way.
  31731. @param toAppendTo The buffer to append to.
  31732. @param value The value to format.
  31733. </member>
  31734. <member name="M:NPOI.SS.Format.CellFormatter.Format(System.Object)">
  31735. Formats the value, returning the resulting string.
  31736. @param value The value to format.
  31737. @return The value, formatted.
  31738. </member>
  31739. <member name="M:NPOI.SS.Format.CellFormatter.SimpleFormat(System.Object)">
  31740. Formats the value in the most basic way, returning the resulting string.
  31741. @param value The value to format.
  31742. @return The value, formatted.
  31743. </member>
  31744. <member name="M:NPOI.SS.Format.CellFormatter.Quote(System.String)">
  31745. Returns the input string, surrounded by quotes.
  31746. @param str The string to quote.
  31747. @return The input string, surrounded by quotes.
  31748. </member>
  31749. <member name="T:NPOI.SS.Format.CellFormatType">
  31750. The different kinds of formats that the formatter understands.
  31751. @author Ken Arnold, Industrious Media LLC
  31752. </member>
  31753. <member name="F:NPOI.SS.Format.CellFormatType.GENERAL">
  31754. The general (default) format; also used for <tt>"General"</tt>.
  31755. </member>
  31756. <member name="F:NPOI.SS.Format.CellFormatType.NUMBER">
  31757. A numeric format.
  31758. </member>
  31759. <member name="F:NPOI.SS.Format.CellFormatType.DATE">
  31760. A date format.
  31761. </member>
  31762. <member name="F:NPOI.SS.Format.CellFormatType.ELAPSED">
  31763. An elapsed time format.
  31764. </member>
  31765. <member name="F:NPOI.SS.Format.CellFormatType.TEXT">
  31766. A text format.
  31767. </member>
  31768. <member name="M:NPOI.SS.Format.CellFormatType.IsSpecial(System.Char)">
  31769. Returns <tt>true</tt> if the format is special and needs to be quoted.
  31770. @param ch The character to test.
  31771. @return <tt>true</tt> if the format is special and needs to be quoted.
  31772. </member>
  31773. <member name="M:NPOI.SS.Format.CellFormatType.Formatter(System.String)">
  31774. Returns a new formatter of the appropriate type, for the given pattern.
  31775. The pattern must be appropriate for the type.
  31776. @param pattern The pattern to use.
  31777. @return A new formatter of the appropriate type, for the given pattern.
  31778. </member>
  31779. <member name="T:NPOI.SS.Format.CellGeneralFormatter">
  31780. A formatter for the default "General" cell format.
  31781. @author Ken Arnold, Industrious Media LLC
  31782. </member>
  31783. <member name="M:NPOI.SS.Format.CellGeneralFormatter.#ctor">
  31784. Creates a new general formatter.
  31785. </member>
  31786. <member name="M:NPOI.SS.Format.CellGeneralFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31787. The general style is not quite the same as any other, or any combination
  31788. of others.
  31789. @param toAppendTo The buffer to append to.
  31790. @param value The value to format.
  31791. </member>
  31792. <member name="M:NPOI.SS.Format.CellGeneralFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31793. Equivalent to {@link #formatValue(StringBuilder,Object)}. {@inheritDoc}.
  31794. </member>
  31795. <member name="T:NPOI.SS.Format.CellNumberFormatter">
  31796. This class : printing out a value using a number format.
  31797. @author Ken Arnold, Industrious Media LLC
  31798. </member>
  31799. <member name="T:NPOI.SS.Format.CellNumberFormatter.SimpleNumberCellFormatter">
  31800. <summary>
  31801. The CellNumberFormatter.simpleValue() method uses the SIMPLE_NUMBER
  31802. CellFormatter defined here. The CellFormat.GENERAL_FORMAT CellFormat
  31803. no longer uses the SIMPLE_NUMBER CellFormatter.
  31804. Note that the simpleValue()/SIMPLE_NUMBER CellFormatter format
  31805. ("#" for integer values, and "#.#" for floating-point values) is
  31806. different from the 'General' format for numbers ("#" for integer
  31807. values and "#.#########" for floating-point values).
  31808. </summary>
  31809. </member>
  31810. <member name="T:NPOI.SS.Format.CellNumberFormatter.Special">
  31811. This class is used to mark where the special characters in the format
  31812. are, as opposed to the other characters that are simply printed.
  31813. </member>
  31814. <member name="T:NPOI.SS.Format.CellNumberFormatter.StringMod">
  31815. This class represents a single modification to a result string. The way
  31816. this works is complicated, but so is numeric formatting. In general, for
  31817. most formats, we use a DecimalFormat object that will Put the string out
  31818. in a known format, usually with all possible leading and trailing zeros.
  31819. We then walk through the result and the orginal format, and note any
  31820. modifications that need to be made. Finally, we go through and apply
  31821. them all, dealing with overlapping modifications.
  31822. </member>
  31823. <member name="M:NPOI.SS.Format.CellNumberFormatter.#ctor(System.String)">
  31824. Creates a new cell number formatter.
  31825. @param format The format to Parse.
  31826. </member>
  31827. <member name="M:NPOI.SS.Format.CellNumberFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31828. {@inheritDoc}
  31829. </member>
  31830. <member name="M:NPOI.SS.Format.CellNumberFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31831. {@inheritDoc}
  31832. <p/>
  31833. For a number, this is <tt>"#"</tt> for integer values, and <tt>"#.#"</tt>
  31834. for floating-point values.
  31835. </member>
  31836. <member name="T:NPOI.SS.Format.CellTextFormatter">
  31837. This class : printing out text.
  31838. @author Ken Arnold, Industrious Media LLC
  31839. </member>
  31840. <member name="M:NPOI.SS.Format.CellTextFormatter.FormatValue(System.Text.StringBuilder,System.Object)">
  31841. {@inheritDoc}
  31842. </member>
  31843. <member name="M:NPOI.SS.Format.CellTextFormatter.SimpleValue(System.Text.StringBuilder,System.Object)">
  31844. {@inheritDoc}
  31845. <p/>
  31846. For text, this is just printing the text.
  31847. </member>
  31848. <member name="F:NPOI.SS.Format.SimpleFraction.denominator">
  31849. The denominator.
  31850. </member>
  31851. <member name="F:NPOI.SS.Format.SimpleFraction.numerator">
  31852. The numerator.
  31853. </member>
  31854. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionExactDenominator(System.Double,System.Int32)">
  31855. Create a fraction given a double value and a denominator.
  31856. @param val double value of fraction
  31857. @param exactDenom the exact denominator
  31858. @return a SimpleFraction with the given values set.
  31859. </member>
  31860. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Int32)">
  31861. Create a fraction given the double value and either the maximum error
  31862. allowed or the maximum number of denominator digits.
  31863. @param value the double value to convert to a fraction.
  31864. @param maxDenominator maximum denominator value allowed.
  31865. @throws RuntimeException if the continued fraction failed to
  31866. converge.
  31867. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  31868. </member>
  31869. <member name="M:NPOI.SS.Format.SimpleFraction.BuildFractionMaxDenominator(System.Double,System.Double,System.Int32,System.Int32)">
  31870. Create a fraction given the double value and either the maximum error
  31871. allowed or the maximum number of denominator digits.
  31872. <p>
  31873. References:
  31874. <ul>
  31875. <li><a href="http://mathworld.wolfram.com/ContinuedFraction.html">
  31876. Continued Fraction</a> equations (11) and (22)-(26)</li>
  31877. </ul>
  31878. </p>
  31879. Based on org.apache.commons.math.fraction.Fraction from Apache Commons-Math.
  31880. YK: The only reason of having this class is to avoid dependency on the Commons-Math jar.
  31881. @param value the double value to convert to a fraction.
  31882. @param epsilon maximum error allowed. The resulting fraction is within
  31883. <code>epsilon</code> of <code>value</code>, in absolute terms.
  31884. @param maxDenominator maximum denominator value allowed.
  31885. @param maxIterations maximum number of convergents
  31886. @throws RuntimeException if the continued fraction failed to
  31887. converge.
  31888. @throws IllegalArgumentException if value > Integer.MAX_VALUE
  31889. </member>
  31890. <member name="M:NPOI.SS.Format.SimpleFraction.#ctor(System.Int32,System.Int32)">
  31891. Create a fraction given a numerator and denominator.
  31892. @param numerator
  31893. @param denominator maxDenominator The maximum allowed value for denominator
  31894. </member>
  31895. <member name="P:NPOI.SS.Format.SimpleFraction.Denominator">
  31896. Access the denominator.
  31897. @return the denominator.
  31898. </member>
  31899. <member name="P:NPOI.SS.Format.SimpleFraction.Numerator">
  31900. Access the numerator.
  31901. @return the numerator.
  31902. </member>
  31903. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetSupportedFunctionNames">
  31904. Returns a collection of ATP function names implemented by POI.
  31905. @return an array of supported functions
  31906. @since 3.8 beta6
  31907. </member>
  31908. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.GetNotSupportedFunctionNames">
  31909. Returns a collection of ATP function names NOT implemented by POI.
  31910. @return an array of not supported functions
  31911. @since 3.8 beta6
  31912. </member>
  31913. <member name="M:NPOI.SS.Formula.Atp.AnalysisToolPak.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  31914. Register a ATP function in runtime.
  31915. @param name the function name
  31916. @param func the functoin to register
  31917. @throws ArgumentException if the function is unknown or already registered.
  31918. @since 3.8 beta6
  31919. </member>
  31920. <member name="T:NPOI.SS.Formula.Atp.ArgumentsEvaluator">
  31921. Evaluator for formula arguments.
  31922. @author jfaenomoto@gmail.com
  31923. </member>
  31924. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDateArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31925. Evaluate a generic {@link ValueEval} argument to a double value that represents a date in POI.
  31926. @param arg {@link ValueEval} an argument.
  31927. @param srcCellRow number cell row.
  31928. @param srcCellCol number cell column.
  31929. @return a double representing a date in POI.
  31930. @throws EvaluationException exception upon argument evaluation.
  31931. </member>
  31932. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateDatesArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31933. Evaluate a generic {@link ValueEval} argument to an array of double values that represents dates in POI.
  31934. @param arg {@link ValueEval} an argument.
  31935. @param srcCellRow number cell row.
  31936. @param srcCellCol number cell column.
  31937. @return an array of doubles representing dates in POI.
  31938. @throws EvaluationException exception upon argument evaluation.
  31939. </member>
  31940. <member name="M:NPOI.SS.Formula.Atp.ArgumentsEvaluator.EvaluateNumberArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  31941. Evaluate a generic {@link ValueEval} argument to a double value.
  31942. @param arg {@link ValueEval} an argument.
  31943. @param srcCellRow number cell row.
  31944. @param srcCellCol number cell column.
  31945. @return a double value.
  31946. @throws EvaluationException exception upon argument evaluation.
  31947. </member>
  31948. <member name="T:NPOI.SS.Formula.Atp.DateParser">
  31949. Parser for java dates.
  31950. @author jfaenomoto@gmail.com
  31951. </member>
  31952. <member name="M:NPOI.SS.Formula.Atp.DateParser.ParseDate(System.String)">
  31953. Parses a date from a string.
  31954. @param strVal a string with a date pattern.
  31955. @return a date parsed from argument.
  31956. @throws EvaluationException exception upon parsing.
  31957. </member>
  31958. <member name="M:NPOI.SS.Formula.Atp.DateParser.MakeDate(System.Int32,System.Int32,System.Int32)">
  31959. @param month 1-based
  31960. </member>
  31961. <member name="T:NPOI.SS.Formula.Atp.MRound">
  31962. Implementation of Excel 'Analysis ToolPak' function MROUND()<br/>
  31963. Returns a number rounded to the desired multiple.<p/>
  31964. <b>Syntax</b><br/>
  31965. <b>MROUND</b>(<b>number</b>, <b>multiple</b>)
  31966. <p/>
  31967. @author Yegor Kozlov
  31968. </member>
  31969. <member name="T:NPOI.SS.Formula.Atp.NetworkdaysFunction">
  31970. Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()<br/>
  31971. Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non
  31972. saturday/sunday date.
  31973. <p/>
  31974. <b>Syntax</b><br/>
  31975. <b>NETWORKDAYS</b>(<b>startDate</b>, <b>endDate</b>, holidays)
  31976. <p/>
  31977. @author jfaenomoto@gmail.com
  31978. </member>
  31979. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.#ctor(NPOI.SS.Formula.Atp.ArgumentsEvaluator)">
  31980. Constructor.
  31981. @param anEvaluator an injected {@link ArgumentsEvaluator}.
  31982. </member>
  31983. <member name="M:NPOI.SS.Formula.Atp.NetworkdaysFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  31984. Evaluate for NETWORKDAYS. Given two dates and a optional date or interval of holidays, determines how many working days are there
  31985. between those dates.
  31986. @return {@link ValueEval} for the number of days between two dates.
  31987. </member>
  31988. <member name="T:NPOI.SS.Formula.Atp.ParityFunction">
  31989. Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()<br/>
  31990. @author Josh Micich
  31991. </member>
  31992. <member name="T:NPOI.SS.Formula.Atp.RandBetween">
  31993. * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()<br/>
  31994. *
  31995. * Returns a random integer number between the numbers you specify.<p/>
  31996. *
  31997. * <b>Syntax</b><br/>
  31998. * <b>RANDBETWEEN</b>(<b>bottom</b>, <b>top</b>)<p/>
  31999. *
  32000. * <b>bottom</b> is the smallest integer RANDBETWEEN will return.<br/>
  32001. * <b>top</b> is the largest integer RANDBETWEEN will return.<br/>
  32002. * @author Brendan Nolan
  32003. </member>
  32004. <member name="M:NPOI.SS.Formula.Atp.RandBetween.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  32005. Evaluate for RANDBETWEEN(). Must be given two arguments. Bottom must be greater than top.
  32006. Bottom is rounded up and top value is rounded down. After rounding top has to be set greater
  32007. than top.
  32008. @see org.apache.poi.ss.formula.functions.FreeRefFunction#evaluate(org.apache.poi.ss.formula.eval.ValueEval[], org.apache.poi.ss.formula.OperationEvaluationContext)
  32009. </member>
  32010. <member name="T:NPOI.SS.Formula.Atp.WorkdayCalculator">
  32011. A calculator for workdays, considering dates as excel representations.
  32012. @author jfaenomoto@gmail.com
  32013. </member>
  32014. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.#ctor">
  32015. Constructor.
  32016. </member>
  32017. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Double,System.Double[])">
  32018. Calculate how many workdays are there between a start and an end date, as excel representations, considering a range of holidays.
  32019. @param start start date.
  32020. @param end end date.
  32021. @param holidays an array of holidays.
  32022. @return number of workdays between start and end dates, including both dates.
  32023. </member>
  32024. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateWorkdays(System.Double,System.Int32,System.Double[])">
  32025. Calculate the workday past x workdays from a starting date, considering a range of holidays.
  32026. @param start start date.
  32027. @param workdays number of workdays to be past from starting date.
  32028. @param holidays an array of holidays.
  32029. @return date past x workdays.
  32030. </member>
  32031. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.PastDaysOfWeek(System.Double,System.Double,System.DayOfWeek)">
  32032. Calculates how many days of week past between a start and an end date.
  32033. @param start start date.
  32034. @param end end date.
  32035. @param dayOfWeek a day of week as represented by {@link Calendar} constants.
  32036. @return how many days of week past in this interval.
  32037. </member>
  32038. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.CalculateNonWeekendHolidays(System.Double,System.Double,System.Double[])">
  32039. Calculates how many holidays in a list are workdays, considering an interval of dates.
  32040. @param start start date.
  32041. @param end end date.
  32042. @param holidays an array of holidays.
  32043. @return number of holidays that occur in workdays, between start and end dates.
  32044. </member>
  32045. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsWeekend(System.Double)">
  32046. @param aDate a given date.
  32047. @return <code>true</code> if date is weekend, <code>false</code> otherwise.
  32048. </member>
  32049. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsHoliday(System.Double,System.Double[])">
  32050. @param aDate a given date.
  32051. @param holidays an array of holidays.
  32052. @return <code>true</code> if date is a holiday, <code>false</code> otherwise.
  32053. </member>
  32054. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsNonWorkday(System.Double,System.Double[])">
  32055. @param aDate a given date.
  32056. @param holidays an array of holidays.
  32057. @return <code>1</code> is not a workday, <code>0</code> otherwise.
  32058. </member>
  32059. <member name="M:NPOI.SS.Formula.Atp.WorkdayCalculator.IsInARange(System.Double,System.Double,System.Double)">
  32060. @param start start date.
  32061. @param end end date.
  32062. @param aDate a date to be analyzed.
  32063. @return <code>true</code> if aDate is between start and end dates, <code>false</code> otherwise.
  32064. </member>
  32065. <member name="T:NPOI.SS.Formula.Atp.WorkdayFunction">
  32066. Implementation of Excel 'Analysis ToolPak' function WORKDAY()<br/>
  32067. Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non
  32068. saturday/sunday date.
  32069. <p/>
  32070. <b>Syntax</b><br/>
  32071. <b>WORKDAY</b>(<b>startDate</b>, <b>days</b>, holidays)
  32072. <p/>
  32073. @author jfaenomoto@gmail.com
  32074. </member>
  32075. <member name="M:NPOI.SS.Formula.Atp.WorkdayFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  32076. Evaluate for WORKDAY. Given a date, a number of days and a optional date or interval of holidays, determines which date it is past
  32077. number of parametrized workdays.
  32078. @return {@link ValueEval} with date as its value.
  32079. </member>
  32080. <member name="T:NPOI.SS.Formula.Atp.YearFrac">
  32081. Implementation of Excel 'Analysis ToolPak' function YEARFRAC()<br/>
  32082. Returns the fraction of the year spanned by two dates.<p/>
  32083. <b>Syntax</b><br/>
  32084. <b>YEARFRAC</b>(<b>startDate</b>, <b>endDate</b>, basis)<p/>
  32085. The <b>basis</b> optionally specifies the behaviour of YEARFRAC as follows:
  32086. <table border="0" cellpadding="1" cellspacing="0" summary="basis parameter description">
  32087. <tr><th>Value</th><th>Days per Month</th><th>Days per Year</th></tr>
  32088. <tr align='center'><td>0 (default)</td><td>30</td><td>360</td></tr>
  32089. <tr align='center'><td>1</td><td>actual</td><td>actual</td></tr>
  32090. <tr align='center'><td>2</td><td>actual</td><td>360</td></tr>
  32091. <tr align='center'><td>3</td><td>actual</td><td>365</td></tr>
  32092. <tr align='center'><td>4</td><td>30</td><td>360</td></tr>
  32093. </table>
  32094. </member>
  32095. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator">
  32096. <summary>
  32097. Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
  32098. Algorithm inspired by www.dwheeler.com/yearfrac
  32099. @author Josh Micich
  32100. </summary>
  32101. <remarks>
  32102. Date Count convention
  32103. http://en.wikipedia.org/wiki/Day_count_convention
  32104. </remarks>
  32105. <remarks>
  32106. Office Online Help on YEARFRAC
  32107. http://office.microsoft.com/en-us/excel/HP052093441033.aspx
  32108. </remarks>
  32109. </member>
  32110. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.MS_PER_HOUR">
  32111. use UTC time-zone to avoid daylight savings issues
  32112. </member>
  32113. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.LONG_MONTH_LEN">
  32114. the length of normal long months i.e. 31
  32115. </member>
  32116. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SHORT_MONTH_LEN">
  32117. the length of normal short months i.e. 30
  32118. </member>
  32119. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Calculate(System.Double,System.Double,System.Int32)">
  32120. <summary>
  32121. Calculates YEARFRAC()
  32122. </summary>
  32123. <param name="pStartDateVal">The start date.</param>
  32124. <param name="pEndDateVal">The end date.</param>
  32125. <param name="basis">The basis value.</param>
  32126. <returns></returns>
  32127. </member>
  32128. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis0(System.Int32,System.Int32)">
  32129. <summary>
  32130. Basis 0, 30/360 date convention
  32131. </summary>
  32132. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32133. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32134. <returns></returns>
  32135. </member>
  32136. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis1(System.Int32,System.Int32)">
  32137. <summary>
  32138. Basis 1, Actual/Actual date convention
  32139. </summary>
  32140. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32141. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32142. <returns></returns>
  32143. </member>
  32144. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis2(System.Int32,System.Int32)">
  32145. <summary>
  32146. Basis 2, Actual/360 date convention
  32147. </summary>
  32148. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32149. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32150. <returns></returns>
  32151. </member>
  32152. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis3(System.Double,System.Double)">
  32153. <summary>
  32154. Basis 3, Actual/365 date convention
  32155. </summary>
  32156. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32157. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32158. <returns></returns>
  32159. </member>
  32160. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.Basis4(System.Int32,System.Int32)">
  32161. <summary>
  32162. Basis 4, European 30/360 date convention
  32163. </summary>
  32164. <param name="startDateVal">The start date value assumed to be less than or equal to endDateVal.</param>
  32165. <param name="endDateVal">The end date value assumed to be greater than or equal to startDateVal.</param>
  32166. <returns></returns>
  32167. </member>
  32168. <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)">
  32169. <summary>
  32170. Calculates the adjusted.
  32171. </summary>
  32172. <param name="startDate">The start date.</param>
  32173. <param name="endDate">The end date.</param>
  32174. <param name="date1day">The date1day.</param>
  32175. <param name="date2day">The date2day.</param>
  32176. <returns></returns>
  32177. </member>
  32178. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32179. <summary>
  32180. Determines whether [is last day of month] [the specified date].
  32181. </summary>
  32182. <param name="date">The date.</param>
  32183. <returns>
  32184. <c>true</c> if [is last day of month] [the specified date]; otherwise, <c>false</c>.
  32185. </returns>
  32186. </member>
  32187. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.GetLastDayOfMonth(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32188. <summary>
  32189. Gets the last day of month.
  32190. </summary>
  32191. <param name="date">The date.</param>
  32192. <returns></returns>
  32193. </member>
  32194. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.ShouldCountFeb29(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32195. <summary>
  32196. Assumes dates are no more than 1 year apart.
  32197. </summary>
  32198. <param name="start">The start.</param>
  32199. <param name="end">The end.</param>
  32200. <returns><c>true</c>
  32201. if dates both within a leap year, or span a period including Feb 29</returns>
  32202. </member>
  32203. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.DateDiff(System.Int64,System.Int64)">
  32204. <summary>
  32205. return the whole number of days between the two time-stamps. Both time-stamps are
  32206. assumed to represent 12:00 midnight on the respective day.
  32207. </summary>
  32208. <param name="startDateTicks">The start date ticks.</param>
  32209. <param name="endDateTicks">The end date ticks.</param>
  32210. <returns></returns>
  32211. </member>
  32212. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.AverageYearLength(System.Int32,System.Int32)">
  32213. <summary>
  32214. Averages the length of the year.
  32215. </summary>
  32216. <param name="startYear">The start year.</param>
  32217. <param name="endYear">The end year.</param>
  32218. <returns></returns>
  32219. </member>
  32220. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsLeapYear(System.Int32)">
  32221. <summary>
  32222. determine Leap Year
  32223. </summary>
  32224. <param name="i">the year</param>
  32225. <returns></returns>
  32226. </member>
  32227. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.IsGreaterThanOneYear(NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate,NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate)">
  32228. <summary>
  32229. Determines whether [is greater than one year] [the specified start].
  32230. </summary>
  32231. <param name="start">The start date.</param>
  32232. <param name="end">The end date.</param>
  32233. <returns>
  32234. <c>true</c> if [is greater than one year] [the specified start]; otherwise, <c>false</c>.
  32235. </returns>
  32236. </member>
  32237. <member name="M:NPOI.SS.Formula.Atp.YearFracCalculator.CreateDate(System.Int32)">
  32238. <summary>
  32239. Creates the date.
  32240. </summary>
  32241. <param name="dayCount">The day count.</param>
  32242. <returns></returns>
  32243. </member>
  32244. <member name="T:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate">
  32245. <summary>
  32246. Simple Date Wrapper
  32247. </summary>
  32248. </member>
  32249. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.month">
  32250. 1-based month
  32251. </member>
  32252. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.day">
  32253. day of month
  32254. </member>
  32255. <member name="F:NPOI.SS.Formula.Atp.YearFracCalculator.SimpleDate.ticks">
  32256. milliseconds since 1970
  32257. </member>
  32258. <member name="T:NPOI.SS.Formula.CellCacheEntry">
  32259. Stores the parameters that identify the evaluation of one cell.<br/>
  32260. </member>
  32261. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults">
  32262. Calls formulaCell.SetFormulaResult(null, null) recursively all the way up the tree of
  32263. dependencies. Calls usedCell.ClearConsumingCell(fc) for each child of a cell that Is
  32264. Cleared along the way.
  32265. @param formulaCells
  32266. </member>
  32267. <member name="M:NPOI.SS.Formula.CellCacheEntry.RecurseClearCachedFormulaResults(NPOI.SS.Formula.IEvaluationListener,System.Int32)">
  32268. Identical To {@link #RecurseClearCachedFormulaResults()} except for the listener call-backs
  32269. </member>
  32270. <member name="T:NPOI.SS.Formula.CellEvaluationFrame">
  32271. Stores details about the current evaluation of a cell.<br/>
  32272. </member>
  32273. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.AddSensitiveInputCell(NPOI.SS.Formula.CellCacheEntry)">
  32274. @param inputCell a cell directly used by the formula of this evaluation frame
  32275. </member>
  32276. <member name="M:NPOI.SS.Formula.CellEvaluationFrame.GetSensitiveInputCells">
  32277. @return never <c>null</c>, (possibly empty) array of all cells directly used while
  32278. evaluating the formula of this frame.
  32279. </member>
  32280. <member name="T:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment">
  32281. Manages a collection of {@link WorkbookEvaluator}s, in order To support evaluation of formulas
  32282. across spreadsheets.<p/>
  32283. For POI internal use only
  32284. @author Josh Micich
  32285. </member>
  32286. <member name="M:NPOI.SS.Formula.CollaboratingWorkbooksEnvironment.Unhook">
  32287. </member>
  32288. <member name="T:NPOI.SS.Formula.Constant.ConstantValueParser">
  32289. To support Constant Values (2.5.7) as required by the CRN record.
  32290. This class is also used for two dimensional arrays which are encoded by
  32291. EXTERNALNAME (5.39) records and Array tokens.<p/>
  32292. @author Josh Micich
  32293. </member>
  32294. <member name="M:NPOI.SS.Formula.Constant.ConstantValueParser.GetEncodedSize(System.Object)">
  32295. @return encoded size without the 'type' code byte
  32296. </member>
  32297. <member name="T:NPOI.SS.Formula.Constant.ErrorConstant">
  32298. <summary>
  32299. Represents a constant error code value as encoded in a constant values array.
  32300. This class is a type-safe wrapper for a 16-bit int value performing a similar job to
  32301. <c>ErrorEval</c>
  32302. </summary>
  32303. <remarks> @author Josh Micich</remarks>
  32304. </member>
  32305. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.#ctor(System.Int32)">
  32306. <summary>
  32307. Initializes a new instance of the <see cref="T:NPOI.SS.Formula.Constant.ErrorConstant"/> class.
  32308. </summary>
  32309. <param name="errorCode">The error code.</param>
  32310. </member>
  32311. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.ErrorCode">
  32312. <summary>
  32313. Gets the error code.
  32314. </summary>
  32315. <value>The error code.</value>
  32316. </member>
  32317. <member name="P:NPOI.SS.Formula.Constant.ErrorConstant.Text">
  32318. <summary>
  32319. Gets the text.
  32320. </summary>
  32321. <value>The text.</value>
  32322. </member>
  32323. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ValueOf(System.Int32)">
  32324. <summary>
  32325. Values the of.
  32326. </summary>
  32327. <param name="errorCode">The error code.</param>
  32328. <returns></returns>
  32329. </member>
  32330. <member name="M:NPOI.SS.Formula.Constant.ErrorConstant.ToString">
  32331. <summary>
  32332. Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  32333. </summary>
  32334. <returns>
  32335. A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
  32336. </returns>
  32337. </member>
  32338. <member name="T:NPOI.SS.Formula.EvaluationCache">
  32339. Performance optimisation for {@link HSSFFormulaEvaluator}. This class stores previously
  32340. calculated values of already visited cells, To avoid unnecessary re-calculation when the
  32341. same cells are referenced multiple times
  32342. @author Josh Micich
  32343. </member>
  32344. <member name="F:NPOI.SS.Formula.EvaluationCache._evaluationListener">
  32345. only used for testing. <c>null</c> otherwise
  32346. </member>
  32347. <member name="M:NPOI.SS.Formula.EvaluationCache.Clear">
  32348. Should be called whenever there are Changes To input cells in the evaluated workbook.
  32349. </member>
  32350. <member name="T:NPOI.SS.Formula.IEvaluationCell">
  32351. Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
  32352. and non-formula cells.<br/>
  32353. Implementors of this class must implement {@link #HashCode()} and {@link #Equals(Object)}
  32354. To provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
  32355. For POI internal use only
  32356. @author Josh Micich
  32357. </member>
  32358. <member name="T:NPOI.SS.Formula.IEvaluationName">
  32359. Abstracts a name record for formula evaluation.<br/>
  32360. For POI internal use only
  32361. @author Josh Micich
  32362. </member>
  32363. <member name="T:NPOI.SS.Formula.IEvaluationSheet">
  32364. Abstracts a sheet for the purpose of formula evaluation.<br/>
  32365. For POI internal use only
  32366. @author Josh Micich
  32367. </member>
  32368. <member name="M:NPOI.SS.Formula.IEvaluationSheet.GetCell(System.Int32,System.Int32)">
  32369. @return <c>null</c> if there is no cell at the specified coordinates
  32370. </member>
  32371. <member name="T:NPOI.SS.Formula.EvaluationTracker">
  32372. <summary>
  32373. Instances of this class keep track of multiple dependent cell evaluations due
  32374. To recursive calls To <see cref="M:NPOI.SS.Formula.WorkbookEvaluator.Evaluate(NPOI.SS.Formula.IEvaluationCell)"/>
  32375. The main purpose of this class is To detect an attempt To evaluate a cell
  32376. that is already being evaluated. In other words, it detects circular
  32377. references in spreadsheet formulas.
  32378. </summary>
  32379. <remarks>
  32380. @author Josh Micich
  32381. </remarks>
  32382. </member>
  32383. <member name="M:NPOI.SS.Formula.EvaluationTracker.StartEvaluate(NPOI.SS.Formula.FormulaCellCacheEntry)">
  32384. Notifies this evaluation tracker that evaluation of the specified cell Is
  32385. about To start.<br/>
  32386. In the case of a <c>true</c> return code, the caller should
  32387. continue evaluation of the specified cell, and also be sure To call
  32388. <c>endEvaluate()</c> when complete.<br/>
  32389. In the case of a <c>null</c> return code, the caller should
  32390. return an evaluation result of
  32391. <c>ErrorEval.CIRCULAR_REF_ERROR</c>, and not call <c>endEvaluate()</c>.
  32392. <br/>
  32393. @return <c>false</c> if the specified cell is already being evaluated
  32394. </member>
  32395. <member name="M:NPOI.SS.Formula.EvaluationTracker.EndEvaluate(NPOI.SS.Formula.CellCacheEntry)">
  32396. Notifies this evaluation tracker that the evaluation of the specified cell is complete. <p/>
  32397. Every successful call To <c>startEvaluate</c> must be followed by a call To <c>endEvaluate</c> (recommended in a finally block) To enable
  32398. proper tracking of which cells are being evaluated at any point in time.<p/>
  32399. Assuming a well behaved client, parameters To this method would not be
  32400. required. However, they have been included To assert correct behaviour,
  32401. and form more meaningful error messages.
  32402. </member>
  32403. <member name="T:NPOI.SS.Formula.IEvaluationWorkbook">
  32404. Abstracts a workbook for the purpose of formula evaluation.<br/>
  32405. For POI internal use only
  32406. @author Josh Micich
  32407. </member>
  32408. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetSheetIndex(NPOI.SS.Formula.IEvaluationSheet)">
  32409. @return -1 if the specified sheet is from a different book
  32410. </member>
  32411. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.Int32)">
  32412. HSSF Only - fetch the external-style sheet details
  32413. <p>Return will have no workbook set if it's actually in our own workbook</p>
  32414. </member>
  32415. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalSheet(System.String,System.String,System.Int32)">
  32416. XSSF Only - fetch the external-style sheet details
  32417. <p>Return will have no workbook set if it's actually in our own workbook</p>
  32418. </member>
  32419. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.ConvertFromExternSheetIndex(System.Int32)">
  32420. HSSF Only - convert an external sheet index to an internal sheet index,
  32421. for an external-style reference to one of this workbook's own sheets
  32422. </member>
  32423. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.Int32,System.Int32)">
  32424. HSSF Only - fetch the external-style name details
  32425. </member>
  32426. <member name="M:NPOI.SS.Formula.IEvaluationWorkbook.GetExternalName(System.String,System.String,System.Int32)">
  32427. XSSF Only - fetch the external-style name details
  32428. </member>
  32429. <member name="T:NPOI.SS.Formula.Eval.AreaEval">
  32430. Evaluation of 2D (Row+Column) and 3D (Sheet+Row+Column) areas
  32431. </member>
  32432. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstRow">
  32433. returns the 0-based index of the first row in
  32434. this area.
  32435. </member>
  32436. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastRow">
  32437. returns the 0-based index of the last row in
  32438. this area.
  32439. </member>
  32440. <member name="P:NPOI.SS.Formula.Eval.AreaEval.FirstColumn">
  32441. returns the 0-based index of the first col in
  32442. this area.
  32443. </member>
  32444. <member name="P:NPOI.SS.Formula.Eval.AreaEval.LastColumn">
  32445. returns the 0-based index of the last col in
  32446. this area.
  32447. </member>
  32448. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Contains(System.Int32,System.Int32)">
  32449. returns true if the cell at row and col specified
  32450. as absolute indexes in the sheet is contained in
  32451. this area.
  32452. @param row
  32453. @param col
  32454. </member>
  32455. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsColumn(System.Int32)">
  32456. returns true if the specified col is in range
  32457. @param col
  32458. </member>
  32459. <member name="M:NPOI.SS.Formula.Eval.AreaEval.ContainsRow(System.Int32)">
  32460. returns true if the specified row is in range
  32461. @param row
  32462. </member>
  32463. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetAbsoluteValue(System.Int32,System.Int32)">
  32464. @return the ValueEval from within this area at the specified row and col index. Never
  32465. <code>null</code> (possibly {@link BlankEval}). The specified indexes should be absolute
  32466. indexes in the sheet and not relative indexes within the area.
  32467. </member>
  32468. <member name="M:NPOI.SS.Formula.Eval.AreaEval.GetRelativeValue(System.Int32,System.Int32)">
  32469. @return the ValueEval from within this area at the specified relativeRowIndex and
  32470. relativeColumnIndex. Never <c>null</c> (possibly {@link BlankEval}). The
  32471. specified indexes should relative to the top left corner of this area.
  32472. </member>
  32473. <member name="M:NPOI.SS.Formula.Eval.AreaEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  32474. Creates an {@link AreaEval} offset by a relative amount from from the upper left cell
  32475. of this area
  32476. </member>
  32477. <member name="T:NPOI.SS.Formula.Eval.AreaEvalBase">
  32478. @author Josh Micich
  32479. </member>
  32480. <member name="M:NPOI.SS.Formula.Eval.AreaEvalBase.IsSubTotal(System.Int32,System.Int32)">
  32481. @return whether cell at rowIndex and columnIndex is a subtotal.
  32482. By default return false which means 'don't care about subtotals'
  32483. </member>
  32484. <member name="T:NPOI.SS.Formula.Eval.BlankEval">
  32485. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt; This class is a
  32486. marker class. It is a special value for empty cells.
  32487. </member>
  32488. <member name="T:NPOI.SS.Formula.Eval.BoolEval">
  32489. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32490. </member>
  32491. <member name="M:NPOI.SS.Formula.Eval.BoolEval.ValueOf(System.Boolean)">
  32492. Convenience method for the following:<br/>
  32493. <c>(b ? BoolEval.TRUE : BoolEval.FALSE)</c>
  32494. @return a <c>BoolEval</c> instance representing <c>b</c>.
  32495. </member>
  32496. <member name="T:NPOI.SS.Formula.Eval.ConcatEval">
  32497. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32498. </member>
  32499. <member name="T:NPOI.SS.Formula.Eval.ErrorEval">
  32500. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32501. </member>
  32502. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NULL_INTERSECTION">
  32503. <b>#NULL!</b> - Intersection of two cell ranges is empty
  32504. </member>
  32505. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.DIV_ZERO">
  32506. <b>#DIV/0!</b> - Division by zero
  32507. </member>
  32508. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.VALUE_INVALID">
  32509. <b>#VALUE!</b> - Wrong type of operand
  32510. </member>
  32511. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.REF_INVALID">
  32512. <b>#REF!</b> - Illegal or deleted cell reference
  32513. </member>
  32514. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NAME_INVALID">
  32515. <b>#NAME?</b> - Wrong function or range name
  32516. </member>
  32517. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NUM_ERROR">
  32518. <b>#NUM!</b> - Value range overflow
  32519. </member>
  32520. <member name="F:NPOI.SS.Formula.Eval.ErrorEval.NA">
  32521. <b>#N/A</b> - Argument or function not available
  32522. </member>
  32523. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.ValueOf(System.Int32)">
  32524. Translates an Excel internal error code into the corresponding POI ErrorEval instance
  32525. @param errorCode
  32526. </member>
  32527. <member name="M:NPOI.SS.Formula.Eval.ErrorEval.GetText(System.Int32)">
  32528. Converts error codes to text. Handles non-standard error codes OK.
  32529. For debug/test purposes (and for formatting error messages).
  32530. @return the String representation of the specified Excel error code.
  32531. </member>
  32532. <member name="T:NPOI.SS.Formula.Eval.Eval">
  32533. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32534. </member>
  32535. <member name="T:NPOI.SS.Formula.Eval.EvaluationException">
  32536. This class is used to simplify error handling logic <i>within</i> operator and function
  32537. implementations. Note - <c>OperationEval.Evaluate()</c> and <c>Function.Evaluate()</c>
  32538. method signatures do not throw this exception so it cannot propagate outside.<p/>
  32539. Here is an example coded without <c>EvaluationException</c>, to show how it can help:
  32540. <pre>
  32541. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  32542. // ...
  32543. Eval arg0 = args[0];
  32544. if(arg0 is ErrorEval) {
  32545. return arg0;
  32546. }
  32547. if(!(arg0 is AreaEval)) {
  32548. return ErrorEval.VALUE_INVALID;
  32549. }
  32550. double temp = 0;
  32551. AreaEval area = (AreaEval)arg0;
  32552. ValueEval[] values = area.LittleEndianConstants.BYTE_SIZE;
  32553. for (int i = 0; i &lt; values.Length; i++) {
  32554. ValueEval ve = values[i];
  32555. if(ve is ErrorEval) {
  32556. return ve;
  32557. }
  32558. if(!(ve is NumericValueEval)) {
  32559. return ErrorEval.VALUE_INVALID;
  32560. }
  32561. temp += ((NumericValueEval)ve).NumberValue;
  32562. }
  32563. // ...
  32564. }
  32565. </pre>
  32566. In this example, if any error is encountered while Processing the arguments, an error is
  32567. returned immediately. This code is difficult to refactor due to all the points where errors
  32568. are returned.<br/>
  32569. Using <c>EvaluationException</c> allows the error returning code to be consolidated to one
  32570. place.<p/>
  32571. <pre>
  32572. public Eval Evaluate(Eval[] args, int srcRow, short srcCol) {
  32573. try {
  32574. // ...
  32575. AreaEval area = GetAreaArg(args[0]);
  32576. double temp = sumValues(area.LittleEndianConstants.BYTE_SIZE);
  32577. // ...
  32578. } catch (EvaluationException e) {
  32579. return e.GetErrorEval();
  32580. }
  32581. }
  32582. private static AreaEval GetAreaArg(Eval arg0){
  32583. if (arg0 is ErrorEval) {
  32584. throw new EvaluationException((ErrorEval) arg0);
  32585. }
  32586. if (arg0 is AreaEval) {
  32587. return (AreaEval) arg0;
  32588. }
  32589. throw EvaluationException.InvalidValue();
  32590. }
  32591. private double sumValues(ValueEval[] values){
  32592. double temp = 0;
  32593. for (int i = 0; i &lt; values.Length; i++) {
  32594. ValueEval ve = values[i];
  32595. if (ve is ErrorEval) {
  32596. throw new EvaluationException((ErrorEval) ve);
  32597. }
  32598. if (!(ve is NumericValueEval)) {
  32599. throw EvaluationException.InvalidValue();
  32600. }
  32601. temp += ((NumericValueEval) ve).NumberValue;
  32602. }
  32603. return temp;
  32604. }
  32605. </pre>
  32606. It is not mandatory to use EvaluationException, doing so might give the following advantages:<br/>
  32607. - Methods can more easily be extracted, allowing for re-use.<br/>
  32608. - Type management (typecasting etc) is simpler because error conditions have been Separated from
  32609. intermediate calculation values.<br/>
  32610. - Fewer local variables are required. Local variables can have stronger types.<br/>
  32611. - It is easier to mimic common Excel error handling behaviour (exit upon encountering first
  32612. error), because exceptions conveniently propagate up the call stack regardless of execution
  32613. points or the number of levels of nested calls.<p/>
  32614. <b>Note</b> - Only standard evaluation errors are represented by <c>EvaluationException</c> (
  32615. i.e. conditions expected to be encountered when evaluating arbitrary Excel formulas). Conditions
  32616. that could never occur in an Excel spReadsheet should result in runtime exceptions. Care should
  32617. be taken to not translate any POI internal error into an Excel evaluation error code.
  32618. @author Josh Micich
  32619. </member>
  32620. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidValue">
  32621. <b>#VALUE!</b> - Wrong type of operand
  32622. </member>
  32623. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.InvalidRef">
  32624. <b>#REF!</b> - Illegal or deleted cell reference
  32625. </member>
  32626. <member name="M:NPOI.SS.Formula.Eval.EvaluationException.NumberError">
  32627. <b>#NUM!</b> - Value range overflow
  32628. </member>
  32629. <member name="T:NPOI.SS.Formula.Eval.ExternalNameEval">
  32630. Evaluation of a Name defined in a Sheet or Workbook scope
  32631. </member>
  32632. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell">
  32633. Represents a cell being used for forked Evaluation that has had a value Set different from the
  32634. corresponding cell in the shared master workbook.
  32635. @author Josh Micich
  32636. </member>
  32637. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationCell._masterCell">
  32638. corresponding cell from master workbook
  32639. </member>
  32640. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet">
  32641. Represents a sheet being used for forked Evaluation. Initially, objects of this class contain
  32642. only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)},
  32643. the master cell object is logically Replaced with a {@link ForkedEvaluationCell} instance, which
  32644. will be used in all subsequent Evaluations.
  32645. @author Josh Micich
  32646. </member>
  32647. <member name="F:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationSheet._sharedCellsByRowCol">
  32648. Only cells which have been split are Put in this map. (This has been done to conserve memory).
  32649. </member>
  32650. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluationWorkbook">
  32651. Represents a workbook being used for forked Evaluation. Most operations are delegated to the
  32652. shared master workbook, except those that potentially involve cell values that may have been
  32653. updated After a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
  32654. @author Josh Micich
  32655. </member>
  32656. <member name="T:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator">
  32657. An alternative workbook Evaluator that saves memory in situations where a single workbook is
  32658. concurrently and independently Evaluated many times. With standard formula Evaluation, around
  32659. 90% of memory consumption is due to loading of the {@link HSSFWorkbook} or {@link NPOI.xssf.usermodel.XSSFWorkbook}.
  32660. This class enables a 'master workbook' to be loaded just once and shared between many Evaluation
  32661. clients. Each Evaluation client Creates its own {@link ForkedEvaluator} and can Set cell values
  32662. that will be used for local Evaluations (and don't disturb Evaluations on other Evaluators).
  32663. @author Josh Micich
  32664. </member>
  32665. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier)">
  32666. @deprecated (Sep 2009) (reduce overloading) use {@link #Create(Workbook, IStabilityClassifier, UDFFinder)}
  32667. </member>
  32668. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Create(NPOI.SS.UserModel.IWorkbook,NPOI.SS.Formula.IStabilityClassifier,NPOI.SS.Formula.Udf.UDFFinder)">
  32669. @param udfFinder pass <code>null</code> for default (AnalysisToolPak only)
  32670. </member>
  32671. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.UpdateCell(System.String,System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  32672. Sets the specified cell to the supplied <tt>value</tt>
  32673. @param sheetName the name of the sheet Containing the cell
  32674. @param rowIndex zero based
  32675. @param columnIndex zero based
  32676. </member>
  32677. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.CopyUpdatedCells(NPOI.SS.UserModel.IWorkbook)">
  32678. Copies the values of all updated cells (modified by calls to {@link
  32679. #updateCell(String, int, int, ValueEval)}) to the supplied <tt>workbook</tt>.<br/>
  32680. Typically, the supplied <tt>workbook</tt> is a writable copy of the 'master workbook',
  32681. but at the very least it must contain sheets with the same names.
  32682. </member>
  32683. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.Evaluate(System.String,System.Int32,System.Int32)">
  32684. If cell Contains a formula, the formula is Evaluated and returned,
  32685. else the CellValue simply copies the appropriate cell value from
  32686. the cell and also its cell type. This method should be preferred over
  32687. EvaluateInCell() when the call should not modify the contents of the
  32688. original cell.
  32689. @param sheetName the name of the sheet Containing the cell
  32690. @param rowIndex zero based
  32691. @param columnIndex zero based
  32692. @return <code>null</code> if the supplied cell is <code>null</code> or blank
  32693. </member>
  32694. <member name="M:NPOI.SS.Formula.Eval.Forked.ForkedEvaluator.SetupEnvironment(System.String[],NPOI.SS.Formula.Eval.Forked.ForkedEvaluator[])">
  32695. Coordinates several formula Evaluators together so that formulas that involve external
  32696. references can be Evaluated.
  32697. @param workbookNames the simple file names used to identify the workbooks in formulas
  32698. with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
  32699. @param Evaluators all Evaluators for the full Set of workbooks required by the formulas.
  32700. </member>
  32701. <member name="T:NPOI.SS.Formula.Eval.FunctionEval">
  32702. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32703. </member>
  32704. <member name="T:NPOI.SS.Formula.Eval.FunctionEval.FunctionID">
  32705. Some function IDs that require special treatment
  32706. </member>
  32707. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.IF">
  32708. 1
  32709. </member>
  32710. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.OFFSET">
  32711. 78
  32712. </member>
  32713. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.CHOOSE">
  32714. 100
  32715. </member>
  32716. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.INDIRECT">
  32717. 148
  32718. </member>
  32719. <member name="F:NPOI.SS.Formula.Eval.FunctionEval.FunctionID.EXTERNAL_FUNC">
  32720. 255
  32721. </member>
  32722. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  32723. Register a new function in runtime.
  32724. @param name the function name
  32725. @param func the functoin to register
  32726. @throws ArgumentException if the function is unknown or already registered.
  32727. @since 3.8 beta6
  32728. </member>
  32729. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetSupportedFunctionNames">
  32730. Returns a collection of function names implemented by POI.
  32731. @return an array of supported functions
  32732. @since 3.8 beta6
  32733. </member>
  32734. <member name="M:NPOI.SS.Formula.Eval.FunctionEval.GetNotSupportedFunctionNames">
  32735. Returns an array of function names NOT implemented by POI.
  32736. @return an array of not supported functions
  32737. @since 3.8 beta6
  32738. </member>
  32739. <member name="T:NPOI.SS.Formula.Eval.FunctionNameEval">
  32740. @author Josh Micich
  32741. </member>
  32742. <member name="M:NPOI.SS.Formula.Eval.FunctionNameEval.#ctor(System.String)">
  32743. Creates a NameEval representing a function name
  32744. </member>
  32745. <member name="T:NPOI.SS.Formula.Eval.IntersectionEval">
  32746. @author Josh Micich
  32747. </member>
  32748. <member name="M:NPOI.SS.Formula.Eval.IntersectionEval.ResolveRange(NPOI.SS.Formula.Eval.AreaEval,NPOI.SS.Formula.Eval.AreaEval)">
  32749. @return simple rectangular {@link AreaEval} which represents the intersection of areas
  32750. <c>aeA</c> and <c>aeB</c>. If the two areas do not intersect, the result is <code>null</code>.
  32751. </member>
  32752. <member name="T:NPOI.SS.Formula.Eval.NotImplementedFunctionException">
  32753. An exception thrown by implementors of {@link FormulaEvaluator} when
  32754. attempting to evaluate a formula which requires a function that POI
  32755. does not (yet) support.
  32756. </member>
  32757. <member name="T:NPOI.SS.Formula.Eval.NumberEval">
  32758. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32759. </member>
  32760. <member name="T:NPOI.SS.Formula.Eval.NumericValueEval">
  32761. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32762. </member>
  32763. <member name="T:NPOI.SS.Formula.Eval.OperandResolver">
  32764. Provides functionality for evaluating arguments to functions and operators.
  32765. @author Josh Micich
  32766. </member>
  32767. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.GetSingleValue(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  32768. Retrieves a single value from a variety of different argument types according to standard
  32769. Excel rules. Does not perform any type conversion.
  32770. @param arg the Evaluated argument as passed to the function or operator.
  32771. @param srcCellRow used when arg is a single column AreaRef
  32772. @param srcCellCol used when arg is a single row AreaRef
  32773. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c> or <c>BlankEval</c>.
  32774. Never <c>null</c> or <c>ErrorEval</c>.
  32775. @throws EvaluationException(#VALUE!) if srcCellRow or srcCellCol do not properly index into
  32776. an AreaEval. If the actual value retrieved is an ErrorEval, a corresponding
  32777. EvaluationException is thrown.
  32778. </member>
  32779. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  32780. Implements (some perhaps not well known) Excel functionality to select a single cell from an
  32781. area depending on the coordinates of the calling cell. Here is an example demonstrating
  32782. both selection from a single row area and a single column area in the same formula.
  32783. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  32784. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  32785. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  32786. <tr><th>2</th><td> </td><td> </td><td> </td><td>200</td></tr>
  32787. <tr><th>3</th><td> </td><td> </td><td> </td><td>300</td></tr>
  32788. <tr><th>3</th><td> </td><td> </td><td> </td><td>400</td></tr>
  32789. </table>
  32790. If the formula "=1000+A1:B1+D2:D3" is put into the 9 cells from A2 to C4, the spReadsheet
  32791. will look like this:
  32792. <table border="1" cellpAdding="1" cellspacing="1" summary="sample spReadsheet">
  32793. <tr><th> </th><th> A </th><th> B </th><th> C </th><th> D </th></tr>
  32794. <tr><th>1</th><td>15</td><td>20</td><td>25</td><td> </td></tr>
  32795. <tr><th>2</th><td>1215</td><td>1220</td><td>#VALUE!</td><td>200</td></tr>
  32796. <tr><th>3</th><td>1315</td><td>1320</td><td>#VALUE!</td><td>300</td></tr>
  32797. <tr><th>4</th><td>#VALUE!</td><td>#VALUE!</td><td>#VALUE!</td><td>400</td></tr>
  32798. </table>
  32799. Note that the row area (A1:B1) does not include column C and the column area (D2:D3) does
  32800. not include row 4, so the values in C1(=25) and D4(=400) are not accessible to the formula
  32801. as written, but in the 4 cells A2:B3, the row and column selection works ok.<p/>
  32802. The same concept is extended to references across sheets, such that even multi-row,
  32803. multi-column areas can be useful.<p/>
  32804. Of course with carefully (or carelessly) chosen parameters, cyclic references can occur and
  32805. hence this method <b>can</b> throw a 'circular reference' EvaluationException. Note that
  32806. this method does not attempt to detect cycles. Every cell in the specified Area <c>ae</c>
  32807. has already been Evaluated prior to this method call. Any cell (or cell<b>s</b>) part of
  32808. <c>ae</c> that would incur a cyclic reference error if selected by this method, will
  32809. already have the value <c>ErrorEval.CIRCULAR_REF_ERROR</c> upon entry to this method. It
  32810. is assumed logic exists elsewhere to produce this behaviour.
  32811. @return whatever the selected cell's Evaluated value Is. Never <c>null</c>. Never
  32812. <c>ErrorEval</c>.
  32813. @if there is a problem with indexing into the area, or if the
  32814. Evaluated cell has an error.
  32815. </member>
  32816. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ChooseSingleElementFromAreaInternal(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32)">
  32817. @return possibly <c>ErrorEval</c>, and <c>null</c>
  32818. </member>
  32819. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToInt(NPOI.SS.Formula.Eval.ValueEval)">
  32820. Applies some conversion rules if the supplied value is not already an integer.<br/>
  32821. Value is first Coerced to a <c>double</c> ( See <c>CoerceValueTodouble()</c> ).<p/>
  32822. Excel typically Converts doubles to integers by truncating toward negative infinity.<br/>
  32823. The equivalent java code Is:<br/>
  32824. <c>return (int)Math.floor(d);</c><br/>
  32825. <b>not</b>:<br/>
  32826. <c>return (int)d; // wrong - rounds toward zero</c>
  32827. </member>
  32828. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToDouble(NPOI.SS.Formula.Eval.ValueEval)">
  32829. Applies some conversion rules if the supplied value is not already a number.
  32830. Note - <c>BlankEval</c> is not supported and must be handled by the caller.
  32831. @param ev must be a <c>NumberEval</c>, <c>StringEval</c> or <c>BoolEval</c>
  32832. @return actual, Parsed or interpreted double value (respectively).
  32833. @throws EvaluationException(#VALUE!) only if a StringEval is supplied and cannot be Parsed
  32834. as a double (See <c>Parsedouble()</c> for allowable formats).
  32835. @throws Exception if the supplied parameter is not <c>NumberEval</c>,
  32836. <c>StringEval</c> or <c>BoolEval</c>
  32837. </member>
  32838. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.ParseDouble(System.String)">
  32839. Converts a string to a double using standard rules that Excel would use.<br/>
  32840. Tolerates currency prefixes, commas, leading and trailing spaces.<p/>
  32841. Some examples:<br/>
  32842. " 123 " -&gt; 123.0<br/>
  32843. ".123" -&gt; 0.123<br/>
  32844. These not supported yet:<br/>
  32845. " $ 1,000.00 " -&gt; 1000.0<br/>
  32846. "$1.25E4" -&gt; 12500.0<br/>
  32847. "5**2" -&gt; 500<br/>
  32848. "250%" -&gt; 2.5<br/>
  32849. @param text
  32850. @return <c>null</c> if the specified text cannot be Parsed as a number
  32851. </member>
  32852. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToString(NPOI.SS.Formula.Eval.ValueEval)">
  32853. @param ve must be a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>, or <c>BlankEval</c>
  32854. @return the Converted string value. never <c>null</c>
  32855. </member>
  32856. <member name="M:NPOI.SS.Formula.Eval.OperandResolver.CoerceValueToBoolean(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  32857. @return <c>null</c> to represent blank values
  32858. @throws EvaluationException if ve is an ErrorEval, or if a string value cannot be converted
  32859. </member>
  32860. <member name="T:NPOI.SS.Formula.Eval.OperationEval">
  32861. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32862. </member>
  32863. <member name="T:NPOI.SS.Formula.Eval.PercentEval">
  32864. Implementation of Excel formula token '%'. <p/>
  32865. @author Josh Micich
  32866. </member>
  32867. <member name="T:NPOI.SS.Formula.Eval.RangeEval">
  32868. @author Josh Micich
  32869. </member>
  32870. <member name="T:NPOI.SS.Formula.Eval.RefEval">
  32871. @author Amol S Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32872. RefEval is the base interface for Ref2D and Ref3DEval. Basically a RefEval
  32873. impl should contain reference to the original ReferencePtg or Ref3DPtg as
  32874. well as the "value" resulting from the evaluation of the cell
  32875. reference. Thus if the HSSFCell has type CELL_TYPE_NUMERIC, the contained
  32876. value object should be of type NumberEval; if cell type is CELL_TYPE_STRING,
  32877. contained value object should be of type StringEval
  32878. </member>
  32879. <member name="M:NPOI.SS.Formula.Eval.RefEval.GetInnerValueEval(System.Int32)">
  32880. The (possibly Evaluated) ValueEval contained
  32881. in this RefEval. eg. if cell A1 Contains "test"
  32882. then in a formula referring to cell A1
  32883. the RefEval representing
  32884. A1 will return as the InnerValueEval the
  32885. object of concrete type StringEval
  32886. </member>
  32887. <member name="P:NPOI.SS.Formula.Eval.RefEval.Column">
  32888. returns the zero based column index.
  32889. </member>
  32890. <member name="P:NPOI.SS.Formula.Eval.RefEval.Row">
  32891. returns the zero based row index.
  32892. </member>
  32893. <member name="P:NPOI.SS.Formula.Eval.RefEval.NumberOfSheets">
  32894. returns the number of sheets this applies to
  32895. </member>
  32896. <member name="M:NPOI.SS.Formula.Eval.RefEval.Offset(System.Int32,System.Int32,System.Int32,System.Int32)">
  32897. Creates an {@link AreaEval} offset by a relative amount from this RefEval
  32898. </member>
  32899. <member name="T:NPOI.SS.Formula.Eval.EqualEval">
  32900. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32901. </member>
  32902. <member name="T:NPOI.SS.Formula.Eval.GreaterEqualEval">
  32903. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32904. </member>
  32905. <member name="T:NPOI.SS.Formula.Eval.GreaterThanEval">
  32906. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32907. </member>
  32908. <member name="T:NPOI.SS.Formula.Eval.LessEqualEval">
  32909. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32910. </member>
  32911. <member name="T:NPOI.SS.Formula.Eval.LessThanEval">
  32912. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32913. </member>
  32914. <member name="T:NPOI.SS.Formula.Eval.NotEqualEval">
  32915. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32916. </member>
  32917. <member name="T:NPOI.SS.Formula.Eval.RelationalOperationEval">
  32918. @author Amol S. Deshmukh &lt; amolweb at ya hoo Dot com &gt;
  32919. </member>
  32920. <member name="T:NPOI.SS.Formula.Eval.StringEval">
  32921. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32922. </member>
  32923. <member name="T:NPOI.SS.Formula.Eval.StringValueEval">
  32924. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32925. </member>
  32926. <member name="P:NPOI.SS.Formula.Eval.StringValueEval.StringValue">
  32927. @return never <code>null</code>, possibly empty string.
  32928. </member>
  32929. <member name="T:NPOI.SS.Formula.Eval.AddEval">
  32930. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32931. This is a documentation of the observed behaviour of
  32932. the '+' operator in Excel:
  32933. - 1+TRUE = 2
  32934. - 1+FALSE = 1
  32935. - 1+"true" = #VALUE!
  32936. - 1+"1" = 2
  32937. - 1+A1 = #VALUE if A1 Contains "1"
  32938. - 1+A1 = 2 if A1 Contains ="1"
  32939. - 1+A1 = 2 if A1 Contains TRUE or =TRUE
  32940. - 1+A1 = #VALUE! if A1 Contains "TRUE" or ="TRUE"
  32941. </member>
  32942. <member name="T:NPOI.SS.Formula.Eval.DivideEval">
  32943. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32944. </member>
  32945. <member name="T:NPOI.SS.Formula.Eval.MultiplyEval">
  32946. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32947. </member>
  32948. <member name="T:NPOI.SS.Formula.Eval.PowerEval">
  32949. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32950. </member>
  32951. <member name="T:NPOI.SS.Formula.Eval.SubtractEval">
  32952. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32953. </member>
  32954. <member name="T:NPOI.SS.Formula.Eval.UnaryMinusEval">
  32955. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32956. </member>
  32957. <member name="T:NPOI.SS.Formula.Eval.UnaryPlusEval">
  32958. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32959. </member>
  32960. <member name="T:NPOI.SS.Formula.Eval.ValueEval">
  32961. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  32962. </member>
  32963. <member name="T:NPOI.SS.Formula.IExternSheetReferenceToken">
  32964. Should be implemented by any {@link Ptg} subclass that needs Has an extern sheet index <br/>
  32965. For POI internal use only
  32966. @author Josh Micich
  32967. </member>
  32968. <member name="T:NPOI.SS.Formula.Formula">
  32969. Encapsulates an encoded formula token array.
  32970. @author Josh Micich
  32971. </member>
  32972. <member name="F:NPOI.SS.Formula.Formula._byteEncoding">
  32973. immutable
  32974. </member>
  32975. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput)">
  32976. Convenience method for {@link #read(int, LittleEndianInput, int)}
  32977. </member>
  32978. <member name="M:NPOI.SS.Formula.Formula.Read(System.Int32,NPOI.Util.ILittleEndianInput,System.Int32)">
  32979. When there are no array constants present, <c>encodedTokenLen</c>==<c>totalEncodedLen</c>
  32980. @param encodedTokenLen number of bytes in the stream taken by the plain formula tokens
  32981. @param totalEncodedLen the total number of bytes in the formula (includes trailing encoding
  32982. for array constants, but does not include 2 bytes for initial <c>ushort encodedTokenLen</c> field.
  32983. @return A new formula object as read from the stream. Possibly empty, never <code>null</code>.
  32984. </member>
  32985. <member name="M:NPOI.SS.Formula.Formula.Serialize(NPOI.Util.ILittleEndianOutput)">
  32986. Writes The formula encoding is includes:
  32987. <ul>
  32988. <li>ushort tokenDataLen</li>
  32989. <li>tokenData</li>
  32990. <li>arrayConstantData (if present)</li>
  32991. </ul>
  32992. </member>
  32993. <member name="P:NPOI.SS.Formula.Formula.EncodedSize">
  32994. @return total formula encoding length. The formula encoding includes:
  32995. <ul>
  32996. <li>ushort tokenDataLen</li>
  32997. <li>tokenData</li>
  32998. <li>arrayConstantData (optional)</li>
  32999. </ul>
  33000. Note - this value is different to <c>tokenDataLength</c>
  33001. </member>
  33002. <member name="P:NPOI.SS.Formula.Formula.EncodedTokenSize">
  33003. This method is often used when the formula length does not appear immediately before
  33004. the encoded token data.
  33005. @return the encoded length of the plain formula tokens. This does <em>not</em> include
  33006. the leading ushort field, nor any trailing array constant data.
  33007. </member>
  33008. <member name="M:NPOI.SS.Formula.Formula.Create(NPOI.SS.Formula.PTG.Ptg[])">
  33009. Creates a {@link Formula} object from a supplied {@link Ptg} array.
  33010. Handles <code>null</code>s OK.
  33011. @param ptgs may be <code>null</code>
  33012. @return Never <code>null</code> (Possibly empty if the supplied <c>ptgs</c> is <code>null</code>)
  33013. </member>
  33014. <member name="M:NPOI.SS.Formula.Formula.GetTokens(NPOI.SS.Formula.Formula)">
  33015. Gets the {@link Ptg} array from the supplied {@link Formula}.
  33016. Handles <code>null</code>s OK.
  33017. @param formula may be <code>null</code>
  33018. @return possibly <code>null</code> (if the supplied <c>formula</c> is <code>null</code>)
  33019. </member>
  33020. <member name="P:NPOI.SS.Formula.Formula.ExpReference">
  33021. Gets the locator for the corresponding {@link SharedFormulaRecord}, {@link ArrayRecord} or
  33022. {@link TableRecord} if this formula belongs to such a grouping. The {@link CellReference}
  33023. returned by this method will match the top left corner of the range of that grouping.
  33024. The return value is usually not the same as the location of the cell containing this formula.
  33025. @return the firstRow &amp; firstColumn of an array formula or shared formula that this formula
  33026. belongs to. <code>null</code> if this formula is not part of an array or shared formula.
  33027. </member>
  33028. <member name="T:NPOI.SS.Formula.FormulaCellCache">
  33029. @author Josh Micich
  33030. </member>
  33031. <member name="M:NPOI.SS.Formula.FormulaCellCache.Get(NPOI.SS.Formula.IEvaluationCell)">
  33032. @return <c>null</c> if not found
  33033. </member>
  33034. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntry">
  33035. Stores the cached result of a formula evaluation, along with the Set of sensititive input cells
  33036. @author Josh Micich
  33037. </member>
  33038. <member name="F:NPOI.SS.Formula.FormulaCellCacheEntry._sensitiveInputCells">
  33039. Cells 'used' in the current evaluation of the formula corresponding To this cache entry
  33040. If any of the following cells Change, this cache entry needs To be Cleared
  33041. </member>
  33042. <member name="T:NPOI.SS.Formula.FormulaCellCacheEntrySet">
  33043. A custom implementation of {@link java.util.HashSet} in order To reduce memory consumption.
  33044. Profiling tests (Oct 2008) have shown that each element {@link FormulaCellCacheEntry} takes
  33045. around 32 bytes To store in a HashSet, but around 6 bytes To store here. For Spreadsheets with
  33046. thousands of formula cells with multiple interdependencies, the savings can be very significant.
  33047. @author Josh Micich
  33048. </member>
  33049. <member name="T:NPOI.SS.Formula.FormulaParseException">
  33050. <summary>
  33051. Specific exception thrown when a supplied formula does not Parse properly.
  33052. Primarily used by test cases when testing for specific parsing exceptions.
  33053. </summary>
  33054. </member>
  33055. <member name="M:NPOI.SS.Formula.FormulaParseException.#ctor(System.String)">
  33056. <summary>
  33057. This class was given package scope until it would become Clear that it is useful to general client code.
  33058. </summary>
  33059. <param name="msg"></param>
  33060. </member>
  33061. <member name="F:NPOI.SS.Formula.FormulaParser.look">
  33062. Lookahead Character.
  33063. Gets value '\0' when the input string is exhausted
  33064. </member>
  33065. <member name="M:NPOI.SS.Formula.FormulaParser.#ctor(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,System.Int32)">
  33066. Create the formula Parser, with the string that is To be
  33067. Parsed against the supplied workbook.
  33068. A later call the Parse() method To return ptg list in
  33069. rpn order, then call the GetRPNPtg() To retrive the
  33070. Parse results.
  33071. This class is recommended only for single threaded use.
  33072. If you only have a usermodel.HSSFWorkbook, and not a
  33073. model.Workbook, then use the convenience method on
  33074. usermodel.HSSFFormulaEvaluator
  33075. </member>
  33076. <member name="M:NPOI.SS.Formula.FormulaParser.Parse(System.String,NPOI.SS.Formula.IFormulaParsingWorkbook,NPOI.SS.Formula.FormulaType,System.Int32)">
  33077. Parse a formula into a array of tokens
  33078. @param formula the formula to parse
  33079. @param workbook the parent workbook
  33080. @param formulaType the type of the formula, see {@link FormulaType}
  33081. @param sheetIndex the 0-based index of the sheet this formula belongs to.
  33082. The sheet index is required to resolve sheet-level names. <code>-1</code> means that
  33083. the scope of the name will be ignored and the parser will match names only by name
  33084. @return array of parsed tokens
  33085. @throws FormulaParseException if the formula is unparsable
  33086. </member>
  33087. <member name="M:NPOI.SS.Formula.FormulaParser.GetChar">
  33088. Read New Character From Input Stream
  33089. </member>
  33090. <member name="M:NPOI.SS.Formula.FormulaParser.expected(System.String)">
  33091. Report What Was Expected
  33092. </member>
  33093. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlpha(System.Char)">
  33094. Recognize an Alpha Character
  33095. </member>
  33096. <member name="M:NPOI.SS.Formula.FormulaParser.IsDigit(System.Char)">
  33097. Recognize a Decimal Digit
  33098. </member>
  33099. <member name="M:NPOI.SS.Formula.FormulaParser.IsAlNum(System.Char)">
  33100. Recognize an Alphanumeric
  33101. </member>
  33102. <member name="M:NPOI.SS.Formula.FormulaParser.IsWhite(System.Char)">
  33103. Recognize White Space
  33104. </member>
  33105. <member name="M:NPOI.SS.Formula.FormulaParser.SkipWhite">
  33106. Skip Over Leading White Space
  33107. </member>
  33108. <member name="M:NPOI.SS.Formula.FormulaParser.Match(System.Char)">
  33109. Consumes the next input character if it is equal To the one specified otherwise throws an
  33110. unchecked exception. This method does <b>not</b> consume whitespace (before or after the
  33111. matched character).
  33112. </member>
  33113. <member name="M:NPOI.SS.Formula.FormulaParser.GetNum">
  33114. Get a Number
  33115. </member>
  33116. <member name="M:NPOI.SS.Formula.FormulaParser.NeedsMemFunc(NPOI.SS.Formula.ParseNode)">
  33117. From OOO doc: "Whenever one operand of the reference subexpression is a function,
  33118. a defined name, a 3D reference, or an external reference (and no error occurs),
  33119. a tMemFunc token is used"
  33120. </member>
  33121. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidDefinedNameChar(System.Char)">
  33122. @return <c>true</c> if the specified character may be used in a defined name
  33123. </member>
  33124. <member name="M:NPOI.SS.Formula.FormulaParser.CheckValidRangeOperand(System.String,System.Int32,NPOI.SS.Formula.ParseNode)">
  33125. @param currentParsePosition used to format a potential error message
  33126. </member>
  33127. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidRangeOperand(NPOI.SS.Formula.ParseNode)">
  33128. @return false if sub-expression represented the specified ParseNode definitely
  33129. cannot appear on either side of the range (':') operator
  33130. </member>
  33131. <member name="M:NPOI.SS.Formula.FormulaParser.ParseRangeable">
  33132. Parses area refs (things which could be the operand of ':') and simple factors
  33133. Examples
  33134. <pre>
  33135. A$1
  33136. $A$1 : $B1
  33137. A1 ....... C2
  33138. Sheet1 !$A1
  33139. a..b!A1
  33140. 'my sheet'!A1
  33141. .my.sheet!A1
  33142. 'my sheet':'my alt sheet'!A1
  33143. .my.sheet1:.my.sheet2!$B$2
  33144. my.named..range.
  33145. 'my sheet'!my.named.range
  33146. .my.sheet!my.named.range
  33147. foo.bar(123.456, "abc")
  33148. 123.456
  33149. "abc"
  33150. true
  33151. [Foo.xls]!$A$1
  33152. [Foo.xls]'my sheet'!$A$1
  33153. [Foo.xls]!my.named.range
  33154. </pre>
  33155. </member>
  33156. <member name="M:NPOI.SS.Formula.FormulaParser.ParseNonRange(System.Int32)">
  33157. Parses simple factors that are not primitive ranges or range components
  33158. i.e. '!', ':'(and equiv '...') do not appear
  33159. Examples
  33160. <pre>
  33161. my.named...range.
  33162. foo.bar(123.456, "abc")
  33163. 123.456
  33164. "abc"
  33165. true
  33166. </pre>
  33167. </member>
  33168. <member name="M:NPOI.SS.Formula.FormulaParser.CreateAreaRefParseNode(NPOI.SS.Formula.SheetIdentifier,NPOI.SS.Formula.FormulaParser.SimpleRangePart,NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  33169. @param sheetIden may be <code>null</code>
  33170. @param part1
  33171. @param part2 may be <code>null</code>
  33172. </member>
  33173. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleRangePart">
  33174. Parses out a potential LHS or RHS of a ':' intended to produce a plain AreaRef. Normally these are
  33175. proper cell references but they could also be row or column refs like "$AC" or "10"
  33176. @return <code>null</code> (and leaves {@link #_pointer} unchanged if a proper range part does not parse out
  33177. </member>
  33178. <member name="M:NPOI.SS.Formula.FormulaParser.ReduceRangeExpression(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.PTG.Ptg)">
  33179. "A1", "B3" -> "A1:B3"
  33180. "sheet1!A1", "B3" -> "sheet1!A1:B3"
  33181. @return <c>null</c> if the range expression cannot / shouldn't be reduced.
  33182. </member>
  33183. <member name="T:NPOI.SS.Formula.FormulaParser.SimpleRangePart">
  33184. A1, $A1, A$1, $A$1, A, 1
  33185. </member>
  33186. <member name="M:NPOI.SS.Formula.FormulaParser.SimpleRangePart.IsCompatibleForArea(NPOI.SS.Formula.FormulaParser.SimpleRangePart)">
  33187. @return <c>true</c> if the two range parts can be combined in an
  33188. {@link AreaPtg} ( Note - the explicit range operator (:) may still be valid
  33189. when this method returns <c>false</c> )
  33190. </member>
  33191. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetName">
  33192. Note - caller should reset {@link #_pointer} upon <code>null</code> result
  33193. @return The sheet name as an identifier <code>null</code> if '!' is not found in the right place
  33194. </member>
  33195. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSheetRange(System.String,NPOI.SS.Formula.NameIdentifier)">
  33196. If we have something that looks like [book]Sheet1: or
  33197. Sheet1, see if it's actually a range eg Sheet1:Sheet2!
  33198. </member>
  33199. <member name="M:NPOI.SS.Formula.FormulaParser.IsUnquotedSheetNameChar(System.Char)">
  33200. very similar to {@link SheetNameFormatter#isSpecialChar(char)}
  33201. </member>
  33202. <member name="M:NPOI.SS.Formula.FormulaParser.IsValidCellReference(System.String)">
  33203. @return <c>true</c> if the specified name is a valid cell reference
  33204. </member>
  33205. <member name="M:NPOI.SS.Formula.FormulaParser.Function(System.String)">
  33206. Note - Excel Function names are 'case aware but not case sensitive'. This method may end
  33207. up creating a defined name record in the workbook if the specified name is not an internal
  33208. Excel Function, and Has not been encountered before.
  33209. @param name case preserved Function name (as it was entered/appeared in the formula).
  33210. </member>
  33211. <member name="M:NPOI.SS.Formula.FormulaParser.GetFunction(System.String,NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.ParseNode[])">
  33212. * Generates the variable Function ptg for the formula.
  33213. *
  33214. * For IF Formulas, Additional PTGs are Added To the Tokens
  33215. * @param name a {@link NamePtg} or {@link NameXPtg} or <code>null</code>
  33216. * @return Ptg a null is returned if we're in an IF formula, it needs extreme manipulation and is handled in this Function
  33217. </member>
  33218. <member name="M:NPOI.SS.Formula.FormulaParser.Arguments">
  33219. Get arguments To a Function
  33220. </member>
  33221. <member name="M:NPOI.SS.Formula.FormulaParser.PowerFactor">
  33222. Parse and Translate a Math Factor
  33223. </member>
  33224. <member name="M:NPOI.SS.Formula.FormulaParser.ParseSimpleFactor">
  33225. factors (without ^ or % )
  33226. </member>
  33227. <member name="M:NPOI.SS.Formula.FormulaParser.GetNumberPtgFromString(System.String,System.String,System.String)">
  33228. Get a PTG for an integer from its string representation.
  33229. return Int or Number Ptg based on size of input
  33230. </member>
  33231. <member name="M:NPOI.SS.Formula.FormulaParser.Term">
  33232. Parse and Translate a Math Term
  33233. </member>
  33234. <member name="M:NPOI.SS.Formula.FormulaParser.AdditiveExpression">
  33235. Parse and Translate an Expression
  33236. </member>
  33237. <member name="M:NPOI.SS.Formula.FormulaParser.Parse">
  33238. API call To execute the parsing of the formula
  33239. </member>
  33240. <member name="T:NPOI.SS.Formula.IFormulaParsingWorkbook">
  33241. Abstracts a workbook for the purpose of formula parsing.<br/>
  33242. For POI internal use only
  33243. @author Josh Micich
  33244. </member>
  33245. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetName(System.String,System.Int32)">
  33246. <summary>
  33247. named range name matching is case insensitive
  33248. </summary>
  33249. <param name="name">The name.</param>
  33250. <param name="sheetIndex">Index of the sheet.</param>
  33251. <returns></returns>
  33252. </member>
  33253. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetNameXPtg(System.String,NPOI.SS.Formula.SheetIdentifier)">
  33254. <summary>
  33255. Gets the name XPTG.
  33256. </summary>
  33257. <param name="name">The name.</param>
  33258. <param name="sheet"></param>
  33259. <returns></returns>
  33260. </member>
  33261. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.CellReference,NPOI.SS.Formula.SheetIdentifier)">
  33262. <summary>
  33263. Produce the appropriate Ptg for a 3d cell reference
  33264. </summary>
  33265. <param name="cell"></param>
  33266. <param name="sheet"></param>
  33267. <returns></returns>
  33268. </member>
  33269. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.Get3DReferencePtg(NPOI.SS.Util.AreaReference,NPOI.SS.Formula.SheetIdentifier)">
  33270. <summary>
  33271. Produce the appropriate Ptg for a 3d area reference
  33272. </summary>
  33273. <param name="area"></param>
  33274. <param name="sheet"></param>
  33275. <returns></returns>
  33276. </member>
  33277. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String)">
  33278. <summary>
  33279. Gets the externSheet index for a sheet from this workbook
  33280. </summary>
  33281. <param name="sheetName">Name of the sheet.</param>
  33282. <returns></returns>
  33283. </member>
  33284. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetExternalSheetIndex(System.String,System.String)">
  33285. <summary>
  33286. Gets the externSheet index for a sheet from an external workbook
  33287. </summary>
  33288. <param name="workbookName">Name of the workbook, e.g. "BudGet.xls"</param>
  33289. <param name="sheetName">a name of a sheet in that workbook</param>
  33290. <returns></returns>
  33291. </member>
  33292. <member name="M:NPOI.SS.Formula.IFormulaParsingWorkbook.GetSpreadsheetVersion">
  33293. <summary>
  33294. Returns an enum holding spReadhseet properties specific to an Excel version (
  33295. max column and row numbers, max arguments to a function, etc.)
  33296. </summary>
  33297. <returns></returns>
  33298. </member>
  33299. <member name="T:NPOI.SS.Formula.FormulaRenderer">
  33300. Common logic for rendering formulas.<br/>
  33301. For POI internal use only
  33302. @author Josh Micich
  33303. </member>
  33304. <member name="M:NPOI.SS.Formula.FormulaRenderer.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook,NPOI.SS.Formula.PTG.Ptg[])">
  33305. Static method To convert an array of {@link Ptg}s in RPN order
  33306. To a human readable string format in infix mode.
  33307. @param book used for defined names and 3D references
  33308. @param ptgs must not be <c>null</c>
  33309. @return a human readable String
  33310. </member>
  33311. <member name="T:NPOI.SS.Formula.IFormulaRenderingWorkbook">
  33312. Abstracts a workbook for the purpose of converting formula To text.<br/>
  33313. For POI internal use only
  33314. @author Josh Micich
  33315. </member>
  33316. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetExternalSheet(System.Int32)">
  33317. @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
  33318. </member>
  33319. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetFirstNameByExternSheet(System.Int32)">
  33320. @return the name of the (first) sheet referred to by the given external sheet index
  33321. </member>
  33322. <member name="M:NPOI.SS.Formula.IFormulaRenderingWorkbook.GetSheetLastNameByExternSheet(System.Int32)">
  33323. @return the name of the (last) sheet referred to by the given external sheet index
  33324. </member>
  33325. <member name="T:NPOI.SS.Formula.FormulaType">
  33326. Enumeration of various formula types.<br/>
  33327. For POI internal use only
  33328. @author Josh Micich
  33329. </member>
  33330. <member name="T:NPOI.SS.Formula.FormulaUsedBlankCellSet">
  33331. Optimisation - compacts many blank cell references used by a single formula.
  33332. @author Josh Micich
  33333. </member>
  33334. <member name="T:NPOI.SS.Formula.Functions.Address">
  33335. Creates a text reference as text, given specified row and column numbers.
  33336. @author Aniket Banerjee (banerjee@google.com)
  33337. </member>
  33338. <member name="P:NPOI.SS.Formula.Functions.SubtotalInstance.IsSubtotalCounted">
  33339. ignore nested subtotals.
  33340. </member>
  33341. <member name="T:NPOI.SS.Formula.Functions.Percentile">
  33342. Returns the k-th percentile of values in a range. You can use this function to establish a threshold of
  33343. acceptance. For example, you can decide to examine candidates who score above the 90th percentile.
  33344. PERCENTILE(array,k)
  33345. Array is the array or range of data that defines relative standing.
  33346. K is the percentile value in the range 0..1, inclusive.
  33347. <strong>Remarks</strong>
  33348. <ul>
  33349. <li>if array is empty or Contains more than 8,191 data points, PERCENTILE returns the #NUM! error value.</li>
  33350. <li>If k is nonnumeric, PERCENTILE returns the #VALUE! error value.</li>
  33351. <li>If k is &lt; 0 or if k &gt; 1, PERCENTILE returns the #NUM! error value.</li>
  33352. <li>If k is not a multiple of 1/(n - 1), PERCENTILE interpolates to determine the value at the k-th percentile.</li>
  33353. </ul>
  33354. </member>
  33355. <member name="T:NPOI.SS.Formula.Functions.AggregateFunction">
  33356. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33357. </member>
  33358. <member name="T:NPOI.SS.Formula.Functions.AverageIf">
  33359. Implementation for the Excel function SUMIF<p>
  33360. Syntax : <br/>
  33361. AVERAGEIF ( <b>range</b>, <b>criteria</b>, avg_range ) <br/>
  33362. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  33363. <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>
  33364. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  33365. <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>
  33366. </table><br/>
  33367. </p>
  33368. @author Josh Micich
  33369. </member>
  33370. <member name="T:NPOI.SS.Formula.Functions.AverageIfs">
  33371. Implementation for the Excel function AverageIfs<br/>
  33372. <p>
  33373. Syntax : <br/>
  33374. AverageIfs ( <b>average_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  33375. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  33376. <ul>
  33377. <li><b>average_range</b> Required. One or more cells to get the average, including numbers or names, ranges,
  33378. or cell references that contain numbers. Blank and text values are ignored.</li>
  33379. <li><b>criteria1_range</b> Required. The first range in which
  33380. to evaluate the associated criteria.</li>
  33381. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  33382. cell reference, or text that define which cells in the criteria_range1
  33383. argument will be counted</li>
  33384. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  33385. Up to 127 range/criteria pairs are allowed.</li>
  33386. </ul>
  33387. </p>
  33388. @author Yegor Kozlov
  33389. </member>
  33390. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  33391. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  33392. as the <code>avgRange</code> argument
  33393. @throws EvaluationException if
  33394. </member>
  33395. <member name="M:NPOI.SS.Formula.Functions.AverageIfs.GetAvgFromMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  33396. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeAvg</code>
  33397. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  33398. @param aeAvg the range to calculate
  33399. @return the computed value
  33400. </member>
  33401. <member name="T:NPOI.SS.Formula.Functions.BaseNumberUtils">
  33402. <p>Some utils for Converting from and to any base</p>
  33403. @author cedric dot walter @ gmail dot com
  33404. </member>
  33405. <member name="T:NPOI.SS.Formula.Functions.Bin2Dec">
  33406. Implementation for Excel Bin2Dec() function.<p/>
  33407. <p/>
  33408. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>)<br/>
  33409. <p/>
  33410. Converts a binary number to decimal.
  33411. <p/>
  33412. Number is the binary number you want to convert. Number cannot contain more than 10 characters (10 bits).
  33413. The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits.
  33414. Negative numbers are represented using two's-complement notation.
  33415. <p/>
  33416. Remark
  33417. If number is not a valid binary number, or if number contains more than 10 characters (10 bits),
  33418. BIN2DEC returns the #NUM! error value.
  33419. @author cedric dot walter @ gmail dot com
  33420. </member>
  33421. <member name="T:NPOI.SS.Formula.Functions.BooleanFunction">
  33422. Here are the general rules concerning Boolean functions:
  33423. <ol>
  33424. <li> Blanks are ignored (not either true or false) </li>
  33425. <li> Strings are ignored if part of an area ref or cell ref, otherwise they must be 'true' or 'false'</li>
  33426. <li> Numbers: 0 is false. Any other number is TRUE </li>
  33427. <li> Areas: *all* cells in area are evaluated according to the above rules</li>
  33428. </ol>
  33429. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33430. </member>
  33431. <member name="T:NPOI.SS.Formula.Functions.False">
  33432. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33433. </member>
  33434. <member name="T:NPOI.SS.Formula.Functions.True">
  33435. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33436. </member>
  33437. <member name="T:NPOI.SS.Formula.Functions.CalendarFieldFunction">
  33438. Implementation of Excel functions Date parsing functions:
  33439. Date - DAY, MONTH and YEAR
  33440. Time - HOUR, MINUTE and SECOND
  33441. @author Others (not mentioned in code)
  33442. @author Thies Wellpott
  33443. </member>
  33444. <member name="T:NPOI.SS.Formula.Functions.Ceiling">
  33445. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33446. </member>
  33447. <member name="T:NPOI.SS.Formula.Functions.Choose">
  33448. @author Josh Micich
  33449. </member>
  33450. <member name="T:NPOI.SS.Formula.Functions.Code">
  33451. Implementation for Excel CODE () function.<p/>
  33452. <p/>
  33453. <b>Syntax</b>:<br/> <b>CODE </b>(<b>text</b> )<br/>
  33454. <p/>
  33455. Returns a numeric code for the first character in a text string. The returned code corresponds to the character set used by your computer.
  33456. <p/>
  33457. text The text for which you want the code of the first character.
  33458. @author cedric dot walter @ gmail dot com
  33459. </member>
  33460. <member name="T:NPOI.SS.Formula.Functions.Columns">
  33461. Implementation for Excel COLUMNS function.
  33462. @author Josh Micich
  33463. </member>
  33464. <member name="T:NPOI.SS.Formula.Functions.Combin">
  33465. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33466. </member>
  33467. <member name="T:NPOI.SS.Formula.Functions.Complex">
  33468. Implementation for Excel COMPLEX () function.<p/>
  33469. <p/>
  33470. <b>Syntax</b>:<br/> <b>COMPLEX </b>(<b>real_num</b>,<b>i_num</b>,<b>suffix </b> )<br/>
  33471. <p/>
  33472. Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.
  33473. <p/>
  33474. <p/>
  33475. All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J".
  33476. Using uppercase results in the #VALUE! error value. All functions that accept two
  33477. or more complex numbers require that all suffixes match.
  33478. <p/>
  33479. <b>real_num</b> The real coefficient of the complex number.
  33480. If this argument is nonnumeric, this function returns the #VALUE! error value.
  33481. <p/>
  33482. <p/>
  33483. <b>i_num</b> The imaginary coefficient of the complex number.
  33484. If this argument is nonnumeric, this function returns the #VALUE! error value.
  33485. <p/>
  33486. <p/>
  33487. <b>suffix</b> The suffix for the imaginary component of the complex number.
  33488. <ul>
  33489. <li>If omitted, suffix is assumed to be "i".</li>
  33490. <li>If suffix is neither "i" nor "j", COMPLEX returns the #VALUE! error value.</li>
  33491. </ul>
  33492. @author cedric dot walter @ gmail dot com
  33493. </member>
  33494. <member name="T:NPOI.SS.Formula.Functions.Count">
  33495. Counts the number of cells that contain numeric data within
  33496. the list of arguments.
  33497. Excel Syntax
  33498. COUNT(value1,value2,...)
  33499. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  33500. TODO: Check this properly Matches excel on edge cases
  33501. like formula cells, error cells etc
  33502. </member>
  33503. <member name="M:NPOI.SS.Formula.Functions.Count.SubtotalInstance">
  33504. Create an instance of Count to use in {@link Subtotal}
  33505. <p>
  33506. If there are other subtotals within argument refs (or nested subtotals),
  33507. these nested subtotals are ignored to avoid double counting.
  33508. </p>
  33509. @see Subtotal
  33510. </member>
  33511. <member name="T:NPOI.SS.Formula.Functions.Counta">
  33512. Counts the number of cells that contain data within the list of arguments.
  33513. Excel Syntax
  33514. COUNTA(value1,value2,...)
  33515. Value1, value2, ... are 1 to 30 arguments representing the values or ranges to be Counted.
  33516. @author Josh Micich
  33517. </member>
  33518. <member name="M:NPOI.SS.Formula.Functions.Counta.SubtotalPredicate.Matches(NPOI.SS.Formula.TwoDEval,System.Int32,System.Int32)">
  33519. don't count cells that are subtotals
  33520. </member>
  33521. <member name="T:NPOI.SS.Formula.Functions.Countblank">
  33522. Implementation for the function COUNTBLANK
  33523. <p>
  33524. Syntax: COUNTBLANK ( range )
  33525. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  33526. <tr><th>range </th><td>is the range of cells to count blanks</td></tr>
  33527. </table>
  33528. </p>
  33529. @author Mads Mohr Christensen
  33530. </member>
  33531. <member name="T:NPOI.SS.Formula.Functions.Countif">
  33532. Implementation for the function COUNTIF<p/>
  33533. Syntax: COUNTIF ( range, criteria )
  33534. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  33535. <tr><th>range </th><td>is the range of cells to be Counted based on the criteria</td></tr>
  33536. <tr><th>criteria</th><td>is used to determine which cells to Count</td></tr>
  33537. </table>
  33538. <p/>
  33539. @author Josh Micich
  33540. </member>
  33541. <member name="P:NPOI.SS.Formula.Functions.Countif.CmpOp.Length">
  33542. @return number of characters used to represent this operator
  33543. </member>
  33544. <member name="M:NPOI.SS.Formula.Functions.Countif.StringMatcher.GetWildCardPattern(System.String)">
  33545. <summary>
  33546. Translates Excel countif wildcard strings into .NET regex strings
  33547. </summary>
  33548. <param name="value">Excel wildcard expression</param>
  33549. <returns>return null if the specified value contains no special wildcard characters.</returns>
  33550. </member>
  33551. <member name="M:NPOI.SS.Formula.Functions.Countif.CountMatchingCellsInArea(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  33552. @return the number of evaluated cells in the range that match the specified criteria
  33553. </member>
  33554. <member name="M:NPOI.SS.Formula.Functions.Countif.EvaluateCriteriaArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33555. @return the de-referenced criteria arg (possibly {@link ErrorEval})
  33556. </member>
  33557. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateGeneralMatchPredicate(NPOI.SS.Formula.Eval.StringEval)">
  33558. When the second argument is a string, many things are possible
  33559. </member>
  33560. <member name="M:NPOI.SS.Formula.Functions.Countif.CreateCriteriaPredicate(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  33561. Creates a criteria predicate object for the supplied criteria arg
  33562. @return <code>null</code> if the arg evaluates to blank.
  33563. </member>
  33564. <member name="M:NPOI.SS.Formula.Functions.Countif.ParseBoolean(System.String)">
  33565. bool literals ('TRUE', 'FALSE') treated similarly but NOT same as numbers.
  33566. </member>
  33567. <member name="T:NPOI.SS.Formula.Functions.Countifs">
  33568. Implementation for the function COUNTIFS
  33569. <p>
  33570. Syntax: COUNTIFS(criteria_range1, criteria1, [criteria_range2, criteria2])
  33571. </p>
  33572. </member>
  33573. <member name="T:NPOI.SS.Formula.Functions.IMatchPredicate">
  33574. Common interface for the matching criteria.
  33575. </member>
  33576. <member name="T:NPOI.SS.Formula.Functions.CountUtils">
  33577. Common logic for COUNT, COUNTA and COUNTIF
  33578. @author Josh Micich
  33579. </member>
  33580. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInRef(NPOI.SS.Formula.Eval.RefEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  33581. @return the number of evaluated cells in the range that match the specified criteria
  33582. </member>
  33583. <member name="M:NPOI.SS.Formula.Functions.CountUtils.CountMatchingCellsInArea(NPOI.SS.Formula.ThreeDEval,NPOI.SS.Formula.Functions.IMatchPredicate)">
  33584. @return the number of evaluated cells in the range that match the specified criteria
  33585. </member>
  33586. <member name="T:NPOI.SS.Formula.Functions.DateFunc">
  33587. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  33588. </member>
  33589. <member name="M:NPOI.SS.Formula.Functions.DateFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  33590. * Note - works with Java Calendar months, not Excel months
  33591. * Java Calendar month = Excel month + 1
  33592. </member>
  33593. <member name="T:NPOI.SS.Formula.Functions.Dec2Bin">
  33594. Implementation for Excel Bin2Dec() function.<p/>
  33595. <p/>
  33596. <b>Syntax</b>:<br/> <b>Bin2Dec </b>(<b>number</b>,<b>[places]</b> )<br/>
  33597. <p/>
  33598. Converts a decimal number to binary.
  33599. <p/>
  33600. The DEC2BIN function syntax has the following arguments:
  33601. <ul>
  33602. <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>
  33603. <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>
  33604. </ul>
  33605. <p/>
  33606. Remarks
  33607. <ul>
  33608. <li>If number &lt; -512 or if number &gt; 511, DEC2BIN returns the #NUM! error value.</li>
  33609. <li>If number is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  33610. <li>If DEC2BIN requires more than places characters, it returns the #NUM! error value.</li>
  33611. <li>If places is not an integer, it is tRuncated.</li>
  33612. <li>If places is nonnumeric, DEC2BIN returns the #VALUE! error value.</li>
  33613. <li>If places is zero or negative, DEC2BIN returns the #NUM! error value.</li>
  33614. </ul>
  33615. @author cedric dot walter @ gmail dot com
  33616. </member>
  33617. <member name="T:NPOI.SS.Formula.Functions.Dec2Hex">
  33618. Implementation for Excel DELTA() function.<p/>
  33619. <p/>
  33620. <b>Syntax</b>:<br/> <b>DEC2HEX </b>(<b>number</b>,<b>places</b> )<br/>
  33621. <p/>
  33622. Converts a decimal number to hexadecimal.
  33623. The decimal integer you want to Convert. If number is negative, places is ignored
  33624. and this function returns a 10-character (40-bit) hexadecimal number in which the
  33625. most significant bit is the sign bit. The remaining 39 bits are magnitude bits.
  33626. Negative numbers are represented using two's-complement notation.
  33627. <ul>
  33628. <li>If number &lt; -549,755,813,888 or if number &gt; 549,755,813,887, this function returns the #NUM! error value.</li>
  33629. <li>If number is nonnumeric, this function returns the #VALUE! error value.</li>
  33630. </ul>
  33631. <h2>places</h2>
  33632. The number of characters to use. The places argument is useful for pAdding the
  33633. return value with leading 0s (zeros).
  33634. <ul>
  33635. <li>If this argument is omitted, this function uses the minimum number of characters necessary.</li>
  33636. <li>If this function requires more than places characters, it returns the #NUM! error value.</li>
  33637. <li>If this argument is nonnumeric, this function returns the #VALUE! error value.</li>
  33638. <li>If this argument is negative, this function returns the #NUM! error value.</li>
  33639. <li>If this argument Contains a decimal value, this function ignores the numbers to the right side of the decimal point.</li>
  33640. </ul>
  33641. @author cedric dot walter @ gmail dot com
  33642. </member>
  33643. <member name="T:NPOI.SS.Formula.Functions.Degrees">
  33644. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33645. </member>
  33646. <member name="T:NPOI.SS.Formula.Functions.Delta">
  33647. Implementation for Excel DELTA() function.<p/>
  33648. <p/>
  33649. <b>Syntax</b>:<br/> <b>DELTA </b>(<b>number1</b>,<b>number2</b> )<br/>
  33650. <p/>
  33651. Tests whether two values are Equal. Returns 1 if number1 = number2; returns 0 otherwise.
  33652. Use this function to filter a Set of values. For example, by summing several DELTA functions
  33653. you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.
  33654. <ul>
  33655. <li>If number1 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  33656. <li>If number2 is nonnumeric, DELTA returns the #VALUE! error value.</li>
  33657. </ul>
  33658. @author cedric dot walter @ gmail dot com
  33659. </member>
  33660. <member name="T:NPOI.SS.Formula.Functions.DGet">
  33661. Implementation of the DGet function:
  33662. Finds the value of a column in an area with given conditions.
  33663. TODO:
  33664. - wildcards ? and * in string conditions
  33665. - functions as conditions
  33666. </member>
  33667. <member name="T:NPOI.SS.Formula.Functions.DMin">
  33668. Implementation of the DMin function:
  33669. Finds the minimum value of a column in an area with given conditions.
  33670. TODO:
  33671. - wildcards ? and * in string conditions
  33672. - functions as conditions
  33673. </member>
  33674. <member name="T:NPOI.SS.Formula.Functions.Dollar">
  33675. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33676. </member>
  33677. <member name="T:NPOI.SS.Formula.Functions.DStarRunner">
  33678. This class performs a D* calculation. It takes an {@link IDStarAlgorithm} object and
  33679. uses it for calculating the result value. Iterating a database and Checking the
  33680. entries against the Set of conditions is done here.
  33681. </member>
  33682. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.solveReference(NPOI.SS.Formula.Eval.ValueEval)">
  33683. Resolve reference(-chains) until we have a normal value.
  33684. @param field a ValueEval which can be a RefEval.
  33685. @return a ValueEval which is guaranteed not to be a RefEval
  33686. @If a multi-sheet reference was found along the way.
  33687. </member>
  33688. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForTag(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.TwoDEval)">
  33689. Returns the first column index that matches the given name. The name can either be
  33690. a string or an integer, when it's an integer, then the respective column
  33691. (1 based index) is returned.
  33692. @param nameValueEval
  33693. @param db
  33694. @return the first column index that matches the given name (or int)
  33695. @
  33696. </member>
  33697. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetColumnForString(NPOI.SS.Formula.TwoDEval,System.String)">
  33698. For a given database returns the column number for a column heading.
  33699. @param db Database.
  33700. @param name Column heading.
  33701. @return Corresponding column number.
  33702. @If it's not possible to turn all headings into strings.
  33703. </member>
  33704. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.FullFillsConditions(NPOI.SS.Formula.TwoDEval,System.Int32,NPOI.SS.Formula.TwoDEval)">
  33705. Checks a row in a database against a condition database.
  33706. @param db Database.
  33707. @param row The row in the database to Check.
  33708. @param cdb The condition database to use for Checking.
  33709. @return Whether the row matches the conditions.
  33710. @If references could not be Resolved or comparison
  33711. operators and operands didn't match.
  33712. </member>
  33713. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNormalCondition(NPOI.SS.Formula.Eval.ValueEval,System.String)">
  33714. Test a value against a simple (&lt; &gt; &lt;= &gt;= = starts-with) condition string.
  33715. @param value The value to Check.
  33716. @param condition The condition to check for.
  33717. @return Whether the condition holds.
  33718. @If comparison operator and operands don't match.
  33719. </member>
  33720. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.testNumericCondition(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.DStarRunner.Operator,System.String)">
  33721. Test whether a value matches a numeric condition.
  33722. @param valueEval Value to Check.
  33723. @param op Comparator to use.
  33724. @param condition Value to check against.
  33725. @return whether the condition holds.
  33726. @If it's impossible to turn the condition into a number.
  33727. </member>
  33728. <member name="M:NPOI.SS.Formula.Functions.DStarRunner.GetStringFromValueEval(NPOI.SS.Formula.Eval.ValueEval)">
  33729. Takes a ValueEval and tries to retrieve a String value from it.
  33730. It tries to resolve references if there are any.
  33731. @param value ValueEval to retrieve the string from.
  33732. @return String corresponding to the given ValueEval.
  33733. @If it's not possible to retrieve a String value.
  33734. </member>
  33735. <member name="T:NPOI.SS.Formula.Functions.EDate">
  33736. Implementation of Excel 'Analysis ToolPak' function EDATE()<br/>
  33737. Adds a specified number of months to the specified date.<p/>
  33738. <b>Syntax</b><br/>
  33739. <b>EDATE</b>(<b>date</b>, <b>number</b>)
  33740. <p/>
  33741. @author Tomas Herceg
  33742. </member>
  33743. <member name="T:NPOI.SS.Formula.Functions.EOMonth">
  33744. Implementation for the Excel EOMONTH() function.<p/>
  33745. <p/>
  33746. EOMONTH() returns the date of the last day of a month..<p/>
  33747. <p/>
  33748. <b>Syntax</b>:<br/>
  33749. <b>EOMONTH</b>(<b>start_date</b>,<b>months</b>)<p/>
  33750. <p/>
  33751. <b>start_date</b> is the starting date of the calculation
  33752. <b>months</b> is the number of months to be Added to <b>start_date</b>,
  33753. to give a new date. For this new date, <b>EOMONTH</b> returns the date of
  33754. the last day of the month. <b>months</b> may be positive (in the future),
  33755. zero or negative (in the past).
  33756. </member>
  33757. <member name="T:NPOI.SS.Formula.Functions.Errortype">
  33758. Implementation for the ERROR.TYPE() Excel function.
  33759. <p>
  33760. <b>Syntax:</b><br/>
  33761. <b>ERROR.TYPE</b>(<b>errorValue</b>)</p>
  33762. <p>
  33763. Returns a number corresponding to the error type of the supplied argument.</p>
  33764. <p>
  33765. <table border="1" cellpadding="1" cellspacing="1" summary="Return values for ERROR.TYPE()">
  33766. <tr><td>errorValue</td><td>Return Value</td></tr>
  33767. <tr><td>#NULL!</td><td>1</td></tr>
  33768. <tr><td>#DIV/0!</td><td>2</td></tr>
  33769. <tr><td>#VALUE!</td><td>3</td></tr>
  33770. <tr><td>#REF!</td><td>4</td></tr>
  33771. <tr><td>#NAME?</td><td>5</td></tr>
  33772. <tr><td>#NUM!</td><td>6</td></tr>
  33773. <tr><td>#N/A!</td><td>7</td></tr>
  33774. <tr><td>everything else</td><td>#N/A!</td></tr>
  33775. </table>
  33776. Note - the results of ERROR.TYPE() are different to the constants defined in
  33777. <tt>ErrorConstants</tt>.
  33778. </p>
  33779. @author Josh Micich
  33780. </member>
  33781. <member name="T:NPOI.SS.Formula.Functions.Even">
  33782. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33783. </member>
  33784. <member name="T:NPOI.SS.Formula.Functions.Exp">
  33785. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33786. </member>
  33787. <member name="T:NPOI.SS.Formula.Functions.Fact">
  33788. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33789. </member>
  33790. <member name="T:NPOI.SS.Formula.Functions.FactDouble">
  33791. Implementation for Excel FACTDOUBLE() function.<p/>
  33792. <p/>
  33793. <b>Syntax</b>:<br/> <b>FACTDOUBLE </b>(<b>number</b>)<br/>
  33794. <p/>
  33795. Returns the double factorial of a number.
  33796. <p/>
  33797. Number is the value for which to return the double factorial. If number is not an integer, it is truncated.
  33798. <p/>
  33799. Remarks
  33800. <ul>
  33801. <li>If number is nonnumeric, FACTDOUBLE returns the #VALUE! error value.</li>
  33802. <li>If number is negative, FACTDOUBLE returns the #NUM! error value.</li>
  33803. </ul>
  33804. Use a cache for more speed of previously calculated factorial
  33805. @author cedric dot walter @ gmail dot com
  33806. </member>
  33807. <member name="T:NPOI.SS.Formula.Functions.Finance">
  33808. Implementation of the financial functions pmt, fv, ppmt, ipmt.
  33809. @author Mike Argyriou micharg@gmail.com
  33810. </member>
  33811. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  33812. Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type)
  33813. function, which calculates the payments for a loan or the future value of an investment
  33814. @param r
  33815. - periodic interest rate represented as a decimal.
  33816. @param nper
  33817. - number of total payments / periods.
  33818. @param pv
  33819. - present value -- borrowed or invested principal.
  33820. @param fv
  33821. - future value of loan or annuity.
  33822. @param type
  33823. - when payment is made: beginning of period is 1; end, 0.
  33824. @return <code>double</code> representing periodic payment amount.
  33825. </member>
  33826. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double,System.Double)">
  33827. Overloaded pmt() call omitting type, which defaults to 0.
  33828. @see #pmt(double, int, double, double, int)
  33829. </member>
  33830. <member name="M:NPOI.SS.Formula.Functions.Finance.PMT(System.Double,System.Int32,System.Double)">
  33831. Overloaded pmt() call omitting fv and type, which both default to 0.
  33832. @see #pmt(double, int, double, double, int)
  33833. </member>
  33834. <member name="M:NPOI.SS.Formula.Functions.Finance.IPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  33835. Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV,
  33836. FV, Type) function, which calculates the portion of the payment at a
  33837. given period that is the interest on previous balance.
  33838. @param r
  33839. - periodic interest rate represented as a decimal.
  33840. @param per
  33841. - period (payment number) to check value at.
  33842. @param nper
  33843. - number of total payments / periods.
  33844. @param pv
  33845. - present value -- borrowed or invested principal.
  33846. @param fv
  33847. - future value of loan or annuity.
  33848. @param type
  33849. - when payment is made: beginning of period is 1; end, 0.
  33850. @return <code>double</code> representing interest portion of payment.
  33851. @see #pmt(double, int, double, double, int)
  33852. @see #fv(double, int, double, double, int)
  33853. </member>
  33854. <member name="M:NPOI.SS.Formula.Functions.Finance.PPMT(System.Double,System.Int32,System.Int32,System.Double,System.Double,System.Int32)">
  33855. Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV,
  33856. FV, Type) function, which calculates the portion of the payment at a
  33857. given period that will apply to principal.
  33858. @param r
  33859. - periodic interest rate represented as a decimal.
  33860. @param per
  33861. - period (payment number) to check value at.
  33862. @param nper
  33863. - number of total payments / periods.
  33864. @param pv
  33865. - present value -- borrowed or invested principal.
  33866. @param fv
  33867. - future value of loan or annuity.
  33868. @param type
  33869. - when payment is made: beginning of period is 1; end, 0.
  33870. @return <code>double</code> representing principal portion of payment.
  33871. @see #pmt(double, int, double, double, int)
  33872. @see #ipmt(double, int, int, double, double, bool)
  33873. </member>
  33874. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double,System.Int32)">
  33875. Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV,
  33876. Type) function, which calculates future value or principal at period N.
  33877. @param r
  33878. - periodic interest rate represented as a decimal.
  33879. @param nper
  33880. - number of total payments / periods.
  33881. @param pmt
  33882. - periodic payment amount.
  33883. @param pv
  33884. - present value -- borrowed or invested principal.
  33885. @param type
  33886. - when payment is made: beginning of period is 1; end, 0.
  33887. @return <code>double</code> representing future principal value.
  33888. </member>
  33889. <member name="M:NPOI.SS.Formula.Functions.Finance.FV(System.Double,System.Int32,System.Double,System.Double)">
  33890. Overloaded fv() call omitting type, which defaults to 0.
  33891. @see #fv(double, int, double, double, int)
  33892. </member>
  33893. <member name="T:NPOI.SS.Formula.Functions.FinanceFunction">
  33894. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33895. Super class for all Evals for financial function evaluation.
  33896. </member>
  33897. <member name="T:NPOI.SS.Formula.Functions.FinanceLib">
  33898. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  33899. This class Is a functon library for common fiscal functions.
  33900. <b>Glossary of terms/abbreviations:</b>
  33901. <br/>
  33902. <ul>
  33903. <li><em>FV:</em> Future Value</li>
  33904. <li><em>PV:</em> Present Value</li>
  33905. <li><em>NPV:</em> Net Present Value</li>
  33906. <li><em>PMT:</em> (Periodic) Payment</li>
  33907. </ul>
  33908. For more info on the terms/abbreviations please use the references below
  33909. (hyperlinks are subject to Change):
  33910. <br/>Online References:
  33911. <ol>
  33912. <li>GNU Emacs Calc 2.02 Manual: http://theory.uwinnipeg.ca/gnu/calc/calc_203.html</li>
  33913. <li>Yahoo Financial Glossary: http://biz.yahoo.com/f/g/nn.html#y</li>
  33914. <li>MS Excel function reference: http://office.microsoft.com/en-us/assistance/CH062528251033.aspx</li>
  33915. </ol>
  33916. <h3>Implementation Notes:</h3>
  33917. Symbols used in the formulae that follow:<br/>
  33918. <ul>
  33919. <li>p: present value</li>
  33920. <li>f: future value</li>
  33921. <li>n: number of periods</li>
  33922. <li>y: payment (in each period)</li>
  33923. <li>r: rate</li>
  33924. <li>^: the power operator (NOT the java bitwise XOR operator!)</li>
  33925. </ul>
  33926. [From MS Excel function reference] Following are some of the key formulas
  33927. that are used in this implementation:
  33928. <pre>
  33929. p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0}
  33930. ny + p + f=0 ...{when r=0}
  33931. </pre>
  33932. </member>
  33933. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.fv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33934. Future value of an amount given the number of payments, rate, amount
  33935. of individual payment, present value and bool value indicating whether
  33936. payments are due at the beginning of period
  33937. (false => payments are due at end of period)
  33938. @param r rate
  33939. @param n num of periods
  33940. @param y pmt per period
  33941. @param p future value
  33942. @param t type (true=pmt at end of period, false=pmt at begining of period)
  33943. </member>
  33944. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pv(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33945. Present value of an amount given the number of future payments, rate, amount
  33946. of individual payment, future value and bool value indicating whether
  33947. payments are due at the beginning of period
  33948. (false => payments are due at end of period)
  33949. @param r
  33950. @param n
  33951. @param y
  33952. @param f
  33953. @param t
  33954. </member>
  33955. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.npv(System.Double,System.Double[])">
  33956. calculates the Net Present Value of a principal amount
  33957. given the disCount rate and a sequence of cash flows
  33958. (supplied as an array). If the amounts are income the value should
  33959. be positive, else if they are payments and not income, the
  33960. value should be negative.
  33961. @param r
  33962. @param cfs cashflow amounts
  33963. </member>
  33964. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.pmt(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33965. @param r
  33966. @param n
  33967. @param p
  33968. @param f
  33969. @param t
  33970. </member>
  33971. <member name="M:NPOI.SS.Formula.Functions.FinanceLib.nper(System.Double,System.Double,System.Double,System.Double,System.Boolean)">
  33972. @param r
  33973. @param y
  33974. @param p
  33975. @param f
  33976. @param t
  33977. </member>
  33978. <member name="T:NPOI.SS.Formula.Functions.Fixed0ArgFunction">
  33979. Convenience base class for functions that only take zero arguments.
  33980. @author Josh Micich
  33981. </member>
  33982. <member name="T:NPOI.SS.Formula.Functions.Fixed1ArgFunction">
  33983. Convenience base class for functions that must take exactly one argument.
  33984. @author Josh Micich
  33985. </member>
  33986. <member name="T:NPOI.SS.Formula.Functions.Fixed2ArgFunction">
  33987. Convenience base class for functions that must take exactly two arguments.
  33988. @author Josh Micich
  33989. </member>
  33990. <member name="T:NPOI.SS.Formula.Functions.Fixed3ArgFunction">
  33991. Convenience base class for functions that must take exactly three arguments.
  33992. @author Josh Micich
  33993. </member>
  33994. <member name="T:NPOI.SS.Formula.Functions.Fixed4ArgFunction">
  33995. Convenience base class for functions that must take exactly four arguments.
  33996. @author Josh Micich
  33997. </member>
  33998. <member name="T:NPOI.SS.Formula.Functions.Floor">
  33999. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34000. </member>
  34001. <member name="T:NPOI.SS.Formula.Functions.FreeRefFunction">
  34002. For most Excel functions, involving references ((cell, area), (2d, 3d)), the references are
  34003. passed in as arguments, and the exact location remains fixed. However, a select few Excel
  34004. functions have the ability to access cells that were not part of any reference passed as an
  34005. argument.<br/>
  34006. Two important functions with this feature are <b>INDIRECT</b> and <b>OFFSet</b><p/>
  34007. In POI, the <c>HSSFFormulaEvaluator</c> Evaluates every cell in each reference argument before
  34008. calling the function. This means that functions using fixed references do not need access to
  34009. the rest of the workbook to execute. Hence the <c>Evaluate()</c> method on the common
  34010. interface <c>Function</c> does not take a workbook parameter.
  34011. This interface recognises the requirement of some functions to freely Create and Evaluate
  34012. references beyond those passed in as arguments.
  34013. @author Josh Micich
  34014. </member>
  34015. <member name="M:NPOI.SS.Formula.Functions.FreeRefFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  34016. @param args the pre-Evaluated arguments for this function. args is never <code>null</code>,
  34017. nor are any of its elements.
  34018. @param ec primarily used to identify the source cell Containing the formula being Evaluated.
  34019. may also be used to dynamically create reference evals.
  34020. @return never <code>null</code>. Possibly an instance of <c>ErrorEval</c> in the case of
  34021. a specified Excel error (Exceptions are never thrown to represent Excel errors).
  34022. </member>
  34023. <member name="T:NPOI.SS.Formula.Functions.Function">
  34024. <summary>
  34025. Function serves as a marker interface.
  34026. </summary>
  34027. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34028. </member>
  34029. <member name="M:NPOI.SS.Formula.Functions.Function.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  34030. <summary>
  34031. Evaluates the specified args.
  34032. </summary>
  34033. <param name="args">the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval</param>
  34034. <param name="srcRowIndex">row index of the cell containing the formula under evaluation</param>
  34035. <param name="srcColumnIndex">column index of the cell containing the formula under evaluation</param>
  34036. <returns></returns>
  34037. </member>
  34038. <member name="T:NPOI.SS.Formula.Functions.Function0Arg">
  34039. Implemented by all functions that can be called with zero arguments
  34040. @author Josh Micich
  34041. </member>
  34042. <member name="M:NPOI.SS.Formula.Functions.Function0Arg.Evaluate(System.Int32,System.Int32)">
  34043. see {@link Function#Evaluate(ValueEval[], int, int)}
  34044. </member>
  34045. <member name="T:NPOI.SS.Formula.Functions.Function1Arg">
  34046. Implemented by all functions that can be called with one argument
  34047. @author Josh Micich
  34048. </member>
  34049. <member name="M:NPOI.SS.Formula.Functions.Function1Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval)">
  34050. see {@link Function#Evaluate(ValueEval[], int, int)}
  34051. </member>
  34052. <member name="T:NPOI.SS.Formula.Functions.Function2Arg">
  34053. Implemented by all functions that can be called with two arguments
  34054. @author Josh Micich
  34055. </member>
  34056. <member name="M:NPOI.SS.Formula.Functions.Function2Arg.Evaluate(System.Int32,System.Int32,NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.ValueEval)">
  34057. see {@link Function#Evaluate(ValueEval[], int, int)}
  34058. </member>
  34059. <member name="T:NPOI.SS.Formula.Functions.Function3Arg">
  34060. Implemented by all functions that can be called with three arguments
  34061. @author Josh Micich
  34062. </member>
  34063. <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)">
  34064. see {@link Function#Evaluate(ValueEval[], int, int)}
  34065. </member>
  34066. <member name="T:NPOI.SS.Formula.Functions.Function4Arg">
  34067. Implemented by all functions that can be called with four arguments
  34068. @author Josh Micich
  34069. </member>
  34070. <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)">
  34071. see {@link Function#Evaluate(ValueEval[], int, int)}
  34072. </member>
  34073. <member name="T:NPOI.SS.Formula.Functions.Hex2Dec">
  34074. Implementation for Excel HEX2DEC() function.<p/>
  34075. <p/>
  34076. <b>Syntax</b>:<br/> <b>HEX2DEC </b>(<b>number</b>)<br/>
  34077. <p/>
  34078. Converts a hexadecimal number to decimal.
  34079. <p/>
  34080. Number is the hexadecimal number you want to Convert. Number cannot contain more than 10 characters (40 bits).
  34081. The most significant bit of number is the sign bit.
  34082. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
  34083. Remark
  34084. If number is not a valid hexadecimal number, HEX2DEC returns the #NUM! error value.
  34085. @author cedric dot walter @ gmail dot com
  34086. </member>
  34087. <member name="T:NPOI.SS.Formula.Functions.Hlookup">
  34088. Implementation of the HLOOKUP() function.<p/>
  34089. HLOOKUP Finds a column in a lookup table by the first row value and returns the value from another row.<br/>
  34090. <b>Syntax</b>:<br/>
  34091. <b>HLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>row_index_num</b>, range_lookup)<p/>
  34092. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  34093. <b>table_array</b> An area reference for the lookup data. <br/>
  34094. <b>row_index_num</b> a 1 based index specifying which row value of the lookup data will be returned.<br/>
  34095. <b>range_lookup</b> If TRUE (default), HLOOKUP Finds the largest value less than or equal to
  34096. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  34097. @author Josh Micich
  34098. </member>
  34099. <member name="M:NPOI.SS.Formula.Functions.Hlookup.CreateResultColumnVector(NPOI.SS.Formula.Eval.AreaEval,System.Int32)">
  34100. Returns one column from an <c>AreaEval</c>
  34101. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  34102. </member>
  34103. <member name="T:NPOI.SS.Formula.Functions.Hyperlink">
  34104. Implementation of Excel HYPERLINK function.<p/>
  34105. In Excel this function has special behaviour - it causes the displayed cell value to behave like
  34106. a hyperlink in the GUI. From an evaluation perspective however, it is very simple.<p/>
  34107. <b>Syntax</b>:<br/>
  34108. <b>HYPERLINK</b>(<b>link_location</b>, friendly_name)<p/>
  34109. <b>link_location</b> The URL of the hyperlink <br/>
  34110. <b>friendly_name</b> (optional) the value to display<p/>
  34111. Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}).
  34112. @author Wayne Clingingsmith
  34113. </member>
  34114. <member name="T:NPOI.SS.Formula.Functions.IDStarAlgorithm">
  34115. Interface specifying how an algorithm to be used by {@link DStarRunner} should look like.
  34116. Each implementing class should correspond to one of the D* functions.
  34117. </member>
  34118. <member name="M:NPOI.SS.Formula.Functions.IDStarAlgorithm.Reset">
  34119. Reset the state of this algorithm.
  34120. This is called before each run through a database.
  34121. </member>
  34122. <member name="M:NPOI.SS.Formula.Functions.IDStarAlgorithm.ProcessMatch(NPOI.SS.Formula.Eval.ValueEval)">
  34123. Process a match that is found during a run through a database.
  34124. @param eval ValueEval of the cell in the matching row. References will already be Resolved.
  34125. @return Whether we should continue iterating through the database.
  34126. </member>
  34127. <member name="P:NPOI.SS.Formula.Functions.IDStarAlgorithm.Result">
  34128. Return a result ValueEval that will be the result of the calculation.
  34129. This is always called at the end of a run through the database.
  34130. @return a ValueEval
  34131. </member>
  34132. <member name="T:NPOI.SS.Formula.Functions.If">
  34133. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34134. </member>
  34135. <member name="T:NPOI.SS.Formula.Functions.Imaginary">
  34136. Implementation for Excel IMAGINARY() function.<p/>
  34137. <p/>
  34138. <b>Syntax</b>:<br/> <b>IMAGINARY </b>(<b>Inumber</b>)<br/>
  34139. <p/>
  34140. Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.
  34141. <p/>
  34142. Inumber is a complex number for which you want the imaginary coefficient.
  34143. <p/>
  34144. Remarks
  34145. <ul>
  34146. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  34147. </ul>
  34148. @author cedric dot walter @ gmail dot com
  34149. </member>
  34150. <member name="T:NPOI.SS.Formula.Functions.ImReal">
  34151. Implementation for Excel ImReal() function.<p/>
  34152. <p/>
  34153. <b>Syntax</b>:<br/> <b>ImReal </b>(<b>Inumber</b>)<br/>
  34154. <p/>
  34155. Returns the real coefficient of a complex number in x + yi or x + yj text format.
  34156. <p/>
  34157. Inumber A complex number for which you want the real coefficient.
  34158. <p/>
  34159. Remarks
  34160. <ul>
  34161. <li>If inumber is not in the form x + yi or x + yj, this function returns the #NUM! error value.</li>
  34162. <li>Use COMPLEX to convert real and imaginary coefficients into a complex number.</li>
  34163. </ul>
  34164. @author cedric dot walter @ gmail dot com
  34165. </member>
  34166. <member name="T:NPOI.SS.Formula.Functions.Index">
  34167. Implementation for the Excel function INDEX
  34168. Syntax : <br/>
  34169. INDEX ( reference, row_num[, column_num [, area_num]])<br/>
  34170. INDEX ( array, row_num[, column_num])
  34171. <table border="0" cellpAdding="1" cellspacing="0" summary="Parameter descriptions">
  34172. <tr><th>reference</th><td>typically an area reference, possibly a union of areas</td></tr>
  34173. <tr><th>array</th><td>a literal array value (currently not supported)</td></tr>
  34174. <tr><th>row_num</th><td>selects the row within the array or area reference</td></tr>
  34175. <tr><th>column_num</th><td>selects column within the array or area reference. default Is 1</td></tr>
  34176. <tr><th>area_num</th><td>used when reference Is a union of areas</td></tr>
  34177. </table>
  34178. @author Josh Micich
  34179. </member>
  34180. <member name="M:NPOI.SS.Formula.Functions.Index.GetValueFromArea(NPOI.SS.Formula.Eval.AreaEval,System.Int32,System.Int32,System.Boolean,System.Int32,System.Int32)">
  34181. @param colArgWasPassed <c>false</c> if the INDEX argument lIst had just 2 items
  34182. (exactly 1 comma). If anything Is passed for the <c>column_num</c> argument
  34183. (including {@link BlankEval} or {@link MIssingArgEval}) this parameter will be
  34184. <c>true</c>. ThIs parameter is needed because error codes are slightly
  34185. different when only 2 args are passed.
  34186. </member>
  34187. <member name="M:NPOI.SS.Formula.Functions.Index.ResolveIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34188. @param arg a 1-based index.
  34189. @return the Resolved 1-based index. Zero if the arg was missing or blank
  34190. @throws EvaluationException if the arg Is an error value evaluates to a negative numeric value
  34191. </member>
  34192. <member name="T:NPOI.SS.Formula.Functions.Indirect">
  34193. Implementation for Excel function INDIRECT<p/>
  34194. INDIRECT() returns the cell or area reference denoted by the text argument.<p/>
  34195. <b>Syntax</b>:<br/>
  34196. <b>INDIRECT</b>(<b>ref_text</b>,isA1Style)<p/>
  34197. <b>ref_text</b> a string representation of the desired reference as it would normally be written
  34198. in a cell formula.<br/>
  34199. <b>isA1Style</b> (default TRUE) specifies whether the ref_text should be interpreted as A1-style
  34200. or R1C1-style.
  34201. @author Josh Micich
  34202. </member>
  34203. <member name="M:NPOI.SS.Formula.Functions.Indirect.ParseWorkbookAndSheetName(System.String)">
  34204. @return array of length 2: {workbookName, sheetName,}. Second element will always be
  34205. present. First element may be null if sheetName is unqualified.
  34206. Returns <code>null</code> if text cannot be parsed.
  34207. </member>
  34208. <member name="M:NPOI.SS.Formula.Functions.Indirect.UnescapeString(System.String)">
  34209. @return <code>null</code> if there is a syntax error in any escape sequence
  34210. (the typical syntax error is a single quote character not followed by another).
  34211. </member>
  34212. <member name="T:NPOI.SS.Formula.Functions.Int">
  34213. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34214. </member>
  34215. <member name="T:NPOI.SS.Formula.Functions.Intercept">
  34216. Implementation of Excel function INTERCEPT()<p/>
  34217. Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values<br/>
  34218. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  34219. <b>Syntax</b>:<br/>
  34220. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  34221. @author Johan Karlsteen
  34222. </member>
  34223. <member name="T:NPOI.SS.Formula.Functions.Irr">
  34224. Calculates the internal rate of return.
  34225. Syntax is IRR(values) or IRR(values,guess)
  34226. @author Marcel May
  34227. @author Yegor Kozlov
  34228. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">Wikipedia on IRR</a>
  34229. @see <a href="http://office.microsoft.com/en-us/excel-help/irr-HP005209146.aspx">Excel IRR</a>
  34230. </member>
  34231. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[])">
  34232. Computes the internal rate of return using an estimated irr of 10 percent.
  34233. @param income the income values.
  34234. @return the irr.
  34235. </member>
  34236. <member name="M:NPOI.SS.Formula.Functions.Irr.irr(System.Double[],System.Double)">
  34237. Calculates IRR using the Newton-Raphson Method.
  34238. <p>
  34239. Starting with the guess, the method cycles through the calculation until the result
  34240. is accurate within 0.00001 percent. If IRR can't find a result that works
  34241. after 20 tries, the Double.NaN is returned.
  34242. </p>
  34243. <p>
  34244. The implementation is inspired by the NewtonSolver from the Apache Commons-Math library,
  34245. @see <a href="http://commons.apache.org">http://commons.apache.org</a>
  34246. </p>
  34247. @param values the income values.
  34248. @param guess the initial guess of irr.
  34249. @return the irr value. The method returns <code>Double.NaN</code>
  34250. if the maximum iteration count is exceeded
  34251. @see <a href="http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution">
  34252. http://en.wikipedia.org/wiki/Internal_rate_of_return#Numerical_solution</a>
  34253. @see <a href="http://en.wikipedia.org/wiki/Newton%27s_method">
  34254. http://en.wikipedia.org/wiki/Newton%27s_method</a>
  34255. </member>
  34256. <member name="T:NPOI.SS.Formula.Functions.LinearRegressionFunction">
  34257. Base class for linear regression functions.
  34258. Calculates the linear regression line that is used to predict y values from x values<br/>
  34259. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  34260. <b>Syntax</b>:<br/>
  34261. <b>INTERCEPT</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  34262. or
  34263. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  34264. @author Johan Karlsteen
  34265. </member>
  34266. <member name="T:NPOI.SS.Formula.Functions.Isblank">
  34267. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34268. </member>
  34269. <member name="T:NPOI.SS.Formula.Functions.Iserr">
  34270. contribute by Pavel Egorov
  34271. https://github.com/xoposhiy/npoi/commit/27b34a2389030c7115a666ace65daafda40d61af
  34272. Implementation of Excel <tt>ISERR()</tt> function.<p/>
  34273. <b>Syntax</b>:<br/>
  34274. <b>ISERR</b>(<b>value</b>)<p/>
  34275. <b>value</b> The value to be tested<p/>
  34276. Returns the logical value <tt>TRUE</tt> if value refers to any error value except
  34277. <tt>'#N/A'</tt>; otherwise, it returns <tt>FALSE</tt>.
  34278. </member>
  34279. <member name="T:NPOI.SS.Formula.Functions.Iserror">
  34280. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34281. </member>
  34282. <member name="T:NPOI.SS.Formula.Functions.Islogical">
  34283. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34284. </member>
  34285. <member name="T:NPOI.SS.Formula.Functions.Isna">
  34286. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34287. </member>
  34288. <member name="T:NPOI.SS.Formula.Functions.Isnontext">
  34289. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34290. </member>
  34291. <member name="T:NPOI.SS.Formula.Functions.Isnumber">
  34292. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34293. </member>
  34294. <member name="T:NPOI.SS.Formula.Functions.Isref">
  34295. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34296. </member>
  34297. <member name="T:NPOI.SS.Formula.Functions.Istext">
  34298. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34299. </member>
  34300. <member name="T:NPOI.SS.Formula.Functions.LogicalFunction">
  34301. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34302. </member>
  34303. <member name="M:NPOI.SS.Formula.Functions.LogicalFunction.Evaluate(NPOI.SS.Formula.Eval.ValueEval)">
  34304. @param arg any {@link ValueEval}, potentially {@link BlankEval} or {@link ErrorEval}.
  34305. </member>
  34306. <member name="T:NPOI.SS.Formula.Functions.Lookup">
  34307. Implementation of Excel function LOOKUP.<p/>
  34308. LOOKUP Finds an index row in a lookup table by the first column value and returns the value from another column.
  34309. <b>Syntax</b>:<br/>
  34310. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>lookup_vector</b>, result_vector)<p/>
  34311. <b>lookup_value</b> The value to be found in the lookup vector.<br/>
  34312. <b>lookup_vector</b> An area reference for the lookup data. <br/>
  34313. <b>result_vector</b> Single row or single column area reference from which the result value Is chosen.<br/>
  34314. @author Josh Micich
  34315. </member>
  34316. <member name="T:NPOI.SS.Formula.Functions.LookupUtils">
  34317. Common functionality used by VLOOKUP, HLOOKUP, LOOKUP and MATCH
  34318. @author Josh Micich
  34319. </member>
  34320. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.CreateVector(NPOI.SS.Formula.TwoDEval)">
  34321. @return <c>null</c> if the supplied area is neither a single row nor a single colum
  34322. </member>
  34323. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRowOrColIndexArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34324. Processes the third argument to VLOOKUP, or HLOOKUP (<b>col_index_num</b>
  34325. or <b>row_index_num</b> respectively).<br/>
  34326. Sample behaviour:
  34327. <table border="0" cellpAdding="1" cellspacing="2" summary="Sample behaviour">
  34328. <tr><th>Input Return</th><th>Value </th><th>Thrown Error</th></tr>
  34329. <tr><td>5</td><td>4</td><td> </td></tr>
  34330. <tr><td>2.9</td><td>2</td><td> </td></tr>
  34331. <tr><td>"5"</td><td>4</td><td> </td></tr>
  34332. <tr><td>"2.18e1"</td><td>21</td><td> </td></tr>
  34333. <tr><td>"-$2"</td><td>-3</td><td>*</td></tr>
  34334. <tr><td>FALSE</td><td>-1</td><td>*</td></tr>
  34335. <tr><td>TRUE</td><td>0</td><td> </td></tr>
  34336. <tr><td>"TRUE"</td><td> </td><td>#REF!</td></tr>
  34337. <tr><td>"abc"</td><td> </td><td>#REF!</td></tr>
  34338. <tr><td>""</td><td> </td><td>#REF!</td></tr>
  34339. <tr><td>&lt;blank&gt;</td><td> </td><td>#VALUE!</td></tr>
  34340. </table><br/>
  34341. * Note - out of range errors (both too high and too low) are handled by the caller.
  34342. @return column or row index as a zero-based value
  34343. </member>
  34344. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveTableArrayArg(NPOI.SS.Formula.Eval.ValueEval)">
  34345. The second argument (table_array) should be an area ref, but can actually be a cell ref, in
  34346. which case it Is interpreted as a 1x1 area ref. Other scalar values cause #VALUE! error.
  34347. </member>
  34348. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.ResolveRangeLookupArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34349. Resolves the last (optional) parameter (<b>range_lookup</b>) to the VLOOKUP and HLOOKUP functions.
  34350. @param rangeLookupArg
  34351. @param srcCellRow
  34352. @param srcCellCol
  34353. @return
  34354. @throws EvaluationException
  34355. </member>
  34356. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.LookupIndexOfExactValue(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector)">
  34357. Finds first (lowest index) exact occurrence of specified value.
  34358. @param lookupComparer the value to be found in column or row vector
  34359. @param vector the values to be searched. For VLOOKUP this Is the first column of the
  34360. tableArray. For HLOOKUP this Is the first row of the tableArray.
  34361. @return zero based index into the vector, -1 if value cannot be found
  34362. </member>
  34363. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.PerformBinarySearch(NPOI.SS.Formula.Functions.ValueVector,NPOI.SS.Formula.Functions.LookupValueComparer)">
  34364. Excel has funny behaviour when the some elements in the search vector are the wrong type.
  34365. </member>
  34366. <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)">
  34367. Excel seems to handle mismatched types initially by just stepping 'mid' ix forward to the
  34368. first compatible value.
  34369. @param midIx 'mid' index (value which has the wrong type)
  34370. @return usually -1, signifying that the BinarySearchIndex has been narrowed to the new mid
  34371. index. Zero or greater signifies that an exact match for the lookup value was found
  34372. </member>
  34373. <member name="M:NPOI.SS.Formula.Functions.LookupUtils.FindLastIndexInRunOfEqualValues(NPOI.SS.Formula.Functions.LookupValueComparer,NPOI.SS.Formula.Functions.ValueVector,System.Int32,System.Int32)">
  34374. Once the binary search has found a single match, (V/H)LOOKUP steps one by one over subsequent
  34375. values to choose the last matching item.
  34376. </member>
  34377. <member name="T:NPOI.SS.Formula.Functions.CompareResult">
  34378. Enumeration to support <b>4</b> valued comparison results.<p/>
  34379. Excel lookup functions have complex behaviour in the case where the lookup array has mixed
  34380. types, and/or Is Unordered. Contrary to suggestions in some Excel documentation, there
  34381. does not appear to be a Universal ordering across types. The binary search algorithm used
  34382. Changes behaviour when the Evaluated 'mid' value has a different type to the lookup value.<p/>
  34383. A simple int might have done the same job, but there Is risk in confusion with the well
  34384. known <c>Comparable.CompareTo()</c> and <c>Comparator.Compare()</c> which both use
  34385. a ubiquitous 3 value result encoding.
  34386. </member>
  34387. <member name="T:NPOI.SS.Formula.Functions.BinarySearchIndexes">
  34388. Encapsulates some standard binary search functionality so the Unusual Excel behaviour can
  34389. be clearly distinguished.
  34390. </member>
  34391. <member name="M:NPOI.SS.Formula.Functions.BinarySearchIndexes.GetMidIx">
  34392. @return -1 if the search range Is empty
  34393. </member>
  34394. <member name="T:NPOI.SS.Formula.Functions.ValueVector">
  34395. Represents a single row or column within an <c>AreaEval</c>.
  34396. </member>
  34397. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparer.CompareTo(NPOI.SS.Formula.Eval.ValueEval)">
  34398. @return one of 4 instances or <c>CompareResult</c>: <c>LESS_THAN</c>, <c>EQUAL</c>,
  34399. <c>GREATER_THAN</c> or <c>TYPE_MISMATCH</c>
  34400. </member>
  34401. <member name="M:NPOI.SS.Formula.Functions.LookupValueComparerBase.GetValueAsString">
  34402. used only for debug purposes
  34403. </member>
  34404. <member name="T:NPOI.SS.Formula.Functions.Match">
  34405. Implementation for the MATCH() Excel function.<p/>
  34406. <b>Syntax:</b><br/>
  34407. <b>MATCH</b>(<b>lookup_value</b>, <b>lookup_array</b>, match_type)<p/>
  34408. Returns a 1-based index specifying at what position in the <b>lookup_array</b> the specified
  34409. <b>lookup_value</b> Is found.<p/>
  34410. Specific matching behaviour can be modified with the optional <b>match_type</b> parameter.
  34411. <table border="0" cellpAdding="1" cellspacing="0" summary="match_type parameter description">
  34412. <tr><th>Value</th><th>Matching Behaviour</th></tr>
  34413. <tr><td>1</td><td>(default) Find the largest value that Is less than or equal to lookup_value.
  34414. The lookup_array must be in ascending <i>order</i>*.</td></tr>
  34415. <tr><td>0</td><td>Find the first value that Is exactly equal to lookup_value.
  34416. The lookup_array can be in any order.</td></tr>
  34417. <tr><td>-1</td><td>Find the smallest value that Is greater than or equal to lookup_value.
  34418. The lookup_array must be in descending <i>order</i>*.</td></tr>
  34419. </table>
  34420. * Note regarding <i>order</i> - For the <b>match_type</b> cases that require the lookup_array to
  34421. be ordered, MATCH() can produce incorrect results if this requirement Is not met. Observed
  34422. behaviour in Excel Is to return the lowest index value for which every item after that index
  34423. breaks the match rule.<br/>
  34424. The (ascending) sort order expected by MATCH() Is:<br/>
  34425. numbers (low to high), strings (A to Z), bool (FALSE to TRUE)<br/>
  34426. MATCH() ignores all elements in the lookup_array with a different type to the lookup_value.
  34427. Type conversion of the lookup_array elements Is never performed.
  34428. @author Josh Micich
  34429. </member>
  34430. <member name="M:NPOI.SS.Formula.Functions.Match.FindIndexOfValue(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.ValueVector,System.Boolean,System.Boolean)">
  34431. @return zero based index
  34432. </member>
  34433. <member name="T:NPOI.SS.Formula.Functions.MathX">
  34434. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34435. This class Is an extension to the standard math library
  34436. provided by java.lang.Math class. It follows the Math class
  34437. in that it has a private constructor and all static methods.
  34438. </member>
  34439. <member name="M:NPOI.SS.Formula.Functions.MathX.Round(System.Double,System.Int32)">
  34440. Returns a value rounded to p digits after decimal.
  34441. If p Is negative, then the number Is rounded to
  34442. places to the left of the decimal point. eg.
  34443. 10.23 rounded to -1 will give: 10. If p Is zero,
  34444. the returned value Is rounded to the nearest integral
  34445. value.
  34446. If n Is negative, the resulting value Is obtained
  34447. as the round value of absolute value of n multiplied
  34448. by the sign value of n (@see MathX.sign(double d)).
  34449. Thus, -0.6666666 rounded to p=0 will give -1 not 0.
  34450. If n Is NaN, returned value Is NaN.
  34451. @param n
  34452. @param p
  34453. </member>
  34454. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundUp(System.Double,System.Int32)">
  34455. Returns a value rounded-up to p digits after decimal.
  34456. If p Is negative, then the number Is rounded to
  34457. places to the left of the decimal point. eg.
  34458. 10.23 rounded to -1 will give: 20. If p Is zero,
  34459. the returned value Is rounded to the nearest integral
  34460. value.
  34461. If n Is negative, the resulting value Is obtained
  34462. as the round-up value of absolute value of n multiplied
  34463. by the sign value of n (@see MathX.sign(double d)).
  34464. Thus, -0.2 rounded-up to p=0 will give -1 not 0.
  34465. If n Is NaN, returned value Is NaN.
  34466. @param n
  34467. @param p
  34468. </member>
  34469. <member name="M:NPOI.SS.Formula.Functions.MathX.RoundDown(System.Double,System.Int32)">
  34470. Returns a value rounded to p digits after decimal.
  34471. If p Is negative, then the number Is rounded to
  34472. places to the left of the decimal point. eg.
  34473. 10.23 rounded to -1 will give: 10. If p Is zero,
  34474. the returned value Is rounded to the nearest integral
  34475. value.
  34476. If n Is negative, the resulting value Is obtained
  34477. as the round-up value of absolute value of n multiplied
  34478. by the sign value of n (@see MathX.sign(double d)).
  34479. Thus, -0.8 rounded-down to p=0 will give 0 not -1.
  34480. If n Is NaN, returned value Is NaN.
  34481. @param n
  34482. @param p
  34483. </member>
  34484. <member name="M:NPOI.SS.Formula.Functions.MathX.Average(System.Double[])">
  34485. average of all values
  34486. @param values
  34487. </member>
  34488. <member name="M:NPOI.SS.Formula.Functions.MathX.Sum(System.Double[])">
  34489. sum of all values
  34490. @param values
  34491. </member>
  34492. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumsq(System.Double[])">
  34493. sum of squares of all values
  34494. @param values
  34495. </member>
  34496. <member name="M:NPOI.SS.Formula.Functions.MathX.Product(System.Double[])">
  34497. product of all values
  34498. @param values
  34499. </member>
  34500. <member name="M:NPOI.SS.Formula.Functions.MathX.Min(System.Double[])">
  34501. min of all values. If supplied array Is zero Length,
  34502. double.POSITIVE_INFINITY Is returned.
  34503. @param values
  34504. </member>
  34505. <member name="M:NPOI.SS.Formula.Functions.MathX.Max(System.Double[])">
  34506. min of all values. If supplied array Is zero Length,
  34507. double.NEGATIVE_INFINITY Is returned.
  34508. @param values
  34509. </member>
  34510. <member name="M:NPOI.SS.Formula.Functions.MathX.Floor(System.Double,System.Double)">
  34511. Note: this function Is different from java.lang.Math.floor(..).
  34512. When n and s are "valid" arguments, the returned value Is: Math.floor(n/s) * s;
  34513. <br/>
  34514. n and s are invalid if any of following conditions are true:
  34515. <ul>
  34516. <li>s Is zero</li>
  34517. <li>n Is negative and s Is positive</li>
  34518. <li>n Is positive and s Is negative</li>
  34519. </ul>
  34520. In all such cases, double.NaN Is returned.
  34521. @param n
  34522. @param s
  34523. </member>
  34524. <member name="M:NPOI.SS.Formula.Functions.MathX.Ceiling(System.Double,System.Double)">
  34525. Note: this function Is different from java.lang.Math.ceil(..).
  34526. When n and s are "valid" arguments, the returned value Is: Math.ceiling(n/s) * s;
  34527. <br/>
  34528. n and s are invalid if any of following conditions are true:
  34529. <ul>
  34530. <li>s Is zero</li>
  34531. <li>n Is negative and s Is positive</li>
  34532. <li>n Is positive and s Is negative</li>
  34533. </ul>
  34534. In all such cases, double.NaN Is returned.
  34535. @param n
  34536. @param s
  34537. </member>
  34538. <member name="M:NPOI.SS.Formula.Functions.MathX.Factorial(System.Int32)">
  34539. <br/> for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
  34540. <br/> else if n == 0; factorial n = 1
  34541. <br/> else if n &lt; 0; factorial n = double.NaN
  34542. <br/> Loss of precision can occur if n Is large enough.
  34543. If n Is large so that the resulting value would be greater
  34544. than double.MAX_VALUE; double.POSITIVE_INFINITY Is returned.
  34545. If n &lt; 0, double.NaN Is returned.
  34546. @param n
  34547. </member>
  34548. <member name="M:NPOI.SS.Formula.Functions.MathX.Mod(System.Double,System.Double)">
  34549. returns the remainder resulting from operation:
  34550. n / d.
  34551. <br/> The result has the sign of the divisor.
  34552. <br/> Examples:
  34553. <ul>
  34554. <li>mod(3.4, 2) = 1.4</li>
  34555. <li>mod(-3.4, 2) = 0.6</li>
  34556. <li>mod(-3.4, -2) = -1.4</li>
  34557. <li>mod(3.4, -2) = -0.6</li>
  34558. </ul>
  34559. If d == 0, result Is NaN
  34560. @param n
  34561. @param d
  34562. </member>
  34563. <member name="M:NPOI.SS.Formula.Functions.MathX.Acosh(System.Double)">
  34564. inverse hyperbolic cosine
  34565. @param d
  34566. </member>
  34567. <member name="M:NPOI.SS.Formula.Functions.MathX.Asinh(System.Double)">
  34568. inverse hyperbolic sine
  34569. @param d
  34570. </member>
  34571. <member name="M:NPOI.SS.Formula.Functions.MathX.Atanh(System.Double)">
  34572. inverse hyperbolic tangent
  34573. @param d
  34574. </member>
  34575. <member name="M:NPOI.SS.Formula.Functions.MathX.Cosh(System.Double)">
  34576. hyperbolic cosine
  34577. @param d
  34578. </member>
  34579. <member name="M:NPOI.SS.Formula.Functions.MathX.Sinh(System.Double)">
  34580. hyperbolic sine
  34581. @param d
  34582. </member>
  34583. <member name="M:NPOI.SS.Formula.Functions.MathX.Tanh(System.Double)">
  34584. hyperbolic tangent
  34585. @param d
  34586. </member>
  34587. <member name="M:NPOI.SS.Formula.Functions.MathX.SumProduct(System.Double[][])">
  34588. returns the sum of product of corresponding double value in each
  34589. subarray. It Is the responsibility of the caller to Ensure that
  34590. all the subarrays are of equal Length. If the subarrays are
  34591. not of equal Length, the return value can be Unpredictable.
  34592. @param arrays
  34593. </member>
  34594. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2my2(System.Double[],System.Double[])">
  34595. returns the sum of difference of squares of corresponding double
  34596. value in each subarray: ie. sigma (xarr[i]^2-yarr[i]^2)
  34597. <br/>
  34598. It Is the responsibility of the caller
  34599. to Ensure that the two subarrays are of equal Length. If the
  34600. subarrays are not of equal Length, the return value can be
  34601. Unpredictable.
  34602. @param xarr
  34603. @param yarr
  34604. </member>
  34605. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumx2py2(System.Double[],System.Double[])">
  34606. returns the sum of sum of squares of corresponding double
  34607. value in each subarray: ie. sigma (xarr[i]^2 + yarr[i]^2)
  34608. <br/>
  34609. It Is the responsibility of the caller
  34610. to Ensure that the two subarrays are of equal Length. If the
  34611. subarrays are not of equal Length, the return value can be
  34612. Unpredictable.
  34613. @param xarr
  34614. @param yarr
  34615. </member>
  34616. <member name="M:NPOI.SS.Formula.Functions.MathX.Sumxmy2(System.Double[],System.Double[])">
  34617. returns the sum of squares of difference of corresponding double
  34618. value in each subarray: ie. sigma ( (xarr[i]-yarr[i])^2 )
  34619. <br/>
  34620. It Is the responsibility of the caller
  34621. to Ensure that the two subarrays are of equal Length. If the
  34622. subarrays are not of equal Length, the return value can be
  34623. Unpredictable.
  34624. @param xarr
  34625. @param yarr
  34626. </member>
  34627. <member name="M:NPOI.SS.Formula.Functions.MathX.NChooseK(System.Int32,System.Int32)">
  34628. returns the total number of combinations possible when
  34629. k items are chosen out of total of n items. If the number
  34630. Is too large, loss of precision may occur (since returned
  34631. value Is double). If the returned value Is larger than
  34632. double.MAX_VALUE, double.POSITIVE_INFINITY Is returned.
  34633. If either of the parameters Is negative, double.NaN Is returned.
  34634. @param n
  34635. @param k
  34636. </member>
  34637. <member name="T:NPOI.SS.Formula.Functions.MinaMaxa">
  34638. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34639. </member>
  34640. <member name="T:NPOI.SS.Formula.Functions.Mirr">
  34641. Calculates Modified internal rate of return. Syntax is MIRR(cash_flow_values, finance_rate, reinvest_rate)
  34642. <p>Returns the modified internal rate of return for a series of periodic cash flows. MIRR considers both the cost
  34643. of the investment and the interest received on reinvestment of cash.</p>
  34644. 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.
  34645. <ul>
  34646. <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>
  34647. <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>
  34648. </ul>
  34649. Finance_rate is the interest rate you pay on the money used in the cash flows.
  34650. Reinvest_rate is the interest rate you receive on the cash flows as you reinvest them.
  34651. @author Carlos Delgado (carlos dot del dot est at gmail dot com)
  34652. @author Cédric Walter (cedric dot walter at gmail dot com)
  34653. @see <a href="http://en.wikipedia.org/wiki/MIRR">Wikipedia on MIRR</a>
  34654. @see <a href="http://office.microsoft.com/en-001/excel-help/mirr-HP005209180.aspx">Excel MIRR</a>
  34655. @see {@link Irr}
  34656. </member>
  34657. <member name="T:NPOI.SS.Formula.Functions.Mod">
  34658. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34659. </member>
  34660. <member name="T:NPOI.SS.Formula.Functions.Mode">
  34661. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34662. </member>
  34663. <member name="M:NPOI.SS.Formula.Functions.Mode.Evaluate(System.Double[])">
  34664. if v is zero length or contains no duplicates, return value is
  34665. Double.NaN. Else returns the value that occurs most times and if there is
  34666. a tie, returns the first such value.
  34667. @param v
  34668. </member>
  34669. <member name="T:NPOI.SS.Formula.Functions.MultiOperandNumericFunction">
  34670. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34671. This Is the base class for all excel function evaluator
  34672. classes that take variable number of operands, and
  34673. where the order of operands does not matter
  34674. </member>
  34675. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.MaxNumOperands">
  34676. Maximum number of operands accepted by this function.
  34677. Subclasses may override to Change default value.
  34678. </member>
  34679. <member name="P:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.IsSubtotalCounted">
  34680. Whether to count nested subtotals.
  34681. </member>
  34682. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.CollectValues(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Functions.MultiOperandNumericFunction.DoubleList)">
  34683. Collects values from a single argument
  34684. </member>
  34685. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.GetNumberArray(NPOI.SS.Formula.Eval.ValueEval[])">
  34686. Returns a double array that contains values for the numeric cells
  34687. from among the list of operands. Blanks and Blank equivalent cells
  34688. are ignored. Error operands or cells containing operands of type
  34689. that are considered invalid and would result in #VALUE! error in
  34690. excel cause this function to return <c>null</c>.
  34691. @return never <c>null</c>
  34692. </member>
  34693. <member name="M:NPOI.SS.Formula.Functions.MultiOperandNumericFunction.AreSubArraysConsistent(System.Double[][])">
  34694. Ensures that a two dimensional array has all sub-arrays present and the same Length
  34695. @return <c>false</c> if any sub-array Is missing, or Is of different Length
  34696. </member>
  34697. <member name="T:NPOI.SS.Formula.Functions.Na">
  34698. Implementation of Excel function NA()
  34699. @author Josh Micich
  34700. </member>
  34701. <member name="T:NPOI.SS.Formula.Functions.NotImplementedFunction">
  34702. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34703. This Is the default implementation of a Function class.
  34704. The default behaviour Is to return a non-standard ErrorEval
  34705. "ErrorEval.FUNCTION_NOT_IMPLEMENTED". This error should alert
  34706. the user that the formula contained a function that Is not
  34707. yet implemented.
  34708. </member>
  34709. <member name="T:NPOI.SS.Formula.Functions.Now">
  34710. Implementation of Excel NOW() Function
  34711. @author Frank Taffelt
  34712. </member>
  34713. <member name="T:NPOI.SS.Formula.Functions.Abs">
  34714. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34715. </member>
  34716. <member name="T:NPOI.SS.Formula.Functions.Acos">
  34717. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34718. </member>
  34719. <member name="T:NPOI.SS.Formula.Functions.Acosh">
  34720. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34721. Support for hyperbolic trig functions was Added as a part of
  34722. Java distribution only in JDK1.5. This class uses custom
  34723. naive implementation based on formulas at:
  34724. http://www.math2.org/math/trig/hyperbolics.htm
  34725. These formulas seem to agree with excel's implementation.
  34726. </member>
  34727. <member name="T:NPOI.SS.Formula.Functions.Asin">
  34728. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34729. </member>
  34730. <member name="T:NPOI.SS.Formula.Functions.Asinh">
  34731. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34732. Support for hyperbolic trig functions was Added as a part of
  34733. Java distribution only in JDK1.5. This class uses custom
  34734. naive implementation based on formulas at:
  34735. http://www.math2.org/math/trig/hyperbolics.htm
  34736. These formulas seem to agree with excel's implementation.
  34737. </member>
  34738. <member name="T:NPOI.SS.Formula.Functions.Atan">
  34739. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34740. </member>
  34741. <member name="T:NPOI.SS.Formula.Functions.Atan2">
  34742. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34743. </member>
  34744. <member name="T:NPOI.SS.Formula.Functions.Atanh">
  34745. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34746. Support for hyperbolic trig functions was Added as a part of
  34747. Java distribution only in JDK1.5. This class uses custom
  34748. naive implementation based on formulas at:
  34749. http://www.math2.org/math/trig/hyperbolics.htm
  34750. These formulas seem to agree with excel's implementation.
  34751. </member>
  34752. <member name="T:NPOI.SS.Formula.Functions.Cos">
  34753. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34754. </member>
  34755. <member name="T:NPOI.SS.Formula.Functions.Cosh">
  34756. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34757. </member>
  34758. <member name="T:NPOI.SS.Formula.Functions.Ln">
  34759. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34760. </member>
  34761. <member name="T:NPOI.SS.Formula.Functions.Log">
  34762. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34763. Log: LOG(number,[base])
  34764. </member>
  34765. <member name="T:NPOI.SS.Formula.Functions.Log10">
  34766. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34767. </member>
  34768. <member name="T:NPOI.SS.Formula.Functions.NumericFunction">
  34769. @author Amol S. Deshmukh &lt; amolweb at yahoo dot com &gt;
  34770. </member>
  34771. <member name="T:NPOI.SS.Formula.Functions.Pi">
  34772. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34773. </member>
  34774. <member name="M:NPOI.SS.Formula.Functions.Poisson.IsDefaultResult(System.Double,System.Double)">
  34775. This checks is x = 0 and the mean = 0.
  34776. Excel currently returns the value 1 where as the
  34777. maths common implementation will error.
  34778. @param x The number.
  34779. @param mean The mean.
  34780. @return If a default value should be returned.
  34781. </member>
  34782. <member name="F:NPOI.SS.Formula.Functions.Poisson.FACTORIALS">
  34783. All long-representable factorials
  34784. </member>
  34785. <member name="T:NPOI.SS.Formula.Functions.Rand">
  34786. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34787. </member>
  34788. <member name="T:NPOI.SS.Formula.Functions.Sin">
  34789. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34790. </member>
  34791. <member name="T:NPOI.SS.Formula.Functions.Sinh">
  34792. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34793. </member>
  34794. <member name="T:NPOI.SS.Formula.Functions.Sqrt">
  34795. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34796. </member>
  34797. <member name="T:NPOI.SS.Formula.Functions.Tan">
  34798. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34799. </member>
  34800. <member name="T:NPOI.SS.Formula.Functions.Tanh">
  34801. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34802. </member>
  34803. <member name="T:NPOI.SS.Formula.Functions.Oct2Dec">
  34804. <p>Implementation for Excel Oct2Dec() function.</p>
  34805. <p>
  34806. Converts an octal number to decimal.
  34807. </p>
  34808. <p>
  34809. <b>Syntax</b>:<br/> <b>Oct2Dec </b>(<b>number</b> )
  34810. </p>
  34811. <p/>
  34812. Number is the octal number you want to Convert. Number may not contain more than 10 octal characters (30 bits).
  34813. The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits.
  34814. Negative numbers are represented using two's-complement notation..
  34815. <p/>
  34816. If number is not a valid octal number, OCT2DEC returns the #NUM! error value.
  34817. @author cedric dot walter @ gmail dot com
  34818. </member>
  34819. <member name="T:NPOI.SS.Formula.Functions.Odd">
  34820. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34821. </member>
  34822. <member name="T:NPOI.SS.Formula.Functions.Offset">
  34823. Implementation for Excel function OFFSet()<p/>
  34824. OFFSet returns an area reference that Is a specified number of rows and columns from a
  34825. reference cell or area.<p/>
  34826. <b>Syntax</b>:<br/>
  34827. <b>OFFSet</b>(<b>reference</b>, <b>rows</b>, <b>cols</b>, height, width)<p/>
  34828. <b>reference</b> Is the base reference.<br/>
  34829. <b>rows</b> Is the number of rows up or down from the base reference.<br/>
  34830. <b>cols</b> Is the number of columns left or right from the base reference.<br/>
  34831. <b>height</b> (default same height as base reference) Is the row Count for the returned area reference.<br/>
  34832. <b>width</b> (default same width as base reference) Is the column Count for the returned area reference.<br/>
  34833. @author Josh Micich
  34834. </member>
  34835. <member name="T:NPOI.SS.Formula.Functions.Offset.EvalEx">
  34836. Exceptions are used within this class to help simplify flow control when error conditions
  34837. are enCountered
  34838. </member>
  34839. <member name="T:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange">
  34840. A one dimensional base + offset. Represents either a row range or a column range.
  34841. Two instances of this class toGether specify an area range.
  34842. </member>
  34843. <member name="M:NPOI.SS.Formula.Functions.Offset.LinearOffsetRange.NormaliseAndTranslate(System.Int32)">
  34844. Moves the range by the specified translation amount.<p/>
  34845. This method also 'normalises' the range: Excel specifies that the width and height
  34846. parameters (Length field here) cannot be negative. However, OFFSet() does produce
  34847. sensible results in these cases. That behavior Is replicated here. <p/>
  34848. @param translationAmount may be zero negative or positive
  34849. @return the equivalent <c>LinearOffsetRange</c> with a positive Length, moved by the
  34850. specified translationAmount.
  34851. </member>
  34852. <member name="T:NPOI.SS.Formula.Functions.Offset.BaseRef">
  34853. Encapsulates either an area or cell reference which may be 2d or 3d.
  34854. </member>
  34855. <member name="M:NPOI.SS.Formula.Functions.Offset.EvaluateIntArg(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  34856. OFFSet's numeric arguments (2..5) have similar Processing rules
  34857. </member>
  34858. <member name="M:NPOI.SS.Formula.Functions.Offset.ConvertDoubleToInt(System.Double)">
  34859. Fractional values are silently truncated by Excel.
  34860. Truncation Is toward negative infinity.
  34861. </member>
  34862. <member name="T:NPOI.SS.Formula.Functions.Pmt">
  34863. Implementation for the PMT() Excel function.<p/>
  34864. <b>Syntax:</b><br/>
  34865. <b>PMT</b>(<b>rate</b>, <b>nper</b>, <b>pv</b>, fv, type)<p/>
  34866. Returns the constant repayment amount required for a loan assuming a constant interest rate.<p/>
  34867. <b>rate</b> the loan interest rate.<br/>
  34868. <b>nper</b> the number of loan repayments.<br/>
  34869. <b>pv</b> the present value of the future payments (or principle).<br/>
  34870. <b>fv</b> the future value (default zero) surplus cash at the end of the loan lifetime.<br/>
  34871. <b>type</b> whether payments are due at the beginning(1) or end(0 - default) of each payment period.<br/>
  34872. </member>
  34873. <member name="T:NPOI.SS.Formula.Functions.Power">
  34874. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34875. </member>
  34876. <member name="T:NPOI.SS.Formula.Functions.PPMT">
  34877. Compute the interest portion of a payment.
  34878. @author Mike Argyriou micharg@gmail.com
  34879. </member>
  34880. <member name="T:NPOI.SS.Formula.Functions.Quotient">
  34881. <p>Implementation for Excel QUOTIENT () function.</p>
  34882. <p>
  34883. <b>Syntax</b>:<br/> <b>QUOTIENT</b>(<b>Numerator</b>,<b>Denominator</b>)<br/>
  34884. </p>
  34885. <p>
  34886. Numerator is the dividend.
  34887. Denominator is the divisor.
  34888. Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.
  34889. </p>
  34890. If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value.
  34891. If denominator is Equals to zero, QUOTIENT returns the #DIV/0! error value.
  34892. @author cedric dot walter @ gmail dot com
  34893. </member>
  34894. <member name="T:NPOI.SS.Formula.Functions.Radians">
  34895. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34896. </member>
  34897. <member name="T:NPOI.SS.Formula.Functions.Rank">
  34898. * 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.
  34899. * Syntax:
  34900. * RANK(number,ref,order)
  34901. * Number is the number whose rank you want to find.
  34902. * Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored.
  34903. * Order is a number specifying how to rank number.
  34904. * If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order.
  34905. * If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.
  34906. *
  34907. * @author Rubin Wang
  34908. </member>
  34909. <member name="T:NPOI.SS.Formula.Functions.Rate">
  34910. Implements the Excel Rate function
  34911. </member>
  34912. <member name="M:NPOI.SS.Formula.Functions.Rate.CheckValue(System.Double)">
  34913. Excel does not support infinities and NaNs, rather, it gives a #NUM! error in these cases
  34914. @throws EvaluationException (#NUM!) if result is NaN or Infinity
  34915. </member>
  34916. <member name="T:NPOI.SS.Formula.Functions.Rept">
  34917. Implementation for Excel REPT () function.<p/>
  34918. <p/>
  34919. <b>Syntax</b>:<br/> <b>REPT </b>(<b>text</b>,<b>number_times</b> )<br/>
  34920. <p/>
  34921. Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.
  34922. text : text The text that you want to repeat.
  34923. number_times: A positive number specifying the number of times to repeat text.
  34924. If number_times is 0 (zero), REPT returns "" (empty text).
  34925. If this argument contains a decimal value, this function ignores the numbers to the right side of the decimal point.
  34926. The result of the REPT function cannot be longer than 32,767 characters, or REPT returns #VALUE!.
  34927. @author cedric dot walter @ gmail dot com
  34928. </member>
  34929. <member name="T:NPOI.SS.Formula.Functions.Roman">
  34930. Implementation for Excel WeekNum() function.<p/>
  34931. <p/>
  34932. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  34933. <p/>
  34934. Returns a number that indicates where the week falls numerically within a year.
  34935. <p/>
  34936. <p/>
  34937. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  34938. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  34939. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  34940. Return_type is a number that determines on which day the week begins. The default is 1.
  34941. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  34942. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  34943. @author cedric dot walter @ gmail dot com
  34944. </member>
  34945. <member name="M:NPOI.SS.Formula.Functions.Roman.integerToRoman(System.Int32)">
  34946. Classic conversion.
  34947. @param number
  34948. @return
  34949. </member>
  34950. <member name="M:NPOI.SS.Formula.Functions.Roman.MakeConcise(System.String,System.Int32)">
  34951. Use conversion rule to factor some parts and make them more concise
  34952. @param result
  34953. @param form
  34954. @return
  34955. </member>
  34956. <member name="T:NPOI.SS.Formula.Functions.Rows">
  34957. Implementation for Excel ROWS function.
  34958. @author Josh Micich
  34959. </member>
  34960. <member name="T:NPOI.SS.Formula.Functions.Slope">
  34961. Implementation of Excel function SLOPE()<p/>
  34962. Calculates the SLOPE of the linear regression line that is used to predict y values from x values<br/>
  34963. (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
  34964. <b>Syntax</b>:<br/>
  34965. <b>SLOPE</b>(<b>arrayX</b>, <b>arrayY</b>)<p/>
  34966. @author Johan Karlsteen
  34967. </member>
  34968. <member name="T:NPOI.SS.Formula.Functions.StatsLib">
  34969. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  34970. Library for common statistics functions
  34971. </member>
  34972. <member name="M:NPOI.SS.Formula.Functions.StatsLib.avedev(System.Double[])">
  34973. returns the mean of deviations from mean.
  34974. @param v
  34975. </member>
  34976. <member name="M:NPOI.SS.Formula.Functions.StatsLib.mode(System.Double[])">
  34977. if v Is zero Length or Contains no duplicates, return value
  34978. Is double.NaN. Else returns the value that occurs most times
  34979. and if there Is a tie, returns the first such value.
  34980. @param v
  34981. </member>
  34982. <member name="T:NPOI.SS.Formula.Functions.Subtotal">
  34983. Implementation for the Excel function SUBTOTAL<p>
  34984. <b>Syntax :</b> <br/>
  34985. SUBTOTAL ( <b>functionCode</b>, <b>ref1</b>, ref2 ... ) <br/>
  34986. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34987. <tr><td><b>functionCode</b></td><td>(1-11) Selects the underlying aggregate function to be used (see table below)</td></tr>
  34988. <tr><td><b>ref1</b>, ref2 ...</td><td>Arguments to be passed to the underlying aggregate function</td></tr>
  34989. </table><br/>
  34990. </p>
  34991. <table border="1" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  34992. <tr><th>functionCode</th><th>Aggregate Function</th></tr>
  34993. <tr align='center'><td>1</td><td>AVERAGE</td></tr>
  34994. <tr align='center'><td>2</td><td>COUNT</td></tr>
  34995. <tr align='center'><td>3</td><td>COUNTA</td></tr>
  34996. <tr align='center'><td>4</td><td>MAX</td></tr>
  34997. <tr align='center'><td>5</td><td>MIN</td></tr>
  34998. <tr align='center'><td>6</td><td>PRODUCT</td></tr>
  34999. <tr align='center'><td>7</td><td>STDEV</td></tr>
  35000. <tr align='center'><td>8</td><td>STDEVP *</td></tr>
  35001. <tr align='center'><td>9</td><td>SUM</td></tr>
  35002. <tr align='center'><td>10</td><td>VAR *</td></tr>
  35003. <tr align='center'><td>11</td><td>VARP *</td></tr>
  35004. <tr align='center'><td>101-111</td><td>*</td></tr>
  35005. </table><br/>
  35006. * Not implemented in POI yet. Functions 101-111 are the same as functions 1-11 but with
  35007. the option 'ignore hidden values'.
  35008. <p/>
  35009. @author Paul Tomlin &lt; pault at bulk sms dot com &gt;
  35010. </member>
  35011. <member name="T:NPOI.SS.Formula.Functions.Sumif">
  35012. Implementation for the Excel function SUMIF<p>
  35013. Syntax : <br/>
  35014. SUMIF ( <b>range</b>, <b>criteria</b>, sum_range ) <br/>
  35015. <table border="0" cellpadding="1" cellspacing="0" summary="Parameter descriptions">
  35016. <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>
  35017. <tr><th>criteria</th><td>The value or expression used to filter rows from <b>range</b></td></tr>
  35018. <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>
  35019. </table><br/>
  35020. </p>
  35021. @author Josh Micich
  35022. </member>
  35023. <member name="M:NPOI.SS.Formula.Functions.Sumif.CreateSumRange(NPOI.SS.Formula.Eval.ValueEval,NPOI.SS.Formula.Eval.AreaEval)">
  35024. @return a range of the same dimensions as aeRange using eval to define the top left corner.
  35025. @throws EvaluationException if eval is not a reference
  35026. </member>
  35027. <member name="T:NPOI.SS.Formula.Functions.Sumifs">
  35028. Implementation for the Excel function SUMIFS<br/>
  35029. <p>
  35030. Syntax : <br/>
  35031. SUMIFS ( <b>sum_range</b>, <b>criteria_range1</b>, <b>criteria1</b>,
  35032. [<b>criteria_range2</b>, <b>criteria2</b>], ...) <br/>
  35033. <ul>
  35034. <li><b>sum_range</b> Required. One or more cells to sum, including numbers or names, ranges,
  35035. or cell references that contain numbers. Blank and text values are ignored.</li>
  35036. <li><b>criteria1_range</b> Required. The first range in which
  35037. to evaluate the associated criteria.</li>
  35038. <li><b>criteria1</b> Required. The criteria in the form of a number, expression,
  35039. cell reference, or text that define which cells in the criteria_range1
  35040. argument will be added</li>
  35041. <li><b> criteria_range2, criteria2, ...</b> Optional. Additional ranges and their associated criteria.
  35042. Up to 127 range/criteria pairs are allowed.</li>
  35043. </ul>
  35044. </p>
  35045. @author Yegor Kozlov
  35046. </member>
  35047. <member name="M:NPOI.SS.Formula.Functions.Sumifs.ValidateCriteriaRanges(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Eval.AreaEval)">
  35048. Verify that each <code>criteriaRanges</code> argument contains the same number of rows and columns
  35049. as the <code>sumRange</code> argument
  35050. @throws EvaluationException if
  35051. </member>
  35052. <member name="M:NPOI.SS.Formula.Functions.Sumifs.SumMatchingCells(NPOI.SS.Formula.Eval.AreaEval[],NPOI.SS.Formula.Functions.IMatchPredicate[],NPOI.SS.Formula.Eval.AreaEval)">
  35053. @param ranges criteria ranges, each range must be of the same dimensions as <code>aeSum</code>
  35054. @param predicates array of predicates, a predicate for each value in <code>ranges</code>
  35055. @param aeSum the range to sum
  35056. @return the computed value
  35057. </member>
  35058. <member name="M:NPOI.SS.Formula.Functions.Sumproduct.GetProductTerm(NPOI.SS.Formula.Eval.ValueEval,System.Boolean)">
  35059. Determines a <c>double</c> value for the specified <c>ValueEval</c>.
  35060. @param IsScalarProduct <c>false</c> for SUMPRODUCTs over area refs.
  35061. @throws EvalEx if <c>ve</c> represents an error value.
  35062. <p/>
  35063. Note - string values and empty cells are interpreted differently depending on
  35064. <c>isScalarProduct</c>. For scalar products, if any term Is blank or a string, the
  35065. error (#VALUE!) Is raised. For area (sum)products, if any term Is blank or a string, the
  35066. result Is zero.
  35067. </member>
  35068. <member name="T:NPOI.SS.Formula.Functions.Concatenate">
  35069. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35070. </member>
  35071. <member name="T:NPOI.SS.Formula.Functions.Exact">
  35072. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35073. </member>
  35074. <member name="T:NPOI.SS.Formula.Functions.LeftRight">
  35075. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35076. </member>
  35077. <member name="T:NPOI.SS.Formula.Functions.Len">
  35078. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35079. </member>
  35080. <member name="T:NPOI.SS.Formula.Functions.Lower">
  35081. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35082. </member>
  35083. <member name="T:NPOI.SS.Formula.Functions.Mid">
  35084. <summary>
  35085. An implementation of the MID function
  35086. MID returns a specific number of
  35087. Chars from a text string, starting at the specified position.
  35088. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org;
  35089. </summary>
  35090. </member>
  35091. <member name="T:NPOI.SS.Formula.Functions.Proper">
  35092. <summary>
  35093. Implementation of the PROPER function:
  35094. Normalizes all words (separated by non-word characters) by
  35095. making the first letter upper and the rest lower case.
  35096. </summary>
  35097. </member>
  35098. <member name="T:NPOI.SS.Formula.Functions.Replace">
  35099. An implementation of the Replace function:
  35100. Replaces part of a text string based on the number of Chars
  35101. you specify, with another text string.
  35102. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35103. </member>
  35104. <member name="M:NPOI.SS.Formula.Functions.Replace.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  35105. Replaces part of a text string based on the number of Chars
  35106. you specify, with another text string.
  35107. @see org.apache.poi.hssf.record.formula.eval.Eval
  35108. </member>
  35109. <member name="T:NPOI.SS.Formula.Functions.Substitute">
  35110. An implementation of the SUBSTITUTE function:
  35111. Substitutes text in a text string with new text, some number of times.
  35112. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35113. </member>
  35114. <member name="M:NPOI.SS.Formula.Functions.Substitute.EvaluateFunc(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  35115. Substitutes text in a text string with new text, some number of times.
  35116. @see org.apache.poi.hssf.record.formula.eval.Eval
  35117. </member>
  35118. <member name="T:NPOI.SS.Formula.Functions.Text">
  35119. An implementation of the TEXT function
  35120. TEXT returns a number value formatted with the given number formatting string.
  35121. This function is not a complete implementation of the Excel function, but
  35122. handles most of the common cases. All work is passed down to
  35123. {@link DataFormatter} to be done, as this works much the same as the
  35124. display focused work that that does.
  35125. </member>
  35126. <member name="T:NPOI.SS.Formula.Functions.TextFunction">
  35127. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35128. </member>
  35129. <member name="F:NPOI.SS.Formula.Functions.TextFunction.TRIM">
  35130. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35131. <summary>
  35132. An implementation of the TRIM function:
  35133. <para>
  35134. Removes leading and trailing spaces from value if evaluated operand value is string.
  35135. </para>
  35136. </summary>
  35137. </member>
  35138. <member name="F:NPOI.SS.Formula.Functions.TextFunction.MID">
  35139. <summary>
  35140. An implementation of the MID function
  35141. MID returns a specific number of
  35142. characters from a text string, starting at the specified position.
  35143. Syntax: MID(text, start_num, num_chars)
  35144. </summary>
  35145. </member>
  35146. <member name="F:NPOI.SS.Formula.Functions.TextFunction.FIND">
  35147. @author Torstein Tauno Svendsen (torstei@officenet.no)
  35148. <summary>
  35149. Implementation of the FIND() function.
  35150. <para>
  35151. Syntax: FIND(Find_text, within_text, start_num)
  35152. </para>
  35153. <para> FIND returns the character position of the first (case sensitive) occurrence of
  35154. Find_text inside within_text. The third parameter,
  35155. start_num, is optional (default=1) and specifies where to start searching
  35156. from. Character positions are 1-based.</para>
  35157. </summary>
  35158. </member>
  35159. <member name="F:NPOI.SS.Formula.Functions.TextFunction.SEARCH">
  35160. <summary>
  35161. Implementation of the FIND() function. SEARCH is a case-insensitive version of FIND()
  35162. <para>
  35163. Syntax: SEARCH(Find_text, within_text, start_num)
  35164. </para>
  35165. </summary>
  35166. </member>
  35167. <member name="T:NPOI.SS.Formula.Functions.Trim">
  35168. An implementation of the TRIM function:
  35169. Removes leading and trailing spaces from value if Evaluated operand
  35170. value Is string.
  35171. @author Manda Wilson &lt; wilson at c bio dot msk cc dot org &gt;
  35172. </member>
  35173. <member name="T:NPOI.SS.Formula.Functions.Upper">
  35174. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35175. </member>
  35176. <member name="T:NPOI.SS.Formula.Functions.TimeFunc">
  35177. Implementation for the Excel function TIME
  35178. @author Steven Butler (sebutler @ gmail dot com)
  35179. Based on POI {@link DateFunc}
  35180. </member>
  35181. <member name="M:NPOI.SS.Formula.Functions.TimeFunc.Evaluate(System.Int32,System.Int32,System.Int32)">
  35182. Converts the supplied hours, minutes and seconds to an Excel time value.
  35183. @param ds array of 3 doubles Containing hours, minutes and seconds.
  35184. Non-integer inputs are tRuncated to an integer before further calculation
  35185. of the time value.
  35186. @return An Excel representation of a time of day.
  35187. If the time value represents more than a day, the days are Removed from
  35188. the result, leaving only the time of day component.
  35189. @throws NPOI.SS.Formula.Eval.EvaluationException
  35190. If any of the arguments are greater than 32767 or the hours
  35191. minutes and seconds when combined form a time value less than 0, the function
  35192. Evaluates to an error.
  35193. </member>
  35194. <member name="F:NPOI.SS.Formula.Functions.Value.MIN_DISTANCE_BETWEEN_THOUSANDS_SEPARATOR">
  35195. "1,0000" is valid, "1,00" is not
  35196. </member>
  35197. <member name="M:NPOI.SS.Formula.Functions.Value.ConvertTextToNumber(System.String)">
  35198. TODO see if the same functionality is needed in {@link OperandResolver#parseDouble(String)}
  35199. @return <code>null</code> if there is any problem converting the text
  35200. </member>
  35201. <member name="T:NPOI.SS.Formula.Functions.Var1or2ArgFunction">
  35202. Convenience base class for any function which must take two or three
  35203. arguments
  35204. @author Josh Micich
  35205. </member>
  35206. <member name="T:NPOI.SS.Formula.Functions.Var2or3ArgFunction">
  35207. Convenience base class for any function which must take two or three
  35208. arguments
  35209. @author Josh Micich
  35210. </member>
  35211. <member name="T:NPOI.SS.Formula.Functions.Var3or4ArgFunction">
  35212. Convenience base class for any function which must take three or four
  35213. arguments
  35214. @author Josh Micich
  35215. </member>
  35216. <member name="T:NPOI.SS.Formula.Functions.Vlookup">
  35217. Implementation of the VLOOKUP() function.<p/>
  35218. VLOOKUP Finds a row in a lookup table by the first column value and returns the value from another column.<br/>
  35219. <b>Syntax</b>:<br/>
  35220. <b>VLOOKUP</b>(<b>lookup_value</b>, <b>table_array</b>, <b>col_index_num</b>, range_lookup)<p/>
  35221. <b>lookup_value</b> The value to be found in the first column of the table array.<br/>
  35222. <b>table_array</b> An area reference for the lookup data. <br/>
  35223. <b>col_index_num</b> a 1 based index specifying which column value of the lookup data will be returned.<br/>
  35224. <b>range_lookup</b> If TRUE (default), VLOOKUP Finds the largest value less than or equal to
  35225. the lookup_value. If FALSE, only exact Matches will be considered<br/>
  35226. @author Josh Micich
  35227. </member>
  35228. <member name="M:NPOI.SS.Formula.Functions.Vlookup.CreateResultColumnVector(NPOI.SS.Formula.TwoDEval,System.Int32)">
  35229. Returns one column from an <c>AreaEval</c>
  35230. @(#VALUE!) if colIndex Is negative, (#REF!) if colIndex Is too high
  35231. </member>
  35232. <member name="T:NPOI.SS.Formula.Functions.WeekdayFunc">
  35233. Implementation for the Excel function WEEKDAY
  35234. @author Thies Wellpott
  35235. </member>
  35236. <member name="M:NPOI.SS.Formula.Functions.WeekdayFunc.Evaluate(NPOI.SS.Formula.Eval.ValueEval[],System.Int32,System.Int32)">
  35237. * Perform WEEKDAY(date, returnOption) function.
  35238. * Note: Parameter texts are from German EXCEL-2010 help.
  35239. * Parameters in args[]:
  35240. * args[0] serialDate
  35241. * EXCEL-date value
  35242. * Standardmaessig ist der 1. Januar 1900 die fortlaufende Zahl 1 und
  35243. * der 1. Januar 2008 die fortlaufende Zahl 39.448, da dieser Tag nach 39.448 Tagen
  35244. * auf den 01.01.1900 folgt.
  35245. * @return Option (optional)
  35246. * Bestimmt den Rueckgabewert:
  35247. 1 oder nicht angegeben Zahl 1 (Sonntag) bis 7 (Samstag). Verhaelt sich wie fruehere Microsoft Excel-Versionen.
  35248. 2 Zahl 1 (Montag) bis 7 (Sonntag).
  35249. 3 Zahl 0 (Montag) bis 6 (Sonntag).
  35250. 11 Die Zahlen 1 (Montag) bis 7 (Sonntag)
  35251. 12 Die Zahlen 1 (Dienstag) bis 7 (Montag)
  35252. 13 Die Zahlen 1 (Mittwoch) bis 7 (Dienstag)
  35253. 14 Die Zahlen 1 (Donnerstag) bis 7 (Mittwoch)
  35254. 15 Die Zahlen 1 (Freitag) bis 7 (Donnerstag)
  35255. 16 Die Zahlen 1 (Samstag) bis 7 (Freitag)
  35256. 17 Die Zahlen 1 (Sonntag) bis 7 (Samstag)
  35257. </member>
  35258. <member name="T:NPOI.SS.Formula.Functions.WeekNum">
  35259. Implementation for Excel WeekNum() function.<p/>
  35260. <p/>
  35261. <b>Syntax</b>:<br/> <b>WeekNum </b>(<b>Serial_num</b>,<b>Return_type</b>)<br/>
  35262. <p/>
  35263. Returns a number that indicates where the week falls numerically within a year.
  35264. <p/>
  35265. <p/>
  35266. Serial_num is a date within the week. Dates should be entered by using the DATE function,
  35267. or as results of other formulas or functions. For example, use DATE(2008,5,23)
  35268. for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
  35269. Return_type is a number that determines on which day the week begins. The default is 1.
  35270. 1 Week begins on Sunday. Weekdays are numbered 1 through 7.
  35271. 2 Week begins on Monday. Weekdays are numbered 1 through 7.
  35272. @author cedric dot walter @ gmail dot com
  35273. </member>
  35274. <member name="T:NPOI.SS.Formula.Functions.XYNumericFunction">
  35275. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  35276. </member>
  35277. <member name="M:NPOI.SS.Formula.Functions.XYNumericFunction.CreateAccumulator">
  35278. Constructs a new instance of the Accumulator used to calculated this function
  35279. </member>
  35280. <member name="T:NPOI.SS.Formula.Function.FunctionDataBuilder">
  35281. Temporarily collects <c>FunctionMetadata</c> instances for creation of a
  35282. <c>FunctionMetadataRegistry</c>.
  35283. @author Josh Micich
  35284. </member>
  35285. <member name="F:NPOI.SS.Formula.Function.FunctionDataBuilder._mutatingFunctionIndexes">
  35286. stores indexes of all functions with footnotes (i.e. whose definitions might Change)
  35287. </member>
  35288. <member name="T:NPOI.SS.Formula.Function.FunctionMetadata">
  35289. Holds information about Excel built-in functions.
  35290. @author Josh Micich
  35291. </member>
  35292. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataReader">
  35293. Converts the text meta-data file into a <c>FunctionMetadataRegistry</c>
  35294. @author Josh Micich
  35295. </member>
  35296. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataReader.ELLIPSIS">
  35297. plain ASCII text metadata file uses three dots for ellipsis
  35298. </member>
  35299. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataReader.ValidateFunctionName(System.String)">
  35300. Makes sure that footnote digits from the original OOO document have not been accidentally
  35301. left behind
  35302. </member>
  35303. <member name="T:NPOI.SS.Formula.Function.FunctionMetadataRegistry">
  35304. Allows clients to Get <c>FunctionMetadata</c> instances for any built-in function of Excel.
  35305. @author Josh Micich
  35306. </member>
  35307. <member name="F:NPOI.SS.Formula.Function.FunctionMetadataRegistry.FUNCTION_NAME_IF">
  35308. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  35309. </member>
  35310. <member name="M:NPOI.SS.Formula.Function.FunctionMetadataRegistry.LookupIndexByName(System.String)">
  35311. Resolves a built-in function index.
  35312. @param name uppercase function name
  35313. @return a negative value if the function name is not found.
  35314. This typically occurs for external functions.
  35315. </member>
  35316. <member name="T:NPOI.SS.Formula.ICacheEntry">
  35317. A (mostly) opaque interface To allow test clients To trace cache values
  35318. Each spreadsheet cell Gets one unique cache entry instance. These objects
  35319. are safe To use as keys in {@link java.util.HashMap}s
  35320. </member>
  35321. <member name="T:NPOI.SS.Formula.IEvaluationListener">
  35322. Tests can implement this class To track the internal working of the {@link WorkbookEvaluator}.<br/>
  35323. For POI internal testing use only
  35324. @author Josh Micich
  35325. </member>
  35326. <member name="M:NPOI.SS.Formula.IEvaluationListener.SortDependentCachedValues(NPOI.SS.Formula.ICacheEntry[])">
  35327. Internally, formula {@link ICacheEntry}s are stored in Sets which may Change ordering due
  35328. To seemingly trivial Changes. This method is provided To make the order of call-backs To
  35329. {@link #onClearDependentCachedValue(ICacheEntry, int)} more deterministic.
  35330. </member>
  35331. <member name="T:NPOI.SS.Formula.IStabilityClassifier">
  35332. Used to help optimise cell evaluation result caching by allowing applications to specify which
  35333. parts of a workbook are <em>final</em>.<br/>
  35334. The term <b>final</b> is introduced here to denote immutability or 'having constant definition'.
  35335. This classification refers to potential actions (on the evaluated workbook) by the evaluating
  35336. application. It does not refer to operations performed by the evaluator ({@link
  35337. WorkbookEvaluator}).<br/>
  35338. <br/>
  35339. <b>General guidelines</b>:
  35340. <ul>
  35341. <li>a plain value cell can be marked as 'final' if it will not be changed after the first call
  35342. to {@link WorkbookEvaluator#evaluate(EvaluationCell)}.
  35343. </li>
  35344. <li>a formula cell can be marked as 'final' if its formula will not be changed after the first
  35345. call to {@link WorkbookEvaluator#evaluate(EvaluationCell)}. This remains true even if changes
  35346. in dependent values may cause the evaluated value to change.</li>
  35347. <li>plain value cells should be marked as 'not final' if their plain value value may change.
  35348. </li>
  35349. <li>formula cells should be marked as 'not final' if their formula definition may change.</li>
  35350. <li>cells which may switch between plain value and formula should also be marked as 'not final'.
  35351. </li>
  35352. </ul>
  35353. <b>Notes</b>:
  35354. <ul>
  35355. <li>If none of the spreadsheet cells is expected to have its definition changed after evaluation
  35356. begins, every cell can be marked as 'final'. This is the most efficient / least resource
  35357. intensive option.</li>
  35358. <li>To retain freedom to change any cell definition at any time, an application may classify all
  35359. cells as 'not final'. This freedom comes at the expense of greater memory consumption.</li>
  35360. <li>For the purpose of these classifications, setting the cached formula result of a cell (for
  35361. example in {@link HSSFFormulaEvaluator#evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)})
  35362. does not constitute changing the definition of the cell.</li>
  35363. <li>Updating cells which have been classified as 'final' will cause the evaluator to behave
  35364. unpredictably (typically ignoring the update).</li>
  35365. </ul>
  35366. @author Josh Micich
  35367. </member>
  35368. <member name="F:NPOI.SS.Formula.IStabilityClassifier.TOTALLY_IMMUTABLE">
  35369. Convenience implementation for situations where all cell definitions remain fixed after
  35370. evaluation begins.
  35371. </member>
  35372. <member name="M:NPOI.SS.Formula.IStabilityClassifier.IsCellFinal(System.Int32,System.Int32,System.Int32)">
  35373. Checks if a cell's value(/formula) is fixed - in other words - not expected to be modified
  35374. between calls to the evaluator. (Note - this is an independent concept from whether a
  35375. formula cell's evaluated value may change during successive calls to the evaluator).
  35376. @param sheetIndex zero based index into workbook sheet list
  35377. @param rowIndex zero based row index of cell
  35378. @param columnIndex zero based column index of cell
  35379. @return <c>false</c> if the evaluating application may need to modify the specified
  35380. cell between calls to the evaluator.
  35381. </member>
  35382. <member name="T:NPOI.SS.Formula.LazyAreaEval">
  35383. Provides Lazy Evaluation to 3D Ranges
  35384. </member>
  35385. <member name="M:NPOI.SS.Formula.LazyAreaEval.IsSubTotal(System.Int32,System.Int32)">
  35386. @return whether cell at rowIndex and columnIndex is a subtotal
  35387. </member>
  35388. <member name="T:NPOI.SS.Formula.LazyRefEval">
  35389. Provides Lazy Evaluation to a 3D Reference
  35390. TODO Provide access to multiple sheets where present
  35391. </member>
  35392. <member name="T:NPOI.SS.Formula.OperandClassTransformer">
  35393. This class performs 'operand class' transformation. Non-base Tokens are classified into three
  35394. operand classes:
  35395. <ul>
  35396. <li>reference</li>
  35397. <li>value</li>
  35398. <li>array</li>
  35399. </ul>
  35400. <p/>
  35401. The operand class chosen for each Token depends on the formula type and the Token's place
  35402. in the formula. If POI Gets the operand class wrong, Excel <em>may</em> interpret the formula
  35403. incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!',
  35404. but resolves correctly when the user presses F2, enter.<p/>
  35405. The logic implemented here was partially inspired by the description in
  35406. "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there
  35407. seems To be inconsistent with observed Excel behaviour (These differences have not been fully
  35408. investigated). The implementation in this class Has been heavily modified in order To satisfy
  35409. concrete examples of how Excel performs the same logic (see TestRVA).<p/>
  35410. Hopefully, as Additional important test cases are identified and Added To the test suite,
  35411. patterns might become more obvious in this code and allow for simplification.
  35412. @author Josh Micich
  35413. </member>
  35414. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformFormula(NPOI.SS.Formula.ParseNode)">
  35415. Traverses the supplied formula parse tree, calling <c>Ptg.SetClass()</c> for each non-base
  35416. Token To Set its operand class.
  35417. </member>
  35418. <member name="M:NPOI.SS.Formula.OperandClassTransformer.TransformNode(NPOI.SS.Formula.ParseNode,System.Byte,System.Boolean)">
  35419. @param callerForceArrayFlag <c>true</c> if one of the current node's parents is a
  35420. function Ptg which Has been Changed from default 'V' To 'A' type (due To requirements on
  35421. the function return value).
  35422. </member>
  35423. <member name="T:NPOI.SS.Formula.OperationEvaluationContext">
  35424. Contains all the contextual information required to Evaluate an operation
  35425. within a formula
  35426. For POI internal use only
  35427. @author Josh Micich
  35428. </member>
  35429. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.CreateExternSheetRefEvaluator(System.String,System.String)">
  35430. @return <code>null</code> if either workbook or sheet is not found
  35431. </member>
  35432. <member name="M:NPOI.SS.Formula.OperationEvaluationContext.GetDynamicReference(System.String,System.String,System.String,System.String,System.Boolean)">
  35433. Resolves a cell or area reference dynamically.
  35434. @param workbookName the name of the workbook Containing the reference. If <code>null</code>
  35435. the current workbook is assumed. Note - to Evaluate formulas which use multiple workbooks,
  35436. a {@link CollaboratingWorkbooksEnvironment} must be set up.
  35437. @param sheetName the name of the sheet Containing the reference. May be <code>null</code>
  35438. (when <c>workbookName</c> is also null) in which case the current workbook and sheet is
  35439. assumed.
  35440. @param refStrPart1 the single cell reference or first part of the area reference. Must not
  35441. be <code>null</code>.
  35442. @param refStrPart2 the second part of the area reference. For single cell references this
  35443. parameter must be <code>null</code>
  35444. @param isA1Style specifies the format for <c>refStrPart1</c> and <c>refStrPart2</c>.
  35445. Pass <c>true</c> for 'A1' style and <c>false</c> for 'R1C1' style.
  35446. TODO - currently POI only supports 'A1' reference style
  35447. @return a {@link RefEval} or {@link AreaEval}
  35448. </member>
  35449. <member name="T:NPOI.SS.Formula.OperationEvaluatorFactory">
  35450. This class Creates <c>OperationEval</c> instances To help evaluate <c>OperationPtg</c>
  35451. formula Tokens.
  35452. @author Josh Micich
  35453. </member>
  35454. <member name="M:NPOI.SS.Formula.OperationEvaluatorFactory.Evaluate(NPOI.SS.Formula.PTG.OperationPtg,NPOI.SS.Formula.Eval.ValueEval[],NPOI.SS.Formula.OperationEvaluationContext)">
  35455. returns the OperationEval concrete impl instance corresponding
  35456. to the supplied operationPtg
  35457. </member>
  35458. <member name="T:NPOI.SS.Formula.ParseNode">
  35459. Represents a syntactic element from a formula by encapsulating the corresponding <c>Ptg</c>
  35460. Token. Each <c>ParseNode</c> may have child <c>ParseNode</c>s in the case when the wrapped
  35461. <c>Ptg</c> is non-atomic.
  35462. @author Josh Micich
  35463. </member>
  35464. <member name="M:NPOI.SS.Formula.ParseNode.ToTokenArray(NPOI.SS.Formula.ParseNode)">
  35465. Collects the array of <c>Ptg</c> Tokens for the specified tree.
  35466. </member>
  35467. <member name="M:NPOI.SS.Formula.ParseNode.CollectIfPtgs(NPOI.SS.Formula.ParseNode.TokenCollector)">
  35468. The IF() function Gets marked up with two or three tAttr Tokens.
  35469. Similar logic will be required for CHOOSE() when it is supported
  35470. See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
  35471. </member>
  35472. <member name="T:NPOI.SS.Formula.PlainCellCache">
  35473. @author Josh Micich
  35474. </member>
  35475. <member name="T:NPOI.SS.Formula.PlainValueCellCacheEntry">
  35476. Used for non-formula cells, primarily To keep track of the referencing (formula) cells.
  35477. @author Josh Micich
  35478. </member>
  35479. <member name="T:NPOI.SS.Formula.PTG.AbstractFunctionPtg">
  35480. This class provides the base functionality for Excel sheet functions
  35481. There are two kinds of function Ptgs - tFunc and tFuncVar
  35482. Therefore, this class will have ONLY two subclasses
  35483. @author Avik Sengupta
  35484. @author Andrew C. Oliver (acoliver at apache dot org)
  35485. </member>
  35486. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_NAME_IF">
  35487. The name of the IF function (i.e. "IF"). Extracted as a constant for clarity.
  35488. </member>
  35489. <member name="F:NPOI.SS.Formula.PTG.AbstractFunctionPtg.FUNCTION_INDEX_EXTERNAL">
  35490. All external functions have function index 255
  35491. </member>
  35492. <member name="P:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsExternalFunction">
  35493. external functions Get some special Processing
  35494. @return <c>true</c> if this is an external function
  35495. </member>
  35496. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.IsBuiltInFunctionName(System.String)">
  35497. Used to detect whether a function name found in a formula is one of the standard excel functions
  35498. The name matching is case insensitive.
  35499. @return <c>true</c> if the name specifies a standard worksheet function,
  35500. <c>false</c> if the name should be assumed to be an external function.
  35501. </member>
  35502. <member name="M:NPOI.SS.Formula.PTG.AbstractFunctionPtg.LookupIndex(System.String)">
  35503. Resolves internal function names into function indexes.
  35504. The name matching is case insensitive.
  35505. @return the standard worksheet function index if found, otherwise <c>FUNCTION_INDEX_EXTERNAL</c>
  35506. </member>
  35507. <member name="T:NPOI.SS.Formula.PTG.AddPtg">
  35508. Addition operator PTG the "+" binomial operator. If you need more
  35509. explanation than that then well...We really can't help you here.
  35510. @author Andrew C. Oliver (acoliver@apache.org)
  35511. @author Jason Height (jheight at chariot dot net dot au)
  35512. </member>
  35513. <member name="M:NPOI.SS.Formula.PTG.AddPtg.ToFormulaString(System.String[])">
  35514. implementation of method from OperationsPtg
  35515. </member>
  35516. <member name="T:NPOI.SS.Formula.PTG.Area2DPtgBase">
  35517. Common superclass of 2-D area refs
  35518. </member>
  35519. <member name="T:NPOI.SS.Formula.PTG.Area3DPtg">
  35520. <p>Title: Area 3D Ptg - 3D reference (Sheet + Area)</p>
  35521. <p>Description: Defined an area in Extern Sheet. </p>
  35522. <p>REFERENCE: </p>
  35523. This is HSSF only, as it matches the HSSF file format way of
  35524. referring to the sheet by an extern index. The XSSF equivalent
  35525. is {@link Area3DPxg}
  35526. </member>
  35527. <member name="M:NPOI.SS.Formula.PTG.Area3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  35528. @return text representation of this area reference that can be used in text
  35529. formulas. The sheet name will get properly delimited if required.
  35530. </member>
  35531. <member name="T:NPOI.SS.Formula.PTG.Area3DPxg">
  35532. <p>Title: XSSF Area 3D Reference (Sheet + Area)</p>
  35533. <p>Description: Defined an area in an external or different sheet. </p>
  35534. <p>REFERENCE: </p>
  35535. <p>This is XSSF only, as it stores the sheet / book references
  35536. in String form. The HSSF equivalent using indexes is {@link Area3DPtg}</p>
  35537. </member>
  35538. <member name="T:NPOI.SS.Formula.PTG.AreaErrPtg">
  35539. AreaErr - handles deleted cell area references.
  35540. @author Daniel Noll (daniel at nuix dot com dot au)
  35541. </member>
  35542. <member name="T:NPOI.SS.Formula.PTG.AreaI">
  35543. Common interface for AreaPtg and Area3DPtg, and their
  35544. child classes.
  35545. </member>
  35546. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstRow">
  35547. @return the first row in the area
  35548. </member>
  35549. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastRow">
  35550. @return last row in the range (x2 in x1,y1-x2,y2)
  35551. </member>
  35552. <member name="P:NPOI.SS.Formula.PTG.AreaI.FirstColumn">
  35553. @return the first column number in the area.
  35554. </member>
  35555. <member name="P:NPOI.SS.Formula.PTG.AreaI.LastColumn">
  35556. @return lastcolumn in the area
  35557. </member>
  35558. <member name="T:NPOI.SS.Formula.PTG.AreaNPtg">
  35559. Specifies a rectangular area of cells A1:A4 for instance.
  35560. @author Jason Height (jheight at chariot dot net dot au)
  35561. </member>
  35562. <member name="T:NPOI.SS.Formula.PTG.AreaPtg">
  35563. Specifies a rectangular area of cells A1:A4 for instance.
  35564. @author Jason Height (jheight at chariot dot net dot au)
  35565. </member>
  35566. <member name="T:NPOI.SS.Formula.PTG.AreaPtgBase">
  35567. Specifies a rectangular area of cells A1:A4 for instance.
  35568. @author andy
  35569. @author Jason Height (jheight at chariot dot net dot au)
  35570. </member>
  35571. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.NotImplemented">
  35572. TODO - (May-2008) fix subclasses of AreaPtg 'AreaN~' which are used in shared formulas.
  35573. see similar comment in ReferencePtg
  35574. </member>
  35575. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_1_first_row">
  35576. zero based, Unsigned 16 bit
  35577. </member>
  35578. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_2_last_row">
  35579. zero based, Unsigned 16 bit
  35580. </member>
  35581. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_3_first_column">
  35582. zero based, Unsigned 8 bit
  35583. </member>
  35584. <member name="F:NPOI.SS.Formula.PTG.AreaPtgBase.field_4_last_column">
  35585. zero based, Unsigned 8 bit
  35586. </member>
  35587. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstRow">
  35588. @return the first row in the area
  35589. </member>
  35590. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastRow">
  35591. @return last row in the range (x2 in x1,y1-x2,y2)
  35592. </member>
  35593. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.FirstColumn">
  35594. @return the first column number in the area.
  35595. </member>
  35596. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstRowRelative">
  35597. @return whether or not the first row is a relative reference or not.
  35598. </member>
  35599. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsFirstColRelative">
  35600. @return Isrelative first column to relative or not
  35601. </member>
  35602. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumn">
  35603. @return lastcolumn in the area
  35604. </member>
  35605. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.LastColumnRaw">
  35606. @return last column and bitmask (the raw field)
  35607. </member>
  35608. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastRowRelative">
  35609. @return last row relative or not
  35610. </member>
  35611. <member name="P:NPOI.SS.Formula.PTG.AreaPtgBase.IsLastColRelative">
  35612. @return lastcol relative or not
  35613. </member>
  35614. <member name="M:NPOI.SS.Formula.PTG.AreaPtgBase.SetLastColumnRaw(System.Int16)">
  35615. Set the last column irrespective of the bitmasks
  35616. </member>
  35617. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg">
  35618. ArrayPtg - handles arrays
  35619. The ArrayPtg is a little weird, the size of the Ptg when parsing initially only
  35620. includes the Ptg sid and the reserved bytes. The next Ptg in the expression then follows.
  35621. It is only after the "size" of all the Ptgs is met, that the ArrayPtg data is actually
  35622. held after this. So Ptg.CreateParsedExpression keeps track of the number of
  35623. ArrayPtg elements and need to Parse the data upto the FORMULA record size.
  35624. @author Jason Height (jheight at chariot dot net dot au)
  35625. </member>
  35626. <member name="F:NPOI.SS.Formula.PTG.ArrayPtg.PLAIN_TOKEN_SIZE">
  35627. The size of the plain tArray token written within the standard formula tokens
  35628. (not including the data which comes after all formula tokens)
  35629. </member>
  35630. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.#ctor(System.Object[][])">
  35631. @param values2d array values arranged in rows
  35632. </member>
  35633. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.GetValueIndex(System.Int32,System.Int32)">
  35634. Note - (2D) array elements are stored column by column
  35635. @return the index into the internal 1D array for the specified column and row
  35636. </member>
  35637. <member name="P:NPOI.SS.Formula.PTG.ArrayPtg.Size">
  35638. This size includes the size of the array Ptg plus the Array Ptg Token value size
  35639. </member>
  35640. <member name="T:NPOI.SS.Formula.PTG.ArrayPtg.Initial">
  35641. Represents the initial plain tArray token (without the constant data that trails the whole
  35642. formula). Objects of this class are only temporary and cannot be used as {@link Ptg}s.
  35643. These temporary objects get converted to {@link ArrayPtg} by the
  35644. {@link #finishReading(LittleEndianInput)} method.
  35645. </member>
  35646. <member name="M:NPOI.SS.Formula.PTG.ArrayPtg.Initial.FinishReading(NPOI.Util.ILittleEndianInput)">
  35647. Read in the actual token (array) values. This occurs
  35648. AFTER the last Ptg in the expression.
  35649. See page 304-305 of Excel97-2007BinaryFileFormat(xls)Specification.pdf
  35650. </member>
  35651. <member name="T:NPOI.SS.Formula.PTG.AttrPtg">
  35652. "Special Attributes"
  35653. This seems to be a Misc Stuff and Junk record. One function it serves Is
  35654. in SUM functions (i.e. SUM(A1:A3) causes an area PTG then an ATTR with the SUM option Set)
  35655. @author andy
  35656. @author Jason Height (jheight at chariot dot net dot au)
  35657. </member>
  35658. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._jumpTable">
  35659. only used for tAttrChoose: table of offsets to starts of args
  35660. </member>
  35661. <member name="F:NPOI.SS.Formula.PTG.AttrPtg._chooseFuncOffset">
  35662. only used for tAttrChoose: offset to the tFuncVar for CHOOSE()
  35663. </member>
  35664. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBefore">
  35665. 00H = Spaces before the next token (not allowed before tParen token)
  35666. </member>
  35667. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBefore">
  35668. 01H = Carriage returns before the next token (not allowed before tParen token)
  35669. </member>
  35670. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeOpenParen">
  35671. 02H = Spaces before opening parenthesis (only allowed before tParen token)
  35672. </member>
  35673. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeOpenParen">
  35674. 03H = Carriage returns before opening parenthesis (only allowed before tParen token)
  35675. </member>
  35676. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceBeforeCloseParen">
  35677. 04H = Spaces before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  35678. </member>
  35679. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.CrBeforeCloseParen">
  35680. 05H = Carriage returns before closing parenthesis (only allowed before tParen, tFunc, and tFuncVar tokens)
  35681. </member>
  35682. <member name="F:NPOI.SS.Formula.PTG.AttrPtg.SpaceType.SpaceAfterEquality">
  35683. 06H = Spaces following the equality sign (only in macro sheets)
  35684. </member>
  35685. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSpace(NPOI.SS.Formula.PTG.AttrPtg.SpaceType,System.Int32)">
  35686. <summary>
  35687. Creates the space.
  35688. </summary>
  35689. <param name="type">a constant from SpaceType</param>
  35690. <param name="count">The count.</param>
  35691. </member>
  35692. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateIf(System.Int32)">
  35693. <summary>
  35694. Creates if.
  35695. </summary>
  35696. <param name="dist">distance (in bytes) to start of either
  35697. tFuncVar(IF) token (when false parameter is not present).</param>
  35698. </member>
  35699. <member name="M:NPOI.SS.Formula.PTG.AttrPtg.CreateSkip(System.Int32)">
  35700. <summary>
  35701. Creates the skip.
  35702. </summary>
  35703. <param name="dist">distance (in bytes) to position behind tFuncVar(IF) token (minus 1).</param>
  35704. </member>
  35705. <member name="T:NPOI.SS.Formula.PTG.BoolPtg">
  35706. bool (bool)
  35707. Stores a (java) bool value in a formula.
  35708. @author Paul Krause (pkrause at soundbite dot com)
  35709. @author Andrew C. Oliver (acoliver at apache dot org)
  35710. @author Jason Height (jheight at chariot dot net dot au)
  35711. </member>
  35712. <member name="T:NPOI.SS.Formula.PTG.ConcatPtg">
  35713. @author andy
  35714. @author Jason Height (jheight at chariot dot net dot au)
  35715. </member>
  35716. <member name="T:NPOI.SS.Formula.PTG.ControlPtg">
  35717. Common baseclass for
  35718. tExp
  35719. tTbl
  35720. tParen
  35721. tNlr
  35722. tAttr
  35723. tSheet
  35724. tEndSheet
  35725. </member>
  35726. <member name="T:NPOI.SS.Formula.PTG.Deleted3DPxg">
  35727. An XSSF only representation of a reference to a deleted area
  35728. </member>
  35729. <member name="T:NPOI.SS.Formula.PTG.DeletedArea3DPtg">
  35730. Title: Deleted Area 3D Ptg - 3D referecnce (Sheet + Area)
  35731. Description: Defined a area in Extern Sheet.
  35732. REFERENCE:
  35733. @author Patrick Luby
  35734. @version 1.0-pre
  35735. </member>
  35736. <member name="T:NPOI.SS.Formula.PTG.DeletedRef3DPtg">
  35737. Title: Deleted Reference 3D Ptg
  35738. Description: Defined a cell in extern sheet.
  35739. REFERENCE:
  35740. @author Patrick Luby
  35741. @version 1.0-pre
  35742. </member>
  35743. <member name="M:NPOI.SS.Formula.PTG.DeletedRef3DPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35744. Creates new DeletedRef3DPtg
  35745. </member>
  35746. <member name="T:NPOI.SS.Formula.PTG.DividePtg">
  35747. This PTG implements the standard binomial divide "/"
  35748. @author Andrew C. Oliver acoliver at apache dot org
  35749. @author Jason Height (jheight at chariot dot net dot au)
  35750. </member>
  35751. <member name="T:NPOI.SS.Formula.PTG.EqualPtg">
  35752. @author andy
  35753. </member>
  35754. <member name="T:NPOI.SS.Formula.PTG.ErrPtg">
  35755. @author Daniel Noll (daniel at nuix dot com dot au)
  35756. </member>
  35757. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NULL_INTERSECTION">
  35758. <b>#NULL!</b> - Intersection of two cell ranges is empty
  35759. </member>
  35760. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.DIV_ZERO">
  35761. <b>#DIV/0!</b> - Division by zero
  35762. </member>
  35763. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.VALUE_INVALID">
  35764. <b>#VALUE!</b> - Wrong type of operand
  35765. </member>
  35766. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.REF_INVALID">
  35767. <b>#REF!</b> - Illegal or deleted cell reference
  35768. </member>
  35769. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NAME_INVALID">
  35770. <b>#NAME?</b> - Wrong function or range name
  35771. </member>
  35772. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.NUM_ERROR">
  35773. <b>#NUM!</b> - Value range overflow
  35774. </member>
  35775. <member name="F:NPOI.SS.Formula.PTG.ErrPtg.N_A">
  35776. <b>#N/A</b> - Argument or function not available
  35777. </member>
  35778. <member name="M:NPOI.SS.Formula.PTG.ErrPtg.#ctor(System.Int32)">
  35779. Creates new ErrPtg
  35780. </member>
  35781. <member name="T:NPOI.SS.Formula.PTG.ExpPtg">
  35782. @author andy
  35783. @author Jason Height (jheight at chariot dot net dot au)
  35784. @author dmui (save existing implementation)
  35785. </member>
  35786. <member name="T:NPOI.SS.Formula.PTG.FuncPtg">
  35787. @author aviks
  35788. @author Jason Height (jheight at chariot dot net dot au)
  35789. @author Danny Mui (dmui at apache dot org) (Leftover handling)
  35790. </member>
  35791. <member name="T:NPOI.SS.Formula.PTG.FuncVarPtg">
  35792. @author Jason Height (jheight at chariot dot net dot au)
  35793. </member>
  35794. <member name="F:NPOI.SS.Formula.PTG.FuncVarPtg.SUM">
  35795. Single instance of this token for 'sum() taking a single argument'
  35796. </member>
  35797. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(NPOI.Util.ILittleEndianInput)">
  35798. Creates new function pointer from a byte array
  35799. usually called while reading an excel file.
  35800. </member>
  35801. <member name="M:NPOI.SS.Formula.PTG.FuncVarPtg.Create(System.String,System.Int32)">
  35802. Create a function ptg from a string tokenised by the parser
  35803. </member>
  35804. <member name="T:NPOI.SS.Formula.PTG.GreaterEqualPtg">
  35805. PTG class to implement greater or equal to
  35806. @author fred at stsci dot edu
  35807. </member>
  35808. <member name="T:NPOI.SS.Formula.PTG.GreaterThanPtg">
  35809. Greater than operator PTG ">"
  35810. @author Cameron Riley (criley at ekmail.com)
  35811. </member>
  35812. <member name="P:NPOI.SS.Formula.PTG.GreaterThanPtg.NumberOfOperands">
  35813. Get the number of operands for the Less than operator
  35814. @return int the number of operands
  35815. </member>
  35816. <member name="M:NPOI.SS.Formula.PTG.GreaterThanPtg.ToFormulaString(System.String[])">
  35817. Implementation of method from OperationsPtg
  35818. @param operands a String array of operands
  35819. @return String the Formula as a String
  35820. </member>
  35821. <member name="T:NPOI.SS.Formula.PTG.IntersectionPtg">
  35822. @author Daniel Noll (daniel at nuix dot com dot au)
  35823. </member>
  35824. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString">
  35825. Implementation of method from Ptg
  35826. </member>
  35827. <member name="M:NPOI.SS.Formula.PTG.IntersectionPtg.ToFormulaString(System.String[])">
  35828. implementation of method from OperationsPtg
  35829. </member>
  35830. <member name="T:NPOI.SS.Formula.PTG.IntPtg">
  35831. Integer (unsigned short integer)
  35832. Stores an Unsigned short value (java int) in a formula
  35833. @author Andrew C. Oliver (acoliver at apache dot org)
  35834. @author Jason Height (jheight at chariot dot net dot au)
  35835. </member>
  35836. <member name="M:NPOI.SS.Formula.PTG.IntPtg.IsInRange(System.Int32)">
  35837. Excel represents integers 0..65535 with the tInt token.
  35838. @return <c>true</c> if the specified value is within the range of values
  35839. <c>IntPtg</c> can represent.
  35840. </member>
  35841. <member name="T:NPOI.SS.Formula.PTG.LessEqualPtg">
  35842. Ptg class to implement less than or equal
  35843. @author fred at stsci dot edu
  35844. </member>
  35845. <member name="T:NPOI.SS.Formula.PTG.LessThanPtg">
  35846. Less than operator PTG "&lt;". The SID is taken from the
  35847. Openoffice.orgs Documentation of the Excel File Format,
  35848. Table 3.5.7
  35849. @author Cameron Riley (criley at ekmail.com)
  35850. </member>
  35851. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.sid">
  35852. the sid for the less than operator as hex
  35853. </member>
  35854. <member name="F:NPOI.SS.Formula.PTG.LessThanPtg.LESSTHAN">
  35855. identifier for LESS THAN char
  35856. </member>
  35857. <member name="P:NPOI.SS.Formula.PTG.LessThanPtg.NumberOfOperands">
  35858. Get the number of operands for the Less than operator
  35859. @return int the number of operands
  35860. </member>
  35861. <member name="M:NPOI.SS.Formula.PTG.LessThanPtg.ToFormulaString(System.String[])">
  35862. Implementation of method from OperationsPtg
  35863. @param operands a String array of operands
  35864. @return String the Formula as a String
  35865. </member>
  35866. <member name="T:NPOI.SS.Formula.PTG.MemAreaPtg">
  35867. @author Daniel Noll (daniel at nuix dot com dot au)
  35868. </member>
  35869. <member name="M:NPOI.SS.Formula.PTG.MemAreaPtg.#ctor(System.Int32)">
  35870. Creates new MemAreaPtg
  35871. </member>
  35872. <member name="T:NPOI.SS.Formula.PTG.MemErrPtg">
  35873. @author andy
  35874. @author Jason Height (jheight at chariot dot net dot au)
  35875. @author Daniel Noll (daniel at nuix dot com dot au)
  35876. </member>
  35877. <member name="M:NPOI.SS.Formula.PTG.MemErrPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35878. Creates new MemErrPtg
  35879. </member>
  35880. <member name="T:NPOI.SS.Formula.PTG.MemFuncPtg">
  35881. @author Glen Stampoultzis (glens at apache.org)
  35882. </member>
  35883. <member name="M:NPOI.SS.Formula.PTG.MemFuncPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35884. Creates new function pointer from a byte array
  35885. usually called while Reading an excel file.
  35886. </member>
  35887. <member name="T:NPOI.SS.Formula.PTG.MissingArgPtg">
  35888. Missing Function Arguments
  35889. Avik Sengupta &lt;avik at apache.org&gt;
  35890. @author Jason Height (jheight at chariot dot net dot au)
  35891. </member>
  35892. <member name="T:NPOI.SS.Formula.PTG.MultiplyPtg">
  35893. Implements the standard mathmatical multiplication - *
  35894. @author Andrew C. Oliver (acoliver at apache dot org)
  35895. @author Jason Height (jheight at chariot dot net dot au)
  35896. </member>
  35897. <member name="T:NPOI.SS.Formula.PTG.NamePtg">
  35898. @author andy
  35899. @author Jason Height (jheight at chariot dot net dot au)
  35900. </member>
  35901. <member name="F:NPOI.SS.Formula.PTG.NamePtg.field_1_label_index">
  35902. one-based index to defined name record
  35903. </member>
  35904. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(System.Int32)">
  35905. @param nameIndex zero-based index to name within workbook
  35906. </member>
  35907. <member name="M:NPOI.SS.Formula.PTG.NamePtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35908. Creates new NamePtg
  35909. </member>
  35910. <member name="P:NPOI.SS.Formula.PTG.NamePtg.Index">
  35911. @return zero based index to a defined name record in the LinkTable
  35912. </member>
  35913. <member name="T:NPOI.SS.Formula.PTG.NameXPtg">
  35914. A Name, be that a Named Range or a Function / User Defined
  35915. Function, addressed in the HSSF External Sheet style.
  35916. This is HSSF only, as it matches the HSSF file format way of
  35917. referring to the sheet by an extern index. The XSSF equivalent
  35918. is {@link NameXPxg}
  35919. </member>
  35920. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._sheetRefIndex">
  35921. index to REF entry in externsheet record
  35922. </member>
  35923. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._nameNumber">
  35924. index to defined name or externname table(1 based)
  35925. </member>
  35926. <member name="F:NPOI.SS.Formula.PTG.NameXPtg._reserved">
  35927. reserved must be 0
  35928. </member>
  35929. <member name="M:NPOI.SS.Formula.PTG.NameXPtg.#ctor(System.Int32,System.Int32)">
  35930. @param sheetRefIndex index to REF entry in externsheet record
  35931. @param nameIndex index to defined name or externname table
  35932. </member>
  35933. <member name="T:NPOI.SS.Formula.PTG.NameXPxg">
  35934. A Name, be that a Named Range or a Function / User Defined
  35935. Function, Addressed in the HSSF External Sheet style.
  35936. <p>This is XSSF only, as it stores the sheet / book references
  35937. in String form. The HSSF equivalent using indexes is {@link NameXPtg}</p>
  35938. </member>
  35939. <member name="T:NPOI.SS.Formula.PTG.NotEqualPtg">
  35940. Ptg class to implement not equal
  35941. @author fred at stsci dot edu
  35942. </member>
  35943. <member name="T:NPOI.SS.Formula.PTG.NumberPtg">
  35944. Number
  35945. Stores a floating point value in a formula
  35946. value stored in a 8 byte field using IEEE notation
  35947. @author Avik Sengupta
  35948. @author Jason Height (jheight at chariot dot net dot au)
  35949. </member>
  35950. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  35951. Create a NumberPtg from a byte array Read from disk
  35952. </member>
  35953. <member name="M:NPOI.SS.Formula.PTG.NumberPtg.#ctor(System.String)">
  35954. Create a NumberPtg from a string representation of the number
  35955. Number format is not checked, it is expected to be validated in the parser
  35956. that calls this method.
  35957. @param value : String representation of a floating point number
  35958. </member>
  35959. <member name="T:NPOI.SS.Formula.PTG.OperandPtg">
  35960. @author Josh Micich
  35961. </member>
  35962. <member name="P:NPOI.SS.Formula.PTG.OperandPtg.IsBaseToken">
  35963. All Operand <c>Ptg</c>s are classifed ('relative', 'value', 'array')
  35964. </member>
  35965. <member name="T:NPOI.SS.Formula.PTG.OperationPtg">
  35966. defines a Ptg that is an operation instead of an operand
  35967. @author andy
  35968. </member>
  35969. <member name="M:NPOI.SS.Formula.PTG.OperationPtg.ToFormulaString(System.String[])">
  35970. returns a string representation of the operations
  35971. the Length of the input array should equal the number returned by
  35972. @see #GetNumberOfOperands
  35973. </member>
  35974. <member name="P:NPOI.SS.Formula.PTG.OperationPtg.NumberOfOperands">
  35975. The number of operands expected by the operations
  35976. </member>
  35977. <member name="T:NPOI.SS.Formula.PTG.ParenthesisPtg">
  35978. While formula tokens are stored in RPN order and thus do not need parenthesis for
  35979. precedence reasons, Parenthesis tokens ARE written to Ensure that user entered
  35980. parenthesis are Displayed as-is on Reading back
  35981. Avik Sengupta &lt;lists@aviksengupta.com&gt;
  35982. Andrew C. Oliver (acoliver at apache dot org)
  35983. @author Jason Height (jheight at chariot dot net dot au)
  35984. </member>
  35985. <member name="T:NPOI.SS.Formula.PTG.PercentPtg">
  35986. Percent PTG.
  35987. @author Daniel Noll (daniel at nuix.com.au)
  35988. </member>
  35989. <member name="T:NPOI.SS.Formula.PTG.PowerPtg">
  35990. @author andy
  35991. @author Jason Height (jheight at chariot dot net dot au)
  35992. </member>
  35993. <member name="T:NPOI.SS.Formula.PTG.Ptg">
  35994. <c>Ptg</c> represents a syntactic token in a formula. 'PTG' is an acronym for
  35995. '<b>p</b>arse <b>t</b>hin<b>g</b>'. Originally, the name referred to the single
  35996. byte identifier at the start of the token, but in POI, <c>Ptg</c> encapsulates
  35997. the whole formula token (initial byte + value data).
  35998. <c>Ptg</c>s are logically arranged in a tree representing the structure of the
  35999. Parsed formula. However, in BIFF files <c>Ptg</c>s are written/Read in
  36000. <em>Reverse-Polish Notation</em> order. The RPN ordering also simplifies formula
  36001. evaluation logic, so POI mostly accesses <c>Ptg</c>s in the same way.
  36002. @author andy
  36003. @author avik
  36004. @author Jason Height (jheight at chariot dot net dot au)
  36005. </member>
  36006. <member name="M:NPOI.SS.Formula.PTG.Ptg.ReadTokens(System.Int32,NPOI.Util.ILittleEndianInput)">
  36007. Reads <c>size</c> bytes of the input stream, to Create an array of <c>Ptg</c>s.
  36008. Extra data (beyond <c>size</c>) may be Read if and <c>ArrayPtg</c>s are present.
  36009. </member>
  36010. <member name="M:NPOI.SS.Formula.PTG.Ptg.Clone">
  36011. @return a distinct copy of this <c>Ptg</c> if the class is mutable, or the same instance
  36012. if the class is immutable.
  36013. </member>
  36014. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSize(NPOI.SS.Formula.PTG.Ptg[])">
  36015. This method will return the same result as {@link #getEncodedSizeWithoutArrayData(Ptg[])}
  36016. if there are no array tokens present.
  36017. @return the full size taken to encode the specified <c>Ptg</c>s
  36018. </member>
  36019. <member name="M:NPOI.SS.Formula.PTG.Ptg.GetEncodedSizeWithoutArrayData(NPOI.SS.Formula.PTG.Ptg[])">
  36020. Used to calculate value that should be encoded at the start of the encoded Ptg token array;
  36021. @return the size of the encoded Ptg tokens not including any trailing array data.
  36022. </member>
  36023. <member name="M:NPOI.SS.Formula.PTG.Ptg.SerializePtgs(NPOI.SS.Formula.PTG.Ptg[],System.Byte[],System.Int32)">
  36024. Writes the ptgs to the data buffer, starting at the specified offset.
  36025. <br/>
  36026. The 2 byte encode Length field is <b>not</b> written by this method.
  36027. @return number of bytes written
  36028. </member>
  36029. <member name="P:NPOI.SS.Formula.PTG.Ptg.Size">
  36030. @return the encoded Length of this Ptg, including the initial Ptg type identifier byte.
  36031. </member>
  36032. <member name="P:NPOI.SS.Formula.PTG.Ptg.IsBaseToken">
  36033. @return <c>false</c> if this token is classified as 'reference', 'value', or 'array'
  36034. </member>
  36035. <member name="M:NPOI.SS.Formula.PTG.Ptg.Write(NPOI.Util.ILittleEndianOutput)">
  36036. Write this Ptg to a byte array
  36037. </member>
  36038. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToFormulaString">
  36039. return a string representation of this token alone
  36040. </member>
  36041. <member name="M:NPOI.SS.Formula.PTG.Ptg.ToString">
  36042. Overridden toString method to Ensure object hash is not printed.
  36043. This helps Get rid of gratuitous diffs when comparing two dumps
  36044. Subclasses may output more relevant information by overriding this method
  36045. </member>
  36046. <member name="P:NPOI.SS.Formula.PTG.Ptg.PtgClass">
  36047. @return the 'operand class' (REF/VALUE/ARRAY) for this Ptg
  36048. </member>
  36049. <member name="P:NPOI.SS.Formula.PTG.Ptg.RVAType">
  36050. Debug / diagnostic method to get this token's 'operand class' type.
  36051. @return 'R' for 'reference', 'V' for 'value', 'A' for 'array' and '.' for base tokens
  36052. </member>
  36053. <member name="T:NPOI.SS.Formula.PTG.Pxg">
  36054. An XSSF only special kind of Ptg, which stores the sheet / book
  36055. reference in string form.
  36056. </member>
  36057. <member name="T:NPOI.SS.Formula.PTG.Pxg3D">
  36058. An XSSF only special kind of Ptg, which stores a range of
  36059. sheet / book references in string form.
  36060. </member>
  36061. <member name="T:NPOI.SS.Formula.PTG.RangePtg">
  36062. @author Daniel Noll (daniel at nuix dot com dot au)
  36063. </member>
  36064. <member name="M:NPOI.SS.Formula.PTG.RangePtg.ToFormulaString(System.String[])">
  36065. implementation of method from OperationsPtg
  36066. </member>
  36067. <member name="T:NPOI.SS.Formula.PTG.Ref2DPtgBase">
  36068. @author Josh Micich
  36069. </member>
  36070. <member name="M:NPOI.SS.Formula.PTG.Ref2DPtgBase.#ctor(System.String)">
  36071. Takes in a String representation of a cell reference and fills out the
  36072. numeric fields.
  36073. </member>
  36074. <member name="T:NPOI.SS.Formula.PTG.Ref3DPtg">
  36075. Title: Reference 3D Ptg
  36076. Description: Defined a cell in extern sheet.
  36077. REFERENCE:
  36078. @author Libin Roman (Vista Portal LDT. Developer)
  36079. @author Jason Height (jheight at chariot dot net dot au)
  36080. @version 1.0-pre
  36081. </member>
  36082. <member name="F:NPOI.SS.Formula.PTG.Ref3DPtg.rowRelative">
  36083. Field 2
  36084. - lower 8 bits is the zero based Unsigned byte column index
  36085. - bit 16 - IsRowRelative
  36086. - bit 15 - IsColumnRelative
  36087. </member>
  36088. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.#ctor">
  36089. Creates new AreaPtg
  36090. </member>
  36091. <member name="M:NPOI.SS.Formula.PTG.Ref3DPtg.ToFormulaString(NPOI.SS.Formula.IFormulaRenderingWorkbook)">
  36092. @return text representation of this cell reference that can be used in text
  36093. formulas. The sheet name will Get properly delimited if required.
  36094. </member>
  36095. <member name="T:NPOI.SS.Formula.PTG.Ref3DPxg">
  36096. <p>Title: XSSF 3D Reference</p>
  36097. <p>Description: Defines a cell in an external or different sheet.</p>
  36098. <p>REFERENCE: </p>
  36099. <p>This is XSSF only, as it stores the sheet / book references
  36100. in String form. The HSSF equivalent using indexes is {@link Ref3DPtg}</p>
  36101. </member>
  36102. <member name="T:NPOI.SS.Formula.PTG.RefErrorPtg">
  36103. RefError - handles deleted cell reference
  36104. @author Jason Height (jheight at chariot dot net dot au)
  36105. </member>
  36106. <member name="T:NPOI.SS.Formula.PTG.RefNPtg">
  36107. RefNPtg
  36108. @author Jason Height (jheight at apache dot com)
  36109. </member>
  36110. <member name="M:NPOI.SS.Formula.PTG.RefNPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  36111. Creates new ValueReferencePtg
  36112. </member>
  36113. <member name="T:NPOI.SS.Formula.PTG.RefPtg">
  36114. ReferencePtg - handles references (such as A1, A2, IA4)
  36115. @author Andrew C. Oliver (acoliver@apache.org)
  36116. @author Jason Height (jheight at chariot dot net dot au)
  36117. </member>
  36118. <member name="M:NPOI.SS.Formula.PTG.RefPtg.#ctor(System.String)">
  36119. Takes in a String representation of a cell reference and Fills out the
  36120. numeric fields.
  36121. </member>
  36122. <member name="T:NPOI.SS.Formula.PTG.RefPtgBase">
  36123. ReferencePtgBase - handles references (such as A1, A2, IA4)
  36124. @author Andrew C. Oliver (acoliver@apache.org)
  36125. @author Jason Height (jheight at chariot dot net dot au)
  36126. </member>
  36127. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_1_row">
  36128. The row index - zero based Unsigned 16 bit value
  36129. </member>
  36130. <member name="F:NPOI.SS.Formula.PTG.RefPtgBase.field_2_col">
  36131. Field 2
  36132. - lower 8 bits is the zero based Unsigned byte column index
  36133. - bit 16 - IsRowRelative
  36134. - bit 15 - IsColumnRelative
  36135. </member>
  36136. <member name="M:NPOI.SS.Formula.PTG.RefPtgBase.#ctor(System.String)">
  36137. Takes in a String representation of a cell reference and Fills out the
  36138. numeric fields.
  36139. </member>
  36140. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.Row">
  36141. Returns the row number as a short, which will be
  36142. wrapped (negative) for values between 32769 and 65535
  36143. </member>
  36144. <member name="P:NPOI.SS.Formula.PTG.RefPtgBase.RowAsInt">
  36145. Returns the row number as an int, between 0 and 65535
  36146. </member>
  36147. <member name="T:NPOI.SS.Formula.PTG.ScalarConstantPtg">
  36148. @author Josh Micich
  36149. </member>
  36150. <member name="T:NPOI.SS.Formula.PTG.StringPtg">
  36151. String Stores a String value in a formula value stored in the format
  36152. &lt;Length 2 bytes&gt;char[]
  36153. @author Werner Froidevaux
  36154. @author Jason Height (jheight at chariot dot net dot au)
  36155. @author Bernard Chesnoy
  36156. </member>
  36157. <member name="F:NPOI.SS.Formula.PTG.StringPtg.FORMULA_DELIMITER">
  36158. the Char (")used in formulas to delimit string literals
  36159. </member>
  36160. <member name="F:NPOI.SS.Formula.PTG.StringPtg.field_1_Length">
  36161. NOTE: OO doc says 16bit Length, but BiffViewer says 8 Book says something
  36162. totally different, so don't look there!
  36163. </member>
  36164. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(NPOI.Util.ILittleEndianInput)">
  36165. Create a StringPtg from a stream
  36166. </member>
  36167. <member name="M:NPOI.SS.Formula.PTG.StringPtg.#ctor(System.String)">
  36168. Create a StringPtg from a string representation of the number Number
  36169. format Is not Checked, it Is expected to be Validated in the Parser that
  36170. calls this method.
  36171. @param value :
  36172. String representation of a floating point number
  36173. </member>
  36174. <member name="T:NPOI.SS.Formula.PTG.SubtractPtg">
  36175. @author andy
  36176. @author Jason Height (jheight at chariot dot net dot au)
  36177. </member>
  36178. <member name="T:NPOI.SS.Formula.PTG.TblPtg">
  36179. This ptg indicates a data table.
  36180. It only occurs in a FORMULA record, never in an
  36181. ARRAY or NAME record. When ptgTbl occurs in a
  36182. formula, it is the only token in the formula.
  36183. This indicates that the cell containing the
  36184. formula is an interior cell in a data table;
  36185. the table description is found in a TABLE
  36186. record. Rows and columns which contain input
  36187. values to be substituted in the table do
  36188. not contain ptgTbl.
  36189. See page 811 of the june 08 binary docs.
  36190. </member>
  36191. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_1_first_row">
  36192. The row number of the upper left corner
  36193. </member>
  36194. <member name="F:NPOI.SS.Formula.PTG.TblPtg.field_2_first_col">
  36195. The column number of the upper left corner
  36196. </member>
  36197. <member name="T:NPOI.SS.Formula.PTG.UnaryMinusPtg">
  36198. Unary Plus operator
  36199. does not have any effect on the operand
  36200. @author Avik Sengupta
  36201. </member>
  36202. <member name="M:NPOI.SS.Formula.PTG.UnaryMinusPtg.ToFormulaString(System.String[])">
  36203. implementation of method from OperationsPtg
  36204. </member>
  36205. <member name="T:NPOI.SS.Formula.PTG.UnaryPlusPtg">
  36206. Unary Plus operator
  36207. does not have any effect on the operand
  36208. @author Avik Sengupta
  36209. </member>
  36210. <member name="M:NPOI.SS.Formula.PTG.UnaryPlusPtg.ToFormulaString(System.String[])">
  36211. implementation of method from OperationsPtg
  36212. </member>
  36213. <member name="T:NPOI.SS.Formula.PTG.UnionPtg">
  36214. @author Glen Stampoultzis (glens at apache.org)
  36215. </member>
  36216. <member name="M:NPOI.SS.Formula.PTG.UnionPtg.ToFormulaString(System.String[])">
  36217. implementation of method from OperationsPtg
  36218. </member>
  36219. <member name="T:NPOI.SS.Formula.PTG.UnknownPtg">
  36220. @author andy
  36221. @author Jason Height (jheight at chariot dot net dot au)
  36222. </member>
  36223. <member name="M:NPOI.SS.Formula.PTG.UnknownPtg.#ctor">
  36224. Creates new UnknownPtg
  36225. </member>
  36226. <member name="T:NPOI.SS.Formula.PTG.ValueOperatorPtg">
  36227. Common baseclass of all value operators.
  36228. Subclasses include all Unary and binary operators except for the reference operators (IntersectionPtg, RangePtg, UnionPtg)
  36229. @author Josh Micich
  36230. </member>
  36231. <member name="P:NPOI.SS.Formula.PTG.ValueOperatorPtg.IsBaseToken">
  36232. All Operator <c>Ptg</c>s are base tokens (i.e. are not RVA classified)
  36233. </member>
  36234. <member name="T:NPOI.SS.Formula.PTG.SharedFormula">
  36235. Encapsulates logic to convert shared formulaa into non shared equivalent
  36236. </member>
  36237. <member name="M:NPOI.SS.Formula.PTG.SharedFormula.ConvertSharedFormulas(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  36238. Creates a non shared formula from the shared formula counterpart, i.e.
  36239. Converts the shared formula into the equivalent {@link org.apache.poi.ss.formula.ptg.Ptg} array that it would have,
  36240. were it not shared.
  36241. @param ptgs parsed tokens of the shared formula
  36242. @param formulaRow
  36243. @param formulaColumn
  36244. </member>
  36245. <member name="T:NPOI.SS.Formula.FormulaShifter">
  36246. @author Josh Micich
  36247. </member>
  36248. <member name="F:NPOI.SS.Formula.FormulaShifter._externSheetIndex">
  36249. Extern sheet index of sheet where moving is occurring
  36250. </member>
  36251. <member name="F:NPOI.SS.Formula.FormulaShifter._sheetName">
  36252. Sheet name of the sheet where moving is occurring,
  36253. used for updating XSSF style 3D references on row shifts.
  36254. </member>
  36255. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.String,System.Int32,System.Int32,System.Int32)">
  36256. Create an instance for Shifting row.
  36257. For example, this will be called on {@link NPOI.HSSF.UserModel.HSSFSheet#ShiftRows(int, int, int)} }
  36258. </member>
  36259. <member name="M:NPOI.SS.Formula.FormulaShifter.#ctor(System.Int32,System.Int32)">
  36260. Create an instance for shifting sheets.
  36261. For example, this will be called on {@link org.apache.poi.hssf.usermodel.HSSFWorkbook#setSheetOrder(String, int)}
  36262. </member>
  36263. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustFormula(NPOI.SS.Formula.PTG.Ptg[],System.Int32)">
  36264. @param ptgs - if necessary, will get modified by this method
  36265. @param currentExternSheetIx - the extern sheet index of the sheet that contains the formula being adjusted
  36266. @return <c>true</c> if a change was made to the formula tokens
  36267. </member>
  36268. <member name="M:NPOI.SS.Formula.FormulaShifter.AdjustPtgDueToRowMove(NPOI.SS.Formula.PTG.Ptg,System.Int32)">
  36269. @return <c>true</c> if this Ptg needed to be changed
  36270. </member>
  36271. <member name="T:NPOI.SS.Formula.SheetNameFormatter">
  36272. Formats sheet names for use in formula expressions.
  36273. @author Josh Micich
  36274. </member>
  36275. <member name="M:NPOI.SS.Formula.SheetNameFormatter.Format(System.String)">
  36276. Used to format sheet names as they would appear in cell formula expressions.
  36277. @return the sheet name UnChanged if there is no need for delimiting. Otherwise the sheet
  36278. name is enclosed in single quotes ('). Any single quotes which were already present in the
  36279. sheet name will be converted to double single quotes ('').
  36280. </member>
  36281. <member name="M:NPOI.SS.Formula.SheetNameFormatter.AppendFormat(System.Text.StringBuilder,System.String)">
  36282. Convenience method for when a StringBuilder is already available
  36283. @param out - sheet name will be Appended here possibly with delimiting quotes
  36284. </member>
  36285. <member name="M:NPOI.SS.Formula.SheetNameFormatter.IsSpecialChar(System.Char)">
  36286. @return <c>true</c> if the presence of the specified Char in a sheet name would
  36287. require the sheet name to be delimited in formulas. This includes every non-alphanumeric
  36288. Char besides Underscore '_'.
  36289. </member>
  36290. <member name="M:NPOI.SS.Formula.SheetNameFormatter.CellReferenceIsWithinRange(System.String,System.String)">
  36291. Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they
  36292. look like cell references.
  36293. <p/>
  36294. This code is currently being used for translating formulas represented with <code>Ptg</code>
  36295. tokens into human readable text form. In formula expressions, a sheet name always has a
  36296. trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
  36297. method returns but it is worth noting the likely consumers of these formula text strings:
  36298. <ol>
  36299. <li>POI's own formula parser</li>
  36300. <li>Visual reading by human</li>
  36301. <li>VBA automation entry into Excel cell contents e.g. ActiveCell.Formula = "=c64!A1"</li>
  36302. <li>Manual entry into Excel cell contents</li>
  36303. <li>Some third party formula parser</li>
  36304. </ol>
  36305. At the time of writing, POI's formula parser tolerates cell-like sheet names in formulas
  36306. with or without delimiters. The same goes for Excel(2007), both manual and automated entry.
  36307. <p/>
  36308. For better or worse this implementation attempts to replicate Excel's formula renderer.
  36309. Excel uses range checking on the apparent 'row' and 'column' components. Note however that
  36310. the maximum sheet size varies across versions.
  36311. @see org.apache.poi.hssf.util.CellReference
  36312. </member>
  36313. <member name="M:NPOI.SS.Formula.SheetNameFormatter.NameLooksLikePlainCellReference(System.String)">
  36314. Note - this method assumes the specified rawSheetName has only letters and digits. It
  36315. cannot be used to match absolute or range references (using the dollar or colon char).
  36316. Some notable cases:
  36317. <blockquote><table border="0" cellpAdding="1" cellspacing="0"
  36318. summary="Notable cases.">
  36319. <tr><th>Input </th><th>Result </th><th>Comments</th></tr>
  36320. <tr><td>"A1" </td><td>true</td><td> </td></tr>
  36321. <tr><td>"a111" </td><td>true</td><td> </td></tr>
  36322. <tr><td>"AA" </td><td>false</td><td> </td></tr>
  36323. <tr><td>"aa1" </td><td>true</td><td> </td></tr>
  36324. <tr><td>"A1A" </td><td>false</td><td> </td></tr>
  36325. <tr><td>"A1A1" </td><td>false</td><td> </td></tr>
  36326. <tr><td>"A$1:$C$20" </td><td>false</td><td>Not a plain cell reference</td></tr>
  36327. <tr><td>"SALES20080101" </td><td>true</td>
  36328. <td>Still needs delimiting even though well out of range</td></tr>
  36329. </table></blockquote>
  36330. @return <c>true</c> if there is any possible ambiguity that the specified rawSheetName
  36331. could be interpreted as a valid cell name.
  36332. </member>
  36333. <member name="T:NPOI.SS.Formula.SheetRangeEvaluator">
  36334. Evaluator for returning cells or sheets for a range of sheets
  36335. </member>
  36336. <member name="T:NPOI.SS.Formula.SheetRefEvaluator">
  36337. @author Josh Micich
  36338. </member>
  36339. <member name="M:NPOI.SS.Formula.SheetRefEvaluator.IsSubTotal(System.Int32,System.Int32)">
  36340. @return whether cell at rowIndex and columnIndex is a subtotal
  36341. @see org.apache.poi.ss.formula.functions.Subtotal
  36342. </member>
  36343. <member name="T:NPOI.SS.Formula.ThreeDEval">
  36344. Optional Extension to the likes of {@link AreaEval} and
  36345. {@link NPOI.SS.Formula.Eval.AreaEvalBase},
  36346. which allows for looking up 3D (sheet+row+column) Evaluations
  36347. </member>
  36348. <member name="M:NPOI.SS.Formula.ThreeDEval.GetValue(System.Int32,System.Int32,System.Int32)">
  36349. @param sheetIndex sheet index (zero based)
  36350. @param rowIndex relative row index (zero based)
  36351. @param columnIndex relative column index (zero based)
  36352. @return element at the specified row and column position
  36353. </member>
  36354. <member name="T:NPOI.SS.Formula.TwoDEval">
  36355. Common interface of {@link AreaEval} and {@link org.apache.poi.ss.formula.eval.AreaEvalBase},
  36356. for 2D (row+column) evaluations
  36357. </member>
  36358. <member name="M:NPOI.SS.Formula.TwoDEval.GetValue(System.Int32,System.Int32)">
  36359. @param rowIndex relative row index (zero based)
  36360. @param columnIndex relative column index (zero based)
  36361. @return element at the specified row and column position
  36362. </member>
  36363. <member name="P:NPOI.SS.Formula.TwoDEval.IsRow">
  36364. @return <c>true</c> if the area has just a single row, this also includes
  36365. the trivial case when the area has just a single cell.
  36366. </member>
  36367. <member name="P:NPOI.SS.Formula.TwoDEval.IsColumn">
  36368. @return <c>true</c> if the area has just a single column, this also includes
  36369. the trivial case when the area has just a single cell.
  36370. </member>
  36371. <member name="M:NPOI.SS.Formula.TwoDEval.GetRow(System.Int32)">
  36372. @param rowIndex relative row index (zero based)
  36373. @return a single row {@link TwoDEval}
  36374. </member>
  36375. <member name="M:NPOI.SS.Formula.TwoDEval.GetColumn(System.Int32)">
  36376. @param columnIndex relative column index (zero based)
  36377. @return a single column {@link TwoDEval}
  36378. </member>
  36379. <member name="M:NPOI.SS.Formula.TwoDEval.IsSubTotal(System.Int32,System.Int32)">
  36380. @return true if the cell at row and col is a subtotal
  36381. </member>
  36382. <member name="T:NPOI.SS.Formula.Udf.AggregatingUDFFinder">
  36383. Collects Add-in libraries and VB macro functions toGether into one UDF Finder
  36384. @author PUdalau
  36385. </member>
  36386. <member name="M:NPOI.SS.Formula.Udf.AggregatingUDFFinder.FindFunction(System.String)">
  36387. <summary>
  36388. Returns executor by specified name.
  36389. </summary>
  36390. <param name="name">Name of function.</param>
  36391. <returns>Function executor. null if not found</returns>
  36392. </member>
  36393. <member name="M:NPOI.SS.Formula.Udf.AggregatingUDFFinder.Add(NPOI.SS.Formula.Udf.UDFFinder)">
  36394. <summary>
  36395. Add a new toolpack
  36396. </summary>
  36397. <param name="toolPack"></param>
  36398. </member>
  36399. <member name="T:NPOI.SS.Formula.Udf.DefaultUDFFinder">
  36400. Default UDF Finder - for Adding your own user defined functions.
  36401. @author PUdalau
  36402. </member>
  36403. <member name="T:NPOI.SS.Formula.Udf.IndexedUDFFinder">
  36404. A UDFFinder that can retrieve functions both by name and by fake index.
  36405. @author Yegor Kozlov
  36406. </member>
  36407. <member name="T:NPOI.SS.Formula.Udf.UDFFinder">
  36408. Common interface for "Add-in" libraries and user defined function libraries.
  36409. @author PUdalau
  36410. </member>
  36411. <member name="M:NPOI.SS.Formula.Udf.UDFFinder.FindFunction(System.String)">
  36412. Returns executor by specified name. Returns <code>null</code> if the function name is unknown.
  36413. @param name Name of function.
  36414. @return Function executor.
  36415. </member>
  36416. <member name="T:NPOI.SS.Formula.WorkbookDependentFormula">
  36417. Should be implemented by any {@link Ptg} subclass that needs a workbook To render its formula.
  36418. <br/>
  36419. For POI internal use only
  36420. @author Josh Micich
  36421. </member>
  36422. <member name="T:NPOI.SS.Formula.WorkbookEvaluator">
  36423. Evaluates formula cells.<p/>
  36424. For performance reasons, this class keeps a cache of all previously calculated intermediate
  36425. cell values. Be sure To call {@link #ClearCache()} if any workbook cells are Changed between
  36426. calls To evaluate~ methods on this class.<br/>
  36427. For POI internal use only
  36428. @author Josh Micich
  36429. </member>
  36430. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetName(System.Int32)">
  36431. also for debug use. Used in ToString methods
  36432. </member>
  36433. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.ClearAllCachedResultValues">
  36434. Should be called whenever there are Changes To input cells in the evaluated workbook.
  36435. Failure To call this method after changing cell values will cause incorrect behaviour
  36436. of the evaluate~ methods of this class
  36437. </member>
  36438. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyUpdateCell(NPOI.SS.Formula.IEvaluationCell)">
  36439. Should be called To tell the cell value cache that the specified (value or formula) cell
  36440. Has Changed.
  36441. </member>
  36442. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.NotifyDeleteCell(NPOI.SS.Formula.IEvaluationCell)">
  36443. Should be called To tell the cell value cache that the specified cell Has just been
  36444. deleted.
  36445. </member>
  36446. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSheetIndex(System.String)">
  36447. Case-insensitive.
  36448. @return -1 if sheet with specified name does not exist
  36449. </member>
  36450. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateAny(NPOI.SS.Formula.IEvaluationCell,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  36451. @return never <c>null</c>, never {@link BlankEval}
  36452. </member>
  36453. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.AddExceptionInfo(System.NotImplementedException,System.Int32,System.Int32,System.Int32)">
  36454. Adds the current cell reference to the exception for easier debugging.
  36455. Would be nice to get the formula text as well, but that seems to require
  36456. too much digging around and casting to get the FormulaRenderingWorkbook.
  36457. </member>
  36458. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetValueFromNonFormulaCell(NPOI.SS.Formula.IEvaluationCell)">
  36459. Gets the value from a non-formula cell.
  36460. @param cell may be <c>null</c>
  36461. @return {@link BlankEval} if cell is <c>null</c> or blank, never <c>null</c>
  36462. </member>
  36463. <member name="F:NPOI.SS.Formula.WorkbookEvaluator.dbgEvaluationOutputForNextEval">
  36464. whether print detailed messages about the next formula evaluation
  36465. </member>
  36466. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.CountTokensToBeSkipped(NPOI.SS.Formula.PTG.Ptg[],System.Int32,System.Int32)">
  36467. Calculates the number of tokens that the evaluator should skip upon reaching a tAttrSkip.
  36468. @return the number of tokens (starting from <c>startIndex+1</c>) that need to be skipped
  36469. to achieve the specified <c>distInBytes</c> skip distance.
  36470. </member>
  36471. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.DereferenceResult(NPOI.SS.Formula.Eval.ValueEval,System.Int32,System.Int32)">
  36472. Dereferences a single value from any AreaEval or RefEval evaluation result.
  36473. If the supplied evaluationResult is just a plain value, it is returned as-is.
  36474. @return a <c>NumberEval</c>, <c>StringEval</c>, <c>BoolEval</c>,
  36475. <c>BlankEval</c> or <c>ErrorEval</c>. Never <c>null</c>.
  36476. </member>
  36477. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetEvalForPtg(NPOI.SS.Formula.PTG.Ptg,NPOI.SS.Formula.OperationEvaluationContext)">
  36478. returns an appropriate Eval impl instance for the Ptg. The Ptg must be
  36479. one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg,
  36480. StringPtg, BoolPtg <br/>special Note: OperationPtg subtypes cannot be
  36481. passed here!
  36482. </member>
  36483. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.EvaluateReference(NPOI.SS.Formula.IEvaluationSheet,System.Int32,System.Int32,System.Int32,NPOI.SS.Formula.EvaluationTracker)">
  36484. Used by the lazy ref evals whenever they need To Get the value of a contained cell.
  36485. </member>
  36486. <member name="P:NPOI.SS.Formula.WorkbookEvaluator.IgnoreMissingWorkbooks">
  36487. Whether to ignore missing references to external workbooks and
  36488. use cached formula results in the main workbook instead.
  36489. <p>
  36490. In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable.
  36491. With this method you can control how POI handles such missing references:
  36492. <ul>
  36493. <li>by default ignoreMissingWorkbooks=false and POI throws {@link WorkbookNotFoundException}
  36494. if an external reference cannot be resolved</li>
  36495. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  36496. that already exists in the main workbook</li>
  36497. </ul>
  36498. </p>
  36499. @param ignore whether to ignore missing references to external workbooks
  36500. @see <a href="https://issues.apache.org/bugzilla/show_bug.cgi?id=52575">Bug 52575 for details</a>
  36501. </member>
  36502. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetSupportedFunctionNames">
  36503. Return a collection of functions that POI can evaluate
  36504. @return names of functions supported by POI
  36505. </member>
  36506. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.GetNotSupportedFunctionNames">
  36507. Return a collection of functions that POI does not support
  36508. @return names of functions NOT supported by POI
  36509. </member>
  36510. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.FreeRefFunction)">
  36511. Register a ATP function in runtime.
  36512. @param name the function name
  36513. @param func the functoin to register
  36514. @throws IllegalArgumentException if the function is unknown or already registered.
  36515. @since 3.8 beta6
  36516. </member>
  36517. <member name="M:NPOI.SS.Formula.WorkbookEvaluator.RegisterFunction(System.String,NPOI.SS.Formula.Functions.Function)">
  36518. Register a function in runtime.
  36519. @param name the function name
  36520. @param func the functoin to register
  36521. @throws IllegalArgumentException if the function is unknown or already registered.
  36522. @since 3.8 beta6
  36523. </member>
  36524. <member name="T:NPOI.SS.Formula.IWorkbookEvaluatorProvider">
  36525. Provides access to a {@link WorkbookEvaluator}, eg for use with
  36526. {@link CollaboratingWorkbooksEnvironment}
  36527. For POI internal use only
  36528. </member>
  36529. <member name="M:NPOI.SS.Formula.IWorkbookEvaluatorProvider.GetWorkbookEvaluator">
  36530. Provide the underlying WorkbookEvaluator
  36531. </member>
  36532. <member name="T:NPOI.SS.SpreadsheetVersion">
  36533. This enum allows spReadsheets from multiple Excel versions to be handled by the common code.
  36534. Properties of this enum correspond to attributes of the <i>spReadsheet</i> that are easily
  36535. discernable to the user. It is not intended to deal with low-level issues like file formats.
  36536. <p/>
  36537. @author Josh Micich
  36538. @author Yegor Kozlov
  36539. </member>
  36540. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL97">
  36541. Excel97 format aka BIFF8
  36542. <ul>
  36543. <li>The total number of available columns is 256 (2^8)</li>
  36544. <li>The total number of available rows is 64k (2^16)</li>
  36545. <li>The maximum number of arguments to a function is 30</li>
  36546. <li>Number of conditional format conditions on a cell is 3</li>
  36547. <li>Length of text cell contents is unlimited </li>
  36548. <li>Length of text cell contents is 32767</li>
  36549. </ul>
  36550. </member>
  36551. <member name="F:NPOI.SS.SpreadsheetVersion.EXCEL2007">
  36552. Excel2007
  36553. <ul>
  36554. <li>The total number of available columns is 16K (2^14)</li>
  36555. <li>The total number of available rows is 1M (2^20)</li>
  36556. <li>The maximum number of arguments to a function is 255</li>
  36557. <li>Number of conditional format conditions on a cell is unlimited
  36558. (actually limited by available memory in Excel)</li>
  36559. <li>Length of text cell contents is unlimited </li>
  36560. </ul>
  36561. </member>
  36562. <member name="P:NPOI.SS.SpreadsheetVersion.DefaultExtension">
  36563. @return the default file extension of spReadsheet
  36564. </member>
  36565. <member name="P:NPOI.SS.SpreadsheetVersion.MaxRows">
  36566. @return the maximum number of usable rows in each spReadsheet
  36567. </member>
  36568. <member name="P:NPOI.SS.SpreadsheetVersion.LastRowIndex">
  36569. @return the last (maximum) valid row index, equals to <code> GetMaxRows() - 1 </code>
  36570. </member>
  36571. <member name="P:NPOI.SS.SpreadsheetVersion.MaxColumns">
  36572. @return the maximum number of usable columns in each spReadsheet
  36573. </member>
  36574. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnIndex">
  36575. @return the last (maximum) valid column index, equals to <code> GetMaxColumns() - 1 </code>
  36576. </member>
  36577. <member name="P:NPOI.SS.SpreadsheetVersion.MaxFunctionArgs">
  36578. @return the maximum number arguments that can be passed to a multi-arg function (e.g. COUNTIF)
  36579. </member>
  36580. <member name="P:NPOI.SS.SpreadsheetVersion.MaxConditionalFormats">
  36581. @return the maximum number of conditional format conditions on a cell
  36582. </member>
  36583. <member name="P:NPOI.SS.SpreadsheetVersion.LastColumnName">
  36584. @return the last valid column index in a ALPHA-26 representation
  36585. (<code>IV</code> or <code>XFD</code>).
  36586. </member>
  36587. <member name="P:NPOI.SS.SpreadsheetVersion.MaxCellStyles">
  36588. @return the maximum number of cell styles per spreadsheet
  36589. </member>
  36590. <member name="P:NPOI.SS.SpreadsheetVersion.MaxTextLength">
  36591. @return the maximum length of a text cell
  36592. </member>
  36593. <member name="T:NPOI.SS.UserModel.IAutoFilter">
  36594. Represents autofiltering for the specified worksheet.
  36595. <p>
  36596. Filtering data is a quick and easy way to find and work with a subset of data in a range of cells or table.
  36597. For example, you can filter to see only the values that you specify, filter to see the top or bottom values,
  36598. or filter to quickly see duplicate values.
  36599. </p>
  36600. TODO YK: For now (Aug 2010) POI only supports Setting a basic autofilter on a range of cells.
  36601. In future, when we support more auto-filter functions like custom criteria, sort, etc. we will add
  36602. corresponding methods to this interface.
  36603. </member>
  36604. <member name="F:NPOI.SS.UserModel.BorderDiagonal.None">
  36605. <summary>
  36606. No diagional border
  36607. </summary>
  36608. </member>
  36609. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Backward">
  36610. <summary>
  36611. Backward diagional border, from left-top to right-bottom
  36612. </summary>
  36613. </member>
  36614. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Forward">
  36615. <summary>
  36616. Forward diagional border, from right-top to left-bottom
  36617. </summary>
  36618. </member>
  36619. <member name="F:NPOI.SS.UserModel.BorderDiagonal.Both">
  36620. <summary>
  36621. Both forward and backward diagional border
  36622. </summary>
  36623. </member>
  36624. <member name="T:NPOI.SS.UserModel.IBorderFormatting">
  36625. @author Dmitriy Kumshayev
  36626. @author Yegor Kozlov
  36627. </member>
  36628. <member name="T:NPOI.SS.UserModel.BorderStyle">
  36629. <summary>
  36630. The enumeration value indicating the line style of a border in a cell
  36631. </summary>
  36632. </member>
  36633. <member name="F:NPOI.SS.UserModel.BorderStyle.None">
  36634. <summary>
  36635. No border
  36636. </summary>
  36637. </member>
  36638. <member name="F:NPOI.SS.UserModel.BorderStyle.Thin">
  36639. <summary>
  36640. Thin border
  36641. </summary>
  36642. </member>
  36643. <member name="F:NPOI.SS.UserModel.BorderStyle.Medium">
  36644. <summary>
  36645. Medium border
  36646. </summary>
  36647. </member>
  36648. <member name="F:NPOI.SS.UserModel.BorderStyle.Dashed">
  36649. <summary>
  36650. dash border
  36651. </summary>
  36652. </member>
  36653. <member name="F:NPOI.SS.UserModel.BorderStyle.Dotted">
  36654. <summary>
  36655. dot border
  36656. </summary>
  36657. </member>
  36658. <member name="F:NPOI.SS.UserModel.BorderStyle.Thick">
  36659. <summary>
  36660. Thick border
  36661. </summary>
  36662. </member>
  36663. <member name="F:NPOI.SS.UserModel.BorderStyle.Double">
  36664. <summary>
  36665. double-line border
  36666. </summary>
  36667. </member>
  36668. <member name="F:NPOI.SS.UserModel.BorderStyle.Hair">
  36669. <summary>
  36670. hair-line border
  36671. </summary>
  36672. </member>
  36673. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashed">
  36674. <summary>
  36675. Medium dashed border
  36676. </summary>
  36677. </member>
  36678. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDot">
  36679. <summary>
  36680. dash-dot border
  36681. </summary>
  36682. </member>
  36683. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDot">
  36684. <summary>
  36685. medium dash-dot border
  36686. </summary>
  36687. </member>
  36688. <member name="F:NPOI.SS.UserModel.BorderStyle.DashDotDot">
  36689. <summary>
  36690. dash-dot-dot border
  36691. </summary>
  36692. </member>
  36693. <member name="F:NPOI.SS.UserModel.BorderStyle.MediumDashDotDot">
  36694. <summary>
  36695. medium dash-dot-dot border
  36696. </summary>
  36697. </member>
  36698. <member name="F:NPOI.SS.UserModel.BorderStyle.SlantedDashDot">
  36699. <summary>
  36700. slanted dash-dot border
  36701. </summary>
  36702. </member>
  36703. <member name="T:NPOI.SS.UserModel.BuiltinFormats">
  36704. Utility to identify built-in formats. The following is a list of the formats as
  36705. returned by this class.<p/>
  36706. <p/>
  36707. 0, "General"<br/>
  36708. 1, "0"<br/>
  36709. 2, "0.00"<br/>
  36710. 3, "#,##0"<br/>
  36711. 4, "#,##0.00"<br/>
  36712. 5, "$#,##0_);($#,##0)"<br/>
  36713. 6, "$#,##0_);[Red]($#,##0)"<br/>
  36714. 7, "$#,##0.00);($#,##0.00)"<br/>
  36715. 8, "$#,##0.00_);[Red]($#,##0.00)"<br/>
  36716. 9, "0%"<br/>
  36717. 0xa, "0.00%"<br/>
  36718. 0xb, "0.00E+00"<br/>
  36719. 0xc, "# ?/?"<br/>
  36720. 0xd, "# ??/??"<br/>
  36721. 0xe, "m/d/yy"<br/>
  36722. 0xf, "d-mmm-yy"<br/>
  36723. 0x10, "d-mmm"<br/>
  36724. 0x11, "mmm-yy"<br/>
  36725. 0x12, "h:mm AM/PM"<br/>
  36726. 0x13, "h:mm:ss AM/PM"<br/>
  36727. 0x14, "h:mm"<br/>
  36728. 0x15, "h:mm:ss"<br/>
  36729. 0x16, "m/d/yy h:mm"<br/>
  36730. <p/>
  36731. // 0x17 - 0x24 reserved for international and undocumented
  36732. 0x25, "#,##0_);(#,##0)"<br/>
  36733. 0x26, "#,##0_);[Red](#,##0)"<br/>
  36734. 0x27, "#,##0.00_);(#,##0.00)"<br/>
  36735. 0x28, "#,##0.00_);[Red](#,##0.00)"<br/>
  36736. 0x29, "_(*#,##0_);_(*(#,##0);_(* \"-\"_);_(@_)"<br/>
  36737. 0x2a, "_($*#,##0_);_($*(#,##0);_($* \"-\"_);_(@_)"<br/>
  36738. 0x2b, "_(*#,##0.00_);_(*(#,##0.00);_(*\"-\"??_);_(@_)"<br/>
  36739. 0x2c, "_($*#,##0.00_);_($*(#,##0.00);_($*\"-\"??_);_(@_)"<br/>
  36740. 0x2d, "mm:ss"<br/>
  36741. 0x2e, "[h]:mm:ss"<br/>
  36742. 0x2f, "mm:ss.0"<br/>
  36743. 0x30, "##0.0E+0"<br/>
  36744. 0x31, "@" - This is text format.<br/>
  36745. 0x31 "text" - Alias for "@"<br/>
  36746. <p/>
  36747. @author Yegor Kozlov
  36748. Modified 6/17/09 by Stanislav Shor - positive formats don't need starting '('
  36749. </member>
  36750. <member name="F:NPOI.SS.UserModel.BuiltinFormats.FIRST_USER_DEFINED_FORMAT_INDEX">
  36751. The first user-defined format starts at 164.
  36752. </member>
  36753. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormats">
  36754. @deprecated (May 2009) use {@link #getAll()}
  36755. </member>
  36756. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetAll">
  36757. @return array of built-in data formats
  36758. </member>
  36759. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.Int32)">
  36760. Get the format string that matches the given format index
  36761. @param index of a built in format
  36762. @return string represented at index of format or <code>null</code> if there is not a built-in format at that index
  36763. </member>
  36764. <member name="M:NPOI.SS.UserModel.BuiltinFormats.GetBuiltinFormat(System.String)">
  36765. Get the format index that matches the given format string.
  36766. <p>
  36767. Automatically converts "text" to excel's format string to represent text.
  36768. </p>
  36769. @param pFmt string matching a built-in format
  36770. @return index of format or -1 if undefined.
  36771. </member>
  36772. <member name="T:NPOI.SS.UserModel.ICell">
  36773. High level representation of a cell in a row of a spreadsheet.
  36774. <p>
  36775. Cells can be numeric, formula-based or string-based (text). The cell type
  36776. specifies this. String cells cannot conatin numbers and numeric cells cannot
  36777. contain strings (at least according to our model). Client apps should do the
  36778. conversions themselves. Formula cells have the formula string, as well as
  36779. the formula result, which can be numeric or string.
  36780. </p>
  36781. <p>
  36782. Cells should have their number (0 based) before being Added to a row.
  36783. </p>
  36784. </member>
  36785. <member name="P:NPOI.SS.UserModel.ICell.ColumnIndex">
  36786. <summary>
  36787. zero-based column index of a column in a sheet.
  36788. </summary>
  36789. </member>
  36790. <member name="P:NPOI.SS.UserModel.ICell.RowIndex">
  36791. <summary>
  36792. zero-based row index of a row in the sheet that contains this cell
  36793. </summary>
  36794. </member>
  36795. <member name="P:NPOI.SS.UserModel.ICell.Sheet">
  36796. <summary>
  36797. the sheet this cell belongs to
  36798. </summary>
  36799. </member>
  36800. <member name="P:NPOI.SS.UserModel.ICell.Row">
  36801. <summary>
  36802. the row this cell belongs to
  36803. </summary>
  36804. </member>
  36805. <member name="P:NPOI.SS.UserModel.ICell.CellType">
  36806. <summary>
  36807. Set the cells type (numeric, formula or string)
  36808. </summary>
  36809. <p>If the cell currently contains a value, the value will
  36810. be converted to match the new type, if possible. Formatting
  36811. is generally lost in the process however.</p>
  36812. <p>If what you want to do is get a String value for your
  36813. numeric cell, <i>stop!</i>. This is not the way to do it.
  36814. Instead, for fetching the string value of a numeric or boolean
  36815. or date cell, use {@link DataFormatter} instead.</p>
  36816. </member>
  36817. <member name="M:NPOI.SS.UserModel.ICell.SetCellType(NPOI.SS.UserModel.CellType)">
  36818. <summary>
  36819. Set the cells type (numeric, formula or string)
  36820. </summary>
  36821. <param name="cellType"></param>
  36822. </member>
  36823. <member name="P:NPOI.SS.UserModel.ICell.CachedFormulaResultType">
  36824. <summary>
  36825. Only valid for formula cells
  36826. </summary>
  36827. </member>
  36828. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Double)">
  36829. <summary>
  36830. Set a numeric value for the cell
  36831. </summary>
  36832. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  36833. precalculated value, for numerics we'll set its value. For other types we will change
  36834. the cell to a numeric cell and set its value.
  36835. </param>
  36836. </member>
  36837. <member name="M:NPOI.SS.UserModel.ICell.SetCellErrorValue(System.Byte)">
  36838. <summary>
  36839. Set a error value for the cell
  36840. </summary>
  36841. <param name="value">the error value to set this cell to. For formulas we'll set the
  36842. precalculated value , for errors we'll set its value. For other types we will change
  36843. the cell to an error cell and set its value.
  36844. </param>
  36845. </member>
  36846. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.DateTime)">
  36847. <summary>
  36848. Converts the supplied date to its equivalent Excel numeric value and Sets that into the cell.
  36849. </summary>
  36850. <param name="value">the numeric value to set this cell to. For formulas we'll set the
  36851. precalculated value, for numerics we'll set its value. For other types we will change
  36852. the cell to a numerics cell and set its value.
  36853. </param>
  36854. </member>
  36855. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(NPOI.SS.UserModel.IRichTextString)">
  36856. <summary>
  36857. Set a rich string value for the cell.
  36858. </summary>
  36859. <param name="value">value to set the cell to. For formulas we'll set the formula
  36860. string, for String cells we'll set its value. For other types we will
  36861. change the cell to a string cell and set its value.
  36862. If value is null then we will change the cell to a Blank cell.
  36863. </param>
  36864. </member>
  36865. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.String)">
  36866. <summary>
  36867. Set a string value for the cell.
  36868. </summary>
  36869. <param name="value">value to set the cell to. For formulas we'll set the formula
  36870. string, for String cells we'll set its value. For other types we will
  36871. change the cell to a string cell and set its value.
  36872. If value is null then we will change the cell to a blank cell.
  36873. </param>
  36874. </member>
  36875. <member name="M:NPOI.SS.UserModel.ICell.CopyCellTo(System.Int32)">
  36876. <summary>
  36877. Copy the cell to the target index. If the target cell exists, a new cell will be inserted before the existing cell.
  36878. </summary>
  36879. <param name="targetIndex">target index</param>
  36880. <returns>the new copied cell object</returns>
  36881. </member>
  36882. <member name="P:NPOI.SS.UserModel.ICell.CellFormula">
  36883. <summary>
  36884. Return a formula for the cell
  36885. </summary>
  36886. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is not CELL_TYPE_FORMULA </exception>
  36887. </member>
  36888. <member name="M:NPOI.SS.UserModel.ICell.SetCellFormula(System.String)">
  36889. <summary>
  36890. Sets formula for this cell.
  36891. </summary>
  36892. <param name="formula">the formula to Set, e.g. <code>"SUM(C4:E4)"</code>.</param>
  36893. </member>
  36894. <member name="P:NPOI.SS.UserModel.ICell.NumericCellValue">
  36895. <summary>
  36896. Get the value of the cell as a number.
  36897. </summary>
  36898. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  36899. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  36900. </member>
  36901. <member name="P:NPOI.SS.UserModel.ICell.DateCellValue">
  36902. <summary>
  36903. Get the value of the cell as a date.
  36904. </summary>
  36905. <exception cref="T:System.InvalidOperationException">if the cell type returned by GetCellType() is CELL_TYPE_STRING</exception>
  36906. <exception cref="T:System.FormatException">if the cell value isn't a parsable double</exception>
  36907. </member>
  36908. <member name="P:NPOI.SS.UserModel.ICell.RichStringCellValue">
  36909. <summary>
  36910. Get the value of the cell RichTextString
  36911. </summary>
  36912. </member>
  36913. <member name="P:NPOI.SS.UserModel.ICell.ErrorCellValue">
  36914. <summary>
  36915. Get the value of the cell as an error code.
  36916. </summary>
  36917. </member>
  36918. <member name="P:NPOI.SS.UserModel.ICell.StringCellValue">
  36919. <summary>
  36920. Get the value of the cell as a string
  36921. </summary>
  36922. </member>
  36923. <member name="M:NPOI.SS.UserModel.ICell.SetCellValue(System.Boolean)">
  36924. <summary>
  36925. Set a bool value for the cell
  36926. </summary>
  36927. <param name="value"></param>
  36928. </member>
  36929. <member name="P:NPOI.SS.UserModel.ICell.BooleanCellValue">
  36930. <summary>
  36931. Get the value of the cell as a bool.
  36932. </summary>
  36933. </member>
  36934. <member name="P:NPOI.SS.UserModel.ICell.CellStyle">
  36935. <summary>
  36936. Return the cell's style.
  36937. </summary>
  36938. </member>
  36939. <member name="M:NPOI.SS.UserModel.ICell.SetAsActiveCell">
  36940. <summary>
  36941. Sets this cell as the active cell for the worksheet
  36942. </summary>
  36943. </member>
  36944. <member name="P:NPOI.SS.UserModel.ICell.CellComment">
  36945. <summary>
  36946. comment associated with this cell
  36947. </summary>
  36948. </member>
  36949. <member name="M:NPOI.SS.UserModel.ICell.RemoveCellComment">
  36950. <summary>
  36951. Removes the comment for this cell, if there is one.
  36952. </summary>
  36953. </member>
  36954. <member name="P:NPOI.SS.UserModel.ICell.Hyperlink">
  36955. <summary>
  36956. hyperlink associated with this cell
  36957. </summary>
  36958. </member>
  36959. <member name="M:NPOI.SS.UserModel.ICell.RemoveHyperlink">
  36960. <summary>
  36961. Removes the hyperlink for this cell, if there is one.
  36962. </summary>
  36963. </member>
  36964. <member name="P:NPOI.SS.UserModel.ICell.ArrayFormulaRange">
  36965. <summary>
  36966. Only valid for array formula cells
  36967. </summary>
  36968. <returns>range of the array formula group that the cell belongs to.</returns>
  36969. </member>
  36970. <member name="P:NPOI.SS.UserModel.ICell.IsPartOfArrayFormulaGroup">
  36971. <summary>
  36972. if this cell is part of group of cells having a common array formula.
  36973. </summary>
  36974. </member>
  36975. <member name="P:NPOI.SS.UserModel.ICellRange`1.Size">
  36976. Gets the number of cells in this range.
  36977. @return <tt>height * width </tt>
  36978. </member>
  36979. <member name="P:NPOI.SS.UserModel.ICellRange`1.ReferenceText">
  36980. @return the text format of this range. Single cell ranges are formatted
  36981. like single cell references (e.g. 'A1' instead of 'A1:A1').
  36982. </member>
  36983. <member name="P:NPOI.SS.UserModel.ICellRange`1.TopLeftCell">
  36984. @return the cell at relative coordinates (0,0). Never <code>null</code>.
  36985. </member>
  36986. <member name="M:NPOI.SS.UserModel.ICellRange`1.GetCell(System.Int32,System.Int32)">
  36987. @param relativeRowIndex must be between <tt>0</tt> and <tt>height-1</tt>
  36988. @param relativeColumnIndex must be between <tt>0</tt> and <tt>width-1</tt>
  36989. @return the cell at the specified coordinates. Never <code>null</code>.
  36990. </member>
  36991. <member name="P:NPOI.SS.UserModel.ICellRange`1.FlattenedCells">
  36992. @return a flattened array of all the cells in this {@link CellRange}
  36993. </member>
  36994. <member name="P:NPOI.SS.UserModel.ICellRange`1.Cells">
  36995. @return a 2-D array of all the cells in this {@link CellRange}. The first
  36996. array dimension is the row index (values <tt>0...height-1</tt>)
  36997. and the second dimension is the column index (values <tt>0...width-1</tt>)
  36998. </member>
  36999. <member name="P:NPOI.SS.UserModel.ICellStyle.ShrinkToFit">
  37000. <summary>
  37001. the Cell should be auto-sized to shrink to fit if the text is too long
  37002. </summary>
  37003. </member>
  37004. <member name="P:NPOI.SS.UserModel.ICellStyle.Index">
  37005. get the index within the Workbook (sequence within the collection of ExtnededFormat objects)
  37006. @return unique index number of the underlying record this style represents (probably you don't care
  37007. unless you're comparing which one is which)
  37008. </member>
  37009. <member name="P:NPOI.SS.UserModel.ICellStyle.DataFormat">
  37010. get the index of the format
  37011. @see DataFormat
  37012. </member>
  37013. <member name="M:NPOI.SS.UserModel.ICellStyle.GetDataFormatString">
  37014. Get the format string
  37015. </member>
  37016. <member name="M:NPOI.SS.UserModel.ICellStyle.SetFont(NPOI.SS.UserModel.IFont)">
  37017. set the font for this style
  37018. @param font a font object Created or retreived from the Workbook object
  37019. @see Workbook#CreateFont()
  37020. @see Workbook#GetFontAt(short)
  37021. </member>
  37022. <member name="P:NPOI.SS.UserModel.ICellStyle.FontIndex">
  37023. Gets the index of the font for this style
  37024. @see Workbook#GetFontAt(short)
  37025. </member>
  37026. <member name="P:NPOI.SS.UserModel.ICellStyle.IsHidden">
  37027. get whether the cell's using this style are to be hidden
  37028. @return hidden - whether the cell using this style should be hidden
  37029. </member>
  37030. <member name="P:NPOI.SS.UserModel.ICellStyle.IsLocked">
  37031. get whether the cell's using this style are to be locked
  37032. @return hidden - whether the cell using this style should be locked
  37033. </member>
  37034. <member name="P:NPOI.SS.UserModel.ICellStyle.Alignment">
  37035. get the type of horizontal alignment for the cell
  37036. @return align - the type of alignment
  37037. @see #ALIGN_GENERAL
  37038. @see #ALIGN_LEFT
  37039. @see #ALIGN_CENTER
  37040. @see #ALIGN_RIGHT
  37041. @see #ALIGN_FILL
  37042. @see #ALIGN_JUSTIFY
  37043. @see #ALIGN_CENTER_SELECTION
  37044. </member>
  37045. <member name="P:NPOI.SS.UserModel.ICellStyle.WrapText">
  37046. get whether the text should be wrapped
  37047. @return wrap text or not
  37048. </member>
  37049. <member name="P:NPOI.SS.UserModel.ICellStyle.VerticalAlignment">
  37050. get the type of vertical alignment for the cell
  37051. @return align the type of alignment
  37052. @see #VERTICAL_TOP
  37053. @see #VERTICAL_CENTER
  37054. @see #VERTICAL_BOTTOM
  37055. @see #VERTICAL_JUSTIFY
  37056. </member>
  37057. <member name="P:NPOI.SS.UserModel.ICellStyle.Rotation">
  37058. get the degree of rotation for the text in the cell
  37059. @return rotation degrees (between -90 and 90 degrees)
  37060. </member>
  37061. <member name="P:NPOI.SS.UserModel.ICellStyle.Indention">
  37062. get the number of spaces to indent the text in the cell
  37063. @return indent - number of spaces
  37064. </member>
  37065. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderLeft">
  37066. get the type of border to use for the left border of the cell
  37067. @return border type
  37068. @see #BORDER_NONE
  37069. @see #BORDER_THIN
  37070. @see #BORDER_MEDIUM
  37071. @see #BORDER_DASHED
  37072. @see #BORDER_DOTTED
  37073. @see #BORDER_THICK
  37074. @see #BORDER_DOUBLE
  37075. @see #BORDER_HAIR
  37076. @see #BORDER_MEDIUM_DASHED
  37077. @see #BORDER_DASH_DOT
  37078. @see #BORDER_MEDIUM_DASH_DOT
  37079. @see #BORDER_DASH_DOT_DOT
  37080. @see #BORDER_MEDIUM_DASH_DOT_DOT
  37081. @see #BORDER_SLANTED_DASH_DOT
  37082. </member>
  37083. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderRight">
  37084. get the type of border to use for the right border of the cell
  37085. @return border type
  37086. @see #BORDER_NONE
  37087. @see #BORDER_THIN
  37088. @see #BORDER_MEDIUM
  37089. @see #BORDER_DASHED
  37090. @see #BORDER_DOTTED
  37091. @see #BORDER_THICK
  37092. @see #BORDER_DOUBLE
  37093. @see #BORDER_HAIR
  37094. @see #BORDER_MEDIUM_DASHED
  37095. @see #BORDER_DASH_DOT
  37096. @see #BORDER_MEDIUM_DASH_DOT
  37097. @see #BORDER_DASH_DOT_DOT
  37098. @see #BORDER_MEDIUM_DASH_DOT_DOT
  37099. @see #BORDER_SLANTED_DASH_DOT
  37100. </member>
  37101. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderTop">
  37102. get the type of border to use for the top border of the cell
  37103. @return border type
  37104. @see #BORDER_NONE
  37105. @see #BORDER_THIN
  37106. @see #BORDER_MEDIUM
  37107. @see #BORDER_DASHED
  37108. @see #BORDER_DOTTED
  37109. @see #BORDER_THICK
  37110. @see #BORDER_DOUBLE
  37111. @see #BORDER_HAIR
  37112. @see #BORDER_MEDIUM_DASHED
  37113. @see #BORDER_DASH_DOT
  37114. @see #BORDER_MEDIUM_DASH_DOT
  37115. @see #BORDER_DASH_DOT_DOT
  37116. @see #BORDER_MEDIUM_DASH_DOT_DOT
  37117. @see #BORDER_SLANTED_DASH_DOT
  37118. </member>
  37119. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderBottom">
  37120. get the type of border to use for the bottom border of the cell
  37121. @return border type
  37122. @see #BORDER_NONE
  37123. @see #BORDER_THIN
  37124. @see #BORDER_MEDIUM
  37125. @see #BORDER_DASHED
  37126. @see #BORDER_DOTTED
  37127. @see #BORDER_THICK
  37128. @see #BORDER_DOUBLE
  37129. @see #BORDER_HAIR
  37130. @see #BORDER_MEDIUM_DASHED
  37131. @see #BORDER_DASH_DOT
  37132. @see #BORDER_MEDIUM_DASH_DOT
  37133. @see #BORDER_DASH_DOT_DOT
  37134. @see #BORDER_MEDIUM_DASH_DOT_DOT
  37135. @see #BORDER_SLANTED_DASH_DOT
  37136. </member>
  37137. <member name="P:NPOI.SS.UserModel.ICellStyle.LeftBorderColor">
  37138. get the color to use for the left border
  37139. </member>
  37140. <member name="P:NPOI.SS.UserModel.ICellStyle.RightBorderColor">
  37141. get the color to use for the left border
  37142. @return the index of the color defInition
  37143. </member>
  37144. <member name="P:NPOI.SS.UserModel.ICellStyle.TopBorderColor">
  37145. get the color to use for the top border
  37146. @return hhe index of the color defInition
  37147. </member>
  37148. <member name="P:NPOI.SS.UserModel.ICellStyle.BottomBorderColor">
  37149. get the color to use for the left border
  37150. @return the index of the color defInition
  37151. </member>
  37152. <member name="P:NPOI.SS.UserModel.ICellStyle.FillPattern">
  37153. get the fill pattern (??) - set to 1 to fill with foreground color
  37154. @return fill pattern
  37155. </member>
  37156. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColor">
  37157. get the background fill color
  37158. @return fill color
  37159. </member>
  37160. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColor">
  37161. get the foreground fill color
  37162. @return fill color
  37163. </member>
  37164. <member name="M:NPOI.SS.UserModel.ICellStyle.CloneStyleFrom(NPOI.SS.UserModel.ICellStyle)">
  37165. Clones all the style information from another
  37166. CellStyle, onto this one. This
  37167. CellStyle will then have all the same
  37168. properties as the source, but the two may
  37169. be edited independently.
  37170. Any stylings on this CellStyle will be lost!
  37171. The source CellStyle could be from another
  37172. Workbook if you like. This allows you to
  37173. copy styles from one Workbook to another.
  37174. However, both of the CellStyles will need
  37175. to be of the same type (HSSFCellStyle or
  37176. XSSFCellStyle)
  37177. </member>
  37178. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalColor">
  37179. <summary>
  37180. Gets or sets the color to use for the diagional border
  37181. </summary>
  37182. <value>The index of the color definition.</value>
  37183. </member>
  37184. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonalLineStyle">
  37185. <summary>
  37186. Gets or sets the line type to use for the diagional border
  37187. </summary>
  37188. <value>The line type.</value>
  37189. </member>
  37190. <member name="P:NPOI.SS.UserModel.ICellStyle.BorderDiagonal">
  37191. <summary>
  37192. Gets or sets the type of diagional border
  37193. </summary>.
  37194. <value>The border diagional type.</value>
  37195. </member>
  37196. <member name="P:NPOI.SS.UserModel.ICellStyle.FillBackgroundColorColor">
  37197. Gets the color object representing the current
  37198. background fill, resolving indexes using
  37199. the supplied workbook.
  37200. This will work for both indexed and rgb
  37201. defined colors.
  37202. </member>
  37203. <member name="P:NPOI.SS.UserModel.ICellStyle.FillForegroundColorColor">
  37204. Gets the color object representing the current
  37205. foreground fill, resolving indexes using
  37206. the supplied workbook.
  37207. This will work for both indexed and rgb
  37208. defined colors.
  37209. </member>
  37210. <member name="T:NPOI.SS.UserModel.CellValue">
  37211. Mimics the 'data view' of a cell. This allows formula Evaluator
  37212. to return a CellValue instead of precasting the value to String
  37213. or Number or bool type.
  37214. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  37215. </member>
  37216. <member name="P:NPOI.SS.UserModel.CellValue.BooleanValue">
  37217. @return Returns the boolValue.
  37218. </member>
  37219. <member name="P:NPOI.SS.UserModel.CellValue.NumberValue">
  37220. @return Returns the numberValue.
  37221. </member>
  37222. <member name="P:NPOI.SS.UserModel.CellValue.StringValue">
  37223. @return Returns the stringValue.
  37224. </member>
  37225. <member name="P:NPOI.SS.UserModel.CellValue.CellType">
  37226. @return Returns the cellType.
  37227. </member>
  37228. <member name="P:NPOI.SS.UserModel.CellValue.ErrorValue">
  37229. @return Returns the errorValue.
  37230. </member>
  37231. <member name="T:NPOI.SS.UserModel.IChart">
  37232. High level representation of a chart.
  37233. @author Roman Kashitsyn
  37234. </member>
  37235. <member name="P:NPOI.SS.UserModel.IChart.ChartDataFactory">
  37236. @return an appropriate ChartDataFactory implementation
  37237. </member>
  37238. <member name="P:NPOI.SS.UserModel.IChart.ChartAxisFactory">
  37239. @return an appropriate ChartAxisFactory implementation
  37240. </member>
  37241. <member name="M:NPOI.SS.UserModel.IChart.GetOrCreateLegend">
  37242. @return chart legend instance
  37243. </member>
  37244. <member name="M:NPOI.SS.UserModel.IChart.DeleteLegend">
  37245. Delete current chart legend.
  37246. </member>
  37247. <member name="M:NPOI.SS.UserModel.IChart.GetAxis">
  37248. @return list of all chart axis
  37249. </member>
  37250. <member name="M:NPOI.SS.UserModel.IChart.Plot(NPOI.SS.UserModel.Charts.IChartData,NPOI.SS.UserModel.Charts.IChartAxis[])">
  37251. Plots specified data on the chart.
  37252. @param data a data to plot
  37253. </member>
  37254. <member name="T:NPOI.SS.UserModel.Charts.AxisCrossBetween">
  37255. Specifies the possible crossing states of an axis.
  37256. @author Roman Kashitsyn
  37257. </member>
  37258. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.Between">
  37259. Specifies the value axis shall cross the category axis
  37260. between data markers.
  37261. </member>
  37262. <member name="F:NPOI.SS.UserModel.Charts.AxisCrossBetween.MidpointCategory">
  37263. Specifies the value axis shall cross the category axis at
  37264. the midpoint of a category.
  37265. </member>
  37266. <member name="T:NPOI.SS.UserModel.Charts.AxisCrosses">
  37267. Specifies the possible crossing points for an axis.
  37268. @author Roman Kashitsyn
  37269. </member>
  37270. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.AutoZero">
  37271. The category axis crosses at the zero point of the value axis (if
  37272. possible), or the minimum value (if the minimum is greater than zero) or
  37273. the maximum (if the maximum is less than zero).
  37274. </member>
  37275. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Min">
  37276. The axis crosses at the maximum value.
  37277. </member>
  37278. <member name="F:NPOI.SS.UserModel.Charts.AxisCrosses.Max">
  37279. Axis crosses at the minimum value of the chart.
  37280. </member>
  37281. <member name="T:NPOI.SS.UserModel.Charts.AxisOrientation">
  37282. Specifies the possible ways to place a picture on a data point, series, wall, or floor.
  37283. @author Roman Kashitsyn
  37284. </member>
  37285. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MaxToMin">
  37286. Specifies that the values on the axis shall be reversed
  37287. so they go from maximum to minimum.
  37288. </member>
  37289. <member name="F:NPOI.SS.UserModel.Charts.AxisOrientation.MinToMax">
  37290. Specifies that the axis values shall be in the usual
  37291. order, minimum to maximum.
  37292. </member>
  37293. <member name="T:NPOI.SS.UserModel.Charts.AxisPosition">
  37294. Enumeration of all possible axis positions.
  37295. @author Roman Kashitsyn
  37296. </member>
  37297. <member name="T:NPOI.SS.UserModel.Charts.IBarChartData`2">
  37298. <summary>
  37299. Data for a Bar Chart
  37300. </summary>
  37301. <typeparam name="Tx"></typeparam>
  37302. <typeparam name="Ty"></typeparam>
  37303. </member>
  37304. <member name="M:NPOI.SS.UserModel.Charts.IBarChartData`2.GetSeries">
  37305. @return list of all series.
  37306. </member>
  37307. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetCategoryAxisData">
  37308. @return data source used for category axis data.
  37309. </member>
  37310. <member name="M:NPOI.SS.UserModel.Charts.IBarChartSeries`2.GetValues">
  37311. @return data source used for value axis.
  37312. </member>
  37313. <member name="T:NPOI.SS.UserModel.Charts.IChartAxis">
  37314. High level representation of chart axis.
  37315. @author Roman Kashitsyn
  37316. </member>
  37317. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Id">
  37318. @return axis id
  37319. </member>
  37320. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Position">
  37321. get or set axis position
  37322. </member>
  37323. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.NumberFormat">
  37324. get or set axis number format
  37325. </member>
  37326. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetLogBase">
  37327. @return true if log base is defined, false otherwise
  37328. </member>
  37329. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.LogBase">
  37330. @param logBase a number between 2 and 1000 (inclusive)
  37331. @return axis log base or 0.0 if not Set
  37332. @throws ArgumentException if log base not within allowed range
  37333. </member>
  37334. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMinimum">
  37335. @return true if minimum value is defined, false otherwise
  37336. </member>
  37337. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Minimum">
  37338. get or set axis minimum
  37339. 0.0 if not Set
  37340. </member>
  37341. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsSetMaximum">
  37342. @return true if maximum value is defined, false otherwise
  37343. </member>
  37344. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Maximum">
  37345. get or set axis maximum
  37346. 0.0 if not Set
  37347. </member>
  37348. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Orientation">
  37349. get or set axis orientation
  37350. </member>
  37351. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.Crosses">
  37352. get or set axis cross type
  37353. </member>
  37354. <member name="M:NPOI.SS.UserModel.Charts.IChartAxis.CrossAxis(NPOI.SS.UserModel.Charts.IChartAxis)">
  37355. Declare this axis cross another axis.
  37356. @param axis that this axis should cross
  37357. </member>
  37358. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.IsVisible">
  37359. @return visibility of the axis.
  37360. </member>
  37361. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MajorTickMark">
  37362. @return major tick mark.
  37363. </member>
  37364. <member name="P:NPOI.SS.UserModel.Charts.IChartAxis.MinorTickMark">
  37365. @return minor tick mark.
  37366. </member>
  37367. <member name="T:NPOI.SS.UserModel.Charts.IChartAxisFactory">
  37368. <summary>
  37369. A factory for different chart axis.
  37370. </summary>
  37371. <remarks>@author Roman Kashitsyn</remarks>
  37372. </member>
  37373. <member name="M:NPOI.SS.UserModel.Charts.IChartAxisFactory.CreateValueAxis(NPOI.SS.UserModel.Charts.AxisPosition)">
  37374. <summary>
  37375. returns new value axis
  37376. </summary>
  37377. <param name="pos"></param>
  37378. <returns></returns>
  37379. </member>
  37380. <member name="T:NPOI.SS.UserModel.Charts.IChartData">
  37381. <summary>
  37382. A base for all chart data types.
  37383. </summary>
  37384. <remarks>
  37385. @author Roman Kashitsyn
  37386. </remarks>
  37387. </member>
  37388. <member name="M:NPOI.SS.UserModel.Charts.IChartData.FillChart(NPOI.SS.UserModel.IChart,NPOI.SS.UserModel.Charts.IChartAxis[])">
  37389. <summary>
  37390. Fills a chart with data specified by implementation.
  37391. </summary>
  37392. <param name="chart">a chart to fill in</param>
  37393. <param name="axis">chart axis to use</param>
  37394. </member>
  37395. <member name="T:NPOI.SS.UserModel.Charts.IChartDataFactory">
  37396. <summary>
  37397. A factory for different chart data types.
  37398. </summary>
  37399. <remarks>
  37400. @author Roman Kashitsyn
  37401. </remarks>
  37402. </member>
  37403. <member name="M:NPOI.SS.UserModel.Charts.IChartDataFactory.CreateScatterChartData``2">
  37404. <summary>
  37405. returns an appropriate ScatterChartData instance
  37406. </summary>
  37407. <returns></returns>
  37408. </member>
  37409. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.PointCount">
  37410. Return number of points contained by data source.
  37411. @return number of points contained by data source
  37412. </member>
  37413. <member name="M:NPOI.SS.UserModel.Charts.IChartDataSource`1.GetPointAt(System.Int32)">
  37414. Returns point value at specified index.
  37415. @param index index to value from
  37416. @return point value at specified index.
  37417. @throws {@code IndexOutOfBoundsException} if index
  37418. parameter not in range {@code 0 &lt;= index &lt;= pointCount}
  37419. </member>
  37420. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsReference">
  37421. Returns {@code true} if charts data source is valid cell range.
  37422. @return {@code true} if charts data source is valid cell range
  37423. </member>
  37424. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.IsNumeric">
  37425. Returns {@code true} if data source points should be treated as numbers.
  37426. @return {@code true} if data source points should be treated as numbers
  37427. </member>
  37428. <member name="P:NPOI.SS.UserModel.Charts.IChartDataSource`1.FormulaString">
  37429. Returns formula representation of the data source. It is only applicable
  37430. for data source that is valid cell range.
  37431. @return formula representation of the data source
  37432. @throws {@code UnsupportedOperationException} if the data source is not a
  37433. reference.
  37434. </member>
  37435. <member name="T:NPOI.SS.UserModel.Charts.IChartLegend">
  37436. <summary>
  37437. High level representation of chart legend.
  37438. </summary>
  37439. <remarks>@author Roman Kashitsyn</remarks>
  37440. </member>
  37441. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.Position">
  37442. <summary>
  37443. legend position
  37444. </summary>
  37445. <returns></returns>
  37446. </member>
  37447. <member name="P:NPOI.SS.UserModel.Charts.IChartLegend.IsOverlay">
  37448. <summary>
  37449. If true the legend is positioned over the chart area otherwise
  37450. the legend is displayed next to it.
  37451. Default is no overlay.
  37452. </summary>
  37453. </member>
  37454. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(System.String)">
  37455. Sets the title of the series as a string literal.
  37456. @param title
  37457. </member>
  37458. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.SetTitle(NPOI.SS.Util.CellReference)">
  37459. Sets the title of the series as a cell reference.
  37460. @param titleReference
  37461. </member>
  37462. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleString">
  37463. @return title as string literal.
  37464. </member>
  37465. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleCellReference">
  37466. @return title as cell reference.
  37467. </member>
  37468. <member name="M:NPOI.SS.UserModel.Charts.IChartSeries.GetTitleType">
  37469. @return title type.
  37470. </member>
  37471. <member name="T:NPOI.SS.UserModel.Charts.LayoutMode">
  37472. <summary>
  37473. Specifies the possible ways to store a chart element's position.
  37474. </summary>
  37475. <remarks>
  37476. @author Roman Kashitsyn
  37477. </remarks>
  37478. </member>
  37479. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Edge">
  37480. <summary>
  37481. Specifies that the Width or Height shall be interpreted as the Right or Bottom of the chart element.
  37482. </summary>
  37483. </member>
  37484. <member name="F:NPOI.SS.UserModel.Charts.LayoutMode.Factor">
  37485. <summary>
  37486. Specifies that the Width or Height shall be interpreted as the width or Height of the chart element.
  37487. </summary>
  37488. </member>
  37489. <member name="T:NPOI.SS.UserModel.Charts.LayoutTarget">
  37490. <summary>
  37491. Specifies whether to layout the plot area by its inside (not including axis
  37492. and axis labels) or outside (including axis and axis labels).
  37493. </summary>
  37494. <remarks>
  37495. @author Roman Kashitsyn
  37496. </remarks>
  37497. </member>
  37498. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Inner">
  37499. <summary>
  37500. Specifies that the plot area size shall determine the size of the plot area, not including the tick marks and axis labels.
  37501. </summary>
  37502. </member>
  37503. <member name="F:NPOI.SS.UserModel.Charts.LayoutTarget.Outer">
  37504. <summary>
  37505. Specifies that the plot area size shall determine the
  37506. size of the plot area, the tick marks, and the axis
  37507. labels.
  37508. </summary>
  37509. </member>
  37510. <member name="T:NPOI.SS.UserModel.Charts.LegendPosition">
  37511. <summary>
  37512. Enumeration of all possible chart legend positions.
  37513. </summary>
  37514. <remarks>
  37515. @author Roman Kashitsyn
  37516. </remarks>
  37517. </member>
  37518. <member name="T:NPOI.SS.UserModel.Charts.ILineChartData`2">
  37519. <summary>
  37520. Data for a Line Chart
  37521. </summary>
  37522. <typeparam name="Tx"></typeparam>
  37523. <typeparam name="Ty"></typeparam>
  37524. </member>
  37525. <member name="M:NPOI.SS.UserModel.Charts.ILineChartData`2.GetSeries">
  37526. @return list of all series.
  37527. </member>
  37528. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetCategoryAxisData">
  37529. @return data source used for category axis data.
  37530. </member>
  37531. <member name="M:NPOI.SS.UserModel.Charts.ILineChartSeries`2.GetValues">
  37532. @return data source used for value axis.
  37533. </member>
  37534. <member name="T:NPOI.SS.UserModel.Charts.IManualLayout">
  37535. High level representation of chart element manual layout.
  37536. @author Roman Kashitsyn
  37537. </member>
  37538. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetTarget(NPOI.SS.UserModel.Charts.LayoutTarget)">
  37539. Sets the layout target.
  37540. @param target new layout target.
  37541. </member>
  37542. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetTarget">
  37543. Returns current layout target.
  37544. @return current layout target
  37545. </member>
  37546. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetXMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37547. Sets the x-coordinate layout mode.
  37548. @param mode new x-coordinate layout mode.
  37549. </member>
  37550. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetXMode">
  37551. Returns current x-coordinnate layout mode.
  37552. @return current x-coordinate layout mode.
  37553. </member>
  37554. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetYMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37555. Sets the y-coordinate layout mode.
  37556. @param mode new y-coordinate layout mode.
  37557. </member>
  37558. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetYMode">
  37559. Returns current y-coordinate layout mode.
  37560. @return current y-coordinate layout mode.
  37561. </member>
  37562. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetX">
  37563. Returns the x location of the chart element.
  37564. @return the x location (left) of the chart element or 0.0 if
  37565. not Set.
  37566. </member>
  37567. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetX(System.Double)">
  37568. Specifies the x location (left) of the chart element as a
  37569. fraction of the width of the chart. If Left Mode is Factor,
  37570. then the position is relative to the default position for the
  37571. chart element.
  37572. </member>
  37573. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetY">
  37574. Returns current y location of the chart element.
  37575. @return the y location (top) of the chart element or 0.0 if not
  37576. Set.
  37577. </member>
  37578. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetY(System.Double)">
  37579. Specifies the y location (top) of the chart element as a
  37580. fraction of the height of the chart. If Top Mode is Factor,
  37581. then the position is relative to the default position for the
  37582. chart element.
  37583. </member>
  37584. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37585. Specifies how to interpret the Width element for this manual
  37586. layout.
  37587. @param mode new width layout mode of this manual layout.
  37588. </member>
  37589. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthMode">
  37590. Returns current width mode of this manual layout.
  37591. @return width mode of this manual layout.
  37592. </member>
  37593. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightMode(NPOI.SS.UserModel.Charts.LayoutMode)">
  37594. Specifies how to interpret the Height element for this manual
  37595. layout.
  37596. @param mode new height mode of this manual layout.
  37597. </member>
  37598. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightMode">
  37599. Returns current height mode of this
  37600. @return height mode of this manual layout.
  37601. </member>
  37602. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetWidthRatio(System.Double)">
  37603. Specifies the width (if Width Mode is Factor) or right (if
  37604. Width Mode is Edge) of the chart element as a fraction of the
  37605. width of the chart.
  37606. @param ratio a fraction of the width of the chart.
  37607. </member>
  37608. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetWidthRatio">
  37609. Returns current fraction of the width of the chart.
  37610. @return fraction of the width of the chart or 0.0 if not Set.
  37611. </member>
  37612. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.SetHeightRatio(System.Double)">
  37613. Specifies the height (if Height Mode is Factor) or bottom (if
  37614. Height Mode is edge) of the chart element as a fraction of the
  37615. height of the chart.
  37616. @param ratio a fraction of the height of the chart.
  37617. </member>
  37618. <member name="M:NPOI.SS.UserModel.Charts.IManualLayout.GetHeightRatio">
  37619. Returns current fraction of the height of the chart.
  37620. @return fraction of the height of the chart or 0.0 if not Set.
  37621. </member>
  37622. <member name="T:NPOI.SS.UserModel.Charts.ManuallyPositionable">
  37623. Abstraction of chart element that can be positioned with manual
  37624. layout.
  37625. @author Roman Kashitsyn
  37626. </member>
  37627. <member name="M:NPOI.SS.UserModel.Charts.ManuallyPositionable.GetManualLayout">
  37628. Returns manual layout for the chart element.
  37629. @return manual layout for the chart element.
  37630. </member>
  37631. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartData`2">
  37632. Data for a Scatter Chart
  37633. </member>
  37634. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.AddSeries(NPOI.SS.UserModel.Charts.IChartDataSource{`0},NPOI.SS.UserModel.Charts.IChartDataSource{`1})">
  37635. @param xs data source to be used for X axis values
  37636. @param ys data source to be used for Y axis values
  37637. @return a new scatter charts series
  37638. </member>
  37639. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartData`2.GetSeries">
  37640. @return list of all series
  37641. </member>
  37642. <member name="T:NPOI.SS.UserModel.Charts.IScatterChartSeries`2">
  37643. Represents scatter charts serie.
  37644. @author Roman Kashitsyn
  37645. </member>
  37646. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetXValues">
  37647. @return data source used for X axis values
  37648. </member>
  37649. <member name="M:NPOI.SS.UserModel.Charts.IScatterChartSeries`2.GetYValues">
  37650. @return data source used for Y axis values
  37651. </member>
  37652. <member name="T:NPOI.SS.UserModel.Charts.IValueAxis">
  37653. @author Roman Kashitsyn
  37654. </member>
  37655. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.GetCrossBetween">
  37656. @return cross between type
  37657. </member>
  37658. <member name="M:NPOI.SS.UserModel.Charts.IValueAxis.SetCrossBetween(NPOI.SS.UserModel.Charts.AxisCrossBetween)">
  37659. @param crossBetween cross between type
  37660. </member>
  37661. <member name="F:NPOI.SS.UserModel.AnchorType.MoveAndResize">
  37662. Move and Resize With Anchor Cells
  37663. <p>
  37664. Specifies that the current drawing shall move and
  37665. resize to maintain its row and column anchors (i.e. the
  37666. object is anchored to the actual from and to row and column)
  37667. </p>
  37668. </member>
  37669. <member name="F:NPOI.SS.UserModel.AnchorType.MoveDontResize">
  37670. Move With Cells but Do Not Resize
  37671. <p>
  37672. Specifies that the current drawing shall move with its
  37673. row and column (i.e. the object is anchored to the
  37674. actual from row and column), but that the size shall remain absolute.
  37675. </p>
  37676. <p>
  37677. If Additional rows/columns are Added between the from and to locations of the drawing,
  37678. the drawing shall move its to anchors as needed to maintain this same absolute size.
  37679. </p>
  37680. </member>
  37681. <member name="F:NPOI.SS.UserModel.AnchorType.DontMoveAndResize">
  37682. Do Not Move or Resize With Underlying Rows/Columns
  37683. <p>
  37684. Specifies that the current start and end positions shall
  37685. be maintained with respect to the distances from the
  37686. absolute start point of the worksheet.
  37687. </p>
  37688. <p>
  37689. If Additional rows/columns are Added before the
  37690. drawing, the drawing shall move its anchors as needed
  37691. to maintain this same absolute position.
  37692. </p>
  37693. </member>
  37694. <member name="T:NPOI.SS.UserModel.IClientAnchor">
  37695. A client anchor is attached to an excel worksheet. It anchors against a
  37696. top-left and bottom-right cell.
  37697. @author Yegor Kozlov
  37698. </member>
  37699. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col1">
  37700. Returns the column (0 based) of the first cell.
  37701. @return 0-based column of the first cell.
  37702. </member>
  37703. <member name="P:NPOI.SS.UserModel.IClientAnchor.Col2">
  37704. Returns the column (0 based) of the second cell.
  37705. @return 0-based column of the second cell.
  37706. </member>
  37707. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row1">
  37708. Returns the row (0 based) of the first cell.
  37709. @return 0-based row of the first cell.
  37710. </member>
  37711. <member name="P:NPOI.SS.UserModel.IClientAnchor.Row2">
  37712. Returns the row (0 based) of the second cell.
  37713. @return 0-based row of the second cell.
  37714. </member>
  37715. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx1">
  37716. Returns the x coordinate within the first cell
  37717. @return the x coordinate within the first cell
  37718. </member>
  37719. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy1">
  37720. Returns the y coordinate within the first cell
  37721. @return the y coordinate within the first cell
  37722. </member>
  37723. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dy2">
  37724. Sets the y coordinate within the second cell
  37725. @return the y coordinate within the second cell
  37726. </member>
  37727. <member name="P:NPOI.SS.UserModel.IClientAnchor.Dx2">
  37728. Returns the x coordinate within the second cell
  37729. @return the x coordinate within the second cell
  37730. </member>
  37731. <member name="P:NPOI.SS.UserModel.IClientAnchor.AnchorType">
  37732. s the anchor type
  37733. <p>
  37734. 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
  37735. </p>
  37736. @return the anchor type
  37737. @see #MOVE_AND_RESIZE
  37738. @see #MOVE_DONT_RESIZE
  37739. @see #DONT_MOVE_AND_RESIZE
  37740. </member>
  37741. <member name="P:NPOI.SS.UserModel.IComment.Visible">
  37742. Sets whether this comment is visible.
  37743. @return <c>true</c> if the comment is visible, <c>false</c> otherwise
  37744. </member>
  37745. <member name="P:NPOI.SS.UserModel.IComment.Row">
  37746. Return the row of the cell that Contains the comment
  37747. @return the 0-based row of the cell that Contains the comment
  37748. </member>
  37749. <member name="P:NPOI.SS.UserModel.IComment.Column">
  37750. Return the column of the cell that Contains the comment
  37751. @return the 0-based column of the cell that Contains the comment
  37752. </member>
  37753. <member name="P:NPOI.SS.UserModel.IComment.Author">
  37754. Name of the original comment author
  37755. @return the name of the original author of the comment
  37756. </member>
  37757. <member name="P:NPOI.SS.UserModel.IComment.String">
  37758. Fetches the rich text string of the comment
  37759. </member>
  37760. <member name="P:NPOI.SS.UserModel.IComment.ClientAnchor">
  37761. Return defines position of this anchor in the sheet.
  37762. @return defines position of this anchor in the sheet
  37763. </member>
  37764. <member name="T:NPOI.SS.UserModel.ComparisonOperator">
  37765. The conditional format operators used for "Highlight Cells That Contain..." rules.
  37766. <p>
  37767. For example, "highlight cells that begin with "M2" and contain "Mountain Gear".
  37768. </p>
  37769. @author Dmitriy Kumshayev
  37770. @author Yegor Kozlov
  37771. </member>
  37772. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Between">
  37773. 'Between' operator
  37774. </member>
  37775. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotBetween">
  37776. 'Not between' operator
  37777. </member>
  37778. <member name="F:NPOI.SS.UserModel.ComparisonOperator.Equal">
  37779. 'Equal to' operator
  37780. </member>
  37781. <member name="F:NPOI.SS.UserModel.ComparisonOperator.NotEqual">
  37782. 'Not equal to' operator
  37783. </member>
  37784. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThan">
  37785. 'Greater than' operator
  37786. </member>
  37787. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThan">
  37788. 'Less than' operator
  37789. </member>
  37790. <member name="F:NPOI.SS.UserModel.ComparisonOperator.GreaterThanOrEqual">
  37791. 'Greater than or equal to' operator
  37792. </member>
  37793. <member name="F:NPOI.SS.UserModel.ComparisonOperator.LessThanOrEqual">
  37794. 'Less than or equal to' operator
  37795. </member>
  37796. <member name="T:NPOI.SS.UserModel.IConditionalFormatting">
  37797. The ConditionalFormatting class encapsulates all Settings of Conditional Formatting.
  37798. The class can be used
  37799. <UL>
  37800. <LI>
  37801. to make a copy ConditionalFormatting Settings.
  37802. </LI>
  37803. For example:
  37804. <PRE>
  37805. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  37806. newSheet.AddConditionalFormatting(cf);
  37807. </PRE>
  37808. <LI>
  37809. or to modify existing Conditional Formatting Settings (formatting regions and/or rules).
  37810. </LI>
  37811. </UL>
  37812. Use {@link NPOI.HSSF.UserModel.Sheet#getSheetConditionalFormatting()} to Get access to an instance of this class.
  37813. To create a new Conditional Formatting Set use the following approach:
  37814. <PRE>
  37815. // Define a Conditional Formatting rule, which triggers formatting
  37816. // when cell's value is greater or equal than 100.0 and
  37817. // applies patternFormatting defined below.
  37818. ConditionalFormattingRule rule = sheet.CreateConditionalFormattingRule(
  37819. ComparisonOperator.GE,
  37820. "100.0", // 1st formula
  37821. null // 2nd formula is not used for comparison operator GE
  37822. );
  37823. // Create pattern with red background
  37824. PatternFormatting patternFmt = rule.CretePatternFormatting();
  37825. patternFormatting.FillBackgroundColor(IndexedColor.RED.Index);
  37826. // Define a region Containing first column
  37827. Region [] regions =
  37828. {
  37829. new Region(1,(short)1,-1,(short)1)
  37830. };
  37831. // Apply Conditional Formatting rule defined above to the regions
  37832. sheet.AddConditionalFormatting(regions, rule);
  37833. </PRE>
  37834. @author Dmitriy Kumshayev
  37835. @author Yegor Kozlov
  37836. </member>
  37837. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetFormattingRanges">
  37838. @return array of <c>CellRangeAddress</c>s. Never <code>null</code>
  37839. </member>
  37840. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.SetRule(System.Int32,NPOI.SS.UserModel.IConditionalFormattingRule)">
  37841. Replaces an existing Conditional Formatting rule at position idx.
  37842. Excel allows to create up to 3 Conditional Formatting rules.
  37843. This method can be useful to modify existing Conditional Formatting rules.
  37844. @param idx position of the rule. Should be between 0 and 2.
  37845. @param cfRule - Conditional Formatting rule
  37846. </member>
  37847. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.AddRule(NPOI.SS.UserModel.IConditionalFormattingRule)">
  37848. Add a Conditional Formatting rule.
  37849. Excel allows to create up to 3 Conditional Formatting rules.
  37850. @param cfRule - Conditional Formatting rule
  37851. </member>
  37852. <member name="M:NPOI.SS.UserModel.IConditionalFormatting.GetRule(System.Int32)">
  37853. @return the Conditional Formatting rule at position idx.
  37854. </member>
  37855. <member name="P:NPOI.SS.UserModel.IConditionalFormatting.NumberOfRules">
  37856. @return number of Conditional Formatting rules.
  37857. </member>
  37858. <member name="F:NPOI.SS.UserModel.ConditionType.None">
  37859. <summary>
  37860. Allow accessing the Initial value.
  37861. </summary>
  37862. </member>
  37863. <member name="F:NPOI.SS.UserModel.ConditionType.CellValueIs">
  37864. This conditional formatting rule Compares a cell value
  37865. to a formula calculated result, using an operator
  37866. </member>
  37867. <member name="F:NPOI.SS.UserModel.ConditionType.Formula">
  37868. This conditional formatting rule Contains a formula to Evaluate.
  37869. When the formula result is true, the cell is highlighted.
  37870. </member>
  37871. <member name="T:NPOI.SS.UserModel.IConditionalFormattingRule">
  37872. Represents a description of a conditional formatting rule
  37873. @author Dmitriy Kumshayev
  37874. @author Yegor Kozlov
  37875. </member>
  37876. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateBorderFormatting">
  37877. Create a new border formatting structure if it does not exist,
  37878. otherwise just return existing object.
  37879. @return - border formatting object, never returns <code>null</code>.
  37880. </member>
  37881. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetBorderFormatting">
  37882. @return - border formatting object if defined, <code>null</code> otherwise
  37883. </member>
  37884. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreateFontFormatting">
  37885. Create a new font formatting structure if it does not exist,
  37886. otherwise just return existing object.
  37887. @return - font formatting object, never returns <code>null</code>.
  37888. </member>
  37889. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetFontFormatting">
  37890. @return - font formatting object if defined, <code>null</code> otherwise
  37891. </member>
  37892. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.CreatePatternFormatting">
  37893. Create a new pattern formatting structure if it does not exist,
  37894. otherwise just return existing object.
  37895. @return - pattern formatting object, never returns <code>null</code>.
  37896. </member>
  37897. <member name="M:NPOI.SS.UserModel.IConditionalFormattingRule.GetPatternFormatting">
  37898. @return - pattern formatting object if defined, <code>null</code> otherwise
  37899. </member>
  37900. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ConditionType">
  37901. Type of conditional formatting rule.
  37902. <p>
  37903. MUST be either {@link #CONDITION_TYPE_CELL_VALUE_IS} or {@link #CONDITION_TYPE_FORMULA}
  37904. </p>
  37905. @return the type of condition
  37906. </member>
  37907. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.ComparisonOperation">
  37908. The comparison function used when the type of conditional formatting is Set to
  37909. {@link #CONDITION_TYPE_CELL_VALUE_IS}
  37910. <p>
  37911. MUST be a constant from {@link ComparisonOperator}
  37912. </p>
  37913. @return the conditional format operator
  37914. </member>
  37915. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula1">
  37916. The formula used to Evaluate the first operand for the conditional formatting rule.
  37917. <p>
  37918. If the condition type is {@link #CONDITION_TYPE_CELL_VALUE_IS},
  37919. this field is the first operand of the comparison.
  37920. If type is {@link #CONDITION_TYPE_FORMULA}, this formula is used
  37921. to determine if the conditional formatting is applied.
  37922. </p>
  37923. <p>
  37924. If comparison type is {@link #CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function
  37925. </p>
  37926. @return the first formula
  37927. </member>
  37928. <member name="P:NPOI.SS.UserModel.IConditionalFormattingRule.Formula2">
  37929. The formula used to Evaluate the second operand of the comparison when
  37930. comparison type is {@link #CONDITION_TYPE_CELL_VALUE_IS} and operator
  37931. is either {@link ComparisonOperator#BETWEEN} or {@link ComparisonOperator#NOT_BETWEEN}
  37932. @return the second formula
  37933. </member>
  37934. <member name="T:NPOI.SS.UserModel.ICreationHelper">
  37935. An object that handles instantiating concrete
  37936. classes of the various instances one needs for
  37937. HSSF and XSSF.
  37938. Works around a major shortcoming in Java, where we
  37939. can't have static methods on interfaces or abstract
  37940. classes.
  37941. This allows you to get the appropriate class for
  37942. a given interface, without you having to worry
  37943. about if you're dealing with HSSF or XSSF, despite
  37944. Java being quite rubbish.
  37945. </member>
  37946. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateRichTextString(System.String)">
  37947. Creates a new RichTextString instance
  37948. @param text The text to Initialise the RichTextString with
  37949. </member>
  37950. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateDataFormat">
  37951. Creates a new DataFormat instance
  37952. </member>
  37953. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateHyperlink(NPOI.SS.UserModel.HyperlinkType)">
  37954. Creates a new Hyperlink, of the given type
  37955. </member>
  37956. <member name="M:NPOI.SS.UserModel.ICreationHelper.CreateFormulaEvaluator">
  37957. Creates FormulaEvaluator - an object that Evaluates formula cells.
  37958. @return a FormulaEvaluator instance
  37959. </member>
  37960. <member name="T:NPOI.SS.UserModel.DataConsolidateFunction">
  37961. Enum mapping the values of STDataConsolidateFunction
  37962. </member>
  37963. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.String)">
  37964. get the format index that matches the given format string.
  37965. Creates a new format if one is not found. Aliases text to the proper format.
  37966. @param format string matching a built in format
  37967. @return index of format.
  37968. </member>
  37969. <member name="M:NPOI.SS.UserModel.IDataFormat.GetFormat(System.Int16)">
  37970. get the format string that matches the given format index
  37971. @param index of a format
  37972. @return string represented at index of format or null if there is not a format at that index
  37973. </member>
  37974. <member name="T:NPOI.SS.UserModel.DataFormatter">
  37975. HSSFDataFormatter contains methods for Formatting the value stored in an
  37976. Cell. This can be useful for reports and GUI presentations when you
  37977. need to display data exactly as it appears in Excel. Supported Formats
  37978. include currency, SSN, percentages, decimals, dates, phone numbers, zip
  37979. codes, etc.
  37980. Internally, Formats will be implemented using subclasses of <see cref="T:NPOI.SS.Util.FormatBase"/>
  37981. such as <see cref="T:NPOI.SS.Util.DecimalFormat"/> and <see cref="T:NPOI.SS.Util.SimpleDateFormat"/>. Therefore the
  37982. Formats used by this class must obey the same pattern rules as these FormatBase
  37983. subclasses. This means that only legal number pattern characters ("0", "#",
  37984. ".", "," etc.) may appear in number formats. Other characters can be
  37985. inserted <em>before</em> or <em> after</em> the number pattern to form a
  37986. prefix or suffix.
  37987. For example the Excel pattern <c>"$#,##0.00 "USD"_);($#,##0.00 "USD")"
  37988. </c> will be correctly Formatted as "$1,000.00 USD" or "($1,000.00 USD)".
  37989. However the pattern <c>"00-00-00"</c> is incorrectly Formatted by
  37990. DecimalFormat as "000000--". For Excel Formats that are not compatible with
  37991. DecimalFormat, you can provide your own custom {@link FormatBase} implementation
  37992. via <c>HSSFDataFormatter.AddFormat(String,FormatBase)</c>. The following
  37993. custom Formats are already provided by this class:
  37994. <pre>
  37995. <ul><li>SSN "000-00-0000"</li>
  37996. <li>Phone Number "(###) ###-####"</li>
  37997. <li>Zip plus 4 "00000-0000"</li>
  37998. </ul>
  37999. </pre>
  38000. If the Excel FormatBase pattern cannot be Parsed successfully, then a default
  38001. FormatBase will be used. The default number FormatBase will mimic the Excel General
  38002. FormatBase: "#" for whole numbers and "#.##########" for decimal numbers. You
  38003. can override the default FormatBase pattern with <c>
  38004. HSSFDataFormatter.setDefaultNumberFormat(FormatBase)</c>. <b>Note:</b> the
  38005. default FormatBase will only be used when a FormatBase cannot be Created from the
  38006. cell's data FormatBase string.
  38007. @author James May (james dot may at fmr dot com)
  38008. </member>
  38009. <member name="F:NPOI.SS.UserModel.DataFormatter.numPattern">
  38010. Pattern to find a number FormatBase: "0" or "#"
  38011. </member>
  38012. <member name="F:NPOI.SS.UserModel.DataFormatter.amPmPattern">
  38013. Pattern to find "AM/PM" marker
  38014. </member>
  38015. <member name="F:NPOI.SS.UserModel.DataFormatter.localePatternGroup">
  38016. A regex to find patterns like [$$-1009] and [$�-452].
  38017. Note that we don't currently process these into locales
  38018. </member>
  38019. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionPattern">
  38020. A regex to identify a fraction pattern.
  38021. This requires that replaceAll("\\?", "#") has already been called
  38022. </member>
  38023. <member name="F:NPOI.SS.UserModel.DataFormatter.fractionStripper">
  38024. A regex to strip junk out of fraction formats
  38025. </member>
  38026. <member name="F:NPOI.SS.UserModel.DataFormatter.invalidDateTimeString">
  38027. * Cells formatted with a date or time format and which contain invalid date or time values
  38028. * show 255 pound signs ("#").
  38029. </member>
  38030. <member name="F:NPOI.SS.UserModel.DataFormatter.generalWholeNumFormat">
  38031. <em>General</em> FormatBase for whole numbers.
  38032. </member>
  38033. <member name="F:NPOI.SS.UserModel.DataFormatter.generalDecimalNumFormat">
  38034. <em>General</em> FormatBase for decimal numbers.
  38035. </member>
  38036. <member name="F:NPOI.SS.UserModel.DataFormatter.defaultNumFormat">
  38037. A default FormatBase to use when a number pattern cannot be Parsed.
  38038. </member>
  38039. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor">
  38040. Creates a formatter using the {@link Locale#getDefault() default locale}.
  38041. </member>
  38042. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo)">
  38043. Constructor
  38044. </member>
  38045. <member name="M:NPOI.SS.UserModel.DataFormatter.#ctor(System.Globalization.CultureInfo,System.Boolean)">
  38046. Creates a formatter using the given locale.
  38047. @param emulateCsv whether to emulate CSV output.
  38048. </member>
  38049. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormat(NPOI.SS.UserModel.ICell)">
  38050. Return a FormatBase for the given cell if one exists, otherwise try to
  38051. Create one. This method will return <c>null</c> if the any of the
  38052. following is true:
  38053. <ul>
  38054. <li>the cell's style is null</li>
  38055. <li>the style's data FormatBase string is null or empty</li>
  38056. <li>the FormatBase string cannot be recognized as either a number or date</li>
  38057. </ul>
  38058. @param cell The cell to retrieve a FormatBase for
  38059. @return A FormatBase for the FormatBase String
  38060. </member>
  38061. <member name="M:NPOI.SS.UserModel.DataFormatter.CreateFormat(NPOI.SS.UserModel.ICell)">
  38062. Create and return a FormatBase based on the FormatBase string from a cell's
  38063. style. If the pattern cannot be Parsed, return a default pattern.
  38064. @param cell The Excel cell
  38065. @return A FormatBase representing the excel FormatBase. May return null.
  38066. </member>
  38067. <member name="M:NPOI.SS.UserModel.DataFormatter.IsWholeNumber(System.Double)">
  38068. Return true if the double value represents a whole number
  38069. @param d the double value to check
  38070. @return <c>true</c> if d is a whole number
  38071. </member>
  38072. <member name="M:NPOI.SS.UserModel.DataFormatter.GetDefaultFormat(NPOI.SS.UserModel.ICell)">
  38073. Returns a default FormatBase for a cell.
  38074. @param cell The cell
  38075. @return a default FormatBase
  38076. </member>
  38077. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedDateString(NPOI.SS.UserModel.ICell)">
  38078. Returns the Formatted value of an Excel date as a <c>String</c> based
  38079. on the cell's <c>DataFormat</c>. i.e. "Thursday, January 02, 2003"
  38080. , "01/02/2003" , "02-Jan" , etc.
  38081. @param cell The cell
  38082. @return a Formatted date string
  38083. </member>
  38084. <member name="M:NPOI.SS.UserModel.DataFormatter.GetFormattedNumberString(NPOI.SS.UserModel.ICell)">
  38085. Returns the Formatted value of an Excel number as a <c>String</c>
  38086. based on the cell's <c>DataFormat</c>. Supported Formats include
  38087. currency, percents, decimals, phone number, SSN, etc.:
  38088. "61.54%", "$100.00", "(800) 555-1234".
  38089. @param cell The cell
  38090. @return a Formatted number string
  38091. </member>
  38092. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String)">
  38093. Formats the given raw cell value, based on the supplied
  38094. FormatBase index and string, according to excel style rules.
  38095. @see #FormatCellValue(Cell)
  38096. </member>
  38097. <member name="M:NPOI.SS.UserModel.DataFormatter.PerformDateFormatting(System.DateTime,NPOI.SS.Util.FormatBase)">
  38098. Performs Excel-style date formatting, using the
  38099. supplied Date and format
  38100. </member>
  38101. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatRawCellContents(System.Double,System.Int32,System.String,System.Boolean)">
  38102. Formats the given raw cell value, based on the supplied
  38103. format index and string, according to excel style rules.
  38104. @see #formatCellValue(Cell)
  38105. </member>
  38106. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell)">
  38107. Returns the Formatted value of a cell as a <c>String</c> regardless
  38108. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  38109. cell value will be Formatted using a default FormatBase.
  38110. When passed a null or blank cell, this method will return an empty
  38111. String (""). Formulas in formula type cells will not be evaluated.
  38112. @param cell The cell
  38113. @return the Formatted cell value as a String
  38114. </member>
  38115. <member name="M:NPOI.SS.UserModel.DataFormatter.FormatCellValue(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IFormulaEvaluator)">
  38116. Returns the Formatted value of a cell as a <c>String</c> regardless
  38117. of the cell type. If the Excel FormatBase pattern cannot be Parsed then the
  38118. cell value will be Formatted using a default FormatBase.
  38119. When passed a null or blank cell, this method will return an empty
  38120. String (""). Formula cells will be evaluated using the given
  38121. {@link HSSFFormulaEvaluator} if the evaluator is non-null. If the
  38122. evaluator is null, then the formula String will be returned. The caller
  38123. is responsible for setting the currentRow on the evaluator
  38124. @param cell The cell (can be null)
  38125. @param evaluator The HSSFFormulaEvaluator (can be null)
  38126. @return a string value of the cell
  38127. </member>
  38128. <member name="M:NPOI.SS.UserModel.DataFormatter.SetDefaultNumberFormat(NPOI.SS.Util.FormatBase)">
  38129. Sets a default number FormatBase to be used when the Excel FormatBase cannot be
  38130. Parsed successfully. <b>Note:</b> This is a fall back for when an error
  38131. occurs while parsing an Excel number FormatBase pattern. This will not
  38132. affect cells with the <em>General</em> FormatBase.
  38133. The value that will be passed to the FormatBase's FormatBase method (specified
  38134. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  38135. numeric cell. Therefore the code in the FormatBase method should expect a
  38136. <c>Number</c> value.
  38137. @param FormatBase A FormatBase instance to be used as a default
  38138. @see java.text.FormatBase#FormatBase
  38139. </member>
  38140. <member name="M:NPOI.SS.UserModel.DataFormatter.AddFormat(System.String,NPOI.SS.Util.FormatBase)">
  38141. Adds a new FormatBase to the available formats.
  38142. The value that will be passed to the FormatBase's FormatBase method (specified
  38143. by <c>java.text.FormatBase#FormatBase</c>) will be a double value from a
  38144. numeric cell. Therefore the code in the FormatBase method should expect a
  38145. <c>Number</c> value.
  38146. @param excelformatStr The data FormatBase string
  38147. @param FormatBase A FormatBase instance
  38148. </member>
  38149. <member name="T:NPOI.SS.UserModel.ERRORSTYLE">
  38150. Error style constants for error box
  38151. </member>
  38152. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.STOP">
  38153. STOP style
  38154. </member>
  38155. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.WARNING">
  38156. WARNING style
  38157. </member>
  38158. <member name="F:NPOI.SS.UserModel.ERRORSTYLE.INFO">
  38159. INFO style
  38160. </member>
  38161. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorStyle">
  38162. <summary>
  38163. get or set the error style for error box
  38164. </summary>
  38165. </member>
  38166. <member name="P:NPOI.SS.UserModel.IDataValidation.EmptyCellAllowed">
  38167. <summary>
  38168. Setting this allows an empty object as a valid value. Retrieve the settings for empty cells allowed.
  38169. @return True if this object should treats empty as valid value , false otherwise
  38170. </summary>
  38171. <value><c>true</c> if this object should treats empty as valid value, <c>false</c> otherwise</value>
  38172. </member>
  38173. <member name="P:NPOI.SS.UserModel.IDataValidation.SuppressDropDownArrow">
  38174. <summary>
  38175. Useful for list validation objects .
  38176. Useful only list validation objects . This method always returns false if the object isn't a list validation object
  38177. </summary>
  38178. </member>
  38179. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowPromptBox">
  38180. Sets the behaviour when a cell which belongs to this object is selected
  38181. <value><c>true</c> if an prompt box should be displayed , <c>false</c> otherwise</value>
  38182. </member>
  38183. <member name="P:NPOI.SS.UserModel.IDataValidation.ShowErrorBox">
  38184. Sets the behaviour when an invalid value is entered
  38185. <value><c>true</c> if an error box should be displayed , <c>false</c> otherwise</value>
  38186. </member>
  38187. <member name="M:NPOI.SS.UserModel.IDataValidation.CreatePromptBox(System.String,System.String)">
  38188. Sets the title and text for the prompt box . Prompt box is displayed when
  38189. the user selects a cell which belongs to this validation object . In
  38190. order for a prompt box to be displayed you should also use method
  38191. SetShowPromptBox( bool show )
  38192. @param title The prompt box's title
  38193. @param text The prompt box's text
  38194. </member>
  38195. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxTitle">
  38196. @return Prompt box's title or <code>null</code>
  38197. </member>
  38198. <member name="P:NPOI.SS.UserModel.IDataValidation.PromptBoxText">
  38199. @return Prompt box's text or <code>null</code>
  38200. </member>
  38201. <member name="M:NPOI.SS.UserModel.IDataValidation.CreateErrorBox(System.String,System.String)">
  38202. Sets the title and text for the error box . Error box is displayed when
  38203. the user enters an invalid value int o a cell which belongs to this
  38204. validation object . In order for an error box to be displayed you should
  38205. also use method SetShowErrorBox( bool show )
  38206. @param title The error box's title
  38207. @param text The error box's text
  38208. </member>
  38209. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxTitle">
  38210. @return Error box's title or <code>null</code>
  38211. </member>
  38212. <member name="P:NPOI.SS.UserModel.IDataValidation.ErrorBoxText">
  38213. @return Error box's text or <code>null</code>
  38214. </member>
  38215. <member name="M:NPOI.SS.UserModel.IDataValidationConstraint.GetValidationType">
  38216. @return data validation type of this constraint
  38217. @see ValidationType
  38218. </member>
  38219. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Operator">
  38220. @return the operator used for this constraint
  38221. @see OperatorType
  38222. <summary>
  38223. get or set then comparison operator for this constraint
  38224. </summary>
  38225. </member>
  38226. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula1">
  38227. <summary>
  38228. get or set the formula for expression 1. May be <code>null</code>
  38229. </summary>
  38230. </member>
  38231. <member name="P:NPOI.SS.UserModel.IDataValidationConstraint.Formula2">
  38232. <summary>
  38233. get or set the formula for expression 2. May be <code>null</code>
  38234. </summary>
  38235. </member>
  38236. <member name="T:NPOI.SS.UserModel.ValidationType">
  38237. ValidationType enum
  38238. </member>
  38239. <member name="F:NPOI.SS.UserModel.ValidationType.ANY">
  38240. 'Any value' type - value not restricted
  38241. </member>
  38242. <member name="F:NPOI.SS.UserModel.ValidationType.INTEGER">
  38243. int ('Whole number') type
  38244. </member>
  38245. <member name="F:NPOI.SS.UserModel.ValidationType.DECIMAL">
  38246. Decimal type
  38247. </member>
  38248. <member name="F:NPOI.SS.UserModel.ValidationType.LIST">
  38249. List type ( combo box type )
  38250. </member>
  38251. <member name="F:NPOI.SS.UserModel.ValidationType.DATE">
  38252. Date type
  38253. </member>
  38254. <member name="F:NPOI.SS.UserModel.ValidationType.TIME">
  38255. Time type
  38256. </member>
  38257. <member name="F:NPOI.SS.UserModel.ValidationType.TEXT_LENGTH">
  38258. String length type
  38259. </member>
  38260. <member name="F:NPOI.SS.UserModel.ValidationType.FORMULA">
  38261. Formula ( 'Custom' ) type
  38262. </member>
  38263. <member name="T:NPOI.SS.UserModel.OperatorType">
  38264. Condition operator enum
  38265. </member>
  38266. <member name="F:NPOI.SS.UserModel.OperatorType.IGNORED">
  38267. default value to supply when the operator type is not used
  38268. </member>
  38269. <member name="T:NPOI.SS.UserModel.IDataValidationHelper">
  38270. @author <a href="rjankiraman@emptoris.com">Radhakrishnan J</a>
  38271. </member>
  38272. <member name="T:NPOI.SS.UserModel.DateUtil">
  38273. <summary>
  38274. Contains methods for dealing with Excel dates.
  38275. @author Michael Harhen
  38276. @author Glen Stampoultzis (glens at apache.org)
  38277. @author Dan Sherman (dsherman at Isisph.com)
  38278. @author Hack Kampbjorn (hak at 2mba.dk)
  38279. @author Alex Jacoby (ajacoby at gmail.com)
  38280. @author Pavel Krupets (pkrupets at palmtreebusiness dot com)
  38281. @author Thies Wellpott
  38282. </summary>
  38283. </member>
  38284. <member name="F:NPOI.SS.UserModel.DateUtil.date_ptrn1">
  38285. The following patterns are used in {@link #isADateFormat(int, String)}
  38286. </member>
  38287. <member name="M:NPOI.SS.UserModel.DateUtil.AbsoluteDay(System.DateTime,System.Boolean)">
  38288. <summary>
  38289. Given a Calendar, return the number of days since 1899/12/31.
  38290. </summary>
  38291. <param name="cal">the date</param>
  38292. <param name="use1904windowing">if set to <c>true</c> [use1904windowing].</param>
  38293. <returns>number of days since 1899/12/31</returns>
  38294. </member>
  38295. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime)">
  38296. <summary>
  38297. Given a Date, Converts it into a double representing its internal Excel representation,
  38298. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  38299. </summary>
  38300. <param name="date">Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</param>
  38301. <returns>the Date</returns>
  38302. </member>
  38303. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)">
  38304. <summary>
  38305. Gets the excel date.
  38306. </summary>
  38307. <param name="year">The year.</param>
  38308. <param name="month">The month.</param>
  38309. <param name="day">The day.</param>
  38310. <param name="hour">The hour.</param>
  38311. <param name="minute">The minute.</param>
  38312. <param name="second">The second.</param>
  38313. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  38314. <returns></returns>
  38315. </member>
  38316. <member name="M:NPOI.SS.UserModel.DateUtil.GetExcelDate(System.DateTime,System.Boolean)">
  38317. <summary>
  38318. Given a Date, Converts it into a double representing its internal Excel representation,
  38319. which Is the number of days since 1/1/1900. Fractional days represent hours, minutes, and seconds.
  38320. </summary>
  38321. <param name="date">The date.</param>
  38322. <param name="use1904windowing">Should 1900 or 1904 date windowing be used?</param>
  38323. <returns>Excel representation of Date (-1 if error - test for error by Checking for less than 0.1)</returns>
  38324. </member>
  38325. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double)">
  38326. <summary>
  38327. Given an Excel date with using 1900 date windowing, and converts it to a java.util.Date.
  38328. Excel Dates and Times are stored without any timezone
  38329. information. If you know (through other means) that your file
  38330. uses a different TimeZone to the system default, you can use
  38331. this version of the getJavaDate() method to handle it.
  38332. </summary>
  38333. <param name="date">The Excel date.</param>
  38334. <returns>null if date is not a valid Excel date</returns>
  38335. </member>
  38336. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean)">
  38337. Given an Excel date with either 1900 or 1904 date windowing,
  38338. Converts it to a Date.
  38339. NOTE: If the default <c>TimeZone</c> in Java uses Daylight
  38340. Saving Time then the conversion back to an Excel date may not give
  38341. the same value, that Is the comparison
  38342. <CODE>excelDate == GetExcelDate(GetJavaDate(excelDate,false))</CODE>
  38343. Is not always true. For example if default timezone Is
  38344. <c>Europe/Copenhagen</c>, on 2004-03-28 the minute after
  38345. 01:59 CET Is 03:00 CEST, if the excel date represents a time between
  38346. 02:00 and 03:00 then it Is Converted to past 03:00 summer time
  38347. @param date The Excel date.
  38348. @param use1904windowing true if date uses 1904 windowing,
  38349. or false if using 1900 date windowing.
  38350. @return Java representation of the date, or null if date Is not a valid Excel date
  38351. @see TimeZone
  38352. </member>
  38353. <member name="M:NPOI.SS.UserModel.DateUtil.getJavaDate(System.Double,System.Boolean,System.TimeZone)">
  38354. Given an Excel date with either 1900 or 1904 date windowing,
  38355. converts it to a java.util.Date.
  38356. Excel Dates and Times are stored without any timezone
  38357. information. If you know (through other means) that your file
  38358. uses a different TimeZone to the system default, you can use
  38359. this version of the getJavaDate() method to handle it.
  38360. @param date The Excel date.
  38361. @param tz The TimeZone to evaluate the date in
  38362. @param use1904windowing true if date uses 1904 windowing,
  38363. or false if using 1900 date windowing.
  38364. @return Java representation of the date, or null if date is not a valid Excel date
  38365. </member>
  38366. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaDate(System.Double,System.Boolean,System.TimeZone,System.Boolean)">
  38367. Given an Excel date with either 1900 or 1904 date windowing,
  38368. converts it to a java.util.Date.
  38369. Excel Dates and Times are stored without any timezone
  38370. information. If you know (through other means) that your file
  38371. uses a different TimeZone to the system default, you can use
  38372. this version of the getJavaDate() method to handle it.
  38373. @param date The Excel date.
  38374. @param tz The TimeZone to evaluate the date in
  38375. @param use1904windowing true if date uses 1904 windowing,
  38376. or false if using 1900 date windowing.
  38377. @param roundSeconds round to closest second
  38378. @return Java representation of the date, or null if date is not a valid Excel date
  38379. </member>
  38380. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean)">
  38381. Get EXCEL date as Java Calendar with given time zone.
  38382. @param date The Excel date.
  38383. @param use1904windowing true if date uses 1904 windowing,
  38384. or false if using 1900 date windowing.
  38385. @param timeZone The TimeZone to evaluate the date in
  38386. @return Java representation of the date, or null if date is not a valid Excel date
  38387. </member>
  38388. <member name="M:NPOI.SS.UserModel.DateUtil.GetJavaCalendar(System.Double,System.Boolean,System.Boolean)">
  38389. <summary>
  38390. Get EXCEL date as Java Calendar (with default time zone). This is like GetJavaDate(double, boolean) but returns a Calendar object.
  38391. </summary>
  38392. <param name="date">The Excel date.</param>
  38393. <param name="use1904windowing">true if date uses 1904 windowing, or false if using 1900 date windowing.</param>
  38394. <param name="roundSeconds"></param>
  38395. <returns>null if date is not a valid Excel date</returns>
  38396. </member>
  38397. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTime(System.String)">
  38398. <summary>
  38399. Converts a string of format "HH:MM" or "HH:MM:SS" to its (Excel) numeric equivalent
  38400. </summary>
  38401. <param name="timeStr">The time STR.</param>
  38402. <returns> a double between 0 and 1 representing the fraction of the day</returns>
  38403. </member>
  38404. <member name="M:NPOI.SS.UserModel.DateUtil.ConvertTimeInternal(System.String)">
  38405. <summary>
  38406. Converts the time internal.
  38407. </summary>
  38408. <param name="timeStr">The time STR.</param>
  38409. <returns></returns>
  38410. </member>
  38411. <member name="M:NPOI.SS.UserModel.DateUtil.IsADateFormat(System.Int32,System.String)">
  38412. <summary>
  38413. Given a format ID and its format String, will Check to see if the
  38414. format represents a date format or not.
  38415. Firstly, it will Check to see if the format ID corresponds to an
  38416. internal excel date format (eg most US date formats)
  38417. If not, it will Check to see if the format string only Contains
  38418. date formatting Chars (ymd-/), which covers most
  38419. non US date formats.
  38420. </summary>
  38421. <param name="formatIndex">The index of the format, eg from ExtendedFormatRecord.GetFormatIndex</param>
  38422. <param name="formatString">The format string, eg from FormatRecord.GetFormatString</param>
  38423. <returns>
  38424. <c>true</c> if [is A date format] [the specified format index]; otherwise, <c>false</c>.
  38425. </returns>
  38426. </member>
  38427. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDate(System.String)">
  38428. <summary>
  38429. Converts a string of format "YYYY/MM/DD" to its (Excel) numeric equivalent
  38430. </summary>
  38431. <param name="dateStr">The date STR.</param>
  38432. <returns>a double representing the (integer) number of days since the start of the Excel epoch</returns>
  38433. </member>
  38434. <member name="M:NPOI.SS.UserModel.DateUtil.ParseYYYYMMDDDateInternal(System.String)">
  38435. <summary>
  38436. Parses the YYYYMMDD date internal.
  38437. </summary>
  38438. <param name="timeStr">The time string.</param>
  38439. <returns></returns>
  38440. </member>
  38441. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32)">
  38442. <summary>
  38443. Parses the int.
  38444. </summary>
  38445. <param name="strVal">The string value.</param>
  38446. <param name="fieldName">Name of the field.</param>
  38447. <param name="rangeMax">The range max.</param>
  38448. <returns></returns>
  38449. </member>
  38450. <member name="M:NPOI.SS.UserModel.DateUtil.ParseInt(System.String,System.String,System.Int32,System.Int32)">
  38451. <summary>
  38452. Parses the int.
  38453. </summary>
  38454. <param name="strVal">The STR val.</param>
  38455. <param name="fieldName">Name of the field.</param>
  38456. <param name="lowerLimit">The lower limit.</param>
  38457. <param name="upperLimit">The upper limit.</param>
  38458. <returns></returns>
  38459. </member>
  38460. <member name="M:NPOI.SS.UserModel.DateUtil.IsInternalDateFormat(System.Int32)">
  38461. <summary>
  38462. Given a format ID this will Check whether the format represents an internal excel date format or not.
  38463. </summary>
  38464. <param name="format">The format.</param>
  38465. </member>
  38466. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellDateFormatted(NPOI.SS.UserModel.ICell)">
  38467. <summary>
  38468. Check if a cell Contains a date
  38469. Since dates are stored internally in Excel as double values
  38470. we infer it Is a date if it Is formatted as such.
  38471. </summary>
  38472. <param name="cell">The cell.</param>
  38473. </member>
  38474. <member name="M:NPOI.SS.UserModel.DateUtil.IsCellInternalDateFormatted(NPOI.SS.UserModel.ICell)">
  38475. <summary>
  38476. Check if a cell contains a date, Checking only for internal excel date formats.
  38477. As Excel stores a great many of its dates in "non-internal" date formats, you will not normally want to use this method.
  38478. </summary>
  38479. <param name="cell">The cell.</param>
  38480. </member>
  38481. <member name="M:NPOI.SS.UserModel.DateUtil.IsValidExcelDate(System.Double)">
  38482. <summary>
  38483. Given a double, Checks if it Is a valid Excel date.
  38484. </summary>
  38485. <param name="value">the double value.</param>
  38486. <returns>
  38487. <c>true</c> if [is valid excel date] [the specified value]; otherwise, <c>false</c>.
  38488. </returns>
  38489. </member>
  38490. <member name="T:NPOI.SS.UserModel.IDrawing">
  38491. @author Yegor Kozlov
  38492. </member>
  38493. <member name="M:NPOI.SS.UserModel.IDrawing.CreatePicture(NPOI.SS.UserModel.IClientAnchor,System.Int32)">
  38494. Creates a picture.
  38495. @param anchor the client anchor describes how this picture is
  38496. attached to the sheet.
  38497. @param pictureIndex the index of the picture in the workbook collection
  38498. of pictures.
  38499. @return the newly created picture.
  38500. </member>
  38501. <member name="M:NPOI.SS.UserModel.IDrawing.CreateCellComment(NPOI.SS.UserModel.IClientAnchor)">
  38502. Creates a comment.
  38503. @param anchor the client anchor describes how this comment is attached
  38504. to the sheet.
  38505. @return the newly created comment.
  38506. </member>
  38507. <member name="M:NPOI.SS.UserModel.IDrawing.CreateChart(NPOI.SS.UserModel.IClientAnchor)">
  38508. Creates a chart.
  38509. @param anchor the client anchor describes how this chart is attached to
  38510. the sheet.
  38511. @return the newly created chart
  38512. </member>
  38513. <member name="M:NPOI.SS.UserModel.IDrawing.CreateAnchor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  38514. Creates a new client anchor and sets the top-left and bottom-right
  38515. coordinates of the anchor.
  38516. @param dx1 the x coordinate in EMU within the first cell.
  38517. @param dy1 the y coordinate in EMU within the first cell.
  38518. @param dx2 the x coordinate in EMU within the second cell.
  38519. @param dy2 the y coordinate in EMU within the second cell.
  38520. @param col1 the column (0 based) of the first cell.
  38521. @param row1 the row (0 based) of the first cell.
  38522. @param col2 the column (0 based) of the second cell.
  38523. @param row2 the row (0 based) of the second cell.
  38524. @return the newly created client anchor
  38525. </member>
  38526. <member name="T:NPOI.SS.UserModel.Drawing.MSOFillType">
  38527. <summary>
  38528. the type of fill to display with the shape or the background of the slide.
  38529. </summary>
  38530. </member>
  38531. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Solid">
  38532. <summary>
  38533. A solid fill
  38534. </summary>
  38535. </member>
  38536. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Pattern">
  38537. <summary>
  38538. A patterned fill
  38539. </summary>
  38540. </member>
  38541. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Texture">
  38542. <summary>
  38543. A textured fill
  38544. </summary>
  38545. </member>
  38546. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Picture">
  38547. <summary>
  38548. A picture fill
  38549. </summary>
  38550. </member>
  38551. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Shade">
  38552. <summary>
  38553. A gradient fill that starts and ends with defined endpoints
  38554. </summary>
  38555. </member>
  38556. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeCenter">
  38557. <summary>
  38558. A gradient fill that starts and ends based on the bounds of the shape
  38559. </summary>
  38560. </member>
  38561. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeShape">
  38562. <summary>
  38563. A gradient fill that starts on the outline of the shape and ends at a point defined within the shape
  38564. </summary>
  38565. </member>
  38566. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeScale">
  38567. <summary>
  38568. A gradient fill that starts on the outline of the shape and ends at a point defined within the shape.
  38569. The fill angle is scaled by the aspect ratio of the shape
  38570. </summary>
  38571. </member>
  38572. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.ShadeTitle">
  38573. <summary>
  38574. A gradient fill interpreted by the host application
  38575. </summary>
  38576. </member>
  38577. <member name="F:NPOI.SS.UserModel.Drawing.MSOFillType.Background">
  38578. <summary>
  38579. A fill that matches the background fill
  38580. </summary>
  38581. </member>
  38582. <member name="T:NPOI.SS.UserModel.ErrorConstants">
  38583. Contains raw Excel error codes (as defined in OOO's excelfileformat.pdf (2.5.6)
  38584. @author Michael Harhen
  38585. </member>
  38586. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NULL">
  38587. <b>#NULL!</b> - Intersection of two cell ranges is empty
  38588. </member>
  38589. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_DIV_0">
  38590. <b>#DIV/0!</b> - Division by zero
  38591. </member>
  38592. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_VALUE">
  38593. <b>#VALUE!</b> - Wrong type of operand
  38594. </member>
  38595. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_REF">
  38596. <b>#REF!</b> - Illegal or deleted cell reference
  38597. </member>
  38598. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NAME">
  38599. <b>#NAME?</b> - Wrong function or range name
  38600. </member>
  38601. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NUM">
  38602. <b>#NUM!</b> - Value range overflow
  38603. </member>
  38604. <member name="F:NPOI.SS.UserModel.ErrorConstants.ERROR_NA">
  38605. <b>#N/A</b> - Argument or function not available
  38606. </member>
  38607. <member name="M:NPOI.SS.UserModel.ErrorConstants.GetText(System.Int32)">
  38608. @return Standard Excel error literal for the specified error code.
  38609. @throws ArgumentException if the specified error code is not one of the 7
  38610. standard error codes
  38611. </member>
  38612. <member name="M:NPOI.SS.UserModel.ErrorConstants.IsValidCode(System.Int32)">
  38613. @return <c>true</c> if the specified error code is a standard Excel error code.
  38614. </member>
  38615. <member name="T:NPOI.SS.UserModel.ExcelStyleDateFormatter">
  38616. A wrapper around a {@link SimpleDateFormat} instance,
  38617. which handles a few Excel-style extensions that
  38618. are not supported by {@link SimpleDateFormat}.
  38619. Currently, the extensions are around the handling
  38620. of elapsed time, eg rendering 1 day 2 hours
  38621. as 26 hours.
  38622. </member>
  38623. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.ProcessFormatPattern(System.String)">
  38624. Takes a format String, and Replaces Excel specific bits
  38625. with our detection sequences
  38626. </member>
  38627. <member name="M:NPOI.SS.UserModel.ExcelStyleDateFormatter.SetDateToBeFormatted(System.Double)">
  38628. Used to let us know what the date being
  38629. formatted is, in Excel terms, which we
  38630. may wish to use when handling elapsed
  38631. times.
  38632. </member>
  38633. <member name="T:NPOI.SS.UserModel.FillPattern">
  38634. The enumeration value indicating the style of fill pattern being used for a cell format.
  38635. </member>
  38636. <member name="F:NPOI.SS.UserModel.FillPattern.NoFill">
  38637. No background
  38638. </member>
  38639. <member name="F:NPOI.SS.UserModel.FillPattern.SolidForeground">
  38640. Solidly Filled
  38641. </member>
  38642. <member name="F:NPOI.SS.UserModel.FillPattern.FineDots">
  38643. Small fine dots
  38644. </member>
  38645. <member name="F:NPOI.SS.UserModel.FillPattern.AltBars">
  38646. Wide dots
  38647. </member>
  38648. <member name="F:NPOI.SS.UserModel.FillPattern.SparseDots">
  38649. Sparse dots
  38650. </member>
  38651. <member name="F:NPOI.SS.UserModel.FillPattern.ThickHorizontalBands">
  38652. Thick horizontal bands
  38653. </member>
  38654. <member name="F:NPOI.SS.UserModel.FillPattern.ThickVerticalBands">
  38655. Thick vertical bands
  38656. </member>
  38657. <member name="F:NPOI.SS.UserModel.FillPattern.ThickBackwardDiagonals">
  38658. Thick backward facing diagonals
  38659. </member>
  38660. <member name="F:NPOI.SS.UserModel.FillPattern.ThickForwardDiagonals">
  38661. Thick forward facing diagonals
  38662. </member>
  38663. <member name="F:NPOI.SS.UserModel.FillPattern.BigSpots">
  38664. Large spots
  38665. </member>
  38666. <member name="F:NPOI.SS.UserModel.FillPattern.Bricks">
  38667. Brick-like layout
  38668. </member>
  38669. <member name="F:NPOI.SS.UserModel.FillPattern.ThinHorizontalBands">
  38670. Thin horizontal bands
  38671. </member>
  38672. <member name="F:NPOI.SS.UserModel.FillPattern.ThinVerticalBands">
  38673. Thin vertical bands
  38674. </member>
  38675. <member name="F:NPOI.SS.UserModel.FillPattern.ThinBackwardDiagonals">
  38676. Thin backward diagonal
  38677. </member>
  38678. <member name="F:NPOI.SS.UserModel.FillPattern.ThinForwardDiagonals">
  38679. Thin forward diagonal
  38680. </member>
  38681. <member name="F:NPOI.SS.UserModel.FillPattern.Squares">
  38682. Squares
  38683. </member>
  38684. <member name="F:NPOI.SS.UserModel.FillPattern.Diamonds">
  38685. Diamonds
  38686. </member>
  38687. <member name="F:NPOI.SS.UserModel.FillPattern.LessDots">
  38688. Less Dots
  38689. </member>
  38690. <member name="F:NPOI.SS.UserModel.FillPattern.LeastDots">
  38691. Least Dots
  38692. </member>
  38693. <member name="F:NPOI.SS.UserModel.FontUnderlineType.None">
  38694. not underlined
  38695. </member>
  38696. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Single">
  38697. single (normal) underline
  38698. </member>
  38699. <member name="F:NPOI.SS.UserModel.FontUnderlineType.Double">
  38700. double underlined
  38701. </member>
  38702. <member name="F:NPOI.SS.UserModel.FontUnderlineType.SingleAccounting">
  38703. accounting style single underline
  38704. </member>
  38705. <member name="F:NPOI.SS.UserModel.FontUnderlineType.DoubleAccounting">
  38706. accounting style double underline
  38707. </member>
  38708. <member name="F:NPOI.SS.UserModel.FontSuperScript.None">
  38709. no type Offsetting (not super or subscript)
  38710. </member>
  38711. <member name="F:NPOI.SS.UserModel.FontSuperScript.Super">
  38712. superscript
  38713. </member>
  38714. <member name="F:NPOI.SS.UserModel.FontSuperScript.Sub">
  38715. subscript
  38716. </member>
  38717. <member name="F:NPOI.SS.UserModel.FontColor.None">
  38718. <summary>
  38719. Allow accessing the Initial value.
  38720. </summary>
  38721. </member>
  38722. <member name="F:NPOI.SS.UserModel.FontColor.Normal">
  38723. normal type of black color.
  38724. </member>
  38725. <member name="F:NPOI.SS.UserModel.FontColor.Red">
  38726. Dark Red color
  38727. </member>
  38728. <member name="F:NPOI.SS.UserModel.FontBoldWeight.None">
  38729. <summary>
  38730. Allow accessing the Initial value.
  38731. </summary>
  38732. </member>
  38733. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Normal">
  38734. Normal boldness (not bold)
  38735. </member>
  38736. <member name="F:NPOI.SS.UserModel.FontBoldWeight.Bold">
  38737. Bold boldness (bold)
  38738. </member>
  38739. <member name="P:NPOI.SS.UserModel.IFont.FontName">
  38740. <summary>
  38741. get the name for the font (i.e. Arial)
  38742. </summary>
  38743. </member>
  38744. <member name="P:NPOI.SS.UserModel.IFont.FontHeight">
  38745. <summary>
  38746. Get the font height in unit's of 1/20th of a point.
  38747. </summary>
  38748. <remarks>
  38749. Maybe you might want to use the GetFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
  38750. </remarks>
  38751. <see cref="P:NPOI.SS.UserModel.IFont.FontHeightInPoints"/>
  38752. </member>
  38753. <member name="P:NPOI.SS.UserModel.IFont.FontHeightInPoints">
  38754. <summary>
  38755. Get the font height in points.
  38756. </summary>
  38757. <remarks>
  38758. This will return the same font height that is shown in Excel, such as 10 or 14 or 28.
  38759. </remarks>
  38760. <see cref="P:NPOI.SS.UserModel.IFont.FontHeight"/>
  38761. </member>
  38762. <member name="P:NPOI.SS.UserModel.IFont.IsItalic">
  38763. <summary>
  38764. get whether to use italics or not
  38765. </summary>
  38766. </member>
  38767. <member name="P:NPOI.SS.UserModel.IFont.IsStrikeout">
  38768. <summary>
  38769. get whether to use a strikeout horizontal line through the text or not
  38770. </summary>
  38771. </member>
  38772. <member name="P:NPOI.SS.UserModel.IFont.Color">
  38773. get the color for the font
  38774. @return color to use
  38775. @see #COLOR_NORMAL
  38776. @see #COLOR_RED
  38777. @see NPOI.HSSF.usermodel.HSSFPalette#GetColor(short)
  38778. </member>
  38779. <member name="P:NPOI.SS.UserModel.IFont.TypeOffset">
  38780. <summary>
  38781. get type of text underlining to use
  38782. </summary>
  38783. </member>
  38784. <member name="P:NPOI.SS.UserModel.IFont.Underline">
  38785. <summary>
  38786. get type of text underlining to use
  38787. </summary>
  38788. </member>
  38789. <member name="P:NPOI.SS.UserModel.IFont.Charset">
  38790. get character-set to use.
  38791. @return character-set
  38792. @see #ANSI_CHARSET
  38793. @see #DEFAULT_CHARSET
  38794. @see #SYMBOL_CHARSET
  38795. </member>
  38796. <member name="P:NPOI.SS.UserModel.IFont.Index">
  38797. get the index within the XSSFWorkbook (sequence within the collection of Font objects)
  38798. @return unique index number of the underlying record this Font represents (probably you don't care
  38799. unless you're comparing which one is which)
  38800. </member>
  38801. <member name="M:NPOI.SS.UserModel.IFont.CloneStyleFrom(NPOI.SS.UserModel.IFont)">
  38802. <summary>
  38803. Copies the style from another font into this one
  38804. </summary>
  38805. </member>
  38806. <member name="T:NPOI.SS.UserModel.FontCharset">
  38807. Charset represents the basic set of characters associated with a font (that it can display), and
  38808. corresponds to the ANSI codepage (8-bit or DBCS) of that character set used by a given language.
  38809. @author Gisella Bronzetti
  38810. </member>
  38811. <member name="P:NPOI.SS.UserModel.FontCharset.Value">
  38812. Returns value of this charset
  38813. @return value of this charset
  38814. </member>
  38815. <member name="T:NPOI.SS.UserModel.FontFamily">
  38816. The font family this font belongs to. A font family is a set of fonts having common stroke width and serif
  38817. characteristics. The font name overrides when there are conflicting values.
  38818. @author Gisella Bronzetti
  38819. </member>
  38820. <member name="P:NPOI.SS.UserModel.FontFamily.Value">
  38821. Returns index of this font family
  38822. @return index of this font family
  38823. </member>
  38824. <member name="T:NPOI.SS.UserModel.IFontFormatting">
  38825. High level representation for Font Formatting component
  38826. of Conditional Formatting Settings
  38827. @author Dmitriy Kumshayev
  38828. @author Yegor Kozlov
  38829. </member>
  38830. <member name="P:NPOI.SS.UserModel.IFontFormatting.EscapementType">
  38831. <summary>
  38832. get or set the type of super or subscript for the font
  38833. </summary>
  38834. </member>
  38835. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontColorIndex">
  38836. <summary>
  38837. get or set font color index
  38838. </summary>
  38839. </member>
  38840. <member name="P:NPOI.SS.UserModel.IFontFormatting.FontHeight">
  38841. <summary>
  38842. get or set the height of the font in 1/20th point units
  38843. </summary>
  38844. </member>
  38845. <member name="P:NPOI.SS.UserModel.IFontFormatting.UnderlineType">
  38846. <summary>
  38847. get or set the type of underlining for the font
  38848. </summary>
  38849. </member>
  38850. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsBold">
  38851. Get whether the font weight is Set to bold or not
  38852. @return bold - whether the font is bold or not
  38853. </member>
  38854. <member name="P:NPOI.SS.UserModel.IFontFormatting.IsItalic">
  38855. @return true if font style was Set to <i>italic</i>
  38856. </member>
  38857. <member name="M:NPOI.SS.UserModel.IFontFormatting.SetFontStyle(System.Boolean,System.Boolean)">
  38858. Set font style options.
  38859. @param italic - if true, Set posture style to italic, otherwise to normal
  38860. @param bold if true, Set font weight to bold, otherwise to normal
  38861. </member>
  38862. <member name="M:NPOI.SS.UserModel.IFontFormatting.ResetFontStyle">
  38863. Set font style options to default values (non-italic, non-bold)
  38864. </member>
  38865. <member name="T:NPOI.SS.UserModel.FontScheme">
  38866. Defines the font scheme to which this font belongs.
  38867. When a font defInition is part of a theme defInition, then the font is categorized as either a major or minor font scheme component.
  38868. 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
  38869. theme.
  38870. Usually major fonts are used for styles like headings, and minor fonts are used for body and paragraph text.
  38871. @author Gisella Bronzetti
  38872. </member>
  38873. <member name="T:NPOI.SS.UserModel.FontUnderline">
  38874. the different types of possible underline formatting
  38875. @author Gisella Bronzetti
  38876. </member>
  38877. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE">
  38878. Single-line underlining under each character in the cell.
  38879. The underline is drawn through the descenders of
  38880. characters such as g and p..
  38881. </member>
  38882. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE">
  38883. Double-line underlining under each character in the
  38884. cell. underlines are drawn through the descenders of
  38885. characters such as g and p.
  38886. </member>
  38887. <member name="F:NPOI.SS.UserModel.FontUnderline.SINGLE_ACCOUNTING">
  38888. Single-line accounting underlining under each
  38889. character in the cell. The underline is drawn under the
  38890. descenders of characters such as g and p.
  38891. </member>
  38892. <member name="F:NPOI.SS.UserModel.FontUnderline.DOUBLE_ACCOUNTING">
  38893. Double-line accounting underlining under each
  38894. character in the cell. The underlines are drawn under
  38895. the descenders of characters such as g and p.
  38896. </member>
  38897. <member name="F:NPOI.SS.UserModel.FontUnderline.NONE">
  38898. No underline.
  38899. </member>
  38900. <member name="T:NPOI.SS.UserModel.IFooter">
  38901. <summary>
  38902. Common defInition of a HSSF or XSSF page footer.
  38903. For a list of all the different fields that can be
  38904. placed into a footer, such as page number,
  38905. bold, underline etc, see
  38906. </summary>
  38907. </member>
  38908. <member name="T:NPOI.SS.UserModel.FormulaError">
  38909. Enumerates error values in SpreadsheetML formula calculations.
  38910. See also OOO's excelfileformat.pdf (2.5.6)
  38911. </member>
  38912. <member name="F:NPOI.SS.UserModel.FormulaError.NULL">
  38913. Intended to indicate when two areas are required to intersect, but do not.
  38914. <p>Example:
  38915. In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary
  38916. intersection operator, when a comma was intended. end example]
  38917. </p>
  38918. </member>
  38919. <member name="F:NPOI.SS.UserModel.FormulaError.DIV0">
  38920. Intended to indicate when any number, including zero, is divided by zero.
  38921. Note: However, any error code divided by zero results in that error code.
  38922. </member>
  38923. <member name="F:NPOI.SS.UserModel.FormulaError.VALUE">
  38924. Intended to indicate when an incompatible type argument is passed to a function, or
  38925. an incompatible type operand is used with an operator.
  38926. <p>Example:
  38927. In the case of a function argument, text was expected, but a number was provided
  38928. </p>
  38929. </member>
  38930. <member name="F:NPOI.SS.UserModel.FormulaError.REF">
  38931. Intended to indicate when a cell reference is invalid.
  38932. <p>Example:
  38933. If a formula Contains a reference to a cell, and then the row or column Containing that cell is deleted,
  38934. a #REF! error results. If a worksheet does not support 20,001 columns,
  38935. OFFSET(A1,0,20000) will result in a #REF! error.
  38936. </p>
  38937. </member>
  38938. <member name="F:NPOI.SS.UserModel.FormulaError.NUM">
  38939. Intended to indicate when an argument to a function has a compatible type, but has a
  38940. value that is outside the domain over which that function is defined. (This is known as
  38941. a domain error.)
  38942. <p>Example:
  38943. Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
  38944. </p>
  38945. Intended to indicate that the result of a function cannot be represented in a value of
  38946. the specified type, typically due to extreme magnitude. (This is known as a range
  38947. error.)
  38948. <p>Example: FACT(1000) might result in a range error. </p>
  38949. </member>
  38950. <member name="F:NPOI.SS.UserModel.FormulaError.NA">
  38951. Intended to indicate when a designated value is not available.
  38952. <p>Example:
  38953. Some functions, such as SUMX2MY2, perform a series of operations on corresponding
  38954. elements in two arrays. If those arrays do not have the same number of elements, then
  38955. for some elements in the longer array, there are no corresponding elements in the
  38956. shorter one; that is, one or more values in the shorter array are not available.
  38957. </p>
  38958. This error value can be produced by calling the function NA
  38959. </member>
  38960. <member name="F:NPOI.SS.UserModel.FormulaError.CIRCULAR_REF">
  38961. POI specific code to indicate that there is a circular reference
  38962. in the formula
  38963. </member>
  38964. <member name="F:NPOI.SS.UserModel.FormulaError.FUNCTION_NOT_IMPLEMENTED">
  38965. POI specific code to indicate that the funcition required is
  38966. not implemented in POI
  38967. </member>
  38968. <member name="P:NPOI.SS.UserModel.FormulaError.Code">
  38969. @return numeric code of the error
  38970. </member>
  38971. <member name="P:NPOI.SS.UserModel.FormulaError.LongCode">
  38972. @return long (internal) numeric code of the error
  38973. </member>
  38974. <member name="P:NPOI.SS.UserModel.FormulaError.String">
  38975. @return string representation of the error
  38976. </member>
  38977. <member name="T:NPOI.SS.UserModel.IFormulaEvaluator">
  38978. Evaluates formula cells.<p/>
  38979. For performance reasons, this class keeps a cache of all previously calculated intermediate
  38980. cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between
  38981. calls to Evaluate~ methods on this class.
  38982. @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
  38983. @author Josh Micich
  38984. </member>
  38985. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.ClearAllCachedResultValues">
  38986. Should be called whenever there are Changes to input cells in the Evaluated workbook.
  38987. Failure to call this method after changing cell values will cause incorrect behaviour
  38988. of the Evaluate~ methods of this class
  38989. </member>
  38990. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifySetFormula(NPOI.SS.UserModel.ICell)">
  38991. Should be called to tell the cell value cache that the specified (value or formula) cell
  38992. has Changed.
  38993. Failure to call this method after changing cell values will cause incorrect behaviour
  38994. of the Evaluate~ methods of this class
  38995. </member>
  38996. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyDeleteCell(NPOI.SS.UserModel.ICell)">
  38997. Should be called to tell the cell value cache that the specified cell has just become a
  38998. formula cell, or the formula text has Changed
  38999. </member>
  39000. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.NotifyUpdateCell(NPOI.SS.UserModel.ICell)">
  39001. Should be called to tell the cell value cache that the specified (value or formula) cell
  39002. has changed.
  39003. Failure to call this method after changing cell values will cause incorrect behaviour
  39004. of the evaluate~ methods of this class
  39005. </member>
  39006. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.Evaluate(NPOI.SS.UserModel.ICell)">
  39007. If cell Contains a formula, the formula is Evaluated and returned,
  39008. else the CellValue simply copies the appropriate cell value from
  39009. the cell and also its cell type. This method should be preferred over
  39010. EvaluateInCell() when the call should not modify the contents of the
  39011. original cell.
  39012. @param cell
  39013. </member>
  39014. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateAll">
  39015. Loops over all cells in all sheets of the associated workbook.
  39016. For cells that contain formulas, their formulas are evaluated,
  39017. and the results are saved. These cells remain as formula cells.
  39018. For cells that do not contain formulas, no changes are made.
  39019. This is a helpful wrapper around looping over all cells, and
  39020. calling evaluateFormulaCell on each one.
  39021. </member>
  39022. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateFormulaCell(NPOI.SS.UserModel.ICell)">
  39023. If cell Contains formula, it Evaluates the formula,
  39024. and saves the result of the formula. The cell
  39025. remains as a formula cell.
  39026. Else if cell does not contain formula, this method leaves
  39027. the cell unChanged.
  39028. Note that the type of the formula result is returned,
  39029. so you know what kind of value is also stored with
  39030. the formula.
  39031. <pre>
  39032. int EvaluatedCellType = Evaluator.evaluateFormulaCell(cell);
  39033. </pre>
  39034. Be aware that your cell will hold both the formula,
  39035. and the result. If you want the cell Replaced with
  39036. the result of the formula, use {@link #EvaluateInCell(Cell)}
  39037. @param cell The cell to Evaluate
  39038. @return The type of the formula result, i.e. -1 if the cell is not a formula,
  39039. or one of Cell.CELL_TYPE_NUMERIC, Cell.CELL_TYPE_STRING, Cell.CELL_TYPE_BOOLEAN, Cell.CELL_TYPE_ERROR
  39040. Note: the cell's type remains as Cell.CELL_TYPE_FORMULA however.
  39041. </member>
  39042. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.EvaluateInCell(NPOI.SS.UserModel.ICell)">
  39043. If cell Contains formula, it Evaluates the formula, and
  39044. Puts the formula result back into the cell, in place
  39045. of the old formula.
  39046. Else if cell does not contain formula, this method leaves
  39047. the cell unChanged.
  39048. Note that the same instance of Cell is returned to
  39049. allow chained calls like:
  39050. <pre>
  39051. int EvaluatedCellType = Evaluator.evaluateInCell(cell).getCellType();
  39052. </pre>
  39053. Be aware that your cell value will be Changed to hold the
  39054. result of the formula. If you simply want the formula
  39055. value comPuted for you, use {@link #EvaluateFormulaCell(Cell)}
  39056. @param cell
  39057. </member>
  39058. <member name="M:NPOI.SS.UserModel.IFormulaEvaluator.SetupReferencedWorkbooks(System.Collections.Generic.Dictionary{System.String,NPOI.SS.UserModel.IFormulaEvaluator})">
  39059. Sets up the Formula Evaluator to be able to reference and resolve
  39060. links to other workbooks, eg [Test.xls]Sheet1!A1.
  39061. For a workbook referenced as [Test.xls]Sheet1!A1, you should
  39062. supply a map containing the key Test.xls (no square brackets),
  39063. and an open FormulaEvaluator onto that Workbook.
  39064. @param otherWorkbooks Map of workbook names (no square brackets) to an evaluator on that workbook
  39065. </member>
  39066. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.IgnoreMissingWorkbooks">
  39067. Whether to ignore missing references to external workbooks and
  39068. use cached formula results in the main workbook instead.
  39069. <br/>
  39070. In some cases external workbooks referenced by formulas in the main workbook are not available.
  39071. With this method you can control how POI handles such missing references:
  39072. <ul>
  39073. <li>by default ignoreMissingWorkbooks=false and POI throws
  39074. {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException}
  39075. if an external reference cannot be resolved</li>
  39076. <li>if ignoreMissingWorkbooks=true then POI uses cached formula result
  39077. that already exists in the main workbook</li>
  39078. </ul>
  39079. @param ignore whether to ignore missing references to external workbooks
  39080. </member>
  39081. <member name="P:NPOI.SS.UserModel.IFormulaEvaluator.DebugEvaluationOutputForNextEval">
  39082. * Perform detailed output of formula evaluation for next evaluation only?
  39083. * Is for developer use only (also developers using POI for their XLS files).
  39084. * Log-Level WARN is for basic info, INFO for detailed information. These quite
  39085. * high levels are used because you have to explicitly enable this specific logging.
  39086. * @param value whether to perform detailed output
  39087. </member>
  39088. <member name="T:NPOI.SS.UserModel.FractionFormat">
  39089. <p>Format class that handles Excel style fractions, such as "# #/#" and "#/###"</p>
  39090. <p>As of this writing, this is still not 100% accurate, but it does a reasonable job
  39091. of trying to mimic Excel's fraction calculations. It does not currently
  39092. maintain Excel's spacing.</p>
  39093. <p>This class relies on a method lifted nearly verbatim from org.apache.math.fraction.
  39094. If further uses for Commons Math are found, we will consider Adding it as a dependency.
  39095. For now, we have in-lined the one method to keep things simple.</p>
  39096. </member>
  39097. <member name="M:NPOI.SS.UserModel.FractionFormat.#ctor(System.String,System.String)">
  39098. Single parameter ctor
  39099. @param denomFormatString The format string for the denominator
  39100. </member>
  39101. <member name="T:NPOI.SS.UserModel.IHeader">
  39102. <summary>
  39103. Common defInition of a HSSF or XSSF page header.
  39104. For a list of all the different fields that can be
  39105. placed into a header, such as page number,
  39106. bold, underline etc, see
  39107. </summary>
  39108. </member>
  39109. <member name="T:NPOI.SS.UserModel.IHeaderFooter">
  39110. <summary>
  39111. Common interface for NPOI.SS.UserModel.Header and NPOI.SS.UserModel.Footer
  39112. </summary>
  39113. </member>
  39114. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Left">
  39115. <summary>
  39116. Gets or sets the left side of the header or footer.
  39117. </summary>
  39118. <value>The string representing the left side.</value>
  39119. </member>
  39120. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Center">
  39121. <summary>
  39122. Gets or sets the center of the header or footer.
  39123. </summary>
  39124. <value>The string representing the center.</value>
  39125. </member>
  39126. <member name="P:NPOI.SS.UserModel.IHeaderFooter.Right">
  39127. <summary>
  39128. Gets or sets the right side of the header or footer.
  39129. </summary>
  39130. <value>The string representing the right side.</value>
  39131. </member>
  39132. <member name="T:NPOI.SS.UserModel.HorizontalAlignment">
  39133. The enumeration value indicating horizontal alignment of a cell,
  39134. i.e., whether it is aligned general, left, right, horizontally centered, Filled (replicated),
  39135. justified, centered across multiple cells, or distributed.
  39136. </member>
  39137. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.General">
  39138. The horizontal alignment is general-aligned. Text data is left-aligned.
  39139. Numbers, dates, and times are rightaligned. Boolean types are centered.
  39140. Changing the alignment does not change the type of data.
  39141. </member>
  39142. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Left">
  39143. The horizontal alignment is left-aligned, even in Rightto-Left mode.
  39144. Aligns contents at the left edge of the cell. If an indent amount is specified, the contents of
  39145. the cell is indented from the left by the specified number of character spaces. The character spaces are
  39146. based on the default font and font size for the workbook.
  39147. </member>
  39148. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Center">
  39149. The horizontal alignment is centered, meaning the text is centered across the cell.
  39150. </member>
  39151. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Right">
  39152. The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell,
  39153. even in Right-to-Left mode.
  39154. </member>
  39155. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Justify">
  39156. The horizontal alignment is justified (flush left and right).
  39157. For each line of text, aligns each line of the wrapped text in a cell to the right and left
  39158. (except the last line). If no single line of text wraps in the cell, then the text is not justified.
  39159. </member>
  39160. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Fill">
  39161. Indicates that the value of the cell should be Filled
  39162. across the entire width of the cell. If blank cells to the right also have the fill alignment,
  39163. they are also Filled with the value, using a convention similar to centerContinuous.
  39164. <p>
  39165. Additional rules:
  39166. <ol>
  39167. <li>Only whole values can be Appended, not partial values.</li>
  39168. <li>The column will not be widened to 'best fit' the Filled value</li>
  39169. <li>If Appending an Additional occurrence of the value exceeds the boundary of the cell
  39170. left/right edge, don't append the Additional occurrence of the value.</li>
  39171. <li>The display value of the cell is Filled, not the underlying raw number.</li>
  39172. </ol>
  39173. </p>
  39174. </member>
  39175. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.CenterSelection">
  39176. The horizontal alignment is centered across multiple cells.
  39177. The information about how many cells to span is expressed in the Sheet Part,
  39178. in the row of the cell in question. For each cell that is spanned in the alignment,
  39179. a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.
  39180. </member>
  39181. <member name="F:NPOI.SS.UserModel.HorizontalAlignment.Distributed">
  39182. Indicates that each 'word' in each line of text inside the cell is evenly distributed
  39183. across the width of the cell, with flush right and left margins.
  39184. <p>
  39185. When there is also an indent value to apply, both the left and right side of the cell
  39186. are pAdded by the indent value.
  39187. </p>
  39188. <p> A 'word' is a set of characters with no space character in them. </p>
  39189. <p> Two lines inside a cell are Separated by a carriage return. </p>
  39190. </member>
  39191. <member name="F:NPOI.SS.UserModel.HyperlinkType.Url">
  39192. <summary>
  39193. Link to an existing file or web page
  39194. </summary>
  39195. </member>
  39196. <member name="F:NPOI.SS.UserModel.HyperlinkType.Document">
  39197. <summary>
  39198. Link to a place in this document
  39199. </summary>
  39200. </member>
  39201. <member name="F:NPOI.SS.UserModel.HyperlinkType.Email">
  39202. <summary>
  39203. Link to an E-mail Address
  39204. </summary>
  39205. </member>
  39206. <member name="F:NPOI.SS.UserModel.HyperlinkType.File">
  39207. <summary>
  39208. Link to a file
  39209. </summary>
  39210. </member>
  39211. <member name="T:NPOI.SS.UserModel.IHyperlink">
  39212. <summary>
  39213. Represents an Excel hyperlink.
  39214. </summary>
  39215. </member>
  39216. <member name="P:NPOI.SS.UserModel.IHyperlink.Address">
  39217. <summary>
  39218. Hyperlink address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
  39219. </summary>
  39220. </member>
  39221. <member name="P:NPOI.SS.UserModel.IHyperlink.Label">
  39222. <summary>
  39223. text label for this hyperlink
  39224. </summary>
  39225. </member>
  39226. <member name="P:NPOI.SS.UserModel.IHyperlink.Type">
  39227. <summary>
  39228. the type of this hyperlink
  39229. </summary>
  39230. </member>
  39231. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstRow">
  39232. <summary>
  39233. the row of the first cell that Contains the hyperlink
  39234. </summary>
  39235. </member>
  39236. <member name="P:NPOI.SS.UserModel.IHyperlink.LastRow">
  39237. <summary>
  39238. the row of the last cell that Contains the hyperlink
  39239. </summary>
  39240. </member>
  39241. <member name="P:NPOI.SS.UserModel.IHyperlink.FirstColumn">
  39242. <summary>
  39243. the column of the first cell that Contains the hyperlink
  39244. </summary>
  39245. </member>
  39246. <member name="P:NPOI.SS.UserModel.IHyperlink.LastColumn">
  39247. <summary>
  39248. the column of the last cell that Contains the hyperlink
  39249. </summary>
  39250. </member>
  39251. <member name="T:NPOI.SS.UserModel.IName">
  39252. Represents a defined name for a range of cells.
  39253. A name is a meaningful shorthand that makes it easier to understand the purpose of a
  39254. cell reference, constant or a formula.
  39255. </member>
  39256. <member name="P:NPOI.SS.UserModel.IName.SheetName">
  39257. Get the sheets name which this named range is referenced to
  39258. @return sheet name, which this named range refered to
  39259. </member>
  39260. <member name="P:NPOI.SS.UserModel.IName.NameName">
  39261. Gets the name of the named range
  39262. @return named range name
  39263. </member>
  39264. <member name="P:NPOI.SS.UserModel.IName.RefersToFormula">
  39265. Returns the formula that the name is defined to refer to.
  39266. @return the reference for this name, <code>null</code> if it has not been set yet. Never empty string
  39267. @see #SetRefersToFormula(String)
  39268. </member>
  39269. <member name="P:NPOI.SS.UserModel.IName.IsFunctionName">
  39270. Checks if this name is a function name
  39271. @return true if this name is a function name
  39272. </member>
  39273. <member name="P:NPOI.SS.UserModel.IName.IsDeleted">
  39274. Checks if this name points to a cell that no longer exists
  39275. @return <c>true</c> if the name refers to a deleted cell, <c>false</c> otherwise
  39276. </member>
  39277. <member name="P:NPOI.SS.UserModel.IName.SheetIndex">
  39278. Returns the sheet index this name applies to.
  39279. @return the sheet index this name applies to, -1 if this name applies to the entire workbook
  39280. </member>
  39281. <member name="P:NPOI.SS.UserModel.IName.Comment">
  39282. Returns the comment the user provided when the name was Created.
  39283. @return the user comment for this named range
  39284. </member>
  39285. <member name="M:NPOI.SS.UserModel.IName.SetFunction(System.Boolean)">
  39286. Indicates that the defined name refers to a user-defined function.
  39287. This attribute is used when there is an add-in or other code project associated with the file.
  39288. @param value <c>true</c> indicates the name refers to a function.
  39289. </member>
  39290. <member name="T:NPOI.SS.UserModel.PageOrder">
  39291. Specifies printed page order.
  39292. @author Gisella Bronzetti
  39293. </member>
  39294. <member name="F:NPOI.SS.UserModel.PageOrder.DOWN_THEN_OVER">
  39295. Order pages vertically first, then move horizontally.
  39296. </member>
  39297. <member name="F:NPOI.SS.UserModel.PageOrder.OVER_THEN_DOWN">
  39298. Order pages horizontally first, then move vertically
  39299. </member>
  39300. <member name="T:NPOI.SS.UserModel.PaperSize">
  39301. The enumeration value indicating the possible paper size for a sheet
  39302. @author Daniele Montagni
  39303. </member>
  39304. <member name="F:NPOI.SS.UserModel.PaperSize.PRINTER_DEFAULT_PAPERSIZE">
  39305. <summary>
  39306. Allow accessing the Initial value.
  39307. </summary>
  39308. </member>
  39309. <member name="F:NPOI.SS.UserModel.PaperSize.A4_TRANSVERSE_PAPERSIZE">
  39310. <summary>
  39311. A4 Transverse - 210x297 mm
  39312. </summary>
  39313. </member>
  39314. <member name="F:NPOI.SS.UserModel.PaperSize.A4_PLUS_PAPERSIZE">
  39315. <summary>
  39316. A4 Plus - 210x330 mm
  39317. </summary>
  39318. </member>
  39319. <member name="F:NPOI.SS.UserModel.PaperSize.LETTER_ROTATED_PAPERSIZE">
  39320. <summary>
  39321. US Letter Rotated 11 x 8 1/2 in
  39322. </summary>
  39323. </member>
  39324. <member name="F:NPOI.SS.UserModel.PaperSize.A4_ROTATED_PAPERSIZE">
  39325. <summary>
  39326. A4 Rotated - 297x210 mm */
  39327. </summary>
  39328. </member>
  39329. <member name="T:NPOI.SS.UserModel.IPatternFormatting">
  39330. @author Yegor Kozlov
  39331. </member>
  39332. <member name="F:NPOI.SS.UserModel.PictureType.Unknown">
  39333. <summary>
  39334. Allow accessing the Initial value.
  39335. </summary>
  39336. </member>
  39337. <member name="F:NPOI.SS.UserModel.PictureType.EMF">
  39338. Extended windows meta file
  39339. </member>
  39340. <member name="F:NPOI.SS.UserModel.PictureType.WMF">
  39341. Windows Meta File
  39342. </member>
  39343. <member name="F:NPOI.SS.UserModel.PictureType.PICT">
  39344. Mac PICT format
  39345. </member>
  39346. <member name="F:NPOI.SS.UserModel.PictureType.JPEG">
  39347. JPEG format
  39348. </member>
  39349. <member name="F:NPOI.SS.UserModel.PictureType.PNG">
  39350. PNG format
  39351. </member>
  39352. <member name="F:NPOI.SS.UserModel.PictureType.DIB">
  39353. Device independent bitmap
  39354. </member>
  39355. <member name="F:NPOI.SS.UserModel.PictureType.GIF">
  39356. GIF image format
  39357. </member>
  39358. <member name="F:NPOI.SS.UserModel.PictureType.TIFF">
  39359. Tag Image File (.tiff)
  39360. </member>
  39361. <member name="F:NPOI.SS.UserModel.PictureType.EPS">
  39362. Encapsulated Postscript (.eps)
  39363. </member>
  39364. <member name="F:NPOI.SS.UserModel.PictureType.BMP">
  39365. Windows Bitmap (.bmp)
  39366. </member>
  39367. <member name="F:NPOI.SS.UserModel.PictureType.WPG">
  39368. WordPerfect graphics (.wpg)
  39369. </member>
  39370. <member name="T:NPOI.SS.UserModel.IPicture">
  39371. Repersents a picture in a SpreadsheetML document
  39372. @author Yegor Kozlov
  39373. </member>
  39374. <member name="M:NPOI.SS.UserModel.IPicture.Resize">
  39375. Reset the image to the dimension of the embedded image
  39376. @see #resize(double, double)
  39377. </member>
  39378. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double)">
  39379. Resize the image proportionally.
  39380. </member>
  39381. <member name="M:NPOI.SS.UserModel.IPicture.Resize(System.Double,System.Double)">
  39382. Resize the image.
  39383. <p>
  39384. Please note, that this method works correctly only for workbooks
  39385. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  39386. If the default font is changed the resized image can be streched vertically or horizontally.
  39387. </p>
  39388. <p>
  39389. <code>resize(1.0,1.0)</code> keeps the original size,<br/>
  39390. <code>resize(0.5,0.5)</code> resize to 50% of the original,<br/>
  39391. <code>resize(2.0,2.0)</code> resizes to 200% of the original.<br/>
  39392. <code>resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})</code> resizes to the dimension of the embedded image.
  39393. </p>
  39394. @param scaleX the amount by which the image width is multiplied relative to the original width.
  39395. @param scaleY the amount by which the image height is multiplied relative to the original height.
  39396. </member>
  39397. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize">
  39398. Calculate the preferred size for this picture.
  39399. @return XSSFClientAnchor with the preferred size for this image
  39400. </member>
  39401. <member name="M:NPOI.SS.UserModel.IPicture.GetPreferredSize(System.Double,System.Double)">
  39402. Calculate the preferred size for this picture.
  39403. @param scaleX the amount by which image width is multiplied relative to the original width.
  39404. @param scaleY the amount by which image height is multiplied relative to the original height.
  39405. @return ClientAnchor with the preferred size for this image
  39406. </member>
  39407. <member name="M:NPOI.SS.UserModel.IPicture.GetImageDimension">
  39408. Return the dimension of the embedded image in pixel
  39409. @return image dimension in pixels
  39410. </member>
  39411. <member name="P:NPOI.SS.UserModel.IPicture.PictureData">
  39412. Return picture data for this picture
  39413. @return picture data for this picture
  39414. </member>
  39415. <member name="P:NPOI.SS.UserModel.IPicture.ClientAnchor">
  39416. @return the anchor that is used by this picture
  39417. </member>
  39418. <member name="P:NPOI.SS.UserModel.IPictureData.Data">
  39419. Gets the picture data.
  39420. @return the picture data.
  39421. </member>
  39422. <member name="M:NPOI.SS.UserModel.IPictureData.SuggestFileExtension">
  39423. Suggests a file extension for this image.
  39424. @return the file extension.
  39425. </member>
  39426. <member name="P:NPOI.SS.UserModel.IPictureData.MimeType">
  39427. Returns the mime type for the image
  39428. </member>
  39429. <member name="P:NPOI.SS.UserModel.IPictureData.PictureType">
  39430. @return the POI internal image type, 0 if unknown image type
  39431. @see Workbook#PICTURE_TYPE_DIB
  39432. @see Workbook#PICTURE_TYPE_EMF
  39433. @see Workbook#PICTURE_TYPE_JPEG
  39434. @see Workbook#PICTURE_TYPE_PICT
  39435. @see Workbook#PICTURE_TYPE_PNG
  39436. @see Workbook#PICTURE_TYPE_WMF
  39437. </member>
  39438. <member name="T:NPOI.SS.UserModel.PrintCellComments">
  39439. These enumerations specify how cell comments shall be displayed for paper printing purposes.
  39440. @author Gisella Bronzetti
  39441. </member>
  39442. <member name="F:NPOI.SS.UserModel.PrintCellComments.NONE">
  39443. Do not print cell comments.
  39444. </member>
  39445. <member name="F:NPOI.SS.UserModel.PrintCellComments.AS_DISPLAYED">
  39446. Print cell comments as displayed.
  39447. </member>
  39448. <member name="F:NPOI.SS.UserModel.PrintCellComments.AT_END">
  39449. Print cell comments at end of document.
  39450. </member>
  39451. <member name="T:NPOI.SS.UserModel.PrintOrientation">
  39452. The enumeration value indicating the print orientation for a sheet.
  39453. @author Gisella Bronzetti
  39454. </member>
  39455. <member name="F:NPOI.SS.UserModel.PrintOrientation.DEFAULT">
  39456. orientation not specified
  39457. </member>
  39458. <member name="F:NPOI.SS.UserModel.PrintOrientation.PORTRAIT">
  39459. portrait orientation
  39460. </member>
  39461. <member name="F:NPOI.SS.UserModel.PrintOrientation.LANDSCAPE">
  39462. landscape orientations
  39463. </member>
  39464. <member name="T:NPOI.SS.UserModel.DisplayCellErrorType">
  39465. <summary>
  39466. Used by HSSFPrintSetup.CellError property
  39467. </summary>
  39468. </member>
  39469. <member name="P:NPOI.SS.UserModel.IPrintSetup.PaperSize">
  39470. Returns the paper size.
  39471. @return paper size
  39472. </member>
  39473. <member name="P:NPOI.SS.UserModel.IPrintSetup.Scale">
  39474. Returns the scale.
  39475. @return scale
  39476. </member>
  39477. <member name="P:NPOI.SS.UserModel.IPrintSetup.PageStart">
  39478. Returns the page start.
  39479. @return page start
  39480. </member>
  39481. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitWidth">
  39482. Returns the number of pages wide to fit sheet in.
  39483. @return number of pages wide to fit sheet in
  39484. </member>
  39485. <member name="P:NPOI.SS.UserModel.IPrintSetup.FitHeight">
  39486. Returns the number of pages high to fit the sheet in.
  39487. @return number of pages high to fit the sheet in
  39488. </member>
  39489. <member name="P:NPOI.SS.UserModel.IPrintSetup.LeftToRight">
  39490. Returns the left to right print order.
  39491. @return left to right print order
  39492. </member>
  39493. <member name="P:NPOI.SS.UserModel.IPrintSetup.Landscape">
  39494. Returns the landscape mode.
  39495. @return landscape mode
  39496. </member>
  39497. <member name="P:NPOI.SS.UserModel.IPrintSetup.ValidSettings">
  39498. Returns the valid Settings.
  39499. @return valid Settings
  39500. </member>
  39501. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoColor">
  39502. Returns the black and white Setting.
  39503. @return black and white Setting
  39504. </member>
  39505. <member name="P:NPOI.SS.UserModel.IPrintSetup.Draft">
  39506. Returns the draft mode.
  39507. @return draft mode
  39508. </member>
  39509. <member name="P:NPOI.SS.UserModel.IPrintSetup.Notes">
  39510. Returns the print notes.
  39511. @return print notes
  39512. </member>
  39513. <member name="P:NPOI.SS.UserModel.IPrintSetup.NoOrientation">
  39514. Returns the no orientation.
  39515. @return no orientation
  39516. </member>
  39517. <member name="P:NPOI.SS.UserModel.IPrintSetup.UsePage">
  39518. Returns the use page numbers.
  39519. @return use page numbers
  39520. </member>
  39521. <member name="P:NPOI.SS.UserModel.IPrintSetup.HResolution">
  39522. Returns the horizontal resolution.
  39523. @return horizontal resolution
  39524. </member>
  39525. <member name="P:NPOI.SS.UserModel.IPrintSetup.VResolution">
  39526. Returns the vertical resolution.
  39527. @return vertical resolution
  39528. </member>
  39529. <member name="P:NPOI.SS.UserModel.IPrintSetup.HeaderMargin">
  39530. Returns the header margin.
  39531. @return header margin
  39532. </member>
  39533. <member name="P:NPOI.SS.UserModel.IPrintSetup.FooterMargin">
  39534. Returns the footer margin.
  39535. @return footer margin
  39536. </member>
  39537. <member name="P:NPOI.SS.UserModel.IPrintSetup.Copies">
  39538. Returns the number of copies.
  39539. @return number of copies
  39540. </member>
  39541. <member name="T:NPOI.SS.UserModel.IRichTextString">
  39542. Rich text unicode string. These strings can have fonts
  39543. applied to arbitary parts of the string.
  39544. @author Glen Stampoultzis (glens at apache.org)
  39545. @author Jason Height (jheight at apache.org)
  39546. </member>
  39547. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,System.Int16)">
  39548. Applies a font to the specified characters of a string.
  39549. @param startIndex The start index to apply the font to (inclusive)
  39550. @param endIndex The end index to apply the font to (exclusive)
  39551. @param fontIndex The font to use.
  39552. </member>
  39553. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int32,System.Int32,NPOI.SS.UserModel.IFont)">
  39554. Applies a font to the specified characters of a string.
  39555. @param startIndex The start index to apply the font to (inclusive)
  39556. @param endIndex The end index to apply to font to (exclusive)
  39557. @param font The index of the font to use.
  39558. </member>
  39559. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(NPOI.SS.UserModel.IFont)">
  39560. Sets the font of the entire string.
  39561. @param font The font to use.
  39562. </member>
  39563. <member name="M:NPOI.SS.UserModel.IRichTextString.ClearFormatting">
  39564. Removes any formatting that may have been applied to the string.
  39565. </member>
  39566. <member name="P:NPOI.SS.UserModel.IRichTextString.String">
  39567. Returns the plain string representation.
  39568. </member>
  39569. <member name="P:NPOI.SS.UserModel.IRichTextString.Length">
  39570. @return the number of characters in the font.
  39571. </member>
  39572. <member name="P:NPOI.SS.UserModel.IRichTextString.NumFormattingRuns">
  39573. @return The number of formatting Runs used.
  39574. </member>
  39575. <member name="M:NPOI.SS.UserModel.IRichTextString.GetIndexOfFormattingRun(System.Int32)">
  39576. The index within the string to which the specified formatting run applies.
  39577. @param index the index of the formatting run
  39578. @return the index within the string.
  39579. </member>
  39580. <member name="M:NPOI.SS.UserModel.IRichTextString.ApplyFont(System.Int16)">
  39581. Applies the specified font to the entire string.
  39582. @param fontIndex the font to apply.
  39583. </member>
  39584. <member name="T:NPOI.SS.UserModel.MissingCellPolicy">
  39585. <summary>
  39586. Used to specify the different possible policies
  39587. if for the case of null and blank cells
  39588. </summary>
  39589. </member>
  39590. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK">
  39591. <summary>Missing cells are returned as null, Blank cells are returned as normal</summary>
  39592. </member>
  39593. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL">
  39594. <summary>Missing cells are returned as null, as are blank cells</summary>
  39595. </member>
  39596. <member name="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK">
  39597. <summary>A new, blank cell is Created for missing cells. Blank cells are returned as normal</summary>
  39598. </member>
  39599. <member name="T:NPOI.SS.UserModel.IRow">
  39600. <summary>
  39601. High level representation of a row of a spreadsheet.
  39602. </summary>
  39603. </member>
  39604. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32)">
  39605. <summary>
  39606. Use this to create new cells within the row and return it.
  39607. The cell that is returned is a <see cref="T:NPOI.SS.UserModel.ICell"/>/<see cref="F:NPOI.SS.UserModel.CellType.Blank"/>.
  39608. The type can be changed either through calling <c>SetCellValue</c> or <c>SetCellType</c>.
  39609. </summary>
  39610. <param name="column">the column number this cell represents</param>
  39611. <returns>Cell a high level representation of the created cell.</returns>
  39612. <throws>
  39613. ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  39614. (255 for *.xls, 1048576 for *.xlsx)
  39615. </throws>
  39616. </member>
  39617. <member name="M:NPOI.SS.UserModel.IRow.CreateCell(System.Int32,NPOI.SS.UserModel.CellType)">
  39618. <summary>
  39619. Use this to create new cells within the row and return it.
  39620. 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
  39621. either through calling <code>SetCellValue</code> or <code>SetCellType</code>.
  39622. </summary>
  39623. <param name="column">the column number this cell represents</param>
  39624. <param name="type"></param>
  39625. <returns>Cell a high level representation of the created cell.</returns>
  39626. <throws>ArgumentException if columnIndex &lt; 0 or greater than the maximum number of supported columns
  39627. (255 for *.xls, 1048576 for *.xlsx)
  39628. </throws>
  39629. </member>
  39630. <member name="M:NPOI.SS.UserModel.IRow.RemoveCell(NPOI.SS.UserModel.ICell)">
  39631. <summary>
  39632. Remove the Cell from this row.
  39633. </summary>
  39634. <param name="cell">the cell to remove</param>
  39635. </member>
  39636. <member name="P:NPOI.SS.UserModel.IRow.RowNum">
  39637. <summary>
  39638. Get row number this row represents
  39639. </summary>
  39640. <returns>the row number (0 based)</returns>
  39641. </member>
  39642. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32)">
  39643. <summary>
  39644. Get the cell representing a given column (logical cell) 0-based. If you
  39645. ask for a cell that is not defined....you get a null.
  39646. </summary>
  39647. <param name="cellnum">0 based column number</param>
  39648. <returns>Cell representing that column or null if undefined.</returns>
  39649. <see cref="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)"/>
  39650. </member>
  39651. <member name="M:NPOI.SS.UserModel.IRow.GetCell(System.Int32,NPOI.SS.UserModel.MissingCellPolicy)">
  39652. <summary>
  39653. Returns the cell at the given (0 based) index, with the specified {@link NPOI.SS.usermodel.Row.MissingCellPolicy}
  39654. </summary>
  39655. <returns>the cell at the given (0 based) index</returns>
  39656. <throws>ArgumentException if cellnum &lt; 0 or the specified MissingCellPolicy is invalid</throws>
  39657. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_NULL_AND_BLANK"/>
  39658. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.RETURN_BLANK_AS_NULL"/>
  39659. <see cref="F:NPOI.SS.UserModel.MissingCellPolicy.CREATE_NULL_AS_BLANK"/>
  39660. </member>
  39661. <member name="P:NPOI.SS.UserModel.IRow.FirstCellNum">
  39662. <summary>
  39663. Get the number of the first cell Contained in this row.
  39664. </summary>
  39665. <returns>
  39666. short representing the first logical cell in the row,
  39667. or -1 if the row does not contain any cells.
  39668. </returns>
  39669. </member>
  39670. <member name="P:NPOI.SS.UserModel.IRow.LastCellNum">
  39671. <summary>
  39672. Gets the index of the last cell Contained in this row <b>PLUS ONE</b>. The result also
  39673. happens to be the 1-based column number of the last cell. This value can be used as a
  39674. standard upper bound when iterating over cells:
  39675. <pre>
  39676. short minColIx = row.GetFirstCellNum();
  39677. short maxColIx = row.GetLastCellNum();
  39678. for(short colIx=minColIx; colIx&lt;maxColIx; colIx++) {
  39679. Cell cell = row.GetCell(colIx);
  39680. if(cell == null) {
  39681. continue;
  39682. }
  39683. //... do something with cell
  39684. }
  39685. </pre>
  39686. </summary>
  39687. <returns>
  39688. short representing the last logical cell in the row <b>PLUS ONE</b>,
  39689. or -1 if the row does not contain any cells.
  39690. </returns>
  39691. </member>
  39692. <member name="P:NPOI.SS.UserModel.IRow.PhysicalNumberOfCells">
  39693. <summary>
  39694. Gets the number of defined cells (NOT number of cells in the actual row!).
  39695. That is to say if only columns 0,4,5 have values then there would be 3.
  39696. </summary>
  39697. <returns>int representing the number of defined cells in the row.</returns>
  39698. </member>
  39699. <member name="P:NPOI.SS.UserModel.IRow.ZeroHeight">
  39700. <summary>
  39701. Get whether or not to display this row with 0 height
  39702. </summary>
  39703. <returns>zHeight height is zero or not.</returns>
  39704. </member>
  39705. <member name="P:NPOI.SS.UserModel.IRow.Height">
  39706. <summary>
  39707. Get the row's height measured in twips (1/20th of a point).
  39708. If the height is not set, the default worksheet value is returned,
  39709. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  39710. </summary>
  39711. <returns>row height measured in twips (1/20th of a point)</returns>
  39712. </member>
  39713. <member name="P:NPOI.SS.UserModel.IRow.HeightInPoints">
  39714. <summary>
  39715. Returns row height measured in point size.
  39716. If the height is not set, the default worksheet value is returned,
  39717. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  39718. </summary>
  39719. <returns>row height measured in point size
  39720. <see cref="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints"/>
  39721. </returns>
  39722. </member>
  39723. <member name="P:NPOI.SS.UserModel.IRow.IsFormatted">
  39724. <summary>
  39725. Is this row formatted? Most aren't, but some rows
  39726. do have whole-row styles. For those that do, you
  39727. can get the formatting from <see cref="P:NPOI.SS.UserModel.IRow.RowStyle"/>
  39728. </summary>
  39729. </member>
  39730. <member name="P:NPOI.SS.UserModel.IRow.Sheet">
  39731. <summary>
  39732. Returns the Sheet this row belongs to
  39733. </summary>
  39734. <returns>the Sheet that owns this row</returns>
  39735. </member>
  39736. <member name="P:NPOI.SS.UserModel.IRow.RowStyle">
  39737. <summary>
  39738. Returns the whole-row cell styles. Most rows won't
  39739. have one of these, so will return null. Call IsFormmated to check first
  39740. </summary>
  39741. <value>The row style.</value>
  39742. </member>
  39743. <member name="M:NPOI.SS.UserModel.IRow.MoveCell(NPOI.SS.UserModel.ICell,System.Int32)">
  39744. <summary>
  39745. Moves the supplied cell to a new column, which
  39746. must not already have a cell there!
  39747. </summary>
  39748. <param name="cell">The cell to move</param>
  39749. <param name="newColumn">The new column number (0 based)</param>
  39750. </member>
  39751. <member name="M:NPOI.SS.UserModel.IRow.CopyRowTo(System.Int32)">
  39752. <summary>
  39753. Copy the current row to the target row
  39754. </summary>
  39755. <param name="targetIndex">row index of the target row</param>
  39756. <returns>the new copied row object</returns>
  39757. </member>
  39758. <member name="M:NPOI.SS.UserModel.IRow.CopyCell(System.Int32,System.Int32)">
  39759. <summary>
  39760. Copy the source cell to the target cell. If the target cell exists, the new copied cell will be inserted before the existing one
  39761. </summary>
  39762. <param name="sourceIndex">index of the source cell</param>
  39763. <param name="targetIndex">index of the target cell</param>
  39764. <returns>the new copied cell object</returns>
  39765. </member>
  39766. <member name="P:NPOI.SS.UserModel.IRow.Cells">
  39767. <summary>
  39768. Get cells in the row
  39769. </summary>
  39770. </member>
  39771. <member name="P:NPOI.SS.UserModel.IRow.OutlineLevel">
  39772. <summary>
  39773. Returns the rows outline level. Increased as you
  39774. put it into more groups (outlines), reduced as
  39775. you take it out of them.
  39776. </summary>
  39777. </member>
  39778. <member name="T:NPOI.SS.UserModel.ShapeTypes">
  39779. All known types of automatic shapes in DrawingML
  39780. @author Yegor Kozlov
  39781. </member>
  39782. <member name="F:NPOI.SS.UserModel.ShapeTypes.None">
  39783. <summary>
  39784. Allow accessing the Initial value.
  39785. </summary>
  39786. </member>
  39787. <member name="T:NPOI.SS.UserModel.MarginType">
  39788. <summary>
  39789. Indicate the position of the margin. One of left, right, top and bottom.
  39790. </summary>
  39791. </member>
  39792. <member name="F:NPOI.SS.UserModel.MarginType.LeftMargin">
  39793. <summary>
  39794. referes to the left margin
  39795. </summary>
  39796. </member>
  39797. <member name="F:NPOI.SS.UserModel.MarginType.RightMargin">
  39798. <summary>
  39799. referes to the right margin
  39800. </summary>
  39801. </member>
  39802. <member name="F:NPOI.SS.UserModel.MarginType.TopMargin">
  39803. <summary>
  39804. referes to the top margin
  39805. </summary>
  39806. </member>
  39807. <member name="F:NPOI.SS.UserModel.MarginType.BottomMargin">
  39808. <summary>
  39809. referes to the bottom margin
  39810. </summary>
  39811. </member>
  39812. <member name="T:NPOI.SS.UserModel.PanePosition">
  39813. <summary>
  39814. Define the position of the pane. One of lower/right, upper/right, lower/left and upper/left.
  39815. </summary>
  39816. </member>
  39817. <member name="F:NPOI.SS.UserModel.PanePosition.LowerRight">
  39818. <summary>
  39819. referes to the lower/right corner
  39820. </summary>
  39821. </member>
  39822. <member name="F:NPOI.SS.UserModel.PanePosition.UpperRight">
  39823. <summary>
  39824. referes to the upper/right corner
  39825. </summary>
  39826. </member>
  39827. <member name="F:NPOI.SS.UserModel.PanePosition.LowerLeft">
  39828. <summary>
  39829. referes to the lower/left corner
  39830. </summary>
  39831. </member>
  39832. <member name="F:NPOI.SS.UserModel.PanePosition.UpperLeft">
  39833. <summary>
  39834. referes to the upper/left corner
  39835. </summary>
  39836. </member>
  39837. <member name="T:NPOI.SS.UserModel.ISheet">
  39838. <summary>
  39839. High level representation of a Excel worksheet.
  39840. </summary>
  39841. <remarks>
  39842. Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work.
  39843. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can
  39844. contain text, numbers, dates, and formulas. Cells can also be formatted.
  39845. </remarks>
  39846. </member>
  39847. <member name="M:NPOI.SS.UserModel.ISheet.CreateRow(System.Int32)">
  39848. <summary>
  39849. Create a new row within the sheet and return the high level representation
  39850. </summary>
  39851. <param name="rownum">The row number.</param>
  39852. <returns>high level Row object representing a row in the sheet</returns>
  39853. <see>RemoveRow(Row)</see>
  39854. </member>
  39855. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRow(NPOI.SS.UserModel.IRow)">
  39856. <summary>
  39857. Remove a row from this sheet. All cells Contained in the row are Removed as well
  39858. </summary>
  39859. <param name="row">a row to Remove.</param>
  39860. </member>
  39861. <member name="M:NPOI.SS.UserModel.ISheet.GetRow(System.Int32)">
  39862. <summary>
  39863. Returns the logical row (not physical) 0-based. If you ask for a row that is not
  39864. defined you get a null. This is to say row 4 represents the fifth row on a sheet.
  39865. </summary>
  39866. <param name="rownum">row to get (0-based).</param>
  39867. <returns>the rownumber or null if its not defined on the sheet</returns>
  39868. </member>
  39869. <member name="P:NPOI.SS.UserModel.ISheet.PhysicalNumberOfRows">
  39870. <summary>
  39871. Returns the number of physically defined rows (NOT the number of rows in the sheet)
  39872. </summary>
  39873. <value>the number of physically defined rows in this sheet.</value>
  39874. </member>
  39875. <member name="P:NPOI.SS.UserModel.ISheet.FirstRowNum">
  39876. <summary>
  39877. Gets the first row on the sheet
  39878. </summary>
  39879. <value>the number of the first logical row on the sheet (0-based).</value>
  39880. </member>
  39881. <member name="P:NPOI.SS.UserModel.ISheet.LastRowNum">
  39882. <summary>
  39883. Gets the last row on the sheet
  39884. </summary>
  39885. <value>last row contained n this sheet (0-based)</value>
  39886. </member>
  39887. <member name="P:NPOI.SS.UserModel.ISheet.ForceFormulaRecalculation">
  39888. <summary>
  39889. whether force formula recalculation.
  39890. </summary>
  39891. </member>
  39892. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnHidden(System.Int32,System.Boolean)">
  39893. <summary>
  39894. Get the visibility state for a given column
  39895. </summary>
  39896. <param name="columnIndex">the column to get (0-based)</param>
  39897. <param name="hidden">the visiblity state of the column</param>
  39898. </member>
  39899. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnHidden(System.Int32)">
  39900. <summary>
  39901. Get the hidden state for a given column
  39902. </summary>
  39903. <param name="columnIndex">the column to set (0-based)</param>
  39904. <returns>hidden - <c>false</c> if the column is visible</returns>
  39905. </member>
  39906. <member name="M:NPOI.SS.UserModel.ISheet.CopyRow(System.Int32,System.Int32)">
  39907. <summary>
  39908. Copy the source row to the target row. If the target row exists, the new copied row will be inserted before the existing one
  39909. </summary>
  39910. <param name="sourceIndex">source index</param>
  39911. <param name="targetIndex">target index</param>
  39912. <returns>the new copied row object</returns>
  39913. </member>
  39914. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnWidth(System.Int32,System.Int32)">
  39915. <summary>
  39916. Set the width (in units of 1/256th of a character width)
  39917. </summary>
  39918. <param name="columnIndex">the column to set (0-based)</param>
  39919. <param name="width">the width in units of 1/256th of a character width</param>
  39920. <remarks>
  39921. The maximum column width for an individual cell is 255 characters.
  39922. This value represents the number of characters that can be displayed
  39923. in a cell that is formatted with the standard font.
  39924. </remarks>
  39925. </member>
  39926. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidth(System.Int32)">
  39927. <summary>
  39928. get the width (in units of 1/256th of a character width )
  39929. </summary>
  39930. <param name="columnIndex">the column to get (0-based)</param>
  39931. <returns>the width in units of 1/256th of a character width</returns>
  39932. </member>
  39933. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnWidthInPixels(System.Int32)">
  39934. <summary>
  39935. get the width in pixel
  39936. </summary>
  39937. <param name="columnIndex"></param>
  39938. <returns></returns>
  39939. <remarks>
  39940. Please note, that this method works correctly only for workbooks
  39941. with the default font size (Arial 10pt for .xls and Calibri 11pt for .xlsx).
  39942. If the default font is changed the column width can be streched
  39943. </remarks>
  39944. </member>
  39945. <member name="P:NPOI.SS.UserModel.ISheet.DefaultColumnWidth">
  39946. <summary>
  39947. Get the default column width for the sheet (if the columns do not define their own width)
  39948. in characters
  39949. </summary>
  39950. <value>default column width measured in characters.</value>
  39951. </member>
  39952. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeight">
  39953. <summary>
  39954. Get the default row height for the sheet (if the rows do not define their own height) in
  39955. twips (1/20 of a point)
  39956. </summary>
  39957. <value>default row height measured in twips (1/20 of a point)</value>
  39958. </member>
  39959. <member name="P:NPOI.SS.UserModel.ISheet.DefaultRowHeightInPoints">
  39960. <summary>
  39961. Get the default row height for the sheet (if the rows do not define their own height) in
  39962. points.
  39963. </summary>
  39964. <value>The default row height in points.</value>
  39965. </member>
  39966. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnStyle(System.Int32)">
  39967. <summary>
  39968. Returns the CellStyle that applies to the given
  39969. (0 based) column, or null if no style has been
  39970. set for that column
  39971. </summary>
  39972. <param name="column">The column.</param>
  39973. </member>
  39974. <member name="M:NPOI.SS.UserModel.ISheet.AddMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  39975. <summary>
  39976. Adds a merged region of cells (hence those cells form one)
  39977. </summary>
  39978. <param name="region">(rowfrom/colfrom-rowto/colto) to merge.</param>
  39979. <returns>index of this region</returns>
  39980. </member>
  39981. <member name="P:NPOI.SS.UserModel.ISheet.HorizontallyCenter">
  39982. <summary>
  39983. Determine whether printed output for this sheet will be horizontally centered.
  39984. </summary>
  39985. </member>
  39986. <member name="P:NPOI.SS.UserModel.ISheet.VerticallyCenter">
  39987. <summary>
  39988. Determine whether printed output for this sheet will be vertically centered.
  39989. </summary>
  39990. </member>
  39991. <member name="M:NPOI.SS.UserModel.ISheet.RemoveMergedRegion(System.Int32)">
  39992. <summary>
  39993. Removes a merged region of cells (hence letting them free)
  39994. </summary>
  39995. <param name="index">index of the region to unmerge</param>
  39996. </member>
  39997. <member name="P:NPOI.SS.UserModel.ISheet.NumMergedRegions">
  39998. <summary>
  39999. Returns the number of merged regions
  40000. </summary>
  40001. </member>
  40002. <member name="M:NPOI.SS.UserModel.ISheet.GetMergedRegion(System.Int32)">
  40003. <summary>
  40004. Returns the merged region at the specified index
  40005. </summary>
  40006. <param name="index">The index.</param>
  40007. </member>
  40008. <member name="M:NPOI.SS.UserModel.ISheet.GetRowEnumerator">
  40009. <summary>
  40010. Gets the row enumerator.
  40011. </summary>
  40012. <returns>
  40013. an iterator of the PHYSICAL rows. Meaning the 3rd element may not
  40014. be the third row if say for instance the second row is undefined.
  40015. Call <see cref="P:NPOI.SS.UserModel.IRow.RowNum"/> on each row
  40016. if you care which one it is.
  40017. </returns>
  40018. </member>
  40019. <member name="M:NPOI.SS.UserModel.ISheet.GetEnumerator">
  40020. <summary>
  40021. Get the row enumerator
  40022. </summary>
  40023. <returns></returns>
  40024. </member>
  40025. <member name="P:NPOI.SS.UserModel.ISheet.DisplayZeros">
  40026. <summary>
  40027. Gets the flag indicating whether the window should show 0 (zero) in cells Containing zero value.
  40028. When false, cells with zero value appear blank instead of showing the number zero.
  40029. </summary>
  40030. <value>whether all zero values on the worksheet are displayed.</value>
  40031. </member>
  40032. <member name="P:NPOI.SS.UserModel.ISheet.Autobreaks">
  40033. <summary>
  40034. Gets or sets a value indicating whether the sheet displays Automatic Page Breaks.
  40035. </summary>
  40036. </member>
  40037. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGuts">
  40038. <summary>
  40039. Get whether to display the guts or not,
  40040. </summary>
  40041. <value>default value is true</value>
  40042. </member>
  40043. <member name="P:NPOI.SS.UserModel.ISheet.FitToPage">
  40044. <summary>
  40045. Flag indicating whether the Fit to Page print option is enabled.
  40046. </summary>
  40047. </member>
  40048. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsBelow">
  40049. <summary>
  40050. Flag indicating whether summary rows appear below detail in an outline, when applying an outline.
  40051. When true a summary row is inserted below the detailed data being summarized and a
  40052. new outline level is established on that row.
  40053. When false a summary row is inserted above the detailed data being summarized and a new outline level
  40054. is established on that row.
  40055. </summary>
  40056. <returns><c>true</c> if row summaries appear below detail in the outline</returns>
  40057. </member>
  40058. <member name="P:NPOI.SS.UserModel.ISheet.RowSumsRight">
  40059. <summary>
  40060. Flag indicating whether summary columns appear to the right of detail in an outline, when applying an outline.
  40061. When true a summary column is inserted to the right of the detailed data being summarized
  40062. and a new outline level is established on that column.
  40063. When false a summary column is inserted to the left of the detailed data being
  40064. summarized and a new outline level is established on that column.
  40065. </summary>
  40066. <returns><c>true</c> if col summaries appear right of the detail in the outline</returns>
  40067. </member>
  40068. <member name="P:NPOI.SS.UserModel.ISheet.IsPrintGridlines">
  40069. <summary>
  40070. Gets the flag indicating whether this sheet displays the lines
  40071. between rows and columns to make editing and reading easier.
  40072. </summary>
  40073. <returns><c>true</c> if this sheet displays gridlines.</returns>
  40074. </member>
  40075. <member name="P:NPOI.SS.UserModel.ISheet.PrintSetup">
  40076. <summary>
  40077. Gets the print Setup object.
  40078. </summary>
  40079. <returns>The user model for the print Setup object.</returns>
  40080. </member>
  40081. <member name="P:NPOI.SS.UserModel.ISheet.Header">
  40082. <summary>
  40083. Gets the user model for the default document header.
  40084. <p/>
  40085. Note that XSSF offers more kinds of document headers than HSSF does
  40086. </summary>
  40087. <returns>the document header. Never <code>null</code></returns>
  40088. </member>
  40089. <member name="P:NPOI.SS.UserModel.ISheet.Footer">
  40090. <summary>
  40091. Gets the user model for the default document footer.
  40092. <p/>
  40093. Note that XSSF offers more kinds of document footers than HSSF does.
  40094. </summary>
  40095. <returns>the document footer. Never <code>null</code></returns>
  40096. </member>
  40097. <member name="M:NPOI.SS.UserModel.ISheet.GetMargin(NPOI.SS.UserModel.MarginType)">
  40098. <summary>
  40099. Gets the size of the margin in inches.
  40100. </summary>
  40101. <param name="margin">which margin to get</param>
  40102. <returns>the size of the margin</returns>
  40103. </member>
  40104. <member name="M:NPOI.SS.UserModel.ISheet.SetMargin(NPOI.SS.UserModel.MarginType,System.Double)">
  40105. <summary>
  40106. Sets the size of the margin in inches.
  40107. </summary>
  40108. <param name="margin">which margin to get</param>
  40109. <param name="size">the size of the margin</param>
  40110. </member>
  40111. <member name="P:NPOI.SS.UserModel.ISheet.Protect">
  40112. <summary>
  40113. Answer whether protection is enabled or disabled
  40114. </summary>
  40115. <returns>true => protection enabled; false => protection disabled</returns>
  40116. </member>
  40117. <member name="M:NPOI.SS.UserModel.ISheet.ProtectSheet(System.String)">
  40118. <summary>
  40119. Sets the protection enabled as well as the password
  40120. </summary>
  40121. <param name="password">to set for protection. Pass <code>null</code> to remove protection</param>
  40122. </member>
  40123. <member name="P:NPOI.SS.UserModel.ISheet.ScenarioProtect">
  40124. <summary>
  40125. Answer whether scenario protection is enabled or disabled
  40126. </summary>
  40127. <returns>true => protection enabled; false => protection disabled</returns>
  40128. </member>
  40129. <member name="P:NPOI.SS.UserModel.ISheet.TabColorIndex">
  40130. <summary>
  40131. Gets or sets the tab color of the _sheet
  40132. </summary>
  40133. </member>
  40134. <member name="P:NPOI.SS.UserModel.ISheet.DrawingPatriarch">
  40135. <summary>
  40136. Returns the top-level drawing patriach, if there is one.
  40137. This will hold any graphics or charts for the _sheet.
  40138. WARNING - calling this will trigger a parsing of the
  40139. associated escher records. Any that aren't supported
  40140. (such as charts and complex drawing types) will almost
  40141. certainly be lost or corrupted when written out. Only
  40142. use this with simple drawings, otherwise call
  40143. HSSFSheet#CreateDrawingPatriarch() and
  40144. start from scratch!
  40145. </summary>
  40146. <value>The drawing patriarch.</value>
  40147. </member>
  40148. <member name="M:NPOI.SS.UserModel.ISheet.SetZoom(System.Int32,System.Int32)">
  40149. <summary>
  40150. Sets the zoom magnication for the sheet. The zoom is expressed as a
  40151. fraction. For example to express a zoom of 75% use 3 for the numerator
  40152. and 4 for the denominator.
  40153. </summary>
  40154. <param name="numerator">The numerator for the zoom magnification.</param>
  40155. <param name="denominator">denominator for the zoom magnification.</param>
  40156. </member>
  40157. <member name="P:NPOI.SS.UserModel.ISheet.TopRow">
  40158. <summary>
  40159. The top row in the visible view when the sheet is
  40160. first viewed after opening it in a viewer
  40161. </summary>
  40162. <value>the rownum (0 based) of the top row.</value>
  40163. </member>
  40164. <member name="P:NPOI.SS.UserModel.ISheet.LeftCol">
  40165. <summary>
  40166. The left col in the visible view when the sheet is
  40167. first viewed after opening it in a viewer
  40168. </summary>
  40169. <value>the rownum (0 based) of the top row</value>
  40170. </member>
  40171. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int32,System.Int32)">
  40172. <summary>
  40173. Sets desktop window pane display area, when the file is first opened in a viewer.
  40174. </summary>
  40175. <param name="toprow">the top row to show in desktop window pane</param>
  40176. <param name="leftcol">the left column to show in desktop window pane</param>
  40177. </member>
  40178. <member name="M:NPOI.SS.UserModel.ISheet.ShowInPane(System.Int16,System.Int16)">
  40179. <summary>
  40180. Sets desktop window pane display area, when the
  40181. file is first opened in a viewer.
  40182. </summary>
  40183. <param name="toprow"> the top row to show in desktop window pane</param>
  40184. <param name="leftcol"> the left column to show in desktop window pane</param>
  40185. </member>
  40186. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32)">
  40187. <summary>
  40188. Shifts rows between startRow and endRow n number of rows.
  40189. If you use a negative number, it will shift rows up.
  40190. Code ensures that rows don't wrap around.
  40191. Calls shiftRows(startRow, endRow, n, false, false);
  40192. Additionally shifts merged regions that are completely defined in these
  40193. rows (ie. merged 2 cells on a row to be shifted).
  40194. </summary>
  40195. <param name="startRow">the row to start shifting</param>
  40196. <param name="endRow">the row to end shifting</param>
  40197. <param name="n">the number of rows to shift</param>
  40198. </member>
  40199. <member name="M:NPOI.SS.UserModel.ISheet.ShiftRows(System.Int32,System.Int32,System.Int32,System.Boolean,System.Boolean)">
  40200. <summary>
  40201. Shifts rows between startRow and endRow n number of rows.
  40202. If you use a negative number, it will shift rows up.
  40203. Code ensures that rows don't wrap around
  40204. Additionally shifts merged regions that are completely defined in these
  40205. rows (ie. merged 2 cells on a row to be shifted).
  40206. </summary>
  40207. <param name="startRow">the row to start shifting</param>
  40208. <param name="endRow">the row to end shifting</param>
  40209. <param name="n">the number of rows to shift</param>
  40210. <param name="copyRowHeight">whether to copy the row height during the shift</param>
  40211. <param name="resetOriginalRowHeight">whether to set the original row's height to the default</param>
  40212. </member>
  40213. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32,System.Int32,System.Int32)">
  40214. <summary>
  40215. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  40216. </summary>
  40217. <param name="colSplit">Horizonatal position of split</param>
  40218. <param name="rowSplit">Vertical position of split</param>
  40219. <param name="leftmostColumn">Top row visible in bottom pane</param>
  40220. <param name="topRow">Left column visible in right pane</param>
  40221. </member>
  40222. <member name="M:NPOI.SS.UserModel.ISheet.CreateFreezePane(System.Int32,System.Int32)">
  40223. <summary>
  40224. Creates a split (freezepane). Any existing freezepane or split pane is overwritten.
  40225. </summary>
  40226. <param name="colSplit">Horizonatal position of split.</param>
  40227. <param name="rowSplit">Vertical position of split.</param>
  40228. </member>
  40229. <member name="M:NPOI.SS.UserModel.ISheet.CreateSplitPane(System.Int32,System.Int32,System.Int32,System.Int32,NPOI.SS.UserModel.PanePosition)">
  40230. <summary>
  40231. Creates a split pane. Any existing freezepane or split pane is overwritten.
  40232. </summary>
  40233. <param name="xSplitPos">Horizonatal position of split (in 1/20th of a point)</param>
  40234. <param name="ySplitPos">Vertical position of split (in 1/20th of a point)</param>
  40235. <param name="leftmostColumn">Left column visible in right pane</param>
  40236. <param name="topRow">Top row visible in bottom pane</param>
  40237. <param name="activePane">Active pane. One of: PANE_LOWER_RIGHT, PANE_UPPER_RIGHT, PANE_LOWER_LEFT, PANE_UPPER_LEFT</param>
  40238. @see #PANE_LOWER_LEFT
  40239. @see #PANE_LOWER_RIGHT
  40240. @see #PANE_UPPER_LEFT
  40241. @see #PANE_UPPER_RIGHT
  40242. </member>
  40243. <member name="P:NPOI.SS.UserModel.ISheet.PaneInformation">
  40244. <summary>
  40245. Returns the information regarding the currently configured pane (split or freeze)
  40246. </summary>
  40247. <value>if no pane configured returns <c>null</c> else return the pane information.</value>
  40248. </member>
  40249. <member name="P:NPOI.SS.UserModel.ISheet.DisplayGridlines">
  40250. <summary>
  40251. Returns if gridlines are displayed
  40252. </summary>
  40253. </member>
  40254. <member name="P:NPOI.SS.UserModel.ISheet.DisplayFormulas">
  40255. <summary>
  40256. Returns if formulas are displayed
  40257. </summary>
  40258. </member>
  40259. <member name="P:NPOI.SS.UserModel.ISheet.DisplayRowColHeadings">
  40260. <summary>
  40261. Returns if RowColHeadings are displayed.
  40262. </summary>
  40263. </member>
  40264. <member name="P:NPOI.SS.UserModel.ISheet.IsActive">
  40265. <summary>
  40266. Returns if RowColHeadings are displayed.
  40267. </summary>
  40268. </member>
  40269. <member name="M:NPOI.SS.UserModel.ISheet.IsRowBroken(System.Int32)">
  40270. <summary>
  40271. Determines if there is a page break at the indicated row
  40272. </summary>
  40273. <param name="row">The row.</param>
  40274. </member>
  40275. <member name="M:NPOI.SS.UserModel.ISheet.RemoveRowBreak(System.Int32)">
  40276. <summary>
  40277. Removes the page break at the indicated row
  40278. </summary>
  40279. <param name="row">The row index.</param>
  40280. </member>
  40281. <member name="P:NPOI.SS.UserModel.ISheet.RowBreaks">
  40282. <summary>
  40283. Retrieves all the horizontal page breaks
  40284. </summary>
  40285. <value>all the horizontal page breaks, or null if there are no row page breaks</value>
  40286. </member>
  40287. <member name="P:NPOI.SS.UserModel.ISheet.ColumnBreaks">
  40288. <summary>
  40289. Retrieves all the vertical page breaks
  40290. </summary>
  40291. <value>all the vertical page breaks, or null if there are no column page breaks.</value>
  40292. </member>
  40293. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCell(System.Int32,System.Int32)">
  40294. <summary>
  40295. Sets the active cell.
  40296. </summary>
  40297. <param name="row">The row.</param>
  40298. <param name="column">The column.</param>
  40299. </member>
  40300. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Int32,System.Int32,System.Int32,System.Int32)">
  40301. <summary>
  40302. Sets the active cell range.
  40303. </summary>
  40304. <param name="firstRow">The firstrow.</param>
  40305. <param name="lastRow">The lastrow.</param>
  40306. <param name="firstColumn">The firstcolumn.</param>
  40307. <param name="lastColumn">The lastcolumn.</param>
  40308. </member>
  40309. <member name="M:NPOI.SS.UserModel.ISheet.SetActiveCellRange(System.Collections.Generic.List{NPOI.SS.Util.CellRangeAddress8Bit},System.Int32,System.Int32,System.Int32)">
  40310. <summary>
  40311. Sets the active cell range.
  40312. </summary>
  40313. <param name="cellranges">The cellranges.</param>
  40314. <param name="activeRange">The index of the active range.</param>
  40315. <param name="activeRow">The active row in the active range</param>
  40316. <param name="activeColumn">The active column in the active range</param>
  40317. </member>
  40318. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnBreak(System.Int32)">
  40319. <summary>
  40320. Sets a page break at the indicated column
  40321. </summary>
  40322. <param name="column">The column.</param>
  40323. </member>
  40324. <member name="M:NPOI.SS.UserModel.ISheet.SetRowBreak(System.Int32)">
  40325. <summary>
  40326. Sets the row break.
  40327. </summary>
  40328. <param name="row">The row.</param>
  40329. </member>
  40330. <member name="M:NPOI.SS.UserModel.ISheet.IsColumnBroken(System.Int32)">
  40331. <summary>
  40332. Determines if there is a page break at the indicated column
  40333. </summary>
  40334. <param name="column">The column index.</param>
  40335. </member>
  40336. <member name="M:NPOI.SS.UserModel.ISheet.RemoveColumnBreak(System.Int32)">
  40337. <summary>
  40338. Removes a page break at the indicated column
  40339. </summary>
  40340. <param name="column">The column.</param>
  40341. </member>
  40342. <member name="M:NPOI.SS.UserModel.ISheet.SetColumnGroupCollapsed(System.Int32,System.Boolean)">
  40343. <summary>
  40344. Expands or collapses a column group.
  40345. </summary>
  40346. <param name="columnNumber">One of the columns in the group.</param>
  40347. <param name="collapsed">if set to <c>true</c>collapse group.<c>false</c>expand group.</param>
  40348. </member>
  40349. <member name="M:NPOI.SS.UserModel.ISheet.GroupColumn(System.Int32,System.Int32)">
  40350. <summary>
  40351. Create an outline for the provided column range.
  40352. </summary>
  40353. <param name="fromColumn">beginning of the column range.</param>
  40354. <param name="toColumn">end of the column range.</param>
  40355. </member>
  40356. <member name="M:NPOI.SS.UserModel.ISheet.UngroupColumn(System.Int32,System.Int32)">
  40357. <summary>
  40358. Ungroup a range of columns that were previously groupped
  40359. </summary>
  40360. <param name="fromColumn">start column (0-based).</param>
  40361. <param name="toColumn">end column (0-based).</param>
  40362. </member>
  40363. <member name="M:NPOI.SS.UserModel.ISheet.GroupRow(System.Int32,System.Int32)">
  40364. <summary>
  40365. Tie a range of rows toGether so that they can be collapsed or expanded
  40366. </summary>
  40367. <param name="fromRow">start row (0-based)</param>
  40368. <param name="toRow">end row (0-based)</param>
  40369. </member>
  40370. <member name="M:NPOI.SS.UserModel.ISheet.UngroupRow(System.Int32,System.Int32)">
  40371. <summary>
  40372. Ungroup a range of rows that were previously groupped
  40373. </summary>
  40374. <param name="fromRow">start row (0-based)</param>
  40375. <param name="toRow">end row (0-based)</param>
  40376. </member>
  40377. <member name="M:NPOI.SS.UserModel.ISheet.SetRowGroupCollapsed(System.Int32,System.Boolean)">
  40378. <summary>
  40379. Set view state of a groupped range of rows
  40380. </summary>
  40381. <param name="row">start row of a groupped range of rows (0-based).</param>
  40382. <param name="collapse">whether to expand/collapse the detail rows.</param>
  40383. </member>
  40384. <member name="M:NPOI.SS.UserModel.ISheet.SetDefaultColumnStyle(System.Int32,NPOI.SS.UserModel.ICellStyle)">
  40385. <summary>
  40386. Sets the default column style for a given column. POI will only apply this style to new cells Added to the sheet.
  40387. </summary>
  40388. <param name="column">the column index</param>
  40389. <param name="style">the style to set</param>
  40390. </member>
  40391. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32)">
  40392. <summary>
  40393. Adjusts the column width to fit the contents.
  40394. </summary>
  40395. <param name="column">the column index</param>
  40396. <remarks>
  40397. This process can be relatively slow on large sheets, so this should
  40398. normally only be called once per column, at the end of your
  40399. processing.
  40400. </remarks>
  40401. </member>
  40402. <member name="M:NPOI.SS.UserModel.ISheet.AutoSizeColumn(System.Int32,System.Boolean)">
  40403. <summary>
  40404. Adjusts the column width to fit the contents.
  40405. </summary>
  40406. <param name="column">the column index.</param>
  40407. <param name="useMergedCells">whether to use the contents of merged cells when
  40408. calculating the width of the column. Default is to ignore merged cells.</param>
  40409. <remarks>
  40410. This process can be relatively slow on large sheets, so this should
  40411. normally only be called once per column, at the end of your
  40412. processing.
  40413. </remarks>
  40414. </member>
  40415. <member name="M:NPOI.SS.UserModel.ISheet.GetCellComment(System.Int32,System.Int32)">
  40416. <summary>
  40417. Returns cell comment for the specified row and column
  40418. </summary>
  40419. <param name="row">The row.</param>
  40420. <param name="column">The column.</param>
  40421. </member>
  40422. <member name="M:NPOI.SS.UserModel.ISheet.CreateDrawingPatriarch">
  40423. <summary>
  40424. Creates the top-level drawing patriarch.
  40425. </summary>
  40426. </member>
  40427. <member name="P:NPOI.SS.UserModel.ISheet.Workbook">
  40428. <summary>
  40429. Gets the parent workbook.
  40430. </summary>
  40431. </member>
  40432. <member name="P:NPOI.SS.UserModel.ISheet.SheetName">
  40433. <summary>
  40434. Gets the name of the sheet.
  40435. </summary>
  40436. </member>
  40437. <member name="P:NPOI.SS.UserModel.ISheet.IsSelected">
  40438. <summary>
  40439. Gets or sets a value indicating whether this sheet is currently selected.
  40440. </summary>
  40441. </member>
  40442. <member name="M:NPOI.SS.UserModel.ISheet.SetActive(System.Boolean)">
  40443. <summary>
  40444. Sets whether sheet is selected.
  40445. </summary>
  40446. <param name="value">Whether to select the sheet or deselect the sheet.</param>
  40447. </member>
  40448. <member name="M:NPOI.SS.UserModel.ISheet.SetArrayFormula(System.String,NPOI.SS.Util.CellRangeAddress)">
  40449. <summary>
  40450. Sets array formula to specified region for result.
  40451. </summary>
  40452. <param name="formula">text representation of the formula</param>
  40453. <param name="range">Region of array formula for result</param>
  40454. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  40455. </member>
  40456. <member name="M:NPOI.SS.UserModel.ISheet.RemoveArrayFormula(NPOI.SS.UserModel.ICell)">
  40457. <summary>
  40458. Remove a Array Formula from this sheet. All cells contained in the Array Formula range are removed as well
  40459. </summary>
  40460. <param name="cell">any cell within Array Formula range</param>
  40461. <returns>the <see cref="T:NPOI.SS.UserModel.ICellRange`1"/> of cells affected by this change</returns>
  40462. </member>
  40463. <member name="M:NPOI.SS.UserModel.ISheet.IsMergedRegion(NPOI.SS.Util.CellRangeAddress)">
  40464. <summary>
  40465. Checks if the provided region is part of the merged regions.
  40466. </summary>
  40467. <param name="mergedRegion">Region searched in the merged regions</param>
  40468. <returns><c>true</c>, when the region is contained in at least one of the merged regions</returns>
  40469. </member>
  40470. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidationHelper">
  40471. <summary>
  40472. Create an instance of a DataValidationHelper.
  40473. </summary>
  40474. <returns>Instance of a DataValidationHelper</returns>
  40475. </member>
  40476. <member name="M:NPOI.SS.UserModel.ISheet.GetDataValidations">
  40477. <summary>
  40478. Returns the list of DataValidation in the sheet.
  40479. </summary>
  40480. <returns>list of DataValidation in the sheet</returns>
  40481. </member>
  40482. <member name="M:NPOI.SS.UserModel.ISheet.AddValidationData(NPOI.SS.UserModel.IDataValidation)">
  40483. <summary>
  40484. Creates a data validation object
  40485. </summary>
  40486. <param name="dataValidation">The data validation object settings</param>
  40487. </member>
  40488. <member name="M:NPOI.SS.UserModel.ISheet.SetAutoFilter(NPOI.SS.Util.CellRangeAddress)">
  40489. <summary>
  40490. Enable filtering for a range of cells
  40491. </summary>
  40492. <param name="range">the range of cells to filter</param>
  40493. </member>
  40494. <member name="P:NPOI.SS.UserModel.ISheet.SheetConditionalFormatting">
  40495. <summary>
  40496. The 'Conditional Formatting' facet for this <c>Sheet</c>
  40497. </summary>
  40498. <returns>conditional formatting rule for this sheet</returns>
  40499. </member>
  40500. <member name="P:NPOI.SS.UserModel.ISheet.IsRightToLeft">
  40501. <summary>
  40502. Whether the text is displayed in right-to-left mode in the window
  40503. </summary>
  40504. </member>
  40505. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingRows">
  40506. <summary>
  40507. Get or set the repeating rows used when printing the sheet, as found in File->PageSetup->Sheet.
  40508. <p/>
  40509. Repeating rows cover a range of contiguous rows, e.g.:
  40510. <pre>
  40511. Sheet1!$1:$1
  40512. Sheet2!$5:$8
  40513. </pre>
  40514. The {@link CellRangeAddress} returned contains a column part which spans
  40515. all columns, and a row part which specifies the contiguous range of
  40516. repeating rows.
  40517. <p/>
  40518. If the Sheet does not have any repeating rows defined, null is returned.
  40519. </summary>
  40520. </member>
  40521. <member name="P:NPOI.SS.UserModel.ISheet.RepeatingColumns">
  40522. <summary>
  40523. Gets or set the repeating columns used when printing the sheet, as found in File->PageSetup->Sheet.
  40524. <p/>
  40525. Repeating columns cover a range of contiguous columns, e.g.:
  40526. <pre>
  40527. Sheet1!$A:$A
  40528. Sheet2!$C:$F
  40529. </pre>
  40530. The {@link CellRangeAddress} returned contains a row part which spans all
  40531. rows, and a column part which specifies the contiguous range of
  40532. repeating columns.
  40533. <p/>
  40534. If the Sheet does not have any repeating columns defined, null is
  40535. returned.
  40536. </summary>
  40537. </member>
  40538. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String)">
  40539. <summary>
  40540. Copy sheet with a new name
  40541. </summary>
  40542. <param name="Name">new sheet name</param>
  40543. <returns>cloned sheet</returns>
  40544. </member>
  40545. <member name="M:NPOI.SS.UserModel.ISheet.CopySheet(System.String,System.Boolean)">
  40546. <summary>
  40547. Copy sheet with a new name
  40548. </summary>
  40549. <param name="Name">new sheet name</param>
  40550. <param name="copyStyle">whether to copy styles</param>
  40551. <returns>cloned sheet</returns>
  40552. </member>
  40553. <member name="M:NPOI.SS.UserModel.ISheet.GetColumnOutlineLevel(System.Int32)">
  40554. <summary>
  40555. Returns the column outline level. Increased as you
  40556. put it into more groups (outlines), reduced as
  40557. you take it out of them.
  40558. </summary>
  40559. <param name="columnIndex"></param>
  40560. <returns></returns>
  40561. </member>
  40562. <member name="T:NPOI.SS.UserModel.ISheetConditionalFormatting">
  40563. The 'Conditional Formatting' facet of <c>Sheet</c>
  40564. @author Dmitriy Kumshayev
  40565. @author Yegor Kozlov
  40566. @since 3.8
  40567. </member>
  40568. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule)">
  40569. <summary>
  40570. Add a new Conditional Formatting to the sheet.
  40571. </summary>
  40572. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  40573. <param name="rule">the rule to apply</param>
  40574. <returns>index of the newly Created Conditional Formatting object</returns>
  40575. </member>
  40576. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule,NPOI.SS.UserModel.IConditionalFormattingRule)">
  40577. <summary>
  40578. Add a new Conditional Formatting consisting of two rules.
  40579. </summary>
  40580. <param name="regions"> list of rectangular regions to apply conditional formatting rules</param>
  40581. <param name="rule1">the first rule</param>
  40582. <param name="rule2">the second rule</param>
  40583. <returns>index of the newly Created Conditional Formatting object</returns>
  40584. </member>
  40585. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.Util.CellRangeAddress[],NPOI.SS.UserModel.IConditionalFormattingRule[])">
  40586. <summary>
  40587. Add a new Conditional Formatting Set to the sheet.
  40588. </summary>
  40589. <param name="regions">list of rectangular regions to apply conditional formatting rules</param>
  40590. <param name="cfRules">Set of up to three conditional formatting rules</param>
  40591. <returns>index of the newly Created Conditional Formatting object</returns>
  40592. </member>
  40593. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.AddConditionalFormatting(NPOI.SS.UserModel.IConditionalFormatting)">
  40594. <summary>
  40595. Adds a copy of a ConditionalFormatting object to the sheet
  40596. </summary>
  40597. <param name="cf">the Conditional Formatting to clone</param>
  40598. <returns>index of the new Conditional Formatting object</returns>
  40599. <remarks>
  40600. This method could be used to copy ConditionalFormatting object
  40601. from one sheet to another. For example:
  40602. ConditionalFormatting cf = sheet.GetConditionalFormattingAt(index);
  40603. newSheet.AddConditionalFormatting(cf);
  40604. </remarks>
  40605. </member>
  40606. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String,System.String)">
  40607. A factory method allowing to create a conditional formatting rule
  40608. with a cell comparison operator
  40609. <p>
  40610. The Created conditional formatting rule Compares a cell value
  40611. to a formula calculated result, using the specified operator.
  40612. The type of the Created condition is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}
  40613. </p>
  40614. @param comparisonOperation - MUST be a constant value from
  40615. <c>{@link ComparisonOperator}</c>: <p>
  40616. <ul>
  40617. <li>BETWEEN</li>
  40618. <li>NOT_BETWEEN</li>
  40619. <li>EQUAL</li>
  40620. <li>NOT_EQUAL</li>
  40621. <li>GT</li>
  40622. <li>LT</li>
  40623. <li>GE</li>
  40624. <li>LE</li>
  40625. </ul>
  40626. </p>
  40627. @param formula1 - formula for the valued, Compared with the cell
  40628. @param formula2 - second formula (only used with
  40629. {@link ComparisonOperator#BETWEEN}) and {@link ComparisonOperator#NOT_BETWEEN} operations)
  40630. </member>
  40631. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(NPOI.SS.UserModel.ComparisonOperator,System.String)">
  40632. <summary>
  40633. Create a conditional formatting rule that Compares a cell value to a formula calculated result, using an operator
  40634. </summary>
  40635. <param name="comparisonOperation">MUST be a constant value from ComparisonOperator except BETWEEN and NOT_BETWEEN</param>
  40636. <param name="formula">the formula to determine if the conditional formatting is applied</param>
  40637. <returns>a conditional formatting rule</returns>
  40638. </member>
  40639. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.CreateConditionalFormattingRule(System.String)">
  40640. <summary>
  40641. Create a conditional formatting rule based on a Boolean formula.
  40642. When the formula result is true, the cell is highlighted.
  40643. </summary>
  40644. <param name="formula">the formula to Evaluate. MUST be a Boolean function.</param>
  40645. <returns>conditional formatting rule</returns>
  40646. </member>
  40647. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.GetConditionalFormattingAt(System.Int32)">
  40648. <summary>
  40649. Gets Conditional Formatting object at a particular index
  40650. </summary>
  40651. <param name="index">0-based index of the Conditional Formatting object to fetch</param>
  40652. <returns>Conditional Formatting object or null if not found</returns>
  40653. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  40654. </member>
  40655. <member name="P:NPOI.SS.UserModel.ISheetConditionalFormatting.NumConditionalFormattings">
  40656. <summary>
  40657. get the number of conditional formats in this sheet
  40658. </summary>
  40659. </member>
  40660. <member name="M:NPOI.SS.UserModel.ISheetConditionalFormatting.RemoveConditionalFormatting(System.Int32)">
  40661. <summary>
  40662. Removes a Conditional Formatting object by index
  40663. </summary>
  40664. <param name="index">0-based index of the Conditional Formatting object to remove</param>
  40665. <exception cref="T:System.ArgumentException">throws ArgumentException if the index is outside of the allowable range (0 ... numberOfFormats-1)</exception>
  40666. </member>
  40667. <member name="P:NPOI.SS.UserModel.ITextbox.String">
  40668. @return the rich text string for this textbox.
  40669. </member>
  40670. <member name="P:NPOI.SS.UserModel.ITextbox.MarginLeft">
  40671. @return Returns the left margin within the textbox.
  40672. </member>
  40673. <member name="P:NPOI.SS.UserModel.ITextbox.MarginRight">
  40674. @return returns the right margin within the textbox.
  40675. </member>
  40676. <member name="P:NPOI.SS.UserModel.ITextbox.MarginTop">
  40677. @return returns the top margin within the textbox.
  40678. </member>
  40679. <member name="P:NPOI.SS.UserModel.ITextbox.MarginBottom">
  40680. s the bottom margin within the textbox.
  40681. </member>
  40682. <member name="T:NPOI.SS.UserModel.VerticalAlignment">
  40683. This enumeration value indicates the type of vertical alignment for a cell, i.e.,
  40684. whether it is aligned top, bottom, vertically centered, justified or distributed.
  40685. </member>
  40686. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Top">
  40687. The vertical alignment is aligned-to-top.
  40688. </member>
  40689. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Center">
  40690. The vertical alignment is centered across the height of the cell.
  40691. </member>
  40692. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Bottom">
  40693. The vertical alignment is aligned-to-bottom.
  40694. </member>
  40695. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Justify">
  40696. <p>
  40697. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  40698. where each line of text inside the cell is evenly distributed across the height of the cell,
  40699. with flush top and bottom margins.
  40700. </p>
  40701. <p>
  40702. When text direction is vertical: similar behavior as horizontal justification.
  40703. The alignment is justified (flush top and bottom in this case). For each line of text, each
  40704. line of the wrapped text in a cell is aligned to the top and bottom (except the last line).
  40705. If no single line of text wraps in the cell, then the text is not justified.
  40706. </p>
  40707. </member>
  40708. <member name="F:NPOI.SS.UserModel.VerticalAlignment.Distributed">
  40709. <p>
  40710. When text direction is horizontal: the vertical alignment of lines of text is distributed vertically,
  40711. where each line of text inside the cell is evenly distributed across the height of the cell,
  40712. with flush top
  40713. </p>
  40714. <p>
  40715. When text direction is vertical: behaves exactly as distributed horizontal alignment.
  40716. The first words in a line of text (appearing at the top of the cell) are flush
  40717. 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,
  40718. and the line of text is distributed evenly from top to bottom.
  40719. </p>
  40720. </member>
  40721. <member name="F:NPOI.SS.UserModel.SheetState.Visible">
  40722. <summary>
  40723. Indicates the sheet is visible.
  40724. </summary>
  40725. </member>
  40726. <member name="F:NPOI.SS.UserModel.SheetState.Hidden">
  40727. <summary>
  40728. Indicates the book window is hidden, but can be shown by the user via the user interface.
  40729. </summary>
  40730. </member>
  40731. <member name="F:NPOI.SS.UserModel.SheetState.VeryHidden">
  40732. <summary>
  40733. Indicates the sheet is hidden and cannot be shown in the user interface (UI).
  40734. </summary>
  40735. <remarks>
  40736. In Excel this state is only available programmatically in VBA:
  40737. ThisWorkbook.Sheets("MySheetName").Visible = xlSheetVeryHidden
  40738. </remarks>
  40739. </member>
  40740. <member name="T:NPOI.SS.UserModel.IWorkbook">
  40741. <summary>
  40742. High level interface of a Excel workbook. This is the first object most users
  40743. will construct whether they are reading or writing a workbook. It is also the
  40744. top level object for creating new sheets/etc.
  40745. This interface is shared between the implementation specific to xls and xlsx.
  40746. This way it is possible to access Excel workbooks stored in both formats.
  40747. </summary>
  40748. </member>
  40749. <member name="P:NPOI.SS.UserModel.IWorkbook.ActiveSheetIndex">
  40750. <summary>
  40751. get the active sheet. The active sheet is is the sheet
  40752. which is currently displayed when the workbook is viewed in Excel.
  40753. </summary>
  40754. </member>
  40755. <member name="P:NPOI.SS.UserModel.IWorkbook.FirstVisibleTab">
  40756. <summary>
  40757. Gets the first tab that is displayed in the list of tabs in excel.
  40758. </summary>
  40759. </member>
  40760. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetOrder(System.String,System.Int32)">
  40761. <summary>
  40762. Sets the order of appearance for a given sheet.
  40763. </summary>
  40764. <param name="sheetname">the name of the sheet to reorder</param>
  40765. <param name="pos">the position that we want to insert the sheet into (0 based)</param>
  40766. </member>
  40767. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSelectedTab(System.Int32)">
  40768. <summary>
  40769. Sets the tab whose data is actually seen when the sheet is opened.
  40770. This may be different from the "selected sheet" since excel seems to
  40771. allow you to show the data of one sheet when another is seen "selected"
  40772. in the tabs (at the bottom).
  40773. </summary>
  40774. <param name="index">the index of the sheet to select (0 based)</param>
  40775. </member>
  40776. <member name="M:NPOI.SS.UserModel.IWorkbook.SetActiveSheet(System.Int32)">
  40777. <summary>
  40778. set the active sheet. The active sheet is is the sheet
  40779. which is currently displayed when the workbook is viewed in Excel.
  40780. </summary>
  40781. <param name="sheetIndex">index of the active sheet (0-based)</param>
  40782. </member>
  40783. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetName(System.Int32)">
  40784. <summary>
  40785. Set the sheet name
  40786. </summary>
  40787. <param name="sheet">sheet number (0 based)</param>
  40788. <returns>Sheet name</returns>
  40789. </member>
  40790. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetName(System.Int32,System.String)">
  40791. <summary>
  40792. Set the sheet name.
  40793. </summary>
  40794. <param name="sheet">sheet number (0 based)</param>
  40795. <param name="name">sheet name</param>
  40796. </member>
  40797. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(System.String)">
  40798. <summary>
  40799. Returns the index of the sheet by its name
  40800. </summary>
  40801. <param name="name">the sheet name</param>
  40802. <returns>index of the sheet (0 based)</returns>
  40803. </member>
  40804. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetIndex(NPOI.SS.UserModel.ISheet)">
  40805. <summary>
  40806. Returns the index of the given sheet
  40807. </summary>
  40808. <param name="sheet">the sheet to look up</param>
  40809. <returns>index of the sheet (0 based)</returns>
  40810. </member>
  40811. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet">
  40812. <summary>
  40813. Sreate an Sheet for this Workbook, Adds it to the sheets and returns
  40814. the high level representation. Use this to create new sheets.
  40815. </summary>
  40816. <returns></returns>
  40817. </member>
  40818. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateSheet(System.String)">
  40819. <summary>
  40820. Create an Sheet for this Workbook, Adds it to the sheets and returns
  40821. the high level representation. Use this to create new sheets.
  40822. </summary>
  40823. <param name="sheetname">sheetname to set for the sheet.</param>
  40824. <returns>Sheet representing the new sheet.</returns>
  40825. </member>
  40826. <member name="M:NPOI.SS.UserModel.IWorkbook.CloneSheet(System.Int32)">
  40827. <summary>
  40828. Create an Sheet from an existing sheet in the Workbook.
  40829. </summary>
  40830. <param name="sheetNum"></param>
  40831. <returns></returns>
  40832. </member>
  40833. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfSheets">
  40834. <summary>
  40835. Get the number of spreadsheets in the workbook
  40836. </summary>
  40837. </member>
  40838. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheetAt(System.Int32)">
  40839. <summary>
  40840. Get the Sheet object at the given index.
  40841. </summary>
  40842. <param name="index">index of the sheet number (0-based physical &amp; logical)</param>
  40843. <returns>Sheet at the provided index</returns>
  40844. </member>
  40845. <member name="M:NPOI.SS.UserModel.IWorkbook.GetSheet(System.String)">
  40846. <summary>
  40847. Get sheet with the given name
  40848. </summary>
  40849. <param name="name">name of the sheet</param>
  40850. <returns>Sheet with the name provided or null if it does not exist</returns>
  40851. </member>
  40852. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveSheetAt(System.Int32)">
  40853. <summary>
  40854. Removes sheet at the given index
  40855. </summary>
  40856. <param name="index"></param>
  40857. </member>
  40858. <member name="M:NPOI.SS.UserModel.IWorkbook.GetEnumerator">
  40859. <summary>
  40860. Enumerate sheets
  40861. </summary>
  40862. <returns></returns>
  40863. </member>
  40864. <member name="M:NPOI.SS.UserModel.IWorkbook.SetRepeatingRowsAndColumns(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  40865. To set just repeating columns:
  40866. workbook.SetRepeatingRowsAndColumns(0,0,1,-1-1);
  40867. To set just repeating rows:
  40868. workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
  40869. To remove all repeating rows and columns for a sheet.
  40870. workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
  40871. <summary>
  40872. Sets the repeating rows and columns for a sheet (as found in
  40873. File->PageSetup->Sheet). This is function is included in the workbook
  40874. because it Creates/modifies name records which are stored at the
  40875. workbook level.
  40876. </summary>
  40877. <param name="sheetIndex">0 based index to sheet.</param>
  40878. <param name="startColumn">0 based start of repeating columns.</param>
  40879. <param name="endColumn">0 based end of repeating columns.</param>
  40880. <param name="startRow">0 based start of repeating rows.</param>
  40881. <param name="endRow">0 based end of repeating rows.</param>
  40882. </member>
  40883. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateFont">
  40884. <summary>
  40885. Create a new Font and add it to the workbook's font table
  40886. </summary>
  40887. <returns></returns>
  40888. </member>
  40889. <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)">
  40890. <summary>
  40891. Finds a font that matches the one with the supplied attributes
  40892. </summary>
  40893. <param name="boldWeight"></param>
  40894. <param name="color"></param>
  40895. <param name="fontHeight"></param>
  40896. <param name="name"></param>
  40897. <param name="italic"></param>
  40898. <param name="strikeout"></param>
  40899. <param name="typeOffset"></param>
  40900. <param name="underline"></param>
  40901. <returns>the font with the matched attributes or null</returns>
  40902. </member>
  40903. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfFonts">
  40904. <summary>
  40905. Get the number of fonts in the font table
  40906. </summary>
  40907. </member>
  40908. <member name="M:NPOI.SS.UserModel.IWorkbook.GetFontAt(System.Int16)">
  40909. <summary>
  40910. Get the font at the given index number
  40911. </summary>
  40912. <param name="idx">index number (0-based)</param>
  40913. <returns>font at the index</returns>
  40914. </member>
  40915. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateCellStyle">
  40916. <summary>
  40917. Create a new Cell style and add it to the workbook's style table
  40918. </summary>
  40919. <returns>the new Cell Style object</returns>
  40920. </member>
  40921. <member name="P:NPOI.SS.UserModel.IWorkbook.NumCellStyles">
  40922. <summary>
  40923. Get the number of styles the workbook Contains
  40924. </summary>
  40925. </member>
  40926. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCellStyleAt(System.Int16)">
  40927. <summary>
  40928. Get the cell style object at the given index
  40929. </summary>
  40930. <param name="idx">index within the set of styles (0-based)</param>
  40931. <returns>CellStyle object at the index</returns>
  40932. </member>
  40933. <member name="M:NPOI.SS.UserModel.IWorkbook.Write(System.IO.Stream)">
  40934. <summary>
  40935. Write out this workbook to an OutPutstream.
  40936. </summary>
  40937. <param name="stream">the stream you wish to write to</param>
  40938. </member>
  40939. <member name="P:NPOI.SS.UserModel.IWorkbook.NumberOfNames">
  40940. <summary>
  40941. the total number of defined names in this workbook
  40942. </summary>
  40943. </member>
  40944. <member name="M:NPOI.SS.UserModel.IWorkbook.GetName(System.String)">
  40945. <summary>
  40946. the defined name with the specified name.
  40947. </summary>
  40948. <param name="name">the name of the defined name</param>
  40949. <returns>the defined name with the specified name. null if not found</returns>
  40950. </member>
  40951. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameAt(System.Int32)">
  40952. <summary>
  40953. the defined name at the specified index
  40954. </summary>
  40955. <param name="nameIndex">position of the named range (0-based)</param>
  40956. <returns></returns>
  40957. </member>
  40958. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateName">
  40959. <summary>
  40960. Creates a new (unInitialised) defined name in this workbook
  40961. </summary>
  40962. <returns>new defined name object</returns>
  40963. </member>
  40964. <member name="M:NPOI.SS.UserModel.IWorkbook.GetNameIndex(System.String)">
  40965. <summary>
  40966. Gets the defined name index by name
  40967. </summary>
  40968. <param name="name">the name of the defined name</param>
  40969. <returns>zero based index of the defined name.</returns>
  40970. </member>
  40971. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.Int32)">
  40972. <summary>
  40973. Remove the defined name at the specified index
  40974. </summary>
  40975. <param name="index">named range index (0 based)</param>
  40976. </member>
  40977. <member name="M:NPOI.SS.UserModel.IWorkbook.RemoveName(System.String)">
  40978. <summary>
  40979. Remove a defined name by name
  40980. </summary>
  40981. <param name="name">the name of the defined name</param>
  40982. </member>
  40983. <member name="M:NPOI.SS.UserModel.IWorkbook.LinkExternalWorkbook(System.String,NPOI.SS.UserModel.IWorkbook)">
  40984. <summary>
  40985. Adds the linking required to allow formulas referencing the specified
  40986. external workbook to be added to this one. In order for formulas
  40987. such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the file,
  40988. some linking information must first be recorded. Once a given external
  40989. workbook has been linked, then formulas using it can added. Each workbook
  40990. needs linking only once. <br/>
  40991. This linking only applies for writing formulas.
  40992. To link things for evaluation, see {@link FormulaEvaluator#setupReferencedWorkbooks(java.util.Map)}
  40993. </summary>
  40994. <param name="name">The name the workbook will be referenced as in formulas</param>
  40995. <param name="workbook">The open workbook to fetch the link required information from</param>
  40996. <returns></returns>
  40997. </member>
  40998. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.String)">
  40999. <summary>
  41000. Sets the printarea for the sheet provided
  41001. </summary>
  41002. <param name="sheetIndex">Zero-based sheet index</param>
  41003. <param name="reference">Valid name Reference for the Print Area</param>
  41004. </member>
  41005. <member name="M:NPOI.SS.UserModel.IWorkbook.SetPrintArea(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
  41006. <summary>
  41007. Sets the printarea for the sheet provided
  41008. </summary>
  41009. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  41010. <param name="startColumn">Column to begin printarea</param>
  41011. <param name="endColumn">Column to end the printarea</param>
  41012. <param name="startRow">Row to begin the printarea</param>
  41013. <param name="endRow">Row to end the printarea</param>
  41014. </member>
  41015. <member name="M:NPOI.SS.UserModel.IWorkbook.GetPrintArea(System.Int32)">
  41016. <summary>
  41017. Retrieves the reference for the printarea of the specified sheet,
  41018. the sheet name is Appended to the reference even if it was not specified.
  41019. </summary>
  41020. <param name="sheetIndex">Zero-based sheet index</param>
  41021. <returns>Null if no print area has been defined</returns>
  41022. </member>
  41023. <member name="M:NPOI.SS.UserModel.IWorkbook.RemovePrintArea(System.Int32)">
  41024. <summary>
  41025. Delete the printarea for the sheet specified
  41026. </summary>
  41027. <param name="sheetIndex">Zero-based sheet index (0 = First Sheet)</param>
  41028. </member>
  41029. <member name="P:NPOI.SS.UserModel.IWorkbook.MissingCellPolicy">
  41030. <summary>
  41031. Retrieves the current policy on what to do when getting missing or blank cells from a row.
  41032. </summary>
  41033. </member>
  41034. <member name="M:NPOI.SS.UserModel.IWorkbook.CreateDataFormat">
  41035. <summary>
  41036. Returns the instance of DataFormat for this workbook.
  41037. </summary>
  41038. <returns>the DataFormat object</returns>
  41039. </member>
  41040. <member name="M:NPOI.SS.UserModel.IWorkbook.AddPicture(System.Byte[],NPOI.SS.UserModel.PictureType)">
  41041. <summary>
  41042. Adds a picture to the workbook.
  41043. </summary>
  41044. <param name="pictureData">The bytes of the picture</param>
  41045. <param name="format">The format of the picture.</param>
  41046. <returns>the index to this picture (1 based).</returns>
  41047. </member>
  41048. <member name="M:NPOI.SS.UserModel.IWorkbook.GetAllPictures">
  41049. <summary>
  41050. Gets all pictures from the Workbook.
  41051. </summary>
  41052. <returns>the list of pictures (a list of link PictureData objects.)</returns>
  41053. </member>
  41054. <member name="M:NPOI.SS.UserModel.IWorkbook.GetCreationHelper">
  41055. <summary>
  41056. Return an object that handles instantiating concrete classes of
  41057. the various instances one needs for HSSF and XSSF.
  41058. </summary>
  41059. <returns></returns>
  41060. </member>
  41061. <member name="P:NPOI.SS.UserModel.IWorkbook.IsHidden">
  41062. <summary>
  41063. if this workbook is not visible in the GUI
  41064. </summary>
  41065. </member>
  41066. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetHidden(System.Int32)">
  41067. <summary>
  41068. Check whether a sheet is hidden.
  41069. </summary>
  41070. <param name="sheetIx">number of sheet</param>
  41071. <returns>true if sheet is hidden</returns>
  41072. </member>
  41073. <member name="M:NPOI.SS.UserModel.IWorkbook.IsSheetVeryHidden(System.Int32)">
  41074. Check whether a sheet is very hidden.
  41075. <p>
  41076. This is different from the normal hidden status
  41077. ({@link #isSheetHidden(int)})
  41078. </p>
  41079. @param sheetIx sheet index to check
  41080. @return <code>true</code> if sheet is very hidden
  41081. </member>
  41082. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,NPOI.SS.UserModel.SheetState)">
  41083. Hide or unhide a sheet
  41084. @param sheetIx the sheet index (0-based)
  41085. @param hidden True to mark the sheet as hidden, false otherwise
  41086. </member>
  41087. <member name="M:NPOI.SS.UserModel.IWorkbook.SetSheetHidden(System.Int32,System.Int32)">
  41088. Hide or unhide a sheet.
  41089. <pre>
  41090. 0 = not hidden
  41091. 1 = hidden
  41092. 2 = very hidden.
  41093. </pre>
  41094. @param sheetIx The sheet number
  41095. @param hidden 0 for not hidden, 1 for hidden, 2 for very hidden
  41096. </member>
  41097. <member name="M:NPOI.SS.UserModel.IWorkbook.AddToolPack(NPOI.SS.Formula.Udf.UDFFinder)">
  41098. <summary>
  41099. Register a new toolpack in this workbook.
  41100. </summary>
  41101. <param name="toopack">the toolpack to register</param>
  41102. </member>
  41103. <member name="F:NPOI.SS.Util.AreaReference.SHEET_NAME_DELIMITER">
  41104. The Char (!) that Separates sheet names from cell references
  41105. </member>
  41106. <member name="F:NPOI.SS.Util.AreaReference.CELL_DELIMITER">
  41107. The Char (:) that Separates the two cell references in a multi-cell area reference
  41108. </member>
  41109. <member name="F:NPOI.SS.Util.AreaReference.SPECIAL_NAME_DELIMITER">
  41110. The Char (') used to quote sheet names when they contain special Chars
  41111. </member>
  41112. <member name="M:NPOI.SS.Util.AreaReference.#ctor(System.String)">
  41113. Create an area ref from a string representation. Sheet names containing special Chars should be
  41114. delimited and escaped as per normal syntax rules for formulas.<br/>
  41115. The area reference must be contiguous (i.e. represent a single rectangle, not a Union of rectangles)
  41116. </member>
  41117. <member name="M:NPOI.SS.Util.AreaReference.#ctor(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  41118. Creates an area ref from a pair of Cell References.
  41119. </member>
  41120. <member name="M:NPOI.SS.Util.AreaReference.IsContiguous(System.String)">
  41121. is the reference for a contiguous (i.e.
  41122. Unbroken) area, or is it made up of
  41123. several different parts?
  41124. (If it Is, you will need to call
  41125. ....
  41126. </member>
  41127. <member name="M:NPOI.SS.Util.AreaReference.IsWholeColumnReference(NPOI.SS.Util.CellReference,NPOI.SS.Util.CellReference)">
  41128. is the reference for a whole-column reference,
  41129. such as C:C or D:G ?
  41130. </member>
  41131. <member name="M:NPOI.SS.Util.AreaReference.GenerateContiguous(System.String)">
  41132. Takes a non-contiguous area reference, and
  41133. returns an array of contiguous area references.
  41134. </member>
  41135. <member name="P:NPOI.SS.Util.AreaReference.IsSingleCell">
  41136. @return <c>false</c> if this area reference involves more than one cell
  41137. </member>
  41138. <member name="P:NPOI.SS.Util.AreaReference.FirstCell">
  41139. @return the first cell reference which defines this area. Usually this cell is in the upper
  41140. left corner of the area (but this is not a requirement).
  41141. </member>
  41142. <member name="P:NPOI.SS.Util.AreaReference.LastCell">
  41143. Note - if this area reference refers to a single cell, the return value of this method will
  41144. be identical to that of <c>GetFirstCell()</c>
  41145. @return the second cell reference which defines this area. For multi-cell areas, this is
  41146. cell diagonally opposite the 'first cell'. Usually this cell is in the lower right corner
  41147. of the area (but this is not a requirement).
  41148. </member>
  41149. <member name="M:NPOI.SS.Util.AreaReference.GetAllReferencedCells">
  41150. Returns a reference to every cell covered by this area
  41151. </member>
  41152. <member name="M:NPOI.SS.Util.AreaReference.FormatAsString">
  41153. Example return values:
  41154. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  41155. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  41156. <tr><td>A1:A1</td><td>Single cell area reference without sheet</td></tr>
  41157. <tr><td>A1:$C$1</td><td>Multi-cell area reference without sheet</td></tr>
  41158. <tr><td>Sheet1!A$1:B4</td><td>Standard sheet name</td></tr>
  41159. <tr><td>'O''Brien''s Sales'!B5:C6' </td><td>Sheet name with special Chars</td></tr>
  41160. </table>
  41161. @return the text representation of this area reference as it would appear in a formula.
  41162. </member>
  41163. <member name="M:NPOI.SS.Util.AreaReference.SeparateAreaRefs(System.String)">
  41164. Separates Area refs in two parts and returns them as Separate elements in a String array,
  41165. each qualified with the sheet name (if present)
  41166. @return array with one or two elements. never <c>null</c>
  41167. </member>
  41168. <member name="M:NPOI.SS.Util.CellRangeAddress.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  41169. Creates new cell range. Indexes are zero-based.
  41170. @param firstRow Index of first row
  41171. @param lastRow Index of last row (inclusive), must be equal to or larger than {@code firstRow}
  41172. @param firstCol Index of first column
  41173. @param lastCol Index of last column (inclusive), must be equal to or larger than {@code firstCol}
  41174. </member>
  41175. <member name="M:NPOI.SS.Util.CellRangeAddress.FormatAsString(System.String,System.Boolean)">
  41176. @return the text format of this range using specified sheet name.
  41177. </member>
  41178. <member name="M:NPOI.SS.Util.CellRangeAddress.ValueOf(System.String)">
  41179. <summary>
  41180. Creates a CellRangeAddress from a cell range reference string.
  41181. </summary>
  41182. <param name="reference">
  41183. usually a standard area ref (e.g. "B1:D8"). May be a single
  41184. cell ref (e.g. "B5") in which case the result is a 1 x 1 cell
  41185. range. May also be a whole row range (e.g. "3:5"), or a whole
  41186. column range (e.g. "C:F")
  41187. </param>
  41188. <returns>a CellRangeAddress object</returns>
  41189. </member>
  41190. <member name="T:NPOI.SS.Util.CellRangeAddressBase">
  41191. See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'<p/>
  41192. Common subclass of 8-bit and 16-bit versions
  41193. @author Josh Micich
  41194. </member>
  41195. <member name="M:NPOI.SS.Util.CellRangeAddressBase.Validate(NPOI.SS.SpreadsheetVersion)">
  41196. Validate the range limits against the supplied version of Excel
  41197. @param ssVersion the version of Excel to validate against
  41198. @throws IllegalArgumentException if the range limits are outside of the allowed range
  41199. </member>
  41200. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateRow(System.Int32,NPOI.SS.SpreadsheetVersion)">
  41201. Runs a bounds check for row numbers
  41202. @param row
  41203. </member>
  41204. <member name="M:NPOI.SS.Util.CellRangeAddressBase.ValidateColumn(System.Int32,NPOI.SS.SpreadsheetVersion)">
  41205. Runs a bounds check for column numbers
  41206. @param column
  41207. </member>
  41208. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstColumn">
  41209. @return column number for the upper left hand corner
  41210. </member>
  41211. <member name="P:NPOI.SS.Util.CellRangeAddressBase.FirstRow">
  41212. @return row number for the upper left hand corner
  41213. </member>
  41214. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastColumn">
  41215. @return column number for the lower right hand corner
  41216. </member>
  41217. <member name="P:NPOI.SS.Util.CellRangeAddressBase.LastRow">
  41218. @return row number for the lower right hand corner
  41219. </member>
  41220. <member name="P:NPOI.SS.Util.CellRangeAddressBase.NumberOfCells">
  41221. @return the size of the range (number of cells in the area).
  41222. </member>
  41223. <member name="F:NPOI.SS.Util.CellRangeAddressList._list">
  41224. List of <c>CellRangeAddress</c>es. Each structure represents a cell range
  41225. </member>
  41226. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)">
  41227. Convenience constructor for creating a <c>CellRangeAddressList</c> with a single
  41228. <c>CellRangeAddress</c>. Other <c>CellRangeAddress</c>es may be Added later.
  41229. </member>
  41230. <member name="M:NPOI.SS.Util.CellRangeAddressList.#ctor(NPOI.HSSF.Record.RecordInputStream)">
  41231. @param in the RecordInputstream to read the record from
  41232. </member>
  41233. <member name="M:NPOI.SS.Util.CellRangeAddressList.CountRanges">
  41234. Get the number of following ADDR structures. The number of this
  41235. structures is automatically set when reading an Excel file and/or
  41236. increased when you manually Add a new ADDR structure . This is the reason
  41237. there isn't a set method for this field .
  41238. @return number of ADDR structures
  41239. </member>
  41240. <member name="M:NPOI.SS.Util.CellRangeAddressList.AddCellRangeAddress(System.Int32,System.Int32,System.Int32,System.Int32)">
  41241. Add a cell range structure.
  41242. @param firstRow - the upper left hand corner's row
  41243. @param firstCol - the upper left hand corner's col
  41244. @param lastRow - the lower right hand corner's row
  41245. @param lastCol - the lower right hand corner's col
  41246. @return the index of this ADDR structure
  41247. </member>
  41248. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetCellRangeAddress(System.Int32)">
  41249. @return <c>CellRangeAddress</c> at the given index
  41250. </member>
  41251. <member name="M:NPOI.SS.Util.CellRangeAddressList.GetEncodedSize(System.Int32)">
  41252. @return the total size of for the specified number of ranges,
  41253. including the initial 2 byte range count
  41254. </member>
  41255. <member name="F:NPOI.SS.Util.NameType.None">
  41256. <summary>
  41257. Allow accessing the Initial value.
  41258. </summary>
  41259. </member>
  41260. <member name="T:NPOI.SS.Util.CellReference">
  41261. @author Avik Sengupta
  41262. @author Dennis doubleday (patch to seperateRowColumns())
  41263. </member>
  41264. <member name="F:NPOI.SS.Util.CellReference.ABSOLUTE_REFERENCE_MARKER">
  41265. The character ($) that signifies a row or column value is absolute instead of relative
  41266. </member>
  41267. <member name="F:NPOI.SS.Util.CellReference.SHEET_NAME_DELIMITER">
  41268. The character (!) that Separates sheet names from cell references
  41269. </member>
  41270. <member name="F:NPOI.SS.Util.CellReference.SPECIAL_NAME_DELIMITER">
  41271. The character (') used to quote sheet names when they contain special characters
  41272. </member>
  41273. <member name="F:NPOI.SS.Util.CellReference.CELL_REF_PATTERN">
  41274. Matches a run of one or more letters followed by a run of one or more digits.
  41275. The run of letters is group 1 and the run of digits is group 2.
  41276. Each group may optionally be prefixed with a single '$'.
  41277. </member>
  41278. <member name="F:NPOI.SS.Util.CellReference.COLUMN_REF_PATTERN">
  41279. Matches a run of one or more letters. The run of letters is group 1.
  41280. The text may optionally be prefixed with a single '$'.
  41281. </member>
  41282. <member name="F:NPOI.SS.Util.CellReference.ROW_REF_PATTERN">
  41283. Matches a run of one or more digits. The run of digits is group 1.
  41284. The text may optionally be prefixed with a single '$'.
  41285. </member>
  41286. <member name="F:NPOI.SS.Util.CellReference.NAMED_RANGE_NAME_PATTERN">
  41287. Named range names must start with a letter or underscore. Subsequent characters may include
  41288. digits or dot. (They can even end in dot).
  41289. </member>
  41290. <member name="M:NPOI.SS.Util.CellReference.#ctor(System.String)">
  41291. Create an cell ref from a string representation. Sheet names containing special characters should be
  41292. delimited and escaped as per normal syntax rules for formulas.
  41293. </member>
  41294. <member name="P:NPOI.SS.Util.CellReference.SheetName">
  41295. @return possibly <c>null</c> if this is a 2D reference. Special characters are not
  41296. escaped or delimited
  41297. </member>
  41298. <member name="M:NPOI.SS.Util.CellReference.ConvertColStringToIndex(System.String)">
  41299. takes in a column reference portion of a CellRef and converts it from
  41300. ALPHA-26 number format to 0-based base 10.
  41301. 'A' -> 0
  41302. 'Z' -> 25
  41303. 'AA' -> 26
  41304. 'IV' -> 255
  41305. @return zero based column index
  41306. </member>
  41307. <member name="M:NPOI.SS.Util.CellReference.ConvertNumToColString(System.Int32)">
  41308. Takes in a 0-based base-10 column and returns a ALPHA-26
  41309. representation.
  41310. eg column #3 -> D
  41311. </member>
  41312. <member name="M:NPOI.SS.Util.CellReference.SeparateRefParts(System.String)">
  41313. Separates the row from the columns and returns an array of three Strings. The first element
  41314. is the sheet name. Only the first element may be null. The second element in is the column
  41315. name still in ALPHA-26 number format. The third element is the row.
  41316. </member>
  41317. <member name="M:NPOI.SS.Util.CellReference.FormatAsString">
  41318. Example return values:
  41319. <table border="0" cellpAdding="1" cellspacing="0" summary="Example return values">
  41320. <tr><th align='left'>Result</th><th align='left'>Comment</th></tr>
  41321. <tr><td>A1</td><td>Cell reference without sheet</td></tr>
  41322. <tr><td>Sheet1!A1</td><td>Standard sheet name</td></tr>
  41323. <tr><td>'O''Brien''s Sales'!A1'</td><td>Sheet name with special characters</td></tr>
  41324. </table>
  41325. @return the text representation of this cell reference as it would appear in a formula.
  41326. </member>
  41327. <member name="P:NPOI.SS.Util.CellReference.CellRefParts">
  41328. Returns the three parts of the cell reference, the
  41329. Sheet name (or null if none supplied), the 1 based
  41330. row number, and the A based column letter.
  41331. This will not include any markers for absolute
  41332. references, so use {@link #formatAsString()}
  41333. to properly turn references into strings.
  41334. </member>
  41335. <member name="M:NPOI.SS.Util.CellReference.AppendCellReference(System.Text.StringBuilder)">
  41336. Appends cell reference with '$' markers for absolute values as required.
  41337. Sheet name is not included.
  41338. </member>
  41339. <member name="M:NPOI.SS.Util.CellReference.CellReferenceIsWithinRange(System.String,System.String,NPOI.SS.SpreadsheetVersion)">
  41340. Used to decide whether a name of the form "[A-Z]*[0-9]*" that appears in a formula can be
  41341. interpreted as a cell reference. Names of that form can be also used for sheets and/or
  41342. named ranges, and in those circumstances, the question of whether the potential cell
  41343. reference is valid (in range) becomes important.
  41344. <p/>
  41345. Note - that the maximum sheet size varies across Excel versions:
  41346. <p/>
  41347. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  41348. summary="Notable cases.">
  41349. <tr><th>Version </th><th>File Format </th>
  41350. <th>Last Column </th><th>Last Row</th></tr>
  41351. <tr><td>97-2003</td><td>BIFF8</td><td>"IV" (2^8)</td><td>65536 (2^14)</td></tr>
  41352. <tr><td>2007</td><td>BIFF12</td><td>"XFD" (2^14)</td><td>1048576 (2^20)</td></tr>
  41353. </table></blockquote>
  41354. POI currently targets BIFF8 (Excel 97-2003), so the following behaviour can be observed for
  41355. this method:
  41356. <blockquote><table border="0" cellpadding="1" cellspacing="0"
  41357. summary="Notable cases.">
  41358. <tr><th>Input </th>
  41359. <th>Result </th></tr>
  41360. <tr><td>"A", "1"</td><td>true</td></tr>
  41361. <tr><td>"a", "111"</td><td>true</td></tr>
  41362. <tr><td>"A", "65536"</td><td>true</td></tr>
  41363. <tr><td>"A", "65537"</td><td>false</td></tr>
  41364. <tr><td>"iv", "1"</td><td>true</td></tr>
  41365. <tr><td>"IW", "1"</td><td>false</td></tr>
  41366. <tr><td>"AAA", "1"</td><td>false</td></tr>
  41367. <tr><td>"a", "111"</td><td>true</td></tr>
  41368. <tr><td>"Sheet", "1"</td><td>false</td></tr>
  41369. </table></blockquote>
  41370. @param colStr a string of only letter characters
  41371. @param rowStr a string of only digit characters
  41372. @return <c>true</c> if the row and col parameters are within range of a BIFF8 spreadsheet.
  41373. </member>
  41374. <member name="T:NPOI.SS.Util.CellUtil">
  41375. Various utility functions that make working with a cells and rows easier. The various methods
  41376. that deal with style's allow you to create your CellStyles as you need them. When you apply a
  41377. style change to a cell, the code will attempt to see if a style already exists that meets your
  41378. needs. If not, then it will create a new style. This is to prevent creating too many styles.
  41379. there is an upper limit in Excel on the number of styles that can be supported.
  41380. @author Eric Pugh epugh@upstate.com
  41381. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  41382. </member>
  41383. <member name="M:NPOI.SS.Util.CellUtil.GetRow(System.Int32,NPOI.SS.UserModel.ISheet)">
  41384. Get a row from the spreadsheet, and create it if it doesn't exist.
  41385. @param rowIndex The 0 based row number
  41386. @param sheet The sheet that the row is part of.
  41387. @return The row indicated by the rowCounter
  41388. </member>
  41389. <member name="M:NPOI.SS.Util.CellUtil.GetCell(NPOI.SS.UserModel.IRow,System.Int32)">
  41390. Get a specific cell from a row. If the cell doesn't exist, then create it.
  41391. @param row The row that the cell is part of
  41392. @param columnIndex The column index that the cell is in.
  41393. @return The cell indicated by the column.
  41394. </member>
  41395. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String,NPOI.SS.UserModel.ICellStyle)">
  41396. Creates a cell, gives it a value, and applies a style if provided
  41397. @param row the row to create the cell in
  41398. @param column the column index to create the cell in
  41399. @param value The value of the cell
  41400. @param style If the style is not null, then set
  41401. @return A new Cell
  41402. </member>
  41403. <member name="M:NPOI.SS.Util.CellUtil.CreateCell(NPOI.SS.UserModel.IRow,System.Int32,System.String)">
  41404. Create a cell, and give it a value.
  41405. @param row the row to create the cell in
  41406. @param column the column index to create the cell in
  41407. @param value The value of the cell
  41408. @return A new Cell.
  41409. </member>
  41410. <member name="M:NPOI.SS.Util.CellUtil.SetAlignment(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.Int16)">
  41411. Take a cell, and align it.
  41412. @param cell the cell to set the alignment for
  41413. @param workbook The workbook that is being worked with.
  41414. @param align the column alignment to use.
  41415. @see CellStyle for alignment options
  41416. </member>
  41417. <member name="M:NPOI.SS.Util.CellUtil.SetFont(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,NPOI.SS.UserModel.IFont)">
  41418. Take a cell, and apply a font to it
  41419. @param cell the cell to set the alignment for
  41420. @param workbook The workbook that is being worked with.
  41421. @param font The Font that you want to set...
  41422. </member>
  41423. <member name="M:NPOI.SS.Util.CellUtil.SetCellStyleProperty(NPOI.SS.UserModel.ICell,NPOI.SS.UserModel.IWorkbook,System.String,System.Object)">
  41424. This method attempt to find an already existing CellStyle that matches what you want the
  41425. style to be. If it does not find the style, then it creates a new one. If it does create a
  41426. new one, then it applies the propertyName and propertyValue to the style. This is necessary
  41427. because Excel has an upper limit on the number of Styles that it supports.
  41428. @param workbook The workbook that is being worked with.
  41429. @param propertyName The name of the property that is to be changed.
  41430. @param propertyValue The value of the property that is to be changed.
  41431. @param cell The cell that needs it's style changes
  41432. </member>
  41433. <member name="M:NPOI.SS.Util.CellUtil.GetFormatProperties(NPOI.SS.UserModel.ICellStyle)">
  41434. Returns a map containing the format properties of the given cell style.
  41435. @param style cell style
  41436. @return map of format properties (String -> Object)
  41437. @see #setFormatProperties(org.apache.poi.ss.usermodel.CellStyle, org.apache.poi.ss.usermodel.Workbook, java.util.Map)
  41438. </member>
  41439. <member name="M:NPOI.SS.Util.CellUtil.SetFormatProperties(NPOI.SS.UserModel.ICellStyle,NPOI.SS.UserModel.IWorkbook,System.Collections.Generic.Dictionary{System.String,System.Object})">
  41440. Sets the format properties of the given style based on the given map.
  41441. @param style cell style
  41442. @param workbook parent workbook
  41443. @param properties map of format properties (String -> Object)
  41444. @see #getFormatProperties(CellStyle)
  41445. </member>
  41446. <member name="M:NPOI.SS.Util.CellUtil.GetShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  41447. Utility method that returns the named short value form the given map.
  41448. @return zero if the property does not exist, or is not a {@link Short}.
  41449. @param properties map of named properties (String -> Object)
  41450. @param name property name
  41451. @return property value, or zero
  41452. </member>
  41453. <member name="M:NPOI.SS.Util.CellUtil.GetBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String)">
  41454. Utility method that returns the named boolean value form the given map.
  41455. @return false if the property does not exist, or is not a {@link Boolean}.
  41456. @param properties map of properties (String -> Object)
  41457. @param name property name
  41458. @return property value, or false
  41459. </member>
  41460. <member name="M:NPOI.SS.Util.CellUtil.PutShort(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Int16)">
  41461. Utility method that puts the named short value to the given map.
  41462. @param properties map of properties (String -> Object)
  41463. @param name property name
  41464. @param value property value
  41465. </member>
  41466. <member name="M:NPOI.SS.Util.CellUtil.PutBoolean(System.Collections.Generic.Dictionary{System.String,System.Object},System.String,System.Boolean)">
  41467. Utility method that puts the named boolean value to the given map.
  41468. @param properties map of properties (String -> Object)
  41469. @param name property name
  41470. @param value property value
  41471. </member>
  41472. <member name="M:NPOI.SS.Util.CellUtil.TranslateUnicodeValues(NPOI.SS.UserModel.ICell)">
  41473. Looks for text in the cell that should be unicode, like an alpha and provides the
  41474. unicode version of it.
  41475. @param cell The cell to check for unicode values
  41476. @return translated to unicode
  41477. </member>
  41478. <member name="T:NPOI.SS.Util.CellWalk.ICellHandler">
  41479. Represents callback for CellWalk traverse method.
  41480. @author Roman Kashitsyn
  41481. </member>
  41482. <member name="M:NPOI.SS.Util.CellWalk.ICellHandler.OnCell(NPOI.SS.UserModel.ICell,NPOI.SS.Util.CellWalk.ICellWalkContext)">
  41483. @param cell current cell
  41484. @param ctx information about invokation context
  41485. </member>
  41486. <member name="T:NPOI.SS.Util.CellWalk.CellWalk">
  41487. Traverse cell range.
  41488. @author Roman Kashitsyn
  41489. </member>
  41490. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.IsTraverseEmptyCells">
  41491. Should we call handler on empty (blank) cells. Default is
  41492. false.
  41493. @return true if handler should be called on empty (blank)
  41494. cells, false otherwise.
  41495. </member>
  41496. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.SetTraverseEmptyCells(System.Boolean)">
  41497. Sets the traverseEmptyCells property.
  41498. @param traverseEmptyCells new property value
  41499. </member>
  41500. <member name="M:NPOI.SS.Util.CellWalk.CellWalk.Traverse(NPOI.SS.Util.CellWalk.ICellHandler)">
  41501. Traverse cell range from top left to bottom right cell.
  41502. @param handler handler to call on each appropriate cell
  41503. </member>
  41504. <member name="T:NPOI.SS.Util.CellWalk.CellWalk.SimpleCellWalkContext">
  41505. Inner class to hold walk context.
  41506. @author Roman Kashitsyn
  41507. </member>
  41508. <member name="T:NPOI.SS.Util.CellWalk.ICellWalkContext">
  41509. @author Roman Kashitsyn
  41510. </member>
  41511. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.OrdinalNumber">
  41512. Returns ordinal number of cell in range. Numeration starts
  41513. from top left cell and ends at bottom right cell. Here is a
  41514. brief example (number in cell is it's ordinal number):
  41515. <table border="1">
  41516. <tbody>
  41517. <tr><td>1</td><td>2</td></tr>
  41518. <tr><td>3</td><td>4</td></tr>
  41519. </tbody>
  41520. </table>
  41521. @return ordinal number of current cell
  41522. </member>
  41523. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.RowNumber">
  41524. Returns number of current row.
  41525. @return number of current row
  41526. </member>
  41527. <member name="P:NPOI.SS.Util.CellWalk.ICellWalkContext.ColumnNumber">
  41528. Returns number of current column.
  41529. @return number of current column
  41530. </member>
  41531. <member name="T:NPOI.SS.Util.DataMarker">
  41532. <summary>
  41533. Represents data marker used in charts.
  41534. @author Roman Kashitsyn
  41535. </summary>
  41536. </member>
  41537. <member name="M:NPOI.SS.Util.DataMarker.#ctor(NPOI.SS.UserModel.ISheet,NPOI.SS.Util.CellRangeAddress)">
  41538. <summary>
  41539. constructor
  41540. </summary>
  41541. <param name="sheet">the sheet where data located.</param>
  41542. <param name="range">the range within that sheet.</param>
  41543. </member>
  41544. <member name="P:NPOI.SS.Util.DataMarker.Sheet">
  41545. <summary>
  41546. get or set the sheet marker points to.
  41547. </summary>
  41548. </member>
  41549. <member name="P:NPOI.SS.Util.DataMarker.Range">
  41550. <summary>
  41551. get or set range of the marker.
  41552. </summary>
  41553. </member>
  41554. <member name="M:NPOI.SS.Util.DataMarker.FormatAsString">
  41555. <summary>
  41556. Formats data marker using canonical format, for example
  41557. 'SheetName!$A$1:$A$5'.
  41558. </summary>
  41559. <returns>formatted data marker</returns>
  41560. </member>
  41561. <member name="T:NPOI.SS.Util.DateFormatConverter">
  41562. Convert DateFormat patterns into Excel custom number formats.
  41563. For example, to format a date in excel using the "dd MMMM, yyyy" pattern and Japanese
  41564. locale, use the following code:
  41565. <pre><code>
  41566. // returns "[$-0411]dd MMMM, yyyy;@" where the [$-0411] prefix tells Excel to use the Japanese locale
  41567. String excelFormatPattern = DateFormatConverter.convert(Locale.JAPANESE, "dd MMMM, yyyy");
  41568. CellStyle cellStyle = workbook.createCellStyle();
  41569. DataFormat poiFormat = workbook.createDataFormat();
  41570. cellStyle.setDataFormat(poiFormat.getFormat(excelFormatPattern));
  41571. cell.setCellValue(new Date());
  41572. cell.setCellStyle(cellStyle); // formats date as '2012\u5e743\u670817\u65e5'
  41573. </code></pre>
  41574. </member>
  41575. <member name="F:NPOI.SS.Util.ExpandedDouble._significand">
  41576. Always 64 bits long (MSB, bit-63 is '1')
  41577. </member>
  41578. <member name="M:NPOI.SS.Util.ExpandedDouble.NormaliseBaseTen">
  41579. Convert to an equivalent {@link NormalisedDecimal} representation having 15 decimal digits of precision in the
  41580. non-fractional bits of the significand.
  41581. </member>
  41582. <member name="M:NPOI.SS.Util.ExpandedDouble.GetBinaryExponent">
  41583. @return the number of non-fractional bits after the MSB of the significand
  41584. </member>
  41585. <member name="T:NPOI.SS.Util.FormatBase">
  41586. <summary>
  41587. A substitute class for Format class in Java
  41588. </summary>
  41589. </member>
  41590. <member name="T:NPOI.SS.Util.SSNFormat">
  41591. Format class for Excel's SSN Format. This class mimics Excel's built-in
  41592. SSN Formatting.
  41593. @author James May
  41594. </member>
  41595. <member name="M:NPOI.SS.Util.SSNFormat.Format(System.Object,System.Globalization.CultureInfo)">
  41596. Format a number as an SSN
  41597. </member>
  41598. <member name="T:NPOI.SS.Util.ZipPlusFourFormat">
  41599. Format class for Excel Zip + 4 Format. This class mimics Excel's
  41600. built-in Formatting for Zip + 4.
  41601. @author James May
  41602. </member>
  41603. <member name="M:NPOI.SS.Util.ZipPlusFourFormat.Format(System.Object,System.Globalization.CultureInfo)">
  41604. Format a number as Zip + 4
  41605. </member>
  41606. <member name="T:NPOI.SS.Util.PhoneFormat">
  41607. Format class for Excel phone number Format. This class mimics Excel's
  41608. built-in phone number Formatting.
  41609. @author James May
  41610. </member>
  41611. <member name="M:NPOI.SS.Util.PhoneFormat.Format(System.Object,System.Globalization.CultureInfo)">
  41612. Format a number as a phone number
  41613. </member>
  41614. <member name="T:NPOI.SS.Util.ConstantStringFormat">
  41615. Format class that does nothing and always returns a constant string.
  41616. This format is used to simulate Excel's handling of a format string
  41617. of all # when the value is 0. Excel will output "", Java will output "0".
  41618. @see DataFormatter#createFormat(double, int, String)
  41619. </member>
  41620. <member name="F:NPOI.SS.Util.IEEEDouble.BIASED_EXPONENT_SPECIAL_VALUE">
  41621. The value the exponent field Gets for all <i>NaN</i> and <i>InfInity</i> values
  41622. </member>
  41623. <member name="M:NPOI.SS.Util.IEEEDouble.GetBiasedExponent(System.Int64)">
  41624. @param rawBits the 64 bit binary representation of the double value
  41625. @return the top 12 bits (sign and biased exponent value)
  41626. </member>
  41627. <member name="T:NPOI.SS.Util.ImageUtils">
  41628. @author Yegor Kozlov
  41629. </member>
  41630. <member name="M:NPOI.SS.Util.ImageUtils.GetImageDimension(System.IO.Stream,NPOI.SS.UserModel.PictureType)">
  41631. Return the dimension of this image
  41632. @param is the stream Containing the image data
  41633. @param type type of the picture: {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_JPEG},
  41634. {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_PNG} or {@link NPOI.SS.UserModel.Workbook#PICTURE_TYPE_DIB}
  41635. @return image dimension in pixels
  41636. </member>
  41637. <member name="M:NPOI.SS.Util.ImageUtils.GetResolution(System.Drawing.Image)">
  41638. The metadata of PNG and JPEG can contain the width of a pixel in millimeters.
  41639. Return the the "effective" dpi calculated as <code>25.4/HorizontalPixelSize</code>
  41640. and <code>25.4/VerticalPixelSize</code>. Where 25.4 is the number of mm in inch.
  41641. @return array of two elements: <code>{horisontalPdi, verticalDpi}</code>.
  41642. {96, 96} is the default.
  41643. </member>
  41644. <member name="M:NPOI.SS.Util.ImageUtils.SetPreferredSize(NPOI.SS.UserModel.IPicture,System.Double,System.Double)">
  41645. Calculate and Set the preferred size (anchor) for this picture.
  41646. @param scaleX the amount by which image width is multiplied relative to the original width.
  41647. @param scaleY the amount by which image height is multiplied relative to the original height.
  41648. @return the new Dimensions of the scaled picture in EMUs
  41649. </member>
  41650. <member name="M:NPOI.SS.Util.ImageUtils.GetDimensionFromAnchor(NPOI.SS.UserModel.IPicture)">
  41651. Calculates the dimensions in EMUs for the anchor of the given picture
  41652. @param picture the picture Containing the anchor
  41653. @return the dimensions in EMUs
  41654. </member>
  41655. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MIN_BASE">
  41656. The minimum value in 'Base-10 normalised form'.<br/>
  41657. When {@link #_binaryExponent} == 46 this is the the minimum {@link #_frac} value
  41658. (10<sup>14</sup>-0.05) * 2^17
  41659. <br/>
  41660. Values between (10<sup>14</sup>-0.05) and 10<sup>14</sup> will be represented as '1'
  41661. followed by 14 zeros.
  41662. Values less than (10<sup>14</sup>-0.05) will get Shifted by one more power of 10
  41663. This frac value rounds to '1' followed by fourteen zeros with an incremented decimal exponent
  41664. </member>
  41665. <member name="F:NPOI.SS.Util.MutableFPNumber.BI_MAX_BASE">
  41666. For 'Base-10 normalised form'<br/>
  41667. The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
  41668. (10^15-0.5) * 2^14
  41669. </member>
  41670. <member name="F:NPOI.SS.Util.MutableFPNumber.C_64">
  41671. Width of a long
  41672. </member>
  41673. <member name="F:NPOI.SS.Util.MutableFPNumber.MIN_PRECISION">
  41674. Minimum precision after discarding whole 32-bit words from the significand
  41675. </member>
  41676. <member name="M:NPOI.SS.Util.MutableFPNumber.Rounder.Round(NPOI.Util.BigInteger,System.Int32)">
  41677. @param nBits number of bits to shift right
  41678. </member>
  41679. <member name="T:NPOI.SS.Util.MutableFPNumber.TenPower">
  41680. Holds values for quick multiplication and division by 10
  41681. </member>
  41682. <member name="F:NPOI.SS.Util.NormalisedDecimal.EXPONENT_OFFSET">
  41683. Number of powers of ten Contained in the significand
  41684. </member>
  41685. <member name="F:NPOI.SS.Util.NormalisedDecimal.C_2_POW_19">
  41686. 2<sup>19</sup>
  41687. </member>
  41688. <member name="F:NPOI.SS.Util.NormalisedDecimal.FRAC_HALF">
  41689. the value of {@link #_fractionalPart} that represents 0.5
  41690. </member>
  41691. <member name="F:NPOI.SS.Util.NormalisedDecimal.MAX_REP_WHOLE_PART">
  41692. 10<sup>15</sup>
  41693. </member>
  41694. <member name="M:NPOI.SS.Util.NormalisedDecimal.RoundUnits">
  41695. Rounds at the digit with value 10<sup>decimalExponent</sup>
  41696. </member>
  41697. <member name="F:NPOI.SS.Util.NormalisedDecimal._relativeDecimalExponent">
  41698. The decimal exponent increased by one less than the digit count of {@link #_wholePart}
  41699. </member>
  41700. <member name="F:NPOI.SS.Util.NormalisedDecimal._wholePart">
  41701. The whole part of the significand (typically 15 digits).
  41702. 47-50 bits long (MSB may be anywhere from bit 46 to 49)
  41703. LSB is units bit.
  41704. </member>
  41705. <member name="F:NPOI.SS.Util.NormalisedDecimal._fractionalPart">
  41706. The fractional part of the significand.
  41707. 24 bits (only top 14-17 bits significant): a value between 0x000000 and 0xFFFF80
  41708. </member>
  41709. <member name="M:NPOI.SS.Util.NormalisedDecimal.NormaliseBaseTwo">
  41710. Convert to an equivalent {@link ExpandedDouble} representation (binary frac and exponent).
  41711. The resulting transformed object is easily Converted to a 64 bit IEEE double:
  41712. <ul>
  41713. <li>bits 2-53 of the {@link #GetSignificand()} become the 52 bit 'fraction'.</li>
  41714. <li>{@link #GetBinaryExponent()} is biased by 1023 to give the 'exponent'.</li>
  41715. </ul>
  41716. The sign bit must be obtained from somewhere else.
  41717. @return a new {@link NormalisedDecimal} normalised to base 2 representation.
  41718. </member>
  41719. <member name="M:NPOI.SS.Util.NormalisedDecimal.ComposeFrac">
  41720. @return the significand as a fixed point number (with 24 fraction bits and 47-50 whole bits)
  41721. </member>
  41722. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetSignificantDecimalDigitsLastDigitRounded">
  41723. Rounds the first whole digit position (considers only units digit, not frational part).
  41724. Caller should check total digit count of result to see whether the rounding operation caused
  41725. a carry out of the most significant digit
  41726. </member>
  41727. <member name="M:NPOI.SS.Util.NormalisedDecimal.GetDecimalExponent">
  41728. @return the number of powers of 10 which have been extracted from the significand and binary exponent.
  41729. </member>
  41730. <member name="M:NPOI.SS.Util.NormalisedDecimal.CompareNormalised(NPOI.SS.Util.NormalisedDecimal)">
  41731. assumes both this and other are normalised
  41732. </member>
  41733. <member name="M:NPOI.SS.Util.NumberComparer.Compare(System.Double,System.Double)">
  41734. This class attempts to reproduce Excel's behaviour for comparing numbers. Results are
  41735. mostly the same as those from {@link Double#compare(double, double)} but with some
  41736. rounding. For numbers that are very close, this code converts to a format having 15
  41737. decimal digits of precision and a decimal exponent, before completing the comparison.
  41738. <p/>
  41739. In Excel formula evaluation, expressions like "(0.06-0.01)=0.05" evaluate to "TRUE" even
  41740. though the equivalent java expression is <c>false</c>. In examples like this,
  41741. Excel achieves the effect by having additional logic for comparison operations.
  41742. <p/>
  41743. <p/>
  41744. Note - Excel also gives special treatment to expressions like "0.06-0.01-0.05" which
  41745. evaluates to "0" (in java, rounding anomalies give a result of 6.9E-18). The special
  41746. behaviour here is for different reasons to the example above: If the last operator in a
  41747. cell formula is '+' or '-' and the result is less than 2<sup>50</sup> times smaller than
  41748. first operand, the result is rounded to zero.
  41749. Needless to say, the two rules are not consistent and it is relatively easy to find
  41750. examples that satisfy<br/>
  41751. "A=B" is "TRUE" but "A-B" is not "0"<br/>
  41752. and<br/>
  41753. "A=B" is "FALSE" but "A-B" is "0"<br/>
  41754. <br/>
  41755. This rule (for rounding the result of a final addition or subtraction), has not been
  41756. implemented in POI (as of Jul-2009).
  41757. @return <code>negative, 0, or positive</code> according to the standard Excel comparison
  41758. of values <c>a</c> and <c>b</c>.
  41759. </member>
  41760. <member name="M:NPOI.SS.Util.NumberComparer.CompareSubnormalNumbers(System.Int64,System.Int64,System.Boolean)">
  41761. If both numbers are subnormal, Excel seems to use standard comparison rules
  41762. </member>
  41763. <member name="M:NPOI.SS.Util.NumberComparer.CompareAcrossSubnormalThreshold(System.Int64,System.Int64,System.Boolean)">
  41764. Usually any normal number is greater (in magnitude) than any subnormal number.
  41765. However there are some anomalous cases around the threshold where Excel produces screwy results
  41766. @param isNegative both values are either negative or positive. This parameter affects the sign of the comparison result
  41767. @return usually <code>isNegative ? -1 : +1</code>
  41768. </member>
  41769. <member name="M:NPOI.SS.Util.NumberComparer.ToHex(System.Double)">
  41770. for formatting double values in error messages
  41771. </member>
  41772. <member name="M:NPOI.SS.Util.NumberToTextConverter.ToText(System.Double)">
  41773. Converts the supplied <c>value</c> to the text representation that Excel would give if
  41774. the value were to appear in an unformatted cell, or as a literal number in a formula.<br/>
  41775. Note - the results from this method differ slightly from those of <c>Double.ToString()</c>
  41776. In some special cases Excel behaves quite differently. This function attempts to reproduce
  41777. those results.
  41778. </member>
  41779. <member name="T:NPOI.SS.Util.PaneInformation">
  41780. Holds information regarding a split plane or freeze plane for a sheet.
  41781. </member>
  41782. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_RIGHT">
  41783. Constant for active pane being the lower right
  41784. </member>
  41785. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_RIGHT">
  41786. Constant for active pane being the upper right
  41787. </member>
  41788. <member name="F:NPOI.SS.Util.PaneInformation.PANE_LOWER_LEFT">
  41789. Constant for active pane being the lower left
  41790. </member>
  41791. <member name="F:NPOI.SS.Util.PaneInformation.PANE_UPPER_LEFT">
  41792. Constant for active pane being the upper left
  41793. </member>
  41794. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitPosition">
  41795. Returns the vertical position of the split.
  41796. @return 0 if there is no vertical spilt,
  41797. or for a freeze pane the number of columns in the TOP pane,
  41798. or for a split plane the position of the split in 1/20th of a point.
  41799. </member>
  41800. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitPosition">
  41801. Returns the horizontal position of the split.
  41802. @return 0 if there is no horizontal spilt,
  41803. or for a freeze pane the number of rows in the LEFT pane,
  41804. or for a split plane the position of the split in 1/20th of a point.
  41805. </member>
  41806. <member name="P:NPOI.SS.Util.PaneInformation.HorizontalSplitTopRow">
  41807. For a horizontal split returns the top row in the BOTTOM pane.
  41808. @return 0 if there is no horizontal split, or the top row of the bottom pane.
  41809. </member>
  41810. <member name="P:NPOI.SS.Util.PaneInformation.VerticalSplitLeftColumn">
  41811. For a vertical split returns the left column in the RIGHT pane.
  41812. @return 0 if there is no vertical split, or the left column in the RIGHT pane.
  41813. </member>
  41814. <member name="P:NPOI.SS.Util.PaneInformation.ActivePane">
  41815. Returns the active pane
  41816. @see #PANE_LOWER_RIGHT
  41817. @see #PANE_UPPER_RIGHT
  41818. @see #PANE_LOWER_LEFT
  41819. @see #PANE_UPPER_LEFT
  41820. @return the active pane.
  41821. </member>
  41822. <member name="M:NPOI.SS.Util.PaneInformation.IsFreezePane">
  41823. Returns true if this is a Freeze pane, false if it is a split pane.
  41824. </member>
  41825. <member name="T:NPOI.SS.Util.Region">
  41826. Represents a from/to row/col square. This is a object primitive
  41827. that can be used to represent row,col - row,col just as one would use String
  41828. to represent a string of characters. Its really only useful for HSSF though.
  41829. @author Andrew C. Oliver acoliver at apache dot org
  41830. </member>
  41831. <member name="M:NPOI.SS.Util.Region.#ctor">
  41832. Creates a new instance of Region (0,0 - 0,0)
  41833. </member>
  41834. <member name="P:NPOI.SS.Util.Region.ColumnFrom">
  41835. Get the upper left hand corner column number
  41836. @return column number for the upper left hand corner
  41837. </member>
  41838. <member name="P:NPOI.SS.Util.Region.RowFrom">
  41839. Get the upper left hand corner row number
  41840. @return row number for the upper left hand corner
  41841. </member>
  41842. <member name="P:NPOI.SS.Util.Region.ColumnTo">
  41843. Get the lower right hand corner column number
  41844. @return column number for the lower right hand corner
  41845. </member>
  41846. <member name="P:NPOI.SS.Util.Region.RowTo">
  41847. Get the lower right hand corner row number
  41848. @return row number for the lower right hand corner
  41849. </member>
  41850. <member name="M:NPOI.SS.Util.Region.ConvertCellRangesToRegions(NPOI.SS.Util.CellRangeAddress[])">
  41851. Convert a List of CellRange objects to an array of regions
  41852. @param List of CellRange objects
  41853. @return regions
  41854. </member>
  41855. <member name="T:NPOI.SS.Util.RegionUtil">
  41856. Various utility functions that make working with a region of cells easier.
  41857. @author Eric Pugh epugh@upstate.com
  41858. @author (secondary) Avinash Kewalramani akewalramani@accelrys.com
  41859. </member>
  41860. <member name="T:NPOI.SS.Util.RegionUtil.CellPropertySetter">
  41861. For setting the same property on many cells to the same value
  41862. </member>
  41863. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderLeft(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41864. Sets the left border for a region of cells by manipulating the cell style of the individual
  41865. cells on the left
  41866. @param border The new border
  41867. @param region The region that should have the border
  41868. @param workbook The workbook that the region is on.
  41869. @param sheet The sheet that the region is on.
  41870. </member>
  41871. <member name="M:NPOI.SS.Util.RegionUtil.SetLeftBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41872. Sets the leftBorderColor attribute of the RegionUtil object
  41873. @param color The color of the border
  41874. @param region The region that should have the border
  41875. @param workbook The workbook that the region is on.
  41876. @param sheet The sheet that the region is on.
  41877. </member>
  41878. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderRight(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41879. Sets the borderRight attribute of the RegionUtil object
  41880. @param border The new border
  41881. @param region The region that should have the border
  41882. @param workbook The workbook that the region is on.
  41883. @param sheet The sheet that the region is on.
  41884. </member>
  41885. <member name="M:NPOI.SS.Util.RegionUtil.SetRightBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41886. Sets the rightBorderColor attribute of the RegionUtil object
  41887. @param color The color of the border
  41888. @param region The region that should have the border
  41889. @param workbook The workbook that the region is on.
  41890. @param sheet The sheet that the region is on.
  41891. </member>
  41892. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderBottom(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41893. Sets the borderBottom attribute of the RegionUtil object
  41894. @param border The new border
  41895. @param region The region that should have the border
  41896. @param workbook The workbook that the region is on.
  41897. @param sheet The sheet that the region is on.
  41898. </member>
  41899. <member name="M:NPOI.SS.Util.RegionUtil.SetBottomBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41900. Sets the bottomBorderColor attribute of the RegionUtil object
  41901. @param color The color of the border
  41902. @param region The region that should have the border
  41903. @param workbook The workbook that the region is on.
  41904. @param sheet The sheet that the region is on.
  41905. </member>
  41906. <member name="M:NPOI.SS.Util.RegionUtil.SetBorderTop(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41907. Sets the borderBottom attribute of the RegionUtil object
  41908. @param border The new border
  41909. @param region The region that should have the border
  41910. @param workbook The workbook that the region is on.
  41911. @param sheet The sheet that the region is on.
  41912. </member>
  41913. <member name="M:NPOI.SS.Util.RegionUtil.SetTopBorderColor(System.Int32,NPOI.SS.Util.CellRangeAddress,NPOI.SS.UserModel.ISheet,NPOI.SS.UserModel.IWorkbook)">
  41914. Sets the topBorderColor attribute of the RegionUtil object
  41915. @param color The color of the border
  41916. @param region The region that should have the border
  41917. @param workbook The workbook that the region is on.
  41918. @param sheet The sheet that the region is on.
  41919. </member>
  41920. <member name="T:NPOI.SS.Util.SheetBuilder">
  41921. Class {@code SheetBuilder} provides an easy way of building workbook sheets
  41922. from 2D array of Objects. It can be used in test cases to improve code
  41923. readability or in Swing applications with tables.
  41924. @author Roman Kashitsyn
  41925. </member>
  41926. <member name="M:NPOI.SS.Util.SheetBuilder.GetCreateEmptyCells">
  41927. Returns {@code true} if null array elements should be treated as empty
  41928. cells.
  41929. @return {@code true} if null objects should be treated as empty cells
  41930. and {@code false} otherwise
  41931. </member>
  41932. <member name="M:NPOI.SS.Util.SheetBuilder.SetCreateEmptyCells(System.Boolean)">
  41933. Specifies if null array elements should be treated as empty cells.
  41934. @param shouldCreateEmptyCells {@code true} if null array elements should be
  41935. treated as empty cells
  41936. @return {@code this}
  41937. </member>
  41938. <member name="M:NPOI.SS.Util.SheetBuilder.SetSheetName(System.String)">
  41939. Specifies name of the sheet to build. If not specified, default name (provided by
  41940. workbook) will be used instead.
  41941. @param sheetName sheet name to use
  41942. @return {@code this}
  41943. </member>
  41944. <member name="M:NPOI.SS.Util.SheetBuilder.Build">
  41945. Builds sheet from parent workbook and 2D array with cell
  41946. values. Creates rows anyway (even if row contains only null
  41947. cells), creates cells if either corresponding array value is not
  41948. null or createEmptyCells property is true.
  41949. The conversion is performed in the following way:
  41950. <p/>
  41951. <ul>
  41952. <li>Numbers become numeric cells.</li>
  41953. <li><code>java.util.Date</code> or <code>java.util.Calendar</code>
  41954. instances become date cells.</li>
  41955. <li>String with leading '=' char become formulas (leading '='
  41956. will be truncated).</li>
  41957. <li>Other objects become strings via <code>Object.toString()</code>
  41958. method call.</li>
  41959. </ul>
  41960. @return newly created sheet
  41961. </member>
  41962. <member name="M:NPOI.SS.Util.SheetBuilder.SetCellValue(NPOI.SS.UserModel.ICell,System.Object)">
  41963. Sets the cell value using object type information.
  41964. @param cell cell to change
  41965. @param value value to set
  41966. </member>
  41967. <member name="T:NPOI.SS.Util.SheetReferences">
  41968. Holds a collection of Sheet names and their associated
  41969. reference numbers.
  41970. @author Andrew C. Oliver (acoliver at apache dot org)
  41971. </member>
  41972. <member name="T:NPOI.SS.Util.SheetUtil">
  41973. Helper methods for when working with Usermodel sheets
  41974. @author Yegor Kozlov
  41975. </member>
  41976. <member name="F:NPOI.SS.Util.SheetUtil.dummyEvaluator">
  41977. Dummy formula Evaluator that does nothing.
  41978. YK: The only reason of having this class is that
  41979. {@link NPOI.SS.UserModel.DataFormatter#formatCellValue(NPOI.SS.UserModel.Cell)}
  41980. returns formula string for formula cells. Dummy Evaluator Makes it to format the cached formula result.
  41981. See Bugzilla #50021
  41982. </member>
  41983. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWidth(NPOI.SS.UserModel.ICell,System.Int32,NPOI.SS.UserModel.DataFormatter,System.Boolean)">
  41984. Compute width of a single cell
  41985. @param cell the cell whose width is to be calculated
  41986. @param defaultCharWidth the width of a single character
  41987. @param formatter formatter used to prepare the text to be measured
  41988. @param useMergedCells whether to use merged cells
  41989. @return the width in pixels
  41990. </member>
  41991. <member name="M:NPOI.SS.Util.SheetUtil.GetColumnWidth(NPOI.SS.UserModel.ISheet,System.Int32,System.Boolean)">
  41992. Compute width of a column and return the result
  41993. @param sheet the sheet to calculate
  41994. @param column 0-based index of the column
  41995. @param useMergedCells whether to use merged cells
  41996. @return the width in pixels
  41997. </member>
  41998. <member name="M:NPOI.SS.Util.SheetUtil.IFont2Font(NPOI.SS.UserModel.IFont)">
  41999. <summary>
  42000. Convert HSSFFont to Font.
  42001. </summary>
  42002. <param name="font1">The font.</param>
  42003. <returns></returns>
  42004. </member>
  42005. <member name="M:NPOI.SS.Util.SheetUtil.GetUniqueSheetName(NPOI.SS.UserModel.IWorkbook,System.String)">
  42006. Generate a valid sheet name based on the existing one. Used when cloning sheets.
  42007. @param srcName the original sheet name to
  42008. @return clone sheet name
  42009. </member>
  42010. <member name="M:NPOI.SS.Util.SheetUtil.GetCellWithMerges(NPOI.SS.UserModel.ISheet,System.Int32,System.Int32)">
  42011. Return the cell, taking account of merged regions. Allows you to find the
  42012. cell who's contents are Shown in a given position in the sheet.
  42013. <p>If the cell at the given co-ordinates is a merged cell, this will
  42014. return the primary (top-left) most cell of the merged region.</p>
  42015. <p>If the cell at the given co-ordinates is not in a merged region,
  42016. then will return the cell itself.</p>
  42017. <p>If there is no cell defined at the given co-ordinates, will return
  42018. null.</p>
  42019. </member>
  42020. <member name="T:NPOI.SS.Util.SSCellRange`1">
  42021. For POI internal use only
  42022. @author Josh Micich
  42023. </member>
  42024. <member name="T:NPOI.SS.Util.WorkbookUtil">
  42025. Helper methods for when working with Usermodel Workbooks
  42026. </member>
  42027. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String)">
  42028. Creates a valid sheet name, which is conform to the rules.
  42029. In any case, the result safely can be used for
  42030. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  42031. <br/>
  42032. Rules:
  42033. <ul>
  42034. <li>never null</li>
  42035. <li>minimum length is 1</li>
  42036. <li>maximum length is 31</li>
  42037. <li>doesn't contain special chars: 0x0000, 0x0003, / \ ? * ] [ </li>
  42038. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  42039. </ul>
  42040. Invalid characters are replaced by one space character ' '.
  42041. @param nameProposal can be any string, will be truncated if necessary,
  42042. allowed to be null
  42043. @return a valid string, "empty" if to short, "null" if null
  42044. </member>
  42045. <member name="M:NPOI.SS.Util.WorkbookUtil.CreateSafeSheetName(System.String,System.Char)">
  42046. Creates a valid sheet name, which is conform to the rules.
  42047. In any case, the result safely can be used for
  42048. {@link org.apache.poi.ss.usermodel.Workbook#setSheetName(int, String)}.
  42049. <br />
  42050. Rules:
  42051. <ul>
  42052. <li>never null</li>
  42053. <li>minimum length is 1</li>
  42054. <li>maximum length is 31</li>
  42055. <li>doesn't contain special chars: : 0x0000, 0x0003, / \ ? * ] [ </li>
  42056. <li>Sheet names must not begin or end with ' (apostrophe)</li>
  42057. </ul>
  42058. @param nameProposal can be any string, will be truncated if necessary,
  42059. allowed to be null
  42060. @param replaceChar the char to replace invalid characters.
  42061. @return a valid string, "empty" if to short, "null" if null
  42062. </member>
  42063. <member name="M:NPOI.SS.Util.WorkbookUtil.ValidateSheetName(System.String)">
  42064. Validates sheet name.
  42065. <p>
  42066. The character count <c>MUST</c> be greater than or equal to 1 and less than or equal to 31.
  42067. The string MUST NOT contain the any of the following characters:
  42068. <ul>
  42069. <li> 0x0000 </li>
  42070. <li> 0x0003 </li>
  42071. <li> colon (:) </li>
  42072. <li> backslash (\) </li>
  42073. <li> asterisk (*) </li>
  42074. <li> question mark (?) </li>
  42075. <li> forward slash (/) </li>
  42076. <li> opening square bracket ([) </li>
  42077. <li> closing square bracket (]) </li>
  42078. </ul>
  42079. The string MUST NOT begin or end with the single quote (') character.
  42080. </p>
  42081. @param sheetName the name to validate
  42082. </member>
  42083. <member name="T:NPOI.UnsupportedFileFormatException">
  42084. Base class of all the exceptions that POI throws in the event
  42085. that it's given a file that isn't supported
  42086. </member>
  42087. <member name="T:NPOI.WP.UserModel.ICharacterRun">
  42088. This class represents a run of text that share common properties.
  42089. </member>
  42090. <member name="P:NPOI.WP.UserModel.ICharacterRun.Text">
  42091. @return The text of the Run, including any tabs/spaces/etc
  42092. </member>
  42093. <member name="T:NPOI.WP.UserModel.IParagraph">
  42094. This class represents a paragraph, made up of one or more
  42095. Runs of text.
  42096. </member>
  42097. </members>
  42098. </doc>